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}/messages",
2439 "title": "Creates new messages",
2442 "title": "Example usage:",
2443 "content": "curl https://{domain}/api/chat/interactions/{id}/messages -d '[{\"to\": \"+3901119886500\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
2447 "name": "addMessage",
2448 "group": "Chat_Interactions",
2481 "field": "direction",
2495 "field": "providerName",
2502 "field": "providerResponse",
2508 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2510 "filename": "server/api/chatInteraction/index.js",
2511 "groupTitle": "Chat_Interactions"
2515 "url": "/api/chat/interactions/{id}/close",
2516 "title": "Close Interaction",
2519 "title": "Example usage:",
2520 "content": "curl https://{domain}/api/chat/interactions/{id}/close -d '[{\"to\": \"+3901119886500\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
2524 "name": "addMessage",
2525 "group": "Chat_Interactions",
2526 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2528 "filename": "server/api/chatInteraction/index.js",
2529 "groupTitle": "Chat_Interactions"
2533 "url": "/api/chat/interactions/{id}/attachment_upload",
2534 "title": "Add attachment",
2537 "title": "Example usage:",
2538 "content": "curl https://{domain}/api/chat/interactions/{id}/attachment_upload -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
2542 "name": "attachmentUpload",
2543 "group": "Chat_Interactions",
2544 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2546 "filename": "server/api/chatInteraction/index.js",
2547 "groupTitle": "Chat_Interactions"
2551 "url": "/api/chat/interactions/{id}/vidaoo",
2552 "title": "Create Vidaoo Session",
2555 "title": "Example usage:",
2556 "content": "curl https://{domain}/api/chat/interactions/{id}/vidaoo -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
2560 "name": "createVidaooSession",
2561 "group": "Chat_Interactions",
2562 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2564 "filename": "server/api/chatInteraction/index.js",
2565 "groupTitle": "Chat_Interactions"
2569 "url": "/api/chat/interactions/{id}/custom_update",
2570 "title": "Update interaction",
2573 "title": "Example usage:",
2574 "content": "curl https://{domain}/api/chat/interactions/{id}/custom_update -d '{\"channel\": \"chat\", \"...\": \"...\"}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
2578 "name": "customUpdate",
2579 "group": "Chat_Interactions",
2580 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <p>This API is used to update an interaction.</p>",
2582 "filename": "server/api/chatInteraction/index.js",
2583 "groupTitle": "Chat_Interactions"
2587 "url": "/api/chat/interactions/{id}/download",
2588 "title": "Gets interaction",
2591 "title": "Example usage:",
2592 "content": "curl https://{domain}/api/chat/interactions/{id}/download -v -u {name}:{password} -X GET",
2597 "group": "Chat_Interactions",
2598 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2600 "filename": "server/api/chatInteraction/index.js",
2601 "groupTitle": "Chat_Interactions"
2605 "url": "/api/chat/interactions/{id}/messages",
2606 "title": "Gets interaction messages",
2609 "title": "Example usage:",
2610 "content": "curl https://{domain}/api/chat/interactions/{id}/messages -v -u {name}:{password} -X GET",
2614 "name": "getMessages",
2615 "group": "Chat_Interactions",
2616 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2618 "filename": "server/api/chatInteraction/index.js",
2619 "groupTitle": "Chat_Interactions"
2623 "url": "/api/chat/interactions/{id}/my_messages",
2624 "title": "Gets interaction messages",
2627 "title": "Example usage:",
2628 "content": "curl https://{domain}/api/chat/interactions/{id}/my_messages -v -u {name}:{password} -X GET",
2632 "name": "getMyMessages",
2633 "group": "Chat_Interactions",
2634 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2636 "filename": "server/api/chatInteraction/index.js",
2637 "groupTitle": "Chat_Interactions"
2641 "url": "/api/chat/interactions/{id}",
2642 "title": "Update an existing Interaction",
2645 "title": "Example usage:",
2646 "content": "curl https://{domain}/api/chat/interactions/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
2650 "name": "updateInteractions",
2651 "group": "Chat_Interactions",
2652 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2654 "filename": "server/api/chatInteraction/index.js",
2655 "groupTitle": "Chat_Interactions"
2659 "url": "/api/chat/internal/messages",
2660 "title": "Creates a new Message",
2663 "title": "Example usage:",
2664 "content": "curl https://{domain}/api/chat/internal/messages -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
2668 "name": "CreateMessages",
2669 "group": "Chat_Internal_Messages",
2691 "field": "ChatInternalMessageId",
2697 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2699 "filename": "server/api/chatInternalMessage/index.js",
2700 "groupTitle": "Chat_Internal_Messages"
2704 "url": "/api/chat/internal/messages/{id}",
2705 "title": "Deletes a Message",
2708 "title": "Example usage:",
2709 "content": "curl https://{domain}/api/chat/internal/messages/{id} -v -u {name}:{password} -X DELETE",
2713 "name": "DeleteMessages",
2714 "group": "Chat_Internal_Messages",
2715 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2717 "filename": "server/api/chatInternalMessage/index.js",
2718 "groupTitle": "Chat_Internal_Messages"
2722 "url": "/api/chat/internal/messages/describe",
2723 "title": "Gets table info about Messages",
2726 "title": "Example usage:",
2727 "content": "curl https://{domain}/api/chat/internal/messages/describe -v -u {name}:{password}",
2731 "name": "DescribeMessages",
2732 "group": "Chat_Internal_Messages",
2733 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2735 "filename": "server/api/chatInternalMessage/index.js",
2736 "groupTitle": "Chat_Internal_Messages"
2740 "url": "/api/chat/internal/messages",
2741 "title": "Gets a list of Messages",
2744 "title": "Example usage:",
2745 "content": "curl https://{domain}/api/chat/internal/messages -v -u {name}:{password}",
2749 "name": "GetMessages",
2750 "group": "Chat_Internal_Messages",
2751 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/chat/internal/messages?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/chat/internal/messages?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/chat/internal/messages?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/chat/internal/messages?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/chat/internal/messages?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
2753 "filename": "server/api/chatInternalMessage/index.js",
2754 "groupTitle": "Chat_Internal_Messages"
2758 "url": "/api/chat/internal/messages/{id}",
2759 "title": "Gets a single Message",
2762 "title": "Example usage:",
2763 "content": "curl https://{domain}/api/chat/internal/messages/{id} -v -u {name}:{password}",
2767 "name": "ShowMessages",
2768 "group": "Chat_Internal_Messages",
2769 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2771 "filename": "server/api/chatInternalMessage/index.js",
2772 "groupTitle": "Chat_Internal_Messages"
2776 "url": "/api/chat/internal/messages/{id}",
2777 "title": "Update an existing Message",
2780 "title": "Example usage:",
2781 "content": "curl https://{domain}/api/chat/internal/messages/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
2785 "name": "updateMessages",
2786 "group": "Chat_Internal_Messages",
2787 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2789 "filename": "server/api/chatInternalMessage/index.js",
2790 "groupTitle": "Chat_Internal_Messages"
2794 "url": "/api/chat/messages",
2795 "title": "Creates a new Message",
2798 "title": "Example usage:",
2799 "content": "curl https://{domain}/api/chat/messages -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
2803 "name": "CreateMessages",
2804 "group": "Chat_Messages",
2837 "field": "direction",
2851 "field": "providerName",
2858 "field": "providerResponse",
2864 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2866 "filename": "server/api/chatMessage/index.js",
2867 "groupTitle": "Chat_Messages"
2871 "url": "/api/chat/messages/{id}",
2872 "title": "Deletes a Message",
2875 "title": "Example usage:",
2876 "content": "curl https://{domain}/api/chat/messages/{id} -v -u {name}:{password} -X DELETE",
2880 "name": "DeleteMessages",
2881 "group": "Chat_Messages",
2882 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2884 "filename": "server/api/chatMessage/index.js",
2885 "groupTitle": "Chat_Messages"
2889 "url": "/api/chat/messages/describe",
2890 "title": "Gets table info about Messages",
2893 "title": "Example usage:",
2894 "content": "curl https://{domain}/api/chat/messages/describe -v -u {name}:{password}",
2898 "name": "DescribeMessages",
2899 "group": "Chat_Messages",
2900 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2902 "filename": "server/api/chatMessage/index.js",
2903 "groupTitle": "Chat_Messages"
2907 "url": "/api/chat/messages",
2908 "title": "Gets a list of Messages",
2911 "title": "Example usage:",
2912 "content": "curl https://{domain}/api/chat/messages -v -u {name}:{password}",
2916 "name": "GetMessages",
2917 "group": "Chat_Messages",
2918 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/chat/messages?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/chat/messages?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/chat/messages?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/chat/messages?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/chat/messages?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
2920 "filename": "server/api/chatMessage/index.js",
2921 "groupTitle": "Chat_Messages"
2925 "url": "/api/chat/messages/{id}",
2926 "title": "Gets a single Message",
2929 "title": "Example usage:",
2930 "content": "curl https://{domain}/api/chat/messages/{id} -v -u {name}:{password}",
2934 "name": "ShowMessages",
2935 "group": "Chat_Messages",
2936 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2938 "filename": "server/api/chatMessage/index.js",
2939 "groupTitle": "Chat_Messages"
2943 "url": "/api/chat/messages/{id}",
2944 "title": "Update an existing Message",
2947 "title": "Example usage:",
2948 "content": "curl https://{domain}/api/chat/messages/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
2952 "name": "updateMessages",
2953 "group": "Chat_Messages",
2954 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2956 "filename": "server/api/chatMessage/index.js",
2957 "groupTitle": "Chat_Messages"
2961 "url": "/api/chat/offline_messages",
2962 "title": "Creates a new OfflineMessage",
2965 "title": "Example usage:",
2966 "content": "curl https://{domain}/api/chat/offline_messages -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
2970 "name": "CreateOfflineMessages",
2971 "group": "Chat_Offline_Messages",
2985 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2987 "filename": "server/api/chatOfflineMessage/index.js",
2988 "groupTitle": "Chat_Offline_Messages"
2992 "url": "/api/chat/offline_messages/{id}",
2993 "title": "Deletes a OfflineMessage",
2996 "title": "Example usage:",
2997 "content": "curl https://{domain}/api/chat/offline_messages/{id} -v -u {name}:{password} -X DELETE",
3001 "name": "DeleteOfflineMessages",
3002 "group": "Chat_Offline_Messages",
3003 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3005 "filename": "server/api/chatOfflineMessage/index.js",
3006 "groupTitle": "Chat_Offline_Messages"
3010 "url": "/api/chat/offline_messages/describe",
3011 "title": "Gets table info about OfflineMessages",
3014 "title": "Example usage:",
3015 "content": "curl https://{domain}/api/chat/offline_messages/describe -v -u {name}:{password}",
3019 "name": "DescribeOfflineMessages",
3020 "group": "Chat_Offline_Messages",
3021 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3023 "filename": "server/api/chatOfflineMessage/index.js",
3024 "groupTitle": "Chat_Offline_Messages"
3028 "url": "/api/chat/offline_messages",
3029 "title": "Gets a list of OfflineMessages",
3032 "title": "Example usage:",
3033 "content": "curl https://{domain}/api/chat/offline_messages -v -u {name}:{password}",
3037 "name": "GetOfflineMessages",
3038 "group": "Chat_Offline_Messages",
3039 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/chat/offline_messages?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/chat/offline_messages?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/chat/offline_messages?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/chat/offline_messages?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/chat/offline_messages?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
3041 "filename": "server/api/chatOfflineMessage/index.js",
3042 "groupTitle": "Chat_Offline_Messages"
3046 "url": "/api/chat/offline_messages/{id}",
3047 "title": "Gets a single OfflineMessage",
3050 "title": "Example usage:",
3051 "content": "curl https://{domain}/api/chat/offline_messages/{id} -v -u {name}:{password}",
3055 "name": "ShowOfflineMessages",
3056 "group": "Chat_Offline_Messages",
3057 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3059 "filename": "server/api/chatOfflineMessage/index.js",
3060 "groupTitle": "Chat_Offline_Messages"
3064 "url": "/api/chat/offline_messages/{id}",
3065 "title": "Update an existing OfflineMessage",
3068 "title": "Example usage:",
3069 "content": "curl https://{domain}/api/chat/offline_messages/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
3073 "name": "updateOfflineMessages",
3074 "group": "Chat_Offline_Messages",
3075 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3077 "filename": "server/api/chatOfflineMessage/index.js",
3078 "groupTitle": "Chat_Offline_Messages"
3082 "url": "/api/chat/proactive_actions",
3083 "title": "Creates a new Proactive Action",
3086 "title": "Example usage:",
3087 "content": "curl https://{domain}/api/chat/proactive_actions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
3091 "name": "CreateProactive_Actions",
3092 "group": "Chat_Proactive_Actions",
3118 "field": "selector",
3131 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3133 "filename": "server/api/chatProactiveAction/index.js",
3134 "groupTitle": "Chat_Proactive_Actions"
3138 "url": "/api/chat/proactive_actions/{id}",
3139 "title": "Deletes a Proactive Action",
3142 "title": "Example usage:",
3143 "content": "curl https://{domain}/api/chat/proactive_actions/{id} -v -u {name}:{password} -X DELETE",
3147 "name": "DeleteProactive_Actions",
3148 "group": "Chat_Proactive_Actions",
3149 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3151 "filename": "server/api/chatProactiveAction/index.js",
3152 "groupTitle": "Chat_Proactive_Actions"
3156 "url": "/api/chat/proactive_actions/{id}",
3157 "title": "Gets a single Proactive Action",
3160 "title": "Example usage:",
3161 "content": "curl https://{domain}/api/chat/proactive_actions/{id} -v -u {name}:{password}",
3165 "name": "ShowProactive_Actions",
3166 "group": "Chat_Proactive_Actions",
3167 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3169 "filename": "server/api/chatProactiveAction/index.js",
3170 "groupTitle": "Chat_Proactive_Actions"
3174 "url": "/api/chat/proactive_actions/{id}",
3175 "title": "Update an existing Proactive Action",
3178 "title": "Example usage:",
3179 "content": "curl https://{domain}/api/chat/proactive_actions/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
3183 "name": "updateProactive_Actions",
3184 "group": "Chat_Proactive_Actions",
3185 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3187 "filename": "server/api/chatProactiveAction/index.js",
3188 "groupTitle": "Chat_Proactive_Actions"
3192 "url": "/api/chat/reports/queue",
3193 "title": "Creates a new Chat Queue Report",
3196 "title": "Example usage:",
3197 "content": "curl https://{domain}/api/chat/reports/queue -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
3201 "name": "CreateChat_Queue_Reports",
3202 "group": "Chat_Queue_Reports",
3210 "field": "uniqueid",
3238 "field": "acceptAt",
3258 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3260 "filename": "server/api/chatQueueReport/index.js",
3261 "groupTitle": "Chat_Queue_Reports"
3265 "url": "/api/chat/reports/queue/{id}",
3266 "title": "Deletes a Chat Queue Report",
3269 "title": "Example usage:",
3270 "content": "curl https://{domain}/api/chat/reports/queue/{id} -v -u {name}:{password} -X DELETE",
3274 "name": "DeleteChat_Queue_Reports",
3275 "group": "Chat_Queue_Reports",
3276 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3278 "filename": "server/api/chatQueueReport/index.js",
3279 "groupTitle": "Chat_Queue_Reports"
3283 "url": "/api/chat/reports/queue/describe",
3284 "title": "Gets table info about Chat Queue Reports",
3287 "title": "Example usage:",
3288 "content": "curl https://{domain}/api/chat/reports/queue/describe -v -u {name}:{password}",
3292 "name": "DescribeChat_Queue_Reports",
3293 "group": "Chat_Queue_Reports",
3294 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3296 "filename": "server/api/chatQueueReport/index.js",
3297 "groupTitle": "Chat_Queue_Reports"
3301 "url": "/api/chat/reports/queue",
3302 "title": "Gets a list of Chat Queue Reports",
3305 "title": "Example usage:",
3306 "content": "curl https://{domain}/api/chat/reports/queue -v -u {name}:{password}",
3310 "name": "GetChat_Queue_Reports",
3311 "group": "Chat_Queue_Reports",
3312 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/chat/reports/queue?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/chat/reports/queue?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/chat/reports/queue?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/chat/reports/queue?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/chat/reports/queue?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
3314 "filename": "server/api/chatQueueReport/index.js",
3315 "groupTitle": "Chat_Queue_Reports"
3319 "url": "/api/chat/reports/queue/{id}",
3320 "title": "Gets a single Chat Queue Report",
3323 "title": "Example usage:",
3324 "content": "curl https://{domain}/api/chat/reports/queue/{id} -v -u {name}:{password}",
3328 "name": "ShowChat_Queue_Reports",
3329 "group": "Chat_Queue_Reports",
3330 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3332 "filename": "server/api/chatQueueReport/index.js",
3333 "groupTitle": "Chat_Queue_Reports"
3337 "url": "/api/chat/reports/queue/{id}",
3338 "title": "Update an existing Chat Queue Report",
3341 "title": "Example usage:",
3342 "content": "curl https://{domain}/api/chat/reports/queue/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
3346 "name": "updateChat_Queue_Reports",
3347 "group": "Chat_Queue_Reports",
3348 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3350 "filename": "server/api/chatQueueReport/index.js",
3351 "groupTitle": "Chat_Queue_Reports"
3355 "url": "/api/chat/queues/{id}/users",
3356 "title": "Add agents to a queue",
3359 "title": "Example usage:",
3360 "content": "curl https://{domain}/api/chat/queues/{id}/users -d '{\"ids\": [1,2], \"penalty\": 2}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
3364 "name": "AddAgents",
3365 "group": "Chat_Queues",
3366 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3368 "filename": "server/api/chatQueue/index.js",
3369 "groupTitle": "Chat_Queues"
3373 "url": "/api/chat/queues/{id}/teams",
3374 "title": "Add teams to a queue",
3377 "title": "Example usage:",
3378 "content": "curl https://{domain}/api/chat/queues/{id}/teams -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
3383 "group": "Chat_Queues",
3384 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3386 "filename": "server/api/chatQueue/index.js",
3387 "groupTitle": "Chat_Queues"
3391 "url": "/api/chat/queues",
3392 "title": "Creates a new Queue",
3395 "title": "Example usage:",
3396 "content": "curl https://{domain}/api/chat/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
3400 "name": "CreateQueues",
3401 "group": "Chat_Queues",
3416 "field": "description",
3435 "field": "strategy",
3441 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3443 "filename": "server/api/chatQueue/index.js",
3444 "groupTitle": "Chat_Queues"
3448 "url": "/api/chat/queues/{id}",
3449 "title": "Deletes a Queue",
3452 "title": "Example usage:",
3453 "content": "curl https://{domain}/api/chat/queues/{id} -v -u {name}:{password} -X DELETE",
3457 "name": "DeleteQueues",
3458 "group": "Chat_Queues",
3459 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3461 "filename": "server/api/chatQueue/index.js",
3462 "groupTitle": "Chat_Queues"
3466 "url": "/api/chat/queues/describe",
3467 "title": "Gets table info about Queues",
3470 "title": "Example usage:",
3471 "content": "curl https://{domain}/api/chat/queues/describe -v -u {name}:{password}",
3475 "name": "DescribeQueues",
3476 "group": "Chat_Queues",
3477 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3479 "filename": "server/api/chatQueue/index.js",
3480 "groupTitle": "Chat_Queues"
3484 "url": "/api/chat/queues/{id}/users",
3485 "title": "Gets queue agents",
3488 "title": "Example usage:",
3489 "content": "curl https://{domain}/api/chat/queues/{id}/users -v -u {name}:{password} -X POST",
3493 "name": "GetAgents",
3494 "group": "Chat_Queues",
3495 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3497 "filename": "server/api/chatQueue/index.js",
3498 "groupTitle": "Chat_Queues"
3502 "url": "/api/chat/queues/{id}/members",
3503 "title": "GetMembers",
3506 "title": "Example usage:",
3507 "content": "curl https://{domain}/api/chat/queues/{id}/members -v -u {name}:{password}",
3511 "name": "GetMembers",
3512 "group": "Chat_Queues",
3513 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3515 "filename": "server/api/chatQueue/index.js",
3516 "groupTitle": "Chat_Queues"
3520 "url": "/api/chat/queues",
3521 "title": "Gets a list of Queues",
3524 "title": "Example usage:",
3525 "content": "curl https://{domain}/api/chat/queues -v -u {name}:{password}",
3529 "name": "GetQueues",
3530 "group": "Chat_Queues",
3531 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/chat/queues?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/chat/queues?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/chat/queues?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/chat/queues?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/chat/queues?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
3533 "filename": "server/api/chatQueue/index.js",
3534 "groupTitle": "Chat_Queues"
3538 "url": "/api/chat/queues/{id}/teams",
3539 "title": "Gets queues list",
3542 "title": "Example usage:",
3543 "content": "curl https://{domain}/api/chat/queues/{id}/teams -v -u {name}:{password}",
3548 "group": "Chat_Queues",
3549 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3551 "filename": "server/api/chatQueue/index.js",
3552 "groupTitle": "Chat_Queues"
3556 "url": "/api/chat/queues/{id}/users",
3557 "title": "Removes agents from a queue",
3560 "title": "Example usage:",
3561 "content": "curl https://{domain}/api/chat/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
3565 "name": "RemoveAgents",
3566 "group": "Chat_Queues",
3567 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3569 "filename": "server/api/chatQueue/index.js",
3570 "groupTitle": "Chat_Queues"
3574 "url": "/api/chat/queues/{id}",
3575 "title": "Gets a single Queue",
3578 "title": "Example usage:",
3579 "content": "curl https://{domain}/api/chat/queues/{id} -v -u {name}:{password}",
3583 "name": "ShowQueues",
3584 "group": "Chat_Queues",
3585 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3587 "filename": "server/api/chatQueue/index.js",
3588 "groupTitle": "Chat_Queues"
3592 "url": "/api/chat/queues/{id}",
3593 "title": "Update an existing Queue",
3596 "title": "Example usage:",
3597 "content": "curl https://{domain}/api/chat/queues/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
3601 "name": "updateQueues",
3602 "group": "Chat_Queues",
3603 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3605 "filename": "server/api/chatQueue/index.js",
3606 "groupTitle": "Chat_Queues"
3610 "url": "/api/chat/reports/transfer",
3611 "title": "Creates a new Chat Transfer Report",
3614 "title": "Example usage:",
3615 "content": "curl https://{domain}/api/chat/reports/transfer -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
3619 "name": "CreateChat_Transfer_Reports",
3620 "group": "Chat_Transfer_Reports",
3628 "field": "uniqueid",
3647 "field": "transferredAt",
3653 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3655 "filename": "server/api/chatTransferReport/index.js",
3656 "groupTitle": "Chat_Transfer_Reports"
3660 "url": "/api/chat/reports/transfer/{id}",
3661 "title": "Deletes a Chat Transfer Report",
3664 "title": "Example usage:",
3665 "content": "curl https://{domain}/api/chat/reports/transfer/{id} -v -u {name}:{password} -X DELETE",
3669 "name": "DeleteChat_Transfer_Reports",
3670 "group": "Chat_Transfer_Reports",
3671 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3673 "filename": "server/api/chatTransferReport/index.js",
3674 "groupTitle": "Chat_Transfer_Reports"
3678 "url": "/api/chat/reports/transfer/describe",
3679 "title": "Gets table info about Chat Transfer Reports",
3682 "title": "Example usage:",
3683 "content": "curl https://{domain}/api/chat/reports/transfer/describe -v -u {name}:{password}",
3687 "name": "DescribeChat_Transfer_Reports",
3688 "group": "Chat_Transfer_Reports",
3689 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3691 "filename": "server/api/chatTransferReport/index.js",
3692 "groupTitle": "Chat_Transfer_Reports"
3696 "url": "/api/chat/reports/transfer",
3697 "title": "Gets a list of Chat Transfer Reports",
3700 "title": "Example usage:",
3701 "content": "curl https://{domain}/api/chat/reports/transfer -v -u {name}:{password}",
3705 "name": "GetChat_Transfer_Reports",
3706 "group": "Chat_Transfer_Reports",
3707 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/chat/reports/transfer?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/chat/reports/transfer?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/chat/reports/transfer?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/chat/reports/transfer?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/chat/reports/transfer?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
3709 "filename": "server/api/chatTransferReport/index.js",
3710 "groupTitle": "Chat_Transfer_Reports"
3714 "url": "/api/chat/reports/transfer/{id}",
3715 "title": "Gets a single Chat Transfer Report",
3718 "title": "Example usage:",
3719 "content": "curl https://{domain}/api/chat/reports/transfer/{id} -v -u {name}:{password}",
3723 "name": "ShowChat_Transfer_Reports",
3724 "group": "Chat_Transfer_Reports",
3725 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3727 "filename": "server/api/chatTransferReport/index.js",
3728 "groupTitle": "Chat_Transfer_Reports"
3732 "url": "/api/chat/reports/transfer/{id}",
3733 "title": "Update an existing Chat Transfer Report",
3736 "title": "Example usage:",
3737 "content": "curl https://{domain}/api/chat/reports/transfer/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
3741 "name": "updateChat_Transfer_Reports",
3742 "group": "Chat_Transfer_Reports",
3743 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3745 "filename": "server/api/chatTransferReport/index.js",
3746 "groupTitle": "Chat_Transfer_Reports"
3750 "url": "/api/chat/websites/{id}/users",
3751 "title": "Add agents to a website",
3754 "title": "Example usage:",
3755 "content": "curl https://{domain}/api/chat/websites/{id}/users -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
3759 "name": "AddAgents",
3760 "group": "Chat_Websites",
3761 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3763 "filename": "server/api/chatWebsite/index.js",
3764 "groupTitle": "Chat_Websites"
3768 "url": "/api/chat/websites",
3769 "title": "Creates a new Website",
3772 "title": "Example usage:",
3773 "content": "curl https://{domain}/api/chat/websites -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
3777 "name": "CreateWebsites",
3778 "group": "Chat_Websites",
3800 "field": "description",
3814 "field": "mapKeyOffline",
3828 "field": "agentAlias",
3835 "field": "customerAlias",
3849 "field": "color_button",
3856 "field": "textColor",
3863 "field": "fontSize",
3877 "field": "animation",
3888 "field": "header_shape",
3895 "field": "header_online",
3902 "field": "start_chat_button",
3909 "field": "offline_chat_button",
3916 "field": "header_offline",
3923 "field": "download_transcript",
3937 "field": "whiteLabel",
3944 "field": "defaultWhiteLabel",
3958 "field": "closingQuestion",
3965 "field": "formSubmitSuccessMessage",
3972 "field": "formSubmitFailureMessage",
3979 "field": "noteTitle",
3986 "field": "placeholderMessage",
3993 "field": "closingMessage",
4000 "field": "closingMessageButton",
4007 "field": "skipMessageButton",
4014 "field": "conditionAgreement",
4021 "field": "enableRating",
4028 "field": "enableFeedback",
4035 "field": "enableSendButton",
4042 "field": "feedbackTitle",
4053 "field": "ratingType",
4060 "field": "ratingStarsNumber",
4067 "field": "onlineForm",
4074 "field": "offlineForm",
4088 "field": "autoclose",
4095 "field": "enableCustomerWriting",
4102 "field": "forwardTranscript",
4109 "field": "forwardTranscriptMessage",
4116 "field": "forwardOffline",
4123 "field": "forwardOfflineAddress",
4130 "field": "waitingTitle",
4137 "field": "waitingMessage",
4144 "field": "offlineMessageSubject",
4151 "field": "offlineMessageBody",
4158 "field": "enableUnmanagedNote",
4165 "field": "unmanagedMessage",
4172 "field": "skipUnmanaged",
4179 "field": "sendUnmanaged",
4186 "field": "enableCustomerAttachment",
4193 "field": "enableCustomerCheckmarks",
4200 "field": "agentAvatar",
4207 "field": "showAgentAvatar",
4214 "field": "timezone",
4221 "field": "notificationTemplate",
4228 "field": "notificationSound",
4235 "field": "notificationShake",
4242 "field": "hideWhenOffline",
4249 "field": "agentIdentifier",
4256 "field": "waitForTheAssignedAgent",
4263 "field": "alignment",
4270 "field": "verticalAlignment",
4277 "field": "messagesAlignment",
4284 "field": "defaultTitle",
4291 "field": "customerAvatar",
4298 "field": "showCustomerAvatar",
4305 "field": "messageFontSize",
4312 "field": "backgroundColor",
4319 "field": "queueTransfer",
4326 "field": "queueTransferTimeout",
4333 "field": "agentTransfer",
4340 "field": "agentTransferTimeout",
4347 "field": "systemAlias",
4354 "field": "systemAvatar",
4361 "field": "mandatoryDispositionPauseId",
4362 "description": "<p>Status to put when mandatory disposition is enabled</p>"
4368 "field": "mandatoryDisposition",
4369 "description": "<p>Enabled/disables mandatory dispo on a queue</p>"
4375 "field": "vidaooEscalation",
4382 "field": "vidaooApiKey",
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}/journey",
6085 "title": "Gets customer journey",
6088 "title": "Example usage:",
6089 "content": "curl https://{domain}/api/cm/contacts/{id}/journey -v -u {name}:{password} -X GET",
6093 "name": "getJourney",
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}/jscripty_sessions",
6103 "title": "Gets contact hopper blacks",
6106 "title": "Example usage:",
6107 "content": "curl https://{domain}/api/cm/contacts/{id}/hopper_black -v -u {name}:{password} -X GET",
6111 "name": "getJscriptySessions",
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/{id}/tags",
6121 "title": "Gets configurations tags",
6124 "title": "Example usage:",
6125 "content": "curl https://{domain}/api/cm/contacts/{id}/tags -v -u {name}:{password} -X GET",
6130 "group": "Cm_Contacts",
6131 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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/merge",
6139 "title": "Merge Contact",
6142 "title": "Example usage:",
6143 "content": "curl https://{domain}/api/cm/contacts/merge -d '{\"from\": 1, \"to\": 2}' -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}/tags",
6157 "title": "Sets new tags",
6160 "title": "Example usage:",
6161 "content": "curl https://{domain}/api/cm/contacts/{id}/tags -d '{\"ids\": [1,12]}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
6166 "group": "Cm_Contacts",
6167 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</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": "Gets a single Contact",
6178 "title": "Example usage:",
6179 "content": "curl https://{domain}/api/cm/contacts/{id} -v -u {name}:{password} -X GET",
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/contacts/{id}",
6193 "title": "Update a single Contact",
6196 "title": "Example usage:",
6197 "content": "curl https://{domain}/api/cm/contacts/{id} -d '{\"firstName\": \"John\", \"lastName\": \"Doe\"}' -v -u {name}:{password} -X PUT",
6202 "group": "Cm_Contacts",
6203 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <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/cmContact/index.js",
6206 "groupTitle": "Cm_Contacts"
6210 "url": "/api/cm/custom_fields/{id}",
6211 "title": "Deletes a Custom Field",
6214 "title": "Example usage:",
6215 "content": "curl https://{domain}/api/cm/custom_fields/{id} -v -u {name}:{password} -X DELETE",
6219 "name": "DeleteCustom_Fields",
6220 "group": "Cm_Custom_Fields",
6221 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6223 "filename": "server/api/cmCustomField/index.js",
6224 "groupTitle": "Cm_Custom_Fields"
6228 "url": "/api/cm/custom_fields",
6229 "title": "Gets a list of Custom Fields",
6232 "title": "Example usage:",
6233 "content": "curl https://{domain}/api/cm/custom_fields -v -u {name}:{password}",
6237 "name": "GetCustom_Fields",
6238 "group": "Cm_Custom_Fields",
6239 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
6241 "filename": "server/api/cmCustomField/index.js",
6242 "groupTitle": "Cm_Custom_Fields"
6246 "url": "/api/cm/custom_fields/{id}",
6247 "title": "Gets a single Custom Field",
6250 "title": "Example usage:",
6251 "content": "curl https://{domain}/api/cm/custom_fields/{id} -v -u {name}:{password}",
6255 "name": "ShowCustom_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/custom_fields/{id}",
6265 "title": "Update an existing Custom Field",
6268 "title": "Example usage:",
6269 "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",
6273 "name": "updateCustom_Fields",
6274 "group": "Cm_Custom_Fields",
6275 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6277 "filename": "server/api/cmCustomField/index.js",
6278 "groupTitle": "Cm_Custom_Fields"
6282 "url": "/api/cm/hopper",
6283 "title": "Creates a new Hopper",
6286 "title": "Example usage:",
6287 "content": "curl https://{domain}/api/cm/hopper -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
6291 "name": "CreateHopper",
6292 "group": "Cm_Hopper",
6314 "field": "scheduledat",
6321 "field": "countbusyretry",
6328 "field": "countcongestionretry",
6335 "field": "countnoanswerretry",
6342 "field": "callback",
6349 "field": "callbackuniqueid",
6356 "field": "callbackat",
6363 "field": "priority",
6370 "field": "recallme",
6377 "field": "ContactId",
6398 "field": "VoiceQueueId",
6405 "field": "CampaignId",
6412 "field": "countnosuchnumberretry",
6419 "field": "countdropretry",
6426 "field": "countabandonedretry",
6433 "field": "countmachineretry",
6440 "field": "countagentrejectretry",
6446 "description": "<p>Motion will return a HTTP status code <code>201</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/describe",
6454 "title": "Gets table info about Hopper",
6457 "title": "Example usage:",
6458 "content": "curl https://{domain}/api/cm/hopper/describe -v -u {name}:{password}",
6462 "name": "DescribeHopper",
6463 "group": "Cm_Hopper",
6464 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6466 "filename": "server/api/cmHopper/index.js",
6467 "groupTitle": "Cm_Hopper"
6471 "url": "/api/cm/hopper",
6472 "title": "Gets a list of Hopper",
6475 "title": "Example usage:",
6476 "content": "curl https://{domain}/api/cm/hopper -v -u {name}:{password}",
6480 "name": "GetHopper",
6481 "group": "Cm_Hopper",
6482 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
6484 "filename": "server/api/cmHopper/index.js",
6485 "groupTitle": "Cm_Hopper"
6489 "url": "/api/cm/hopper/{id}",
6490 "title": "Gets a single Hopper",
6493 "title": "Example usage:",
6494 "content": "curl https://{domain}/api/cm/hopper/{id} -v -u {name}:{password}",
6498 "name": "ShowHopper",
6499 "group": "Cm_Hopper",
6500 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <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/cmHopper/index.js",
6503 "groupTitle": "Cm_Hopper"
6507 "url": "/api/cm/hopper_black/{id}",
6508 "title": "Deletes a Hopper Black",
6511 "title": "Example usage:",
6512 "content": "curl https://{domain}/api/cm/hopper_black/{id} -v -u {name}:{password} -X DELETE",
6516 "name": "DeleteHopper_Black",
6517 "group": "Cm_Hopper_Black",
6518 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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/describe",
6526 "title": "Gets table info about Hopper Black",
6529 "title": "Example usage:",
6530 "content": "curl https://{domain}/api/cm/hopper_black/describe -v -u {name}:{password}",
6534 "name": "DescribeHopper_Black",
6535 "group": "Cm_Hopper_Black",
6536 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6538 "filename": "server/api/cmHopperBlack/index.js",
6539 "groupTitle": "Cm_Hopper_Black"
6543 "url": "/api/cm/hopper_black",
6544 "title": "Gets a list of Hopper Black",
6547 "title": "Example usage:",
6548 "content": "curl https://{domain}/api/cm/hopper_black -v -u {name}:{password}",
6552 "name": "GetHopper_Black",
6553 "group": "Cm_Hopper_Black",
6554 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
6556 "filename": "server/api/cmHopperBlack/index.js",
6557 "groupTitle": "Cm_Hopper_Black"
6561 "url": "/api/cm/hopper_black/{id}",
6562 "title": "Gets a single Hopper Black",
6565 "title": "Example usage:",
6566 "content": "curl https://{domain}/api/cm/hopper_black/{id} -v -u {name}:{password}",
6570 "name": "ShowHopper_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_black/{id}",
6580 "title": "Update an existing Hopper Black",
6583 "title": "Example usage:",
6584 "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",
6588 "name": "updateHopper_Black",
6589 "group": "Cm_Hopper_Black",
6590 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6592 "filename": "server/api/cmHopperBlack/index.js",
6593 "groupTitle": "Cm_Hopper_Black"
6597 "url": "/api/cm/hopper_final/checkContactHopper",
6598 "title": "Check if contact is in hopper",
6601 "title": "Example usage:",
6602 "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",
6606 "name": "/checkContactHopper",
6607 "group": "Cm_Hopper_Final",
6608 "description": "<p>Motion will return a HTTP status code <code>201</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/describe",
6616 "title": "Gets table info about HopperFinal",
6619 "title": "Example usage:",
6620 "content": "curl https://{domain}/api/cm/hopper_final/describe -v -u {name}:{password}",
6624 "name": "DescribeHopperFinal",
6625 "group": "Cm_Hopper_Final",
6626 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6628 "filename": "server/api/cmHopperFinal/index.js",
6629 "groupTitle": "Cm_Hopper_Final"
6633 "url": "/api/cm/hopper_final",
6634 "title": "Gets a list of HopperFinal",
6637 "title": "Example usage:",
6638 "content": "curl https://{domain}/api/cm/hopper_final -v -u {name}:{password}",
6642 "name": "GetHopperFinal",
6643 "group": "Cm_Hopper_Final",
6644 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
6646 "filename": "server/api/cmHopperFinal/index.js",
6647 "groupTitle": "Cm_Hopper_Final"
6651 "url": "/api/cm/hopper_final/{id}",
6652 "title": "Gets a single HopperFinal",
6655 "title": "Example usage:",
6656 "content": "curl https://{domain}/api/cm/hopper_final/{id} -v -u {name}:{password}",
6660 "name": "ShowHopperFinal",
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/campaign/countAttributes/{id}",
6670 "title": "Return number contacts for attributes",
6673 "title": "Example usage:",
6674 "content": "curl https://{domain}/api/hopper_final/campaign/countAttributes/{id} -d '{\"disposition\": \"OK\"}' -v -u {name}:{password} -X GET",
6678 "name": "countContactsIvrCampaignHopperFinal",
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/voice/queue/countAttributes/{id}",
6688 "title": "Return number contacts for attributes",
6691 "title": "Example usage:",
6692 "content": "curl https://{domain}/api/hopper_final/voice/queue/countAttributes/{id} -d '{\"disposition\": \"OK\"}' -v -u {name}:{password} -X GET",
6696 "name": "countContactsQueueCampaignHopperFinal",
6697 "group": "Cm_Hopper_Final",
6698 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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/campaign/{id}",
6706 "title": "Move contacts in hopper",
6709 "title": "Example usage:",
6710 "content": "curl https://{domain}/api/hopper_final/campaign/moveContacts/{id} -d '{\"state\": \"state\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
6714 "name": "moveContactsIvrCampaignHopperFinal",
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/voice/queue/{id}",
6724 "title": "Move contacts in hopper",
6727 "title": "Example usage:",
6728 "content": "curl https://{domain}/api/hopper_final/voice/queue/moveContacts/{id} -d '{\"state\": \"state\"}' -H 'Content-Type: application/json' -v -u {name}:{password}",
6732 "name": "moveContactsQueueCampaignHopperFinal",
6733 "group": "Cm_Hopper_Final",
6734 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</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_final/{id}",
6742 "title": "Update a single hopper final",
6745 "title": "Example usage:",
6746 "content": "curl https://{domain}/api/hopper_final/{id} -d '{\"disposition\": \"OK\"}' -v -u {name}:{password} -X PUT",
6751 "group": "Cm_Hopper_Final",
6752 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6754 "filename": "server/api/cmHopperFinal/index.js",
6755 "groupTitle": "Cm_Hopper_Final"
6759 "url": "/api/cm/hopper_history",
6760 "title": "Creates a new HopperHistory",
6763 "title": "Example usage:",
6764 "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",
6768 "name": "CreateHopperHistory",
6769 "group": "Cm_Hopper_History",
6784 "field": "statedesc",
6791 "field": "scheduledat",
6798 "field": "countbusyretry",
6805 "field": "countcongestionretry",
6812 "field": "countnoanswerretry",
6819 "field": "countglobal",
6826 "field": "uniqueid",
6833 "field": "originatecalleridnum",
6840 "field": "originatecalleridname",
6847 "field": "calleridnum",
6854 "field": "calleridname",
6861 "field": "starttime",
6868 "field": "responsetime",
6875 "field": "answertime",
6882 "field": "droptime",
6896 "field": "ringtime",
6903 "field": "holdtime",
6910 "field": "talktime",
6917 "field": "followuptime",
6924 "field": "dropreason",
6931 "field": "campaign",
6938 "field": "campaigntype",
6945 "field": "membername",
6973 "field": "callback",
6980 "field": "callbackuniqueid",
6987 "field": "callbackat",
6994 "field": "recallme",
7001 "field": "editedat",
7015 "field": "countnosuchnumberretry",
7022 "field": "countdropretry",
7029 "field": "countabandonedretry",
7036 "field": "countmachineretry",
7043 "field": "countagentrejectretry",
7049 "description": "<p>Motion will return a HTTP status code <code>201</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/describe",
7057 "title": "Gets table info about HopperHistory",
7060 "title": "Example usage:",
7061 "content": "curl https://{domain}/api/cm/hopper_history/describe -v -u {name}:{password}",
7065 "name": "DescribeHopperHistory",
7066 "group": "Cm_Hopper_History",
7067 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7069 "filename": "server/api/cmHopperHistory/index.js",
7070 "groupTitle": "Cm_Hopper_History"
7074 "url": "/api/cm/hopper_history",
7075 "title": "Gets a list of HopperHistory",
7078 "title": "Example usage:",
7079 "content": "curl https://{domain}/api/cm/hopper_history -v -u {name}:{password}",
7083 "name": "GetHopperHistory",
7084 "group": "Cm_Hopper_History",
7085 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
7087 "filename": "server/api/cmHopperHistory/index.js",
7088 "groupTitle": "Cm_Hopper_History"
7092 "url": "/api/cm/hopper_history/{id}",
7093 "title": "Gets a single HopperHistory",
7096 "title": "Example usage:",
7097 "content": "curl https://{domain}/api/cm/hopper_history/{id} -v -u {name}:{password}",
7101 "name": "ShowHopperHistory",
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_history/{id}",
7111 "title": "Update a single hopper history",
7114 "title": "Example usage:",
7115 "content": "curl https://{domain}/api/hopper_history/{id} -d '{\"disposition\": \"OK\"}' -v -u {name}:{password} -X PUT",
7120 "group": "Cm_Hopper_History",
7121 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <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/cmHopperHistory/index.js",
7124 "groupTitle": "Cm_Hopper_History"
7128 "url": "/api/cm/hopper/{id}",
7129 "title": "Delete Hopper",
7132 "title": "Example usage:",
7133 "content": "curl https://{domain}/api/cm/hopper/{id} -v -u {name}:{password} -X DELETE",
7138 "group": "Cm_Hopper",
7139 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <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/opencontacts",
7147 "title": "Gets Open Contacts",
7150 "title": "Example usage:",
7151 "content": "curl https://{domain}/api/cm/hopper/opencontacts -v -u {name}:{password} -X GET",
7155 "name": "getOpenContacts",
7156 "group": "Cm_Hopper",
7157 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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/preview",
7165 "title": "Gets Preview Dialer Contacts",
7168 "title": "Example usage:",
7169 "content": "curl https://{domain}/api/cm/hopper/preview -d '{\"hopperIds\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X GET",
7173 "name": "getPreview",
7174 "group": "Cm_Hopper",
7175 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</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/hopper/{id}",
7183 "title": "Update an existing Hopper",
7186 "title": "Example usage:",
7187 "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",
7191 "name": "updateHopper",
7192 "group": "Cm_Hopper",
7193 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7195 "filename": "server/api/cmHopper/index.js",
7196 "groupTitle": "Cm_Hopper"
7200 "url": "/api/cm/lists",
7201 "title": "Creates a new List",
7204 "title": "Example usage:",
7205 "content": "curl https://{domain}/api/cm/lists -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
7209 "name": "CreateLists",
7210 "group": "Cm_Lists",
7225 "field": "description",
7232 "field": "dialPrefix",
7238 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</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/{id}",
7246 "title": "Deletes a List",
7249 "title": "Example usage:",
7250 "content": "curl https://{domain}/api/cm/lists/{id} -v -u {name}:{password} -X DELETE",
7254 "name": "DeleteLists",
7255 "group": "Cm_Lists",
7256 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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/describe",
7264 "title": "Gets table info about Lists",
7267 "title": "Example usage:",
7268 "content": "curl https://{domain}/api/cm/lists/describe -v -u {name}:{password}",
7272 "name": "DescribeLists",
7273 "group": "Cm_Lists",
7274 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</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/{id}/users",
7282 "title": "Gets agents from list",
7285 "title": "Example usage:",
7286 "content": "curl https://{domain}/api/cm/lists/{id}/users -v -u {name}:{password} -X GET",
7290 "name": "GetAgents",
7291 "group": "Cm_Lists",
7292 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7294 "filename": "server/api/cmList/index.js",
7295 "groupTitle": "Cm_Lists"
7299 "url": "/api/cm/lists",
7300 "title": "Gets a list of Lists",
7303 "title": "Example usage:",
7304 "content": "curl https://{domain}/api/cm/lists -v -u {name}:{password}",
7309 "group": "Cm_Lists",
7310 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
7312 "filename": "server/api/cmList/index.js",
7313 "groupTitle": "Cm_Lists"
7317 "url": "/api/cm/lists/{id}/users",
7318 "title": "Removes agents from a list",
7321 "title": "Example usage:",
7322 "content": "curl https://{domain}/api/cm/lists/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
7326 "name": "RemoveAgents",
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}/dispositions",
7336 "title": "Removes dispositions from account",
7339 "title": "Example usage:",
7340 "content": "curl https://{domain}/api/cm/lists/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
7344 "name": "RemoveDispositions",
7345 "group": "Cm_Lists",
7346 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <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}",
7354 "title": "Gets a single List",
7357 "title": "Example usage:",
7358 "content": "curl https://{domain}/api/cm/lists/{id} -v -u {name}:{password}",
7362 "name": "ShowLists",
7363 "group": "Cm_Lists",
7364 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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}/users",
7372 "title": "Adds agents to a list",
7375 "title": "Example usage:",
7376 "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",
7380 "name": "addAgents",
7381 "group": "Cm_Lists",
7382 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7384 "filename": "server/api/cmList/index.js",
7385 "groupTitle": "Cm_Lists"
7389 "url": "/api/cm/lists/{id}/contacts",
7390 "title": "Creates new contacts",
7393 "title": "Example usage:",
7394 "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",
7398 "name": "addContacts",
7399 "group": "Cm_Lists",
7407 "field": "firstName",
7414 "field": "lastName",
7428 "field": "postalCode",
7449 "field": "dateOfBirth",
7456 "field": "description",
7498 "field": "facebook",
7554 "field": "telegram",
7568 "field": "priority",
7575 "field": "scheduledat",
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}/fields",
7589 "title": "Creates a new custom field",
7592 "title": "Example usage:",
7593 "content": "curl https://{domain}/api/cm/lists/{id}/fields -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
7597 "name": "addCustomField",
7598 "group": "Cm_Lists",
7599 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7601 "filename": "server/api/cmList/index.js",
7602 "groupTitle": "Cm_Lists"
7606 "url": "/api/cm/lists/{id}/dispositions",
7607 "title": "Creates new disposition",
7610 "title": "Example usage:",
7611 "content": "curl https://{domain}/api/cm/lists/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
7615 "name": "addDisposition",
7616 "group": "Cm_Lists",
7643 "field": "description",
7649 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</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}/contacts",
7657 "title": "Gets List Contacts",
7660 "title": "Example usage:",
7661 "content": "curl https://{domain}/api/cm/lists/{id}/contacts -v -u {name}:{password} -X GET",
7665 "name": "getContacts",
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}/fields",
7675 "title": "Gets Custom Fields",
7678 "title": "Example usage:",
7679 "content": "curl https://{domain}/api/cm/lists/{id}/fields -v -u {name}:{password} -X GET",
7683 "name": "getCustomFields",
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}/dispositions",
7693 "title": "Gets list dispositions",
7696 "title": "Example usage:",
7697 "content": "curl https://{domain}/api/cm/lists/{id}/dispositions -v -u {name}:{password} -X GET",
7701 "name": "getDispositions",
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}/contacts/csv",
7711 "title": "Gets CSV List Contacts",
7714 "title": "Example usage:",
7715 "content": "curl https://{domain}/api/cm/lists/{id}/contacts/csv -v -u {name}:{password} -X GET",
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/lists/{id}",
7729 "title": "Update an existing List",
7732 "title": "Example usage:",
7733 "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",
7737 "name": "updateLists",
7738 "group": "Cm_Lists",
7739 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7741 "filename": "server/api/cmList/index.js",
7742 "groupTitle": "Cm_Lists"
7746 "url": "/api/cm/contacts/upload/:id",
7747 "title": "Import new contacts by csv",
7750 "title": "Example usage:",
7751 "content": "curl https://{domain}/api/cm/contacts/upload/:id -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/upload",
7765 "title": "Upload csv",
7768 "title": "Example usage:",
7769 "content": "curl https://{domain}/api/cm/contacts/upload -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
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/cm/contacts/csv",
7783 "title": "Create new contacts by csv",
7786 "title": "Example usage:",
7787 "content": "curl https://{domain}/api/cm/contacts/csv -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
7791 "name": "uploadCsv",
7792 "group": "Cm_contacts",
7793 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7795 "filename": "server/api/cmContact/index.js",
7796 "groupTitle": "Cm_contacts"
7800 "url": "/api/conditions/{id}",
7801 "title": "Deletes a Condition",
7804 "title": "Example usage:",
7805 "content": "curl https://{domain}/api/conditions/{id} -v -u {name}:{password} -X DELETE",
7809 "name": "DeleteConditions",
7810 "group": "Conditions",
7811 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <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/conditions/{id}",
7819 "title": "Update an existing Condition",
7822 "title": "Example usage:",
7823 "content": "curl https://{domain}/api/conditions/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
7827 "name": "updateConditions",
7828 "group": "Conditions",
7829 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7831 "filename": "server/api/condition/index.js",
7832 "groupTitle": "Conditions"
7836 "url": "/api/cm/custom_field",
7837 "title": "Create a new custom field",
7840 "title": "Example usage:",
7841 "content": "curl https://{domain}/api/cm/custom_field -d '{\"name\": \"mycf\", \"type\": \"text\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
7845 "name": "CreateCustomField",
7846 "group": "Custom_Fields",
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/cmCustomField/index.js",
7850 "groupTitle": "Custom_Fields"
7854 "url": "/api/dashboards/items",
7855 "title": "Create dasboard item",
7858 "title": "Example usage:",
7859 "content": "curl https://{domain}/api/dashboards/items \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
7864 "group": "Dashboard_Items",
7865 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</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": "Deletes a Dashboard Item",
7876 "title": "Example usage:",
7877 "content": "curl https://{domain}/api/dashboards/items/{id} -v -u {name}:{password} -X DELETE",
7881 "name": "DeleteDashboard_Items",
7882 "group": "Dashboard_Items",
7883 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <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": "Gets a single Dashboard Item",
7894 "title": "Example usage:",
7895 "content": "curl https://{domain}/api/dashboards/items/{id} -v -u {name}:{password}",
7899 "name": "ShowDashboard_Items",
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/items/{id}",
7909 "title": "Update an existing item",
7912 "title": "Example usage:",
7913 "content": "curl https://{domain}/api/dashboards/items/{id} -v -u {name}:{password} -X PUT",
7918 "group": "Dashboard_Items",
7919 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7921 "filename": "server/api/dashboardItem/index.js",
7922 "groupTitle": "Dashboard_Items"
7926 "url": "/api/dashboards/clone",
7927 "title": "Clone an existing Dashboard",
7930 "title": "Example usage:",
7931 "content": "curl https://{domain}/api/dashboards/clone -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
7935 "name": "CloneDashboards",
7936 "group": "Dashboards",
7937 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7939 "filename": "server/api/dashboard/index.js",
7940 "groupTitle": "Dashboards"
7944 "url": "/api/dashboards",
7945 "title": "Creates a new Dashboard",
7948 "title": "Example usage:",
7949 "content": "curl https://{domain}/api/dashboards -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
7953 "name": "CreateDashboards",
7954 "group": "Dashboards",
7969 "field": "description",
7975 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</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/{id}",
7983 "title": "Deletes a Dashboard",
7986 "title": "Example usage:",
7987 "content": "curl https://{domain}/api/dashboards/{id} -v -u {name}:{password} -X DELETE",
7991 "name": "DeleteDashboards",
7992 "group": "Dashboards",
7993 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7995 "filename": "server/api/dashboard/index.js",
7996 "groupTitle": "Dashboards"
8000 "url": "/api/dashboards",
8001 "title": "Gets a list of Dashboards",
8004 "title": "Example usage:",
8005 "content": "curl https://{domain}/api/dashboards -v -u {name}:{password}",
8009 "name": "GetDashboards",
8010 "group": "Dashboards",
8011 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
8013 "filename": "server/api/dashboard/index.js",
8014 "groupTitle": "Dashboards"
8018 "url": "/api/dashboards/{id}",
8019 "title": "Gets a single Dashboard",
8022 "title": "Example usage:",
8023 "content": "curl https://{domain}/api/dashboards/{id} -v -u {name}:{password}",
8027 "name": "ShowDashboards",
8028 "group": "Dashboards",
8029 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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": "Creates new item",
8040 "title": "Example usage:",
8041 "content": "curl https://{domain}/api/dashboards/{id}/items -d '{\"type\": \"counter\", \"...\": \"...\"}]' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
8046 "group": "Dashboards",
8047 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</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}/items",
8055 "title": "Gets items",
8058 "title": "Example usage:",
8059 "content": "curl https://{domain}/api/dashboards/{id}/items -v -u {name}:{password} -X GET",
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/dashboards/{id}",
8073 "title": "Update an existing Dashboard",
8076 "title": "Example usage:",
8077 "content": "curl https://{domain}/api/dashboards/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
8081 "name": "updateDashboards",
8082 "group": "Dashboards",
8083 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8085 "filename": "server/api/dashboard/index.js",
8086 "groupTitle": "Dashboards"
8090 "url": "/api/integrations/desk/accounts",
8091 "title": "Creates a new Desk Account",
8094 "title": "Example usage:",
8095 "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",
8099 "name": "CreateDesk_Accounts",
8100 "group": "Desk_Accounts",
8115 "field": "description",
8122 "field": "username",
8129 "field": "remoteUri",
8139 "field": "authType",
8146 "field": "password",
8153 "field": "consumerKey",
8160 "field": "consumerSecret",
8174 "field": "tokenSecret",
8181 "field": "serverUrl",
8188 "\"integrationTab\"",
8198 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</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/{id}",
8206 "title": "Deletes a Desk Account",
8209 "title": "Example usage:",
8210 "content": "curl https://{domain}/api/integrations/desk/accounts/{id} -v -u {name}:{password} -X DELETE",
8214 "name": "DeleteDesk_Accounts",
8215 "group": "Desk_Accounts",
8216 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8218 "filename": "server/api/intDeskAccount/index.js",
8219 "groupTitle": "Desk_Accounts"
8223 "url": "/api/integrations/desk/accounts",
8224 "title": "Gets a list of Desk Accounts",
8227 "title": "Example usage:",
8228 "content": "curl https://{domain}/api/integrations/desk/accounts -v -u {name}:{password}",
8232 "name": "GetDesk_Accounts",
8233 "group": "Desk_Accounts",
8234 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
8236 "filename": "server/api/intDeskAccount/index.js",
8237 "groupTitle": "Desk_Accounts"
8241 "url": "/api/integrations/desk/accounts/{id}",
8242 "title": "Gets a single Desk Account",
8245 "title": "Example usage:",
8246 "content": "curl https://{domain}/api/integrations/desk/accounts/{id} -v -u {name}:{password}",
8250 "name": "ShowDesk_Accounts",
8251 "group": "Desk_Accounts",
8252 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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": "Creates new configuration",
8263 "title": "Example usage:",
8264 "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",
8268 "name": "addConfiguration",
8269 "group": "Desk_Accounts",
8270 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</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}/configurations",
8278 "title": "Gets account configurations",
8281 "title": "Example usage:",
8282 "content": "curl https://{domain}/api/integrations/desk/accounts/{id}/configurations -v -u {name}:{password} -X GET",
8286 "name": "getConfigurations",
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}/fields",
8296 "title": "Gets account fields",
8299 "title": "Example usage:",
8300 "content": "curl https://{domain}/api/integrations/desk/accounts/{id}/fields -v -u {name}:{password} -X GET",
8304 "name": "getFields",
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/accounts/{id}",
8314 "title": "Update an existing Desk Account",
8317 "title": "Example usage:",
8318 "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",
8322 "name": "updateDesk_Accounts",
8323 "group": "Desk_Accounts",
8324 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8326 "filename": "server/api/intDeskAccount/index.js",
8327 "groupTitle": "Desk_Accounts"
8331 "url": "/api/integrations/desk/configurations",
8332 "title": "Creates a new Desk Configuration",
8335 "title": "Example usage:",
8336 "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",
8340 "name": "CreateDesk_Configurations",
8341 "group": "Desk_Configurations",
8356 "field": "description",
8362 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</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/{id}",
8370 "title": "Deletes a Desk Configuration",
8373 "title": "Example usage:",
8374 "content": "curl https://{domain}/api/integrations/desk/configurations/{id} -v -u {name}:{password} -X DELETE",
8378 "name": "DeleteDesk_Configurations",
8379 "group": "Desk_Configurations",
8380 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8382 "filename": "server/api/intDeskConfiguration/index.js",
8383 "groupTitle": "Desk_Configurations"
8387 "url": "/api/integrations/desk/configurations",
8388 "title": "Gets a list of Desk Configurations",
8391 "title": "Example usage:",
8392 "content": "curl https://{domain}/api/integrations/desk/configurations -v -u {name}:{password}",
8396 "name": "GetDesk_Configurations",
8397 "group": "Desk_Configurations",
8398 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
8400 "filename": "server/api/intDeskConfiguration/index.js",
8401 "groupTitle": "Desk_Configurations"
8405 "url": "/api/integrations/desk/configurations/{id}",
8406 "title": "Gets a single Desk Configuration",
8409 "title": "Example usage:",
8410 "content": "curl https://{domain}/api/integrations/desk/configurations/{id} -v -u {name}:{password}",
8414 "name": "ShowDesk_Configurations",
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}/descriptions",
8424 "title": "Gets configurations descriptions",
8427 "title": "Example usage:",
8428 "content": "curl https://{domain}/api/integrations/desk/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
8432 "name": "getDescriptions",
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}/fields",
8442 "title": "Gets configurations fields",
8445 "title": "Example usage:",
8446 "content": "curl https://{domain}/api/integrations/desk/configurations/{id}/fields -v -u {name}:{password} -X GET",
8450 "name": "getFields",
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}/subjects",
8460 "title": "Gets configurations subjects",
8463 "title": "Example usage:",
8464 "content": "curl https://{domain}/api/integrations/desk/configurations/{id}/subjects -v -u {name}:{password} -X GET",
8468 "name": "getSubjects",
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": "Gets configurations tags",
8481 "title": "Example usage:",
8482 "content": "curl https://{domain}/api/integrations/desk/configurations/{id}/tags -v -u {name}:{password} -X GET",
8487 "group": "Desk_Configurations",
8488 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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}/tags",
8496 "title": "Sets new tags",
8499 "title": "Example usage:",
8500 "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",
8505 "group": "Desk_Configurations",
8506 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</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/configurations/{id}",
8514 "title": "Update an existing Desk Configuration",
8517 "title": "Example usage:",
8518 "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",
8522 "name": "updateDesk_Configurations",
8523 "group": "Desk_Configurations",
8524 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8526 "filename": "server/api/intDeskConfiguration/index.js",
8527 "groupTitle": "Desk_Configurations"
8531 "url": "/api/integrations/desk/fields",
8532 "title": "Creates a new Desk Field",
8535 "title": "Example usage:",
8536 "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",
8540 "name": "CreateDesk_Fields",
8541 "group": "Desk_Fields",
8551 "\"customVariable\"",
8578 "\"customVariable\""
8588 "field": "keyContent",
8602 "field": "nameField",
8609 "field": "customField",
8616 "field": "variableName",
8622 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</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/{id}",
8630 "title": "Deletes a Desk Field",
8633 "title": "Example usage:",
8634 "content": "curl https://{domain}/api/integrations/desk/fields/{id} -v -u {name}:{password} -X DELETE",
8638 "name": "DeleteDesk_Fields",
8639 "group": "Desk_Fields",
8640 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8642 "filename": "server/api/intDeskField/index.js",
8643 "groupTitle": "Desk_Fields"
8647 "url": "/api/integrations/desk/fields",
8648 "title": "Gets a list of Desk Fields",
8651 "title": "Example usage:",
8652 "content": "curl https://{domain}/api/integrations/desk/fields -v -u {name}:{password}",
8656 "name": "GetDesk_Fields",
8657 "group": "Desk_Fields",
8658 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
8660 "filename": "server/api/intDeskField/index.js",
8661 "groupTitle": "Desk_Fields"
8665 "url": "/api/integrations/desk/fields/{id}",
8666 "title": "Gets a single Desk Field",
8669 "title": "Example usage:",
8670 "content": "curl https://{domain}/api/integrations/desk/fields/{id} -v -u {name}:{password}",
8674 "name": "ShowDesk_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/integrations/desk/fields/{id}",
8684 "title": "Update an existing Desk Field",
8687 "title": "Example usage:",
8688 "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",
8692 "name": "updateDesk_Fields",
8693 "group": "Desk_Fields",
8694 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8696 "filename": "server/api/intDeskField/index.js",
8697 "groupTitle": "Desk_Fields"
8701 "url": "/api/dispositions",
8702 "title": "Creates a new Disposition",
8705 "title": "Example usage:",
8706 "content": "curl https://{domain}/api/dispositions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
8710 "name": "CreateDispositions",
8711 "group": "Dispositions",
8738 "field": "description",
8744 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</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/{id}",
8752 "title": "Deletes a Disposition",
8755 "title": "Example usage:",
8756 "content": "curl https://{domain}/api/dispositions/{id} -v -u {name}:{password} -X DELETE",
8760 "name": "DeleteDispositions",
8761 "group": "Dispositions",
8762 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8764 "filename": "server/api/disposition/index.js",
8765 "groupTitle": "Dispositions"
8769 "url": "/api/dispositions",
8770 "title": "Gets a list of Dispositions",
8773 "title": "Example usage:",
8774 "content": "curl https://{domain}/api/dispositions -v -u {name}:{password}",
8778 "name": "GetDispositions",
8779 "group": "Dispositions",
8780 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
8782 "filename": "server/api/disposition/index.js",
8783 "groupTitle": "Dispositions"
8787 "url": "/api/dispositions/{id}",
8788 "title": "Gets a single Disposition",
8791 "title": "Example usage:",
8792 "content": "curl https://{domain}/api/dispositions/{id} -v -u {name}:{password}",
8796 "name": "ShowDispositions",
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/dispositions/{id}",
8806 "title": "Update an existing Disposition",
8809 "title": "Example usage:",
8810 "content": "curl https://{domain}/api/dispositions/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
8814 "name": "updateDispositions",
8815 "group": "Dispositions",
8816 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8818 "filename": "server/api/disposition/index.js",
8819 "groupTitle": "Dispositions"
8823 "url": "/api/integrations/dynamics365/accounts",
8824 "title": "Creates a new Dynamics365 Account",
8827 "title": "Example usage:",
8828 "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",
8832 "name": "CreateDynamics365_Accounts",
8833 "group": "Dynamics365_Accounts",
8848 "field": "username",
8855 "field": "password",
8862 "field": "remoteUri",
8869 "field": "tenantId",
8876 "field": "clientId",
8883 "field": "clientSecret",
8890 "field": "serverUrl",
8897 "field": "description",
8903 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</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/{id}",
8911 "title": "Deletes a Dynamics365 Account",
8914 "title": "Example usage:",
8915 "content": "curl https://{domain}/api/integrations/dynamics365/accounts/{id} -v -u {name}:{password} -X DELETE",
8919 "name": "DeleteDynamics365_Accounts",
8920 "group": "Dynamics365_Accounts",
8921 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8923 "filename": "server/api/intDynamics365Account/index.js",
8924 "groupTitle": "Dynamics365_Accounts"
8928 "url": "/api/integrations/dynamics365/accounts",
8929 "title": "Gets a list of Dynamics365 Accounts",
8932 "title": "Example usage:",
8933 "content": "curl https://{domain}/api/integrations/dynamics365/accounts -v -u {name}:{password}",
8937 "name": "GetDynamics365_Accounts",
8938 "group": "Dynamics365_Accounts",
8939 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
8941 "filename": "server/api/intDynamics365Account/index.js",
8942 "groupTitle": "Dynamics365_Accounts"
8946 "url": "/api/integrations/dynamics365/accounts/{id}",
8947 "title": "Gets a single Dynamics365 Account",
8950 "title": "Example usage:",
8951 "content": "curl https://{domain}/api/integrations/dynamics365/accounts/{id} -v -u {name}:{password}",
8955 "name": "ShowDynamics365_Accounts",
8956 "group": "Dynamics365_Accounts",
8957 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8959 "filename": "server/api/intDynamics365Account/index.js",
8960 "groupTitle": "Dynamics365_Accounts"
8964 "url": "/api/integrations/dynamics365/accounts/{id}/configurations",
8965 "title": "Creates new configuration",
8968 "title": "Example usage:",
8969 "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",
8973 "name": "addConfiguration",
8974 "group": "Dynamics365_Accounts",
8975 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</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}/configurations",
8983 "title": "Gets account configurations",
8986 "title": "Example usage:",
8987 "content": "curl https://{domain}/api/integrations/dynamics365/accounts/{id}/configurations -v -u {name}:{password} -X GET",
8991 "name": "getConfigurations",
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}/fields",
9001 "title": "Gets account fields",
9004 "title": "Example usage:",
9005 "content": "curl https://{domain}/api/integrations/dynamics365/accounts/{id}/fields -v -u {name}:{password} -X GET",
9009 "name": "getFields",
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/accounts/{id}",
9019 "title": "Update an existing Dynamics365 Account",
9022 "title": "Example usage:",
9023 "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",
9027 "name": "updateDynamics365_Accounts",
9028 "group": "Dynamics365_Accounts",
9029 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9031 "filename": "server/api/intDynamics365Account/index.js",
9032 "groupTitle": "Dynamics365_Accounts"
9036 "url": "/api/integrations/dynamics365/configurations",
9037 "title": "Creates a new Dynamics365 Configuration",
9040 "title": "Example usage:",
9041 "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",
9045 "name": "CreateDynamics365_Configurations",
9046 "group": "Dynamics365_Configurations",
9061 "field": "description",
9072 "field": "ticketType",
9078 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</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/{id}",
9086 "title": "Deletes a Dynamics365 Configuration",
9089 "title": "Example usage:",
9090 "content": "curl https://{domain}/api/integrations/dynamics365/configurations/{id} -v -u {name}:{password} -X DELETE",
9094 "name": "DeleteDynamics365_Configurations",
9095 "group": "Dynamics365_Configurations",
9096 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9098 "filename": "server/api/intDynamics365Configuration/index.js",
9099 "groupTitle": "Dynamics365_Configurations"
9103 "url": "/api/integrations/dynamics365/configurations",
9104 "title": "Gets a list of Dynamics365 Configurations",
9107 "title": "Example usage:",
9108 "content": "curl https://{domain}/api/integrations/dynamics365/configurations -v -u {name}:{password}",
9112 "name": "GetDynamics365_Configurations",
9113 "group": "Dynamics365_Configurations",
9114 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
9116 "filename": "server/api/intDynamics365Configuration/index.js",
9117 "groupTitle": "Dynamics365_Configurations"
9121 "url": "/api/integrations/dynamics365/configurations/{id}",
9122 "title": "Gets a single Dynamics365 Configuration",
9125 "title": "Example usage:",
9126 "content": "curl https://{domain}/api/integrations/dynamics365/configurations/{id} -v -u {name}:{password}",
9130 "name": "ShowDynamics365_Configurations",
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}/descriptions",
9140 "title": "Gets configurations descriptions",
9143 "title": "Example usage:",
9144 "content": "curl https://{domain}/api/integrations/dynamics365/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
9148 "name": "getDescriptions",
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/dynamics365/configurations/{id}/fields",
9158 "title": "Gets configurations fields",
9161 "title": "Example usage:",
9162 "content": "curl https://{domain}/api/integrations/zoho/configurations/{id}/fields -v -u {name}:{password} -X GET",
9166 "name": "getFields",
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/zoho/configurations/{id}/subjects",
9176 "title": "Gets configurations subjects",
9179 "title": "Example usage:",
9180 "content": "curl https://{domain}/api/integrations/dynamics365/configurations/{id}/subjects -v -u {name}:{password} -X GET",
9184 "name": "getSubjects",
9185 "group": "Dynamics365_Configurations",
9186 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9188 "filename": "server/api/intDynamics365Configuration/index.js",
9189 "groupTitle": "Dynamics365_Configurations"
9193 "url": "/api/integrations/dynamics365/configurations/{id}",
9194 "title": "Update an existing Dynamics365 Configuration",
9197 "title": "Example usage:",
9198 "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",
9202 "name": "updateDynamics365_Configurations",
9203 "group": "Dynamics365_Configurations",
9204 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9206 "filename": "server/api/intDynamics365Configuration/index.js",
9207 "groupTitle": "Dynamics365_Configurations"
9211 "url": "/api/integrations/dynamics365/fields",
9212 "title": "Creates a new Dynamics365 Field",
9215 "title": "Example usage:",
9216 "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",
9220 "name": "CreateDynamics365_Fields",
9221 "group": "Dynamics365_Fields",
9231 "\"customVariable\"",
9258 "\"customVariable\""
9268 "field": "keyContent",
9282 "field": "nameField",
9289 "field": "customField",
9296 "field": "variableName",
9302 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</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/{id}",
9310 "title": "Deletes a Dynamics365 Field",
9313 "title": "Example usage:",
9314 "content": "curl https://{domain}/api/integrations/dynamics365/fields/{id} -v -u {name}:{password} -X DELETE",
9318 "name": "DeleteDynamics365_Fields",
9319 "group": "Dynamics365_Fields",
9320 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9322 "filename": "server/api/intDynamics365Field/index.js",
9323 "groupTitle": "Dynamics365_Fields"
9327 "url": "/api/integrations/dynamics365/fields",
9328 "title": "Gets a list of Dynamics365 Fields",
9331 "title": "Example usage:",
9332 "content": "curl https://{domain}/api/integrations/dynamics365/fields -v -u {name}:{password}",
9336 "name": "GetDynamics365_Fields",
9337 "group": "Dynamics365_Fields",
9338 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
9340 "filename": "server/api/intDynamics365Field/index.js",
9341 "groupTitle": "Dynamics365_Fields"
9345 "url": "/api/integrations/dynamics365/fields/{id}",
9346 "title": "Gets a single Dynamics365 Field",
9349 "title": "Example usage:",
9350 "content": "curl https://{domain}/api/integrations/dynamics365/fields/{id} -v -u {name}:{password}",
9354 "name": "ShowDynamics365_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/integrations/dynamics365/fields/{id}",
9364 "title": "Update an existing Dynamics365 Field",
9367 "title": "Example usage:",
9368 "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",
9372 "name": "updateDynamics365_Fields",
9373 "group": "Dynamics365_Fields",
9374 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9376 "filename": "server/api/intDynamics365Field/index.js",
9377 "groupTitle": "Dynamics365_Fields"
9381 "url": "/api/fax/accounts/{id}/users",
9382 "title": "Add agents to a fax account",
9385 "title": "Example usage:",
9386 "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",
9390 "name": "AddAgents",
9391 "group": "Fax_Accounts",
9392 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9394 "filename": "server/api/faxAccount/index.js",
9395 "groupTitle": "Fax_Accounts"
9399 "url": "/api/fax/accounts",
9400 "title": "Creates a new Account",
9403 "title": "Example usage:",
9404 "content": "curl https://{domain}/api/fax/accounts -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
9408 "name": "CreateAccounts",
9409 "group": "Fax_Accounts",
9424 "field": "description",
9442 "field": "headerinfo",
9449 "field": "localstationid",
9500 "field": "faxdetect",
9507 "field": "t38timeout",
9534 "field": "notificationTemplate",
9541 "field": "notificationSound",
9548 "field": "notificationShake",
9555 "field": "waitForTheAssignedAgent",
9562 "field": "queueTransfer",
9569 "field": "queueTransferTimeout",
9576 "field": "agentTransfer",
9583 "field": "agentTransferTimeout",
9590 "field": "mandatoryDispositionPauseId",
9591 "description": "<p>Status to put when mandatory disposition is enabled</p>"
9597 "field": "mandatoryDisposition",
9598 "description": "<p>Enabled/disables mandatory dispo on a queue</p>"
9603 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</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/{id}",
9611 "title": "Deletes a Account",
9614 "title": "Example usage:",
9615 "content": "curl https://{domain}/api/fax/accounts/{id} -v -u {name}:{password} -X DELETE",
9619 "name": "DeleteAccounts",
9620 "group": "Fax_Accounts",
9621 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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/describe",
9629 "title": "Gets table info about Accounts",
9632 "title": "Example usage:",
9633 "content": "curl https://{domain}/api/fax/accounts/describe -v -u {name}:{password}",
9637 "name": "DescribeAccounts",
9638 "group": "Fax_Accounts",
9639 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9641 "filename": "server/api/faxAccount/index.js",
9642 "groupTitle": "Fax_Accounts"
9646 "url": "/api/fax/accounts",
9647 "title": "Gets a list of Accounts",
9650 "title": "Example usage:",
9651 "content": "curl https://{domain}/api/fax/accounts -v -u {name}:{password}",
9655 "name": "GetAccounts",
9656 "group": "Fax_Accounts",
9657 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
9659 "filename": "server/api/faxAccount/index.js",
9660 "groupTitle": "Fax_Accounts"
9664 "url": "/api/fax/accounts/{id}/users",
9665 "title": "Gets agents from fax account",
9668 "title": "Example usage:",
9669 "content": "curl https://{domain}/api/fax/accounts/{id}/users -v -u {name}:{password} -X GET",
9673 "name": "GetAgents",
9674 "group": "Fax_Accounts",
9675 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <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}/users",
9683 "title": "Removes agents from a fax account",
9686 "title": "Example usage:",
9687 "content": "curl https://{domain}/api/fax/accounts/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
9691 "name": "RemoveAgents",
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}/canned_answers",
9701 "title": "Removes canned answers from account",
9704 "title": "Example usage:",
9705 "content": "curl https://{domain}/api/fax/accounts/{id}/canned_answers?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
9709 "name": "RemoveAnswers",
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}/dispositions",
9719 "title": "Removes dispositions from account",
9722 "title": "Example usage:",
9723 "content": "curl https://{domain}/api/fax/accounts/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
9727 "name": "RemoveDispositions",
9728 "group": "Fax_Accounts",
9729 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <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}",
9737 "title": "Gets a single Account",
9740 "title": "Example usage:",
9741 "content": "curl https://{domain}/api/fax/accounts/{id} -v -u {name}:{password}",
9745 "name": "ShowAccounts",
9746 "group": "Fax_Accounts",
9747 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9749 "filename": "server/api/faxAccount/index.js",
9750 "groupTitle": "Fax_Accounts"
9754 "url": "/api/fax/accounts/{id}/canned_answers",
9755 "title": "Creates new canned answer",
9758 "title": "Example usage:",
9759 "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",
9763 "name": "addAnswer",
9764 "group": "Fax_Accounts",
9786 "field": "description",
9799 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9801 "filename": "server/api/faxAccount/index.js",
9802 "groupTitle": "Fax_Accounts"
9806 "url": "/api/fax/accounts/{id}/applications",
9807 "title": "Creates new applications",
9810 "title": "Example usage:",
9811 "content": "curl https://{domain}/api/fax/accounts/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
9815 "name": "addApplications",
9816 "group": "Fax_Accounts",
9824 "field": "priority",
9845 "field": "description",
9852 "field": "interval",
9858 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9860 "filename": "server/api/faxAccount/index.js",
9861 "groupTitle": "Fax_Accounts"
9865 "url": "/api/fax/accounts/addaccountapplications",
9866 "title": "Creates new account and applications",
9869 "title": "Example usage:",
9870 "content": "curl https://{domain}/api/fax/accounts/addaccountapplications -d '[{\"name\": \"name\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
9874 "name": "addApplications",
9875 "group": "Fax_Accounts",
9883 "field": "priority",
9904 "field": "description",
9911 "field": "interval",
9917 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9919 "filename": "server/api/faxAccount/index.js",
9920 "groupTitle": "Fax_Accounts"
9924 "url": "/api/fax/accounts/{id}/dispositions",
9925 "title": "Creates new disposition",
9928 "title": "Example usage:",
9929 "content": "curl https://{domain}/api/fax/accounts/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
9933 "name": "addDisposition",
9934 "group": "Fax_Accounts",
9961 "field": "description",
9967 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9969 "filename": "server/api/faxAccount/index.js",
9970 "groupTitle": "Fax_Accounts"
9974 "url": "/api/fax/accounts/{id}/interactions",
9975 "title": "Creates new interactions",
9978 "title": "Example usage:",
9979 "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",
9983 "name": "addInteraction",
9984 "group": "Fax_Accounts",
9999 "field": "closedAt",
10006 "field": "disposition",
10013 "field": "secondDisposition",
10020 "field": "thirdDisposition",
10034 "field": "read1stAt",
10052 "field": "firstMsgDirection",
10059 "field": "lastMsgAt",
10070 "field": "lastMsgDirection",
10076 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</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}/canned_answers",
10084 "title": "Gets account canned answers",
10087 "title": "Example usage:",
10088 "content": "curl https://{domain}/api/fax/accounts/{id}/canned_answers -v -u {name}:{password} -X GET",
10092 "name": "getAnswers",
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}/applications",
10102 "title": "Gets account pplications",
10105 "title": "Example usage:",
10106 "content": "curl https://{domain}/api/fax/accounts/{id}/applications -v -u {name}:{password} -X GET",
10110 "name": "getApplications",
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}/dispositions",
10120 "title": "Gets account dispositions",
10123 "title": "Example usage:",
10124 "content": "curl https://{domain}/api/fax/accounts/{id}/dispositions -v -u {name}:{password} -X GET",
10128 "name": "getDispositions",
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}/interactions",
10138 "title": "Gets account interactions",
10141 "title": "Example usage:",
10142 "content": "curl https://{domain}/api/fax/accounts/{id}/interactions -v -u {name}:{password} -X GET",
10146 "name": "getInteraction",
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}/messages",
10156 "title": "Gets account messages",
10159 "title": "Example usage:",
10160 "content": "curl https://{domain}/api/fax/accounts/{id}/messages -v -u {name}:{password} -X GET",
10164 "name": "getMessages",
10165 "group": "Fax_Accounts",
10166 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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}/send",
10174 "title": "Send new fax",
10177 "title": "Example usage:",
10178 "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",
10183 "group": "Fax_Accounts",
10184 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</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/{id}",
10192 "title": "Update an existing Account",
10195 "title": "Example usage:",
10196 "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",
10200 "name": "updateAccounts",
10201 "group": "Fax_Accounts",
10202 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10203 "version": "0.0.0",
10204 "filename": "server/api/faxAccount/index.js",
10205 "groupTitle": "Fax_Accounts"
10209 "url": "/api/fax/accounts/updateaccountapplications",
10210 "title": "Update account and applications",
10213 "title": "Example usage:",
10214 "content": "curl https://{domain}/api/fax/accounts/updateaccountapplications -d '[{\"name\": \"name\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
10218 "name": "updateApplications",
10219 "group": "Fax_Accounts",
10227 "field": "priority",
10241 "field": "appdata",
10248 "field": "description",
10255 "field": "interval",
10261 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10262 "version": "0.0.0",
10263 "filename": "server/api/faxAccount/index.js",
10264 "groupTitle": "Fax_Accounts"
10268 "url": "/api/fax/applications",
10269 "title": "Creates a new Application",
10272 "title": "Example usage:",
10273 "content": "curl https://{domain}/api/fax/applications -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
10277 "name": "CreateApplications",
10278 "group": "Fax_Applications",
10286 "field": "priority",
10300 "field": "appdata",
10307 "field": "description",
10314 "field": "interval",
10320 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</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/{id}",
10328 "title": "Deletes a Application",
10331 "title": "Example usage:",
10332 "content": "curl https://{domain}/api/fax/applications/{id} -v -u {name}:{password} -X DELETE",
10336 "name": "DeleteApplications",
10337 "group": "Fax_Applications",
10338 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10339 "version": "0.0.0",
10340 "filename": "server/api/faxApplication/index.js",
10341 "groupTitle": "Fax_Applications"
10345 "url": "/api/fax/applications",
10346 "title": "Gets a list of Applications",
10349 "title": "Example usage:",
10350 "content": "curl https://{domain}/api/fax/applications -v -u {name}:{password}",
10354 "name": "GetApplications",
10355 "group": "Fax_Applications",
10356 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
10357 "version": "0.0.0",
10358 "filename": "server/api/faxApplication/index.js",
10359 "groupTitle": "Fax_Applications"
10363 "url": "/api/fax/applications/{id}",
10364 "title": "Gets a single Application",
10367 "title": "Example usage:",
10368 "content": "curl https://{domain}/api/fax/applications/{id} -v -u {name}:{password}",
10372 "name": "ShowApplications",
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/applications/{id}",
10382 "title": "Update an existing Application",
10385 "title": "Example usage:",
10386 "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",
10390 "name": "updateApplications",
10391 "group": "Fax_Applications",
10392 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10393 "version": "0.0.0",
10394 "filename": "server/api/faxApplication/index.js",
10395 "groupTitle": "Fax_Applications"
10399 "url": "/api/fax/interactions/{id}/tags",
10400 "title": "Add tags to the interaction",
10403 "title": "Example usage:",
10404 "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",
10409 "group": "Fax_Interactions",
10410 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10411 "version": "0.0.0",
10412 "filename": "server/api/faxInteraction/index.js",
10413 "groupTitle": "Fax_Interactions"
10417 "url": "/api/fax/interactions",
10418 "title": "Creates a new Interaction",
10421 "title": "Example usage:",
10422 "content": "curl https://{domain}/api/fax/interactions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
10426 "name": "CreateInteractions",
10427 "group": "Fax_Interactions",
10442 "field": "closedAt",
10449 "field": "disposition",
10456 "field": "secondDisposition",
10463 "field": "thirdDisposition",
10477 "field": "read1stAt",
10495 "field": "firstMsgDirection",
10502 "field": "lastMsgAt",
10513 "field": "lastMsgDirection",
10519 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</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/{id}",
10527 "title": "Deletes a Interaction",
10530 "title": "Example usage:",
10531 "content": "curl https://{domain}/api/fax/interactions/{id} -v -u {name}:{password} -X DELETE",
10535 "name": "DeleteInteractions",
10536 "group": "Fax_Interactions",
10537 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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/describe",
10545 "title": "Gets table info about Interactions",
10548 "title": "Example usage:",
10549 "content": "curl https://{domain}/api/fax/interactions/describe -v -u {name}:{password}",
10553 "name": "DescribeInteractions",
10554 "group": "Fax_Interactions",
10555 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10556 "version": "0.0.0",
10557 "filename": "server/api/faxInteraction/index.js",
10558 "groupTitle": "Fax_Interactions"
10562 "url": "/api/fax/interactions",
10563 "title": "Gets a list of Interactions",
10566 "title": "Example usage:",
10567 "content": "curl https://{domain}/api/fax/interactions -v -u {name}:{password}",
10571 "name": "GetInteractions",
10572 "group": "Fax_Interactions",
10573 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
10574 "version": "0.0.0",
10575 "filename": "server/api/faxInteraction/index.js",
10576 "groupTitle": "Fax_Interactions"
10580 "url": "/api/fax/interactions/{id}/tags",
10581 "title": "Removes tags from interaction",
10584 "title": "Example usage:",
10585 "content": "curl https://{domain}/api/fax/interactions/{id}/tags?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
10589 "name": "RemoveTags",
10590 "group": "Fax_Interactions",
10591 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <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}",
10599 "title": "Gets a single Interaction",
10602 "title": "Example usage:",
10603 "content": "curl https://{domain}/api/fax/interactions/{id} -v -u {name}:{password}",
10607 "name": "ShowInteractions",
10608 "group": "Fax_Interactions",
10609 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10610 "version": "0.0.0",
10611 "filename": "server/api/faxInteraction/index.js",
10612 "groupTitle": "Fax_Interactions"
10616 "url": "/api/fax/interactions/{id}/messages",
10617 "title": "Creates new messages",
10620 "title": "Example usage:",
10621 "content": "curl https://{domain}/api/fax/interactions/{id}/messages -d '[{\"to\": \"+3901119886500\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
10625 "name": "addMessage",
10626 "group": "Fax_Interactions",
10652 "field": "direction",
10659 "field": "failMessage",
10672 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</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}/download",
10680 "title": "Get interactions",
10683 "title": "Example usage:",
10684 "content": "curl https://{domain}/api/fax/interactions/{id}/download -v -u {name}:{password} -X GET",
10688 "name": "download",
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}/messages",
10698 "title": "Gets interaction messages",
10701 "title": "Example usage:",
10702 "content": "curl https://{domain}/api/fax/interactions/{id}/messages -v -u {name}:{password} -X GET",
10706 "name": "getMessages",
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/interactions/{id}",
10716 "title": "Update an existing Interaction",
10719 "title": "Example usage:",
10720 "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",
10724 "name": "updateInteractions",
10725 "group": "Fax_Interactions",
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/faxInteraction/index.js",
10729 "groupTitle": "Fax_Interactions"
10733 "url": "/api/fax/messages/{id}/download",
10734 "title": "Get message",
10737 "title": "Example usage:",
10738 "content": "curl https://{domain}/api/fax/messages/{id}/download -v -u {name}:{password} -X GET",
10742 "name": "download",
10743 "group": "Fax_Message",
10744 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <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_Message"
10751 "url": "/api/fax/messages/{id}",
10752 "title": "Deletes a Message",
10755 "title": "Example usage:",
10756 "content": "curl https://{domain}/api/fax/messages/{id} -v -u {name}:{password} -X DELETE",
10760 "name": "DeleteMessages",
10761 "group": "Fax_Messages",
10762 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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/describe",
10770 "title": "Gets table info about Messages",
10773 "title": "Example usage:",
10774 "content": "curl https://{domain}/api/fax/messages/describe -v -u {name}:{password}",
10778 "name": "DescribeMessages",
10779 "group": "Fax_Messages",
10780 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10781 "version": "0.0.0",
10782 "filename": "server/api/faxMessage/index.js",
10783 "groupTitle": "Fax_Messages"
10787 "url": "/api/fax/messages",
10788 "title": "Gets a list of Messages",
10791 "title": "Example usage:",
10792 "content": "curl https://{domain}/api/fax/messages -v -u {name}:{password}",
10796 "name": "GetMessages",
10797 "group": "Fax_Messages",
10798 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
10799 "version": "0.0.0",
10800 "filename": "server/api/faxMessage/index.js",
10801 "groupTitle": "Fax_Messages"
10805 "url": "/api/fax/messages/{id}",
10806 "title": "Gets a single Message",
10809 "title": "Example usage:",
10810 "content": "curl https://{domain}/api/fax/messages/{id} -v -u {name}:{password}",
10814 "name": "ShowMessages",
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/{id}/accept",
10824 "title": "Accepts message",
10827 "title": "Example usage:",
10828 "content": "curl https://{domain}/api/fax/messages/{id}/accept \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
10832 "name": "acceptMessage",
10833 "group": "Fax_Messages",
10834 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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",
10842 "title": "Create message and send Fax",
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>201</code> upon success.</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}/reject",
10860 "title": "Rejects message",
10863 "title": "Example usage:",
10864 "content": "curl https://{domain}/api/fax/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
10868 "name": "rejectMessage",
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/messages/{id}",
10878 "title": "Update an existing Message",
10881 "title": "Example usage:",
10882 "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",
10886 "name": "updateMessages",
10887 "group": "Fax_Messages",
10888 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10889 "version": "0.0.0",
10890 "filename": "server/api/faxMessage/index.js",
10891 "groupTitle": "Fax_Messages"
10895 "url": "/api/fax/reports/queue",
10896 "title": "Creates a new Fax Queue Report",
10899 "title": "Example usage:",
10900 "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",
10904 "name": "CreateFax_Queue_Reports",
10905 "group": "Fax_Queue_Reports",
10913 "field": "uniqueid",
10934 "field": "leaveAt",
10941 "field": "acceptAt",
10961 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</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/{id}",
10969 "title": "Deletes a Fax Queue Report",
10972 "title": "Example usage:",
10973 "content": "curl https://{domain}/api/fax/reports/queue/{id} -v -u {name}:{password} -X DELETE",
10977 "name": "DeleteFax_Queue_Reports",
10978 "group": "Fax_Queue_Reports",
10979 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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/describe",
10987 "title": "Gets table info about Fax Queue Reports",
10990 "title": "Example usage:",
10991 "content": "curl https://{domain}/api/fax/reports/queue/describe -v -u {name}:{password}",
10995 "name": "DescribeFax_Queue_Reports",
10996 "group": "Fax_Queue_Reports",
10997 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10998 "version": "0.0.0",
10999 "filename": "server/api/faxQueueReport/index.js",
11000 "groupTitle": "Fax_Queue_Reports"
11004 "url": "/api/fax/reports/queue",
11005 "title": "Gets a list of Fax Queue Reports",
11008 "title": "Example usage:",
11009 "content": "curl https://{domain}/api/fax/reports/queue -v -u {name}:{password}",
11013 "name": "GetFax_Queue_Reports",
11014 "group": "Fax_Queue_Reports",
11015 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
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": "Gets a single Fax Queue Report",
11026 "title": "Example usage:",
11027 "content": "curl https://{domain}/api/fax/reports/queue/{id} -v -u {name}:{password}",
11031 "name": "ShowFax_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/reports/queue/{id}",
11041 "title": "Update an existing Fax Queue Report",
11044 "title": "Example usage:",
11045 "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",
11049 "name": "updateFax_Queue_Reports",
11050 "group": "Fax_Queue_Reports",
11051 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11052 "version": "0.0.0",
11053 "filename": "server/api/faxQueueReport/index.js",
11054 "groupTitle": "Fax_Queue_Reports"
11058 "url": "/api/fax/queues/{id}/users",
11059 "title": "Add agents to a queue",
11062 "title": "Example usage:",
11063 "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",
11067 "name": "AddAgents",
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/{id}/teams",
11077 "title": "Add teams to a queue",
11080 "title": "Example usage:",
11081 "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",
11085 "name": "AddTeams",
11086 "group": "Fax_Queues",
11087 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11088 "version": "0.0.0",
11089 "filename": "server/api/faxQueue/index.js",
11090 "groupTitle": "Fax_Queues"
11094 "url": "/api/fax/queues",
11095 "title": "Creates a new Queue",
11098 "title": "Example usage:",
11099 "content": "curl https://{domain}/api/fax/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
11103 "name": "CreateQueues",
11104 "group": "Fax_Queues",
11119 "field": "description",
11126 "field": "timeout",
11138 "field": "strategy",
11145 "field": "lastAgent",
11151 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</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/{id}",
11159 "title": "Deletes a Queue",
11162 "title": "Example usage:",
11163 "content": "curl https://{domain}/api/fax/queues/{id} -v -u {name}:{password} -X DELETE",
11167 "name": "DeleteQueues",
11168 "group": "Fax_Queues",
11169 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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/describe",
11177 "title": "Gets table info about Queues",
11180 "title": "Example usage:",
11181 "content": "curl https://{domain}/api/fax/queues/describe -v -u {name}:{password}",
11185 "name": "DescribeQueues",
11186 "group": "Fax_Queues",
11187 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</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}/users",
11195 "title": "Gets queue agents",
11198 "title": "Example usage:",
11199 "content": "curl https://{domain}/api/fax/queues/{id}/users -v -u {name}:{password} -X POST",
11203 "name": "GetAgents",
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/{id}/members",
11213 "title": "GetMembers",
11216 "title": "Example usage:",
11217 "content": "curl https://{domain}/api/fax/queues/{id}/members -v -u {name}:{password}",
11221 "name": "GetMembers",
11222 "group": "Fax_Queues",
11223 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11224 "version": "0.0.0",
11225 "filename": "server/api/faxQueue/index.js",
11226 "groupTitle": "Fax_Queues"
11230 "url": "/api/fax/queues",
11231 "title": "Gets a list of Queues",
11234 "title": "Example usage:",
11235 "content": "curl https://{domain}/api/fax/queues -v -u {name}:{password}",
11239 "name": "GetQueues",
11240 "group": "Fax_Queues",
11241 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
11242 "version": "0.0.0",
11243 "filename": "server/api/faxQueue/index.js",
11244 "groupTitle": "Fax_Queues"
11248 "url": "/api/fax/queues/{id}/teams",
11249 "title": "Gets queues list",
11252 "title": "Example usage:",
11253 "content": "curl https://{domain}/api/fax/queues/{id}/teams -v -u {name}:{password}",
11257 "name": "GetTeams",
11258 "group": "Fax_Queues",
11259 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <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}/users",
11267 "title": "Removes agents from a queue",
11270 "title": "Example usage:",
11271 "content": "curl https://{domain}/api/fax/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
11275 "name": "RemoveAgents",
11276 "group": "Fax_Queues",
11277 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <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": "Gets a single Queue",
11288 "title": "Example usage:",
11289 "content": "curl https://{domain}/api/fax/queues/{id} -v -u {name}:{password}",
11293 "name": "ShowQueues",
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/queues/{id}",
11303 "title": "Update an existing Queue",
11306 "title": "Example usage:",
11307 "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",
11311 "name": "updateQueues",
11312 "group": "Fax_Queues",
11313 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11314 "version": "0.0.0",
11315 "filename": "server/api/faxQueue/index.js",
11316 "groupTitle": "Fax_Queues"
11320 "url": "/api/fax/reports/transfer",
11321 "title": "Creates a new Fax Transfer Report",
11324 "title": "Example usage:",
11325 "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",
11329 "name": "CreateFax_Transfer_Reports",
11330 "group": "Fax_Transfer_Reports",
11338 "field": "uniqueid",
11357 "field": "transferredAt",
11363 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</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/{id}",
11371 "title": "Deletes a Fax Transfer Report",
11374 "title": "Example usage:",
11375 "content": "curl https://{domain}/api/fax/reports/transfer/{id} -v -u {name}:{password} -X DELETE",
11379 "name": "DeleteFax_Transfer_Reports",
11380 "group": "Fax_Transfer_Reports",
11381 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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/describe",
11389 "title": "Gets table info about Fax Transfer Reports",
11392 "title": "Example usage:",
11393 "content": "curl https://{domain}/api/fax/reports/transfer/describe -v -u {name}:{password}",
11397 "name": "DescribeFax_Transfer_Reports",
11398 "group": "Fax_Transfer_Reports",
11399 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11400 "version": "0.0.0",
11401 "filename": "server/api/faxTransferReport/index.js",
11402 "groupTitle": "Fax_Transfer_Reports"
11406 "url": "/api/fax/reports/transfer",
11407 "title": "Gets a list of Fax Transfer Reports",
11410 "title": "Example usage:",
11411 "content": "curl https://{domain}/api/fax/reports/transfer -v -u {name}:{password}",
11415 "name": "GetFax_Transfer_Reports",
11416 "group": "Fax_Transfer_Reports",
11417 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
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": "Gets a single Fax Transfer Report",
11428 "title": "Example usage:",
11429 "content": "curl https://{domain}/api/fax/reports/transfer/{id} -v -u {name}:{password}",
11433 "name": "ShowFax_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/fax/reports/transfer/{id}",
11443 "title": "Update an existing Fax Transfer Report",
11446 "title": "Example usage:",
11447 "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",
11451 "name": "updateFax_Transfer_Reports",
11452 "group": "Fax_Transfer_Reports",
11453 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11454 "version": "0.0.0",
11455 "filename": "server/api/faxTransferReport/index.js",
11456 "groupTitle": "Fax_Transfer_Reports"
11460 "url": "/api/integrations/freshdesk/accounts",
11461 "title": "Creates a new Freshdesk Account",
11464 "title": "Example usage:",
11465 "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",
11469 "name": "CreateFreshdesk_Accounts",
11470 "group": "Freshdesk_Accounts",
11485 "field": "description",
11492 "field": "username",
11506 "field": "remoteUri",
11513 "field": "serverUrl",
11519 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</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/{id}",
11527 "title": "Deletes a Freshdesk Account",
11530 "title": "Example usage:",
11531 "content": "curl https://{domain}/api/integrations/freshdesk/accounts/{id} -v -u {name}:{password} -X DELETE",
11535 "name": "DeleteFreshdesk_Accounts",
11536 "group": "Freshdesk_Accounts",
11537 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11538 "version": "0.0.0",
11539 "filename": "server/api/intFreshdeskAccount/index.js",
11540 "groupTitle": "Freshdesk_Accounts"
11544 "url": "/api/integrations/freshdesk/accounts",
11545 "title": "Gets a list of Freshdesk Accounts",
11548 "title": "Example usage:",
11549 "content": "curl https://{domain}/api/integrations/freshdesk/accounts -v -u {name}:{password}",
11553 "name": "GetFreshdesk_Accounts",
11554 "group": "Freshdesk_Accounts",
11555 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
11556 "version": "0.0.0",
11557 "filename": "server/api/intFreshdeskAccount/index.js",
11558 "groupTitle": "Freshdesk_Accounts"
11562 "url": "/api/integrations/freshdesk/accounts/{id}",
11563 "title": "Gets a single Freshdesk Account",
11566 "title": "Example usage:",
11567 "content": "curl https://{domain}/api/integrations/freshdesk/accounts/{id} -v -u {name}:{password}",
11571 "name": "ShowFreshdesk_Accounts",
11572 "group": "Freshdesk_Accounts",
11573 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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": "Creates new configuration",
11584 "title": "Example usage:",
11585 "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",
11589 "name": "addConfiguration",
11590 "group": "Freshdesk_Accounts",
11591 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</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}/configurations",
11599 "title": "Gets account configurations",
11602 "title": "Example usage:",
11603 "content": "curl https://{domain}/api/integrations/freshdesk/accounts/{id}/configurations -v -u {name}:{password} -X GET",
11607 "name": "getConfigurations",
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}/fields",
11617 "title": "Gets account fields",
11620 "title": "Example usage:",
11621 "content": "curl https://{domain}/api/integrations/freshdesk/accounts/{id}/fields -v -u {name}:{password} -X GET",
11625 "name": "getFields",
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/accounts/{id}",
11635 "title": "Update an existing Freshdesk Account",
11638 "title": "Example usage:",
11639 "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",
11643 "name": "updateFreshdesk_Accounts",
11644 "group": "Freshdesk_Accounts",
11645 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11646 "version": "0.0.0",
11647 "filename": "server/api/intFreshdeskAccount/index.js",
11648 "groupTitle": "Freshdesk_Accounts"
11652 "url": "/api/integrations/freshdesk/configurations",
11653 "title": "Creates a new Freshdesk Configuration",
11656 "title": "Example usage:",
11657 "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",
11661 "name": "CreateFreshdesk_Configurations",
11662 "group": "Freshdesk_Configurations",
11677 "field": "description",
11683 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</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/{id}",
11691 "title": "Deletes a Freshdesk Configuration",
11694 "title": "Example usage:",
11695 "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id} -v -u {name}:{password} -X DELETE",
11699 "name": "DeleteFreshdesk_Configurations",
11700 "group": "Freshdesk_Configurations",
11701 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11702 "version": "0.0.0",
11703 "filename": "server/api/intFreshdeskConfiguration/index.js",
11704 "groupTitle": "Freshdesk_Configurations"
11708 "url": "/api/integrations/freshdesk/configurations",
11709 "title": "Gets a list of Freshdesk Configurations",
11712 "title": "Example usage:",
11713 "content": "curl https://{domain}/api/integrations/freshdesk/configurations -v -u {name}:{password}",
11717 "name": "GetFreshdesk_Configurations",
11718 "group": "Freshdesk_Configurations",
11719 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
11720 "version": "0.0.0",
11721 "filename": "server/api/intFreshdeskConfiguration/index.js",
11722 "groupTitle": "Freshdesk_Configurations"
11726 "url": "/api/integrations/freshdesk/configurations/{id}",
11727 "title": "Gets a single Freshdesk Configuration",
11730 "title": "Example usage:",
11731 "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id} -v -u {name}:{password}",
11735 "name": "ShowFreshdesk_Configurations",
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}/descriptions",
11745 "title": "Gets configurations descriptions",
11748 "title": "Example usage:",
11749 "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
11753 "name": "getDescriptions",
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}/fields",
11763 "title": "Gets configurations fields",
11766 "title": "Example usage:",
11767 "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id}/fields -v -u {name}:{password} -X GET",
11771 "name": "getFields",
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}/subjects",
11781 "title": "Gets configurations subjects",
11784 "title": "Example usage:",
11785 "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id}/subjects -v -u {name}:{password} -X GET",
11789 "name": "getSubjects",
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": "Gets configurations tags",
11802 "title": "Example usage:",
11803 "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id}/tags -v -u {name}:{password} -X GET",
11808 "group": "Freshdesk_Configurations",
11809 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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}/tags",
11817 "title": "Sets new tags",
11820 "title": "Example usage:",
11821 "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",
11826 "group": "Freshdesk_Configurations",
11827 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</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/configurations/{id}",
11835 "title": "Update an existing Freshdesk Configuration",
11838 "title": "Example usage:",
11839 "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",
11843 "name": "updateFreshdesk_Configurations",
11844 "group": "Freshdesk_Configurations",
11845 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11846 "version": "0.0.0",
11847 "filename": "server/api/intFreshdeskConfiguration/index.js",
11848 "groupTitle": "Freshdesk_Configurations"
11852 "url": "/api/integrations/freshdesk/fields",
11853 "title": "Creates a new Freshdesk Field",
11856 "title": "Example usage:",
11857 "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",
11861 "name": "CreateFreshdesk_Fields",
11862 "group": "Freshdesk_Fields",
11872 "\"customVariable\"",
11883 "field": "content",
11899 "\"customVariable\""
11902 "field": "keyType",
11909 "field": "keyContent",
11916 "field": "idField",
11923 "field": "nameField",
11930 "field": "customField",
11937 "field": "variableName",
11943 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</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/{id}",
11951 "title": "Deletes a Freshdesk Field",
11954 "title": "Example usage:",
11955 "content": "curl https://{domain}/api/integrations/freshdesk/fields/{id} -v -u {name}:{password} -X DELETE",
11959 "name": "DeleteFreshdesk_Fields",
11960 "group": "Freshdesk_Fields",
11961 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11962 "version": "0.0.0",
11963 "filename": "server/api/intFreshdeskField/index.js",
11964 "groupTitle": "Freshdesk_Fields"
11968 "url": "/api/integrations/freshdesk/fields",
11969 "title": "Gets a list of Freshdesk Fields",
11972 "title": "Example usage:",
11973 "content": "curl https://{domain}/api/integrations/freshdesk/fields -v -u {name}:{password}",
11977 "name": "GetFreshdesk_Fields",
11978 "group": "Freshdesk_Fields",
11979 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
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": "Gets a single Freshdesk Field",
11990 "title": "Example usage:",
11991 "content": "curl https://{domain}/api/integrations/freshdesk/fields/{id} -v -u {name}:{password}",
11995 "name": "ShowFreshdesk_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/freshdesk/fields/{id}",
12005 "title": "Update an existing Freshdesk Field",
12008 "title": "Example usage:",
12009 "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",
12013 "name": "updateFreshdesk_Fields",
12014 "group": "Freshdesk_Fields",
12015 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12016 "version": "0.0.0",
12017 "filename": "server/api/intFreshdeskField/index.js",
12018 "groupTitle": "Freshdesk_Fields"
12022 "url": "/api/integrations/freshsales/accounts",
12023 "title": "Creates a new Freshsales Account",
12026 "title": "Example usage:",
12027 "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",
12031 "name": "CreateFreshsales_Accounts",
12032 "group": "Freshsales_Accounts",
12047 "field": "description",
12054 "field": "username",
12068 "field": "remoteUri",
12075 "field": "serverUrl",
12081 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</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/{id}",
12089 "title": "Deletes a Freshsales Account",
12092 "title": "Example usage:",
12093 "content": "curl https://{domain}/api/integrations/freshsales/accounts/{id} -v -u {name}:{password} -X DELETE",
12097 "name": "DeleteFreshsales_Accounts",
12098 "group": "Freshsales_Accounts",
12099 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12100 "version": "0.0.0",
12101 "filename": "server/api/intFreshsalesAccount/index.js",
12102 "groupTitle": "Freshsales_Accounts"
12106 "url": "/api/integrations/freshsales/accounts",
12107 "title": "Gets a list of Freshsales Accounts",
12110 "title": "Example usage:",
12111 "content": "curl https://{domain}/api/integrations/freshsales/accounts -v -u {name}:{password}",
12115 "name": "GetFreshsales_Accounts",
12116 "group": "Freshsales_Accounts",
12117 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
12118 "version": "0.0.0",
12119 "filename": "server/api/intFreshsalesAccount/index.js",
12120 "groupTitle": "Freshsales_Accounts"
12124 "url": "/api/integrations/freshsales/accounts/{id}",
12125 "title": "Gets a single Freshsales Account",
12128 "title": "Example usage:",
12129 "content": "curl https://{domain}/api/integrations/freshsales/accounts/{id} -v -u {name}:{password}",
12133 "name": "ShowFreshsales_Accounts",
12134 "group": "Freshsales_Accounts",
12135 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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": "Creates new configuration",
12146 "title": "Example usage:",
12147 "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",
12151 "name": "addConfiguration",
12152 "group": "Freshsales_Accounts",
12153 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</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}/configurations",
12161 "title": "Gets account configurations",
12164 "title": "Example usage:",
12165 "content": "curl https://{domain}/api/integrations/freshsales/accounts/{id}/configurations -v -u {name}:{password} -X GET",
12169 "name": "getConfigurations",
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}/fields",
12179 "title": "Gets account fields",
12182 "title": "Example usage:",
12183 "content": "curl https://{domain}/api/integrations/freshsales/accounts/{id}/fields -v -u {name}:{password} -X GET",
12187 "name": "getFields",
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/accounts/{id}",
12197 "title": "Update an existing Freshsales Account",
12200 "title": "Example usage:",
12201 "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",
12205 "name": "updateFreshsales_Accounts",
12206 "group": "Freshsales_Accounts",
12207 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12208 "version": "0.0.0",
12209 "filename": "server/api/intFreshsalesAccount/index.js",
12210 "groupTitle": "Freshsales_Accounts"
12214 "url": "/api/integrations/freshsales/configurations",
12215 "title": "Creates a new Freshsales Configuration",
12218 "title": "Example usage:",
12219 "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",
12223 "name": "CreateFreshsales_Configurations",
12224 "group": "Freshsales_Configurations",
12239 "field": "description",
12245 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</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/{id}",
12253 "title": "Deletes a Freshsales Configuration",
12256 "title": "Example usage:",
12257 "content": "curl https://{domain}/api/integrations/freshsales/configurations/{id} -v -u {name}:{password} -X DELETE",
12261 "name": "DeleteFreshsales_Configurations",
12262 "group": "Freshsales_Configurations",
12263 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12264 "version": "0.0.0",
12265 "filename": "server/api/intFreshsalesConfiguration/index.js",
12266 "groupTitle": "Freshsales_Configurations"
12270 "url": "/api/integrations/freshsales/configurations",
12271 "title": "Gets a list of Freshsales Configurations",
12274 "title": "Example usage:",
12275 "content": "curl https://{domain}/api/integrations/freshsales/configurations -v -u {name}:{password}",
12279 "name": "GetFreshsales_Configurations",
12280 "group": "Freshsales_Configurations",
12281 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
12282 "version": "0.0.0",
12283 "filename": "server/api/intFreshsalesConfiguration/index.js",
12284 "groupTitle": "Freshsales_Configurations"
12288 "url": "/api/integrations/freshsales/configurations/{id}",
12289 "title": "Gets a single Freshsales Configuration",
12292 "title": "Example usage:",
12293 "content": "curl https://{domain}/api/integrations/freshsales/configurations/{id} -v -u {name}:{password}",
12297 "name": "ShowFreshsales_Configurations",
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}/descriptions",
12307 "title": "Gets configurations descriptions",
12310 "title": "Example usage:",
12311 "content": "curl https://{domain}/api/integrations/freshsales/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
12315 "name": "getDescriptions",
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}/fields",
12325 "title": "Gets configurations fields",
12328 "title": "Example usage:",
12329 "content": "curl https://{domain}/api/integrations/freshsales/configurations/{id}/fields -v -u {name}:{password} -X GET",
12333 "name": "getFields",
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}/subjects",
12343 "title": "Gets configurations subjects",
12346 "title": "Example usage:",
12347 "content": "curl https://{domain}/api/integrations/freshsales/configurations/{id}/subjects -v -u {name}:{password} -X GET",
12351 "name": "getSubjects",
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/configurations/{id}",
12361 "title": "Update an existing Freshsales Configuration",
12364 "title": "Example usage:",
12365 "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",
12369 "name": "updateFreshsales_Configurations",
12370 "group": "Freshsales_Configurations",
12371 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12372 "version": "0.0.0",
12373 "filename": "server/api/intFreshsalesConfiguration/index.js",
12374 "groupTitle": "Freshsales_Configurations"
12378 "url": "/api/integrations/freshsales/fields",
12379 "title": "Creates a new Freshsales Field",
12382 "title": "Example usage:",
12383 "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",
12387 "name": "CreateFreshsales_Fields",
12388 "group": "Freshsales_Fields",
12398 "\"customVariable\"",
12409 "field": "content",
12425 "\"customVariable\""
12428 "field": "keyType",
12435 "field": "keyContent",
12442 "field": "idField",
12449 "field": "nameField",
12456 "field": "customField",
12463 "field": "variableName",
12469 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</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/{id}",
12477 "title": "Deletes a Freshsales Field",
12480 "title": "Example usage:",
12481 "content": "curl https://{domain}/api/integrations/freshsales/fields/{id} -v -u {name}:{password} -X DELETE",
12485 "name": "DeleteFreshsales_Fields",
12486 "group": "Freshsales_Fields",
12487 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12488 "version": "0.0.0",
12489 "filename": "server/api/intFreshsalesField/index.js",
12490 "groupTitle": "Freshsales_Fields"
12494 "url": "/api/integrations/freshsales/fields",
12495 "title": "Gets a list of Freshsales Fields",
12498 "title": "Example usage:",
12499 "content": "curl https://{domain}/api/integrations/freshsales/fields -v -u {name}:{password}",
12503 "name": "GetFreshsales_Fields",
12504 "group": "Freshsales_Fields",
12505 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
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": "Gets a single Freshsales Field",
12516 "title": "Example usage:",
12517 "content": "curl https://{domain}/api/integrations/freshsales/fields/{id} -v -u {name}:{password}",
12521 "name": "ShowFreshsales_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/integrations/freshsales/fields/{id}",
12531 "title": "Update an existing Freshsales Field",
12534 "title": "Example usage:",
12535 "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",
12539 "name": "updateFreshsales_Fields",
12540 "group": "Freshsales_Fields",
12541 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12542 "version": "0.0.0",
12543 "filename": "server/api/intFreshsalesField/index.js",
12544 "groupTitle": "Freshsales_Fields"
12548 "url": "/api/campaigns/{id}/blacklists",
12549 "title": "Add blacklists to an IVR campaign",
12552 "title": "Example usage:",
12553 "content": "curl https://{domain}/api/campaigns/{id}/blacklists -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
12557 "name": "AddBlackLists",
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/{id}/lists",
12567 "title": "Add lists to an IVR campaign",
12570 "title": "Example usage:",
12571 "content": "curl https://{domain}/api/campaigns/{id}/lists -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
12575 "name": "AddLists",
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/clone",
12585 "title": "Clone an existing IVR Campaign",
12588 "title": "Example usage:",
12589 "content": "curl https://{domain}/api/campaigns/clone -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
12593 "name": "CloneIVR_Campaigns",
12594 "group": "IVR_Campaigns",
12595 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12596 "version": "0.0.0",
12597 "filename": "server/api/campaign/index.js",
12598 "groupTitle": "IVR_Campaigns"
12602 "url": "/api/campaigns",
12603 "title": "Creates a new IVR Campaign",
12606 "title": "Example usage:",
12607 "content": "curl https://{domain}/api/campaigns -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
12611 "name": "CreateIVR_Campaigns",
12612 "group": "IVR_Campaigns",
12637 "field": "description",
12645 "description": "<p>Active/Disactive Campaign</p>"
12651 "field": "limitCalls",
12652 "description": "<p>Max 200 calls.</p>"
12658 "field": "dialOriginateCallerIdName",
12665 "field": "dialOriginateCallerIdNumber",
12672 "field": "dialOriginateTimeout",
12673 "description": "<p>Originate Timeout Seconds (min:1, max:999)</p>"
12679 "field": "dialCongestionMaxRetry",
12680 "description": "<p>#Congestion Retry (min:1, max:999)</p>"
12686 "field": "dialCongestionRetryFrequency",
12687 "description": "<p>Congestion Retry Frequency Minutes (min:1, max:99999)</p>"
12693 "field": "dialBusyMaxRetry",
12694 "description": "<p>#Busy Retry (min:1, max:999)</p>"
12700 "field": "dialBusyRetryFrequency",
12701 "description": "<p>Busy Retry Frequency Minutes (min:1, max:99999)</p>"
12707 "field": "dialNoAnswerMaxRetry",
12708 "description": "<p>#NoAnswer Retry (min:1, max:999)</p>"
12714 "field": "dialNoAnswerRetryFrequency",
12715 "description": "<p>NoAnswer Retry Frequency Minutes (min:1, max:99999)</p>"
12721 "field": "dialGlobalMaxRetry",
12722 "description": "<p>#Global Max Retry (min:1, max:999)</p>"
12728 "field": "dialTimezone",
12735 "field": "dialGlobalInterval",
12747 "field": "dialCheckDuplicateType",
12754 "field": "dialAMDActive",
12755 "description": "<p>Active/Disactive AMD</p>"
12761 "field": "dialAMDInitialSilence",
12762 "description": "<p>#AMD Initial Silence</p>"
12768 "field": "dialAMDGreeting",
12769 "description": "<p>#AMD Greeting</p>"
12775 "field": "dialAMDAfterGreetingSilence",
12776 "description": "<p>#AMD After Greeting Silence</p>"
12782 "field": "dialAMDTotalAnalysisTime",
12783 "description": "<p>#AMD Total Analysis Time</p>"
12789 "field": "dialAMDMinWordLength",
12790 "description": "<p>#AMD Min Word Length</p>"
12796 "field": "dialAMDBetweenWordsSilence",
12797 "description": "<p>#AMD Between Words Silence</p>"
12803 "field": "dialAMDMaximumNumberOfWords",
12804 "description": "<p>#AMD Maximum Number Of Words</p>"
12810 "field": "dialAMDSilenceThreshold",
12811 "description": "<p>#AMD Silence Threshold (min:0, max:32767)</p>"
12817 "field": "dialAMDMaximumWordLength",
12818 "description": "<p>#AMD Maximum Word Length</p>"
12828 "field": "dialOrderByScheduledAt",
12835 "field": "dialPrefix",
12842 "field": "dialRandomLastDigitCallerIdNumber",
12843 "description": "<p>Random Last Digit (min:1, max:15)</p>"
12849 "field": "dialCutDigit",
12850 "description": "<p>Cut Digit (min:1, max:15)</p>"
12856 "field": "dialNoSuchNumberMaxRetry",
12857 "description": "<p>#NoSuchNumber Retry (min:1, max:999)</p>"
12863 "field": "dialNoSuchNumberRetryFrequency",
12864 "description": "<p>NoSuchNumber Retry Frequency Minutes (min:1, max:99999)</p>"
12870 "field": "dialDropMaxRetry",
12871 "description": "<p>#Drop Retry (min:1, max:999)</p>"
12877 "field": "dialDropRetryFrequency",
12878 "description": "<p>Drop Retry Frequency Minutes (min:1, max:99999)</p>"
12884 "field": "dialAbandonedMaxRetry",
12885 "description": "<p>#Abandoned Retry (min:1, max:999)</p>"
12891 "field": "dialAbandonedRetryFrequency",
12892 "description": "<p>Abandoned Retry Frequency Minutes (min:1, max:99999)</p>"
12898 "field": "dialMachineMaxRetry",
12899 "description": "<p>#Machine Retry (min:1, max:999)</p>"
12905 "field": "dialMachineRetryFrequency",
12906 "description": "<p>Machine Retry Frequency Minutes (min:1, max:99999)</p>"
12912 "field": "dialAgentRejectMaxRetry",
12913 "description": "<p>#AgentReject Retry (min:1, max:999)</p>"
12919 "field": "dialAgentRejectRetryFrequency",
12920 "description": "<p>AgentReject Retry Frequency Minutes (min:1, max:99999)</p>"
12925 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</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}",
12933 "title": "Deletes a IVR Campaign",
12936 "title": "Example usage:",
12937 "content": "curl https://{domain}/api/campaigns/{id} -v -u {name}:{password} -X DELETE",
12941 "name": "DeleteIVR_Campaigns",
12942 "group": "IVR_Campaigns",
12943 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <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}/blacklists",
12951 "title": "Get IVR campaign blacklists",
12954 "title": "Example usage:",
12955 "content": "curl https://{domain}/api/campaigns/{id}/blacklists -v -u {name}:{password} -X GET",
12959 "name": "GetBlackLists",
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}/finals",
12969 "title": "Gets IVR campaign hopper finals",
12972 "title": "Example usage:",
12973 "content": "curl https://{domain}/api/campaigns/{id}/hopper_finals -v -u {name}:{password} -X GET",
12977 "name": "GetHopperFinals",
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}/hopper_histories",
12987 "title": "Gets IVR campaign hopper histories",
12990 "title": "Example usage:",
12991 "content": "curl https://{domain}/api/campaigns/{id}/hopper_histories -v -u {name}:{password} -X GET",
12995 "name": "GetHopperHistories",
12996 "group": "IVR_Campaigns",
12997 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12998 "version": "0.0.0",
12999 "filename": "server/api/campaign/index.js",
13000 "groupTitle": "IVR_Campaigns"
13004 "url": "/api/campaigns/{id}/hoppers",
13005 "title": "Gets IVR campaign hoppers",
13008 "title": "Example usage:",
13009 "content": "curl https://{domain}/api/campaigns/{id}/hoppers -v -u {name}:{password} -X GET",
13013 "name": "GetHoppers",
13014 "group": "IVR_Campaigns",
13015 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13016 "version": "0.0.0",
13017 "filename": "server/api/campaign/index.js",
13018 "groupTitle": "IVR_Campaigns"
13022 "url": "/api/campaigns",
13023 "title": "Gets a list of IVR Campaigns",
13026 "title": "Example usage:",
13027 "content": "curl https://{domain}/api/campaigns -v -u {name}:{password}",
13031 "name": "GetIVR_Campaigns",
13032 "group": "IVR_Campaigns",
13033 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
13034 "version": "0.0.0",
13035 "filename": "server/api/campaign/index.js",
13036 "groupTitle": "IVR_Campaigns"
13040 "url": "/api/campaigns/{id}/lists",
13041 "title": "Get IVR campaign lists",
13044 "title": "Example usage:",
13045 "content": "curl https://{domain}/api/campaigns/{id}/lists -v -u {name}:{password} -X GET",
13049 "name": "GetLists",
13050 "group": "IVR_Campaigns",
13051 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <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}/blacklists",
13059 "title": "Remove blacklists from an IVR Campaign",
13062 "title": "Example usage:",
13063 "content": "curl https://{domain}/api/campaigns/{id}/blacklists?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
13067 "name": "RemoveBlackLists",
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}/lists",
13077 "title": "Remove lists from an IVR Campaign",
13080 "title": "Example usage:",
13081 "content": "curl https://{domain}/api/campaigns/{id}/lists?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
13085 "name": "RemoveLists",
13086 "group": "IVR_Campaigns",
13087 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13088 "version": "0.0.0",
13089 "filename": "server/api/campaign/index.js",
13090 "groupTitle": "IVR_Campaigns"
13094 "url": "/api/campaigns/{id}",
13095 "title": "Gets a single IVR Campaign",
13098 "title": "Example usage:",
13099 "content": "curl https://{domain}/api/campaigns/{id} -v -u {name}:{password}",
13103 "name": "ShowIVR_Campaigns",
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}/blacks",
13113 "title": "Gets IVR campaign hopper blacks",
13116 "title": "Example usage:",
13117 "content": "curl https://{domain}/api/campaigns/{id}/hopper_black -v -u {name}:{password} -X GET",
13121 "name": "getHopperBlacks",
13122 "group": "IVR_Campaigns",
13123 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13124 "version": "0.0.0",
13125 "filename": "server/api/campaign/index.js",
13126 "groupTitle": "IVR_Campaigns"
13130 "url": "/api/campaigns/{id}",
13131 "title": "Update an existing IVR Campaign",
13134 "title": "Example usage:",
13135 "content": "curl https://{domain}/api/campaigns/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
13139 "name": "updateIVR_Campaigns",
13140 "group": "IVR_Campaigns",
13141 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13142 "version": "0.0.0",
13143 "filename": "server/api/campaign/index.js",
13144 "groupTitle": "IVR_Campaigns"
13148 "url": "/api/integrations/reports",
13149 "title": "Creates a new Integration Report",
13152 "title": "Example usage:",
13153 "content": "curl https://{domain}/api/integrations/reports -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
13157 "name": "CreateIntegration_Reports",
13158 "group": "Integration_Reports",
13166 "field": "integration",
13173 "field": "eventChannel",
13180 "field": "exitStatus",
13187 "field": "ticketId",
13194 "field": "integrationId",
13201 "field": "contacts",
13208 "field": "uniqueid",
13215 "field": "calleridnum",
13222 "field": "calleridname",
13236 "field": "interface",
13243 "field": "membername",
13250 "field": "agentcalledAt",
13257 "field": "agentconnectAt",
13264 "field": "holdtime",
13271 "field": "agentcomplete",
13278 "field": "agentcompleteAt",
13285 "field": "talktime",
13292 "field": "agentacw",
13299 "field": "acwtime",
13313 "field": "agentringnoanswer",
13320 "field": "agentringnoanswerAt",
13327 "field": "agentdump",
13334 "field": "agentdumpAt",
13341 "field": "lastevent",
13348 "field": "channel",
13355 "field": "channelstate",
13362 "field": "channelstatedesc",
13369 "field": "connectedlinenum",
13376 "field": "connectedlinename",
13383 "field": "language",
13390 "field": "accountcode",
13397 "field": "context",
13411 "field": "priority",
13418 "field": "destchannel",
13425 "field": "destchannelstate",
13432 "field": "destchannelstatedesc",
13439 "field": "destcalleridnum",
13446 "field": "destcalleridname",
13453 "field": "destconnectedlinenum",
13460 "field": "destconnectedlinename",
13467 "field": "destlanguage",
13474 "field": "destaccountcode",
13481 "field": "destcontext",
13488 "field": "destexten",
13495 "field": "destpriority",
13502 "field": "destuniqueid",
13509 "field": "messageId",
13516 "field": "inReplyTo",
13523 "field": "subject",
13551 "field": "attachment",
13599 "field": "appdata",
13606 "field": "projectId",
13612 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</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/{id}",
13620 "title": "Deletes a Integration Report",
13623 "title": "Example usage:",
13624 "content": "curl https://{domain}/api/integrations/reports/{id} -v -u {name}:{password} -X DELETE",
13628 "name": "DeleteIntegration_Reports",
13629 "group": "Integration_Reports",
13630 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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/describe",
13638 "title": "Gets table info about Integration Reports",
13641 "title": "Example usage:",
13642 "content": "curl https://{domain}/api/integrations/reports/describe -v -u {name}:{password}",
13646 "name": "DescribeIntegration_Reports",
13647 "group": "Integration_Reports",
13648 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13649 "version": "0.0.0",
13650 "filename": "server/api/integrationReport/index.js",
13651 "groupTitle": "Integration_Reports"
13655 "url": "/api/integrations/reports",
13656 "title": "Gets a list of Integration Reports",
13659 "title": "Example usage:",
13660 "content": "curl https://{domain}/api/integrations/reports -v -u {name}:{password}",
13664 "name": "GetIntegration_Reports",
13665 "group": "Integration_Reports",
13666 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
13667 "version": "0.0.0",
13668 "filename": "server/api/integrationReport/index.js",
13669 "groupTitle": "Integration_Reports"
13673 "url": "/api/integrations/reports/{id}",
13674 "title": "Gets a single Integration Report",
13677 "title": "Example usage:",
13678 "content": "curl https://{domain}/api/integrations/reports/{id} -v -u {name}:{password}",
13682 "name": "ShowIntegration_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/integrations/reports/{id}",
13692 "title": "Update an existing Integration Report",
13695 "title": "Example usage:",
13696 "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",
13700 "name": "updateIntegration_Reports",
13701 "group": "Integration_Reports",
13702 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13703 "version": "0.0.0",
13704 "filename": "server/api/integrationReport/index.js",
13705 "groupTitle": "Integration_Reports"
13709 "url": "/api/intervals",
13710 "title": "Creates a new Interval",
13713 "title": "Example usage:",
13714 "content": "curl https://{domain}/api/intervals -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
13718 "name": "CreateIntervals",
13719 "group": "Intervals",
13734 "field": "description",
13741 "field": "interval",
13747 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</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/{id}",
13755 "title": "Deletes a Interval",
13758 "title": "Example usage:",
13759 "content": "curl https://{domain}/api/intervals/{id} -v -u {name}:{password} -X DELETE",
13763 "name": "DeleteIntervals",
13764 "group": "Intervals",
13765 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13766 "version": "0.0.0",
13767 "filename": "server/api/interval/index.js",
13768 "groupTitle": "Intervals"
13772 "url": "/api/intervals",
13773 "title": "Gets a list of Intervals",
13776 "title": "Example usage:",
13777 "content": "curl https://{domain}/api/intervals -v -u {name}:{password}",
13781 "name": "GetIntervals",
13782 "group": "Intervals",
13783 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
13784 "version": "0.0.0",
13785 "filename": "server/api/interval/index.js",
13786 "groupTitle": "Intervals"
13790 "url": "/api/intervals/{id}",
13791 "title": "Gets a single Interval",
13794 "title": "Example usage:",
13795 "content": "curl https://{domain}/api/intervals/{id} -v -u {name}:{password}",
13799 "name": "ShowIntervals",
13800 "group": "Intervals",
13801 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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",
13809 "title": "Creates a new sub interval",
13812 "title": "Example usage:",
13813 "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",
13817 "name": "addInterval",
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/create_many",
13827 "title": "Create new sub intervals set",
13830 "title": "Example usage:",
13831 "content": "curl https://{domain}/api/intervals/{id}/sub_intervals -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
13835 "name": "addIntervals",
13836 "group": "Intervals",
13837 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13838 "version": "0.0.0",
13839 "filename": "server/api/interval/index.js",
13840 "groupTitle": "Intervals"
13844 "url": "/api/intervals/{id}/sub_intervals",
13845 "title": "Get sub intervals set",
13848 "title": "Example usage:",
13849 "content": "curl https://{domain}/api/intervals/{id}/sub_intervals -v -u {name}:{password} -X GET",
13853 "name": "getIntervals",
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/intervals/{id}",
13863 "title": "Update an existing Interval",
13866 "title": "Example usage:",
13867 "content": "curl https://{domain}/api/intervals/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
13871 "name": "updateIntervals",
13872 "group": "Intervals",
13873 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13874 "version": "0.0.0",
13875 "filename": "server/api/interval/index.js",
13876 "groupTitle": "Intervals"
13880 "url": "/api/jira",
13881 "title": "Creates a new issue",
13884 "title": "Example usage:",
13885 "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}",
13889 "name": "Creates_Issue",
13901 "field": "issuetype",
13908 "field": "summary",
13915 "field": "description",
13921 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13922 "version": "0.0.0",
13923 "filename": "server/api/jira/index.js",
13924 "groupTitle": "Issue"
13928 "url": "/api/jscripty/answers/reports",
13929 "title": "Creates a new Report",
13932 "title": "Example usage:",
13933 "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",
13937 "name": "CreateReports",
13938 "group": "JscriptyAnswerReport",
13946 "field": "question",
13960 "field": "membername",
13967 "field": "projectname",
13981 "field": "uniqueid",
13988 "field": "calleridname",
13995 "field": "calleridnum",
14002 "field": "questionId",
14008 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</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/{id}",
14016 "title": "Deletes a Report",
14019 "title": "Example usage:",
14020 "content": "curl https://{domain}/api/jscripty/answers/reports/{id} -v -u {name}:{password} -X DELETE",
14024 "name": "DeleteReports",
14025 "group": "JscriptyAnswerReport",
14026 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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/describe",
14034 "title": "Gets table info about Reports",
14037 "title": "Example usage:",
14038 "content": "curl https://{domain}/api/jscripty/answers/reports/describe -v -u {name}:{password}",
14042 "name": "DescribeReports",
14043 "group": "JscriptyAnswerReport",
14044 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14045 "version": "0.0.0",
14046 "filename": "server/api/jscriptyAnswerReport/index.js",
14047 "groupTitle": "JscriptyAnswerReport"
14051 "url": "/api/jscripty/answers/reports",
14052 "title": "Gets a list of Reports",
14055 "title": "Example usage:",
14056 "content": "curl https://{domain}/api/jscripty/answers/reports -v -u {name}:{password}",
14060 "name": "GetReports",
14061 "group": "JscriptyAnswerReport",
14062 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
14063 "version": "0.0.0",
14064 "filename": "server/api/jscriptyAnswerReport/index.js",
14065 "groupTitle": "JscriptyAnswerReport"
14069 "url": "/api/jscripty/answers/reports/{id}",
14070 "title": "Gets a single Report",
14073 "title": "Example usage:",
14074 "content": "curl https://{domain}/api/jscripty/answers/reports/{id} -v -u {name}:{password}",
14078 "name": "ShowReports",
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/answers/reports/{id}",
14088 "title": "Update an existing Report",
14091 "title": "Example usage:",
14092 "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",
14096 "name": "updateReports",
14097 "group": "JscriptyAnswerReport",
14098 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14099 "version": "0.0.0",
14100 "filename": "server/api/jscriptyAnswerReport/index.js",
14101 "groupTitle": "JscriptyAnswerReport"
14105 "url": "/api/jscripty/questions/reports",
14106 "title": "Creates a new Report",
14109 "title": "Example usage:",
14110 "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",
14114 "name": "CreateReports",
14115 "group": "JscriptyQuestionReport",
14123 "field": "question",
14137 "field": "membername",
14144 "field": "projectname",
14158 "field": "uniqueid",
14165 "field": "calleridname",
14172 "field": "calleridnum",
14179 "field": "questionId",
14185 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</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/{id}",
14193 "title": "Deletes a Report",
14196 "title": "Example usage:",
14197 "content": "curl https://{domain}/api/jscripty/questions/reports/{id} -v -u {name}:{password} -X DELETE",
14201 "name": "DeleteReports",
14202 "group": "JscriptyQuestionReport",
14203 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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/describe",
14211 "title": "Gets table info about Reports",
14214 "title": "Example usage:",
14215 "content": "curl https://{domain}/api/jscripty/questions/reports/describe -v -u {name}:{password}",
14219 "name": "DescribeReports",
14220 "group": "JscriptyQuestionReport",
14221 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14222 "version": "0.0.0",
14223 "filename": "server/api/jscriptyQuestionReport/index.js",
14224 "groupTitle": "JscriptyQuestionReport"
14228 "url": "/api/jscripty/questions/reports",
14229 "title": "Gets a list of Reports",
14232 "title": "Example usage:",
14233 "content": "curl https://{domain}/api/jscripty/questions/reports -v -u {name}:{password}",
14237 "name": "GetReports",
14238 "group": "JscriptyQuestionReport",
14239 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
14240 "version": "0.0.0",
14241 "filename": "server/api/jscriptyQuestionReport/index.js",
14242 "groupTitle": "JscriptyQuestionReport"
14246 "url": "/api/jscripty/questions/reports/{id}",
14247 "title": "Gets a single Report",
14250 "title": "Example usage:",
14251 "content": "curl https://{domain}/api/jscripty/questions/reports/{id} -v -u {name}:{password}",
14255 "name": "ShowReports",
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/questions/reports/{id}",
14265 "title": "Update an existing Report",
14268 "title": "Example usage:",
14269 "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",
14273 "name": "updateReports",
14274 "group": "JscriptyQuestionReport",
14275 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14276 "version": "0.0.0",
14277 "filename": "server/api/jscriptyQuestionReport/index.js",
14278 "groupTitle": "JscriptyQuestionReport"
14282 "url": "/api/jscripty/sessions/reports",
14283 "title": "Creates a new Report",
14286 "title": "Example usage:",
14287 "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",
14291 "name": "CreateReports",
14292 "group": "JscriptySessionReport",
14300 "field": "starttime",
14307 "field": "endtime",
14314 "field": "membername",
14321 "field": "projectname",
14335 "field": "uniqueid",
14342 "field": "calleridname",
14349 "field": "calleridnum",
14356 "field": "completed",
14362 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</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/{id}",
14370 "title": "Deletes a Report",
14373 "title": "Example usage:",
14374 "content": "curl https://{domain}/api/jscripty/sessions/reports/{id} -v -u {name}:{password} -X DELETE",
14378 "name": "DeleteReports",
14379 "group": "JscriptySessionReport",
14380 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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/describe",
14388 "title": "Gets table info about Reports",
14391 "title": "Example usage:",
14392 "content": "curl https://{domain}/api/jscripty/sessions/reports/describe -v -u {name}:{password}",
14396 "name": "DescribeReports",
14397 "group": "JscriptySessionReport",
14398 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14399 "version": "0.0.0",
14400 "filename": "server/api/jscriptySessionReport/index.js",
14401 "groupTitle": "JscriptySessionReport"
14405 "url": "/api/jscripty/sessions/reports",
14406 "title": "Gets a list of Reports",
14409 "title": "Example usage:",
14410 "content": "curl https://{domain}/api/jscripty/sessions/reports -v -u {name}:{password}",
14414 "name": "GetReports",
14415 "group": "JscriptySessionReport",
14416 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
14417 "version": "0.0.0",
14418 "filename": "server/api/jscriptySessionReport/index.js",
14419 "groupTitle": "JscriptySessionReport"
14423 "url": "/api/jscripty/sessions/reports/{id}",
14424 "title": "Gets a single Report",
14427 "title": "Example usage:",
14428 "content": "curl https://{domain}/api/jscripty/sessions/reports/{id} -v -u {name}:{password}",
14432 "name": "ShowReports",
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}/questions",
14442 "title": "Gets Jscripty Session questions",
14445 "title": "Example usage:",
14446 "content": "curl https://{domain}/api/jscripty/sessions/reports/{id}/questions -v -u {name}:{password} -X GET",
14450 "name": "getQuestions",
14451 "group": "JscriptySessionReport",
14452 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14453 "version": "0.0.0",
14454 "filename": "server/api/jscriptySessionReport/index.js",
14455 "groupTitle": "JscriptySessionReport"
14459 "url": "/api/jscripty/sessions/reports/{id}",
14460 "title": "Update an existing Report",
14463 "title": "Example usage:",
14464 "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",
14468 "name": "updateReports",
14469 "group": "JscriptySessionReport",
14470 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14471 "version": "0.0.0",
14472 "filename": "server/api/jscriptySessionReport/index.js",
14473 "groupTitle": "JscriptySessionReport"
14477 "url": "/api/jscripty/projects/clone",
14478 "title": "Clone an existing Project",
14481 "title": "Example usage:",
14482 "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",
14486 "name": "CloneProjects",
14487 "group": "Jscripty_Projects",
14488 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14489 "version": "0.0.0",
14490 "filename": "server/api/jscriptyProject/index.js",
14491 "groupTitle": "Jscripty_Projects"
14495 "url": "/api/jscripty/projects",
14496 "title": "Creates a new Project",
14499 "title": "Example usage:",
14500 "content": "curl https://{domain}/api/jscripty/projects -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
14504 "name": "CreateProjects",
14505 "group": "Jscripty_Projects",
14520 "field": "description",
14527 "field": "formData",
14534 "field": "enableUncompleteSave",
14541 "field": "sendUnpauseOnSubmit",
14547 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</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/{id}",
14555 "title": "Deletes a Project",
14558 "title": "Example usage:",
14559 "content": "curl https://{domain}/api/jscripty/projects/{id} -v -u {name}:{password} -X DELETE",
14563 "name": "DeleteProjects",
14564 "group": "Jscripty_Projects",
14565 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14566 "version": "0.0.0",
14567 "filename": "server/api/jscriptyProject/index.js",
14568 "groupTitle": "Jscripty_Projects"
14572 "url": "/api/jscripty/projects",
14573 "title": "Gets a list of Projects",
14576 "title": "Example usage:",
14577 "content": "curl https://{domain}/api/jscripty/projects -v -u {name}:{password}",
14581 "name": "GetProjects",
14582 "group": "Jscripty_Projects",
14583 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
14584 "version": "0.0.0",
14585 "filename": "server/api/jscriptyProject/index.js",
14586 "groupTitle": "Jscripty_Projects"
14590 "url": "/api/jscripty/projects/{id}",
14591 "title": "Gets a single Project",
14594 "title": "Example usage:",
14595 "content": "curl https://{domain}/api/jscripty/projects/{id} -v -u {name}:{password}",
14599 "name": "ShowProjects",
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}/answers",
14609 "title": "Gets jscripty project answers",
14612 "title": "Example usage:",
14613 "content": "curl https://{domain}/api/jscripty/projects/{id}/answers -v -u {name}:{password} -X GET",
14617 "name": "getAnswers",
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}/sessions",
14627 "title": "Gets jscripty project sessions",
14630 "title": "Example usage:",
14631 "content": "curl https://{domain}/api/jscripty/projects/{id}/sessions -v -u {name}:{password} -X GET",
14635 "name": "getSessions",
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}/summary",
14645 "title": "Gets jscripty project summary",
14648 "title": "Example usage:",
14649 "content": "curl https://{domain}/api/jscripty/projects/{id}/summary -v -u {name}:{password} -X GET",
14653 "name": "getSummary",
14654 "group": "Jscripty_Projects",
14655 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14656 "version": "0.0.0",
14657 "filename": "server/api/jscriptyProject/index.js",
14658 "groupTitle": "Jscripty_Projects"
14662 "url": "/api/jscripty/projects/{id}",
14663 "title": "Update an existing Project",
14666 "title": "Example usage:",
14667 "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",
14671 "name": "updateProjects",
14672 "group": "Jscripty_Projects",
14673 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14674 "version": "0.0.0",
14675 "filename": "server/api/jscriptyProject/index.js",
14676 "groupTitle": "Jscripty_Projects"
14680 "url": "/api/license",
14681 "title": "Gets License Info",
14684 "title": "Example usage:",
14685 "content": "curl https://{domain}/api/license -v -u {name}:{password} -X GET",
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/license/{id}",
14699 "title": "Update License Info",
14702 "title": "Example usage:",
14703 "content": "curl https://{domain}/api/license/{id} -v -u {name}:{password} -X PUT",
14708 "group": "License",
14709 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14710 "version": "0.0.0",
14711 "filename": "server/api/license/index.js",
14712 "groupTitle": "License"
14716 "url": "/api/mail/accounts/{id}/users",
14717 "title": "Add agents to a mail account",
14720 "title": "Example usage:",
14721 "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",
14725 "name": "AddAgents",
14726 "group": "Mail_Accounts",
14727 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14728 "version": "0.0.0",
14729 "filename": "server/api/mailAccount/index.js",
14730 "groupTitle": "Mail_Accounts"
14734 "url": "/api/mail/accounts/{id}/in_servers",
14735 "title": "Creates a new IMAP server",
14738 "title": "Example usage:",
14739 "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",
14744 "group": "Mail_Accounts",
14752 "field": "description",
14766 "field": "authentication",
14780 "field": "password",
14801 "field": "mailbox",
14808 "field": "connTimeout",
14815 "field": "authTimeout",
14822 "field": "service",
14828 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14829 "version": "0.0.0",
14830 "filename": "server/api/mailAccount/index.js",
14831 "groupTitle": "Mail_Accounts"
14835 "url": "/api/mail/accounts/{id}/out_servers",
14836 "title": "Creates a new SMTP server",
14839 "title": "Example usage:",
14840 "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",
14845 "group": "Mail_Accounts",
14853 "field": "description",
14895 "field": "service",
14902 "field": "authentication",
14908 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</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/{id}",
14916 "title": "Deletes a mail account",
14919 "title": "Example usage:",
14920 "content": "curl https://{domain}/api/mail/accounts/{id} -v -u {name}:{password} -X DELETE",
14924 "name": "DeleteMailAccounts",
14925 "group": "Mail_Accounts",
14926 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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/describe",
14934 "title": "Gets table info about Accounts",
14937 "title": "Example usage:",
14938 "content": "curl https://{domain}/api/mail/accounts/describe -v -u {name}:{password}",
14942 "name": "DescribeAccounts",
14943 "group": "Mail_Accounts",
14944 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14945 "version": "0.0.0",
14946 "filename": "server/api/mailAccount/index.js",
14947 "groupTitle": "Mail_Accounts"
14951 "url": "/api/mail/accounts",
14952 "title": "Gets a list of Accounts",
14955 "title": "Example usage:",
14956 "content": "curl https://{domain}/api/mail/accounts -v -u {name}:{password}",
14960 "name": "GetAccounts",
14961 "group": "Mail_Accounts",
14962 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
14963 "version": "0.0.0",
14964 "filename": "server/api/mailAccount/index.js",
14965 "groupTitle": "Mail_Accounts"
14969 "url": "/api/mail/accounts/{id}/users",
14970 "title": "Gets agents from mail account",
14973 "title": "Example usage:",
14974 "content": "curl https://{domain}/api/mail/accounts/{id}/users -v -u {name}:{password} -X GET",
14978 "name": "GetAgents",
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}/in_servers",
14988 "title": "Gets account IMAP server",
14991 "title": "Example usage:",
14992 "content": "curl https://{domain}/api/mail/accounts/{id}/in_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}/out_servers",
15006 "title": "Gets account SMTP server",
15009 "title": "Example usage:",
15010 "content": "curl https://{domain}/api/mail/accounts/{id}/out_servers -v -u {name}:{password} -X GET",
15015 "group": "Mail_Accounts",
15016 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15017 "version": "0.0.0",
15018 "filename": "server/api/mailAccount/index.js",
15019 "groupTitle": "Mail_Accounts"
15023 "url": "/api/mail/accounts/{id}/users",
15024 "title": "Removes agents from a mail account",
15027 "title": "Example usage:",
15028 "content": "curl https://{domain}/api/mail/accounts/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
15032 "name": "RemoveAgents",
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}/canned_answers",
15042 "title": "Removes canned answers from account",
15045 "title": "Example usage:",
15046 "content": "curl https://{domain}/api/mail/accounts/{id}/canned_answers?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
15050 "name": "RemoveAnswers",
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}/dispositions",
15060 "title": "Removes dispositions from account",
15063 "title": "Example usage:",
15064 "content": "curl https://{domain}/api/mail/accounts/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
15068 "name": "RemoveDispositions",
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}/in_servers",
15078 "title": "Removes IMAP server from an account",
15081 "title": "Example usage:",
15082 "content": "curl https://{domain}/api/mail/accounts/{id}/in_servers -v -u {name}:{password} -X DELETE",
15086 "name": "RemoveImmap",
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}/out_servers",
15096 "title": "Removes SMTP server from an account",
15099 "title": "Example usage:",
15100 "content": "curl https://{domain}/api/mail/accounts/{id}/out_servers -v -u {name}:{password} -X DELETE",
15104 "name": "RemoveSmtp",
15105 "group": "Mail_Accounts",
15106 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15107 "version": "0.0.0",
15108 "filename": "server/api/mailAccount/index.js",
15109 "groupTitle": "Mail_Accounts"
15113 "url": "/api/mail/accounts/{id}",
15114 "title": "Gets a single Account",
15117 "title": "Example usage:",
15118 "content": "curl https://{domain}/api/mail/accounts/{id} -v -u {name}:{password}",
15122 "name": "ShowAccounts",
15123 "group": "Mail_Accounts",
15124 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15125 "version": "0.0.0",
15126 "filename": "server/api/mailAccount/index.js",
15127 "groupTitle": "Mail_Accounts"
15131 "url": "/api/mail/accounts/{id}/canned_answers",
15132 "title": "Creates new canned answer",
15135 "title": "Example usage:",
15136 "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",
15140 "name": "addAnswer",
15141 "group": "Mail_Accounts",
15163 "field": "description",
15176 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15177 "version": "0.0.0",
15178 "filename": "server/api/mailAccount/index.js",
15179 "groupTitle": "Mail_Accounts"
15183 "url": "/api/mail/accounts/{id}/applications",
15184 "title": "Creates new applications",
15187 "title": "Example usage:",
15188 "content": "curl https://{domain}/api/mail/accounts/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
15192 "name": "addApplications",
15193 "group": "Mail_Accounts",
15201 "field": "priority",
15215 "field": "appdata",
15222 "field": "description",
15229 "field": "interval",
15235 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15236 "version": "0.0.0",
15237 "filename": "server/api/mailAccount/index.js",
15238 "groupTitle": "Mail_Accounts"
15242 "url": "/api/mail/accounts/{id}/dispositions",
15243 "title": "Creates new disposition",
15246 "title": "Example usage:",
15247 "content": "curl https://{domain}/api/mail/accounts/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
15251 "name": "addDisposition",
15252 "group": "Mail_Accounts",
15279 "field": "description",
15285 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15286 "version": "0.0.0",
15287 "filename": "server/api/mailAccount/index.js",
15288 "groupTitle": "Mail_Accounts"
15292 "url": "/api/mail/accounts/{id}/interactions",
15293 "title": "Creates new interactions",
15296 "title": "Example usage:",
15297 "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",
15301 "name": "addInteraction",
15302 "group": "Mail_Accounts",
15317 "field": "closedAt",
15324 "field": "disposition",
15331 "field": "secondDisposition",
15338 "field": "thirdDisposition",
15352 "field": "inReplyTo",
15373 "field": "subject",
15387 "field": "read1stAt",
15394 "field": "substatus",
15401 "field": "substatusAt",
15412 "field": "firstMsgDirection",
15419 "field": "lastMsgAt",
15430 "field": "lastMsgDirection",
15437 "field": "lastMsgBody",
15444 "field": "lastMsgText",
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",
15458 "title": "Create a mail account",
15461 "title": "Example usage:",
15462 "content": "curl https://{domain}/api/mail/accounts \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
15467 "group": "Mail_Accounts",
15468 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</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}/canned_answers",
15476 "title": "Gets account canned answers",
15479 "title": "Example usage:",
15480 "content": "curl https://{domain}/api/mail/accounts/{id}/canned_answers -v -u {name}:{password} -X GET",
15484 "name": "getAnswers",
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}/applications",
15494 "title": "Gets account applications",
15497 "title": "Example usage:",
15498 "content": "curl https://{domain}/api/mail/accounts/{id}/applications -v -u {name}:{password} -X GET",
15502 "name": "getApplications",
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}/dispositions",
15512 "title": "Gets account dispositions",
15515 "title": "Example usage:",
15516 "content": "curl https://{domain}/api/mail/accounts/{id}/dispositions -v -u {name}:{password} -X GET",
15520 "name": "getDispositions",
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}/interactions",
15530 "title": "Gets account interactions",
15533 "title": "Example usage:",
15534 "content": "curl https://{domain}/api/mail/accounts/{id}/interactions -v -u {name}:{password} -X GET",
15538 "name": "getInteraction",
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}/messages",
15548 "title": "Gets account messages",
15551 "title": "Example usage:",
15552 "content": "curl https://{domain}/api/mail/accounts/{id}/messages -v -u {name}:{password} -X GET",
15556 "name": "getMessages",
15557 "group": "Mail_Accounts",
15558 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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}/send",
15566 "title": "Send new mail",
15569 "title": "Example usage:",
15570 "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",
15574 "name": "sendMail",
15575 "group": "Mail_Accounts",
15576 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</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}",
15584 "title": "Update an existing Account",
15587 "title": "Example usage:",
15588 "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",
15592 "name": "updateAccounts",
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/accounts/{id}/verify",
15602 "title": "Verify mail account",
15605 "title": "Example usage:",
15606 "content": "curl https://{domain}/api/mail/accounts/{id}/verify -v -u {name}:{password} -X GET",
15610 "name": "verifySmtp",
15611 "group": "Mail_Accounts",
15612 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <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/mailAccount/index.js",
15615 "groupTitle": "Mail_Accounts"
15619 "url": "/api/mail/applications/{id}",
15620 "title": "Deletes a Application",
15623 "title": "Example usage:",
15624 "content": "curl https://{domain}/api/mail/applications/{id} -v -u {name}:{password} -X DELETE",
15628 "name": "DeleteApplications",
15629 "group": "Mail_Applications",
15630 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <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": "Gets a single Application",
15641 "title": "Example usage:",
15642 "content": "curl https://{domain}/api/mail/applications/{id} -v -u {name}:{password}",
15646 "name": "ShowApplications",
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/applications/{id}",
15656 "title": "Update an existing Application",
15659 "title": "Example usage:",
15660 "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",
15664 "name": "updateApplications",
15665 "group": "Mail_Applications",
15666 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15667 "version": "0.0.0",
15668 "filename": "server/api/mailApplication/index.js",
15669 "groupTitle": "Mail_Applications"
15673 "url": "/api/mail/interactions/{id}/tags",
15674 "title": "Add tags to the interaction",
15677 "title": "Example usage:",
15678 "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",
15683 "group": "Mail_Interactions",
15684 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15685 "version": "0.0.0",
15686 "filename": "server/api/mailInteraction/index.js",
15687 "groupTitle": "Mail_Interactions"
15691 "url": "/api/mail/interactions",
15692 "title": "Creates a new Interaction",
15695 "title": "Example usage:",
15696 "content": "curl https://{domain}/api/mail/interactions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
15700 "name": "CreateInteractions",
15701 "group": "Mail_Interactions",
15716 "field": "closedAt",
15723 "field": "disposition",
15730 "field": "secondDisposition",
15737 "field": "thirdDisposition",
15751 "field": "inReplyTo",
15772 "field": "subject",
15786 "field": "read1stAt",
15793 "field": "substatus",
15800 "field": "substatusAt",
15811 "field": "firstMsgDirection",
15818 "field": "lastMsgAt",
15829 "field": "lastMsgDirection",
15836 "field": "lastMsgBody",
15843 "field": "lastMsgText",
15849 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</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/{id}",
15857 "title": "Deletes a Interaction",
15860 "title": "Example usage:",
15861 "content": "curl https://{domain}/api/mail/interactions/{id} -v -u {name}:{password} -X DELETE",
15865 "name": "DeleteInteractions",
15866 "group": "Mail_Interactions",
15867 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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/describe",
15875 "title": "Gets table info about Interactions",
15878 "title": "Example usage:",
15879 "content": "curl https://{domain}/api/mail/interactions/describe -v -u {name}:{password}",
15883 "name": "DescribeInteractions",
15884 "group": "Mail_Interactions",
15885 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15886 "version": "0.0.0",
15887 "filename": "server/api/mailInteraction/index.js",
15888 "groupTitle": "Mail_Interactions"
15892 "url": "/api/mail/interactions",
15893 "title": "Gets a list of Interactions",
15896 "title": "Example usage:",
15897 "content": "curl https://{domain}/api/mail/interactions -v -u {name}:{password}",
15901 "name": "GetInteractions",
15902 "group": "Mail_Interactions",
15903 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
15904 "version": "0.0.0",
15905 "filename": "server/api/mailInteraction/index.js",
15906 "groupTitle": "Mail_Interactions"
15910 "url": "/api/mail/interactions/{id}/tags",
15911 "title": "Removes tags from interaction",
15914 "title": "Example usage:",
15915 "content": "curl https://{domain}/api/mail/interactions/{id}/tags?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
15919 "name": "RemoveTags",
15920 "group": "Mail_Interactions",
15921 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <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}",
15929 "title": "Gets a single Interaction",
15932 "title": "Example usage:",
15933 "content": "curl https://{domain}/api/mail/interactions/{id} -v -u {name}:{password}",
15937 "name": "ShowInteractions",
15938 "group": "Mail_Interactions",
15939 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15940 "version": "0.0.0",
15941 "filename": "server/api/mailInteraction/index.js",
15942 "groupTitle": "Mail_Interactions"
15946 "url": "/api/mail/interactions/{id}/messages",
15947 "title": "Creates new message",
15950 "title": "Example usage:",
15951 "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",
15955 "name": "addMessage",
15956 "group": "Mail_Interactions",
15971 "field": "plainBody",
15989 "field": "direction",
15996 "field": "messageId",
16031 "field": "subject",
16066 "field": "originTo",
16073 "field": "originCc",
16079 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</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}/download",
16087 "title": "Gets interaction",
16090 "title": "Example usage:",
16091 "content": "curl https://{domain}/api/mail/interactions/{id}/download -v -u {name}:{password} -X GET",
16095 "name": "download",
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}/messages",
16105 "title": "Gets interaction messages",
16108 "title": "Example usage:",
16109 "content": "curl https://{domain}/api/mail/interactions/{id}/messages -v -u {name}:{password} -X GET",
16113 "name": "getMessages",
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/interactions/{id}",
16123 "title": "Update an existing Interaction",
16126 "title": "Example usage:",
16127 "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",
16131 "name": "updateInteractions",
16132 "group": "Mail_Interactions",
16133 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <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/mailInteraction/index.js",
16136 "groupTitle": "Mail_Interactions"
16140 "url": "/api/mail/messages/{id}",
16141 "title": "Deletes a Message",
16144 "title": "Example usage:",
16145 "content": "curl https://{domain}/api/mail/messages/{id} -v -u {name}:{password} -X DELETE",
16149 "name": "DeleteMessages",
16150 "group": "Mail_Messages",
16151 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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/describe",
16159 "title": "Gets table info about Messages",
16162 "title": "Example usage:",
16163 "content": "curl https://{domain}/api/mail/messages/describe -v -u {name}:{password}",
16167 "name": "DescribeMessages",
16168 "group": "Mail_Messages",
16169 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16170 "version": "0.0.0",
16171 "filename": "server/api/mailMessage/index.js",
16172 "groupTitle": "Mail_Messages"
16176 "url": "/api/mail/messages",
16177 "title": "Gets a list of Messages",
16180 "title": "Example usage:",
16181 "content": "curl https://{domain}/api/mail/messages -v -u {name}:{password}",
16185 "name": "GetMessages",
16186 "group": "Mail_Messages",
16187 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
16188 "version": "0.0.0",
16189 "filename": "server/api/mailMessage/index.js",
16190 "groupTitle": "Mail_Messages"
16194 "url": "/api/mail/messages/{id}",
16195 "title": "Gets a single Message",
16198 "title": "Example usage:",
16199 "content": "curl https://{domain}/api/mail/messages/{id} -v -u {name}:{password}",
16203 "name": "ShowMessages",
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/{id}/accept",
16213 "title": "Accepts message",
16216 "title": "Example usage:",
16217 "content": "curl https://{domain}/api/mail/messages/{id}/accept \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
16221 "name": "acceptMessage",
16222 "group": "Mail_Messages",
16223 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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",
16231 "title": "Create a message",
16234 "title": "Example usage:",
16235 "content": "curl https://{domain}/api/mail/messages \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
16239 "name": "createMessage",
16240 "group": "Mail_Messages",
16241 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</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}/download",
16249 "title": "Gets message",
16252 "title": "Example usage:",
16253 "content": "curl https://{domain}/api/mail/messages/{id}/download -v -u {name}:{password} -X GET",
16257 "name": "download",
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}/reject",
16267 "title": "Rejects message",
16270 "title": "Example usage:",
16271 "content": "curl https://{domain}/api/mail/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
16275 "name": "rejectMessage",
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/messages/{id}",
16285 "title": "Update an existing Message",
16288 "title": "Example usage:",
16289 "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",
16293 "name": "updateMessages",
16294 "group": "Mail_Messages",
16295 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16296 "version": "0.0.0",
16297 "filename": "server/api/mailMessage/index.js",
16298 "groupTitle": "Mail_Messages"
16302 "url": "/api/mail/reports/queue",
16303 "title": "Creates a new Mail Queue Report",
16306 "title": "Example usage:",
16307 "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",
16311 "name": "CreateMail_Queue_Reports",
16312 "group": "Mail_Queue_Reports",
16320 "field": "uniqueid",
16341 "field": "leaveAt",
16348 "field": "acceptAt",
16368 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</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/{id}",
16376 "title": "Deletes a Mail Queue Report",
16379 "title": "Example usage:",
16380 "content": "curl https://{domain}/api/mail/reports/queue/{id} -v -u {name}:{password} -X DELETE",
16384 "name": "DeleteMail_Queue_Reports",
16385 "group": "Mail_Queue_Reports",
16386 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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/describe",
16394 "title": "Gets table info about Mail Queue Reports",
16397 "title": "Example usage:",
16398 "content": "curl https://{domain}/api/mail/reports/queue/describe -v -u {name}:{password}",
16402 "name": "DescribeMail_Queue_Reports",
16403 "group": "Mail_Queue_Reports",
16404 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16405 "version": "0.0.0",
16406 "filename": "server/api/mailQueueReport/index.js",
16407 "groupTitle": "Mail_Queue_Reports"
16411 "url": "/api/mail/reports/queue",
16412 "title": "Gets a list of Mail Queue Reports",
16415 "title": "Example usage:",
16416 "content": "curl https://{domain}/api/mail/reports/queue -v -u {name}:{password}",
16420 "name": "GetMail_Queue_Reports",
16421 "group": "Mail_Queue_Reports",
16422 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
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": "Gets a single Mail Queue Report",
16433 "title": "Example usage:",
16434 "content": "curl https://{domain}/api/mail/reports/queue/{id} -v -u {name}:{password}",
16438 "name": "ShowMail_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/reports/queue/{id}",
16448 "title": "Update an existing Mail Queue Report",
16451 "title": "Example usage:",
16452 "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",
16456 "name": "updateMail_Queue_Reports",
16457 "group": "Mail_Queue_Reports",
16458 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16459 "version": "0.0.0",
16460 "filename": "server/api/mailQueueReport/index.js",
16461 "groupTitle": "Mail_Queue_Reports"
16465 "url": "/api/mail/queues/{id}/users",
16466 "title": "Add agents to a queue",
16469 "title": "Example usage:",
16470 "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",
16474 "name": "AddAgents",
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/{id}/teams",
16484 "title": "Add teams to a queue",
16487 "title": "Example usage:",
16488 "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",
16492 "name": "AddTeams",
16493 "group": "Mail_Queues",
16494 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16495 "version": "0.0.0",
16496 "filename": "server/api/mailQueue/index.js",
16497 "groupTitle": "Mail_Queues"
16501 "url": "/api/mail/queues",
16502 "title": "Creates a new Queue",
16505 "title": "Example usage:",
16506 "content": "curl https://{domain}/api/mail/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
16510 "name": "CreateQueues",
16511 "group": "Mail_Queues",
16526 "field": "description",
16533 "field": "timeout",
16545 "field": "strategy",
16551 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</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/{id}",
16559 "title": "Deletes a Queue",
16562 "title": "Example usage:",
16563 "content": "curl https://{domain}/api/mail/queues/{id} -v -u {name}:{password} -X DELETE",
16567 "name": "DeleteQueues",
16568 "group": "Mail_Queues",
16569 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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/describe",
16577 "title": "Gets table info about Queues",
16580 "title": "Example usage:",
16581 "content": "curl https://{domain}/api/mail/queues/describe -v -u {name}:{password}",
16585 "name": "DescribeQueues",
16586 "group": "Mail_Queues",
16587 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</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}/users",
16595 "title": "Gets queue agents",
16598 "title": "Example usage:",
16599 "content": "curl https://{domain}/api/mail/queues/{id}/users -v -u {name}:{password} -X POST",
16603 "name": "GetAgents",
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/{id}/members",
16613 "title": "GetMembers",
16616 "title": "Example usage:",
16617 "content": "curl https://{domain}/api/mail/queues/{id}/members -v -u {name}:{password}",
16621 "name": "GetMembers",
16622 "group": "Mail_Queues",
16623 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16624 "version": "0.0.0",
16625 "filename": "server/api/mailQueue/index.js",
16626 "groupTitle": "Mail_Queues"
16630 "url": "/api/mail/queues",
16631 "title": "Gets a list of Queues",
16634 "title": "Example usage:",
16635 "content": "curl https://{domain}/api/mail/queues -v -u {name}:{password}",
16639 "name": "GetQueues",
16640 "group": "Mail_Queues",
16641 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
16642 "version": "0.0.0",
16643 "filename": "server/api/mailQueue/index.js",
16644 "groupTitle": "Mail_Queues"
16648 "url": "/api/mail/queues/{id}/teams",
16649 "title": "Gets queues list",
16652 "title": "Example usage:",
16653 "content": "curl https://{domain}/api/mail/queues/{id}/teams -v -u {name}:{password}",
16657 "name": "GetTeams",
16658 "group": "Mail_Queues",
16659 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <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}/users",
16667 "title": "Removes agents from a queue",
16670 "title": "Example usage:",
16671 "content": "curl https://{domain}/api/mail/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
16675 "name": "RemoveAgents",
16676 "group": "Mail_Queues",
16677 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <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": "Gets a single Queue",
16688 "title": "Example usage:",
16689 "content": "curl https://{domain}/api/mail/queues/{id} -v -u {name}:{password}",
16693 "name": "ShowQueues",
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/queues/{id}",
16703 "title": "Update an existing Queue",
16706 "title": "Example usage:",
16707 "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",
16711 "name": "updateQueues",
16712 "group": "Mail_Queues",
16713 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16714 "version": "0.0.0",
16715 "filename": "server/api/mailQueue/index.js",
16716 "groupTitle": "Mail_Queues"
16720 "url": "/api/mail/out_servers",
16721 "title": "Creates a new SMTP",
16724 "title": "Example usage:",
16725 "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",
16729 "name": "CreateSMTPs",
16730 "group": "Mail_SMTP",
16738 "field": "description",
16780 "field": "service",
16787 "field": "authentication",
16793 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</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/{id}",
16801 "title": "Deletes a SMTP",
16804 "title": "Example usage:",
16805 "content": "curl https://{domain}/api/mail/out_servers/{id} -v -u {name}:{password} -X DELETE",
16809 "name": "DeleteSMTPs",
16810 "group": "Mail_SMTP",
16811 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16812 "version": "0.0.0",
16813 "filename": "server/api/mailServerOut/index.js",
16814 "groupTitle": "Mail_SMTP"
16818 "url": "/api/mail/out_servers",
16819 "title": "Gets a list of SMTPs",
16822 "title": "Example usage:",
16823 "content": "curl https://{domain}/api/mail/out_servers -v -u {name}:{password}",
16827 "name": "GetSMTPs",
16828 "group": "Mail_SMTP",
16829 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
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": "Gets a single SMTP",
16840 "title": "Example usage:",
16841 "content": "curl https://{domain}/api/mail/out_servers/{id} -v -u {name}:{password}",
16845 "name": "ShowSMTPs",
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/out_servers/{id}",
16855 "title": "Update an existing SMTP",
16858 "title": "Example usage:",
16859 "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",
16863 "name": "updateSMTPs",
16864 "group": "Mail_SMTP",
16865 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16866 "version": "0.0.0",
16867 "filename": "server/api/mailServerOut/index.js",
16868 "groupTitle": "Mail_SMTP"
16872 "url": "/api/mail/substatuses",
16873 "title": "Creates a new Queue",
16876 "title": "Example usage:",
16877 "content": "curl https://{domain}/api/mail/substatuses -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
16881 "name": "CreateSubstatuses",
16882 "group": "Mail_Substatuses",
16897 "field": "description",
16903 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</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/{id}",
16911 "title": "Deletes a Queue",
16914 "title": "Example usage:",
16915 "content": "curl https://{domain}/api/mail/substatuses/{id} -v -u {name}:{password} -X DELETE",
16919 "name": "DeleteSubstatuses",
16920 "group": "Mail_Substatuses",
16921 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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/describe",
16929 "title": "Gets table info about Substatuses",
16932 "title": "Example usage:",
16933 "content": "curl https://{domain}/api/mail/substatuses/describe -v -u {name}:{password}",
16937 "name": "DescribeSubstatuses",
16938 "group": "Mail_Substatuses",
16939 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16940 "version": "0.0.0",
16941 "filename": "server/api/mailSubstatus/index.js",
16942 "groupTitle": "Mail_Substatuses"
16946 "url": "/api/mail/substatuses",
16947 "title": "Gets a list of Substatuses",
16950 "title": "Example usage:",
16951 "content": "curl https://{domain}/api/mail/substatuses -v -u {name}:{password}",
16955 "name": "GetSubstatuses",
16956 "group": "Mail_Substatuses",
16957 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
16958 "version": "0.0.0",
16959 "filename": "server/api/mailSubstatus/index.js",
16960 "groupTitle": "Mail_Substatuses"
16964 "url": "/api/mail/substatuses/{id}",
16965 "title": "Gets a single Queue",
16968 "title": "Example usage:",
16969 "content": "curl https://{domain}/api/mail/substatuses/{id} -v -u {name}:{password}",
16973 "name": "ShowSubstatuses",
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/substatuses/{id}",
16983 "title": "Update an existing Queue",
16986 "title": "Example usage:",
16987 "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",
16991 "name": "updateSubstatuses",
16992 "group": "Mail_Substatuses",
16993 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16994 "version": "0.0.0",
16995 "filename": "server/api/mailSubstatus/index.js",
16996 "groupTitle": "Mail_Substatuses"
17000 "url": "/api/mail/reports/transfer",
17001 "title": "Creates a new Mail Transfer Report",
17004 "title": "Example usage:",
17005 "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",
17009 "name": "CreateMail_Transfer_Reports",
17010 "group": "Mail_Transfer_Reports",
17018 "field": "uniqueid",
17037 "field": "transferredAt",
17043 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</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/{id}",
17051 "title": "Deletes a Mail Transfer Report",
17054 "title": "Example usage:",
17055 "content": "curl https://{domain}/api/mail/reports/transfer/{id} -v -u {name}:{password} -X DELETE",
17059 "name": "DeleteMail_Transfer_Reports",
17060 "group": "Mail_Transfer_Reports",
17061 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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/describe",
17069 "title": "Gets table info about Mail Transfer Reports",
17072 "title": "Example usage:",
17073 "content": "curl https://{domain}/api/mail/reports/transfer/describe -v -u {name}:{password}",
17077 "name": "DescribeMail_Transfer_Reports",
17078 "group": "Mail_Transfer_Reports",
17079 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17080 "version": "0.0.0",
17081 "filename": "server/api/mailTransferReport/index.js",
17082 "groupTitle": "Mail_Transfer_Reports"
17086 "url": "/api/mail/reports/transfer",
17087 "title": "Gets a list of Mail Transfer Reports",
17090 "title": "Example usage:",
17091 "content": "curl https://{domain}/api/mail/reports/transfer -v -u {name}:{password}",
17095 "name": "GetMail_Transfer_Reports",
17096 "group": "Mail_Transfer_Reports",
17097 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
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": "Gets a single Mail Transfer Report",
17108 "title": "Example usage:",
17109 "content": "curl https://{domain}/api/mail/reports/transfer/{id} -v -u {name}:{password}",
17113 "name": "ShowMail_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/mail/reports/transfer/{id}",
17123 "title": "Update an existing Mail Transfer Report",
17126 "title": "Example usage:",
17127 "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",
17131 "name": "updateMail_Transfer_Reports",
17132 "group": "Mail_Transfer_Reports",
17133 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17134 "version": "0.0.0",
17135 "filename": "server/api/mailTransferReport/index.js",
17136 "groupTitle": "Mail_Transfer_Reports"
17140 "url": "/api/members/reports/describe",
17141 "title": "Gets table info about Member Reports",
17144 "title": "Example usage:",
17145 "content": "curl https://{domain}/api/members/reports/describe -v -u {name}:{password}",
17149 "name": "DescribeMember_Reports",
17150 "group": "Member_Reports",
17151 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17152 "version": "0.0.0",
17153 "filename": "server/api/memberReport/index.js",
17154 "groupTitle": "Member_Reports"
17158 "url": "/api/members/reports",
17159 "title": "Gets a list of Member Reports",
17162 "title": "Example usage:",
17163 "content": "curl https://{domain}/api/members/reports -v -u {name}:{password}",
17167 "name": "GetMember_Reports",
17168 "group": "Member_Reports",
17169 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
17170 "version": "0.0.0",
17171 "filename": "server/api/memberReport/index.js",
17172 "groupTitle": "Member_Reports"
17176 "url": "/api/members/reports/{id}",
17177 "title": "Gets a single Member Report",
17180 "title": "Example usage:",
17181 "content": "curl https://{domain}/api/members/reports/{id} -v -u {name}:{password}",
17185 "name": "ShowMember_Reports",
17186 "group": "Member_Reports",
17187 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17188 "version": "0.0.0",
17189 "filename": "server/api/memberReport/index.js",
17190 "groupTitle": "Member_Reports"
17194 "url": "/api/migrations",
17195 "title": "Gets a list of Migrations",
17198 "title": "Example usage:",
17199 "content": "curl https://{domain}/api/migrations -v -u {name}:{password}",
17203 "name": "GetMigrations",
17204 "group": "Migrations",
17205 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
17206 "version": "0.0.0",
17207 "filename": "server/api/migration/index.js",
17208 "groupTitle": "Migrations"
17212 "url": "/api/voice/networks",
17213 "title": "Create a new network",
17216 "title": "Example usage:",
17217 "content": "curl https://{domain}/api/voice/networks -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
17222 "group": "Networks",
17223 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</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/voice/networks/{id}",
17231 "title": "Deletes a network",
17234 "title": "Example usage:",
17235 "content": "curl https://{domain}/api/voice/networks/{id} -v -u {name}:{password} -X DELETE",
17240 "group": "Networks",
17241 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17242 "version": "0.0.0",
17243 "filename": "server/api/network/index.js",
17244 "groupTitle": "Networks"
17248 "url": "/api/networks",
17249 "title": "Gets a list of Networks",
17252 "title": "Example usage:",
17253 "content": "curl https://{domain}/api/networks -v -u {name}:{password}",
17257 "name": "GetNetworks",
17258 "group": "Networks",
17259 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
17260 "version": "0.0.0",
17261 "filename": "server/api/network/index.js",
17262 "groupTitle": "Networks"
17266 "url": "/api/networks/{id}",
17267 "title": "Gets a single Network",
17270 "title": "Example usage:",
17271 "content": "curl https://{domain}/api/networks/{id} -v -u {name}:{password}",
17275 "name": "ShowNetworks",
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/voice/networks/{id}",
17285 "title": "Update an existing network",
17288 "title": "Example usage:",
17289 "content": "curl https://{domain}/api/voice/networks/{id} -v -u {name}:{password} -X PUT",
17294 "group": "Networks",
17295 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17296 "version": "0.0.0",
17297 "filename": "server/api/network/index.js",
17298 "groupTitle": "Networks"
17302 "url": "/api/notifications",
17303 "title": "Send notification to user",
17306 "title": "Example usage:",
17307 "content": "curl https://{domain}/api/notifications -d '{\"text\": \"Hello!\", \"TemplateId\": 1}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
17312 "group": "Notifications",
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/notification/index.js",
17316 "groupTitle": "Notifications"
17320 "url": "/api/openchannel/accounts/{id}/users",
17321 "title": "Add agents to a openchannel account",
17324 "title": "Example usage:",
17325 "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",
17329 "name": "AddAgents",
17330 "group": "Openchannel_Accounts",
17331 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17332 "version": "0.0.0",
17333 "filename": "server/api/openchannelAccount/index.js",
17334 "groupTitle": "Openchannel_Accounts"
17338 "url": "/api/openchannel/accounts",
17339 "title": "Creates a new Account",
17342 "title": "Example usage:",
17343 "content": "curl https://{domain}/api/openchannel/accounts -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
17347 "name": "CreateAccounts",
17348 "group": "Openchannel_Accounts",
17363 "field": "description",
17377 "field": "replyUri",
17391 "field": "notificationTemplate",
17398 "field": "notificationSound",
17405 "field": "notificationShake",
17412 "field": "waitForTheAssignedAgent",
17426 "field": "queueTransfer",
17433 "field": "queueTransferTimeout",
17440 "field": "agentTransfer",
17447 "field": "agentTransferTimeout",
17454 "field": "mandatoryDispositionPauseId",
17455 "description": "<p>Status to put when mandatory disposition is enabled</p>"
17461 "field": "mandatoryDisposition",
17462 "description": "<p>Enabled/disables mandatory dispo on a queue</p>"
17467 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</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/{id}",
17475 "title": "Deletes a Account",
17478 "title": "Example usage:",
17479 "content": "curl https://{domain}/api/openchannel/accounts/{id} -v -u {name}:{password} -X DELETE",
17483 "name": "DeleteAccounts",
17484 "group": "Openchannel_Accounts",
17485 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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/describe",
17493 "title": "Gets table info about Accounts",
17496 "title": "Example usage:",
17497 "content": "curl https://{domain}/api/openchannel/accounts/describe -v -u {name}:{password}",
17501 "name": "DescribeAccounts",
17502 "group": "Openchannel_Accounts",
17503 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17504 "version": "0.0.0",
17505 "filename": "server/api/openchannelAccount/index.js",
17506 "groupTitle": "Openchannel_Accounts"
17510 "url": "/api/openchannel/accounts",
17511 "title": "Gets a list of Accounts",
17514 "title": "Example usage:",
17515 "content": "curl https://{domain}/api/openchannel/accounts -v -u {name}:{password}",
17519 "name": "GetAccounts",
17520 "group": "Openchannel_Accounts",
17521 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
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": "Gets agents from openchannel account",
17532 "title": "Example usage:",
17533 "content": "curl https://{domain}/api/openchannel/accounts/{id}/users -v -u {name}:{password} -X GET",
17537 "name": "GetAgents",
17538 "group": "Openchannel_Accounts",
17539 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <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}/users",
17547 "title": "Removes agents from a openchannel account",
17550 "title": "Example usage:",
17551 "content": "curl https://{domain}/api/openchannel/accounts/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
17555 "name": "RemoveAgents",
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}/canned_answers",
17565 "title": "Removes canned answers from account",
17568 "title": "Example usage:",
17569 "content": "curl https://{domain}/api/openchannel/accounts/{id}/canned_answers?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
17573 "name": "RemoveAnswers",
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}/dispositions",
17583 "title": "Removes dispositions from account",
17586 "title": "Example usage:",
17587 "content": "curl https://{domain}/api/openchannel/accounts/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
17591 "name": "RemoveDispositions",
17592 "group": "Openchannel_Accounts",
17593 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <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}",
17601 "title": "Gets a single Account",
17604 "title": "Example usage:",
17605 "content": "curl https://{domain}/api/openchannel/accounts/{id} -v -u {name}:{password}",
17609 "name": "ShowAccounts",
17610 "group": "Openchannel_Accounts",
17611 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17612 "version": "0.0.0",
17613 "filename": "server/api/openchannelAccount/index.js",
17614 "groupTitle": "Openchannel_Accounts"
17618 "url": "/api/openchannel/accounts/{id}/canned_answers",
17619 "title": "Creates new canned answer",
17622 "title": "Example usage:",
17623 "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",
17627 "name": "addAnswer",
17628 "group": "Openchannel_Accounts",
17650 "field": "description",
17663 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17664 "version": "0.0.0",
17665 "filename": "server/api/openchannelAccount/index.js",
17666 "groupTitle": "Openchannel_Accounts"
17670 "url": "/api/openchannel/accounts/{id}/applications",
17671 "title": "Creates new applications",
17674 "title": "Example usage:",
17675 "content": "curl https://{domain}/api/openchannel/accounts/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
17679 "name": "addApplications",
17680 "group": "Openchannel_Accounts",
17688 "field": "priority",
17702 "field": "appdata",
17709 "field": "description",
17716 "field": "interval",
17722 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17723 "version": "0.0.0",
17724 "filename": "server/api/openchannelAccount/index.js",
17725 "groupTitle": "Openchannel_Accounts"
17729 "url": "/api/openchannel/accounts/{id}/dispositions",
17730 "title": "Creates new disposition",
17733 "title": "Example usage:",
17734 "content": "curl https://{domain}/api/openchannel/accounts/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
17738 "name": "addDisposition",
17739 "group": "Openchannel_Accounts",
17766 "field": "description",
17772 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</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}/canned_answers",
17780 "title": "Gets account canned answers",
17783 "title": "Example usage:",
17784 "content": "curl https://{domain}/api/openchannel/accounts/{id}/canned_answers -v -u {name}:{password} -X GET",
17788 "name": "getAnswers",
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}/applications",
17798 "title": "Gets account applications",
17801 "title": "Example usage:",
17802 "content": "curl https://{domain}/api/openchannel/accounts/{id}/applications -v -u {name}:{password} -X GET",
17806 "name": "getApplications",
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}/dispositions",
17816 "title": "Gets account dispositions",
17819 "title": "Example usage:",
17820 "content": "curl https://{domain}/api/openchannel/accounts/{id}/dispositions -v -u {name}:{password} -X GET",
17824 "name": "getDispositions",
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}/interactions",
17834 "title": "Gets Openchannel Account Interactions",
17837 "title": "Example usage:",
17838 "content": "curl https://{domain}/api/openchannel/accounts/{id}/interactions -v -u {name}:{password} -X GET",
17842 "name": "getInteractions",
17843 "group": "Openchannel_Accounts",
17844 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17845 "version": "0.0.0",
17846 "filename": "server/api/openchannelAccount/index.js",
17847 "groupTitle": "Openchannel_Accounts"
17851 "url": "/api/openchannel/accounts/{id}/notify",
17852 "title": "Notify new message",
17855 "title": "Example usage:",
17856 "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",
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> <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>",
17863 "version": "0.0.0",
17864 "filename": "server/api/openchannelAccount/index.js",
17865 "groupTitle": "Openchannel_Accounts"
17869 "url": "/api/openchannel/accounts/{id}/send",
17870 "title": "Send new openchannel message",
17873 "title": "Example usage:",
17874 "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",
17878 "name": "sendOpenchannel",
17879 "group": "Openchannel_Accounts",
17880 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</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/accounts/{id}",
17888 "title": "Update an existing Account",
17891 "title": "Example usage:",
17892 "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",
17896 "name": "updateAccounts",
17897 "group": "Openchannel_Accounts",
17898 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17899 "version": "0.0.0",
17900 "filename": "server/api/openchannelAccount/index.js",
17901 "groupTitle": "Openchannel_Accounts"
17905 "url": "/api/openchannel/applications",
17906 "title": "Creates a new Application",
17909 "title": "Example usage:",
17910 "content": "curl https://{domain}/api/openchannel/applications -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
17914 "name": "CreateApplications",
17915 "group": "Openchannel_Applications",
17923 "field": "priority",
17937 "field": "appdata",
17944 "field": "description",
17951 "field": "interval",
17957 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</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/{id}",
17965 "title": "Deletes a Application",
17968 "title": "Example usage:",
17969 "content": "curl https://{domain}/api/openchannel/applications/{id} -v -u {name}:{password} -X DELETE",
17973 "name": "DeleteApplications",
17974 "group": "Openchannel_Applications",
17975 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17976 "version": "0.0.0",
17977 "filename": "server/api/openchannelApplication/index.js",
17978 "groupTitle": "Openchannel_Applications"
17982 "url": "/api/openchannel/applications",
17983 "title": "Gets a list of Applications",
17986 "title": "Example usage:",
17987 "content": "curl https://{domain}/api/openchannel/applications -v -u {name}:{password}",
17991 "name": "GetApplications",
17992 "group": "Openchannel_Applications",
17993 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
17994 "version": "0.0.0",
17995 "filename": "server/api/openchannelApplication/index.js",
17996 "groupTitle": "Openchannel_Applications"
18000 "url": "/api/openchannel/applications/{id}",
18001 "title": "Gets a single Application",
18004 "title": "Example usage:",
18005 "content": "curl https://{domain}/api/openchannel/applications/{id} -v -u {name}:{password}",
18009 "name": "ShowApplications",
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/applications/{id}",
18019 "title": "Update an existing Application",
18022 "title": "Example usage:",
18023 "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",
18027 "name": "updateApplications",
18028 "group": "Openchannel_Applications",
18029 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18030 "version": "0.0.0",
18031 "filename": "server/api/openchannelApplication/index.js",
18032 "groupTitle": "Openchannel_Applications"
18036 "url": "/api/openchannel/interactions/{id}/tags",
18037 "title": "Add tags to the interaction",
18040 "title": "Example usage:",
18041 "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",
18046 "group": "Openchannel_Interactions",
18047 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18048 "version": "0.0.0",
18049 "filename": "server/api/openchannelInteraction/index.js",
18050 "groupTitle": "Openchannel_Interactions"
18054 "url": "/api/openchannel/interactions",
18055 "title": "Creates a new Interaction",
18058 "title": "Example usage:",
18059 "content": "curl https://{domain}/api/openchannel/interactions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
18063 "name": "CreateInteractions",
18064 "group": "Openchannel_Interactions",
18079 "field": "closedAt",
18086 "field": "disposition",
18093 "field": "secondDisposition",
18100 "field": "thirdDisposition",
18114 "field": "read1stAt",
18121 "field": "threadId",
18128 "field": "externalUrl",
18135 "field": "lastMsgAt",
18146 "field": "lastMsgDirection",
18159 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</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/{id}",
18167 "title": "Deletes a Interaction",
18170 "title": "Example usage:",
18171 "content": "curl https://{domain}/api/openchannel/interactions/{id} -v -u {name}:{password} -X DELETE",
18175 "name": "DeleteInteractions",
18176 "group": "Openchannel_Interactions",
18177 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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/describe",
18185 "title": "Gets table info about Interactions",
18188 "title": "Example usage:",
18189 "content": "curl https://{domain}/api/openchannel/interactions/describe -v -u {name}:{password}",
18193 "name": "DescribeInteractions",
18194 "group": "Openchannel_Interactions",
18195 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18196 "version": "0.0.0",
18197 "filename": "server/api/openchannelInteraction/index.js",
18198 "groupTitle": "Openchannel_Interactions"
18202 "url": "/api/openchannel/interactions",
18203 "title": "Gets a list of Interactions",
18206 "title": "Example usage:",
18207 "content": "curl https://{domain}/api/openchannel/interactions -v -u {name}:{password}",
18211 "name": "GetInteractions",
18212 "group": "Openchannel_Interactions",
18213 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
18214 "version": "0.0.0",
18215 "filename": "server/api/openchannelInteraction/index.js",
18216 "groupTitle": "Openchannel_Interactions"
18220 "url": "/api/openchannel/interactions/{id}/tags",
18221 "title": "Removes tags from interaction",
18224 "title": "Example usage:",
18225 "content": "curl https://{domain}/api/openchannel/interactions/{id}/tags?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
18229 "name": "RemoveTags",
18230 "group": "Openchannel_Interactions",
18231 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <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}",
18239 "title": "Gets a single Interaction",
18242 "title": "Example usage:",
18243 "content": "curl https://{domain}/api/openchannel/interactions/{id} -v -u {name}:{password}",
18247 "name": "ShowInteractions",
18248 "group": "Openchannel_Interactions",
18249 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18250 "version": "0.0.0",
18251 "filename": "server/api/openchannelInteraction/index.js",
18252 "groupTitle": "Openchannel_Interactions"
18256 "url": "/api/openchannel/interactions/{id}/messages",
18257 "title": "Creates new messages",
18260 "title": "Example usage:",
18261 "content": "curl https://{domain}/api/openchannel/interactions/{id}/messages -d '[{\"to\": \"+3901119886500\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
18265 "name": "addMessage",
18266 "group": "Openchannel_Interactions",
18299 "field": "direction",
18313 "field": "providerName",
18320 "field": "providerResponse",
18326 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</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}/download",
18334 "title": "Gets interaction",
18337 "title": "Example usage:",
18338 "content": "curl https://{domain}/api/openchannel/interactions/{id}/download -v -u {name}:{password} -X GET",
18342 "name": "download",
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}/messages",
18352 "title": "Gets interaction messages",
18355 "title": "Example usage:",
18356 "content": "curl https://{domain}/api/openchannel/interactions/{id}/messages -v -u {name}:{password} -X GET",
18360 "name": "getMessages",
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/interactions/{id}",
18370 "title": "Update an existing Interaction",
18373 "title": "Example usage:",
18374 "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",
18378 "name": "updateInteractions",
18379 "group": "Openchannel_Interactions",
18380 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18381 "version": "0.0.0",
18382 "filename": "server/api/openchannelInteraction/index.js",
18383 "groupTitle": "Openchannel_Interactions"
18387 "url": "/api/openchannel/messages",
18388 "title": "Creates a new Message",
18391 "title": "Example usage:",
18392 "content": "curl https://{domain}/api/openchannel/messages -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
18396 "name": "CreateMessages",
18397 "group": "Openchannel_Messages",
18430 "field": "direction",
18444 "field": "providerName",
18451 "field": "providerResponse",
18457 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</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/{id}",
18465 "title": "Deletes a Message",
18468 "title": "Example usage:",
18469 "content": "curl https://{domain}/api/openchannel/messages/{id} -v -u {name}:{password} -X DELETE",
18473 "name": "DeleteMessages",
18474 "group": "Openchannel_Messages",
18475 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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/describe",
18483 "title": "Gets table info about Messages",
18486 "title": "Example usage:",
18487 "content": "curl https://{domain}/api/openchannel/messages/describe -v -u {name}:{password}",
18491 "name": "DescribeMessages",
18492 "group": "Openchannel_Messages",
18493 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18494 "version": "0.0.0",
18495 "filename": "server/api/openchannelMessage/index.js",
18496 "groupTitle": "Openchannel_Messages"
18500 "url": "/api/openchannel/messages",
18501 "title": "Gets a list of Messages",
18504 "title": "Example usage:",
18505 "content": "curl https://{domain}/api/openchannel/messages -v -u {name}:{password}",
18509 "name": "GetMessages",
18510 "group": "Openchannel_Messages",
18511 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
18512 "version": "0.0.0",
18513 "filename": "server/api/openchannelMessage/index.js",
18514 "groupTitle": "Openchannel_Messages"
18518 "url": "/api/openchannel/messages/{id}",
18519 "title": "Gets a single Message",
18522 "title": "Example usage:",
18523 "content": "curl https://{domain}/api/openchannel/messages/{id} -v -u {name}:{password}",
18527 "name": "ShowMessages",
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}/accept",
18537 "title": "Accepts message",
18540 "title": "Example usage:",
18541 "content": "curl https://{domain}/api/openchannel/messages/{id}/accept \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
18545 "name": "acceptMessage",
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}/reject",
18555 "title": "Rejects message",
18558 "title": "Example usage:",
18559 "content": "curl https://{domain}/api/openchannel/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
18563 "name": "rejectMessage",
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/messages/{id}",
18573 "title": "Update an existing Message",
18576 "title": "Example usage:",
18577 "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",
18581 "name": "updateMessages",
18582 "group": "Openchannel_Messages",
18583 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18584 "version": "0.0.0",
18585 "filename": "server/api/openchannelMessage/index.js",
18586 "groupTitle": "Openchannel_Messages"
18590 "url": "/api/openchannel/reports/queue",
18591 "title": "Creates a new Openchannel Queue Report",
18594 "title": "Example usage:",
18595 "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",
18599 "name": "CreateOpenchannel_Queue_Reports",
18600 "group": "Openchannel_Queue_Reports",
18608 "field": "uniqueid",
18629 "field": "leaveAt",
18636 "field": "acceptAt",
18656 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</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/{id}",
18664 "title": "Deletes a Openchannel Queue Report",
18667 "title": "Example usage:",
18668 "content": "curl https://{domain}/api/openchannel/reports/queue/{id} -v -u {name}:{password} -X DELETE",
18672 "name": "DeleteOpenchannel_Queue_Reports",
18673 "group": "Openchannel_Queue_Reports",
18674 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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/describe",
18682 "title": "Gets table info about Openchannel Queue Reports",
18685 "title": "Example usage:",
18686 "content": "curl https://{domain}/api/openchannel/reports/queue/describe -v -u {name}:{password}",
18690 "name": "DescribeOpenchannel_Queue_Reports",
18691 "group": "Openchannel_Queue_Reports",
18692 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18693 "version": "0.0.0",
18694 "filename": "server/api/openchannelQueueReport/index.js",
18695 "groupTitle": "Openchannel_Queue_Reports"
18699 "url": "/api/openchannel/reports/queue",
18700 "title": "Gets a list of Openchannel Queue Reports",
18703 "title": "Example usage:",
18704 "content": "curl https://{domain}/api/openchannel/reports/queue -v -u {name}:{password}",
18708 "name": "GetOpenchannel_Queue_Reports",
18709 "group": "Openchannel_Queue_Reports",
18710 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
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": "Gets a single Openchannel Queue Report",
18721 "title": "Example usage:",
18722 "content": "curl https://{domain}/api/openchannel/reports/queue/{id} -v -u {name}:{password}",
18726 "name": "ShowOpenchannel_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/reports/queue/{id}",
18736 "title": "Update an existing Openchannel Queue Report",
18739 "title": "Example usage:",
18740 "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",
18744 "name": "updateOpenchannel_Queue_Reports",
18745 "group": "Openchannel_Queue_Reports",
18746 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18747 "version": "0.0.0",
18748 "filename": "server/api/openchannelQueueReport/index.js",
18749 "groupTitle": "Openchannel_Queue_Reports"
18753 "url": "/api/openchannel/queues/{id}/users",
18754 "title": "Add agents to a queue",
18757 "title": "Example usage:",
18758 "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",
18762 "name": "AddAgents",
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/{id}/teams",
18772 "title": "Add teams to a queue",
18775 "title": "Example usage:",
18776 "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",
18780 "name": "AddTeams",
18781 "group": "Openchannel_Queues",
18782 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18783 "version": "0.0.0",
18784 "filename": "server/api/openchannelQueue/index.js",
18785 "groupTitle": "Openchannel_Queues"
18789 "url": "/api/openchannel/queues",
18790 "title": "Creates a new Queue",
18793 "title": "Example usage:",
18794 "content": "curl https://{domain}/api/openchannel/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
18798 "name": "CreateQueues",
18799 "group": "Openchannel_Queues",
18814 "field": "description",
18821 "field": "timeout",
18833 "field": "strategy",
18839 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</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/{id}",
18847 "title": "Deletes a Queue",
18850 "title": "Example usage:",
18851 "content": "curl https://{domain}/api/openchannel/queues/{id} -v -u {name}:{password} -X DELETE",
18855 "name": "DeleteQueues",
18856 "group": "Openchannel_Queues",
18857 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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/describe",
18865 "title": "Gets table info about Queues",
18868 "title": "Example usage:",
18869 "content": "curl https://{domain}/api/openchannel/queues/describe -v -u {name}:{password}",
18873 "name": "DescribeQueues",
18874 "group": "Openchannel_Queues",
18875 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</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}/users",
18883 "title": "Gets queue agents",
18886 "title": "Example usage:",
18887 "content": "curl https://{domain}/api/openchannel/queues/{id}/users -v -u {name}:{password} -X POST",
18891 "name": "GetAgents",
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/{id}/members",
18901 "title": "GetMembers",
18904 "title": "Example usage:",
18905 "content": "curl https://{domain}/api/openchannel/queues/{id}/members -v -u {name}:{password}",
18909 "name": "GetMembers",
18910 "group": "Openchannel_Queues",
18911 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18912 "version": "0.0.0",
18913 "filename": "server/api/openchannelQueue/index.js",
18914 "groupTitle": "Openchannel_Queues"
18918 "url": "/api/openchannel/queues",
18919 "title": "Gets a list of Queues",
18922 "title": "Example usage:",
18923 "content": "curl https://{domain}/api/openchannel/queues -v -u {name}:{password}",
18927 "name": "GetQueues",
18928 "group": "Openchannel_Queues",
18929 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/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>",
18930 "version": "0.0.0",
18931 "filename": "server/api/openchannelQueue/index.js",
18932 "groupTitle": "Openchannel_Queues"
18936 "url": "/api/openchannel/queues/{id}/teams",
18937 "title": "Gets queues list",
18940 "title": "Example usage:",
18941 "content": "curl https://{domain}/api/openchannel/queues/{id}/teams -v -u {name}:{password}",
18945 "name": "GetTeams",
18946 "group": "Openchannel_Queues",
18947 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18948 "version": "0.0.0",
18949 "filename": "server/api/openchannelQueue/index.js",
18950 "groupTitle": "Openchannel_Queues"
18954 "url": "/api/openchannel/queues/{id}/users",
18955 "title": "Removes agents from a queue",
18958 "title": "Example usage:",
18959 "content": "curl https://{domain}/api/openchannel/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
18963 "name": "RemoveAgents",
18964 "group": "Openchannel_Queues",
18965 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <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": "Gets a single Queue",
18976 "title": "Example usage:",
18977 "content": "curl https://{domain}/api/openchannel/queues/{id} -v -u {name}:{password}",
18981 "name": "ShowQueues",
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/queues/{id}",
18991 "title": "Update an existing Queue",
18994 "title": "Example usage:",
18995 "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",
18999 "name": "updateQueues",
19000 "group": "Openchannel_Queues",
19001 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19002 "version": "0.0.0",
19003 "filename": "server/api/openchannelQueue/index.js",
19004 "groupTitle": "Openchannel_Queues"
19008 "url": "/api/openchannel/reports/transfer",
19009 "title": "Creates a new Openchannel Transfer Report",
19012 "title": "Example usage:",
19013 "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",
19017 "name": "CreateOpenchannel_Transfer_Reports",
19018 "group": "Openchannel_Transfer_Reports",
19026 "field": "uniqueid",
19045 "field": "transferredAt",
19051 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</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/{id}",
19059 "title": "Deletes a Openchannel Transfer Report",
19062 "title": "Example usage:",
19063 "content": "curl https://{domain}/api/openchannel/reports/transfer/{id} -v -u {name}:{password} -X DELETE",
19067 "name": "DeleteOpenchannel_Transfer_Reports",
19068 "group": "Openchannel_Transfer_Reports",
19069 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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/describe",
19077 "title": "Gets table info about Openchannel Transfer Reports",
19080 "title": "Example usage:",
19081 "content": "curl https://{domain}/api/openchannel/reports/transfer/describe -v -u {name}:{password}",
19085 "name": "DescribeOpenchannel_Transfer_Reports",
19086 "group": "Openchannel_Transfer_Reports",
19087 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19088 "version": "0.0.0",
19089 "filename": "server/api/openchannelTransferReport/index.js",
19090 "groupTitle": "Openchannel_Transfer_Reports"
19094 "url": "/api/openchannel/reports/transfer",
19095 "title": "Gets a list of Openchannel Transfer Reports",
19098 "title": "Example usage:",
19099 "content": "curl https://{domain}/api/openchannel/reports/transfer -v -u {name}:{password}",
19103 "name": "GetOpenchannel_Transfer_Reports",
19104 "group": "Openchannel_Transfer_Reports",
19105 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
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": "Gets a single Openchannel Transfer Report",
19116 "title": "Example usage:",
19117 "content": "curl https://{domain}/api/openchannel/reports/transfer/{id} -v -u {name}:{password}",
19121 "name": "ShowOpenchannel_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/openchannel/reports/transfer/{id}",
19131 "title": "Update an existing Openchannel Transfer Report",
19134 "title": "Example usage:",
19135 "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",
19139 "name": "updateOpenchannel_Transfer_Reports",
19140 "group": "Openchannel_Transfer_Reports",
19141 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19142 "version": "0.0.0",
19143 "filename": "server/api/openchannelTransferReport/index.js",
19144 "groupTitle": "Openchannel_Transfer_Reports"
19148 "url": "/api/pauses",
19149 "title": "Creates a new Pause",
19152 "title": "Example usage:",
19153 "content": "curl https://{domain}/api/pauses -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
19157 "name": "CreatePauses",
19173 "field": "description",
19179 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</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/{id}",
19187 "title": "Deletes a Pause",
19190 "title": "Example usage:",
19191 "content": "curl https://{domain}/api/pauses/{id} -v -u {name}:{password} -X DELETE",
19195 "name": "DeletePauses",
19197 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19198 "version": "0.0.0",
19199 "filename": "server/api/pause/index.js",
19200 "groupTitle": "Pauses"
19204 "url": "/api/pauses",
19205 "title": "Gets a list of Pauses",
19208 "title": "Example usage:",
19209 "content": "curl https://{domain}/api/pauses -v -u {name}:{password}",
19213 "name": "GetPauses",
19215 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
19216 "version": "0.0.0",
19217 "filename": "server/api/pause/index.js",
19218 "groupTitle": "Pauses"
19222 "url": "/api/pauses/{id}",
19223 "title": "Gets a single Pause",
19226 "title": "Example usage:",
19227 "content": "curl https://{domain}/api/pauses/{id} -v -u {name}:{password}",
19231 "name": "ShowPauses",
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/pauses/{id}",
19241 "title": "Update an existing Pause",
19244 "title": "Example usage:",
19245 "content": "curl https://{domain}/api/pauses/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
19249 "name": "updatePauses",
19251 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19252 "version": "0.0.0",
19253 "filename": "server/api/pause/index.js",
19254 "groupTitle": "Pauses"
19258 "url": "/api/plugins",
19259 "title": "Gets a list of Plugins",
19262 "title": "Example usage:",
19263 "content": "curl https://{domain}/api/plugins -v -u {name}:{password}",
19267 "name": "GetPlugins",
19268 "group": "Plugins",
19269 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
19270 "version": "0.0.0",
19271 "filename": "server/api/plugin/index.js",
19272 "groupTitle": "Plugins"
19276 "url": "/api/plugins/{id}",
19277 "title": "Gets a single Plugin",
19280 "title": "Example usage:",
19281 "content": "curl https://{domain}/api/plugins/{id} -v -u {name}:{password}",
19285 "name": "ShowPlugins",
19286 "group": "Plugins",
19287 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <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}",
19295 "title": "Delete a plugin",
19298 "title": "Example usage:",
19299 "content": "curl https://{domain}/api/plugins/{id} -v -u {name}:{password} -X DELETE",
19303 "name": "destroyPlugin",
19304 "group": "Plugins",
19305 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <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}/download",
19313 "title": "Download plugin source code",
19316 "title": "Example usage:",
19317 "content": "curl https://{domain}/api/plugins/{id}/download -v -u {name}:{password} -X GET",
19321 "name": "download",
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/{id}",
19331 "title": "Update an existing plugin",
19334 "title": "Example usage:",
19335 "content": "curl https://{domain}/api/plugins/{id} -v -u {name}:{password} -X PUT",
19339 "name": "updatePlugin",
19340 "group": "Plugins",
19341 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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",
19349 "title": "Upload new plugin",
19352 "title": "Example usage:",
19353 "content": "curl https://{domain}/api/plugins -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
19357 "name": "uploadPlugin",
19358 "group": "Plugins",
19359 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</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} -v -u {name}:{password} -X GET",
19375 "name": "webhookPlugin",
19376 "group": "Plugins",
19377 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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/plugins/webhook?hostname={host}&port={port}&encoding={encoding}&json={json}&path={path}",
19385 "title": "Redirect a plugin request to the specified path",
19388 "title": "Example usage:",
19389 "content": "curl https://{domain}/api/plugins/webhook?port={port}&path={path} -H 'Content-Type: application/json' -X POST",
19393 "name": "webhookPlugin",
19394 "group": "Plugins",
19395 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19396 "version": "0.0.0",
19397 "filename": "server/api/plugin/index.js",
19398 "groupTitle": "Plugins"
19402 "url": "/api/pm2/{id}",
19403 "title": "Deletes an existing process",
19406 "title": "Example usage:",
19407 "content": "curl https://{domain}/api/pm2/{id} -v -u {name}:{password} -X DELETE",
19411 "name": "DeletePm2Process",
19413 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <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"
19420 "url": "/api/pm2/{id}",
19421 "title": "Gets a single pm2 process",
19424 "title": "Example usage:",
19425 "content": "curl https://{domain}/api/pm2/{id} -v -u {name}:{password}",
19429 "name": "GetPm2Process",
19431 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19432 "version": "0.0.0",
19433 "filename": "server/api/pm2/index.js",
19434 "groupTitle": "Pm2"
19439 "title": "Gets pm2 processes",
19442 "title": "Example usage:",
19443 "content": "curl https://{domain}/api/pm2 -v -u {name}:{password}",
19447 "name": "GetPm2Processes",
19449 "description": "<p>Motion returns the pm2 processes list.</p>",
19450 "version": "0.0.0",
19451 "filename": "server/api/pm2/index.js",
19452 "groupTitle": "Pm2"
19457 "title": "Start a single pm2 process",
19460 "title": "Example usage:",
19461 "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",
19465 "name": "StartPm2Process",
19487 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</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/pm2/{id}",
19495 "title": "Update an existing process",
19498 "title": "Example usage:",
19499 "content": "curl https://{domain}/api/pm2/{id} -d '{\"status\": \"online\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
19503 "name": "UpdatePm2Process",
19505 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19506 "version": "0.0.0",
19507 "filename": "server/api/pm2/index.js",
19508 "groupTitle": "Pm2"
19512 "url": "/api/rpc/campaigns/",
19513 "title": "Gets a list of campaigns",
19516 "title": "Example usage:",
19517 "content": "curl https://{domain}/api/rpc/campaigns -v -u {name}:{password}",
19521 "name": "Campaigns",
19522 "group": "RPC_Realtime",
19523 "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>",
19524 "version": "0.0.0",
19525 "filename": "server/api/rpc/index.js",
19526 "groupTitle": "RPC_Realtime"
19530 "url": "/api/rpc/fax/accounts",
19531 "title": "Gets a list of FaxAccounts",
19534 "title": "Example usage:",
19535 "content": "curl https://{domain}/api/rpc/fax/accounts -v -u {name}:{password}",
19539 "name": "FaxAccounts",
19540 "group": "RPC_Realtime",
19541 "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>",
19542 "version": "0.0.0",
19543 "filename": "server/api/rpc/index.js",
19544 "groupTitle": "RPC_Realtime"
19548 "url": "/api/rpc/agents/:id/capacity",
19549 "title": "Sets agent capacity",
19552 "title": "Example usage:",
19553 "content": "curl https://{domain}/api/rpc/agents/:id/capacity -v -u {name}:{password}",
19557 "name": "RTAgentCapacity",
19558 "group": "RPC_Realtime",
19559 "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>",
19560 "version": "0.0.0",
19561 "filename": "server/api/rpc/index.js",
19562 "groupTitle": "RPC_Realtime"
19566 "url": "/api/rpc/agents",
19567 "title": "Gets a list of RTAgents",
19570 "title": "Example usage:",
19571 "content": "curl https://{domain}/api/rpc/agents -v -u {name}:{password}",
19575 "name": "RTAgents",
19576 "group": "RPC_Realtime",
19577 "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>",
19578 "version": "0.0.0",
19579 "filename": "server/api/rpc/index.js",
19580 "groupTitle": "RPC_Realtime"
19584 "url": "/api/rpc/chat/queues",
19585 "title": "Gets a list of RTChatQueues",
19588 "title": "Example usage:",
19589 "content": "curl https://{domain}/api/rpc/chat/queues -v -u {name}:{password}",
19593 "name": "RTChatQueues",
19594 "group": "RPC_Realtime",
19595 "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>",
19596 "version": "0.0.0",
19597 "filename": "server/api/rpc/index.js",
19598 "groupTitle": "RPC_Realtime"
19602 "url": "/api/rpc/fax/queues",
19603 "title": "Gets a list of RTFaxQueues",
19606 "title": "Example usage:",
19607 "content": "curl https://{domain}/api/rpc/fax/queues -v -u {name}:{password}",
19611 "name": "RTFaxQueues",
19612 "group": "RPC_Realtime",
19613 "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>",
19614 "version": "0.0.0",
19615 "filename": "server/api/rpc/index.js",
19616 "groupTitle": "RPC_Realtime"
19620 "url": "/api/rpc/mail/accounts",
19621 "title": "Gets a list of RTMailAccounts",
19624 "title": "Example usage:",
19625 "content": "curl https://{domain}/api/rpc/mail/accounts -v -u {name}:{password}",
19629 "name": "RTMailAccounts",
19630 "group": "RPC_Realtime",
19631 "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>",
19632 "version": "0.0.0",
19633 "filename": "server/api/rpc/index.js",
19634 "groupTitle": "RPC_Realtime"
19638 "url": "/api/rpc/mail/queues",
19639 "title": "Gets a list of RTMailQueues",
19642 "title": "Example usage:",
19643 "content": "curl https://{domain}/api/rpc/mail/queues -v -u {name}:{password}",
19647 "name": "RTMailQueues",
19648 "group": "RPC_Realtime",
19649 "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>",
19650 "version": "0.0.0",
19651 "filename": "server/api/rpc/index.js",
19652 "groupTitle": "RPC_Realtime"
19656 "url": "/api/rpc/openchannel/queues",
19657 "title": "Gets a list of RTOpenchannelQueues",
19660 "title": "Example usage:",
19661 "content": "curl https://{domain}/api/rpc/openchannel/queues -v -u {name}:{password}",
19665 "name": "RTOpenchannelQueues",
19666 "group": "RPC_Realtime",
19667 "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>",
19668 "version": "0.0.0",
19669 "filename": "server/api/rpc/index.js",
19670 "groupTitle": "RPC_Realtime"
19674 "url": "/api/rpc/outbound/channels",
19675 "title": "Gets a list of RTOutboundChannels",
19678 "title": "Example usage:",
19679 "content": "curl https://{domain}/api/rpc/outbound/channels -v -u {name}:{password}",
19683 "name": "RTOutboundChannels",
19684 "group": "RPC_Realtime",
19685 "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>",
19686 "version": "0.0.0",
19687 "filename": "server/api/rpc/index.js",
19688 "groupTitle": "RPC_Realtime"
19692 "url": "/api/rpc/sms/queues",
19693 "title": "Gets a list of RTSmsQueues",
19696 "title": "Example usage:",
19697 "content": "curl https://{domain}/api/rpc/sms/queues -v -u {name}:{password}",
19701 "name": "RTSmsQueues",
19702 "group": "RPC_Realtime",
19703 "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>",
19704 "version": "0.0.0",
19705 "filename": "server/api/rpc/index.js",
19706 "groupTitle": "RPC_Realtime"
19710 "url": "/api/rpc/telephones",
19711 "title": "Gets a list of RTTelephones",
19714 "title": "Example usage:",
19715 "content": "curl https://{domain}/api/rpc/telephones -v -u {name}:{password}",
19719 "name": "RTTelephones",
19720 "group": "RPC_Realtime",
19721 "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>",
19722 "version": "0.0.0",
19723 "filename": "server/api/rpc/index.js",
19724 "groupTitle": "RPC_Realtime"
19728 "url": "/api/rpc/trunks",
19729 "title": "Gets a list of RTTrunks",
19732 "title": "Example usage:",
19733 "content": "curl https://{domain}/api/rpc/trunks -v -u {name}:{password}",
19737 "name": "RTTrunks",
19738 "group": "RPC_Realtime",
19739 "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>",
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 RTVoiceChannelMixMonitor",
19750 "title": "Example usage:",
19751 "content": "curl https://{domain}/api/rpc/voice/channels/{uniqueid}/mixmonitor -v -u {name}:{password}",
19755 "name": "RTVoiceChannelMixMonitor",
19756 "group": "RPC_Realtime",
19757 "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>",
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 RTVoiceChannelStopMixMonitor",
19768 "title": "Example usage:",
19769 "content": "curl https://{domain}/api/rpc/voice/channels/{uniqueid}/stopmixmonitor -v -u {name}:{password}",
19773 "name": "RTVoiceChannelStopMixMonitor",
19774 "group": "RPC_Realtime",
19775 "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>",
19776 "version": "0.0.0",
19777 "filename": "server/api/rpc/index.js",
19778 "groupTitle": "RPC_Realtime"
19782 "url": "/api/rpc/voice/channels",
19783 "title": "Gets a list of RTVoiceChannels",
19786 "title": "Example usage:",
19787 "content": "curl https://{domain}/api/rpc/voice/channels -v -u {name}:{password}",
19791 "name": "RTVoiceChannels",
19792 "group": "RPC_Realtime",
19793 "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>",
19794 "version": "0.0.0",
19795 "filename": "server/api/rpc/index.js",
19796 "groupTitle": "RPC_Realtime"
19800 "url": "/api/rpc/voice/queues/channels/{uniqueid}",
19801 "title": "Gets a single RTVoiceQueueChannel",
19804 "title": "Example usage:",
19805 "content": "curl https://{domain}/api/rpc/voice/queues/channels/{uniqueid} -v -u {name}:{password}",
19809 "name": "RTVoiceQueueChannel",
19810 "group": "RPC_Realtime",
19811 "description": "<p>Motion will return 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}/hangup",
19819 "title": "Hangup a single RTVoiceQueueChannel",
19822 "title": "Example usage:",
19823 "content": "curl https://{domain}/api/rpc/voice/queues/channels/{uniqueid}/hangup -v -u {name}:{password}",
19827 "name": "RTVoiceQueueChannelHangup",
19828 "group": "RPC_Realtime",
19829 "description": "<p>Motion will hangup a specific realtime voice queue channel.</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/channels/{uniqueid}/redirect/{exten}",
19837 "title": "Hangup a single RTVoiceQueueChannel",
19840 "title": "Example usage:",
19841 "content": "curl https://{domain}/api/rpc/voice/queues/channels/{uniqueid}/redirect/{exten} -v -u {name}:{password}",
19845 "name": "RTVoiceQueueChannelRedirect",
19846 "group": "RPC_Realtime",
19847 "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>",
19848 "version": "0.0.0",
19849 "filename": "server/api/rpc/index.js",
19850 "groupTitle": "RPC_Realtime"
19854 "url": "/api/rpc/voice/queues/preview/{id}",
19855 "title": "Gets a single preview contact",
19858 "title": "Example usage:",
19859 "content": "curl https://{domain}/api/rpc/voice/queues/preview/{id} -v -u {name}:{password}",
19863 "name": "RTVoiceQueuePreview",
19864 "group": "RPC_Realtime",
19865 "description": "<p>Motion will return a specific preview contact.</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/outbound",
19891 "title": "Gets a list of RTOutbound",
19894 "title": "Example usage:",
19895 "content": "curl https://{domain}/api/rpc/outbound -v -u {name}:{password}",
19899 "name": "RTVoiceQueues",
19900 "group": "RPC_Realtime",
19901 "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>",
19902 "version": "0.0.0",
19903 "filename": "server/api/rpc/index.js",
19904 "groupTitle": "RPC_Realtime"
19908 "url": "/api/rpc/voice/queues/channels",
19909 "title": "Gets a list of RTVoiceQueuesChannels",
19912 "title": "Example usage:",
19913 "content": "curl https://{domain}/api/rpc/voice/queues/channels -v -u {name}:{password}",
19917 "name": "RTVoiceQueuesChannels",
19918 "group": "RPC_Realtime",
19919 "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>",
19920 "version": "0.0.0",
19921 "filename": "server/api/rpc/index.js",
19922 "groupTitle": "RPC_Realtime"
19926 "url": "/api/rpc/chat/queues/{id}",
19927 "title": "Gets a single RTChatQueue",
19930 "title": "Example usage:",
19931 "content": "curl https://{domain}/api/rpc/chat/queues/{id} -v -u {name}:{password}",
19935 "name": "ShowRTChatQueues",
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/fax/queues/{id}",
19945 "title": "Gets a single RTFaxQueue",
19948 "title": "Example usage:",
19949 "content": "curl https://{domain}/api/rpc/fax/queues/{id} -v -u {name}:{password}",
19953 "name": "ShowRTFaxQueues",
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/mail/queues/{id}",
19963 "title": "Gets a single RTMailQueue",
19966 "title": "Example usage:",
19967 "content": "curl https://{domain}/api/rpc/mail/queues/{id} -v -u {name}:{password}",
19971 "name": "ShowRTMailQueues",
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/openchannel/queues/{id}",
19981 "title": "Gets a single RTOpenchannelQueue",
19984 "title": "Example usage:",
19985 "content": "curl https://{domain}/api/rpc/openchannel/queues/{id} -v -u {name}:{password}",
19989 "name": "ShowRTOpenchannelQueues",
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/sms/queues/{id}",
19999 "title": "Gets a single RTSmsQueue",
20002 "title": "Example usage:",
20003 "content": "curl https://{domain}/api/rpc/sms/queues/{id} -v -u {name}:{password}",
20007 "name": "ShowRTSmsQueues",
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/voice/queues/{id}",
20017 "title": "Gets a single RTVoiceQueue",
20020 "title": "Example usage:",
20021 "content": "curl https://{domain}/api/rpc/voice/queues/{id} -v -u {name}:{password}",
20025 "name": "ShowRTVoiceQueues",
20026 "group": "RPC_Realtime",
20027 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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/agents/:id/notify",
20035 "title": "Notify message to a specific agent",
20038 "title": "Example usage:",
20039 "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",
20043 "name": "agentNotify",
20044 "group": "RPC_Realtime",
20045 "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>",
20046 "version": "0.0.0",
20047 "filename": "server/api/rpc/index.js",
20048 "groupTitle": "RPC_Realtime"
20052 "url": "/api/rpc/chat/queues/:id/notify",
20053 "title": "Notify message to a specific queue",
20056 "title": "Example usage:",
20057 "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",
20061 "name": "chatQueueNotify",
20062 "group": "RPC_Realtime",
20063 "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>",
20064 "version": "0.0.0",
20065 "filename": "server/api/rpc/index.js",
20066 "groupTitle": "RPC_Realtime"
20070 "url": "/api/rpc/chat/queues/waitinginteractions",
20071 "title": "Gets a list of chatQueuesWaitingInteractions",
20074 "title": "Example usage:",
20075 "content": "curl https://{domain}/api/rpc/chat/queues/waitinginteractions -v -u {name}:{password}",
20079 "name": "chatQueuesWaitingInteractions",
20080 "group": "RPC_Realtime",
20081 "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>",
20082 "version": "0.0.0",
20083 "filename": "server/api/rpc/index.js",
20084 "groupTitle": "RPC_Realtime"
20088 "url": "/api/rpc/fax/queues/:id/notify",
20089 "title": "Notify message to a specific queue",
20092 "title": "Example usage:",
20093 "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",
20097 "name": "faxQueueNotify",
20098 "group": "RPC_Realtime",
20099 "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>",
20100 "version": "0.0.0",
20101 "filename": "server/api/rpc/index.js",
20102 "groupTitle": "RPC_Realtime"
20106 "url": "/api/rpc/fax/queues/waitinginteractions",
20107 "title": "Gets a list of faxQueuesWaitingInteractions",
20110 "title": "Example usage:",
20111 "content": "curl https://{domain}/api/rpc/fax/queues/waitinginteractions -v -u {name}:{password}",
20115 "name": "faxQueuesWaitingInteractions",
20116 "group": "RPC_Realtime",
20117 "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>",
20118 "version": "0.0.0",
20119 "filename": "server/api/rpc/index.js",
20120 "groupTitle": "RPC_Realtime"
20124 "url": "/api/rpc/mail/queues/:id/notify",
20125 "title": "Notify message to a specific queue",
20128 "title": "Example usage:",
20129 "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",
20133 "name": "mailQueueNotify",
20134 "group": "RPC_Realtime",
20135 "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>",
20136 "version": "0.0.0",
20137 "filename": "server/api/rpc/index.js",
20138 "groupTitle": "RPC_Realtime"
20142 "url": "/api/rpc/mail/queues/waitinginteractions",
20143 "title": "Gets a list of mailQueuesWaitingInteractions",
20146 "title": "Example usage:",
20147 "content": "curl https://{domain}/api/rpc/mail/queues/waitinginteractions -v -u {name}:{password}",
20151 "name": "mailQueuesWaitingInteractions",
20152 "group": "RPC_Realtime",
20153 "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>",
20154 "version": "0.0.0",
20155 "filename": "server/api/rpc/index.js",
20156 "groupTitle": "RPC_Realtime"
20160 "url": "/api/rpc/openchannel/queues/:id/notify",
20161 "title": "Notify message to a specific queue",
20164 "title": "Example usage:",
20165 "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",
20169 "name": "openchannelQueueNotify",
20170 "group": "RPC_Realtime",
20171 "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>",
20172 "version": "0.0.0",
20173 "filename": "server/api/rpc/index.js",
20174 "groupTitle": "RPC_Realtime"
20178 "url": "/api/rpc/openchannel/queues/:id/waitinginteractions",
20179 "title": "Gets a list of openchannelQueuesIdWaitingInteractions",
20182 "title": "Example usage:",
20183 "content": "curl https://{domain}/api/rpc/openchannel/queues/:id/waitinginteractions -v -u {name}:{password}",
20187 "name": "openchannelQueuesIdWaitingInteractions",
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/openchannel/queues/waitinginteractions",
20197 "title": "Gets a list of openchannelQueuesWaitingInteractions",
20200 "title": "Example usage:",
20201 "content": "curl https://{domain}/api/rpc/openchannel/queues/waitinginteractions -v -u {name}:{password}",
20205 "name": "openchannelQueuesWaitingInteractions",
20206 "group": "RPC_Realtime",
20207 "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>",
20208 "version": "0.0.0",
20209 "filename": "server/api/rpc/index.js",
20210 "groupTitle": "RPC_Realtime"
20214 "url": "/api/rpc/sms/queues/:id/notify",
20215 "title": "Notify message to a specific queue",
20218 "title": "Example usage:",
20219 "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",
20223 "name": "smsQueueNotify",
20224 "group": "RPC_Realtime",
20225 "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>",
20226 "version": "0.0.0",
20227 "filename": "server/api/rpc/index.js",
20228 "groupTitle": "RPC_Realtime"
20232 "url": "/api/rpc/sms/queues/waitinginteractions",
20233 "title": "Gets a list of smsQueuesWaitingInteractions",
20236 "title": "Example usage:",
20237 "content": "curl https://{domain}/api/rpc/sms/queues/waitinginteractions -v -u {name}:{password}",
20241 "name": "smsQueuesWaitingInteractions",
20242 "group": "RPC_Realtime",
20243 "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>",
20244 "version": "0.0.0",
20245 "filename": "server/api/rpc/index.js",
20246 "groupTitle": "RPC_Realtime"
20250 "url": "/api/integrations/salesforce/accounts",
20251 "title": "Creates a new Salesforce Account",
20254 "title": "Example usage:",
20255 "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",
20259 "name": "CreateSalesforce_Accounts",
20260 "group": "Salesforce_Accounts",
20275 "field": "description",
20282 "field": "username",
20289 "field": "remoteUri",
20296 "field": "password",
20303 "field": "clientId",
20310 "field": "clientSecret",
20317 "field": "securityToken",
20324 "field": "serverUrl",
20331 "\"integrationTab\"",
20341 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</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/{id}",
20349 "title": "Deletes a Salesforce Account",
20352 "title": "Example usage:",
20353 "content": "curl https://{domain}/api/integrations/salesforce/accounts/{id} -v -u {name}:{password} -X DELETE",
20357 "name": "DeleteSalesforce_Accounts",
20358 "group": "Salesforce_Accounts",
20359 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20360 "version": "0.0.0",
20361 "filename": "server/api/intSalesforceAccount/index.js",
20362 "groupTitle": "Salesforce_Accounts"
20366 "url": "/api/integrations/salesforce/accounts",
20367 "title": "Gets a list of Salesforce Accounts",
20370 "title": "Example usage:",
20371 "content": "curl https://{domain}/api/integrations/salesforce/accounts -v -u {name}:{password}",
20375 "name": "GetSalesforce_Accounts",
20376 "group": "Salesforce_Accounts",
20377 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
20378 "version": "0.0.0",
20379 "filename": "server/api/intSalesforceAccount/index.js",
20380 "groupTitle": "Salesforce_Accounts"
20384 "url": "/api/integrations/salesforce/accounts/{id}",
20385 "title": "Gets a single Salesforce Account",
20388 "title": "Example usage:",
20389 "content": "curl https://{domain}/api/integrations/salesforce/accounts/{id} -v -u {name}:{password}",
20393 "name": "ShowSalesforce_Accounts",
20394 "group": "Salesforce_Accounts",
20395 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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": "Creates new configuration",
20406 "title": "Example usage:",
20407 "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",
20411 "name": "addConfiguration",
20412 "group": "Salesforce_Accounts",
20413 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</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}/configurations",
20421 "title": "Gets account configurations",
20424 "title": "Example usage:",
20425 "content": "curl https://{domain}/api/integrations/salesforce/accounts/{id}/configurations -v -u {name}:{password} -X GET",
20429 "name": "getConfigurations",
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}/fields",
20439 "title": "Gets account fields",
20442 "title": "Example usage:",
20443 "content": "curl https://{domain}/api/integrations/salesforce/accounts/{id}/fields -v -u {name}:{password} -X GET",
20447 "name": "getFields",
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/accounts/{id}",
20457 "title": "Update an existing Salesforce Account",
20460 "title": "Example usage:",
20461 "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",
20465 "name": "updateSalesforce_Accounts",
20466 "group": "Salesforce_Accounts",
20467 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20468 "version": "0.0.0",
20469 "filename": "server/api/intSalesforceAccount/index.js",
20470 "groupTitle": "Salesforce_Accounts"
20474 "url": "/api/integrations/salesforce/configurations",
20475 "title": "Creates a new Salesforce Configuration",
20478 "title": "Example usage:",
20479 "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",
20483 "name": "CreateSalesforce_Configurations",
20484 "group": "Salesforce_Configurations",
20499 "field": "description",
20510 "field": "ticketType",
20517 "\"contact_lead\"",
20522 "field": "moduleSearch",
20534 "field": "moduleCreate",
20540 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</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/{id}",
20548 "title": "Deletes a Salesforce Configuration",
20551 "title": "Example usage:",
20552 "content": "curl https://{domain}/api/integrations/salesforce/configurations/{id} -v -u {name}:{password} -X DELETE",
20556 "name": "DeleteSalesforce_Configurations",
20557 "group": "Salesforce_Configurations",
20558 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20559 "version": "0.0.0",
20560 "filename": "server/api/intSalesforceConfiguration/index.js",
20561 "groupTitle": "Salesforce_Configurations"
20565 "url": "/api/integrations/salesforce/configurations",
20566 "title": "Gets a list of Salesforce Configurations",
20569 "title": "Example usage:",
20570 "content": "curl https://{domain}/api/integrations/salesforce/configurations -v -u {name}:{password}",
20574 "name": "GetSalesforce_Configurations",
20575 "group": "Salesforce_Configurations",
20576 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
20577 "version": "0.0.0",
20578 "filename": "server/api/intSalesforceConfiguration/index.js",
20579 "groupTitle": "Salesforce_Configurations"
20583 "url": "/api/integrations/salesforce/configurations/{id}",
20584 "title": "Gets a single Salesforce Configuration",
20587 "title": "Example usage:",
20588 "content": "curl https://{domain}/api/integrations/salesforce/configurations/{id} -v -u {name}:{password}",
20592 "name": "ShowSalesforce_Configurations",
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}/descriptions",
20602 "title": "Gets configurations descriptions",
20605 "title": "Example usage:",
20606 "content": "curl https://{domain}/api/integrations/salesforce/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
20610 "name": "getDescriptions",
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}/fields",
20620 "title": "Gets configurations fields",
20623 "title": "Example usage:",
20624 "content": "curl https://{domain}/api/integrations/salesforce/configurations/{id}/fields -v -u {name}:{password} -X GET",
20628 "name": "getFields",
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}/subjects",
20638 "title": "Gets configurations subjects",
20641 "title": "Example usage:",
20642 "content": "curl https://{domain}/api/integrations/salesforce/configurations/{id}/subjects -v -u {name}:{password} -X GET",
20646 "name": "getSubjects",
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/configurations/{id}",
20656 "title": "Update an existing Salesforce Configuration",
20659 "title": "Example usage:",
20660 "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",
20664 "name": "updateSalesforce_Configurations",
20665 "group": "Salesforce_Configurations",
20666 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20667 "version": "0.0.0",
20668 "filename": "server/api/intSalesforceConfiguration/index.js",
20669 "groupTitle": "Salesforce_Configurations"
20673 "url": "/api/integrations/salesforce/fields",
20674 "title": "Creates a new Salesforce Field",
20677 "title": "Example usage:",
20678 "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",
20682 "name": "CreateSalesforce_Fields",
20683 "group": "Salesforce_Fields",
20693 "\"customVariable\"",
20704 "field": "content",
20720 "\"customVariable\""
20723 "field": "keyType",
20730 "field": "keyContent",
20737 "field": "idField",
20744 "field": "variableName",
20750 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</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/{id}",
20758 "title": "Deletes a Salesforce Field",
20761 "title": "Example usage:",
20762 "content": "curl https://{domain}/api/integrations/salesforce/fields/{id} -v -u {name}:{password} -X DELETE",
20766 "name": "DeleteSalesforce_Fields",
20767 "group": "Salesforce_Fields",
20768 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20769 "version": "0.0.0",
20770 "filename": "server/api/intSalesforceField/index.js",
20771 "groupTitle": "Salesforce_Fields"
20775 "url": "/api/integrations/salesforce/fields",
20776 "title": "Gets a list of Salesforce Fields",
20779 "title": "Example usage:",
20780 "content": "curl https://{domain}/api/integrations/salesforce/fields -v -u {name}:{password}",
20784 "name": "GetSalesforce_Fields",
20785 "group": "Salesforce_Fields",
20786 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
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": "Gets a single Salesforce Field",
20797 "title": "Example usage:",
20798 "content": "curl https://{domain}/api/integrations/salesforce/fields/{id} -v -u {name}:{password}",
20802 "name": "ShowSalesforce_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/integrations/salesforce/fields/{id}",
20812 "title": "Update an existing Salesforce Field",
20815 "title": "Example usage:",
20816 "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",
20820 "name": "updateSalesforce_Fields",
20821 "group": "Salesforce_Fields",
20822 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20823 "version": "0.0.0",
20824 "filename": "server/api/intSalesforceField/index.js",
20825 "groupTitle": "Salesforce_Fields"
20829 "url": "/api/schedules",
20830 "title": "Creates a new Schedule",
20833 "title": "Example usage:",
20834 "content": "curl https://{domain}/api/schedules -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
20838 "name": "CreateSchedules",
20839 "group": "Schedules",
20854 "field": "description",
20875 "field": "startAt",
20889 "field": "subtractNumber",
20905 "field": "subtractUnit",
20935 "field": "sendMail",
20963 "field": "sendIfEmpty",
20969 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</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/{id}",
20977 "title": "Deletes a Schedule",
20980 "title": "Example usage:",
20981 "content": "curl https://{domain}/api/schedules/{id} -v -u {name}:{password} -X DELETE",
20985 "name": "DeleteSchedules",
20986 "group": "Schedules",
20987 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20988 "version": "0.0.0",
20989 "filename": "server/api/schedule/index.js",
20990 "groupTitle": "Schedules"
20994 "url": "/api/schedules",
20995 "title": "Gets a list of Schedules",
20998 "title": "Example usage:",
20999 "content": "curl https://{domain}/api/schedules -v -u {name}:{password}",
21003 "name": "GetSchedules",
21004 "group": "Schedules",
21005 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
21006 "version": "0.0.0",
21007 "filename": "server/api/schedule/index.js",
21008 "groupTitle": "Schedules"
21012 "url": "/api/schedules/{id}",
21013 "title": "Gets a single Schedule",
21016 "title": "Example usage:",
21017 "content": "curl https://{domain}/api/schedules/{id} -v -u {name}:{password}",
21021 "name": "ShowSchedules",
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}/run",
21031 "title": "Run Scheduler",
21034 "title": "Example usage:",
21035 "content": "curl https://{domain}/api/schedules/{id}/run -v -u {name}:{password} -X GET",
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/schedules/{id}",
21049 "title": "Update an existing Schedule",
21052 "title": "Example usage:",
21053 "content": "curl https://{domain}/api/schedules/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
21057 "name": "updateSchedules",
21058 "group": "Schedules",
21059 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21060 "version": "0.0.0",
21061 "filename": "server/api/schedule/index.js",
21062 "groupTitle": "Schedules"
21066 "url": "/api/screen/recordings",
21067 "title": "Creates a new Recording",
21070 "title": "Example usage:",
21071 "content": "curl https://{domain}/api/screen/recordings -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
21075 "name": "CreateRecordings",
21076 "group": "Screen_Recordings",
21091 "field": "interactionid",
21098 "field": "channel",
21119 "field": "duration",
21126 "field": "startedAt",
21133 "field": "closedAt",
21140 "field": "createdAt",
21147 "field": "updatedAt",
21153 "description": "<p>Motion will return a HTTP status code <code>201</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/describe",
21161 "title": "Gets table info about Recordings",
21164 "title": "Example usage:",
21165 "content": "curl https://{domain}/api/screen/recordings/describe -v -u {name}:{password}",
21169 "name": "DescribeRecordings",
21170 "group": "Screen_Recordings",
21171 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21172 "version": "0.0.0",
21173 "filename": "server/api/screenRecording/index.js",
21174 "groupTitle": "Screen_Recordings"
21178 "url": "/api/screen/recordings",
21179 "title": "Gets a list of Recordings",
21182 "title": "Example usage:",
21183 "content": "curl https://{domain}/api/screen/recordings -v -u {name}:{password}",
21187 "name": "GetRecordings",
21188 "group": "Screen_Recordings",
21189 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
21190 "version": "0.0.0",
21191 "filename": "server/api/screenRecording/index.js",
21192 "groupTitle": "Screen_Recordings"
21196 "url": "/api/screen/recordings/{id}",
21197 "title": "Gets a single Recording",
21200 "title": "Example usage:",
21201 "content": "curl https://{domain}/api/screen/recordings/{id} -v -u {name}:{password}",
21205 "name": "ShowRecordings",
21206 "group": "Screen_Recordings",
21207 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <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}",
21215 "title": "Delete screen recording",
21218 "title": "Example usage:",
21219 "content": "curl https://{domain}/api/screen/recordings/{id} -v -u {name}:{password} -X DELETE",
21224 "group": "Screen_Recordings",
21225 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <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}/download",
21233 "title": "Download Recording",
21236 "title": "Example usage:",
21237 "content": "curl https://{domain}/api/screen/recordings/{id}/download -v -u {name}:{password} -X GET",
21241 "name": "download",
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/screen/recordings/{id}",
21251 "title": "Update an existing Recording",
21254 "title": "Example usage:",
21255 "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",
21259 "name": "updateRecordings",
21260 "group": "Screen_Recordings",
21261 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21262 "version": "0.0.0",
21263 "filename": "server/api/screenRecording/index.js",
21264 "groupTitle": "Screen_Recordings"
21268 "url": "/api/integrations/servicenow/accounts",
21269 "title": "Creates a new Servicenow Account",
21272 "title": "Example usage:",
21273 "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",
21277 "name": "CreateServicenow_Accounts",
21278 "group": "Servicenow_Accounts",
21293 "field": "description",
21300 "field": "username",
21307 "field": "password",
21321 "field": "remoteUri",
21328 "field": "serverUrl",
21334 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</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/{id}",
21342 "title": "Deletes a Servicenow Account",
21345 "title": "Example usage:",
21346 "content": "curl https://{domain}/api/integrations/servicenow/accounts/{id} -v -u {name}:{password} -X DELETE",
21350 "name": "DeleteServicenow_Accounts",
21351 "group": "Servicenow_Accounts",
21352 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21353 "version": "0.0.0",
21354 "filename": "server/api/intServicenowAccount/index.js",
21355 "groupTitle": "Servicenow_Accounts"
21359 "url": "/api/integrations/servicenow/accounts",
21360 "title": "Gets a list of Servicenow Accounts",
21363 "title": "Example usage:",
21364 "content": "curl https://{domain}/api/integrations/servicenow/accounts -v -u {name}:{password}",
21368 "name": "GetServicenow_Accounts",
21369 "group": "Servicenow_Accounts",
21370 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
21371 "version": "0.0.0",
21372 "filename": "server/api/intServicenowAccount/index.js",
21373 "groupTitle": "Servicenow_Accounts"
21377 "url": "/api/integrations/servicenow/accounts/{id}",
21378 "title": "Gets a single Servicenow Account",
21381 "title": "Example usage:",
21382 "content": "curl https://{domain}/api/integrations/servicenow/accounts/{id} -v -u {name}:{password}",
21386 "name": "ShowServicenow_Accounts",
21387 "group": "Servicenow_Accounts",
21388 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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": "Creates new configuration",
21399 "title": "Example usage:",
21400 "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",
21404 "name": "addConfiguration",
21405 "group": "Servicenow_Accounts",
21406 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</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}/configurations",
21414 "title": "Gets account configurations",
21417 "title": "Example usage:",
21418 "content": "curl https://{domain}/api/integrations/servicenow/accounts/{id}/configurations -v -u {name}:{password} -X GET",
21422 "name": "getConfigurations",
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}/fields",
21432 "title": "Gets account fields",
21435 "title": "Example usage:",
21436 "content": "curl https://{domain}/api/integrations/servicenow/accounts/{id}/fields -v -u {name}:{password} -X GET",
21440 "name": "getFields",
21441 "group": "Servicenow_Accounts",
21442 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21443 "version": "0.0.0",
21444 "filename": "server/api/intServicenowAccount/index.js",
21445 "groupTitle": "Servicenow_Accounts"
21449 "url": "/api/integrations/servicenow/accounts/{id}",
21450 "title": "Update an existing Servicenow Account",
21453 "title": "Example usage:",
21454 "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",
21458 "name": "updateServicenow_Accounts",
21459 "group": "Servicenow_Accounts",
21460 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21461 "version": "0.0.0",
21462 "filename": "server/api/intServicenowAccount/index.js",
21463 "groupTitle": "Servicenow_Accounts"
21467 "url": "/api/integrations/servicenow/configurations",
21468 "title": "Creates a new Servicenow Configuration",
21471 "title": "Example usage:",
21472 "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",
21476 "name": "CreateServicenow_Configurations",
21477 "group": "Servicenow_Configurations",
21492 "field": "description",
21498 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</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/{id}",
21506 "title": "Deletes a Servicenow Configuration",
21509 "title": "Example usage:",
21510 "content": "curl https://{domain}/api/integrations/servicenow/configurations/{id} -v -u {name}:{password} -X DELETE",
21514 "name": "DeleteServicenow_Configurations",
21515 "group": "Servicenow_Configurations",
21516 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21517 "version": "0.0.0",
21518 "filename": "server/api/intServicenowConfiguration/index.js",
21519 "groupTitle": "Servicenow_Configurations"
21523 "url": "/api/integrations/servicenow/configurations",
21524 "title": "Gets a list of Servicenow Configurations",
21527 "title": "Example usage:",
21528 "content": "curl https://{domain}/api/integrations/servicenow/configurations -v -u {name}:{password}",
21532 "name": "GetServicenow_Configurations",
21533 "group": "Servicenow_Configurations",
21534 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
21535 "version": "0.0.0",
21536 "filename": "server/api/intServicenowConfiguration/index.js",
21537 "groupTitle": "Servicenow_Configurations"
21541 "url": "/api/integrations/servicenow/configurations/{id}",
21542 "title": "Gets a single Servicenow Configuration",
21545 "title": "Example usage:",
21546 "content": "curl https://{domain}/api/integrations/servicenow/configurations/{id} -v -u {name}:{password}",
21550 "name": "ShowServicenow_Configurations",
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}/descriptions",
21560 "title": "Gets configurations descriptions",
21563 "title": "Example usage:",
21564 "content": "curl https://{domain}/api/integrations/servicenow/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
21568 "name": "getDescriptions",
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}/fields",
21578 "title": "Gets configurations fields",
21581 "title": "Example usage:",
21582 "content": "curl https://{domain}/api/integrations/servicenow/configurations/{id}/fields -v -u {name}:{password} -X GET",
21586 "name": "getFields",
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}/subjects",
21596 "title": "Gets configurations subjects",
21599 "title": "Example usage:",
21600 "content": "curl https://{domain}/api/integrations/servicenow/configurations/{id}/subjects -v -u {name}:{password} -X GET",
21604 "name": "getSubjects",
21605 "group": "Servicenow_Configurations",
21606 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21607 "version": "0.0.0",
21608 "filename": "server/api/intServicenowConfiguration/index.js",
21609 "groupTitle": "Servicenow_Configurations"
21613 "url": "/api/integrations/servicenow/configurations/{id}",
21614 "title": "Update an existing Servicenow Configuration",
21617 "title": "Example usage:",
21618 "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",
21622 "name": "updateServicenow_Configurations",
21623 "group": "Servicenow_Configurations",
21624 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21625 "version": "0.0.0",
21626 "filename": "server/api/intServicenowConfiguration/index.js",
21627 "groupTitle": "Servicenow_Configurations"
21631 "url": "/api/integrations/servicenow/fields",
21632 "title": "Creates a new Servicenow Field",
21635 "title": "Example usage:",
21636 "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",
21640 "name": "CreateServicenow_Fields",
21641 "group": "Servicenow_Fields",
21651 "\"customVariable\"",
21662 "field": "content",
21678 "\"customVariable\""
21681 "field": "keyType",
21688 "field": "keyContent",
21695 "field": "idField",
21702 "field": "nameField",
21709 "field": "customField",
21716 "field": "variableName",
21722 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</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/{id}",
21730 "title": "Deletes a Servicenow Field",
21733 "title": "Example usage:",
21734 "content": "curl https://{domain}/api/integrations/servicenow/fields/{id} -v -u {name}:{password} -X DELETE",
21738 "name": "DeleteServicenow_Fields",
21739 "group": "Servicenow_Fields",
21740 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21741 "version": "0.0.0",
21742 "filename": "server/api/intServicenowField/index.js",
21743 "groupTitle": "Servicenow_Fields"
21747 "url": "/api/integrations/servicenow/fields",
21748 "title": "Gets a list of Servicenow Fields",
21751 "title": "Example usage:",
21752 "content": "curl https://{domain}/api/integrations/servicenow/fields -v -u {name}:{password}",
21756 "name": "GetServicenow_Fields",
21757 "group": "Servicenow_Fields",
21758 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
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": "Gets a single Servicenow Field",
21769 "title": "Example usage:",
21770 "content": "curl https://{domain}/api/integrations/servicenow/fields/{id} -v -u {name}:{password}",
21774 "name": "ShowServicenow_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/integrations/servicenow/fields/{id}",
21784 "title": "Update an existing Servicenow Field",
21787 "title": "Example usage:",
21788 "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",
21792 "name": "updateServicenow_Fields",
21793 "group": "Servicenow_Fields",
21794 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21795 "version": "0.0.0",
21796 "filename": "server/api/intServicenowField/index.js",
21797 "groupTitle": "Servicenow_Fields"
21801 "url": "/api/settings",
21802 "title": "Gets a list of Settings",
21805 "title": "Example usage:",
21806 "content": "curl https://{domain}/api/settings -v -u {name}:{password}",
21810 "name": "GetSettings",
21811 "group": "Settings",
21812 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
21813 "version": "0.0.0",
21814 "filename": "server/api/setting/index.js",
21815 "groupTitle": "Settings"
21819 "url": "/api/settings/{id}",
21820 "title": "Gets a single Setting",
21823 "title": "Example usage:",
21824 "content": "curl https://{domain}/api/settings/{id} -v -u {name}:{password}",
21828 "name": "ShowSettings",
21829 "group": "Settings",
21830 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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}/favicon",
21838 "title": "Add Favicon",
21841 "title": "Example usage:",
21842 "content": "curl https://{domain}/api/settings/{id}/favicon -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
21846 "name": "addFavicon",
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",
21856 "title": "Add logo",
21859 "title": "Example usage:",
21860 "content": "curl https://{domain}/api/settings/{id}/logo -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
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}/logo_login",
21874 "title": "Add logo login",
21877 "title": "Example usage:",
21878 "content": "curl https://{domain}/api/settings/{id}/logo_login -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
21882 "name": "addLogoLogin",
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/{id}/preferred",
21892 "title": "Add Preferred",
21895 "title": "Example usage:",
21896 "content": "curl https://{domain}/api/settings/{id}/preferred -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
21900 "name": "addPreferred",
21901 "group": "Settings",
21902 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</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/now",
21910 "title": "Get Server Current Date",
21913 "title": "Example usage:",
21914 "content": "curl https://{domain}/api/settings/now -v -X GET",
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}/favicon",
21928 "title": "Get Favicon",
21931 "title": "Example usage:",
21932 "content": "curl https://{domain}/api/settings/{id}/favicon -v -X GET",
21936 "name": "getFavicon",
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}/gdpr",
21946 "title": "Get gdpr settings",
21949 "title": "Example usage:",
21950 "content": "curl https://{domain}/api/settings/{id}/gdpr -v -u {name}:{password} -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",
21964 "title": "Get logo",
21967 "title": "Example usage:",
21968 "content": "curl https://{domain}/api/settings/{id}/logo -v -X GET",
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}/logo_login",
21982 "title": "Get logo login",
21985 "title": "Example usage:",
21986 "content": "curl https://{domain}/api/settings/{id}/logo_login -v -X GET",
21990 "name": "getLogoLogin",
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}/preferred",
22000 "title": "Get Preferred",
22003 "title": "Example usage:",
22004 "content": "curl https://{domain}/api/settings/{id}/preferred -v -X GET",
22008 "name": "getPreferred",
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/settings/{id}",
22018 "title": "Update an existing Setting",
22021 "title": "Example usage:",
22022 "content": "curl https://{domain}/api/settings/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
22026 "name": "updateSettings",
22027 "group": "Settings",
22028 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22029 "version": "0.0.0",
22030 "filename": "server/api/setting/index.js",
22031 "groupTitle": "Settings"
22035 "url": "/api/sms/accounts/{id}/users",
22036 "title": "Add agents to a sms account",
22039 "title": "Example usage:",
22040 "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",
22044 "name": "AddAgents",
22045 "group": "Sms_Accounts",
22046 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22047 "version": "0.0.0",
22048 "filename": "server/api/smsAccount/index.js",
22049 "groupTitle": "Sms_Accounts"
22053 "url": "/api/sms/accounts",
22054 "title": "Creates a new Account",
22057 "title": "Example usage:",
22058 "content": "curl https://{domain}/api/sms/accounts -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
22062 "name": "CreateAccounts",
22063 "group": "Sms_Accounts",
22125 "field": "accountSid",
22139 "field": "authToken",
22151 "field": "smsMethod",
22158 "field": "username",
22165 "field": "password",
22179 "field": "applicationId",
22186 "field": "accountId",
22193 "field": "senderString",
22200 "field": "deliveryReport",
22207 "field": "description",
22214 "field": "notificationTemplate",
22221 "field": "notificationSound",
22228 "field": "notificationShake",
22235 "field": "waitForTheAssignedAgent",
22242 "field": "queueTransfer",
22249 "field": "queueTransferTimeout",
22256 "field": "agentTransfer",
22263 "field": "agentTransferTimeout",
22270 "field": "baseUrl",
22277 "field": "mandatoryDispositionPauseId",
22278 "description": "<p>Status to put when mandatory disposition is enabled</p>"
22284 "field": "mandatoryDisposition",
22285 "description": "<p>Enabled/disables mandatory dispo on a queue</p>"
22290 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22291 "version": "0.0.0",
22292 "filename": "server/api/smsAccount/index.js",
22293 "groupTitle": "Sms_Accounts"
22297 "url": "/api/sms/accounts/{id}",
22298 "title": "Deletes a Account",
22301 "title": "Example usage:",
22302 "content": "curl https://{domain}/api/sms/accounts/{id} -v -u {name}:{password} -X DELETE",
22306 "name": "DeleteAccounts",
22307 "group": "Sms_Accounts",
22308 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22309 "version": "0.0.0",
22310 "filename": "server/api/smsAccount/index.js",
22311 "groupTitle": "Sms_Accounts"
22315 "url": "/api/sms/accounts/describe",
22316 "title": "Gets table info about Accounts",
22319 "title": "Example usage:",
22320 "content": "curl https://{domain}/api/sms/accounts/describe -v -u {name}:{password}",
22324 "name": "DescribeAccounts",
22325 "group": "Sms_Accounts",
22326 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22327 "version": "0.0.0",
22328 "filename": "server/api/smsAccount/index.js",
22329 "groupTitle": "Sms_Accounts"
22333 "url": "/api/sms/accounts",
22334 "title": "Gets a list of Accounts",
22337 "title": "Example usage:",
22338 "content": "curl https://{domain}/api/sms/accounts -v -u {name}:{password}",
22342 "name": "GetAccounts",
22343 "group": "Sms_Accounts",
22344 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
22345 "version": "0.0.0",
22346 "filename": "server/api/smsAccount/index.js",
22347 "groupTitle": "Sms_Accounts"
22351 "url": "/api/sms/accounts/{id}/users",
22352 "title": "Gets agents from sms account",
22355 "title": "Example usage:",
22356 "content": "curl https://{domain}/api/sms/accounts/{id}/users -v -u {name}:{password} -X GET",
22360 "name": "GetAgents",
22361 "group": "Sms_Accounts",
22362 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22363 "version": "0.0.0",
22364 "filename": "server/api/smsAccount/index.js",
22365 "groupTitle": "Sms_Accounts"
22369 "url": "/api/sms/accounts/{id}/users",
22370 "title": "Removes agents from a sms account",
22373 "title": "Example usage:",
22374 "content": "curl https://{domain}/api/sms/accounts/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
22378 "name": "RemoveAgents",
22379 "group": "Sms_Accounts",
22380 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22381 "version": "0.0.0",
22382 "filename": "server/api/smsAccount/index.js",
22383 "groupTitle": "Sms_Accounts"
22387 "url": "/api/sms/accounts/{id}/canned_answers",
22388 "title": "Removes canned answers from account",
22391 "title": "Example usage:",
22392 "content": "curl https://{domain}/api/sms/accounts/{id}/canned_answers?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
22396 "name": "RemoveAnswers",
22397 "group": "Sms_Accounts",
22398 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22399 "version": "0.0.0",
22400 "filename": "server/api/smsAccount/index.js",
22401 "groupTitle": "Sms_Accounts"
22405 "url": "/api/sms/accounts/{id}/dispositions",
22406 "title": "Removes dispositions from account",
22409 "title": "Example usage:",
22410 "content": "curl https://{domain}/api/sms/accounts/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
22414 "name": "RemoveDispositions",
22415 "group": "Sms_Accounts",
22416 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22417 "version": "0.0.0",
22418 "filename": "server/api/smsAccount/index.js",
22419 "groupTitle": "Sms_Accounts"
22423 "url": "/api/sms/accounts/{id}",
22424 "title": "Gets a single Account",
22427 "title": "Example usage:",
22428 "content": "curl https://{domain}/api/sms/accounts/{id} -v -u {name}:{password}",
22432 "name": "ShowAccounts",
22433 "group": "Sms_Accounts",
22434 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22435 "version": "0.0.0",
22436 "filename": "server/api/smsAccount/index.js",
22437 "groupTitle": "Sms_Accounts"
22441 "url": "/api/sms/messages/{id}/accept",
22442 "title": "Accepts message",
22445 "title": "Example usage:",
22446 "content": "curl https://{domain}/api/sms/messages/{id}/accept \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
22450 "name": "acceptMessage",
22451 "group": "Sms_Accounts",
22452 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22453 "version": "0.0.0",
22454 "filename": "server/api/smsMessage/index.js",
22455 "groupTitle": "Sms_Accounts"
22459 "url": "/api/sms/accounts/{id}/canned_answers",
22460 "title": "Creates new canned answer",
22463 "title": "Example usage:",
22464 "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",
22468 "name": "addAnswer",
22469 "group": "Sms_Accounts",
22491 "field": "description",
22504 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22505 "version": "0.0.0",
22506 "filename": "server/api/smsAccount/index.js",
22507 "groupTitle": "Sms_Accounts"
22511 "url": "/api/sms/accounts/{id}/applications",
22512 "title": "Creates new applications",
22515 "title": "Example usage:",
22516 "content": "curl https://{domain}/api/sms/accounts/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
22520 "name": "addApplications",
22521 "group": "Sms_Accounts",
22529 "field": "priority",
22543 "field": "appdata",
22550 "field": "description",
22557 "field": "interval",
22563 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22564 "version": "0.0.0",
22565 "filename": "server/api/smsAccount/index.js",
22566 "groupTitle": "Sms_Accounts"
22570 "url": "/api/sms/accounts/{id}/dispositions",
22571 "title": "Creates new disposition",
22574 "title": "Example usage:",
22575 "content": "curl https://{domain}/api/sms/accounts/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
22579 "name": "addDisposition",
22580 "group": "Sms_Accounts",
22607 "field": "description",
22613 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22614 "version": "0.0.0",
22615 "filename": "server/api/smsAccount/index.js",
22616 "groupTitle": "Sms_Accounts"
22620 "url": "/api/sms/accounts/{id}/canned_answers",
22621 "title": "Gets account canned answers",
22624 "title": "Example usage:",
22625 "content": "curl https://{domain}/api/sms/accounts/{id}/canned_answers -v -u {name}:{password} -X GET",
22629 "name": "getAnswers",
22630 "group": "Sms_Accounts",
22631 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22632 "version": "0.0.0",
22633 "filename": "server/api/smsAccount/index.js",
22634 "groupTitle": "Sms_Accounts"
22638 "url": "/api/sms/accounts/{id}/applications",
22639 "title": "Gets account applications",
22642 "title": "Example usage:",
22643 "content": "curl https://{domain}/api/sms/accounts/{id}/applications -v -u {name}:{password} -X GET",
22647 "name": "getApplications",
22648 "group": "Sms_Accounts",
22649 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22650 "version": "0.0.0",
22651 "filename": "server/api/smsAccount/index.js",
22652 "groupTitle": "Sms_Accounts"
22656 "url": "/api/sms/accounts/{id}/dispositions",
22657 "title": "Gets account dispositions",
22660 "title": "Example usage:",
22661 "content": "curl https://{domain}/api/sms/accounts/{id}/dispositions -v -u {name}:{password} -X GET",
22665 "name": "getDispositions",
22666 "group": "Sms_Accounts",
22667 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22668 "version": "0.0.0",
22669 "filename": "server/api/smsAccount/index.js",
22670 "groupTitle": "Sms_Accounts"
22674 "url": "/api/sms/accounts/{id}/interactions",
22675 "title": "Gets Sms Account interactions",
22678 "title": "Example usage:",
22679 "content": "curl https://{domain}/api/sms/accounts/{id}/interactions -v -u {name}:{password} -X GET",
22683 "name": "getInteractions",
22684 "group": "Sms_Accounts",
22685 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22686 "version": "0.0.0",
22687 "filename": "server/api/smsAccount/index.js",
22688 "groupTitle": "Sms_Accounts"
22692 "url": "/api/sms/accounts/{id}/notify",
22693 "title": "Notify new message",
22696 "title": "Example usage:",
22697 "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",
22702 "group": "Sms_Accounts",
22703 "description": "<p>Motion 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>",
22704 "version": "0.0.0",
22705 "filename": "server/api/smsAccount/index.js",
22706 "groupTitle": "Sms_Accounts"
22710 "url": "/api/sms/messages/{id}/reject",
22711 "title": "Rejects message",
22714 "title": "Example usage:",
22715 "content": "curl https://{domain}/api/sms/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
22719 "name": "rejectMessage",
22720 "group": "Sms_Accounts",
22721 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22722 "version": "0.0.0",
22723 "filename": "server/api/smsMessage/index.js",
22724 "groupTitle": "Sms_Accounts"
22728 "url": "/api/sms/accounts/{id}/send",
22729 "title": "Send new sms message",
22732 "title": "Example usage:",
22733 "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",
22738 "group": "Sms_Accounts",
22739 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22740 "version": "0.0.0",
22741 "filename": "server/api/smsAccount/index.js",
22742 "groupTitle": "Sms_Accounts"
22746 "url": "/api/sms/accounts/{id}/status",
22747 "title": "Receive message status as get request",
22750 "title": "Example usage:",
22751 "content": "curl https://{domain}/api/sms/accounts/{id}/status -H 'Content-Type: application/json' -v -X GET",
22755 "name": "statusMessage",
22756 "group": "Sms_Accounts",
22757 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22758 "version": "0.0.0",
22759 "filename": "server/api/smsAccount/index.js",
22760 "groupTitle": "Sms_Accounts"
22764 "url": "/api/sms/messages/{id}/status",
22765 "title": "Receive message status",
22768 "title": "Example usage:",
22769 "content": "curl https://{domain}/api/sms/messages/{id}/status \\ \n -H 'Content-Type: application/json' -v -X POST",
22773 "name": "statusMessage",
22774 "group": "Sms_Accounts",
22775 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22776 "version": "0.0.0",
22777 "filename": "server/api/smsMessage/index.js",
22778 "groupTitle": "Sms_Accounts"
22782 "url": "/api/sms/accounts/{id}/status",
22783 "title": "Receive message status",
22786 "title": "Example usage:",
22787 "content": "curl https://{domain}/api/sms/accounts/{id}/status -H 'Content-Type: application/json' -v -X POST",
22791 "name": "statusMessage",
22792 "group": "Sms_Accounts",
22793 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22794 "version": "0.0.0",
22795 "filename": "server/api/smsAccount/index.js",
22796 "groupTitle": "Sms_Accounts"
22800 "url": "/api/sms/accounts/{id}",
22801 "title": "Update an existing Account",
22804 "title": "Example usage:",
22805 "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",
22809 "name": "updateAccounts",
22810 "group": "Sms_Accounts",
22811 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22812 "version": "0.0.0",
22813 "filename": "server/api/smsAccount/index.js",
22814 "groupTitle": "Sms_Accounts"
22818 "url": "/api/sms/applications",
22819 "title": "Creates a new Application",
22822 "title": "Example usage:",
22823 "content": "curl https://{domain}/api/sms/applications -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
22827 "name": "CreateApplications",
22828 "group": "Sms_Applications",
22836 "field": "priority",
22850 "field": "appdata",
22857 "field": "description",
22864 "field": "interval",
22870 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22871 "version": "0.0.0",
22872 "filename": "server/api/smsApplication/index.js",
22873 "groupTitle": "Sms_Applications"
22877 "url": "/api/sms/applications/{id}",
22878 "title": "Deletes a Application",
22881 "title": "Example usage:",
22882 "content": "curl https://{domain}/api/sms/applications/{id} -v -u {name}:{password} -X DELETE",
22886 "name": "DeleteApplications",
22887 "group": "Sms_Applications",
22888 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22889 "version": "0.0.0",
22890 "filename": "server/api/smsApplication/index.js",
22891 "groupTitle": "Sms_Applications"
22895 "url": "/api/sms/applications",
22896 "title": "Gets a list of Applications",
22899 "title": "Example usage:",
22900 "content": "curl https://{domain}/api/sms/applications -v -u {name}:{password}",
22904 "name": "GetApplications",
22905 "group": "Sms_Applications",
22906 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
22907 "version": "0.0.0",
22908 "filename": "server/api/smsApplication/index.js",
22909 "groupTitle": "Sms_Applications"
22913 "url": "/api/sms/applications/{id}",
22914 "title": "Gets a single Application",
22917 "title": "Example usage:",
22918 "content": "curl https://{domain}/api/sms/applications/{id} -v -u {name}:{password}",
22922 "name": "ShowApplications",
22923 "group": "Sms_Applications",
22924 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22925 "version": "0.0.0",
22926 "filename": "server/api/smsApplication/index.js",
22927 "groupTitle": "Sms_Applications"
22931 "url": "/api/sms/applications/{id}",
22932 "title": "Update an existing Application",
22935 "title": "Example usage:",
22936 "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",
22940 "name": "updateApplications",
22941 "group": "Sms_Applications",
22942 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22943 "version": "0.0.0",
22944 "filename": "server/api/smsApplication/index.js",
22945 "groupTitle": "Sms_Applications"
22949 "url": "/api/sms/interactions/{id}/tags",
22950 "title": "Add tags to the interaction",
22953 "title": "Example usage:",
22954 "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",
22959 "group": "Sms_Interactions",
22960 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22961 "version": "0.0.0",
22962 "filename": "server/api/smsInteraction/index.js",
22963 "groupTitle": "Sms_Interactions"
22967 "url": "/api/sms/interactions",
22968 "title": "Creates a new Interaction",
22971 "title": "Example usage:",
22972 "content": "curl https://{domain}/api/sms/interactions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
22976 "name": "CreateInteractions",
22977 "group": "Sms_Interactions",
22992 "field": "closedAt",
22999 "field": "disposition",
23006 "field": "secondDisposition",
23013 "field": "thirdDisposition",
23034 "field": "read1stAt",
23045 "field": "firstMsgDirection",
23052 "field": "lastMsgAt",
23063 "field": "lastMsgDirection",
23069 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23070 "version": "0.0.0",
23071 "filename": "server/api/smsInteraction/index.js",
23072 "groupTitle": "Sms_Interactions"
23076 "url": "/api/sms/interactions/{id}",
23077 "title": "Deletes a Interaction",
23080 "title": "Example usage:",
23081 "content": "curl https://{domain}/api/sms/interactions/{id} -v -u {name}:{password} -X DELETE",
23085 "name": "DeleteInteractions",
23086 "group": "Sms_Interactions",
23087 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23088 "version": "0.0.0",
23089 "filename": "server/api/smsInteraction/index.js",
23090 "groupTitle": "Sms_Interactions"
23094 "url": "/api/sms/interactions/describe",
23095 "title": "Gets table info about Interactions",
23098 "title": "Example usage:",
23099 "content": "curl https://{domain}/api/sms/interactions/describe -v -u {name}:{password}",
23103 "name": "DescribeInteractions",
23104 "group": "Sms_Interactions",
23105 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23106 "version": "0.0.0",
23107 "filename": "server/api/smsInteraction/index.js",
23108 "groupTitle": "Sms_Interactions"
23112 "url": "/api/sms/interactions",
23113 "title": "Gets a list of Interactions",
23116 "title": "Example usage:",
23117 "content": "curl https://{domain}/api/sms/interactions -v -u {name}:{password}",
23121 "name": "GetInteractions",
23122 "group": "Sms_Interactions",
23123 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
23124 "version": "0.0.0",
23125 "filename": "server/api/smsInteraction/index.js",
23126 "groupTitle": "Sms_Interactions"
23130 "url": "/api/sms/interactions/{id}/tags",
23131 "title": "Removes tags from interaction",
23134 "title": "Example usage:",
23135 "content": "curl https://{domain}/api/sms/interactions/{id}/tags?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
23139 "name": "RemoveTags",
23140 "group": "Sms_Interactions",
23141 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23142 "version": "0.0.0",
23143 "filename": "server/api/smsInteraction/index.js",
23144 "groupTitle": "Sms_Interactions"
23148 "url": "/api/sms/interactions/{id}",
23149 "title": "Gets a single Interaction",
23152 "title": "Example usage:",
23153 "content": "curl https://{domain}/api/sms/interactions/{id} -v -u {name}:{password}",
23157 "name": "ShowInteractions",
23158 "group": "Sms_Interactions",
23159 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23160 "version": "0.0.0",
23161 "filename": "server/api/smsInteraction/index.js",
23162 "groupTitle": "Sms_Interactions"
23166 "url": "/api/sms/interactions/{id}/messages",
23167 "title": "Creates new messages",
23170 "title": "Example usage:",
23171 "content": "curl https://{domain}/api/sms/interactions/{id}/messages -d '[{\"to\": \"+3901119886500\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
23175 "name": "addMessage",
23176 "group": "Sms_Interactions",
23202 "field": "direction",
23209 "field": "messageId",
23237 "field": "providerName",
23244 "field": "providerResponse",
23250 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23251 "version": "0.0.0",
23252 "filename": "server/api/smsInteraction/index.js",
23253 "groupTitle": "Sms_Interactions"
23257 "url": "/api/sms/interactions/{id}/download",
23258 "title": "Gets interaction",
23261 "title": "Example usage:",
23262 "content": "curl https://{domain}/api/sms/interactions/{id}/download -v -u {name}:{password} -X GET",
23266 "name": "download",
23267 "group": "Sms_Interactions",
23268 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23269 "version": "0.0.0",
23270 "filename": "server/api/smsInteraction/index.js",
23271 "groupTitle": "Sms_Interactions"
23275 "url": "/api/sms/interactions/{id}/messages",
23276 "title": "Gets interaction messages",
23279 "title": "Example usage:",
23280 "content": "curl https://{domain}/api/sms/interactions/{id}/messages -v -u {name}:{password} -X GET",
23284 "name": "getMessages",
23285 "group": "Sms_Interactions",
23286 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23287 "version": "0.0.0",
23288 "filename": "server/api/smsInteraction/index.js",
23289 "groupTitle": "Sms_Interactions"
23293 "url": "/api/sms/interactions/{id}",
23294 "title": "Update an existing Interaction",
23297 "title": "Example usage:",
23298 "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",
23302 "name": "updateInteractions",
23303 "group": "Sms_Interactions",
23304 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23305 "version": "0.0.0",
23306 "filename": "server/api/smsInteraction/index.js",
23307 "groupTitle": "Sms_Interactions"
23311 "url": "/api/sms/messages",
23312 "title": "Creates a new Message",
23315 "title": "Example usage:",
23316 "content": "curl https://{domain}/api/sms/messages -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
23320 "name": "CreateMessages",
23321 "group": "Sms_Messages",
23347 "field": "direction",
23354 "field": "messageId",
23382 "field": "providerName",
23389 "field": "providerResponse",
23395 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23396 "version": "0.0.0",
23397 "filename": "server/api/smsMessage/index.js",
23398 "groupTitle": "Sms_Messages"
23402 "url": "/api/sms/messages/{id}",
23403 "title": "Deletes a Message",
23406 "title": "Example usage:",
23407 "content": "curl https://{domain}/api/sms/messages/{id} -v -u {name}:{password} -X DELETE",
23411 "name": "DeleteMessages",
23412 "group": "Sms_Messages",
23413 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23414 "version": "0.0.0",
23415 "filename": "server/api/smsMessage/index.js",
23416 "groupTitle": "Sms_Messages"
23420 "url": "/api/sms/messages/describe",
23421 "title": "Gets table info about Messages",
23424 "title": "Example usage:",
23425 "content": "curl https://{domain}/api/sms/messages/describe -v -u {name}:{password}",
23429 "name": "DescribeMessages",
23430 "group": "Sms_Messages",
23431 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23432 "version": "0.0.0",
23433 "filename": "server/api/smsMessage/index.js",
23434 "groupTitle": "Sms_Messages"
23438 "url": "/api/sms/messages",
23439 "title": "Gets a list of Messages",
23442 "title": "Example usage:",
23443 "content": "curl https://{domain}/api/sms/messages -v -u {name}:{password}",
23447 "name": "GetMessages",
23448 "group": "Sms_Messages",
23449 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
23450 "version": "0.0.0",
23451 "filename": "server/api/smsMessage/index.js",
23452 "groupTitle": "Sms_Messages"
23456 "url": "/api/sms/messages/{id}",
23457 "title": "Gets a single Message",
23460 "title": "Example usage:",
23461 "content": "curl https://{domain}/api/sms/messages/{id} -v -u {name}:{password}",
23465 "name": "ShowMessages",
23466 "group": "Sms_Messages",
23467 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23468 "version": "0.0.0",
23469 "filename": "server/api/smsMessage/index.js",
23470 "groupTitle": "Sms_Messages"
23474 "url": "/api/sms/messages/{id}",
23475 "title": "Update an existing Message",
23478 "title": "Example usage:",
23479 "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",
23483 "name": "updateMessages",
23484 "group": "Sms_Messages",
23485 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23486 "version": "0.0.0",
23487 "filename": "server/api/smsMessage/index.js",
23488 "groupTitle": "Sms_Messages"
23492 "url": "/api/sms/reports/queue",
23493 "title": "Creates a new Sms Queue Report",
23496 "title": "Example usage:",
23497 "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",
23501 "name": "CreateSms_Queue_Reports",
23502 "group": "Sms_Queue_Reports",
23510 "field": "uniqueid",
23531 "field": "leaveAt",
23538 "field": "acceptAt",
23558 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23559 "version": "0.0.0",
23560 "filename": "server/api/smsQueueReport/index.js",
23561 "groupTitle": "Sms_Queue_Reports"
23565 "url": "/api/sms/reports/queue/{id}",
23566 "title": "Deletes a Sms Queue Report",
23569 "title": "Example usage:",
23570 "content": "curl https://{domain}/api/sms/reports/queue/{id} -v -u {name}:{password} -X DELETE",
23574 "name": "DeleteSms_Queue_Reports",
23575 "group": "Sms_Queue_Reports",
23576 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23577 "version": "0.0.0",
23578 "filename": "server/api/smsQueueReport/index.js",
23579 "groupTitle": "Sms_Queue_Reports"
23583 "url": "/api/sms/reports/queue/describe",
23584 "title": "Gets table info about Sms Queue Reports",
23587 "title": "Example usage:",
23588 "content": "curl https://{domain}/api/sms/reports/queue/describe -v -u {name}:{password}",
23592 "name": "DescribeSms_Queue_Reports",
23593 "group": "Sms_Queue_Reports",
23594 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23595 "version": "0.0.0",
23596 "filename": "server/api/smsQueueReport/index.js",
23597 "groupTitle": "Sms_Queue_Reports"
23601 "url": "/api/sms/reports/queue",
23602 "title": "Gets a list of Sms Queue Reports",
23605 "title": "Example usage:",
23606 "content": "curl https://{domain}/api/sms/reports/queue -v -u {name}:{password}",
23610 "name": "GetSms_Queue_Reports",
23611 "group": "Sms_Queue_Reports",
23612 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
23613 "version": "0.0.0",
23614 "filename": "server/api/smsQueueReport/index.js",
23615 "groupTitle": "Sms_Queue_Reports"
23619 "url": "/api/sms/reports/queue/{id}",
23620 "title": "Gets a single Sms Queue Report",
23623 "title": "Example usage:",
23624 "content": "curl https://{domain}/api/sms/reports/queue/{id} -v -u {name}:{password}",
23628 "name": "ShowSms_Queue_Reports",
23629 "group": "Sms_Queue_Reports",
23630 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23631 "version": "0.0.0",
23632 "filename": "server/api/smsQueueReport/index.js",
23633 "groupTitle": "Sms_Queue_Reports"
23637 "url": "/api/sms/reports/queue/{id}",
23638 "title": "Update an existing Sms Queue Report",
23641 "title": "Example usage:",
23642 "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",
23646 "name": "updateSms_Queue_Reports",
23647 "group": "Sms_Queue_Reports",
23648 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23649 "version": "0.0.0",
23650 "filename": "server/api/smsQueueReport/index.js",
23651 "groupTitle": "Sms_Queue_Reports"
23655 "url": "/api/sms/queues/{id}/users",
23656 "title": "Add agents to a queue",
23659 "title": "Example usage:",
23660 "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",
23664 "name": "AddAgents",
23665 "group": "Sms_Queues",
23666 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23667 "version": "0.0.0",
23668 "filename": "server/api/smsQueue/index.js",
23669 "groupTitle": "Sms_Queues"
23673 "url": "/api/sms/queues/{id}/teams",
23674 "title": "Add teams to a queue",
23677 "title": "Example usage:",
23678 "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",
23682 "name": "AddTeams",
23683 "group": "Sms_Queues",
23684 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23685 "version": "0.0.0",
23686 "filename": "server/api/smsQueue/index.js",
23687 "groupTitle": "Sms_Queues"
23691 "url": "/api/sms/queues",
23692 "title": "Creates a new Queue",
23695 "title": "Example usage:",
23696 "content": "curl https://{domain}/api/sms/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
23700 "name": "CreateQueues",
23701 "group": "Sms_Queues",
23716 "field": "description",
23723 "field": "timeout",
23735 "field": "strategy",
23741 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23742 "version": "0.0.0",
23743 "filename": "server/api/smsQueue/index.js",
23744 "groupTitle": "Sms_Queues"
23748 "url": "/api/sms/queues/{id}",
23749 "title": "Deletes a Queue",
23752 "title": "Example usage:",
23753 "content": "curl https://{domain}/api/sms/queues/{id} -v -u {name}:{password} -X DELETE",
23757 "name": "DeleteQueues",
23758 "group": "Sms_Queues",
23759 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23760 "version": "0.0.0",
23761 "filename": "server/api/smsQueue/index.js",
23762 "groupTitle": "Sms_Queues"
23766 "url": "/api/sms/queues/describe",
23767 "title": "Gets table info about Queues",
23770 "title": "Example usage:",
23771 "content": "curl https://{domain}/api/sms/queues/describe -v -u {name}:{password}",
23775 "name": "DescribeQueues",
23776 "group": "Sms_Queues",
23777 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23778 "version": "0.0.0",
23779 "filename": "server/api/smsQueue/index.js",
23780 "groupTitle": "Sms_Queues"
23784 "url": "/api/sms/queues/{id}/users",
23785 "title": "Gets queue agents",
23788 "title": "Example usage:",
23789 "content": "curl https://{domain}/api/sms/queues/{id}/users -v -u {name}:{password} -X POST",
23793 "name": "GetAgents",
23794 "group": "Sms_Queues",
23795 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23796 "version": "0.0.0",
23797 "filename": "server/api/smsQueue/index.js",
23798 "groupTitle": "Sms_Queues"
23802 "url": "/api/sms/queues/{id}/members",
23803 "title": "GetMembers",
23806 "title": "Example usage:",
23807 "content": "curl https://{domain}/api/sms/queues/{id}/members -v -u {name}:{password}",
23811 "name": "GetMembers",
23812 "group": "Sms_Queues",
23813 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23814 "version": "0.0.0",
23815 "filename": "server/api/smsQueue/index.js",
23816 "groupTitle": "Sms_Queues"
23820 "url": "/api/sms/queues",
23821 "title": "Gets a list of Queues",
23824 "title": "Example usage:",
23825 "content": "curl https://{domain}/api/sms/queues -v -u {name}:{password}",
23829 "name": "GetQueues",
23830 "group": "Sms_Queues",
23831 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
23832 "version": "0.0.0",
23833 "filename": "server/api/smsQueue/index.js",
23834 "groupTitle": "Sms_Queues"
23838 "url": "/api/sms/queues/{id}/teams",
23839 "title": "Gets queues list",
23842 "title": "Example usage:",
23843 "content": "curl https://{domain}/api/sms/queues/{id}/teams -v -u {name}:{password}",
23847 "name": "GetTeams",
23848 "group": "Sms_Queues",
23849 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23850 "version": "0.0.0",
23851 "filename": "server/api/smsQueue/index.js",
23852 "groupTitle": "Sms_Queues"
23856 "url": "/api/sms/queues/{id}/users",
23857 "title": "Removes agents from a queue",
23860 "title": "Example usage:",
23861 "content": "curl https://{domain}/api/sms/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
23865 "name": "RemoveAgents",
23866 "group": "Sms_Queues",
23867 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23868 "version": "0.0.0",
23869 "filename": "server/api/smsQueue/index.js",
23870 "groupTitle": "Sms_Queues"
23874 "url": "/api/sms/queues/{id}",
23875 "title": "Gets a single Queue",
23878 "title": "Example usage:",
23879 "content": "curl https://{domain}/api/sms/queues/{id} -v -u {name}:{password}",
23883 "name": "ShowQueues",
23884 "group": "Sms_Queues",
23885 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23886 "version": "0.0.0",
23887 "filename": "server/api/smsQueue/index.js",
23888 "groupTitle": "Sms_Queues"
23892 "url": "/api/sms/queues/{id}",
23893 "title": "Update an existing Queue",
23896 "title": "Example usage:",
23897 "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",
23901 "name": "updateQueues",
23902 "group": "Sms_Queues",
23903 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23904 "version": "0.0.0",
23905 "filename": "server/api/smsQueue/index.js",
23906 "groupTitle": "Sms_Queues"
23910 "url": "/api/sms/reports/transfer",
23911 "title": "Creates a new Sms Transfer Report",
23914 "title": "Example usage:",
23915 "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",
23919 "name": "CreateSms_Transfer_Reports",
23920 "group": "Sms_Transfer_Reports",
23928 "field": "uniqueid",
23947 "field": "transferredAt",
23953 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23954 "version": "0.0.0",
23955 "filename": "server/api/smsTransferReport/index.js",
23956 "groupTitle": "Sms_Transfer_Reports"
23960 "url": "/api/sms/reports/transfer/{id}",
23961 "title": "Deletes a Sms Transfer Report",
23964 "title": "Example usage:",
23965 "content": "curl https://{domain}/api/sms/reports/transfer/{id} -v -u {name}:{password} -X DELETE",
23969 "name": "DeleteSms_Transfer_Reports",
23970 "group": "Sms_Transfer_Reports",
23971 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23972 "version": "0.0.0",
23973 "filename": "server/api/smsTransferReport/index.js",
23974 "groupTitle": "Sms_Transfer_Reports"
23978 "url": "/api/sms/reports/transfer/describe",
23979 "title": "Gets table info about Sms Transfer Reports",
23982 "title": "Example usage:",
23983 "content": "curl https://{domain}/api/sms/reports/transfer/describe -v -u {name}:{password}",
23987 "name": "DescribeSms_Transfer_Reports",
23988 "group": "Sms_Transfer_Reports",
23989 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23990 "version": "0.0.0",
23991 "filename": "server/api/smsTransferReport/index.js",
23992 "groupTitle": "Sms_Transfer_Reports"
23996 "url": "/api/sms/reports/transfer",
23997 "title": "Gets a list of Sms Transfer Reports",
24000 "title": "Example usage:",
24001 "content": "curl https://{domain}/api/sms/reports/transfer -v -u {name}:{password}",
24005 "name": "GetSms_Transfer_Reports",
24006 "group": "Sms_Transfer_Reports",
24007 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
24008 "version": "0.0.0",
24009 "filename": "server/api/smsTransferReport/index.js",
24010 "groupTitle": "Sms_Transfer_Reports"
24014 "url": "/api/sms/reports/transfer/{id}",
24015 "title": "Gets a single Sms Transfer Report",
24018 "title": "Example usage:",
24019 "content": "curl https://{domain}/api/sms/reports/transfer/{id} -v -u {name}:{password}",
24023 "name": "ShowSms_Transfer_Reports",
24024 "group": "Sms_Transfer_Reports",
24025 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24026 "version": "0.0.0",
24027 "filename": "server/api/smsTransferReport/index.js",
24028 "groupTitle": "Sms_Transfer_Reports"
24032 "url": "/api/sms/reports/transfer/{id}",
24033 "title": "Update an existing Sms Transfer Report",
24036 "title": "Example usage:",
24037 "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",
24041 "name": "updateSms_Transfer_Reports",
24042 "group": "Sms_Transfer_Reports",
24043 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24044 "version": "0.0.0",
24045 "filename": "server/api/smsTransferReport/index.js",
24046 "groupTitle": "Sms_Transfer_Reports"
24050 "url": "/api/sounds",
24051 "title": "Gets a list of Sounds",
24054 "title": "Example usage:",
24055 "content": "curl https://{domain}/api/sounds -v -u {name}:{password}",
24059 "name": "GetSounds",
24061 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
24062 "version": "0.0.0",
24063 "filename": "server/api/sound/index.js",
24064 "groupTitle": "Sounds"
24068 "url": "/api/sounds/{id}",
24069 "title": "Gets a single Sound",
24072 "title": "Example usage:",
24073 "content": "curl https://{domain}/api/sounds/{id} -v -u {name}:{password}",
24077 "name": "ShowSounds",
24079 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24080 "version": "0.0.0",
24081 "filename": "server/api/sound/index.js",
24082 "groupTitle": "Sounds"
24086 "url": "/api/sounds",
24087 "title": "Create a new sound",
24090 "title": "Example usage:",
24091 "content": "curl https://{domain}/api/sounds -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
24095 "name": "addSound",
24097 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24098 "version": "0.0.0",
24099 "filename": "server/api/sound/index.js",
24100 "groupTitle": "Sounds"
24104 "url": "/api/sounds/{id}",
24105 "title": "Deletes a sound",
24108 "title": "Example usage:",
24109 "content": "curl https://{domain}/api/sounds/{id} -v -u {name}:{password} -X DELETE",
24113 "name": "destroySound",
24115 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24116 "version": "0.0.0",
24117 "filename": "server/api/sound/index.js",
24118 "groupTitle": "Sounds"
24122 "url": "/api/sounds/{id}/download",
24123 "title": "Download Sound",
24126 "title": "Example usage:",
24127 "content": "curl https://{domain}/api/sounds/{id}/download -v -u {name}:{password} -X GET",
24131 "name": "download",
24133 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24134 "version": "0.0.0",
24135 "filename": "server/api/sound/index.js",
24136 "groupTitle": "Sounds"
24140 "url": "/api/sounds",
24141 "title": "Update an existing new sound",
24144 "title": "Example usage:",
24145 "content": "curl https://{domain}/api/sounds -d '[\"name\": \"sound_name\", \"description\": \"sound_desc\"]' -v -u {name}:{password} -X PUT",
24149 "name": "updateSound",
24151 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24152 "version": "0.0.0",
24153 "filename": "server/api/sound/index.js",
24154 "groupTitle": "Sounds"
24158 "url": "/api/square/details/reports",
24159 "title": "Creates a new Square Detail Report",
24162 "title": "Example usage:",
24163 "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",
24167 "name": "CreateSquare_Detail_Reports",
24168 "group": "Square_Details_Reports",
24176 "field": "uniqueid",
24190 "field": "application",
24204 "field": "project_name",
24211 "field": "callerid",
24217 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24218 "version": "0.0.0",
24219 "filename": "server/api/squareReportDetail/index.js",
24220 "groupTitle": "Square_Details_Reports"
24224 "url": "/api/square/details/reports/{id}",
24225 "title": "Deletes a Square Detail Report",
24228 "title": "Example usage:",
24229 "content": "curl https://{domain}/api/square/details/reports/{id} -v -u {name}:{password} -X DELETE",
24233 "name": "DeleteSquare_Detail_Reports",
24234 "group": "Square_Details_Reports",
24235 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24236 "version": "0.0.0",
24237 "filename": "server/api/squareReportDetail/index.js",
24238 "groupTitle": "Square_Details_Reports"
24242 "url": "/api/square/details/reports/describe",
24243 "title": "Gets table info about Square Detail Reports",
24246 "title": "Example usage:",
24247 "content": "curl https://{domain}/api/square/details/reports/describe -v -u {name}:{password}",
24251 "name": "DescribeSquare_Detail_Reports",
24252 "group": "Square_Details_Reports",
24253 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24254 "version": "0.0.0",
24255 "filename": "server/api/squareReportDetail/index.js",
24256 "groupTitle": "Square_Details_Reports"
24260 "url": "/api/square/details/reports",
24261 "title": "Gets a list of Square Detail Reports",
24264 "title": "Example usage:",
24265 "content": "curl https://{domain}/api/square/details/reports -v -u {name}:{password}",
24269 "name": "GetSquare_Detail_Reports",
24270 "group": "Square_Details_Reports",
24271 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
24272 "version": "0.0.0",
24273 "filename": "server/api/squareReportDetail/index.js",
24274 "groupTitle": "Square_Details_Reports"
24278 "url": "/api/square/details/reports/{id}",
24279 "title": "Gets a single Square Detail Report",
24282 "title": "Example usage:",
24283 "content": "curl https://{domain}/api/square/details/reports/{id} -v -u {name}:{password}",
24287 "name": "ShowSquare_Detail_Reports",
24288 "group": "Square_Details_Reports",
24289 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24290 "version": "0.0.0",
24291 "filename": "server/api/squareReportDetail/index.js",
24292 "groupTitle": "Square_Details_Reports"
24296 "url": "/api/square/details/reports/{id}",
24297 "title": "Update an existing Square Detail Report",
24300 "title": "Example usage:",
24301 "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",
24305 "name": "updateSquare_Detail_Reports",
24306 "group": "Square_Details_Reports",
24307 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24308 "version": "0.0.0",
24309 "filename": "server/api/squareReportDetail/index.js",
24310 "groupTitle": "Square_Details_Reports"
24314 "url": "/api/square/messages",
24315 "title": "Creates a new Message",
24318 "title": "Example usage:",
24319 "content": "curl https://{domain}/api/square/messages -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
24323 "name": "CreateMessages",
24324 "group": "Square_Messages",
24332 "field": "uniqueid",
24350 "field": "direction",
24357 "field": "providerName",
24364 "field": "providerResponse",
24370 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24371 "version": "0.0.0",
24372 "filename": "server/api/squareMessage/index.js",
24373 "groupTitle": "Square_Messages"
24377 "url": "/api/square/messages/{id}",
24378 "title": "Deletes a Message",
24381 "title": "Example usage:",
24382 "content": "curl https://{domain}/api/square/messages/{id} -v -u {name}:{password} -X DELETE",
24386 "name": "DeleteMessages",
24387 "group": "Square_Messages",
24388 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24389 "version": "0.0.0",
24390 "filename": "server/api/squareMessage/index.js",
24391 "groupTitle": "Square_Messages"
24395 "url": "/api/square/messages",
24396 "title": "Gets a list of Messages",
24399 "title": "Example usage:",
24400 "content": "curl https://{domain}/api/square/messages -v -u {name}:{password}",
24404 "name": "GetMessages",
24405 "group": "Square_Messages",
24406 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
24407 "version": "0.0.0",
24408 "filename": "server/api/squareMessage/index.js",
24409 "groupTitle": "Square_Messages"
24413 "url": "/api/square/messages/{id}",
24414 "title": "Gets a single Message",
24417 "title": "Example usage:",
24418 "content": "curl https://{domain}/api/square/messages/{id} -v -u {name}:{password}",
24422 "name": "ShowMessages",
24423 "group": "Square_Messages",
24424 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24425 "version": "0.0.0",
24426 "filename": "server/api/squareMessage/index.js",
24427 "groupTitle": "Square_Messages"
24431 "url": "/api/square/messages/{id}",
24432 "title": "Update an existing Message",
24435 "title": "Example usage:",
24436 "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",
24440 "name": "updateMessages",
24441 "group": "Square_Messages",
24442 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24443 "version": "0.0.0",
24444 "filename": "server/api/squareMessage/index.js",
24445 "groupTitle": "Square_Messages"
24449 "url": "/api/square/odbc",
24450 "title": "Creates a new ODBC",
24453 "title": "Example usage:",
24454 "content": "curl https://{domain}/api/square/odbc -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
24458 "name": "CreateODBCs",
24459 "group": "Square_ODBC",
24481 "field": "description",
24487 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24488 "version": "0.0.0",
24489 "filename": "server/api/squareOdbc/index.js",
24490 "groupTitle": "Square_ODBC"
24494 "url": "/api/square/odbc/{id}",
24495 "title": "Deletes a ODBC",
24498 "title": "Example usage:",
24499 "content": "curl https://{domain}/api/square/odbc/{id} -v -u {name}:{password} -X DELETE",
24503 "name": "DeleteODBCs",
24504 "group": "Square_ODBC",
24505 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24506 "version": "0.0.0",
24507 "filename": "server/api/squareOdbc/index.js",
24508 "groupTitle": "Square_ODBC"
24512 "url": "/api/square/odbc",
24513 "title": "Gets a list of ODBCs",
24516 "title": "Example usage:",
24517 "content": "curl https://{domain}/api/square/odbc -v -u {name}:{password}",
24521 "name": "GetODBCs",
24522 "group": "Square_ODBC",
24523 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
24524 "version": "0.0.0",
24525 "filename": "server/api/squareOdbc/index.js",
24526 "groupTitle": "Square_ODBC"
24530 "url": "/api/square/odbc/{id}",
24531 "title": "Gets a single ODBC",
24534 "title": "Example usage:",
24535 "content": "curl https://{domain}/api/square/odbc/{id} -v -u {name}:{password}",
24539 "name": "ShowODBCs",
24540 "group": "Square_ODBC",
24541 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24542 "version": "0.0.0",
24543 "filename": "server/api/squareOdbc/index.js",
24544 "groupTitle": "Square_ODBC"
24548 "url": "/api/square/odbc/{id}/test",
24549 "title": "Test Odbc",
24552 "title": "Example usage:",
24553 "content": "curl https://{domain}/api/square/odbc/{id}/test -v -u {name}:{password} -X GET",
24558 "group": "Square_ODBC",
24559 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24560 "version": "0.0.0",
24561 "filename": "server/api/squareOdbc/index.js",
24562 "groupTitle": "Square_ODBC"
24566 "url": "/api/square/odbc/{id}",
24567 "title": "Update an existing ODBC",
24570 "title": "Example usage:",
24571 "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",
24575 "name": "updateODBCs",
24576 "group": "Square_ODBC",
24577 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24578 "version": "0.0.0",
24579 "filename": "server/api/squareOdbc/index.js",
24580 "groupTitle": "Square_ODBC"
24584 "url": "/api/square/projects",
24585 "title": "Creates a new Project",
24588 "title": "Example usage:",
24589 "content": "curl https://{domain}/api/square/projects -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
24593 "name": "CreateProjects",
24594 "group": "Square_Projects",
24609 "field": "description",
24623 "field": "preproduction",
24630 "field": "production",
24637 "field": "savedAt",
24644 "field": "publishedAt",
24650 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24651 "version": "0.0.0",
24652 "filename": "server/api/squareProject/index.js",
24653 "groupTitle": "Square_Projects"
24657 "url": "/api/square/projects/{id}",
24658 "title": "Deletes a Project",
24661 "title": "Example usage:",
24662 "content": "curl https://{domain}/api/square/projects/{id} -v -u {name}:{password} -X DELETE",
24666 "name": "DeleteProjects",
24667 "group": "Square_Projects",
24668 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24669 "version": "0.0.0",
24670 "filename": "server/api/squareProject/index.js",
24671 "groupTitle": "Square_Projects"
24675 "url": "/api/square/projects",
24676 "title": "Gets a list of Projects",
24679 "title": "Example usage:",
24680 "content": "curl https://{domain}/api/square/projects -v -u {name}:{password}",
24684 "name": "GetProjects",
24685 "group": "Square_Projects",
24686 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
24687 "version": "0.0.0",
24688 "filename": "server/api/squareProject/index.js",
24689 "groupTitle": "Square_Projects"
24693 "url": "/api/square/projects/{id}",
24694 "title": "Gets a single Project",
24697 "title": "Example usage:",
24698 "content": "curl https://{domain}/api/square/projects/{id} -v -u {name}:{password}",
24702 "name": "ShowProjects",
24703 "group": "Square_Projects",
24704 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24705 "version": "0.0.0",
24706 "filename": "server/api/squareProject/index.js",
24707 "groupTitle": "Square_Projects"
24711 "url": "/api/square/projects/{id}/users",
24712 "title": "Adds user permissions to a Project",
24715 "title": "Example usage:",
24716 "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",
24720 "name": "addUsers",
24721 "group": "Square_Projects",
24722 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24723 "version": "0.0.0",
24724 "filename": "server/api/squareProject/index.js",
24725 "groupTitle": "Square_Projects"
24729 "url": "/api/square/projects/{id}/users",
24730 "title": "Gets users permissions from Project",
24733 "title": "Example usage:",
24734 "content": "curl https://{domain}/api/square/projects/{id}/users -v -u {name}:{password} -X GET",
24738 "name": "getUsers",
24739 "group": "Square_Projects",
24740 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24741 "version": "0.0.0",
24742 "filename": "server/api/squareProject/index.js",
24743 "groupTitle": "Square_Projects"
24747 "url": "/api/square/projects/{id}/users",
24748 "title": "Removes user permissions from a Project",
24751 "title": "Example usage:",
24752 "content": "curl https://{domain}/api/square/projects/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
24756 "name": "removeUsers",
24757 "group": "Square_Projects",
24758 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24759 "version": "0.0.0",
24760 "filename": "server/api/squareProject/index.js",
24761 "groupTitle": "Square_Projects"
24765 "url": "/api/square/projects/{id}",
24766 "title": "Update an existing Project",
24769 "title": "Example usage:",
24770 "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",
24774 "name": "updateProjects",
24775 "group": "Square_Projects",
24776 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24777 "version": "0.0.0",
24778 "filename": "server/api/squareProject/index.js",
24779 "groupTitle": "Square_Projects"
24783 "url": "/api/square/recordings",
24784 "title": "Creates a new Recording",
24787 "title": "Example usage:",
24788 "content": "curl https://{domain}/api/square/recordings -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
24792 "name": "CreateRecordings",
24793 "group": "Square_Recordings",
24801 "field": "uniqueid",
24808 "field": "callerid",
24815 "field": "calleridname",
24822 "field": "context",
24829 "field": "extension",
24836 "field": "priority",
24843 "field": "accountcode",
24857 "field": "projectName",
24864 "field": "saveName",
24871 "field": "filename",
24878 "field": "savePath",
24891 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24892 "version": "0.0.0",
24893 "filename": "server/api/squareRecording/index.js",
24894 "groupTitle": "Square_Recordings"
24898 "url": "/api/square/recordings",
24899 "title": "Gets a list of Recordings",
24902 "title": "Example usage:",
24903 "content": "curl https://{domain}/api/square/recordings -v -u {name}:{password}",
24907 "name": "GetRecordings",
24908 "group": "Square_Recordings",
24909 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
24910 "version": "0.0.0",
24911 "filename": "server/api/squareRecording/index.js",
24912 "groupTitle": "Square_Recordings"
24916 "url": "/api/square/recordings/{id}",
24917 "title": "Gets a single Recording",
24920 "title": "Example usage:",
24921 "content": "curl https://{domain}/api/square/recordings/{id} -v -u {name}:{password}",
24925 "name": "ShowRecordings",
24926 "group": "Square_Recordings",
24927 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24928 "version": "0.0.0",
24929 "filename": "server/api/squareRecording/index.js",
24930 "groupTitle": "Square_Recordings"
24934 "url": "/api/square/recordings/{id}/delete",
24935 "title": "Delete recording",
24938 "title": "Example usage:",
24939 "content": "curl https://{domain}/api/square/recordings/{id}/delete -v -u {name}:{password} -X DELETE",
24944 "group": "Square_Recordings",
24945 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24946 "version": "0.0.0",
24947 "filename": "server/api/squareRecording/index.js",
24948 "groupTitle": "Square_Recordings"
24952 "url": "/api/square/recordings/{id}/download",
24953 "title": "Download Recording",
24956 "title": "Example usage:",
24957 "content": "curl https://{domain}/api/square/recordings/{id}/download -v -u {name}:{password} -X GET",
24961 "name": "download",
24962 "group": "Square_Recordings",
24963 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24964 "version": "0.0.0",
24965 "filename": "server/api/squareRecording/index.js",
24966 "groupTitle": "Square_Recordings"
24970 "url": "/api/square/recordings/{id}",
24971 "title": "Update an existing Recording",
24974 "title": "Example usage:",
24975 "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",
24979 "name": "updateRecordings",
24980 "group": "Square_Recordings",
24981 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24982 "version": "0.0.0",
24983 "filename": "server/api/squareRecording/index.js",
24984 "groupTitle": "Square_Recordings"
24988 "url": "/api/square/reports",
24989 "title": "Creates a new Square Report",
24992 "title": "Example usage:",
24993 "content": "curl https://{domain}/api/square/reports -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
24997 "name": "CreateSquare_Reports",
24998 "group": "Square_Reports",
25006 "field": "network",
25013 "field": "network_script",
25020 "field": "request",
25027 "field": "channel",
25034 "field": "language",
25048 "field": "uniqueid",
25055 "field": "version",
25062 "field": "callerid",
25069 "field": "calleridname",
25076 "field": "callingpres",
25083 "field": "callingani2",
25090 "field": "callington",
25097 "field": "callingtns",
25118 "field": "context",
25125 "field": "extension",
25132 "field": "priority",
25139 "field": "enhanced",
25146 "field": "accountcode",
25153 "field": "threadid",
25160 "field": "project_name",
25174 "field": "leaveAt",
25187 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25188 "version": "0.0.0",
25189 "filename": "server/api/squareReport/index.js",
25190 "groupTitle": "Square_Reports"
25194 "url": "/api/square/reports/{id}",
25195 "title": "Deletes a Square Report",
25198 "title": "Example usage:",
25199 "content": "curl https://{domain}/api/square/reports/{id} -v -u {name}:{password} -X DELETE",
25203 "name": "DeleteSquare_Reports",
25204 "group": "Square_Reports",
25205 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25206 "version": "0.0.0",
25207 "filename": "server/api/squareReport/index.js",
25208 "groupTitle": "Square_Reports"
25212 "url": "/api/square/reports/describe",
25213 "title": "Gets table info about Square Reports",
25216 "title": "Example usage:",
25217 "content": "curl https://{domain}/api/square/reports/describe -v -u {name}:{password}",
25221 "name": "DescribeSquare_Reports",
25222 "group": "Square_Reports",
25223 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25224 "version": "0.0.0",
25225 "filename": "server/api/squareReport/index.js",
25226 "groupTitle": "Square_Reports"
25230 "url": "/api/square/reports",
25231 "title": "Gets a list of Square Reports",
25234 "title": "Example usage:",
25235 "content": "curl https://{domain}/api/square/reports -v -u {name}:{password}",
25239 "name": "GetSquare_Reports",
25240 "group": "Square_Reports",
25241 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
25242 "version": "0.0.0",
25243 "filename": "server/api/squareReport/index.js",
25244 "groupTitle": "Square_Reports"
25248 "url": "/api/square/reports/{id}",
25249 "title": "Gets a single Square Report",
25252 "title": "Example usage:",
25253 "content": "curl https://{domain}/api/square/reports/{id} -v -u {name}:{password}",
25257 "name": "ShowSquare_Reports",
25258 "group": "Square_Reports",
25259 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25260 "version": "0.0.0",
25261 "filename": "server/api/squareReport/index.js",
25262 "groupTitle": "Square_Reports"
25266 "url": "/api/square/reports/{id}",
25267 "title": "Update an existing Square Report",
25270 "title": "Example usage:",
25271 "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",
25275 "name": "updateSquare_Reports",
25276 "group": "Square_Reports",
25277 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25278 "version": "0.0.0",
25279 "filename": "server/api/squareReport/index.js",
25280 "groupTitle": "Square_Reports"
25284 "url": "/api/integrations/sugarcrm/configurations",
25285 "title": "Creates a new SugarCRM Configuration",
25288 "title": "Example usage:",
25289 "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",
25293 "name": "CreateSugarCRM_Configurations",
25294 "group": "SugarCRM_Configurations",
25309 "field": "description",
25315 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25316 "version": "0.0.0",
25317 "filename": "server/api/intSugarcrmConfiguration/index.js",
25318 "groupTitle": "SugarCRM_Configurations"
25322 "url": "/api/integrations/sugarcrm/configurations/{id}",
25323 "title": "Deletes a SugarCRM Configuration",
25326 "title": "Example usage:",
25327 "content": "curl https://{domain}/api/integrations/sugarcrm/configurations/{id} -v -u {name}:{password} -X DELETE",
25331 "name": "DeleteSugarCRM_Configurations",
25332 "group": "SugarCRM_Configurations",
25333 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25334 "version": "0.0.0",
25335 "filename": "server/api/intSugarcrmConfiguration/index.js",
25336 "groupTitle": "SugarCRM_Configurations"
25340 "url": "/api/integrations/sugarcrm/configurations",
25341 "title": "Gets a list of SugarCRM Configurations",
25344 "title": "Example usage:",
25345 "content": "curl https://{domain}/api/integrations/sugarcrm/configurations -v -u {name}:{password}",
25349 "name": "GetSugarCRM_Configurations",
25350 "group": "SugarCRM_Configurations",
25351 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
25352 "version": "0.0.0",
25353 "filename": "server/api/intSugarcrmConfiguration/index.js",
25354 "groupTitle": "SugarCRM_Configurations"
25358 "url": "/api/integrations/sugarcrm/configurations/{id}",
25359 "title": "Gets a single SugarCRM Configuration",
25362 "title": "Example usage:",
25363 "content": "curl https://{domain}/api/integrations/sugarcrm/configurations/{id} -v -u {name}:{password}",
25367 "name": "ShowSugarCRM_Configurations",
25368 "group": "SugarCRM_Configurations",
25369 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25370 "version": "0.0.0",
25371 "filename": "server/api/intSugarcrmConfiguration/index.js",
25372 "groupTitle": "SugarCRM_Configurations"
25376 "url": "/api/integrations/sugarcrm/configurations/{id}",
25377 "title": "Update an existing SugarCRM Configuration",
25380 "title": "Example usage:",
25381 "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",
25385 "name": "updateSugarCRM_Configurations",
25386 "group": "SugarCRM_Configurations",
25387 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25388 "version": "0.0.0",
25389 "filename": "server/api/intSugarcrmConfiguration/index.js",
25390 "groupTitle": "SugarCRM_Configurations"
25394 "url": "/api/integrations/sugarcrm/accounts",
25395 "title": "Creates a new Sugarcrm Account",
25398 "title": "Example usage:",
25399 "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",
25403 "name": "CreateSugarcrm_Accounts",
25404 "group": "Sugarcrm_Accounts",
25419 "field": "description",
25426 "field": "username",
25433 "field": "password",
25440 "field": "remoteUri",
25447 "field": "serverUrl",
25453 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25454 "version": "0.0.0",
25455 "filename": "server/api/intSugarcrmAccount/index.js",
25456 "groupTitle": "Sugarcrm_Accounts"
25460 "url": "/api/integrations/sugarcrm/accounts/{id}",
25461 "title": "Deletes a Sugarcrm Account",
25464 "title": "Example usage:",
25465 "content": "curl https://{domain}/api/integrations/sugarcrm/accounts/{id} -v -u {name}:{password} -X DELETE",
25469 "name": "DeleteSugarcrm_Accounts",
25470 "group": "Sugarcrm_Accounts",
25471 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25472 "version": "0.0.0",
25473 "filename": "server/api/intSugarcrmAccount/index.js",
25474 "groupTitle": "Sugarcrm_Accounts"
25478 "url": "/api/integrations/sugarcrm/accounts",
25479 "title": "Gets a list of Sugarcrm Accounts",
25482 "title": "Example usage:",
25483 "content": "curl https://{domain}/api/integrations/sugarcrm/accounts -v -u {name}:{password}",
25487 "name": "GetSugarcrm_Accounts",
25488 "group": "Sugarcrm_Accounts",
25489 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
25490 "version": "0.0.0",
25491 "filename": "server/api/intSugarcrmAccount/index.js",
25492 "groupTitle": "Sugarcrm_Accounts"
25496 "url": "/api/integrations/sugarcrm/accounts/{id}",
25497 "title": "Gets a single Sugarcrm Account",
25500 "title": "Example usage:",
25501 "content": "curl https://{domain}/api/integrations/sugarcrm/accounts/{id} -v -u {name}:{password}",
25505 "name": "ShowSugarcrm_Accounts",
25506 "group": "Sugarcrm_Accounts",
25507 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25508 "version": "0.0.0",
25509 "filename": "server/api/intSugarcrmAccount/index.js",
25510 "groupTitle": "Sugarcrm_Accounts"
25514 "url": "/api/integrations/sugarcrm/accounts/{id}/configurations",
25515 "title": "Creates new configuration",
25518 "title": "Example usage:",
25519 "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",
25523 "name": "addConfiguration",
25524 "group": "Sugarcrm_Accounts",
25525 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25526 "version": "0.0.0",
25527 "filename": "server/api/intSugarcrmAccount/index.js",
25528 "groupTitle": "Sugarcrm_Accounts"
25532 "url": "/api/integrations/sugarcrm/accounts/{id}/configurations",
25533 "title": "Gets account configurations",
25536 "title": "Example usage:",
25537 "content": "curl https://{domain}/api/integrations/sugarcrm/accounts/{id}/configurations -v -u {name}:{password} -X GET",
25541 "name": "getConfigurations",
25542 "group": "Sugarcrm_Accounts",
25543 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25544 "version": "0.0.0",
25545 "filename": "server/api/intSugarcrmAccount/index.js",
25546 "groupTitle": "Sugarcrm_Accounts"
25550 "url": "/api/integrations/sugarcrm/accounts/{id}/fields",
25551 "title": "Gets account fields",
25554 "title": "Example usage:",
25555 "content": "curl https://{domain}/api/integrations/sugarcrm/accounts/{id}/fields -v -u {name}:{password} -X GET",
25559 "name": "getFields",
25560 "group": "Sugarcrm_Accounts",
25561 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25562 "version": "0.0.0",
25563 "filename": "server/api/intSugarcrmAccount/index.js",
25564 "groupTitle": "Sugarcrm_Accounts"
25568 "url": "/api/integrations/sugarcrm/accounts/{id}",
25569 "title": "Update an existing Sugarcrm Account",
25572 "title": "Example usage:",
25573 "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",
25577 "name": "updateSugarcrm_Accounts",
25578 "group": "Sugarcrm_Accounts",
25579 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25580 "version": "0.0.0",
25581 "filename": "server/api/intSugarcrmAccount/index.js",
25582 "groupTitle": "Sugarcrm_Accounts"
25586 "url": "/api/integrations/sugarcrm/configurations/{id}/descriptions",
25587 "title": "Gets configurations descriptions",
25590 "title": "Example usage:",
25591 "content": "curl https://{domain}/api/integrations/sugarcrm/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
25595 "name": "getDescriptions",
25596 "group": "Sugarcrm_Configurations",
25597 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25598 "version": "0.0.0",
25599 "filename": "server/api/intSugarcrmConfiguration/index.js",
25600 "groupTitle": "Sugarcrm_Configurations"
25604 "url": "/api/integrations/sugarcrm/configurations/{id}/fields",
25605 "title": "Gets configurations fields",
25608 "title": "Example usage:",
25609 "content": "curl https://{domain}/api/integrations/sugarcrm/configurations/{id}/fields -v -u {name}:{password} -X GET",
25613 "name": "getFields",
25614 "group": "Sugarcrm_Configurations",
25615 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25616 "version": "0.0.0",
25617 "filename": "server/api/intSugarcrmConfiguration/index.js",
25618 "groupTitle": "Sugarcrm_Configurations"
25622 "url": "/api/integrations/sugarcrm/configurations/{id}/subjects",
25623 "title": "Gets configurations subjects",
25626 "title": "Example usage:",
25627 "content": "curl https://{domain}/api/integrations/sugarcrm/configurations/{id}/subjects -v -u {name}:{password} -X GET",
25631 "name": "getSubjects",
25632 "group": "Sugarcrm_Configurations",
25633 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25634 "version": "0.0.0",
25635 "filename": "server/api/intSugarcrmConfiguration/index.js",
25636 "groupTitle": "Sugarcrm_Configurations"
25640 "url": "/api/integrations/sugarcrm/fields",
25641 "title": "Creates a new Sugarcrm Field",
25644 "title": "Example usage:",
25645 "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",
25649 "name": "CreateSugarcrm_Fields",
25650 "group": "Sugarcrm_Fields",
25660 "\"customVariable\"",
25671 "field": "content",
25687 "\"customVariable\""
25690 "field": "keyType",
25697 "field": "keyContent",
25704 "field": "idField",
25711 "field": "nameField",
25718 "field": "customField",
25725 "field": "variableName",
25731 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25732 "version": "0.0.0",
25733 "filename": "server/api/intSugarcrmField/index.js",
25734 "groupTitle": "Sugarcrm_Fields"
25738 "url": "/api/integrations/sugarcrm/fields/{id}",
25739 "title": "Deletes a Sugarcrm Field",
25742 "title": "Example usage:",
25743 "content": "curl https://{domain}/api/integrations/sugarcrm/fields/{id} -v -u {name}:{password} -X DELETE",
25747 "name": "DeleteSugarcrm_Fields",
25748 "group": "Sugarcrm_Fields",
25749 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25750 "version": "0.0.0",
25751 "filename": "server/api/intSugarcrmField/index.js",
25752 "groupTitle": "Sugarcrm_Fields"
25756 "url": "/api/integrations/sugarcrm/fields",
25757 "title": "Gets a list of Sugarcrm Fields",
25760 "title": "Example usage:",
25761 "content": "curl https://{domain}/api/integrations/sugarcrm/fields -v -u {name}:{password}",
25765 "name": "GetSugarcrm_Fields",
25766 "group": "Sugarcrm_Fields",
25767 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
25768 "version": "0.0.0",
25769 "filename": "server/api/intSugarcrmField/index.js",
25770 "groupTitle": "Sugarcrm_Fields"
25774 "url": "/api/integrations/sugarcrm/fields/{id}",
25775 "title": "Gets a single Sugarcrm Field",
25778 "title": "Example usage:",
25779 "content": "curl https://{domain}/api/integrations/sugarcrm/fields/{id} -v -u {name}:{password}",
25783 "name": "ShowSugarcrm_Fields",
25784 "group": "Sugarcrm_Fields",
25785 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25786 "version": "0.0.0",
25787 "filename": "server/api/intSugarcrmField/index.js",
25788 "groupTitle": "Sugarcrm_Fields"
25792 "url": "/api/integrations/sugarcrm/fields/{id}",
25793 "title": "Update an existing Sugarcrm Field",
25796 "title": "Example usage:",
25797 "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",
25801 "name": "updateSugarcrm_Fields",
25802 "group": "Sugarcrm_Fields",
25803 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25804 "version": "0.0.0",
25805 "filename": "server/api/intSugarcrmField/index.js",
25806 "groupTitle": "Sugarcrm_Fields"
25810 "url": "/api/system",
25811 "title": "Gets system information",
25814 "title": "Example usage:",
25815 "content": "curl https://{domain}/api/system -v -u {name}:{password}",
25819 "name": "GetSystemInformation",
25820 "group": "System_Information",
25821 "description": "<p>Motion returns the system information.</p>",
25822 "version": "0.0.0",
25823 "filename": "server/api/system/index.js",
25824 "groupTitle": "System_Information"
25828 "url": "/api/system/process",
25829 "title": "Gets system information",
25832 "title": "Example usage:",
25833 "content": "curl https://{domain}/api/system -v -u {name}:{password}",
25837 "name": "GetSystemInformation",
25838 "group": "System_Information",
25839 "description": "<p>Motion returns the system information.</p>",
25840 "version": "0.0.0",
25841 "filename": "server/api/system/index.js",
25842 "groupTitle": "System_Information"
25846 "url": "/api/tags",
25847 "title": "Creates a new Tag",
25850 "title": "Example usage:",
25851 "content": "curl https://{domain}/api/tags -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
25855 "name": "CreateTags",
25878 "field": "description",
25884 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25885 "version": "0.0.0",
25886 "filename": "server/api/tag/index.js",
25887 "groupTitle": "Tags"
25891 "url": "/api/tags/{id}",
25892 "title": "Deletes a Tag",
25895 "title": "Example usage:",
25896 "content": "curl https://{domain}/api/tags/{id} -v -u {name}:{password} -X DELETE",
25900 "name": "DeleteTags",
25902 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25903 "version": "0.0.0",
25904 "filename": "server/api/tag/index.js",
25905 "groupTitle": "Tags"
25909 "url": "/api/tags",
25910 "title": "Gets a list of Tags",
25913 "title": "Example usage:",
25914 "content": "curl https://{domain}/api/tags -v -u {name}:{password}",
25920 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
25921 "version": "0.0.0",
25922 "filename": "server/api/tag/index.js",
25923 "groupTitle": "Tags"
25927 "url": "/api/tags/{id}",
25928 "title": "Gets a single Tag",
25931 "title": "Example usage:",
25932 "content": "curl https://{domain}/api/tags/{id} -v -u {name}:{password}",
25936 "name": "ShowTags",
25938 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25939 "version": "0.0.0",
25940 "filename": "server/api/tag/index.js",
25941 "groupTitle": "Tags"
25945 "url": "/api/tags/{id}",
25946 "title": "Update an existing Tag",
25949 "title": "Example usage:",
25950 "content": "curl https://{domain}/api/tags/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
25954 "name": "updateTags",
25956 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25957 "version": "0.0.0",
25958 "filename": "server/api/tag/index.js",
25959 "groupTitle": "Tags"
25963 "url": "/api/teams/{id}/queues",
25964 "title": "Add queues to a team",
25967 "title": "Example usage:",
25968 "content": "curl https://{domain}/api/teams/{id}/queues -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
25972 "name": "AddQueues",
25974 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25975 "version": "0.0.0",
25976 "filename": "server/api/team/index.js",
25977 "groupTitle": "Teams"
25981 "url": "/api/teams",
25982 "title": "Creates a new Team",
25985 "title": "Example usage:",
25986 "content": "curl https://{domain}/api/teams -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
25990 "name": "CreateTeams",
26006 "field": "description",
26012 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26013 "version": "0.0.0",
26014 "filename": "server/api/team/index.js",
26015 "groupTitle": "Teams"
26019 "url": "/api/teams/{id}",
26020 "title": "Deletes a Team",
26023 "title": "Example usage:",
26024 "content": "curl https://{domain}/api/teams/{id} -v -u {name}:{password} -X DELETE",
26028 "name": "DeleteTeams",
26030 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26031 "version": "0.0.0",
26032 "filename": "server/api/team/index.js",
26033 "groupTitle": "Teams"
26037 "url": "/api/teams/{id}/users",
26038 "title": "Gets agents from team",
26041 "title": "Example usage:",
26042 "content": "curl https://{domain}/api/teams/{id}/users -v -u {name}:{password} -X GET",
26046 "name": "GetAgents",
26048 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26049 "version": "0.0.0",
26050 "filename": "server/api/team/index.js",
26051 "groupTitle": "Teams"
26055 "url": "/api/teams/{id}/queues?channel={channel}",
26056 "title": "Gets Queues list",
26059 "title": "Example usage:",
26060 "content": "curl https://{domain}/api/teams/{id}/queues?channel={channel} -v -u {name}:{password}",
26064 "name": "GetQueues",
26066 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26067 "version": "0.0.0",
26068 "filename": "server/api/team/index.js",
26069 "groupTitle": "Teams"
26073 "url": "/api/teams",
26074 "title": "Gets a list of Teams",
26077 "title": "Example usage:",
26078 "content": "curl https://{domain}/api/teams -v -u {name}:{password}",
26082 "name": "GetTeams",
26084 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
26085 "version": "0.0.0",
26086 "filename": "server/api/team/index.js",
26087 "groupTitle": "Teams"
26091 "url": "/api/teams/{id}/users",
26092 "title": "Removes agents from a team",
26095 "title": "Example usage:",
26096 "content": "curl https://{domain}/api/teams/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
26100 "name": "RemoveAgents",
26102 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26103 "version": "0.0.0",
26104 "filename": "server/api/team/index.js",
26105 "groupTitle": "Teams"
26109 "url": "/api/teams/{id}/queues",
26110 "title": "Remove queues to a team",
26113 "title": "Example usage:",
26114 "content": "curl https://{domain}/api/teams/{id}/queues?channel=voice&ids=1&ids=2 -v -u {name}:{password} -X DELETE",
26118 "name": "RemoveQueues",
26120 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26121 "version": "0.0.0",
26122 "filename": "server/api/team/index.js",
26123 "groupTitle": "Teams"
26127 "url": "/api/whatsapp/queues/{id}/teams",
26128 "title": "Remove teams from a queue",
26131 "title": "Example usage:",
26132 "content": "curl https://{domain}/api/whatsapp/queues/{id}/teams -v -u {name}:{password} -X DELETE",
26136 "name": "RemoveTeams",
26138 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26139 "version": "0.0.0",
26140 "filename": "server/api/whatsappQueue/index.js",
26141 "groupTitle": "Teams"
26145 "url": "/api/openchannel/queues/{id}/teams",
26146 "title": "Remove teams from a queue",
26149 "title": "Example usage:",
26150 "content": "curl https://{domain}/api/openchannel/queues/{id}/teams -v -u {name}:{password} -X DELETE",
26154 "name": "RemoveTeams",
26156 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26157 "version": "0.0.0",
26158 "filename": "server/api/openchannelQueue/index.js",
26159 "groupTitle": "Teams"
26163 "url": "/api/voice/queues/{id}/teams",
26164 "title": "Remove teams from a queue",
26167 "title": "Example usage:",
26168 "content": "curl https://{domain}/api/voice/queues/{id}/teams -v -u {name}:{password} -X DELETE",
26172 "name": "RemoveTeams",
26174 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26175 "version": "0.0.0",
26176 "filename": "server/api/voiceQueue/index.js",
26177 "groupTitle": "Teams"
26181 "url": "/api/sms/queues/{id}/teams",
26182 "title": "Remove teams from a queue",
26185 "title": "Example usage:",
26186 "content": "curl https://{domain}/api/sms/queues/{id}/teams -v -u {name}:{password} -X DELETE",
26190 "name": "RemoveTeams",
26192 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26193 "version": "0.0.0",
26194 "filename": "server/api/smsQueue/index.js",
26195 "groupTitle": "Teams"
26199 "url": "/api/chat/queues/{id}/teams",
26200 "title": "Remove teams from a queue",
26203 "title": "Example usage:",
26204 "content": "curl https://{domain}/api/chat/queues/{id}/teams -v -u {name}:{password} -X DELETE",
26208 "name": "RemoveTeams",
26210 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26211 "version": "0.0.0",
26212 "filename": "server/api/chatQueue/index.js",
26213 "groupTitle": "Teams"
26217 "url": "/api/mail/queues/{id}/teams",
26218 "title": "Remove teams from a queue",
26221 "title": "Example usage:",
26222 "content": "curl https://{domain}/api/mail/queues/{id}/teams -v -u {name}:{password} -X DELETE",
26226 "name": "RemoveTeams",
26228 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26229 "version": "0.0.0",
26230 "filename": "server/api/mailQueue/index.js",
26231 "groupTitle": "Teams"
26235 "url": "/api/fax/queues/{id}/teams",
26236 "title": "Remove teams from a queue",
26239 "title": "Example usage:",
26240 "content": "curl https://{domain}/api/fax/queues/{id}/teams -v -u {name}:{password} -X DELETE",
26244 "name": "RemoveTeams",
26246 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26247 "version": "0.0.0",
26248 "filename": "server/api/faxQueue/index.js",
26249 "groupTitle": "Teams"
26253 "url": "/api/teams/{id}",
26254 "title": "Gets a single Team",
26257 "title": "Example usage:",
26258 "content": "curl https://{domain}/api/teams/{id} -v -u {name}:{password}",
26262 "name": "ShowTeams",
26264 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26265 "version": "0.0.0",
26266 "filename": "server/api/team/index.js",
26267 "groupTitle": "Teams"
26271 "url": "/api/teams/{id}/users",
26272 "title": "Adds agents to a team",
26275 "title": "Example usage:",
26276 "content": "curl https://{domain}/api/teams/{id}/users -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
26280 "name": "addAgents",
26282 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26283 "version": "0.0.0",
26284 "filename": "server/api/team/index.js",
26285 "groupTitle": "Teams"
26289 "url": "/api/teams/{id}",
26290 "title": "Update an existing Team",
26293 "title": "Example usage:",
26294 "content": "curl https://{domain}/api/teams/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
26298 "name": "updateTeams",
26300 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26301 "version": "0.0.0",
26302 "filename": "server/api/team/index.js",
26303 "groupTitle": "Teams"
26307 "url": "/api/templates",
26308 "title": "Creates a new Template",
26311 "title": "Example usage:",
26312 "content": "curl https://{domain}/api/templates -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
26316 "name": "CreateTemplates",
26317 "group": "Templates",
26332 "field": "description",
26345 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26346 "version": "0.0.0",
26347 "filename": "server/api/template/index.js",
26348 "groupTitle": "Templates"
26352 "url": "/api/templates/{id}",
26353 "title": "Deletes a Template",
26356 "title": "Example usage:",
26357 "content": "curl https://{domain}/api/templates/{id} -v -u {name}:{password} -X DELETE",
26361 "name": "DeleteTemplates",
26362 "group": "Templates",
26363 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26364 "version": "0.0.0",
26365 "filename": "server/api/template/index.js",
26366 "groupTitle": "Templates"
26370 "url": "/api/templates",
26371 "title": "Gets a list of Templates",
26374 "title": "Example usage:",
26375 "content": "curl https://{domain}/api/templates -v -u {name}:{password}",
26379 "name": "GetTemplates",
26380 "group": "Templates",
26381 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
26382 "version": "0.0.0",
26383 "filename": "server/api/template/index.js",
26384 "groupTitle": "Templates"
26388 "url": "/api/templates/{id}",
26389 "title": "Gets a single Template",
26392 "title": "Example usage:",
26393 "content": "curl https://{domain}/api/templates/{id} -v -u {name}:{password}",
26397 "name": "ShowTemplates",
26398 "group": "Templates",
26399 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26400 "version": "0.0.0",
26401 "filename": "server/api/template/index.js",
26402 "groupTitle": "Templates"
26406 "url": "/api/templates/{id}",
26407 "title": "Update an existing Template",
26410 "title": "Example usage:",
26411 "content": "curl https://{domain}/api/templates/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
26415 "name": "updateTemplates",
26416 "group": "Templates",
26417 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26418 "version": "0.0.0",
26419 "filename": "server/api/template/index.js",
26420 "groupTitle": "Templates"
26424 "url": "/api/triggers",
26425 "title": "Creates a new Trigger",
26428 "title": "Example usage:",
26429 "content": "curl https://{domain}/api/triggers -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
26433 "name": "CreateTriggers",
26434 "group": "Triggers",
26449 "field": "channel",
26456 "field": "description",
26469 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26470 "version": "0.0.0",
26471 "filename": "server/api/trigger/index.js",
26472 "groupTitle": "Triggers"
26476 "url": "/api/triggers/{id}",
26477 "title": "Deletes a Trigger",
26480 "title": "Example usage:",
26481 "content": "curl https://{domain}/api/triggers/{id} -v -u {name}:{password} -X DELETE",
26485 "name": "DeleteTriggers",
26486 "group": "Triggers",
26487 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26488 "version": "0.0.0",
26489 "filename": "server/api/trigger/index.js",
26490 "groupTitle": "Triggers"
26494 "url": "/api/triggers",
26495 "title": "Gets a list of Triggers",
26498 "title": "Example usage:",
26499 "content": "curl https://{domain}/api/triggers -v -u {name}:{password}",
26503 "name": "GetTriggers",
26504 "group": "Triggers",
26505 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
26506 "version": "0.0.0",
26507 "filename": "server/api/trigger/index.js",
26508 "groupTitle": "Triggers"
26512 "url": "/api/triggers/{id}",
26513 "title": "Gets a single Trigger",
26516 "title": "Example usage:",
26517 "content": "curl https://{domain}/api/triggers/{id} -v -u {name}:{password}",
26521 "name": "ShowTriggers",
26522 "group": "Triggers",
26523 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26524 "version": "0.0.0",
26525 "filename": "server/api/trigger/index.js",
26526 "groupTitle": "Triggers"
26530 "url": "/api/triggers/{id}/actions",
26531 "title": "Creates new actions",
26534 "title": "Example usage:",
26535 "content": "curl https://{domain}/api/triggers/{id}/actions -d '{\"action\": \"contactManager\",\"data1\": \"1\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
26539 "name": "addAction",
26540 "group": "Triggers",
26556 "description": "<p>Allowed values: contactManager, integration, motionbar, jscripty, urlForward, browser, bot, script</p>"
26563 "description": "<p>contactManager[ListId], integration[intName(zendesk)], motionbar[Popup(0),URL(1),WinApp(2)], urlForward[GET,POST], browser[TemplateId(0),URL(1)]</p>"
26570 "description": "<p>integration[AccountId], motionbar[TemplateId,URL,WinAppPath], urlForward[URL]</p>"
26577 "description": "<p>motionbar[NULL,NULL,WinAppArguments]</p>"
26610 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26611 "version": "0.0.0",
26612 "filename": "server/api/trigger/index.js",
26613 "groupTitle": "Triggers"
26617 "url": "/api/triggers/{id}/all_conditions",
26618 "title": "Creates a new \"AND\"condition",
26621 "title": "Example usage:",
26622 "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",
26626 "name": "addAllCondition",
26627 "group": "Triggers",
26649 "field": "operator",
26662 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26663 "version": "0.0.0",
26664 "filename": "server/api/trigger/index.js",
26665 "groupTitle": "Triggers"
26669 "url": "/api/triggers/{id}/any_conditions",
26670 "title": "Creates a new \"OR\"condition",
26673 "title": "Example usage:",
26674 "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",
26678 "name": "addAnyCondition",
26679 "group": "Triggers",
26701 "field": "operator",
26714 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26715 "version": "0.0.0",
26716 "filename": "server/api/trigger/index.js",
26717 "groupTitle": "Triggers"
26721 "url": "/api/triggers/{id}/actions",
26722 "title": "Gets Trigger Actions",
26725 "title": "Example usage:",
26726 "content": "curl https://{domain}/api/triggers/{id}/actions -v -u {name}:{password} -X GET",
26730 "name": "getActions",
26731 "group": "Triggers",
26732 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26733 "version": "0.0.0",
26734 "filename": "server/api/trigger/index.js",
26735 "groupTitle": "Triggers"
26739 "url": "/api/triggers/{id}/all_conditions",
26740 "title": "Gets \"AND\" Trigger Conditions",
26743 "title": "Example usage:",
26744 "content": "curl https://{domain}/api/triggers/{id}/all_conditions -v -u {name}:{password} -X GET",
26748 "name": "getAllConditions",
26749 "group": "Triggers",
26750 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26751 "version": "0.0.0",
26752 "filename": "server/api/trigger/index.js",
26753 "groupTitle": "Triggers"
26757 "url": "/api/triggers/{id}/any_conditions",
26758 "title": "Gets \"OR\" Trigger Conditions",
26761 "title": "Example usage:",
26762 "content": "curl https://{domain}/api/triggers/{id}/any_conditions -v -u {name}:{password} -X GET",
26766 "name": "getAnyConditions",
26767 "group": "Triggers",
26768 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26769 "version": "0.0.0",
26770 "filename": "server/api/trigger/index.js",
26771 "groupTitle": "Triggers"
26775 "url": "/api/triggers/{id}",
26776 "title": "Update an existing Trigger",
26779 "title": "Example usage:",
26780 "content": "curl https://{domain}/api/triggers/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
26784 "name": "updateTriggers",
26785 "group": "Triggers",
26786 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26787 "version": "0.0.0",
26788 "filename": "server/api/trigger/index.js",
26789 "groupTitle": "Triggers"
26793 "url": "/api/trunks/clone",
26794 "title": "Clone an existing Trunk",
26797 "title": "Example usage:",
26798 "content": "curl https://{domain}/api/trunks/clone -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
26802 "name": "CloneTrunks",
26804 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26805 "version": "0.0.0",
26806 "filename": "server/api/trunk/index.js",
26807 "groupTitle": "Trunks"
26811 "url": "/api/trunks",
26812 "title": "Create a new trunk",
26815 "title": "Example usage:",
26816 "content": "curl https://{domain}/api/trunks -v -u {name}:{password} -X POST",
26848 "field": "context",
26855 "\"ALLOWED_NOT_SCREENED\"",
26856 "\"ALLOWED_PASSED_SCREEN\"",
26857 "\"ALLOWED_FAILED_SCREEN\"",
26859 "\"PROHIB_NOT_SCREENED\"",
26860 "\"PROHIB_PASSED_SCREEN\"",
26861 "\"PROHIB_FAILED_SCREEN\"",
26865 "field": "callingpres",
26893 "field": "md5secret",
26900 "field": "remotesecret",
26907 "field": "transport",
26908 "description": "<p>String is deprecated. Please use an Array as ["udp", "tcp"]</p>"
26921 "field": "dtmfmode",
26935 "field": "directmedia",
26946 "field": "directrtpsetup",
26953 "field": "directmediapermit",
26960 "field": "directmediadeny",
26968 "description": "<p>String is deprecated. Please use an Array as ["force_rport", "comedia"]</p>"
26974 "field": "callgroup",
26981 "field": "namedcallgroup",
26988 "field": "pickupgroup",
26995 "field": "namedpickupgroup",
27002 "field": "language",
27009 "field": "tonezone",
27016 "field": "disallow",
27024 "description": "<p>String is deprecated. Please use an Array as ["ulaw", "alaw", "alaw"]</p>"
27034 "field": "autoframing",
27041 "field": "insecure",
27042 "description": "<p>String is deprecated. Please use an Array as ["port", "invite"]</p>"
27052 "field": "trustrpid",
27063 "field": "trust_id_outbound",
27075 "field": "progressinband",
27086 "field": "promiscredir",
27097 "field": "useclientcode",
27104 "field": "accountcode",
27118 "field": "callerid",
27125 "field": "amaflags",
27136 "field": "callcounter",
27143 "field": "busylevel",
27154 "field": "allowoverlap",
27165 "field": "allowsubscribe",
27176 "field": "allowtransfer",
27187 "field": "ignoresdpversion",
27194 "field": "subscribecontext",
27201 "field": "template",
27213 "field": "videosupport",
27220 "field": "maxcallbitrate",
27231 "field": "rfc2833compensate",
27238 "field": "mailbox",
27250 "field": "session_timers",
27257 "field": "session_expires",
27264 "field": "session_minse",
27275 "field": "session_refresher",
27282 "field": "t38pt_usertpsource",
27289 "field": "regexten",
27296 "field": "fromdomain",
27303 "field": "fromuser",
27321 "field": "qualify",
27328 "field": "keepalive",
27335 "field": "defaultip",
27342 "field": "defaultuser",
27349 "field": "rtptimeout",
27356 "field": "rtpholdtimeout",
27363 "field": "rtpkeepalive",
27375 "field": "sendrpid",
27382 "field": "outboundproxy",
27389 "field": "callbackextension",
27396 "field": "timert1",
27410 "field": "qualifyfreq",
27417 "field": "contactpermit",
27424 "field": "contactdeny",
27431 "field": "contactacl",
27438 "field": "unsolicited_mailbox",
27445 "field": "use_q850_reason",
27452 "field": "maxforwards",
27463 "field": "encryption",
27485 "field": "force_avp",
27496 "field": "icesupport",
27507 "field": "dtlsenable",
27520 "field": "dtlsverify",
27527 "field": "dtlsrekey",
27534 "field": "dtlscertfile",
27541 "field": "dtlsprivatekey",
27548 "field": "dtlscipher",
27555 "field": "dtlscafile",
27562 "field": "dtlscapath",
27574 "field": "dtlssetup",
27581 "field": "dtlsfingerprint",
27592 "field": "usereqphone",
27599 "field": "recordonfeature",
27606 "field": "recordofffeature",
27613 "field": "call_limit",
27624 "field": "registertrying",
27635 "field": "subscribemwi",
27642 "field": "vmexten",
27649 "field": "mohinterpret",
27656 "field": "mohsuggest",
27663 "field": "parkinglot",
27670 "field": "description",
27691 "field": "canreinvite",
27698 "field": "registry",
27705 "field": "otherFields",
27719 "field": "t38pt_udptl",
27725 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27726 "version": "0.0.0",
27727 "filename": "server/api/trunk/index.js",
27728 "groupTitle": "Trunks"
27732 "url": "/api/trunks/{id}",
27733 "title": "Deletes a trunk",
27736 "title": "Example usage:",
27737 "content": "curl https://{domain}/api/trunks/{id} -v -u {name}:{password} -X DELETE",
27743 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27744 "version": "0.0.0",
27745 "filename": "server/api/trunk/index.js",
27746 "groupTitle": "Trunks"
27750 "url": "/api/trunks",
27751 "title": "Gets a list of Trunks",
27754 "title": "Example usage:",
27755 "content": "curl https://{domain}/api/trunks -v -u {name}:{password}",
27759 "name": "GetTrunks",
27761 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
27762 "version": "0.0.0",
27763 "filename": "server/api/trunk/index.js",
27764 "groupTitle": "Trunks"
27768 "url": "/api/trunks/{id}",
27769 "title": "Gets a single Trunk",
27772 "title": "Example usage:",
27773 "content": "curl https://{domain}/api/trunks/{id} -v -u {name}:{password}",
27777 "name": "ShowTrunks",
27779 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27780 "version": "0.0.0",
27781 "filename": "server/api/trunk/index.js",
27782 "groupTitle": "Trunks"
27786 "url": "/api/trunks/{id}",
27787 "title": "Update an existing trunk",
27790 "title": "Example usage:",
27791 "content": "curl https://{domain}/api/trunks/{id} -v -u {name}:{password} -X PUT",
27797 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27798 "version": "0.0.0",
27799 "filename": "server/api/trunk/index.js",
27800 "groupTitle": "Trunks"
27804 "url": "/api/userNotifications",
27805 "title": "Send notification to user",
27808 "title": "Example usage:",
27809 "content": "curl https://{domain}/api/userNotifications -d '{\"text\": \"Hello!\", \"TemplateId\": 1}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
27814 "group": "UserNotifications",
27815 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27816 "version": "0.0.0",
27817 "filename": "server/api/userNotification/index.js",
27818 "groupTitle": "UserNotifications"
27822 "url": "/api/userProfile/resources",
27823 "title": "Creates a new User Profile Resource",
27826 "title": "Example usage:",
27827 "content": "curl https://{domain}/api/userProfile/resources -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
27831 "name": "CreateUser_Profile_Resources",
27832 "group": "User_Profile_Resources",
27847 "field": "resourceId",
27860 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27861 "version": "0.0.0",
27862 "filename": "server/api/userProfileResource/index.js",
27863 "groupTitle": "User_Profile_Resources"
27867 "url": "/api/userProfile/resources/{id}",
27868 "title": "Deletes a User Profile Resource",
27871 "title": "Example usage:",
27872 "content": "curl https://{domain}/api/userProfile/resources/{id} -v -u {name}:{password} -X DELETE",
27876 "name": "DeleteUser_Profile_Resources",
27877 "group": "User_Profile_Resources",
27878 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27879 "version": "0.0.0",
27880 "filename": "server/api/userProfileResource/index.js",
27881 "groupTitle": "User_Profile_Resources"
27885 "url": "/api/userProfile/resources/describe",
27886 "title": "Gets table info about User Profile Resources",
27889 "title": "Example usage:",
27890 "content": "curl https://{domain}/api/userProfile/resources/describe -v -u {name}:{password}",
27894 "name": "DescribeUser_Profile_Resources",
27895 "group": "User_Profile_Resources",
27896 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27897 "version": "0.0.0",
27898 "filename": "server/api/userProfileResource/index.js",
27899 "groupTitle": "User_Profile_Resources"
27903 "url": "/api/userProfile/resources",
27904 "title": "Gets a list of User Profile Resources",
27907 "title": "Example usage:",
27908 "content": "curl https://{domain}/api/userProfile/resources -v -u {name}:{password}",
27912 "name": "GetUser_Profile_Resources",
27913 "group": "User_Profile_Resources",
27914 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
27915 "version": "0.0.0",
27916 "filename": "server/api/userProfileResource/index.js",
27917 "groupTitle": "User_Profile_Resources"
27921 "url": "/api/userProfile/resources/{id}",
27922 "title": "Gets a single User Profile Resource",
27925 "title": "Example usage:",
27926 "content": "curl https://{domain}/api/userProfile/resources/{id} -v -u {name}:{password}",
27930 "name": "ShowUser_Profile_Resources",
27931 "group": "User_Profile_Resources",
27932 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27933 "version": "0.0.0",
27934 "filename": "server/api/userProfileResource/index.js",
27935 "groupTitle": "User_Profile_Resources"
27939 "url": "/api/userProfile/resources/{id}",
27940 "title": "Update an existing User Profile Resource",
27943 "title": "Example usage:",
27944 "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",
27948 "name": "updateUser_Profile_Resources",
27949 "group": "User_Profile_Resources",
27950 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27951 "version": "0.0.0",
27952 "filename": "server/api/userProfileResource/index.js",
27953 "groupTitle": "User_Profile_Resources"
27957 "url": "/api/userProfile/sections",
27958 "title": "Creates a new User Profile Section",
27961 "title": "Example usage:",
27962 "content": "curl https://{domain}/api/userProfile/sections -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
27966 "name": "CreateUser_Profile_Sections",
27967 "group": "User_Profile_Sections",
27982 "field": "category",
27989 "field": "sectionId",
27996 "field": "enabled",
28003 "field": "autoAssociation",
28010 "field": "crudPermissions",
28016 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28017 "version": "0.0.0",
28018 "filename": "server/api/userProfileSection/index.js",
28019 "groupTitle": "User_Profile_Sections"
28023 "url": "/api/userProfile/sections/{id}",
28024 "title": "Deletes a User Profile Section",
28027 "title": "Example usage:",
28028 "content": "curl https://{domain}/api/userProfile/sections/{id} -v -u {name}:{password} -X DELETE",
28032 "name": "DeleteUser_Profile_Sections",
28033 "group": "User_Profile_Sections",
28034 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28035 "version": "0.0.0",
28036 "filename": "server/api/userProfileSection/index.js",
28037 "groupTitle": "User_Profile_Sections"
28041 "url": "/api/userProfile/sections/describe",
28042 "title": "Gets table info about User Profile Sections",
28045 "title": "Example usage:",
28046 "content": "curl https://{domain}/api/userProfile/sections/describe -v -u {name}:{password}",
28050 "name": "DescribeUser_Profile_Sections",
28051 "group": "User_Profile_Sections",
28052 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28053 "version": "0.0.0",
28054 "filename": "server/api/userProfileSection/index.js",
28055 "groupTitle": "User_Profile_Sections"
28059 "url": "/api/userProfile/sections",
28060 "title": "Gets a list of User Profile Sections",
28063 "title": "Example usage:",
28064 "content": "curl https://{domain}/api/userProfile/sections -v -u {name}:{password}",
28068 "name": "GetUser_Profile_Sections",
28069 "group": "User_Profile_Sections",
28070 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
28071 "version": "0.0.0",
28072 "filename": "server/api/userProfileSection/index.js",
28073 "groupTitle": "User_Profile_Sections"
28077 "url": "/api/userProfile/sections/{id}",
28078 "title": "Gets a single User Profile Section",
28081 "title": "Example usage:",
28082 "content": "curl https://{domain}/api/userProfile/sections/{id} -v -u {name}:{password}",
28086 "name": "ShowUser_Profile_Sections",
28087 "group": "User_Profile_Sections",
28088 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28089 "version": "0.0.0",
28090 "filename": "server/api/userProfileSection/index.js",
28091 "groupTitle": "User_Profile_Sections"
28095 "url": "/api/userProfile/sections/{id}",
28096 "title": "Update an existing User Profile Section",
28099 "title": "Example usage:",
28100 "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",
28104 "name": "updateUser_Profile_Sections",
28105 "group": "User_Profile_Sections",
28106 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28107 "version": "0.0.0",
28108 "filename": "server/api/userProfileSection/index.js",
28109 "groupTitle": "User_Profile_Sections"
28113 "url": "/api/userProfiles/{id}/resources",
28114 "title": "Add resources' permissions to User Profile",
28117 "title": "Example usage:",
28118 "content": "curl https://{domain}/api/userProfiles/{id}/resources -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
28122 "name": "AddResources",
28123 "group": "User_Profiles",
28124 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28125 "version": "0.0.0",
28126 "filename": "server/api/userProfile/index.js",
28127 "groupTitle": "User_Profiles"
28131 "url": "/api/userProfiles/{id}/sections",
28132 "title": "Add sections' permissions to User Profile",
28135 "title": "Example usage:",
28136 "content": "curl https://{domain}/api/userProfiles/{id}/sections -d '[{\"sectionId\": \"name\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
28140 "name": "AddSections",
28141 "group": "User_Profiles",
28142 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28143 "version": "0.0.0",
28144 "filename": "server/api/userProfile/index.js",
28145 "groupTitle": "User_Profiles"
28149 "url": "/api/userProfiles/clone",
28150 "title": "Clone an existing User Profile",
28153 "title": "Example usage:",
28154 "content": "curl https://{domain}/api/userProfiles/clone -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
28158 "name": "CloneUser_Profiles",
28159 "group": "User_Profiles",
28160 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28161 "version": "0.0.0",
28162 "filename": "server/api/userProfile/index.js",
28163 "groupTitle": "User_Profiles"
28167 "url": "/api/userProfiles",
28168 "title": "Creates a new User Profile",
28171 "title": "Example usage:",
28172 "content": "curl https://{domain}/api/userProfiles -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
28176 "name": "CreateUser_Profiles",
28177 "group": "User_Profiles",
28192 "field": "crudPermissions",
28199 "field": "description",
28205 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28206 "version": "0.0.0",
28207 "filename": "server/api/userProfile/index.js",
28208 "groupTitle": "User_Profiles"
28212 "url": "/api/userProfiles/{id}",
28213 "title": "Deletes a User Profile",
28216 "title": "Example usage:",
28217 "content": "curl https://{domain}/api/userProfiles/{id} -v -u {name}:{password} -X DELETE",
28221 "name": "DeleteUser_Profiles",
28222 "group": "User_Profiles",
28223 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28224 "version": "0.0.0",
28225 "filename": "server/api/userProfile/index.js",
28226 "groupTitle": "User_Profiles"
28230 "url": "/api/userProfiles/describe",
28231 "title": "Gets table info about User Profiles",
28234 "title": "Example usage:",
28235 "content": "curl https://{domain}/api/userProfiles/describe -v -u {name}:{password}",
28239 "name": "DescribeUser_Profiles",
28240 "group": "User_Profiles",
28241 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28242 "version": "0.0.0",
28243 "filename": "server/api/userProfile/index.js",
28244 "groupTitle": "User_Profiles"
28248 "url": "/api/userProfiles/{id}/resources?section={section}",
28249 "title": "Get Resources assigned to a Section",
28252 "title": "Example usage:",
28253 "content": "curl https://{domain}/api/userProfiles/{id}/resources?section={section} -v -u {name}:{password} -X GET",
28257 "name": "GetResources",
28258 "group": "User_Profiles",
28259 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28260 "version": "0.0.0",
28261 "filename": "server/api/userProfile/index.js",
28262 "groupTitle": "User_Profiles"
28266 "url": "/api/userProfiles/{id}/sections",
28267 "title": "Get sections associated to a User Profile",
28270 "title": "Example usage:",
28271 "content": "curl https://{domain}/api/userProfiles/{id}/sections -v -u {name}:{password} -X GET",
28275 "name": "GetSections",
28276 "group": "User_Profiles",
28277 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28278 "version": "0.0.0",
28279 "filename": "server/api/userProfile/index.js",
28280 "groupTitle": "User_Profiles"
28284 "url": "/api/userProfiles",
28285 "title": "Gets a list of User Profiles",
28288 "title": "Example usage:",
28289 "content": "curl https://{domain}/api/userProfiles -v -u {name}:{password}",
28293 "name": "GetUser_Profiles",
28294 "group": "User_Profiles",
28295 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
28296 "version": "0.0.0",
28297 "filename": "server/api/userProfile/index.js",
28298 "groupTitle": "User_Profiles"
28302 "url": "/api/userProfiles/{id}/resources",
28303 "title": "Removes resources' permissions from User Profile",
28306 "title": "Example usage:",
28307 "content": "curl https://{domain}/api/userProfiles/{id}/resources?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
28311 "name": "RemoveResources",
28312 "group": "User_Profiles",
28313 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28314 "version": "0.0.0",
28315 "filename": "server/api/userProfile/index.js",
28316 "groupTitle": "User_Profiles"
28320 "url": "/api/userProfiles/{id}/sections",
28321 "title": "Removes sections' permissions from User Profile",
28324 "title": "Example usage:",
28325 "content": "curl https://{domain}/api/userProfiles/{id}/sections?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
28329 "name": "RemoveSections",
28330 "group": "User_Profiles",
28331 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28332 "version": "0.0.0",
28333 "filename": "server/api/userProfile/index.js",
28334 "groupTitle": "User_Profiles"
28338 "url": "/api/userProfiles/{id}",
28339 "title": "Gets a single User Profile",
28342 "title": "Example usage:",
28343 "content": "curl https://{domain}/api/userProfiles/{id} -v -u {name}:{password}",
28347 "name": "ShowUser_Profiles",
28348 "group": "User_Profiles",
28349 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28350 "version": "0.0.0",
28351 "filename": "server/api/userProfile/index.js",
28352 "groupTitle": "User_Profiles"
28356 "url": "/api/userProfiles/{id}",
28357 "title": "Update an existing User Profile",
28360 "title": "Example usage:",
28361 "content": "curl https://{domain}/api/userProfiles/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
28365 "name": "updateUser_Profiles",
28366 "group": "User_Profiles",
28367 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28368 "version": "0.0.0",
28369 "filename": "server/api/userProfile/index.js",
28370 "groupTitle": "User_Profiles"
28374 "url": "/api/users/{id}/chat_interactions",
28375 "title": "Add chat interaction tabs to an agent",
28378 "title": "Example usage:",
28379 "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",
28383 "name": "AddChatInteractions",
28385 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28386 "version": "0.0.0",
28387 "filename": "server/api/user/index.js",
28388 "groupTitle": "Users"
28392 "url": "/api/users/{id}/chat_websites",
28393 "title": "Add a Chat Website to a user",
28396 "title": "Example usage:",
28397 "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",
28401 "name": "AddChatWebsites",
28403 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28404 "version": "0.0.0",
28405 "filename": "server/api/user/index.js",
28406 "groupTitle": "Users"
28410 "url": "/api/users/{id}/contacts",
28411 "title": "Add contacts to a user",
28414 "title": "Example usage:",
28415 "content": "curl https://{domain}/api/users/{id}/contacts -d '{\"ids\": [1,2]}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
28419 "name": "AddContacts",
28421 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28422 "version": "0.0.0",
28423 "filename": "server/api/user/index.js",
28424 "groupTitle": "Users"
28428 "url": "/api/users/{id}/fax_accounts",
28429 "title": "Add a Fax Account to a user",
28432 "title": "Example usage:",
28433 "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",
28437 "name": "AddFaxAccounts",
28439 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28440 "version": "0.0.0",
28441 "filename": "server/api/user/index.js",
28442 "groupTitle": "Users"
28446 "url": "/api/users/{id}/fax_interactions",
28447 "title": "Add fax interaction tabs to an agent",
28450 "title": "Example usage:",
28451 "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",
28455 "name": "AddFaxInteractions",
28457 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28458 "version": "0.0.0",
28459 "filename": "server/api/user/index.js",
28460 "groupTitle": "Users"
28464 "url": "/api/users/{id}/mail_accounts",
28465 "title": "Add a Mail Account to a user",
28468 "title": "Example usage:",
28469 "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",
28473 "name": "AddMailAccounts",
28475 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28476 "version": "0.0.0",
28477 "filename": "server/api/user/index.js",
28478 "groupTitle": "Users"
28482 "url": "/api/users/{id}/mail_interactions",
28483 "title": "Add mail interaction tabs to an agent",
28486 "title": "Example usage:",
28487 "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",
28491 "name": "AddMailInteractions",
28493 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28494 "version": "0.0.0",
28495 "filename": "server/api/user/index.js",
28496 "groupTitle": "Users"
28500 "url": "/api/users/{id}/openchannel_accounts",
28501 "title": "Add a Open Channel Account to a user",
28504 "title": "Example usage:",
28505 "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",
28509 "name": "AddOpenchannelAccounts",
28511 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28512 "version": "0.0.0",
28513 "filename": "server/api/user/index.js",
28514 "groupTitle": "Users"
28518 "url": "/api/users/{id}/openchannel_interactions",
28519 "title": "Add openchannel interaction tabs to an agent",
28522 "title": "Example usage:",
28523 "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",
28527 "name": "AddOpenchannelInteractions",
28529 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28530 "version": "0.0.0",
28531 "filename": "server/api/user/index.js",
28532 "groupTitle": "Users"
28536 "url": "/api/users/{id}/queues",
28537 "title": "Add queues to an agent",
28540 "title": "Example usage:",
28541 "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",
28545 "name": "AddQueues",
28547 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28548 "version": "0.0.0",
28549 "filename": "server/api/user/index.js",
28550 "groupTitle": "Users"
28554 "url": "/api/users/{id}/sms_accounts",
28555 "title": "Add a Sms Account to a user",
28558 "title": "Example usage:",
28559 "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",
28563 "name": "AddSmsAccounts",
28565 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28566 "version": "0.0.0",
28567 "filename": "server/api/user/index.js",
28568 "groupTitle": "Users"
28572 "url": "/api/users/{id}/sms_interactions",
28573 "title": "Add sms interaction tabs to an agent",
28576 "title": "Example usage:",
28577 "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",
28581 "name": "AddSmsInteractions",
28583 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28584 "version": "0.0.0",
28585 "filename": "server/api/user/index.js",
28586 "groupTitle": "Users"
28590 "url": "/api/users/{id}/square_projects",
28591 "title": "Add a Square Project to a user",
28594 "title": "Example usage:",
28595 "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",
28599 "name": "AddSquareProjects",
28601 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28602 "version": "0.0.0",
28603 "filename": "server/api/user/index.js",
28604 "groupTitle": "Users"
28608 "url": "/api/users/{id}/teams",
28609 "title": "Add teams to an agent",
28612 "title": "Example usage:",
28613 "content": "curl https://{domain}/api/users/{id}/teams -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
28617 "name": "AddTeams",
28619 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28620 "version": "0.0.0",
28621 "filename": "server/api/user/index.js",
28622 "groupTitle": "Users"
28626 "url": "/api/users/{id}/whatsapp_accounts",
28627 "title": "Add a Whatsapp Account to a user",
28630 "title": "Example usage:",
28631 "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",
28635 "name": "AddWhatsappAccounts",
28637 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28638 "version": "0.0.0",
28639 "filename": "server/api/user/index.js",
28640 "groupTitle": "Users"
28644 "url": "/api/users/{id}/whatsapp_interactions",
28645 "title": "Add Whatsapp interaction tabs to an agent",
28648 "title": "Example usage:",
28649 "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",
28653 "name": "AddWhatsappInteractions",
28655 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28656 "version": "0.0.0",
28657 "filename": "server/api/user/index.js",
28658 "groupTitle": "Users"
28662 "url": "/api/users/{id}/password",
28663 "title": "Change user password",
28666 "title": "Example usage:",
28667 "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",
28671 "name": "ChangePwd",
28673 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28674 "version": "0.0.0",
28675 "filename": "server/api/user/index.js",
28676 "groupTitle": "Users"
28680 "url": "/api/users",
28681 "title": "Create a new user",
28684 "title": "Example usage:",
28685 "content": "curl https://{domain}/api/users -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
28691 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28692 "version": "0.0.0",
28693 "filename": "server/api/user/index.js",
28694 "groupTitle": "Users"
28698 "url": "/api/users/{id}/api_key",
28699 "title": "Create a new API access key for the user",
28702 "title": "Example usage:",
28703 "content": "curl https://{domain}/api/users/:id/api_key -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
28707 "name": "CreateApiKey",
28709 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28710 "version": "0.0.0",
28711 "filename": "server/api/user/index.js",
28712 "groupTitle": "Users"
28716 "url": "/api/users/{id}",
28717 "title": "Deletes a user",
28720 "title": "Example usage:",
28721 "content": "curl https://{domain}/api/users/{id} -v -u {name}:{password} -X DELETE",
28727 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28728 "version": "0.0.0",
28729 "filename": "server/api/user/index.js",
28730 "groupTitle": "Users"
28734 "url": "/api/users/describe",
28735 "title": "Gets table info about Users",
28738 "title": "Example usage:",
28739 "content": "curl https://{domain}/api/users/describe -v -u {name}:{password}",
28743 "name": "DescribeUsers",
28745 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28746 "version": "0.0.0",
28747 "filename": "server/api/user/index.js",
28748 "groupTitle": "Users"
28752 "url": "/api/users/{id}/agents",
28753 "title": "GetAgents",
28756 "title": "Example usage:",
28757 "content": "curl https://{domain}/api/users/{id}/agents -v -u {name}:{password} -X GET",
28761 "name": "GetAgents",
28763 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28764 "version": "0.0.0",
28765 "filename": "server/api/user/index.js",
28766 "groupTitle": "Users"
28770 "url": "/api/users/{id}/api_key",
28771 "title": "Get the API access key for the user",
28774 "title": "Example usage:",
28775 "content": "curl https://{domain}/api/users/:id/api_key -v -u {name}:{password} -X GET",
28779 "name": "GetApiKey",
28781 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28782 "version": "0.0.0",
28783 "filename": "server/api/user/index.js",
28784 "groupTitle": "Users"
28788 "url": "/api/users/{id}/groups",
28789 "title": "GetChatGroups",
28792 "title": "Example usage:",
28793 "content": "curl https://{domain}/api/users/{id}/groups -v -u {name}:{password} -X GET",
28797 "name": "GetChatGroups",
28799 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28800 "version": "0.0.0",
28801 "filename": "server/api/user/index.js",
28802 "groupTitle": "Users"
28806 "url": "/api/users/{id}/chat/interactions",
28807 "title": "GetChatInteractions",
28810 "title": "Example usage:",
28811 "content": "curl https://{domain}/api/users/{id}/chat/interactions -v -u {name}:{password} -X GET",
28815 "name": "GetChatInteractions",
28817 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28818 "version": "0.0.0",
28819 "filename": "server/api/user/index.js",
28820 "groupTitle": "Users"
28824 "url": "/api/users/{id}/chat_websites",
28825 "title": "GetChatWebsites",
28828 "title": "Example usage:",
28829 "content": "curl https://{domain}/api/users/{id}/chat_websites -v -u {name}:{password} -X GET",
28833 "name": "GetChatWebsites",
28835 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28836 "version": "0.0.0",
28837 "filename": "server/api/user/index.js",
28838 "groupTitle": "Users"
28842 "url": "/api/users/{id}/contacts",
28843 "title": "GetContacts",
28846 "title": "Example usage:",
28847 "content": "curl https://{domain}/api/users/{id}/contacts -v -u {name}:{password} -X GET",
28851 "name": "GetContacts",
28853 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28854 "version": "0.0.0",
28855 "filename": "server/api/user/index.js",
28856 "groupTitle": "Users"
28860 "url": "/api/users/{id}/fax_accounts",
28861 "title": "GetFaxAccounts",
28864 "title": "Example usage:",
28865 "content": "curl https://{domain}/api/users/{id}/fax_accounts -v -u {name}:{password} -X GET",
28869 "name": "GetFaxAccounts",
28871 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28872 "version": "0.0.0",
28873 "filename": "server/api/user/index.js",
28874 "groupTitle": "Users"
28878 "url": "/api/users/{id}/fax/interactions",
28879 "title": "GetFaxInteractions",
28882 "title": "Example usage:",
28883 "content": "curl https://{domain}/api/users/{id}/fax/interactions -v -u {name}:{password} -X GET",
28887 "name": "GetFaxInteractions",
28889 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28890 "version": "0.0.0",
28891 "filename": "server/api/user/index.js",
28892 "groupTitle": "Users"
28896 "url": "/api/users/{id}/lists",
28897 "title": "GetLists",
28900 "title": "Example usage:",
28901 "content": "curl https://{domain}/api/users/{id}/lists -v -u {name}:{password} -X GET",
28905 "name": "GetLists",
28907 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28908 "version": "0.0.0",
28909 "filename": "server/api/user/index.js",
28910 "groupTitle": "Users"
28914 "url": "/api/users/{id}/mail_accounts",
28915 "title": "GetMailAccounts",
28918 "title": "Example usage:",
28919 "content": "curl https://{domain}/api/users/{id}/mail_accounts -v -u {name}:{password} -X GET",
28923 "name": "GetMailAccounts",
28925 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28926 "version": "0.0.0",
28927 "filename": "server/api/user/index.js",
28928 "groupTitle": "Users"
28932 "url": "/api/users/{id}/mail/interactions",
28933 "title": "GetMailInteractions",
28936 "title": "Example usage:",
28937 "content": "curl https://{domain}/api/users/{id}/mail/interactions -v -u {name}:{password} -X GET",
28941 "name": "GetMailInteractions",
28943 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28944 "version": "0.0.0",
28945 "filename": "server/api/user/index.js",
28946 "groupTitle": "Users"
28950 "url": "/api/users/{id}/openchannel_accounts",
28951 "title": "GetOpenchannelAccounts",
28954 "title": "Example usage:",
28955 "content": "curl https://{domain}/api/users/{id}/openchannel_accounts -v -u {name}:{password} -X GET",
28959 "name": "GetOpenchannelAccounts",
28961 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28962 "version": "0.0.0",
28963 "filename": "server/api/user/index.js",
28964 "groupTitle": "Users"
28968 "url": "/api/users/{id}/openchannel/interactions",
28969 "title": "GetOpenchannelInteractions",
28972 "title": "Example usage:",
28973 "content": "curl https://{domain}/api/users/{id}/openchannel/interactions -v -u {name}:{password}",
28977 "name": "GetOpenchannelInteractions",
28979 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28980 "version": "0.0.0",
28981 "filename": "server/api/user/index.js",
28982 "groupTitle": "Users"
28986 "url": "/api/users/{id}/prefixes",
28987 "title": "GetPrefixes",
28990 "title": "Example usage:",
28991 "content": "curl https://{domain}/api/users/{id}/prefixes -v -u {name}:{password} -X GET",
28995 "name": "GetPrefixes",
28997 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28998 "version": "0.0.0",
28999 "filename": "server/api/user/index.js",
29000 "groupTitle": "Users"
29004 "url": "/api/users/{id}/queues?channel={channel}",
29005 "title": "Gets Queues list",
29008 "title": "Example usage:",
29009 "content": "curl https://{domain}/api/users/{id}/queues/?channel={channel} -v -u {name}:{password} -X GET",
29013 "name": "GetQueues",
29015 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29016 "version": "0.0.0",
29017 "filename": "server/api/user/index.js",
29018 "groupTitle": "Users"
29022 "url": "/api/users/{id}/recordings",
29023 "title": "GetRecordings",
29026 "title": "Example usage:",
29027 "content": "curl https://{domain}/api/users/{id}/recordings -v -u {name}:{password} -X GET",
29031 "name": "GetRecordings",
29033 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29034 "version": "0.0.0",
29035 "filename": "server/api/user/index.js",
29036 "groupTitle": "Users"
29040 "url": "/api/users/{id}/scheduled_calls",
29041 "title": "GetScheduledCalls",
29044 "title": "Example usage:",
29045 "content": "curl https://{domain}/api/users/{id}/scheduled_calls -v -u {name}:{password} -X GET",
29049 "name": "GetScheduledCalls",
29051 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29052 "version": "0.0.0",
29053 "filename": "server/api/user/index.js",
29054 "groupTitle": "Users"
29058 "url": "/api/users/{id}/screen_recordings",
29059 "title": "GetScreenRecordings",
29062 "title": "Example usage:",
29063 "content": "curl https://{domain}/api/users/{id}/screen_recordings -v -u {name}:{password} -X GET",
29067 "name": "GetScreenRecordings",
29069 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29070 "version": "0.0.0",
29071 "filename": "server/api/user/index.js",
29072 "groupTitle": "Users"
29076 "url": "/api/users/{id}/sms_accounts",
29077 "title": "GetSmsAccounts",
29080 "title": "Example usage:",
29081 "content": "curl https://{domain}/api/users/{id}/sms_accounts -v -u {name}:{password} -X GET",
29085 "name": "GetSmsAccounts",
29087 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29088 "version": "0.0.0",
29089 "filename": "server/api/user/index.js",
29090 "groupTitle": "Users"
29094 "url": "/api/users/{id}/sms/interactions",
29095 "title": "GetSmsInteractions",
29098 "title": "Example usage:",
29099 "content": "curl https://{domain}/api/users/{id}/sms/interactions -v -u {name}:{password} -X GET",
29103 "name": "GetSmsInteractions",
29105 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29106 "version": "0.0.0",
29107 "filename": "server/api/user/index.js",
29108 "groupTitle": "Users"
29112 "url": "/api/users/{id}/square_projects",
29113 "title": "GetSquareProjects",
29116 "title": "Example usage:",
29117 "content": "curl https://{domain}/api/users/{id}/square_projects -v -u {name}:{password} -X GET",
29121 "name": "GetSquareProjects",
29123 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29124 "version": "0.0.0",
29125 "filename": "server/api/user/index.js",
29126 "groupTitle": "Users"
29130 "url": "/api/users/{id}/teams",
29131 "title": "GetTeams",
29134 "title": "Example usage:",
29135 "content": "curl https://{domain}/api/users/{id}/teams -v -u {name}:{password} -X GET",
29139 "name": "GetTeams",
29141 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29142 "version": "0.0.0",
29143 "filename": "server/api/user/index.js",
29144 "groupTitle": "Users"
29148 "url": "/api/users",
29149 "title": "Gets a list of Users",
29152 "title": "Example usage:",
29153 "content": "curl https://{domain}/api/users -v -u {name}:{password}",
29157 "name": "GetUsers",
29159 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
29160 "version": "0.0.0",
29161 "filename": "server/api/user/index.js",
29162 "groupTitle": "Users"
29166 "url": "/api/users/{id}/queues_rt",
29167 "title": "GetVoiceQueuesRt",
29170 "title": "Example usage:",
29171 "content": "curl https://{domain}/api/users/{id}/queues_rt -v -u {name}:{password} -X GET",
29175 "name": "GetVoiceQueuesRt",
29177 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29178 "version": "0.0.0",
29179 "filename": "server/api/user/index.js",
29180 "groupTitle": "Users"
29184 "url": "/api/users/{id}/whatsapp_accounts",
29185 "title": "GetWhatsappAccounts",
29188 "title": "Example usage:",
29189 "content": "curl https://{domain}/api/users/{id}/whatsapp_accounts -v -u {name}:{password} -X GET",
29193 "name": "GetWhatsappAccounts",
29195 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29196 "version": "0.0.0",
29197 "filename": "server/api/user/index.js",
29198 "groupTitle": "Users"
29202 "url": "/api/users/{id}/whatsapp/interactions",
29203 "title": "GetWhatsappInteractions",
29206 "title": "Example usage:",
29207 "content": "curl https://{domain}/api/users/{id}/whatsapp/interactions -v -u {name}:{password} -X GET",
29211 "name": "GetWhatsappInteractions",
29213 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29214 "version": "0.0.0",
29215 "filename": "server/api/user/index.js",
29216 "groupTitle": "Users"
29220 "url": "/api/users/{id}/login",
29224 "title": "Example usage:",
29225 "content": "curl https://{domain}/api/users/{id}/login -v -u {name}:{password} -X POST",
29231 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29232 "version": "0.0.0",
29233 "filename": "server/api/user/index.js",
29234 "groupTitle": "Users"
29238 "url": "/api/users/{id}/logout",
29242 "title": "Example usage:",
29243 "content": "curl https://{domain}/api/users/{id}/logout -v -u {name}:{password} -X POST",
29249 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29250 "version": "0.0.0",
29251 "filename": "server/api/user/index.js",
29252 "groupTitle": "Users"
29256 "url": "/api/users/{id}/pause",
29260 "title": "Example usage:",
29261 "content": "curl https://{domain}/api/users/{id}/pause -v -u {name}:{password} -X POST",
29267 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29268 "version": "0.0.0",
29269 "filename": "server/api/user/index.js",
29270 "groupTitle": "Users"
29274 "url": "/api/users/{id}/api_key",
29275 "title": "Remove API access key for the user",
29278 "title": "Example usage:",
29279 "content": "curl https://{domain}/api/users/:id/api_key -v -u {name}:{password} -X DELETE",
29283 "name": "RemoveApiKey",
29285 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29286 "version": "0.0.0",
29287 "filename": "server/api/user/index.js",
29288 "groupTitle": "Users"
29292 "url": "/api/users/{id}/chat_interactions",
29293 "title": "Removes interactions from an agent",
29296 "title": "Example usage:",
29297 "content": "curl https://{domain}/api/users/{id}/chat_interactions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29301 "name": "RemoveChatInteractions",
29303 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29304 "version": "0.0.0",
29305 "filename": "server/api/user/index.js",
29306 "groupTitle": "Users"
29310 "url": "/api/users/{id}/chat_websites",
29311 "title": "Removes a Chat Website from a user",
29314 "title": "Example usage:",
29315 "content": "curl https://{domain}/api/users/{id}/chat_websites?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29319 "name": "RemoveChatWebsites",
29321 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29322 "version": "0.0.0",
29323 "filename": "server/api/user/index.js",
29324 "groupTitle": "Users"
29328 "url": "/api/users/{id}/fax_accounts",
29329 "title": "Removes a Fax Account from a user",
29332 "title": "Example usage:",
29333 "content": "curl https://{domain}/api/users/{id}/fax_accounts?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29337 "name": "RemoveFaxAccounts",
29339 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29340 "version": "0.0.0",
29341 "filename": "server/api/user/index.js",
29342 "groupTitle": "Users"
29346 "url": "/api/users/{id}/fax_interactions",
29347 "title": "Removes interactions from an agent",
29350 "title": "Example usage:",
29351 "content": "curl https://{domain}/api/users/{id}/fax_interactions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29355 "name": "RemoveFaxInteractions",
29357 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29358 "version": "0.0.0",
29359 "filename": "server/api/user/index.js",
29360 "groupTitle": "Users"
29364 "url": "/api/users/{id}/mail_accounts",
29365 "title": "Removes a Mail Account from a user",
29368 "title": "Example usage:",
29369 "content": "curl https://{domain}/api/users/{id}/mail_accounts?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29373 "name": "RemoveMailAccounts",
29375 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29376 "version": "0.0.0",
29377 "filename": "server/api/user/index.js",
29378 "groupTitle": "Users"
29382 "url": "/api/users/{id}/mail_interactions",
29383 "title": "Removes interactions from an agent",
29386 "title": "Example usage:",
29387 "content": "curl https://{domain}/api/users/{id}/mail_interactions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29391 "name": "RemoveMailInteractions",
29393 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29394 "version": "0.0.0",
29395 "filename": "server/api/user/index.js",
29396 "groupTitle": "Users"
29400 "url": "/api/users/{id}/openchannel_accounts",
29401 "title": "Removes a Open Channel Account from a user",
29404 "title": "Example usage:",
29405 "content": "curl https://{domain}/api/users/{id}/openchannel_accounts?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29409 "name": "RemoveOpenchannelAccounts",
29411 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29412 "version": "0.0.0",
29413 "filename": "server/api/user/index.js",
29414 "groupTitle": "Users"
29418 "url": "/api/users/{id}/openchannel_interactions",
29419 "title": "Removes openchannel interactions from an agent",
29422 "title": "Example usage:",
29423 "content": "curl https://{domain}/api/users/{id}/openchannel_interactions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29427 "name": "RemoveOpenchannelInteractions",
29429 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29430 "version": "0.0.0",
29431 "filename": "server/api/user/index.js",
29432 "groupTitle": "Users"
29436 "url": "/api/users/{id}/queues",
29437 "title": "Remove queues to an agent",
29440 "title": "Example usage:",
29441 "content": "curl https://{domain}/api/users/{id}/queues?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29445 "name": "RemoveQueues",
29447 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29448 "version": "0.0.0",
29449 "filename": "server/api/user/index.js",
29450 "groupTitle": "Users"
29454 "url": "/api/users/{id}/sms_accounts",
29455 "title": "Removes a Sms Account from a user",
29458 "title": "Example usage:",
29459 "content": "curl https://{domain}/api/users/{id}/sms_accounts?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29463 "name": "RemoveSmsAccounts",
29465 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29466 "version": "0.0.0",
29467 "filename": "server/api/user/index.js",
29468 "groupTitle": "Users"
29472 "url": "/api/users/{id}/sms_interactions",
29473 "title": "Removes interactions from an agent",
29476 "title": "Example usage:",
29477 "content": "curl https://{domain}/api/users/{id}/sms_interactions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29481 "name": "RemoveSmsInteractions",
29483 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29484 "version": "0.0.0",
29485 "filename": "server/api/user/index.js",
29486 "groupTitle": "Users"
29490 "url": "/api/users/{id}/square_projects",
29491 "title": "Removes a Square Project from a user",
29494 "title": "Example usage:",
29495 "content": "curl https://{domain}/api/users/{id}/square_projects?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29499 "name": "RemoveSquareProjects",
29501 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29502 "version": "0.0.0",
29503 "filename": "server/api/user/index.js",
29504 "groupTitle": "Users"
29508 "url": "/api/users/{id}/teams",
29509 "title": "Removes teams from an agent",
29512 "title": "Example usage:",
29513 "content": "curl https://{domain}/api/users/{id}/teams?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29517 "name": "RemoveTeams",
29519 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29520 "version": "0.0.0",
29521 "filename": "server/api/user/index.js",
29522 "groupTitle": "Users"
29526 "url": "/api/users/{id}/whatsapp_accounts",
29527 "title": "Removes a Whatsapp Account from a user",
29530 "title": "Example usage:",
29531 "content": "curl https://{domain}/api/users/{id}/whatsapp_accounts?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29535 "name": "RemoveWhatsappAccounts",
29537 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29538 "version": "0.0.0",
29539 "filename": "server/api/user/index.js",
29540 "groupTitle": "Users"
29544 "url": "/api/users/{id}/whatsapp_interactions",
29545 "title": "Removes Whatsapp interactions from an agent",
29548 "title": "Example usage:",
29549 "content": "curl https://{domain}/api/users/{id}/whatsapp_interactions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29553 "name": "RemoveWhatsappInteractions",
29555 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29556 "version": "0.0.0",
29557 "filename": "server/api/user/index.js",
29558 "groupTitle": "Users"
29562 "url": "/api/users/{id}",
29563 "title": "Gets a single User",
29566 "title": "Example usage:",
29567 "content": "curl https://{domain}/api/users/{id} -v -u {name}:{password}",
29571 "name": "ShowUsers",
29573 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29574 "version": "0.0.0",
29575 "filename": "server/api/user/index.js",
29576 "groupTitle": "Users"
29580 "url": "/api/users/{id}/unpause",
29581 "title": "Unpause",
29584 "title": "Example usage:",
29585 "content": "curl https://{domain}/api/users/{id}/unpause -v -u {name}:{password} -X POST",
29591 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29592 "version": "0.0.0",
29593 "filename": "server/api/user/index.js",
29594 "groupTitle": "Users"
29598 "url": "/api/users/whoami",
29602 "title": "Example usage:",
29603 "content": "curl https://{domain}/api/users/whoami -v -u {name}:{password} -X GET",
29609 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29610 "version": "0.0.0",
29611 "filename": "server/api/user/index.js",
29612 "groupTitle": "Users"
29616 "url": "/api/users/{id}/avatar",
29617 "title": "Add avatar",
29620 "title": "Example usage:",
29621 "content": "curl https://{domain}/api/users/{id}/avatar -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
29625 "name": "addAvatar",
29627 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29628 "version": "0.0.0",
29629 "filename": "server/api/user/index.js",
29630 "groupTitle": "Users"
29634 "url": "/api/users/create_many",
29635 "title": "Create Users",
29638 "title": "Example usage:",
29639 "content": "curl https://{domain}/api/users/create_many -d '[{\"name\": \"john.doe\", \"role\": \"user\", \"...\": \"...\"}]' -v -u {name}:{password} -X POST",
29643 "name": "bulkCreate",
29645 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29646 "version": "0.0.0",
29647 "filename": "server/api/user/index.js",
29648 "groupTitle": "Users"
29652 "url": "/api/users/{id}/avatar",
29653 "title": "Get avatar",
29656 "title": "Example usage:",
29657 "content": "curl https://{domain}/api/users/{id}/avatar -v -u {name}:{password} -X GET",
29661 "name": "getAvatar",
29663 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29664 "version": "0.0.0",
29665 "filename": "server/api/user/index.js",
29666 "groupTitle": "Users"
29670 "url": "/api/users/presence",
29671 "title": "Gets agent presence",
29674 "title": "Example usage:",
29675 "content": "curl https://{domain}/api/users/presence -v -u {name}:{password} -X GET",
29679 "name": "getPresence",
29681 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29682 "version": "0.0.0",
29683 "filename": "server/api/user/index.js",
29684 "groupTitle": "Users"
29688 "url": "/api/users/{id}",
29689 "title": "Update an existing User",
29692 "title": "Example usage:",
29693 "content": "curl https://{domain}/api/users/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
29697 "name": "updateUsers",
29699 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29700 "version": "0.0.0",
29701 "filename": "server/api/user/index.js",
29702 "groupTitle": "Users"
29706 "url": "/api/variables",
29707 "title": "Creates a new Variable",
29710 "title": "Example usage:",
29711 "content": "curl https://{domain}/api/variables -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
29715 "name": "CreateVariables",
29716 "group": "Variables",
29731 "field": "description",
29737 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29738 "version": "0.0.0",
29739 "filename": "server/api/variable/index.js",
29740 "groupTitle": "Variables"
29744 "url": "/api/variables/{id}",
29745 "title": "Deletes a Variable",
29748 "title": "Example usage:",
29749 "content": "curl https://{domain}/api/variables/{id} -v -u {name}:{password} -X DELETE",
29753 "name": "DeleteVariables",
29754 "group": "Variables",
29755 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29756 "version": "0.0.0",
29757 "filename": "server/api/variable/index.js",
29758 "groupTitle": "Variables"
29762 "url": "/api/variables",
29763 "title": "Gets a list of Variables",
29766 "title": "Example usage:",
29767 "content": "curl https://{domain}/api/variables -v -u {name}:{password}",
29771 "name": "GetVariables",
29772 "group": "Variables",
29773 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
29774 "version": "0.0.0",
29775 "filename": "server/api/variable/index.js",
29776 "groupTitle": "Variables"
29780 "url": "/api/variables/{id}",
29781 "title": "Gets a single Variable",
29784 "title": "Example usage:",
29785 "content": "curl https://{domain}/api/variables/{id} -v -u {name}:{password}",
29789 "name": "ShowVariables",
29790 "group": "Variables",
29791 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29792 "version": "0.0.0",
29793 "filename": "server/api/variable/index.js",
29794 "groupTitle": "Variables"
29798 "url": "/api/variables/{id}",
29799 "title": "Update an existing Variable",
29802 "title": "Example usage:",
29803 "content": "curl https://{domain}/api/variables/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
29807 "name": "updateVariables",
29808 "group": "Variables",
29809 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29810 "version": "0.0.0",
29811 "filename": "server/api/variable/index.js",
29812 "groupTitle": "Variables"
29816 "url": "/api/version/fetch",
29817 "title": "Fetch git version",
29820 "title": "Example usage:",
29821 "content": "curl https://{domain}/api/version/fetch -v -u {name}:{password}",
29825 "name": "FetchVersion",
29826 "group": "Version",
29827 "description": "<p>Motion run the following command: git fetch origin master</p>",
29828 "version": "0.0.0",
29829 "filename": "server/api/version/index.js",
29830 "groupTitle": "Version"
29834 "url": "/api/version",
29835 "title": "Gets version",
29838 "title": "Example usage:",
29839 "content": "curl https://{domain}/api/version -v -u {name}:{password}",
29843 "name": "GetVersion",
29844 "group": "Version",
29845 "description": "<p>Motion returns the current and latest motion version.</p>",
29846 "version": "0.0.0",
29847 "filename": "server/api/version/index.js",
29848 "groupTitle": "Version"
29852 "url": "/api/version/migrations",
29853 "title": "Launch database migrations",
29856 "title": "Example usage:",
29857 "content": "curl https://{domain}/api/version/migrations -v -u {name}:{password}",
29861 "name": "MigrateVersion",
29862 "group": "Version",
29863 "description": "<p>Motion launch the database migrations, according to the application version</p>",
29864 "version": "0.0.0",
29865 "filename": "server/api/version/index.js",
29866 "groupTitle": "Version"
29870 "url": "/api/version/pull",
29871 "title": "Pull git version",
29874 "title": "Example usage:",
29875 "content": "curl https://{domain}/api/version/pull -v -u {name}:{password}",
29879 "name": "PullVersion",
29880 "group": "Version",
29881 "description": "<p>Motion run the following command: git pull</p>",
29882 "version": "0.0.0",
29883 "filename": "server/api/version/index.js",
29884 "groupTitle": "Version"
29888 "url": "/api/version/reset",
29889 "title": "Reset git version",
29892 "title": "Example usage:",
29893 "content": "curl https://{domain}/api/version/reset -v -u {name}:{password}",
29897 "name": "ResetVersion",
29898 "group": "Version",
29899 "description": "<p>Motion run the following command: git reset --hard FETCH_HEAD</p>",
29900 "version": "0.0.0",
29901 "filename": "server/api/version/index.js",
29902 "groupTitle": "Version"
29906 "url": "/api/version/restart",
29907 "title": "Restart motion2 after update",
29910 "title": "Example usage:",
29911 "content": "curl https://{domain}/api/version/restart -v -u {name}:{password}",
29915 "name": "RestartVersion",
29916 "group": "Version",
29917 "description": "<p>Motion run the following command: pm2 restart motion</p>",
29918 "version": "0.0.0",
29919 "filename": "server/api/version/index.js",
29920 "groupTitle": "Version"
29924 "url": "/api/voice/agents/reports/describe",
29925 "title": "Gets table info about Agent Reports",
29928 "title": "Example usage:",
29929 "content": "curl https://{domain}/api/voice/agents/reports/describe -v -u {name}:{password}",
29933 "name": "DescribeAgent_Reports",
29934 "group": "Voice_Agent_Reports",
29935 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29936 "version": "0.0.0",
29937 "filename": "server/api/voiceAgentReport/index.js",
29938 "groupTitle": "Voice_Agent_Reports"
29942 "url": "/api/voice/agents/reports",
29943 "title": "Gets a list of Agent Reports",
29946 "title": "Example usage:",
29947 "content": "curl https://{domain}/api/voice/agents/reports -v -u {name}:{password}",
29951 "name": "GetAgent_Reports",
29952 "group": "Voice_Agent_Reports",
29953 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
29954 "version": "0.0.0",
29955 "filename": "server/api/voiceAgentReport/index.js",
29956 "groupTitle": "Voice_Agent_Reports"
29960 "url": "/api/voice/agents/reports/{id}",
29961 "title": "Gets a single Agent Report",
29964 "title": "Example usage:",
29965 "content": "curl https://{domain}/api/voice/agents/reports/{id} -v -u {name}:{password}",
29969 "name": "ShowAgent_Reports",
29970 "group": "Voice_Agent_Reports",
29971 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29972 "version": "0.0.0",
29973 "filename": "server/api/voiceAgentReport/index.js",
29974 "groupTitle": "Voice_Agent_Reports"
29978 "url": "/api/voice/calls/reports/describe",
29979 "title": "Gets table info about Call Reports",
29982 "title": "Example usage:",
29983 "content": "curl https://{domain}/api/voice/calls/reports/describe -v -u {name}:{password}",
29987 "name": "DescribeCall_Reports",
29988 "group": "Voice_Call_Reports",
29989 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29990 "version": "0.0.0",
29991 "filename": "server/api/voiceCallReport/index.js",
29992 "groupTitle": "Voice_Call_Reports"
29996 "url": "/api/voice/calls/reports",
29997 "title": "Gets a list of Call Reports",
30000 "title": "Example usage:",
30001 "content": "curl https://{domain}/api/voice/calls/reports -v -u {name}:{password}",
30005 "name": "GetCall_Reports",
30006 "group": "Voice_Call_Reports",
30007 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
30008 "version": "0.0.0",
30009 "filename": "server/api/voiceCallReport/index.js",
30010 "groupTitle": "Voice_Call_Reports"
30014 "url": "/api/voice/calls/reports/{id}",
30015 "title": "Gets a single Call Report",
30018 "title": "Example usage:",
30019 "content": "curl https://{domain}/api/voice/calls/reports/{id} -v -u {name}:{password}",
30023 "name": "ShowCall_Reports",
30024 "group": "Voice_Call_Reports",
30025 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30026 "version": "0.0.0",
30027 "filename": "server/api/voiceCallReport/index.js",
30028 "groupTitle": "Voice_Call_Reports"
30032 "url": "/api/voice/calls/reports/{id}",
30033 "title": "Update a single cdr",
30036 "title": "Example usage:",
30037 "content": "curl https://{domain}/api/voice/calls/reports/{id} -d '{\"userDispositio\": \"OK\"}' -v -u {name}:{password} -X PUT",
30042 "group": "Voice_Call_Reports",
30043 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30044 "version": "0.0.0",
30045 "filename": "server/api/voiceCallReport/index.js",
30046 "groupTitle": "Voice_Call_Reports"
30050 "url": "/api/voice/chanspy",
30051 "title": "Creates a new ChanSpy",
30054 "title": "Example usage:",
30055 "content": "curl https://{domain}/api/voice/chanspy -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
30059 "name": "CreateChanSpy",
30060 "group": "Voice_ChanSpy",
30082 "field": "options",
30096 "field": "password",
30110 "field": "recordingFormat",
30117 "field": "description",
30123 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30124 "version": "0.0.0",
30125 "filename": "server/api/voiceChanSpy/index.js",
30126 "groupTitle": "Voice_ChanSpy"
30130 "url": "/api/voice/chanspy/{id}",
30131 "title": "Deletes a ChanSpy",
30134 "title": "Example usage:",
30135 "content": "curl https://{domain}/api/voice/chanspy/{id} -v -u {name}:{password} -X DELETE",
30139 "name": "DeleteChanSpy",
30140 "group": "Voice_ChanSpy",
30141 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30142 "version": "0.0.0",
30143 "filename": "server/api/voiceChanSpy/index.js",
30144 "groupTitle": "Voice_ChanSpy"
30148 "url": "/api/voice/chanspy",
30149 "title": "Gets a list of ChanSpy",
30152 "title": "Example usage:",
30153 "content": "curl https://{domain}/api/voice/chanspy -v -u {name}:{password}",
30157 "name": "GetChanSpy",
30158 "group": "Voice_ChanSpy",
30159 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
30160 "version": "0.0.0",
30161 "filename": "server/api/voiceChanSpy/index.js",
30162 "groupTitle": "Voice_ChanSpy"
30166 "url": "/api/voice/chanspy/{id}",
30167 "title": "Gets a single ChanSpy",
30170 "title": "Example usage:",
30171 "content": "curl https://{domain}/api/voice/chanspy/{id} -v -u {name}:{password}",
30175 "name": "ShowChanSpy",
30176 "group": "Voice_ChanSpy",
30177 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30178 "version": "0.0.0",
30179 "filename": "server/api/voiceChanSpy/index.js",
30180 "groupTitle": "Voice_ChanSpy"
30184 "url": "/api/voice/chanspy/{id}",
30185 "title": "Update an existing ChanSpy",
30188 "title": "Example usage:",
30189 "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",
30193 "name": "updateChanSpy",
30194 "group": "Voice_ChanSpy",
30195 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30196 "version": "0.0.0",
30197 "filename": "server/api/voiceChanSpy/index.js",
30198 "groupTitle": "Voice_ChanSpy"
30202 "url": "/api/voice/contexts",
30203 "title": "Create a new context",
30206 "title": "Example usage:",
30207 "content": "curl https://{domain}/api/voice/contexts -v -u {name}:{password} -X POST",
30212 "group": "Voice_Contexts",
30227 "field": "description",
30234 "field": "defaultEntry",
30240 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30241 "version": "0.0.0",
30242 "filename": "server/api/voiceContext/index.js",
30243 "groupTitle": "Voice_Contexts"
30247 "url": "/api/voice/contexts/{id}",
30248 "title": "Deletes a context",
30251 "title": "Example usage:",
30252 "content": "curl https://{domain}/api/voice/contexts/{id} -v -u {name}:{password} -X DELETE",
30257 "group": "Voice_Contexts",
30258 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30259 "version": "0.0.0",
30260 "filename": "server/api/voiceContext/index.js",
30261 "groupTitle": "Voice_Contexts"
30265 "url": "/api/voice/contexts",
30266 "title": "Gets a list of Contexts",
30269 "title": "Example usage:",
30270 "content": "curl https://{domain}/api/voice/contexts -v -u {name}:{password}",
30274 "name": "GetContexts",
30275 "group": "Voice_Contexts",
30276 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
30277 "version": "0.0.0",
30278 "filename": "server/api/voiceContext/index.js",
30279 "groupTitle": "Voice_Contexts"
30283 "url": "/api/voice/contexts/{id}",
30284 "title": "Gets a single Context",
30287 "title": "Example usage:",
30288 "content": "curl https://{domain}/api/voice/contexts/{id} -v -u {name}:{password}",
30292 "name": "ShowContexts",
30293 "group": "Voice_Contexts",
30294 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30295 "version": "0.0.0",
30296 "filename": "server/api/voiceContext/index.js",
30297 "groupTitle": "Voice_Contexts"
30301 "url": "/api/voice/contexts/{id}",
30302 "title": "Update an existing context",
30305 "title": "Example usage:",
30306 "content": "curl https://{domain}/api/voice/contexts/{id} -v -u {name}:{password} -X PUT",
30311 "group": "Voice_Contexts",
30312 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30313 "version": "0.0.0",
30314 "filename": "server/api/voiceContext/index.js",
30315 "groupTitle": "Voice_Contexts"
30319 "url": "/api/voice/dials/reports/describe",
30320 "title": "Gets table info about Dial Reports",
30323 "title": "Example usage:",
30324 "content": "curl https://{domain}/api/voice/dials/reports/describe -v -u {name}:{password}",
30328 "name": "DescribeDial_Reports",
30329 "group": "Voice_Dial_Reports",
30330 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30331 "version": "0.0.0",
30332 "filename": "server/api/voiceDialReport/index.js",
30333 "groupTitle": "Voice_Dial_Reports"
30337 "url": "/api/voice/dials/reports",
30338 "title": "Gets a list of Dial Reports",
30341 "title": "Example usage:",
30342 "content": "curl https://{domain}/api/voice/dials/reports -v -u {name}:{password}",
30346 "name": "GetDial_Reports",
30347 "group": "Voice_Dial_Reports",
30348 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
30349 "version": "0.0.0",
30350 "filename": "server/api/voiceDialReport/index.js",
30351 "groupTitle": "Voice_Dial_Reports"
30355 "url": "/api/voice/dials/reports/{id}",
30356 "title": "Gets a single Dial Report",
30359 "title": "Example usage:",
30360 "content": "curl https://{domain}/api/voice/dials/reports/{id} -v -u {name}:{password}",
30364 "name": "ShowDial_Reports",
30365 "group": "Voice_Dial_Reports",
30366 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30367 "version": "0.0.0",
30368 "filename": "server/api/voiceDialReport/index.js",
30369 "groupTitle": "Voice_Dial_Reports"
30373 "url": "/api/voice/extensions/{id}",
30374 "title": "Deletes a Extension",
30377 "title": "Example usage:",
30378 "content": "curl https://{domain}/api/voice/extensions/{id} -v -u {name}:{password} -X DELETE",
30382 "name": "DeleteExtensions",
30383 "group": "Voice_Extensions",
30384 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30385 "version": "0.0.0",
30386 "filename": "server/api/voiceExtension/index.js",
30387 "groupTitle": "Voice_Extensions"
30391 "url": "/api/voice/extensions",
30392 "title": "Gets a list of Extensions",
30395 "title": "Example usage:",
30396 "content": "curl https://{domain}/api/voice/extensions -v -u {name}:{password}",
30400 "name": "GetExtensions",
30401 "group": "Voice_Extensions",
30402 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
30403 "version": "0.0.0",
30404 "filename": "server/api/voiceExtension/index.js",
30405 "groupTitle": "Voice_Extensions"
30409 "url": "/api/voice/extensions/{id}",
30410 "title": "Gets a single Extension",
30413 "title": "Example usage:",
30414 "content": "curl https://{domain}/api/voice/extensions/{id} -v -u {name}:{password}",
30418 "name": "ShowExtensions",
30419 "group": "Voice_Extensions",
30420 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30421 "version": "0.0.0",
30422 "filename": "server/api/voiceExtension/index.js",
30423 "groupTitle": "Voice_Extensions"
30427 "url": "/api/voice/extensions",
30428 "title": "Create new applications",
30431 "title": "Example usage:",
30432 "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",
30436 "name": "addApplications",
30437 "group": "Voice_Extensions",
30438 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30439 "version": "0.0.0",
30440 "filename": "server/api/voiceExtension/index.js",
30441 "groupTitle": "Voice_Extensions"
30445 "url": "/api/voice/extensions",
30446 "title": "Create an extension",
30449 "title": "Example usage:",
30450 "content": "curl https://{domain}/api/voice/extensions -d '{\"exten\": \"12345\", \"context\": \"from-custom\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
30455 "group": "Voice_Extensions",
30456 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30457 "version": "0.0.0",
30458 "filename": "server/api/voiceExtension/index.js",
30459 "groupTitle": "Voice_Extensions"
30463 "url": "/api/voice/extensions/{id}",
30464 "title": "Update an extension",
30467 "title": "Example usage:",
30468 "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",
30473 "group": "Voice_Extensions",
30474 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30475 "version": "0.0.0",
30476 "filename": "server/api/voiceExtension/index.js",
30477 "groupTitle": "Voice_Extensions"
30481 "url": "/api/voice/mohs",
30482 "title": "Create a new a new MOH",
30485 "title": "Example usage:",
30486 "content": "curl https://{domain}/api/voice/mohs -d '{\"name\": \"xmas_musics\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
30491 "group": "Voice_MOHs",
30492 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30493 "version": "0.0.0",
30494 "filename": "server/api/voiceMusicOnHold/index.js",
30495 "groupTitle": "Voice_MOHs"
30499 "url": "/api/voice/mohs/{id}/sounds",
30500 "title": "Add sound to MOH",
30503 "title": "Example usage:",
30504 "content": "curl https://{domain}/api/voice/mohs/{id}/sounds -d '{\"id\": 1}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
30508 "name": "AddSound",
30509 "group": "Voice_MOHs",
30510 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30511 "version": "0.0.0",
30512 "filename": "server/api/voiceMusicOnHold/index.js",
30513 "groupTitle": "Voice_MOHs"
30517 "url": "/api/voice/mohs/{id}",
30518 "title": "Deletes an MOH",
30521 "title": "Example usage:",
30522 "content": "curl https://{domain}/api/voice/mohs/{id} -v -u {name}:{password} -X DELETE",
30526 "name": "DestroyMoh",
30527 "group": "Voice_MOHs",
30528 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30529 "version": "0.0.0",
30530 "filename": "server/api/voiceMusicOnHold/index.js",
30531 "groupTitle": "Voice_MOHs"
30535 "url": "/api/voice/mohs",
30536 "title": "Gets a list of Music On Holds",
30539 "title": "Example usage:",
30540 "content": "curl https://{domain}/api/voice/mohs -v -u {name}:{password}",
30544 "name": "GetMusic_On_Holds",
30545 "group": "Voice_MOHs",
30546 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
30547 "version": "0.0.0",
30548 "filename": "server/api/voiceMusicOnHold/index.js",
30549 "groupTitle": "Voice_MOHs"
30553 "url": "/api/voice/mohs/{id}/sounds",
30554 "title": "Gets sounds from MOH",
30557 "title": "Example usage:",
30558 "content": "curl https://{domain}/api/voice/mohs/{id}/sounds -v -u {name}:{password} -X DELETE",
30562 "name": "GetSounds",
30563 "group": "Voice_MOHs",
30564 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30565 "version": "0.0.0",
30566 "filename": "server/api/voiceMusicOnHold/index.js",
30567 "groupTitle": "Voice_MOHs"
30571 "url": "/api/voice/mohs/{id}/sounds/{id2}",
30572 "title": "Remove sound from MOH",
30575 "title": "Example usage:",
30576 "content": "curl https://{domain}/api/voice/mohs/{id}/sounds/{id2} -v -u {name}:{password} -X DELETE",
30580 "name": "RemoveSound",
30581 "group": "Voice_MOHs",
30582 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30583 "version": "0.0.0",
30584 "filename": "server/api/voiceMusicOnHold/index.js",
30585 "groupTitle": "Voice_MOHs"
30589 "url": "/api/voice/mohs/{id}",
30590 "title": "Gets a single Music On Hold",
30593 "title": "Example usage:",
30594 "content": "curl https://{domain}/api/voice/mohs/{id} -v -u {name}:{password}",
30598 "name": "ShowMusic_On_Holds",
30599 "group": "Voice_MOHs",
30600 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30601 "version": "0.0.0",
30602 "filename": "server/api/voiceMusicOnHold/index.js",
30603 "groupTitle": "Voice_MOHs"
30607 "url": "/api/voice/mohs/{id}",
30608 "title": "Update an existing Music On Hold",
30611 "title": "Example usage:",
30612 "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",
30616 "name": "updateMusic_On_Holds",
30617 "group": "Voice_MOHs",
30618 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30619 "version": "0.0.0",
30620 "filename": "server/api/voiceMusicOnHold/index.js",
30621 "groupTitle": "Voice_MOHs"
30625 "url": "/api/voice/mails",
30626 "title": "Creates a new Mail",
30629 "title": "Example usage:",
30630 "content": "curl https://{domain}/api/voice/mails -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
30634 "name": "CreateMails",
30635 "group": "Voice_Mails",
30643 "field": "customer_id",
30650 "field": "context",
30657 "field": "mailbox",
30664 "field": "password",
30671 "field": "fullname",
30721 "field": "dialout",
30728 "field": "callback",
30750 "field": "operator",
30761 "field": "envelope",
30772 "field": "sayduration",
30779 "field": "saydurationm",
30790 "field": "sendvoicemail",
30812 "field": "nextaftercmd",
30823 "field": "forcename",
30834 "field": "forcegreetings",
30845 "field": "hidefromdir",
30859 "field": "emailsubject",
30866 "field": "emailbody",
30873 "field": "maxsecs",
30893 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30894 "version": "0.0.0",
30895 "filename": "server/api/voiceMail/index.js",
30896 "groupTitle": "Voice_Mails"
30900 "url": "/api/voice/mails/{id}",
30901 "title": "Deletes a Mail",
30904 "title": "Example usage:",
30905 "content": "curl https://{domain}/api/voice/mails/{id} -v -u {name}:{password} -X DELETE",
30909 "name": "DeleteMails",
30910 "group": "Voice_Mails",
30911 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30912 "version": "0.0.0",
30913 "filename": "server/api/voiceMail/index.js",
30914 "groupTitle": "Voice_Mails"
30918 "url": "/api/voice/mails",
30919 "title": "Gets a list of Mails",
30922 "title": "Example usage:",
30923 "content": "curl https://{domain}/api/voice/mails -v -u {name}:{password}",
30927 "name": "GetMails",
30928 "group": "Voice_Mails",
30929 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
30930 "version": "0.0.0",
30931 "filename": "server/api/voiceMail/index.js",
30932 "groupTitle": "Voice_Mails"
30936 "url": "/api/voice/mails/{id}",
30937 "title": "Gets a single Mail",
30940 "title": "Example usage:",
30941 "content": "curl https://{domain}/api/voice/mails/{id} -v -u {name}:{password}",
30945 "name": "ShowMails",
30946 "group": "Voice_Mails",
30947 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30948 "version": "0.0.0",
30949 "filename": "server/api/voiceMail/index.js",
30950 "groupTitle": "Voice_Mails"
30954 "url": "/api/voice/mails/{id}/messages",
30955 "title": "Gets voice mail messages",
30958 "title": "Example usage:",
30959 "content": "curl https://{domain}/api/voice/mails/{id}/messages -v -u {name}:{password} -X GET",
30963 "name": "getMessages",
30964 "group": "Voice_Mails",
30965 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30966 "version": "0.0.0",
30967 "filename": "server/api/voiceMail/index.js",
30968 "groupTitle": "Voice_Mails"
30972 "url": "/api/voice/mails/{id}",
30973 "title": "Update an existing Mail",
30976 "title": "Example usage:",
30977 "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",
30981 "name": "updateMails",
30982 "group": "Voice_Mails",
30983 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30984 "version": "0.0.0",
30985 "filename": "server/api/voiceMail/index.js",
30986 "groupTitle": "Voice_Mails"
30990 "url": "/api/voice/mails/messages",
30991 "title": "Creates a new Message",
30994 "title": "Example usage:",
30995 "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",
30999 "name": "CreateMessages",
31000 "group": "Voice_Messages",
31029 "field": "context",
31036 "field": "macrocontext",
31043 "field": "callerid",
31050 "field": "origtime",
31057 "field": "duration",
31064 "field": "mailboxuser",
31071 "field": "mailboxcontext",
31078 "field": "recording",
31105 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31106 "version": "0.0.0",
31107 "filename": "server/api/voiceMailMessage/index.js",
31108 "groupTitle": "Voice_Messages"
31112 "url": "/api/voice/mails/messages/{id}",
31113 "title": "Deletes a Message",
31116 "title": "Example usage:",
31117 "content": "curl https://{domain}/api/voice/mails/messages/{id} -v -u {name}:{password} -X DELETE",
31121 "name": "DeleteMessages",
31122 "group": "Voice_Messages",
31123 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31124 "version": "0.0.0",
31125 "filename": "server/api/voiceMailMessage/index.js",
31126 "groupTitle": "Voice_Messages"
31130 "url": "/api/voice/mails/messages",
31131 "title": "Gets a list of Messages",
31134 "title": "Example usage:",
31135 "content": "curl https://{domain}/api/voice/mails/messages -v -u {name}:{password}",
31139 "name": "GetMessages",
31140 "group": "Voice_Messages",
31141 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
31142 "version": "0.0.0",
31143 "filename": "server/api/voiceMailMessage/index.js",
31144 "groupTitle": "Voice_Messages"
31148 "url": "/api/voice/mails/messages/{id}",
31149 "title": "Gets a single Message",
31152 "title": "Example usage:",
31153 "content": "curl https://{domain}/api/voice/mails/messages/{id} -v -u {name}:{password}",
31157 "name": "ShowMessages",
31158 "group": "Voice_Messages",
31159 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31160 "version": "0.0.0",
31161 "filename": "server/api/voiceMailMessage/index.js",
31162 "groupTitle": "Voice_Messages"
31166 "url": "voice/mails/messages/{id}/download",
31167 "title": "Download Voice Message",
31170 "title": "Example usage:",
31171 "content": "curl https://{domain}voice/mails/messages/{id}/download -v -u {name}:{password} -X GET",
31175 "name": "download",
31176 "group": "Voice_Messages",
31177 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31178 "version": "0.0.0",
31179 "filename": "server/api/voiceMailMessage/index.js",
31180 "groupTitle": "Voice_Messages"
31184 "url": "/api/voice/mails/messages/{id}",
31185 "title": "Update an existing Message",
31188 "title": "Example usage:",
31189 "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",
31193 "name": "updateMessages",
31194 "group": "Voice_Messages",
31195 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31196 "version": "0.0.0",
31197 "filename": "server/api/voiceMailMessage/index.js",
31198 "groupTitle": "Voice_Messages"
31202 "url": "/api/voice/prefixes/{id}/users",
31203 "title": "Add agents to a prefix",
31206 "title": "Example usage:",
31207 "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",
31211 "name": "AddAgents",
31212 "group": "Voice_Prefixes",
31213 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31214 "version": "0.0.0",
31215 "filename": "server/api/voicePrefix/index.js",
31216 "groupTitle": "Voice_Prefixes"
31220 "url": "/api/voice/prefixes/{id}",
31221 "title": "Deletes a Prefix",
31224 "title": "Example usage:",
31225 "content": "curl https://{domain}/api/voice/prefixes/{id} -v -u {name}:{password} -X DELETE",
31229 "name": "DeletePrefixes",
31230 "group": "Voice_Prefixes",
31231 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31232 "version": "0.0.0",
31233 "filename": "server/api/voicePrefix/index.js",
31234 "groupTitle": "Voice_Prefixes"
31238 "url": "/api/voice/prefixes/describe",
31239 "title": "Gets table info about Prefixes",
31242 "title": "Example usage:",
31243 "content": "curl https://{domain}/api/voice/prefixes/describe -v -u {name}:{password}",
31247 "name": "DescribePrefixes",
31248 "group": "Voice_Prefixes",
31249 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31250 "version": "0.0.0",
31251 "filename": "server/api/voicePrefix/index.js",
31252 "groupTitle": "Voice_Prefixes"
31256 "url": "/api/voice/prefixes/{id}/users",
31257 "title": "Gets agents from prefix",
31260 "title": "Example usage:",
31261 "content": "curl https://{domain}/api/voice/prefixes/{id}/users -v -u {name}:{password} -X GET",
31265 "name": "GetAgents",
31266 "group": "Voice_Prefixes",
31267 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31268 "version": "0.0.0",
31269 "filename": "server/api/voicePrefix/index.js",
31270 "groupTitle": "Voice_Prefixes"
31274 "url": "/api/voice/prefixes",
31275 "title": "Gets a list of Prefixes",
31278 "title": "Example usage:",
31279 "content": "curl https://{domain}/api/voice/prefixes -v -u {name}:{password}",
31283 "name": "GetPrefixes",
31284 "group": "Voice_Prefixes",
31285 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
31286 "version": "0.0.0",
31287 "filename": "server/api/voicePrefix/index.js",
31288 "groupTitle": "Voice_Prefixes"
31292 "url": "/api/voice/prefixes/{id}/users",
31293 "title": "Removes agents from a prefix",
31296 "title": "Example usage:",
31297 "content": "curl https://{domain}/api/voice/prefixes/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
31301 "name": "RemoveAgents",
31302 "group": "Voice_Prefixes",
31303 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31304 "version": "0.0.0",
31305 "filename": "server/api/voicePrefix/index.js",
31306 "groupTitle": "Voice_Prefixes"
31310 "url": "/api/voice/prefixes/{id}",
31311 "title": "Gets a single Prefix",
31314 "title": "Example usage:",
31315 "content": "curl https://{domain}/api/voice/prefixes/{id} -v -u {name}:{password}",
31319 "name": "ShowPrefixes",
31320 "group": "Voice_Prefixes",
31321 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31322 "version": "0.0.0",
31323 "filename": "server/api/voicePrefix/index.js",
31324 "groupTitle": "Voice_Prefixes"
31328 "url": "/api/voice/prefixes/{id}",
31329 "title": "Update an existing prefix",
31332 "title": "Example usage:",
31333 "content": "curl https://{domain}/api/voice/prefixes/{id} -v -u {name}:{password} -X PUT",
31338 "group": "Voice_Prefixes",
31339 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31340 "version": "0.0.0",
31341 "filename": "server/api/voicePrefix/index.js",
31342 "groupTitle": "Voice_Prefixes"
31346 "url": "/api/voice/prefixes",
31347 "title": "Create a prefix",
31350 "title": "Example usage:",
31351 "content": "curl https://{domain}/api/voice/prefixes -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
31356 "group": "Voice_Prefixes",
31357 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31358 "version": "0.0.0",
31359 "filename": "server/api/voicePrefix/index.js",
31360 "groupTitle": "Voice_Prefixes"
31364 "url": "/api/voice/queues/reports/describe",
31365 "title": "Gets table info about Queue Reports",
31368 "title": "Example usage:",
31369 "content": "curl https://{domain}/api/voice/queues/reports/describe -v -u {name}:{password}",
31373 "name": "DescribeQueue_Reports",
31374 "group": "Voice_Queue_Reports",
31375 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31376 "version": "0.0.0",
31377 "filename": "server/api/voiceQueueReport/index.js",
31378 "groupTitle": "Voice_Queue_Reports"
31382 "url": "/api/voice/queues/reports",
31383 "title": "Gets a list of Queue Reports",
31386 "title": "Example usage:",
31387 "content": "curl https://{domain}/api/voice/queues/reports -v -u {name}:{password}",
31391 "name": "GetQueue_Reports",
31392 "group": "Voice_Queue_Reports",
31393 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
31394 "version": "0.0.0",
31395 "filename": "server/api/voiceQueueReport/index.js",
31396 "groupTitle": "Voice_Queue_Reports"
31400 "url": "/api/voice/queues/reports/{id}",
31401 "title": "Gets a single Queue Report",
31404 "title": "Example usage:",
31405 "content": "curl https://{domain}/api/voice/queues/reports/{id} -v -u {name}:{password}",
31409 "name": "ShowQueue_Reports",
31410 "group": "Voice_Queue_Reports",
31411 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31412 "version": "0.0.0",
31413 "filename": "server/api/voiceQueueReport/index.js",
31414 "groupTitle": "Voice_Queue_Reports"
31418 "url": "/api/voice/queues/reports/index",
31419 "title": "Get Voice Queues Report",
31422 "title": "Example usage:",
31423 "content": "curl https://{domain}/api/voice/queues/reports/index -v -u {name}:{password} -X GET",
31427 "name": "getVoiceQueuesReport",
31428 "group": "Voice_Queue_Reports",
31429 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31430 "version": "0.0.0",
31431 "filename": "server/api/voiceQueueReport/index.js",
31432 "groupTitle": "Voice_Queue_Reports"
31436 "url": "/api/voice/queues/{id}/users",
31437 "title": "Add agents to queue",
31440 "title": "Example usage:",
31441 "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",
31445 "name": "AddAgents",
31446 "group": "Voice_Queues",
31447 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31448 "version": "0.0.0",
31449 "filename": "server/api/voiceQueue/index.js",
31450 "groupTitle": "Voice_Queues"
31454 "url": "/api/voice/queues/{id}/blacklists",
31455 "title": "Add blacklists to a queue",
31458 "title": "Example usage:",
31459 "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",
31463 "name": "AddBlackLists",
31464 "group": "Voice_Queues",
31465 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31466 "version": "0.0.0",
31467 "filename": "server/api/voiceQueue/index.js",
31468 "groupTitle": "Voice_Queues"
31472 "url": "/api/voice/queues/{id}/lists",
31473 "title": "Add lists to a queue",
31476 "title": "Example usage:",
31477 "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",
31481 "name": "AddLists",
31482 "group": "Voice_Queues",
31483 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31484 "version": "0.0.0",
31485 "filename": "server/api/voiceQueue/index.js",
31486 "groupTitle": "Voice_Queues"
31490 "url": "/api/voice/queues/{id}/teams",
31491 "title": "Add teams to queue",
31494 "title": "Example usage:",
31495 "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",
31499 "name": "AddTeams",
31500 "group": "Voice_Queues",
31501 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31502 "version": "0.0.0",
31503 "filename": "server/api/voiceQueue/index.js",
31504 "groupTitle": "Voice_Queues"
31508 "url": "/api/voice/queues/clone",
31509 "title": "Clone an existing Queue",
31512 "title": "Example usage:",
31513 "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",
31517 "name": "CloneQueues",
31518 "group": "Voice_Queues",
31519 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31520 "version": "0.0.0",
31521 "filename": "server/api/voiceQueue/index.js",
31522 "groupTitle": "Voice_Queues"
31526 "url": "/api/voice/queues",
31527 "title": "Creates a new Queue",
31530 "title": "Example usage:",
31531 "content": "curl https://{domain}/api/voice/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
31535 "name": "CreateQueues",
31536 "group": "Voice_Queues",
31562 "field": "musiconhold",
31569 "field": "announce",
31587 "field": "strategy",
31594 "field": "servicelevel",
31601 "field": "context",
31608 "field": "penaltymemberslimit",
31615 "field": "timeout",
31629 "field": "timeoutpriority",
31643 "field": "wrapuptime",
31654 "field": "autofill",
31666 "field": "autopause",
31673 "field": "autopausedelay",
31684 "field": "autopausebusy",
31695 "field": "autopauseunavail",
31713 "field": "setinterfacevar",
31724 "field": "setqueueentryvar",
31735 "field": "setqueuevar",
31746 "field": "eventmemberstatus",
31753 "field": "membermacro",
31760 "field": "membergosub",
31767 "field": "announce_frequency",
31774 "field": "min_announce_frequency",
31781 "field": "periodic_announce_frequency",
31792 "field": "random_periodic_announce",
31803 "field": "relative_periodic_announce",
31815 "field": "announce_holdtime",
31822 "field": "announce_position",
31833 "field": "announce_to_first_user",
31840 "field": "announce_position_limit",
31855 "field": "announce_round_seconds",
31862 "field": "monitor_format",
31869 "field": "monitor_type",
31876 "field": "queue_youarenext",
31883 "field": "queue_thereare",
31890 "field": "queue_callswaiting",
31897 "field": "queue_holdtime",
31904 "field": "queue_minute",
31911 "field": "queue_minutes",
31918 "field": "queue_seconds",
31925 "field": "queue_thankyou",
31932 "field": "queue_reporthold",
31939 "field": "queue_quantity1",
31946 "field": "queue_quantity2",
31953 "field": "queue_periodic_announce",
31960 "field": "queue_less_than",
31967 "field": "periodic_announce",
31974 "field": "joinempty",
31981 "field": "leavewhenempty",
31992 "field": "reportholdtime",
32003 "field": "ringinuse",
32010 "field": "memberdelay",
32021 "field": "timeoutrestart",
32028 "field": "defaultrule",
32035 "field": "description",
32049 "field": "acwTimeout",
32056 "field": "dialActive",
32057 "description": "<p>Active/Disactive Campaign</p>"
32070 "field": "dialMethod",
32071 "description": "<p>Dial Method.</p>"
32077 "field": "dialLimitChannel",
32078 "description": "<p>Max 9999 channels, 0 means unlimited.</p>"
32084 "field": "dialLimitQueue",
32085 "description": "<p>Max 9999 member in queue(min:1, max:9999), 0 means unlimited.</p>"
32091 "field": "dialPowerLevel",
32092 "description": "<p>Power Level: Calls for agents (min:1, max:10).</p>"
32098 "\"agentBusyFactor\"",
32102 "field": "dialPredictiveOptimization",
32103 "description": "<p>Only for predictive method.</p>"
32109 "field": "dialPredictiveOptimizationPercentage",
32110 "description": "<p>Predictive Optimization Percentage (min: 1, max: 95)</p>"
32116 "field": "dialPredictiveInterval",
32117 "description": "<p>Interval Predictive Minutes (min:5 max:30)</p>"
32123 "field": "dialOriginateCallerIdName",
32130 "field": "dialOriginateCallerIdNumber",
32137 "field": "dialOriginateTimeout",
32138 "description": "<p>Originate Timeout Seconds (min:1, max:999)</p>"
32144 "field": "dialQueueOptions",
32145 "description": "<p>https://wiki.asterisk.org/wiki/display/AST/Asterisk+13+Application_Queue</p>"
32151 "field": "dialQueueTimeout",
32152 "description": "<p>Queue Timeout Seconds (min:1, max:999)</p>"
32158 "field": "dialQueueProject",
32159 "description": "<p>AGI queue option (use: agi://127.0.0.1/square,<project_name>)</p>"
32165 "field": "dialCongestionMaxRetry",
32166 "description": "<p>#Congestion Retry (min:1, max:999)</p>"
32172 "field": "dialCongestionRetryFrequency",
32173 "description": "<p>Congestion Retry Frequency Minutes (min:1, max:99999)</p>"
32179 "field": "dialBusyMaxRetry",
32180 "description": "<p>#Busy Retry (min:1, max:999)</p>"
32186 "field": "dialBusyRetryFrequency",
32187 "description": "<p>Busy Retry Frequency Minutes (min:1, max:99999)</p>"
32193 "field": "dialNoAnswerMaxRetry",
32194 "description": "<p>#NoAnswer Retry (min:1, max:999)</p>"
32200 "field": "dialNoAnswerRetryFrequency",
32201 "description": "<p>NoAnswer Retry Frequency Minutes (min:1, max:99999)</p>"
32207 "field": "dialGlobalMaxRetry",
32208 "description": "<p>#Global Max Retry (min:1, max:999)</p>"
32214 "field": "dialTimezone",
32221 "field": "dialGlobalInterval",
32228 "field": "dialPrefix",
32240 "field": "dialCheckDuplicateType",
32247 "field": "dialAMDActive",
32248 "description": "<p>Active/Disactive AMD</p>"
32254 "field": "dialAMDInitialSilence",
32255 "description": "<p>#AMD Initial Silence</p>"
32261 "field": "dialAMDGreeting",
32262 "description": "<p>#AMD Greeting</p>"
32268 "field": "dialAMDAfterGreetingSilence",
32269 "description": "<p>#AMD After Greeting Silence</p>"
32275 "field": "dialAMDTotalAnalysisTime",
32276 "description": "<p>#AMD Total Analysis Time</p>"
32282 "field": "dialAMDMinWordLength",
32283 "description": "<p>#AMD Min Word Length</p>"
32289 "field": "dialAMDBetweenWordsSilence",
32290 "description": "<p>#AMD Between Words Silence</p>"
32296 "field": "dialAMDMaximumNumberOfWords",
32297 "description": "<p>#AMD Maximum Number Of Words</p>"
32303 "field": "dialAMDSilenceThreshold",
32304 "description": "<p>#AMD Silence Threshold (min:0, max:32767)</p>"
32310 "field": "dialAMDMaximumWordLength",
32311 "description": "<p>#AMD Maximum Word Length</p>"
32317 "field": "dialRecallMeTimeout",
32318 "description": "<p>#RecallMe Timeout (min:1)</p>"
32324 "field": "dialRecallInQueue",
32325 "description": "<p>Active/Disactive Recall In Queue</p>"
32335 "field": "dialOrderByScheduledAt",
32342 "field": "dialQueueProject2",
32343 "description": "<p>AGI queue option (use: agi://127.0.0.1/square,<project_name>)</p>"
32349 "field": "dialAgiAfterHangupClient",
32356 "field": "dialAgiAfterHangupAgent",
32363 "field": "dialRandomLastDigitCallerIdNumber",
32364 "description": "<p>Random Last Digit (min:1, max:15)</p>"
32370 "field": "dialCutDigit",
32371 "description": "<p>Cut Digit (min:1, max:15)</p>"
32377 "field": "dialNoSuchNumberMaxRetry",
32378 "description": "<p>#NoSuchNumber Retry (min:1, max:999)</p>"
32384 "field": "dialNoSuchNumberRetryFrequency",
32385 "description": "<p>NoSuchNumber Retry Frequency Minutes (min:1, max:99999)</p>"
32391 "field": "dialDropMaxRetry",
32392 "description": "<p>#Drop Retry (min:1, max:999)</p>"
32398 "field": "dialDropRetryFrequency",
32399 "description": "<p>Drop Retry Frequency Minutes (min:1, max:99999)</p>"
32405 "field": "dialAbandonedMaxRetry",
32406 "description": "<p>#Abandoned Retry (min:1, max:999)</p>"
32412 "field": "dialAbandonedRetryFrequency",
32413 "description": "<p>Abandoned Retry Frequency Minutes (min:1, max:99999)</p>"
32419 "field": "dialMachineMaxRetry",
32420 "description": "<p>#Machine Retry (min:1, max:999)</p>"
32426 "field": "dialMachineRetryFrequency",
32427 "description": "<p>Machine Retry Frequency Minutes (min:1, max:99999)</p>"
32433 "field": "dialAgentRejectMaxRetry",
32434 "description": "<p>#AgentReject Retry (min:1, max:999)</p>"
32440 "field": "dialAgentRejectRetryFrequency",
32441 "description": "<p>AgentReject Retry Frequency Minutes (min:1, max:99999)</p>"
32447 "field": "mandatoryDispositionPauseId",
32448 "description": "<p>Status to put when mandatory disposition is enabled</p>"
32454 "field": "mandatoryDisposition",
32455 "description": "<p>Enabled/disables mandatory dispo on a queue</p>"
32461 "field": "dialPredictiveIntervalMaxThreshold",
32468 "field": "dialPredictiveIntervalMinThreshold",
32474 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32475 "version": "0.0.0",
32476 "filename": "server/api/voiceQueue/index.js",
32477 "groupTitle": "Voice_Queues"
32481 "url": "/api/voice/queues/{id}",
32482 "title": "Deletes a Queue",
32485 "title": "Example usage:",
32486 "content": "curl https://{domain}/api/voice/queues/{id} -v -u {name}:{password} -X DELETE",
32490 "name": "DeleteQueues",
32491 "group": "Voice_Queues",
32492 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32493 "version": "0.0.0",
32494 "filename": "server/api/voiceQueue/index.js",
32495 "groupTitle": "Voice_Queues"
32499 "url": "/api/voice/queues/{id}/users",
32500 "title": "Gets queue agents",
32503 "title": "Example usage:",
32504 "content": "curl https://{domain}/api/voice/queues/{id}/users -v -u {name}:{password} -X GET",
32508 "name": "GetAgents",
32509 "group": "Voice_Queues",
32510 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32511 "version": "0.0.0",
32512 "filename": "server/api/voiceQueue/index.js",
32513 "groupTitle": "Voice_Queues"
32517 "url": "/api/voice/queues/{id}/blacklists",
32518 "title": "Get queue blacklists",
32521 "title": "Example usage:",
32522 "content": "curl https://{domain}/api/voice/queues/{id}/blacklists -v -u {name}:{password} -X GET",
32526 "name": "GetBlackLists",
32527 "group": "Voice_Queues",
32528 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32529 "version": "0.0.0",
32530 "filename": "server/api/voiceQueue/index.js",
32531 "groupTitle": "Voice_Queues"
32535 "url": "/api/voice/queues/{id}/finals",
32536 "title": "Gets queue hopper finals",
32539 "title": "Example usage:",
32540 "content": "curl https://{domain}/api/voice/queues/{id}/hopper_finals -v -u {name}:{password} -X GET",
32544 "name": "GetHopperFinals",
32545 "group": "Voice_Queues",
32546 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32547 "version": "0.0.0",
32548 "filename": "server/api/voiceQueue/index.js",
32549 "groupTitle": "Voice_Queues"
32553 "url": "/api/voice/queues/{id}/hopper_histories",
32554 "title": "Gets queue hopper histories",
32557 "title": "Example usage:",
32558 "content": "curl https://{domain}/api/voice/queues/{id}/hopper_histories -v -u {name}:{password} -X GET",
32562 "name": "GetHopperHistories",
32563 "group": "Voice_Queues",
32564 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32565 "version": "0.0.0",
32566 "filename": "server/api/voiceQueue/index.js",
32567 "groupTitle": "Voice_Queues"
32571 "url": "/api/voice/queues/{id}/hoppers",
32572 "title": "Gets queue hoppers",
32575 "title": "Example usage:",
32576 "content": "curl https://{domain}/api/voice/queues/{id}/hoppers -v -u {name}:{password} -X GET",
32580 "name": "GetHoppers",
32581 "group": "Voice_Queues",
32582 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32583 "version": "0.0.0",
32584 "filename": "server/api/voiceQueue/index.js",
32585 "groupTitle": "Voice_Queues"
32589 "url": "/api/voice/queues/{id}/lists",
32590 "title": "Get queue lists",
32593 "title": "Example usage:",
32594 "content": "curl https://{domain}/api/voice/queues/{id}/lists -v -u {name}:{password} -X GET",
32598 "name": "GetLists",
32599 "group": "Voice_Queues",
32600 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32601 "version": "0.0.0",
32602 "filename": "server/api/voiceQueue/index.js",
32603 "groupTitle": "Voice_Queues"
32607 "url": "/api/voice/queues/{id}/members",
32608 "title": "Gets queue members",
32611 "title": "Example usage:",
32612 "content": "curl https://{domain}/api/voice/queues/{id}/members -v -u {name}:{password} -X GET",
32616 "name": "GetMembers",
32617 "group": "Voice_Queues",
32618 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32619 "version": "0.0.0",
32620 "filename": "server/api/voiceQueue/index.js",
32621 "groupTitle": "Voice_Queues"
32625 "url": "/api/voice/queues",
32626 "title": "Gets a list of Queues",
32629 "title": "Example usage:",
32630 "content": "curl https://{domain}/api/voice/queues -v -u {name}:{password}",
32634 "name": "GetQueues",
32635 "group": "Voice_Queues",
32636 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
32637 "version": "0.0.0",
32638 "filename": "server/api/voiceQueue/index.js",
32639 "groupTitle": "Voice_Queues"
32643 "url": "/api/voice/queues/{id}/teams",
32644 "title": "Gets queue team",
32647 "title": "Example usage:",
32648 "content": "curl https://{domain}/api/voice/queues/{id}/teams -v -u {name}:{password} -X GET",
32652 "name": "GetTeams",
32653 "group": "Voice_Queues",
32654 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32655 "version": "0.0.0",
32656 "filename": "server/api/voiceQueue/index.js",
32657 "groupTitle": "Voice_Queues"
32661 "url": "/api/voice/queues/{id}/users",
32662 "title": "Removes agents from a queue",
32665 "title": "Example usage:",
32666 "content": "curl https://{domain}/api/voice/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
32670 "name": "RemoveAgents",
32671 "group": "Voice_Queues",
32672 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32673 "version": "0.0.0",
32674 "filename": "server/api/voiceQueue/index.js",
32675 "groupTitle": "Voice_Queues"
32679 "url": "/api/voice/queues/{id}/blacklists",
32680 "title": "Remove blacklists from a queue",
32683 "title": "Example usage:",
32684 "content": "curl https://{domain}/api/voice/queues/{id}/blacklists?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
32688 "name": "RemoveBlackLists",
32689 "group": "Voice_Queues",
32690 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32691 "version": "0.0.0",
32692 "filename": "server/api/voiceQueue/index.js",
32693 "groupTitle": "Voice_Queues"
32697 "url": "/api/voice/queues/{id}/lists",
32698 "title": "Remove lists from a queue",
32701 "title": "Example usage:",
32702 "content": "curl https://{domain}/api/voice/queues/{id}/lists?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
32706 "name": "RemoveLists",
32707 "group": "Voice_Queues",
32708 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32709 "version": "0.0.0",
32710 "filename": "server/api/voiceQueue/index.js",
32711 "groupTitle": "Voice_Queues"
32715 "url": "/api/voice/queues/{id}",
32716 "title": "Gets a single Queue",
32719 "title": "Example usage:",
32720 "content": "curl https://{domain}/api/voice/queues/{id} -v -u {name}:{password}",
32724 "name": "ShowQueues",
32725 "group": "Voice_Queues",
32726 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32727 "version": "0.0.0",
32728 "filename": "server/api/voiceQueue/index.js",
32729 "groupTitle": "Voice_Queues"
32733 "url": "/api/voice/queues/{id}/blacks",
32734 "title": "Gets queue hopper blacks",
32737 "title": "Example usage:",
32738 "content": "curl https://{domain}/api/voice/queues/{id}/hopper_black -v -u {name}:{password} -X GET",
32742 "name": "getHopperBlacks",
32743 "group": "Voice_Queues",
32744 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32745 "version": "0.0.0",
32746 "filename": "server/api/voiceQueue/index.js",
32747 "groupTitle": "Voice_Queues"
32751 "url": "/api/voice/queues/{id}",
32752 "title": "Update an existing Queue",
32755 "title": "Example usage:",
32756 "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",
32760 "name": "updateQueues",
32761 "group": "Voice_Queues",
32762 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32763 "version": "0.0.0",
32764 "filename": "server/api/voiceQueue/index.js",
32765 "groupTitle": "Voice_Queues"
32769 "url": "/api/voice/recordings",
32770 "title": "Creates a new Recording",
32773 "title": "Example usage:",
32774 "content": "curl https://{domain}/api/voice/recordings -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
32778 "name": "CreateRecordings",
32779 "group": "Voice_Recordings",
32794 "field": "uniqueid",
32801 "field": "channel",
32808 "field": "membername",
32815 "field": "calleridnum",
32822 "field": "calleridname",
32829 "field": "connectedlinenum",
32836 "field": "connectedlinename",
32843 "field": "accountcode",
32850 "field": "context",
32892 "field": "userDisposition",
32899 "field": "userSecondDisposition",
32906 "field": "userThirdDisposition",
32913 "field": "location",
32920 "field": "transcribeName",
32927 "field": "transcribeStatus",
32934 "field": "fileUri",
32941 "field": "fileText",
32948 "field": "failureReason",
32955 "field": "sentiment",
32962 "field": "sPositive",
32969 "field": "sNegative",
32976 "field": "sNeutral",
32990 "field": "tempSentiment",
32997 "field": "createdAt",
33004 "field": "updatedAt",
33010 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33011 "version": "0.0.0",
33012 "filename": "server/api/voiceRecording/index.js",
33013 "groupTitle": "Voice_Recordings"
33017 "url": "/api/voice/recordings/describe",
33018 "title": "Gets table info about Recordings",
33021 "title": "Example usage:",
33022 "content": "curl https://{domain}/api/voice/recordings/describe -v -u {name}:{password}",
33026 "name": "DescribeRecordings",
33027 "group": "Voice_Recordings",
33028 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33029 "version": "0.0.0",
33030 "filename": "server/api/voiceRecording/index.js",
33031 "groupTitle": "Voice_Recordings"
33035 "url": "/api/voice/recordings",
33036 "title": "Gets a list of Recordings",
33039 "title": "Example usage:",
33040 "content": "curl https://{domain}/api/voice/recordings -v -u {name}:{password}",
33044 "name": "GetRecordings",
33045 "group": "Voice_Recordings",
33046 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
33047 "version": "0.0.0",
33048 "filename": "server/api/voiceRecording/index.js",
33049 "groupTitle": "Voice_Recordings"
33053 "url": "/api/voice/recordings/{id}",
33054 "title": "Gets a single Recording",
33057 "title": "Example usage:",
33058 "content": "curl https://{domain}/api/voice/recordings/{id} -v -u {name}:{password}",
33062 "name": "ShowRecordings",
33063 "group": "Voice_Recordings",
33064 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33065 "version": "0.0.0",
33066 "filename": "server/api/voiceRecording/index.js",
33067 "groupTitle": "Voice_Recordings"
33071 "url": "/api/voice/recordings/{id}",
33072 "title": "Delete voice recording",
33075 "title": "Example usage:",
33076 "content": "curl https://{domain}/api/voice/recordings/{id} -v -u {name}:{password} -X DELETE",
33081 "group": "Voice_Recordings",
33082 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33083 "version": "0.0.0",
33084 "filename": "server/api/voiceRecording/index.js",
33085 "groupTitle": "Voice_Recordings"
33089 "url": "/api/voice/recordings/{id}/download",
33090 "title": "Download Recording",
33093 "title": "Example usage:",
33094 "content": "curl https://{domain}/api/voice/recordings/{id}/download -v -u {name}:{password} -X GET",
33098 "name": "download",
33099 "group": "Voice_Recordings",
33100 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33101 "version": "0.0.0",
33102 "filename": "server/api/voiceRecording/index.js",
33103 "groupTitle": "Voice_Recordings"
33107 "url": "/api/voice/recordings/{id}/downloads",
33108 "title": "Download Recording",
33111 "title": "Example usage:",
33112 "content": "curl https://{domain}/api/voice/recordings/{id}/downloads -v -u {name}:{password} -X GET",
33116 "name": "downloads",
33117 "group": "Voice_Recordings",
33118 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33119 "version": "0.0.0",
33120 "filename": "server/api/voiceRecording/index.js",
33121 "groupTitle": "Voice_Recordings"
33125 "url": "/api/voice/recordings/{id}/transcribe",
33126 "title": "Run Transcribe Recording",
33129 "title": "Example usage:",
33130 "content": "curl https://{domain}/api/voice/recordings/{id}/transcribe -d '{\"runSentiment\": \"true\"}' -v -u {name}:{password} -X POST",
33134 "name": "transcribe",
33135 "group": "Voice_Recordings",
33136 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33137 "version": "0.0.0",
33138 "filename": "server/api/voiceRecording/index.js",
33139 "groupTitle": "Voice_Recordings"
33143 "url": "/api/voice/recordings/{id}/transcribe",
33144 "title": "Run Transcribe Recording",
33147 "title": "Example usage:",
33148 "content": "curl https://{domain}/api/voice/recordings/{id}/transcribe -v -u {name}:{password} -X GET",
33152 "name": "transcribe",
33153 "group": "Voice_Recordings",
33154 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33155 "version": "0.0.0",
33156 "filename": "server/api/voiceRecording/index.js",
33157 "groupTitle": "Voice_Recordings"
33161 "url": "/api/voice/recordings/{id}",
33162 "title": "Update an existing Recording",
33165 "title": "Example usage:",
33166 "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",
33170 "name": "updateRecordings",
33171 "group": "Voice_Recordings",
33172 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33173 "version": "0.0.0",
33174 "filename": "server/api/voiceRecording/index.js",
33175 "groupTitle": "Voice_Recordings"
33179 "url": "/api/voice/transfers/reports",
33180 "title": "Creates a new Transfer Report",
33183 "title": "Example usage:",
33184 "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",
33188 "name": "CreateTransfer_Reports",
33189 "group": "Voice_Transfer_Reports",
33215 "field": "transfererchannel",
33222 "field": "transferercalleridnum",
33229 "field": "transferercalleridname",
33236 "field": "transfererconnectedlinenum",
33243 "field": "transfererconnectedlinename",
33250 "field": "transfereraccountcode",
33257 "field": "transferercontext",
33264 "field": "transfererexten",
33271 "field": "transfererlinkedid",
33278 "field": "transfereechannel",
33285 "field": "transfereecalleridnum",
33292 "field": "transfereecalleridname",
33299 "field": "transfereeconnectedlinenum",
33306 "field": "transfereeconnectedlinename",
33313 "field": "transfereeaccountcode",
33320 "field": "transfereecontext",
33327 "field": "transfereeexten",
33334 "field": "transfereelinkedid",
33345 "field": "isexternal",
33352 "field": "context",
33359 "field": "extension",
33365 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33366 "version": "0.0.0",
33367 "filename": "server/api/voiceTransferReport/index.js",
33368 "groupTitle": "Voice_Transfer_Reports"
33372 "url": "/api/voice/transfers/reports/{id}",
33373 "title": "Deletes a Transfer Report",
33376 "title": "Example usage:",
33377 "content": "curl https://{domain}/api/voice/transfers/reports/{id} -v -u {name}:{password} -X DELETE",
33381 "name": "DeleteTransfer_Reports",
33382 "group": "Voice_Transfer_Reports",
33383 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33384 "version": "0.0.0",
33385 "filename": "server/api/voiceTransferReport/index.js",
33386 "groupTitle": "Voice_Transfer_Reports"
33390 "url": "/api/voice/transfers/reports/describe",
33391 "title": "Gets table info about Transfer Reports",
33394 "title": "Example usage:",
33395 "content": "curl https://{domain}/api/voice/transfers/reports/describe -v -u {name}:{password}",
33399 "name": "DescribeTransfer_Reports",
33400 "group": "Voice_Transfer_Reports",
33401 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33402 "version": "0.0.0",
33403 "filename": "server/api/voiceTransferReport/index.js",
33404 "groupTitle": "Voice_Transfer_Reports"
33408 "url": "/api/voice/transfers/reports",
33409 "title": "Gets a list of Transfer Reports",
33412 "title": "Example usage:",
33413 "content": "curl https://{domain}/api/voice/transfers/reports -v -u {name}:{password}",
33417 "name": "GetTransfer_Reports",
33418 "group": "Voice_Transfer_Reports",
33419 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
33420 "version": "0.0.0",
33421 "filename": "server/api/voiceTransferReport/index.js",
33422 "groupTitle": "Voice_Transfer_Reports"
33426 "url": "/api/voice/transfers/reports/{id}",
33427 "title": "Gets a single Transfer Report",
33430 "title": "Example usage:",
33431 "content": "curl https://{domain}/api/voice/transfers/reports/{id} -v -u {name}:{password}",
33435 "name": "ShowTransfer_Reports",
33436 "group": "Voice_Transfer_Reports",
33437 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33438 "version": "0.0.0",
33439 "filename": "server/api/voiceTransferReport/index.js",
33440 "groupTitle": "Voice_Transfer_Reports"
33444 "url": "/api/voice/transfers/reports/{id}",
33445 "title": "Update an existing Transfer Report",
33448 "title": "Example usage:",
33449 "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",
33453 "name": "updateTransfer_Reports",
33454 "group": "Voice_Transfer_Reports",
33455 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33456 "version": "0.0.0",
33457 "filename": "server/api/voiceTransferReport/index.js",
33458 "groupTitle": "Voice_Transfer_Reports"
33462 "url": "/api/integrations/vtiger/accounts",
33463 "title": "Creates a new Vtiger Account",
33466 "title": "Example usage:",
33467 "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",
33471 "name": "CreateVtiger_Accounts",
33472 "group": "Vtiger_Accounts",
33487 "field": "description",
33494 "field": "username",
33501 "field": "moduleName",
33508 "field": "remoteUri",
33515 "field": "serverUrl",
33522 "field": "accessKey",
33528 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33529 "version": "0.0.0",
33530 "filename": "server/api/intVtigerAccount/index.js",
33531 "groupTitle": "Vtiger_Accounts"
33535 "url": "/api/integrations/vtiger/accounts/{id}",
33536 "title": "Deletes a Vtiger Account",
33539 "title": "Example usage:",
33540 "content": "curl https://{domain}/api/integrations/vtiger/accounts/{id} -v -u {name}:{password} -X DELETE",
33544 "name": "DeleteVtiger_Accounts",
33545 "group": "Vtiger_Accounts",
33546 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33547 "version": "0.0.0",
33548 "filename": "server/api/intVtigerAccount/index.js",
33549 "groupTitle": "Vtiger_Accounts"
33553 "url": "/api/integrations/vtiger/accounts",
33554 "title": "Gets a list of Vtiger Accounts",
33557 "title": "Example usage:",
33558 "content": "curl https://{domain}/api/integrations/vtiger/accounts -v -u {name}:{password}",
33562 "name": "GetVtiger_Accounts",
33563 "group": "Vtiger_Accounts",
33564 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
33565 "version": "0.0.0",
33566 "filename": "server/api/intVtigerAccount/index.js",
33567 "groupTitle": "Vtiger_Accounts"
33571 "url": "/api/integrations/vtiger/accounts/{id}",
33572 "title": "Gets a single Vtiger Account",
33575 "title": "Example usage:",
33576 "content": "curl https://{domain}/api/integrations/vtiger/accounts/{id} -v -u {name}:{password}",
33580 "name": "ShowVtiger_Accounts",
33581 "group": "Vtiger_Accounts",
33582 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33583 "version": "0.0.0",
33584 "filename": "server/api/intVtigerAccount/index.js",
33585 "groupTitle": "Vtiger_Accounts"
33589 "url": "/api/integrations/vtiger/accounts/{id}/configurations",
33590 "title": "Creates new configuration",
33593 "title": "Example usage:",
33594 "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",
33598 "name": "addConfiguration",
33599 "group": "Vtiger_Accounts",
33600 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33601 "version": "0.0.0",
33602 "filename": "server/api/intVtigerAccount/index.js",
33603 "groupTitle": "Vtiger_Accounts"
33607 "url": "/api/integrations/vtiger/accounts/{id}/configurations",
33608 "title": "Gets account configurations",
33611 "title": "Example usage:",
33612 "content": "curl https://{domain}/api/integrations/vtiger/accounts/{id}/configurations -v -u {name}:{password} -X GET",
33616 "name": "getConfigurations",
33617 "group": "Vtiger_Accounts",
33618 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33619 "version": "0.0.0",
33620 "filename": "server/api/intVtigerAccount/index.js",
33621 "groupTitle": "Vtiger_Accounts"
33625 "url": "/api/integrations/vtiger/accounts/{id}/fields",
33626 "title": "Gets account fields",
33629 "title": "Example usage:",
33630 "content": "curl https://{domain}/api/integrations/vtiger/accounts/{id}/fields -v -u {name}:{password} -X GET",
33634 "name": "getFields",
33635 "group": "Vtiger_Accounts",
33636 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33637 "version": "0.0.0",
33638 "filename": "server/api/intVtigerAccount/index.js",
33639 "groupTitle": "Vtiger_Accounts"
33643 "url": "/api/integrations/vtiger/accounts/{id}",
33644 "title": "Update an existing Vtiger Account",
33647 "title": "Example usage:",
33648 "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",
33652 "name": "updateVtiger_Accounts",
33653 "group": "Vtiger_Accounts",
33654 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33655 "version": "0.0.0",
33656 "filename": "server/api/intVtigerAccount/index.js",
33657 "groupTitle": "Vtiger_Accounts"
33661 "url": "/api/integrations/vtiger/configurations",
33662 "title": "Creates a new Vtiger Configuration",
33665 "title": "Example usage:",
33666 "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",
33670 "name": "CreateVtiger_Configurations",
33671 "group": "Vtiger_Configurations",
33686 "field": "description",
33692 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33693 "version": "0.0.0",
33694 "filename": "server/api/intVtigerConfiguration/index.js",
33695 "groupTitle": "Vtiger_Configurations"
33699 "url": "/api/integrations/vtiger/configurations/{id}",
33700 "title": "Deletes a Vtiger Configuration",
33703 "title": "Example usage:",
33704 "content": "curl https://{domain}/api/integrations/vtiger/configurations/{id} -v -u {name}:{password} -X DELETE",
33708 "name": "DeleteVtiger_Configurations",
33709 "group": "Vtiger_Configurations",
33710 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33711 "version": "0.0.0",
33712 "filename": "server/api/intVtigerConfiguration/index.js",
33713 "groupTitle": "Vtiger_Configurations"
33717 "url": "/api/integrations/vtiger/configurations",
33718 "title": "Gets a list of Vtiger Configurations",
33721 "title": "Example usage:",
33722 "content": "curl https://{domain}/api/integrations/vtiger/configurations -v -u {name}:{password}",
33726 "name": "GetVtiger_Configurations",
33727 "group": "Vtiger_Configurations",
33728 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
33729 "version": "0.0.0",
33730 "filename": "server/api/intVtigerConfiguration/index.js",
33731 "groupTitle": "Vtiger_Configurations"
33735 "url": "/api/integrations/vtiger/configurations/{id}",
33736 "title": "Gets a single Vtiger Configuration",
33739 "title": "Example usage:",
33740 "content": "curl https://{domain}/api/integrations/vtiger/configurations/{id} -v -u {name}:{password}",
33744 "name": "ShowVtiger_Configurations",
33745 "group": "Vtiger_Configurations",
33746 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33747 "version": "0.0.0",
33748 "filename": "server/api/intVtigerConfiguration/index.js",
33749 "groupTitle": "Vtiger_Configurations"
33753 "url": "/api/integrations/vtiger/configurations/{id}/descriptions",
33754 "title": "Gets configurations descriptions",
33757 "title": "Example usage:",
33758 "content": "curl https://{domain}/api/integrations/vtiger/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
33762 "name": "getDescriptions",
33763 "group": "Vtiger_Configurations",
33764 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33765 "version": "0.0.0",
33766 "filename": "server/api/intVtigerConfiguration/index.js",
33767 "groupTitle": "Vtiger_Configurations"
33771 "url": "/api/integrations/vtiger/configurations/{id}/fields",
33772 "title": "Gets configurations fields",
33775 "title": "Example usage:",
33776 "content": "curl https://{domain}/api/integrations/vtiger/configurations/{id}/fields -v -u {name}:{password} -X GET",
33780 "name": "getFields",
33781 "group": "Vtiger_Configurations",
33782 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33783 "version": "0.0.0",
33784 "filename": "server/api/intVtigerConfiguration/index.js",
33785 "groupTitle": "Vtiger_Configurations"
33789 "url": "/api/integrations/vtiger/configurations/{id}/subjects",
33790 "title": "Gets configurations subjects",
33793 "title": "Example usage:",
33794 "content": "curl https://{domain}/api/integrations/vtiger/configurations/{id}/subjects -v -u {name}:{password} -X GET",
33798 "name": "getSubjects",
33799 "group": "Vtiger_Configurations",
33800 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33801 "version": "0.0.0",
33802 "filename": "server/api/intVtigerConfiguration/index.js",
33803 "groupTitle": "Vtiger_Configurations"
33807 "url": "/api/integrations/vtiger/configurations/{id}",
33808 "title": "Update an existing Vtiger Configuration",
33811 "title": "Example usage:",
33812 "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",
33816 "name": "updateVtiger_Configurations",
33817 "group": "Vtiger_Configurations",
33818 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33819 "version": "0.0.0",
33820 "filename": "server/api/intVtigerConfiguration/index.js",
33821 "groupTitle": "Vtiger_Configurations"
33825 "url": "/api/integrations/vtiger/fields",
33826 "title": "Creates a new Vtiger Field",
33829 "title": "Example usage:",
33830 "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",
33834 "name": "CreateVtiger_Fields",
33835 "group": "Vtiger_Fields",
33845 "\"customVariable\"",
33856 "field": "content",
33872 "\"customVariable\""
33875 "field": "keyType",
33882 "field": "keyContent",
33889 "field": "idField",
33896 "field": "nameField",
33903 "field": "customField",
33910 "field": "variableName",
33916 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33917 "version": "0.0.0",
33918 "filename": "server/api/intVtigerField/index.js",
33919 "groupTitle": "Vtiger_Fields"
33923 "url": "/api/integrations/vtiger/fields/{id}",
33924 "title": "Deletes a Vtiger Field",
33927 "title": "Example usage:",
33928 "content": "curl https://{domain}/api/integrations/vtiger/fields/{id} -v -u {name}:{password} -X DELETE",
33932 "name": "DeleteVtiger_Fields",
33933 "group": "Vtiger_Fields",
33934 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33935 "version": "0.0.0",
33936 "filename": "server/api/intVtigerField/index.js",
33937 "groupTitle": "Vtiger_Fields"
33941 "url": "/api/integrations/vtiger/fields",
33942 "title": "Gets a list of Vtiger Fields",
33945 "title": "Example usage:",
33946 "content": "curl https://{domain}/api/integrations/vtiger/fields -v -u {name}:{password}",
33950 "name": "GetVtiger_Fields",
33951 "group": "Vtiger_Fields",
33952 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
33953 "version": "0.0.0",
33954 "filename": "server/api/intVtigerField/index.js",
33955 "groupTitle": "Vtiger_Fields"
33959 "url": "/api/integrations/vtiger/fields/{id}",
33960 "title": "Gets a single Vtiger Field",
33963 "title": "Example usage:",
33964 "content": "curl https://{domain}/api/integrations/vtiger/fields/{id} -v -u {name}:{password}",
33968 "name": "ShowVtiger_Fields",
33969 "group": "Vtiger_Fields",
33970 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33971 "version": "0.0.0",
33972 "filename": "server/api/intVtigerField/index.js",
33973 "groupTitle": "Vtiger_Fields"
33977 "url": "/api/integrations/vtiger/fields/{id}",
33978 "title": "Update an existing Vtiger Field",
33981 "title": "Example usage:",
33982 "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",
33986 "name": "updateVtiger_Fields",
33987 "group": "Vtiger_Fields",
33988 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33989 "version": "0.0.0",
33990 "filename": "server/api/intVtigerField/index.js",
33991 "groupTitle": "Vtiger_Fields"
33995 "url": "/api/webbar/answer",
33996 "title": "answer webrtc call",
33999 "title": "Example usage:",
34000 "content": "curl https://{domain}/api/webbar/answer -d '{\"sessionId\": \"<sessionId>\", \"userId\": 54}' \\\n -H \"Content-Type: application/json\" -X POST",
34004 "name": "Web_Bar_answer",
34013 "field": "sessionId",
34026 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34027 "version": "0.0.0",
34028 "filename": "server/api/webbar/index.js",
34029 "groupTitle": "WebBar"
34033 "url": "/api/webbar/calls",
34034 "title": "webrtc call list",
34037 "title": "Example usage:",
34038 "content": "curl https://{domain}/api/webbar/calls -d '{\"userId\": 54}' \\\n -H \"Content-Type: application/json\" -X POST",
34042 "name": "Web_Bar_calls",
34057 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34058 "version": "0.0.0",
34059 "filename": "server/api/webbar/index.js",
34060 "groupTitle": "WebBar"
34064 "url": "/api/webbar/hangup",
34065 "title": "hangup webrtc call",
34068 "title": "Example usage:",
34069 "content": "curl https://{domain}/api/webbar/hangup -d '{\"sessionId\": \"<sessionId>\", \"userId\": 54}' \\\n -H \"Content-Type: application/json\" -X POST",
34073 "name": "Web_Bar_hangup",
34082 "field": "sessionId",
34095 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34096 "version": "0.0.0",
34097 "filename": "server/api/webbar/index.js",
34098 "groupTitle": "WebBar"
34102 "url": "/api/webbar/hold",
34103 "title": "hold webrtc call",
34106 "title": "Example usage:",
34107 "content": "curl https://{domain}/api/webbar/hold -d '{\"sessionId\": \"<sessionId>\", \"userId\": 54}' \\\n -H \"Content-Type: application/json\" -X POST",
34111 "name": "Web_Bar_hold",
34120 "field": "sessionId",
34133 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34134 "version": "0.0.0",
34135 "filename": "server/api/webbar/index.js",
34136 "groupTitle": "WebBar"
34140 "url": "/api/webbar/unhold",
34141 "title": "unhold webrtc call",
34144 "title": "Example usage:",
34145 "content": "curl https://{domain}/api/webbar/unhold -d '{\"sessionId\": \"<sessionId>\", \"userId\": 54}' \\\n -H \"Content-Type: application/json\" -X POST",
34149 "name": "Web_Bar_hold",
34158 "field": "sessionId",
34171 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34172 "version": "0.0.0",
34173 "filename": "server/api/webbar/index.js",
34174 "groupTitle": "WebBar"
34178 "url": "/api/webbar/originate",
34179 "title": "Originate new webrtc call",
34182 "title": "Example usage:",
34183 "content": "curl https://{domain}/api/webbar/originate -d '{\"callNumber\": \"0119692844\", \"userId\": 54}' \\\n -H \"Content-Type: application/json\" -X POST",
34187 "name": "Web_Bar_originate",
34196 "field": "callNumber",
34210 "field": "callerId",
34217 "field": "callbackUrl",
34223 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34224 "version": "0.0.0",
34225 "filename": "server/api/webbar/index.js",
34226 "groupTitle": "WebBar"
34230 "url": "/api/webbar/transfer",
34231 "title": "blind transfer webrtc call",
34234 "title": "Example usage:",
34235 "content": "curl https://{domain}/api/webbar/transfer -d '{\"userId\": 54, \"sessionId\":\"<sessionId>\", \"transferNumber\":\"<transferNumber>\"}' \\\n -H \"Content-Type: application/json\" -X POST",
34239 "name": "Web_Bar_transfer",
34255 "field": "sessionId",
34262 "field": "transferNumber",
34268 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34269 "version": "0.0.0",
34270 "filename": "server/api/webbar/index.js",
34271 "groupTitle": "WebBar"
34275 "url": "/api/whatsapp/accounts/{id}/users",
34276 "title": "Add agents to a whatsapp account",
34279 "title": "Example usage:",
34280 "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",
34284 "name": "AddAgents",
34285 "group": "Whatsapp_Accounts",
34286 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34287 "version": "0.0.0",
34288 "filename": "server/api/whatsappAccount/index.js",
34289 "groupTitle": "Whatsapp_Accounts"
34293 "url": "/api/whatsapp/accounts",
34294 "title": "Creates a new Account",
34297 "title": "Example usage:",
34298 "content": "curl https://{domain}/api/whatsapp/accounts -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
34302 "name": "CreateAccounts",
34303 "group": "Whatsapp_Accounts",
34356 "field": "accountSid",
34363 "field": "authToken",
34370 "field": "notificationTemplate",
34377 "field": "notificationSound",
34384 "field": "notificationShake",
34391 "field": "waitForTheAssignedAgent",
34398 "field": "queueTransfer",
34405 "field": "queueTransferTimeout",
34412 "field": "agentTransfer",
34419 "field": "agentTransferTimeout",
34426 "field": "mandatoryDispositionPauseId",
34427 "description": "<p>Status to put when mandatory disposition is enabled</p>"
34433 "field": "mandatoryDisposition",
34434 "description": "<p>Enabled/disables mandatory dispo on a queue</p>"
34440 "field": "description",
34446 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34447 "version": "0.0.0",
34448 "filename": "server/api/whatsappAccount/index.js",
34449 "groupTitle": "Whatsapp_Accounts"
34453 "url": "/api/whatsapp/accounts/{id}",
34454 "title": "Deletes a Account",
34457 "title": "Example usage:",
34458 "content": "curl https://{domain}/api/whatsapp/accounts/{id} -v -u {name}:{password} -X DELETE",
34462 "name": "DeleteAccounts",
34463 "group": "Whatsapp_Accounts",
34464 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34465 "version": "0.0.0",
34466 "filename": "server/api/whatsappAccount/index.js",
34467 "groupTitle": "Whatsapp_Accounts"
34471 "url": "/api/whatsapp/accounts/describe",
34472 "title": "Gets table info about Accounts",
34475 "title": "Example usage:",
34476 "content": "curl https://{domain}/api/whatsapp/accounts/describe -v -u {name}:{password}",
34480 "name": "DescribeAccounts",
34481 "group": "Whatsapp_Accounts",
34482 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34483 "version": "0.0.0",
34484 "filename": "server/api/whatsappAccount/index.js",
34485 "groupTitle": "Whatsapp_Accounts"
34489 "url": "/api/whatsapp/accounts",
34490 "title": "Gets a list of Accounts",
34493 "title": "Example usage:",
34494 "content": "curl https://{domain}/api/whatsapp/accounts -v -u {name}:{password}",
34498 "name": "GetAccounts",
34499 "group": "Whatsapp_Accounts",
34500 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
34501 "version": "0.0.0",
34502 "filename": "server/api/whatsappAccount/index.js",
34503 "groupTitle": "Whatsapp_Accounts"
34507 "url": "/api/whatsapp/accounts/{id}/users",
34508 "title": "Gets agents from whatsapp account",
34511 "title": "Example usage:",
34512 "content": "curl https://{domain}/api/whatsapp/accounts/{id}/users -v -u {name}:{password} -X GET",
34516 "name": "GetAgents",
34517 "group": "Whatsapp_Accounts",
34518 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34519 "version": "0.0.0",
34520 "filename": "server/api/whatsappAccount/index.js",
34521 "groupTitle": "Whatsapp_Accounts"
34525 "url": "/api/whatsapp/accounts/{id}/users",
34526 "title": "Removes agents from a whatsapp account",
34529 "title": "Example usage:",
34530 "content": "curl https://{domain}/api/whatsapp/accounts/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
34534 "name": "RemoveAgents",
34535 "group": "Whatsapp_Accounts",
34536 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34537 "version": "0.0.0",
34538 "filename": "server/api/whatsappAccount/index.js",
34539 "groupTitle": "Whatsapp_Accounts"
34543 "url": "/api/whatsapp/accounts/{id}/canned_answers",
34544 "title": "Removes canned answers from account",
34547 "title": "Example usage:",
34548 "content": "curl https://{domain}/api/whatsapp/accounts/{id}/canned_answers?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
34552 "name": "RemoveAnswers",
34553 "group": "Whatsapp_Accounts",
34554 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34555 "version": "0.0.0",
34556 "filename": "server/api/whatsappAccount/index.js",
34557 "groupTitle": "Whatsapp_Accounts"
34561 "url": "/api/whatsapp/accounts/{id}/dispositions",
34562 "title": "Removes dispositions from account",
34565 "title": "Example usage:",
34566 "content": "curl https://{domain}/api/whatsapp/accounts/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
34570 "name": "RemoveDispositions",
34571 "group": "Whatsapp_Accounts",
34572 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34573 "version": "0.0.0",
34574 "filename": "server/api/whatsappAccount/index.js",
34575 "groupTitle": "Whatsapp_Accounts"
34579 "url": "/api/whatsapp/accounts/{id}",
34580 "title": "Gets a single Account",
34583 "title": "Example usage:",
34584 "content": "curl https://{domain}/api/whatsapp/accounts/{id} -v -u {name}:{password}",
34588 "name": "ShowAccounts",
34589 "group": "Whatsapp_Accounts",
34590 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34591 "version": "0.0.0",
34592 "filename": "server/api/whatsappAccount/index.js",
34593 "groupTitle": "Whatsapp_Accounts"
34597 "url": "/api/whatsapp/messages/{id}/accept",
34598 "title": "Accepts message",
34601 "title": "Example usage:",
34602 "content": "curl https://{domain}/api/whatsapp/messages/{id}/accept \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
34606 "name": "acceptMessage",
34607 "group": "Whatsapp_Accounts",
34608 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34609 "version": "0.0.0",
34610 "filename": "server/api/whatsappMessage/index.js",
34611 "groupTitle": "Whatsapp_Accounts"
34615 "url": "/api/whatsapp/accounts/{id}/canned_answers",
34616 "title": "Creates new canned answer",
34619 "title": "Example usage:",
34620 "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",
34624 "name": "addAnswer",
34625 "group": "Whatsapp_Accounts",
34647 "field": "description",
34660 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34661 "version": "0.0.0",
34662 "filename": "server/api/whatsappAccount/index.js",
34663 "groupTitle": "Whatsapp_Accounts"
34667 "url": "/api/whatsapp/accounts/{id}/applications",
34668 "title": "Creates new applications",
34671 "title": "Example usage:",
34672 "content": "curl https://{domain}/api/whatsapp/accounts/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
34676 "name": "addApplications",
34677 "group": "Whatsapp_Accounts",
34685 "field": "priority",
34699 "field": "appdata",
34706 "field": "description",
34713 "field": "interval",
34719 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34720 "version": "0.0.0",
34721 "filename": "server/api/whatsappAccount/index.js",
34722 "groupTitle": "Whatsapp_Accounts"
34726 "url": "/api/whatsapp/accounts/{id}/dispositions",
34727 "title": "Creates new disposition",
34730 "title": "Example usage:",
34731 "content": "curl https://{domain}/api/whatsapp/accounts/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
34735 "name": "addDisposition",
34736 "group": "Whatsapp_Accounts",
34763 "field": "description",
34769 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34770 "version": "0.0.0",
34771 "filename": "server/api/whatsappAccount/index.js",
34772 "groupTitle": "Whatsapp_Accounts"
34776 "url": "/api/whatsapp/accounts/{id}/canned_answers",
34777 "title": "Gets account canned answers",
34780 "title": "Example usage:",
34781 "content": "curl https://{domain}/api/whatsapp/accounts/{id}/canned_answers -v -u {name}:{password} -X GET",
34785 "name": "getAnswers",
34786 "group": "Whatsapp_Accounts",
34787 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34788 "version": "0.0.0",
34789 "filename": "server/api/whatsappAccount/index.js",
34790 "groupTitle": "Whatsapp_Accounts"
34794 "url": "/api/whatsapp/accounts/{id}/applications",
34795 "title": "Gets account applications",
34798 "title": "Example usage:",
34799 "content": "curl https://{domain}/api/whatsapp/accounts/{id}/applications -v -u {name}:{password} -X GET",
34803 "name": "getApplications",
34804 "group": "Whatsapp_Accounts",
34805 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34806 "version": "0.0.0",
34807 "filename": "server/api/whatsappAccount/index.js",
34808 "groupTitle": "Whatsapp_Accounts"
34812 "url": "/api/whatsapp/accounts/{id}/dispositions",
34813 "title": "Gets account dispositions",
34816 "title": "Example usage:",
34817 "content": "curl https://{domain}/api/whatsapp/accounts/{id}/dispositions -v -u {name}:{password} -X GET",
34821 "name": "getDispositions",
34822 "group": "Whatsapp_Accounts",
34823 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34824 "version": "0.0.0",
34825 "filename": "server/api/whatsappAccount/index.js",
34826 "groupTitle": "Whatsapp_Accounts"
34830 "url": "/api/whatsapp/accounts/{id}/notify",
34831 "title": "Notify new message",
34834 "title": "Example usage:",
34835 "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",
34840 "group": "Whatsapp_Accounts",
34841 "description": "<p>Motion 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>",
34842 "version": "0.0.0",
34843 "filename": "server/api/whatsappAccount/index.js",
34844 "groupTitle": "Whatsapp_Accounts"
34848 "url": "/api/whatsapp/messages/{id}/reject",
34849 "title": "Rejects message",
34852 "title": "Example usage:",
34853 "content": "curl https://{domain}/api/whatsapp/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
34857 "name": "rejectMessage",
34858 "group": "Whatsapp_Accounts",
34859 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34860 "version": "0.0.0",
34861 "filename": "server/api/whatsappMessage/index.js",
34862 "groupTitle": "Whatsapp_Accounts"
34866 "url": "/api/whatsapp/accounts/{id}/send",
34867 "title": "Send new whatsapp message",
34870 "title": "Example usage:",
34871 "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",
34875 "name": "sendWhatsapp",
34876 "group": "Whatsapp_Accounts",
34877 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34878 "version": "0.0.0",
34879 "filename": "server/api/whatsappAccount/index.js",
34880 "groupTitle": "Whatsapp_Accounts"
34884 "url": "/api/whatsapp/messages/{id}/status",
34885 "title": "Receive message status",
34888 "title": "Example usage:",
34889 "content": "curl https://{domain}/api/whatsapp/messages/{id}/status \\ \n -H 'Content-Type: application/json' -v -X POST",
34893 "name": "statusMessage",
34894 "group": "Whatsapp_Accounts",
34895 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34896 "version": "0.0.0",
34897 "filename": "server/api/whatsappMessage/index.js",
34898 "groupTitle": "Whatsapp_Accounts"
34902 "url": "/api/whatsapp/accounts/{id}",
34903 "title": "Update an existing Account",
34906 "title": "Example usage:",
34907 "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",
34911 "name": "updateAccounts",
34912 "group": "Whatsapp_Accounts",
34913 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34914 "version": "0.0.0",
34915 "filename": "server/api/whatsappAccount/index.js",
34916 "groupTitle": "Whatsapp_Accounts"
34920 "url": "/api/whatsapp/applications",
34921 "title": "Creates a new Application",
34924 "title": "Example usage:",
34925 "content": "curl https://{domain}/api/whatsapp/applications -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
34929 "name": "CreateApplications",
34930 "group": "Whatsapp_Applications",
34938 "field": "priority",
34952 "field": "appdata",
34959 "field": "description",
34966 "field": "interval",
34972 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34973 "version": "0.0.0",
34974 "filename": "server/api/whatsappApplication/index.js",
34975 "groupTitle": "Whatsapp_Applications"
34979 "url": "/api/whatsapp/applications/{id}",
34980 "title": "Deletes a Application",
34983 "title": "Example usage:",
34984 "content": "curl https://{domain}/api/whatsapp/applications/{id} -v -u {name}:{password} -X DELETE",
34988 "name": "DeleteApplications",
34989 "group": "Whatsapp_Applications",
34990 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34991 "version": "0.0.0",
34992 "filename": "server/api/whatsappApplication/index.js",
34993 "groupTitle": "Whatsapp_Applications"
34997 "url": "/api/whatsapp/applications",
34998 "title": "Gets a list of Applications",
35001 "title": "Example usage:",
35002 "content": "curl https://{domain}/api/whatsapp/applications -v -u {name}:{password}",
35006 "name": "GetApplications",
35007 "group": "Whatsapp_Applications",
35008 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
35009 "version": "0.0.0",
35010 "filename": "server/api/whatsappApplication/index.js",
35011 "groupTitle": "Whatsapp_Applications"
35015 "url": "/api/whatsapp/applications/{id}",
35016 "title": "Gets a single Application",
35019 "title": "Example usage:",
35020 "content": "curl https://{domain}/api/whatsapp/applications/{id} -v -u {name}:{password}",
35024 "name": "ShowApplications",
35025 "group": "Whatsapp_Applications",
35026 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35027 "version": "0.0.0",
35028 "filename": "server/api/whatsappApplication/index.js",
35029 "groupTitle": "Whatsapp_Applications"
35033 "url": "/api/whatsapp/applications/{id}",
35034 "title": "Update an existing Application",
35037 "title": "Example usage:",
35038 "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",
35042 "name": "updateApplications",
35043 "group": "Whatsapp_Applications",
35044 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35045 "version": "0.0.0",
35046 "filename": "server/api/whatsappApplication/index.js",
35047 "groupTitle": "Whatsapp_Applications"
35051 "url": "/api/whatsapp/interactions/{id}/tags",
35052 "title": "Add tags to the interaction",
35055 "title": "Example usage:",
35056 "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",
35061 "group": "Whatsapp_Interactions",
35062 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35063 "version": "0.0.0",
35064 "filename": "server/api/whatsappInteraction/index.js",
35065 "groupTitle": "Whatsapp_Interactions"
35069 "url": "/api/whatsapp/interactions",
35070 "title": "Creates a new Interaction",
35073 "title": "Example usage:",
35074 "content": "curl https://{domain}/api/whatsapp/interactions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
35078 "name": "CreateInteractions",
35079 "group": "Whatsapp_Interactions",
35094 "field": "closedAt",
35101 "field": "disposition",
35108 "field": "secondDisposition",
35115 "field": "thirdDisposition",
35136 "field": "read1stAt",
35147 "field": "firstMsgDirection",
35154 "field": "lastMsgAt",
35165 "field": "lastMsgDirection",
35171 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35172 "version": "0.0.0",
35173 "filename": "server/api/whatsappInteraction/index.js",
35174 "groupTitle": "Whatsapp_Interactions"
35178 "url": "/api/whatsapp/interactions/{id}",
35179 "title": "Deletes a Interaction",
35182 "title": "Example usage:",
35183 "content": "curl https://{domain}/api/whatsapp/interactions/{id} -v -u {name}:{password} -X DELETE",
35187 "name": "DeleteInteractions",
35188 "group": "Whatsapp_Interactions",
35189 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35190 "version": "0.0.0",
35191 "filename": "server/api/whatsappInteraction/index.js",
35192 "groupTitle": "Whatsapp_Interactions"
35196 "url": "/api/whatsapp/interactions/describe",
35197 "title": "Gets table info about Interactions",
35200 "title": "Example usage:",
35201 "content": "curl https://{domain}/api/whatsapp/interactions/describe -v -u {name}:{password}",
35205 "name": "DescribeInteractions",
35206 "group": "Whatsapp_Interactions",
35207 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35208 "version": "0.0.0",
35209 "filename": "server/api/whatsappInteraction/index.js",
35210 "groupTitle": "Whatsapp_Interactions"
35214 "url": "/api/whatsapp/interactions",
35215 "title": "Gets a list of Interactions",
35218 "title": "Example usage:",
35219 "content": "curl https://{domain}/api/whatsapp/interactions -v -u {name}:{password}",
35223 "name": "GetInteractions",
35224 "group": "Whatsapp_Interactions",
35225 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
35226 "version": "0.0.0",
35227 "filename": "server/api/whatsappInteraction/index.js",
35228 "groupTitle": "Whatsapp_Interactions"
35232 "url": "/api/whatsapp/interactions/{id}/tags",
35233 "title": "Removes tags from interaction",
35236 "title": "Example usage:",
35237 "content": "curl https://{domain}/api/whatsapp/interactions/{id}/tags?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
35241 "name": "RemoveTags",
35242 "group": "Whatsapp_Interactions",
35243 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35244 "version": "0.0.0",
35245 "filename": "server/api/whatsappInteraction/index.js",
35246 "groupTitle": "Whatsapp_Interactions"
35250 "url": "/api/whatsapp/interactions/{id}",
35251 "title": "Gets a single Interaction",
35254 "title": "Example usage:",
35255 "content": "curl https://{domain}/api/whatsapp/interactions/{id} -v -u {name}:{password}",
35259 "name": "ShowInteractions",
35260 "group": "Whatsapp_Interactions",
35261 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35262 "version": "0.0.0",
35263 "filename": "server/api/whatsappInteraction/index.js",
35264 "groupTitle": "Whatsapp_Interactions"
35268 "url": "/api/whatsapp/interactions/{id}/messages",
35269 "title": "Creates new messages",
35272 "title": "Example usage:",
35273 "content": "curl https://{domain}/api/whatsapp/interactions/{id}/messages -d '[{\"to\": \"+3901119886500\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
35277 "name": "addMessage",
35278 "group": "Whatsapp_Interactions",
35304 "field": "direction",
35311 "field": "messageId",
35339 "field": "providerName",
35346 "field": "providerResponse",
35352 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35353 "version": "0.0.0",
35354 "filename": "server/api/whatsappInteraction/index.js",
35355 "groupTitle": "Whatsapp_Interactions"
35359 "url": "/api/whatsapp/interactions/{id}/download",
35360 "title": "Gets interaction",
35363 "title": "Example usage:",
35364 "content": "curl https://{domain}/api/whatsapp/interactions/{id}/download -v -u {name}:{password} -X GET",
35368 "name": "download",
35369 "group": "Whatsapp_Interactions",
35370 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35371 "version": "0.0.0",
35372 "filename": "server/api/whatsappInteraction/index.js",
35373 "groupTitle": "Whatsapp_Interactions"
35377 "url": "/api/whatsapp/interactions/{id}/messages",
35378 "title": "Gets interaction messages",
35381 "title": "Example usage:",
35382 "content": "curl https://{domain}/api/whatsapp/interactions/{id}/messages -v -u {name}:{password} -X GET",
35386 "name": "getMessages",
35387 "group": "Whatsapp_Interactions",
35388 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35389 "version": "0.0.0",
35390 "filename": "server/api/whatsappInteraction/index.js",
35391 "groupTitle": "Whatsapp_Interactions"
35395 "url": "/api/whatsapp/interactions/{id}",
35396 "title": "Update an existing Interaction",
35399 "title": "Example usage:",
35400 "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",
35404 "name": "updateInteractions",
35405 "group": "Whatsapp_Interactions",
35406 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35407 "version": "0.0.0",
35408 "filename": "server/api/whatsappInteraction/index.js",
35409 "groupTitle": "Whatsapp_Interactions"
35413 "url": "/api/whatsapp/messages",
35414 "title": "Creates a new Message",
35417 "title": "Example usage:",
35418 "content": "curl https://{domain}/api/whatsapp/messages -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
35422 "name": "CreateMessages",
35423 "group": "Whatsapp_Messages",
35449 "field": "direction",
35456 "field": "messageId",
35484 "field": "providerName",
35491 "field": "providerResponse",
35497 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35498 "version": "0.0.0",
35499 "filename": "server/api/whatsappMessage/index.js",
35500 "groupTitle": "Whatsapp_Messages"
35504 "url": "/api/whatsapp/messages/{id}",
35505 "title": "Deletes a Message",
35508 "title": "Example usage:",
35509 "content": "curl https://{domain}/api/whatsapp/messages/{id} -v -u {name}:{password} -X DELETE",
35513 "name": "DeleteMessages",
35514 "group": "Whatsapp_Messages",
35515 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35516 "version": "0.0.0",
35517 "filename": "server/api/whatsappMessage/index.js",
35518 "groupTitle": "Whatsapp_Messages"
35522 "url": "/api/whatsapp/messages/describe",
35523 "title": "Gets table info about Messages",
35526 "title": "Example usage:",
35527 "content": "curl https://{domain}/api/whatsapp/messages/describe -v -u {name}:{password}",
35531 "name": "DescribeMessages",
35532 "group": "Whatsapp_Messages",
35533 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35534 "version": "0.0.0",
35535 "filename": "server/api/whatsappMessage/index.js",
35536 "groupTitle": "Whatsapp_Messages"
35540 "url": "/api/whatsapp/messages",
35541 "title": "Gets a list of Messages",
35544 "title": "Example usage:",
35545 "content": "curl https://{domain}/api/whatsapp/messages -v -u {name}:{password}",
35549 "name": "GetMessages",
35550 "group": "Whatsapp_Messages",
35551 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
35552 "version": "0.0.0",
35553 "filename": "server/api/whatsappMessage/index.js",
35554 "groupTitle": "Whatsapp_Messages"
35558 "url": "/api/whatsapp/messages/{id}",
35559 "title": "Gets a single Message",
35562 "title": "Example usage:",
35563 "content": "curl https://{domain}/api/whatsapp/messages/{id} -v -u {name}:{password}",
35567 "name": "ShowMessages",
35568 "group": "Whatsapp_Messages",
35569 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35570 "version": "0.0.0",
35571 "filename": "server/api/whatsappMessage/index.js",
35572 "groupTitle": "Whatsapp_Messages"
35576 "url": "/api/whatsapp/messages/{id}",
35577 "title": "Update an existing Message",
35580 "title": "Example usage:",
35581 "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",
35585 "name": "updateMessages",
35586 "group": "Whatsapp_Messages",
35587 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35588 "version": "0.0.0",
35589 "filename": "server/api/whatsappMessage/index.js",
35590 "groupTitle": "Whatsapp_Messages"
35594 "url": "/api/whatsapp/reports/queue",
35595 "title": "Creates a new Whatsapp Queue Report",
35598 "title": "Example usage:",
35599 "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",
35603 "name": "CreateWhatsapp_Queue_Reports",
35604 "group": "Whatsapp_Queue_Reports",
35612 "field": "uniqueid",
35633 "field": "leaveAt",
35640 "field": "acceptAt",
35660 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35661 "version": "0.0.0",
35662 "filename": "server/api/whatsappQueueReport/index.js",
35663 "groupTitle": "Whatsapp_Queue_Reports"
35667 "url": "/api/whatsapp/reports/queue/{id}",
35668 "title": "Deletes a Whatsapp Queue Report",
35671 "title": "Example usage:",
35672 "content": "curl https://{domain}/api/whatsapp/reports/queue/{id} -v -u {name}:{password} -X DELETE",
35676 "name": "DeleteWhatsapp_Queue_Reports",
35677 "group": "Whatsapp_Queue_Reports",
35678 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35679 "version": "0.0.0",
35680 "filename": "server/api/whatsappQueueReport/index.js",
35681 "groupTitle": "Whatsapp_Queue_Reports"
35685 "url": "/api/whatsapp/reports/queue/describe",
35686 "title": "Gets table info about Whatsapp Queue Reports",
35689 "title": "Example usage:",
35690 "content": "curl https://{domain}/api/whatsapp/reports/queue/describe -v -u {name}:{password}",
35694 "name": "DescribeWhatsapp_Queue_Reports",
35695 "group": "Whatsapp_Queue_Reports",
35696 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35697 "version": "0.0.0",
35698 "filename": "server/api/whatsappQueueReport/index.js",
35699 "groupTitle": "Whatsapp_Queue_Reports"
35703 "url": "/api/whatsapp/reports/queue",
35704 "title": "Gets a list of Whatsapp Queue Reports",
35707 "title": "Example usage:",
35708 "content": "curl https://{domain}/api/whatsapp/reports/queue -v -u {name}:{password}",
35712 "name": "GetWhatsapp_Queue_Reports",
35713 "group": "Whatsapp_Queue_Reports",
35714 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
35715 "version": "0.0.0",
35716 "filename": "server/api/whatsappQueueReport/index.js",
35717 "groupTitle": "Whatsapp_Queue_Reports"
35721 "url": "/api/whatsapp/reports/queue/{id}",
35722 "title": "Gets a single Whatsapp Queue Report",
35725 "title": "Example usage:",
35726 "content": "curl https://{domain}/api/whatsapp/reports/queue/{id} -v -u {name}:{password}",
35730 "name": "ShowWhatsapp_Queue_Reports",
35731 "group": "Whatsapp_Queue_Reports",
35732 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35733 "version": "0.0.0",
35734 "filename": "server/api/whatsappQueueReport/index.js",
35735 "groupTitle": "Whatsapp_Queue_Reports"
35739 "url": "/api/whatsapp/reports/queue/{id}",
35740 "title": "Update an existing Whatsapp Queue Report",
35743 "title": "Example usage:",
35744 "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",
35748 "name": "updateWhatsapp_Queue_Reports",
35749 "group": "Whatsapp_Queue_Reports",
35750 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35751 "version": "0.0.0",
35752 "filename": "server/api/whatsappQueueReport/index.js",
35753 "groupTitle": "Whatsapp_Queue_Reports"
35757 "url": "/api/whatsapp/queues/{id}/users",
35758 "title": "Add agents to a queue",
35761 "title": "Example usage:",
35762 "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",
35766 "name": "AddAgents",
35767 "group": "Whatsapp_Queues",
35768 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35769 "version": "0.0.0",
35770 "filename": "server/api/whatsappQueue/index.js",
35771 "groupTitle": "Whatsapp_Queues"
35775 "url": "/api/whatsapp/queues/{id}/teams",
35776 "title": "Add teams to a queue",
35779 "title": "Example usage:",
35780 "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",
35784 "name": "AddTeams",
35785 "group": "Whatsapp_Queues",
35786 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35787 "version": "0.0.0",
35788 "filename": "server/api/whatsappQueue/index.js",
35789 "groupTitle": "Whatsapp_Queues"
35793 "url": "/api/whatsapp/queues",
35794 "title": "Creates a new Queue",
35797 "title": "Example usage:",
35798 "content": "curl https://{domain}/api/whatsapp/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
35802 "name": "CreateQueues",
35803 "group": "Whatsapp_Queues",
35818 "field": "timeout",
35830 "field": "strategy",
35837 "field": "description",
35843 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35844 "version": "0.0.0",
35845 "filename": "server/api/whatsappQueue/index.js",
35846 "groupTitle": "Whatsapp_Queues"
35850 "url": "/api/whatsapp/queues/{id}",
35851 "title": "Deletes a Queue",
35854 "title": "Example usage:",
35855 "content": "curl https://{domain}/api/whatsapp/queues/{id} -v -u {name}:{password} -X DELETE",
35859 "name": "DeleteQueues",
35860 "group": "Whatsapp_Queues",
35861 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35862 "version": "0.0.0",
35863 "filename": "server/api/whatsappQueue/index.js",
35864 "groupTitle": "Whatsapp_Queues"
35868 "url": "/api/whatsapp/queues/describe",
35869 "title": "Gets table info about Queues",
35872 "title": "Example usage:",
35873 "content": "curl https://{domain}/api/whatsapp/queues/describe -v -u {name}:{password}",
35877 "name": "DescribeQueues",
35878 "group": "Whatsapp_Queues",
35879 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35880 "version": "0.0.0",
35881 "filename": "server/api/whatsappQueue/index.js",
35882 "groupTitle": "Whatsapp_Queues"
35886 "url": "/api/whatsapp/queues/{id}/users",
35887 "title": "Gets queue agents",
35890 "title": "Example usage:",
35891 "content": "curl https://{domain}/api/whatsapp/queues/{id}/users -v -u {name}:{password} -X POST",
35895 "name": "GetAgents",
35896 "group": "Whatsapp_Queues",
35897 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35898 "version": "0.0.0",
35899 "filename": "server/api/whatsappQueue/index.js",
35900 "groupTitle": "Whatsapp_Queues"
35904 "url": "/api/whatsapp/queues/{id}/members",
35905 "title": "GetMembers",
35908 "title": "Example usage:",
35909 "content": "curl https://{domain}/api/whatsapp/queues/{id}/members -v -u {name}:{password}",
35913 "name": "GetMembers",
35914 "group": "Whatsapp_Queues",
35915 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35916 "version": "0.0.0",
35917 "filename": "server/api/whatsappQueue/index.js",
35918 "groupTitle": "Whatsapp_Queues"
35922 "url": "/api/whatsapp/queues",
35923 "title": "Gets a list of Queues",
35926 "title": "Example usage:",
35927 "content": "curl https://{domain}/api/whatsapp/queues -v -u {name}:{password}",
35931 "name": "GetQueues",
35932 "group": "Whatsapp_Queues",
35933 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
35934 "version": "0.0.0",
35935 "filename": "server/api/whatsappQueue/index.js",
35936 "groupTitle": "Whatsapp_Queues"
35940 "url": "/api/whatsapp/queues/{id}/teams",
35941 "title": "Gets queues list",
35944 "title": "Example usage:",
35945 "content": "curl https://{domain}/api/whatsapp/queues/{id}/teams -v -u {name}:{password}",
35949 "name": "GetTeams",
35950 "group": "Whatsapp_Queues",
35951 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35952 "version": "0.0.0",
35953 "filename": "server/api/whatsappQueue/index.js",
35954 "groupTitle": "Whatsapp_Queues"
35958 "url": "/api/whatsapp/queues/{id}/users",
35959 "title": "Removes agents from a queue",
35962 "title": "Example usage:",
35963 "content": "curl https://{domain}/api/whatsapp/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
35967 "name": "RemoveAgents",
35968 "group": "Whatsapp_Queues",
35969 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35970 "version": "0.0.0",
35971 "filename": "server/api/whatsappQueue/index.js",
35972 "groupTitle": "Whatsapp_Queues"
35976 "url": "/api/whatsapp/queues/{id}",
35977 "title": "Gets a single Queue",
35980 "title": "Example usage:",
35981 "content": "curl https://{domain}/api/whatsapp/queues/{id} -v -u {name}:{password}",
35985 "name": "ShowQueues",
35986 "group": "Whatsapp_Queues",
35987 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35988 "version": "0.0.0",
35989 "filename": "server/api/whatsappQueue/index.js",
35990 "groupTitle": "Whatsapp_Queues"
35994 "url": "/api/whatsapp/queues/{id}",
35995 "title": "Update an existing Queue",
35998 "title": "Example usage:",
35999 "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",
36003 "name": "updateQueues",
36004 "group": "Whatsapp_Queues",
36005 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36006 "version": "0.0.0",
36007 "filename": "server/api/whatsappQueue/index.js",
36008 "groupTitle": "Whatsapp_Queues"
36012 "url": "/api/whatsapp/reports/transfer",
36013 "title": "Creates a new Whatsapp Transfer Report",
36016 "title": "Example usage:",
36017 "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",
36021 "name": "CreateWhatsapp_Transfer_Reports",
36022 "group": "Whatsapp_Transfer_Reports",
36030 "field": "uniqueid",
36049 "field": "transferredAt",
36055 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36056 "version": "0.0.0",
36057 "filename": "server/api/whatsappTransferReport/index.js",
36058 "groupTitle": "Whatsapp_Transfer_Reports"
36062 "url": "/api/whatsapp/reports/transfer/{id}",
36063 "title": "Deletes a Whatsapp Transfer Report",
36066 "title": "Example usage:",
36067 "content": "curl https://{domain}/api/whatsapp/reports/transfer/{id} -v -u {name}:{password} -X DELETE",
36071 "name": "DeleteWhatsapp_Transfer_Reports",
36072 "group": "Whatsapp_Transfer_Reports",
36073 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36074 "version": "0.0.0",
36075 "filename": "server/api/whatsappTransferReport/index.js",
36076 "groupTitle": "Whatsapp_Transfer_Reports"
36080 "url": "/api/whatsapp/reports/transfer/describe",
36081 "title": "Gets table info about Whatsapp Transfer Reports",
36084 "title": "Example usage:",
36085 "content": "curl https://{domain}/api/whatsapp/reports/transfer/describe -v -u {name}:{password}",
36089 "name": "DescribeWhatsapp_Transfer_Reports",
36090 "group": "Whatsapp_Transfer_Reports",
36091 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36092 "version": "0.0.0",
36093 "filename": "server/api/whatsappTransferReport/index.js",
36094 "groupTitle": "Whatsapp_Transfer_Reports"
36098 "url": "/api/whatsapp/reports/transfer",
36099 "title": "Gets a list of Whatsapp Transfer Reports",
36102 "title": "Example usage:",
36103 "content": "curl https://{domain}/api/whatsapp/reports/transfer -v -u {name}:{password}",
36107 "name": "GetWhatsapp_Transfer_Reports",
36108 "group": "Whatsapp_Transfer_Reports",
36109 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
36110 "version": "0.0.0",
36111 "filename": "server/api/whatsappTransferReport/index.js",
36112 "groupTitle": "Whatsapp_Transfer_Reports"
36116 "url": "/api/whatsapp/reports/transfer/{id}",
36117 "title": "Gets a single Whatsapp Transfer Report",
36120 "title": "Example usage:",
36121 "content": "curl https://{domain}/api/whatsapp/reports/transfer/{id} -v -u {name}:{password}",
36125 "name": "ShowWhatsapp_Transfer_Reports",
36126 "group": "Whatsapp_Transfer_Reports",
36127 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36128 "version": "0.0.0",
36129 "filename": "server/api/whatsappTransferReport/index.js",
36130 "groupTitle": "Whatsapp_Transfer_Reports"
36134 "url": "/api/whatsapp/reports/transfer/{id}",
36135 "title": "Update an existing Whatsapp Transfer Report",
36138 "title": "Example usage:",
36139 "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",
36143 "name": "updateWhatsapp_Transfer_Reports",
36144 "group": "Whatsapp_Transfer_Reports",
36145 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36146 "version": "0.0.0",
36147 "filename": "server/api/whatsappTransferReport/index.js",
36148 "groupTitle": "Whatsapp_Transfer_Reports"
36152 "url": "/api/integrations/zendesk/accounts",
36153 "title": "Creates a new Zendesk Account",
36156 "title": "Example usage:",
36157 "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",
36161 "name": "CreateZendesk_Accounts",
36162 "group": "Zendesk_Accounts",
36177 "field": "description",
36184 "field": "username",
36191 "field": "password",
36205 "field": "remoteUri",
36216 "field": "authType",
36223 "field": "serverUrl",
36230 "\"integrationTab\"",
36240 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36241 "version": "0.0.0",
36242 "filename": "server/api/intZendeskAccount/index.js",
36243 "groupTitle": "Zendesk_Accounts"
36247 "url": "/api/integrations/zendesk/accounts/{id}",
36248 "title": "Deletes a Zendesk Account",
36251 "title": "Example usage:",
36252 "content": "curl https://{domain}/api/integrations/zendesk/accounts/{id} -v -u {name}:{password} -X DELETE",
36256 "name": "DeleteZendesk_Accounts",
36257 "group": "Zendesk_Accounts",
36258 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36259 "version": "0.0.0",
36260 "filename": "server/api/intZendeskAccount/index.js",
36261 "groupTitle": "Zendesk_Accounts"
36265 "url": "/api/integrations/zendesk/accounts",
36266 "title": "Gets a list of Zendesk Accounts",
36269 "title": "Example usage:",
36270 "content": "curl https://{domain}/api/integrations/zendesk/accounts -v -u {name}:{password}",
36274 "name": "GetZendesk_Accounts",
36275 "group": "Zendesk_Accounts",
36276 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
36277 "version": "0.0.0",
36278 "filename": "server/api/intZendeskAccount/index.js",
36279 "groupTitle": "Zendesk_Accounts"
36283 "url": "/api/integrations/zendesk/accounts/{id}",
36284 "title": "Gets a single Zendesk Account",
36287 "title": "Example usage:",
36288 "content": "curl https://{domain}/api/integrations/zendesk/accounts/{id} -v -u {name}:{password}",
36292 "name": "ShowZendesk_Accounts",
36293 "group": "Zendesk_Accounts",
36294 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36295 "version": "0.0.0",
36296 "filename": "server/api/intZendeskAccount/index.js",
36297 "groupTitle": "Zendesk_Accounts"
36301 "url": "/api/integrations/zendesk/accounts/{id}/configurations",
36302 "title": "Creates new configuration",
36305 "title": "Example usage:",
36306 "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",
36310 "name": "addConfiguration",
36311 "group": "Zendesk_Accounts",
36312 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36313 "version": "0.0.0",
36314 "filename": "server/api/intZendeskAccount/index.js",
36315 "groupTitle": "Zendesk_Accounts"
36319 "url": "/api/integrations/zendesk/accounts/{id}/configurations",
36320 "title": "Gets account configurations",
36323 "title": "Example usage:",
36324 "content": "curl https://{domain}/api/integrations/zendesk/accounts/{id}/configurations -v -u {name}:{password} -X GET",
36328 "name": "getConfigurations",
36329 "group": "Zendesk_Accounts",
36330 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36331 "version": "0.0.0",
36332 "filename": "server/api/intZendeskAccount/index.js",
36333 "groupTitle": "Zendesk_Accounts"
36337 "url": "/api/integrations/zendesk/accounts/{id}/fields",
36338 "title": "Gets account fields",
36341 "title": "Example usage:",
36342 "content": "curl https://{domain}/api/integrations/zendesk/accounts/{id}/fields -v -u {name}:{password} -X GET",
36346 "name": "getFields",
36347 "group": "Zendesk_Accounts",
36348 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36349 "version": "0.0.0",
36350 "filename": "server/api/intZendeskAccount/index.js",
36351 "groupTitle": "Zendesk_Accounts"
36355 "url": "/api/integrations/zendesk/accounts/{id}",
36356 "title": "Update an existing Zendesk Account",
36359 "title": "Example usage:",
36360 "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",
36364 "name": "updateZendesk_Accounts",
36365 "group": "Zendesk_Accounts",
36366 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36367 "version": "0.0.0",
36368 "filename": "server/api/intZendeskAccount/index.js",
36369 "groupTitle": "Zendesk_Accounts"
36373 "url": "/api/integrations/zendesk/configurations",
36374 "title": "Creates a new Zendesk Configuration",
36377 "title": "Example usage:",
36378 "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",
36382 "name": "CreateZendesk_Configurations",
36383 "group": "Zendesk_Configurations",
36398 "field": "description",
36404 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36405 "version": "0.0.0",
36406 "filename": "server/api/intZendeskConfiguration/index.js",
36407 "groupTitle": "Zendesk_Configurations"
36411 "url": "/api/integrations/zendesk/configurations/{id}",
36412 "title": "Deletes a Zendesk Configuration",
36415 "title": "Example usage:",
36416 "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id} -v -u {name}:{password} -X DELETE",
36420 "name": "DeleteZendesk_Configurations",
36421 "group": "Zendesk_Configurations",
36422 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36423 "version": "0.0.0",
36424 "filename": "server/api/intZendeskConfiguration/index.js",
36425 "groupTitle": "Zendesk_Configurations"
36429 "url": "/api/integrations/zendesk/configurations",
36430 "title": "Gets a list of Zendesk Configurations",
36433 "title": "Example usage:",
36434 "content": "curl https://{domain}/api/integrations/zendesk/configurations -v -u {name}:{password}",
36438 "name": "GetZendesk_Configurations",
36439 "group": "Zendesk_Configurations",
36440 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
36441 "version": "0.0.0",
36442 "filename": "server/api/intZendeskConfiguration/index.js",
36443 "groupTitle": "Zendesk_Configurations"
36447 "url": "/api/integrations/zendesk/configurations/{id}",
36448 "title": "Gets a single Zendesk Configuration",
36451 "title": "Example usage:",
36452 "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id} -v -u {name}:{password}",
36456 "name": "ShowZendesk_Configurations",
36457 "group": "Zendesk_Configurations",
36458 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36459 "version": "0.0.0",
36460 "filename": "server/api/intZendeskConfiguration/index.js",
36461 "groupTitle": "Zendesk_Configurations"
36465 "url": "/api/integrations/zendesk/configurations/{id}/descriptions",
36466 "title": "Gets configurations descriptions",
36469 "title": "Example usage:",
36470 "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
36474 "name": "getDescriptions",
36475 "group": "Zendesk_Configurations",
36476 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36477 "version": "0.0.0",
36478 "filename": "server/api/intZendeskConfiguration/index.js",
36479 "groupTitle": "Zendesk_Configurations"
36483 "url": "/api/integrations/zendesk/configurations/{id}/fields",
36484 "title": "Gets configurations fields",
36487 "title": "Example usage:",
36488 "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id}/fields -v -u {name}:{password} -X GET",
36492 "name": "getFields",
36493 "group": "Zendesk_Configurations",
36494 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36495 "version": "0.0.0",
36496 "filename": "server/api/intZendeskConfiguration/index.js",
36497 "groupTitle": "Zendesk_Configurations"
36501 "url": "/api/integrations/zendesk/configurations/{id}/subjects",
36502 "title": "Gets configurations subjects",
36505 "title": "Example usage:",
36506 "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id}/subjects -v -u {name}:{password} -X GET",
36510 "name": "getSubjects",
36511 "group": "Zendesk_Configurations",
36512 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36513 "version": "0.0.0",
36514 "filename": "server/api/intZendeskConfiguration/index.js",
36515 "groupTitle": "Zendesk_Configurations"
36519 "url": "/api/integrations/zendesk/configurations/{id}/tags",
36520 "title": "Gets configurations tags",
36523 "title": "Example usage:",
36524 "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id}/tags -v -u {name}:{password} -X GET",
36529 "group": "Zendesk_Configurations",
36530 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36531 "version": "0.0.0",
36532 "filename": "server/api/intZendeskConfiguration/index.js",
36533 "groupTitle": "Zendesk_Configurations"
36537 "url": "/api/integrations/zendesk/configurations/{id}/tags",
36538 "title": "Sets new tags",
36541 "title": "Example usage:",
36542 "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",
36547 "group": "Zendesk_Configurations",
36548 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36549 "version": "0.0.0",
36550 "filename": "server/api/intZendeskConfiguration/index.js",
36551 "groupTitle": "Zendesk_Configurations"
36555 "url": "/api/integrations/zendesk/configurations/{id}",
36556 "title": "Update an existing Zendesk Configuration",
36559 "title": "Example usage:",
36560 "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",
36564 "name": "updateZendesk_Configurations",
36565 "group": "Zendesk_Configurations",
36566 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36567 "version": "0.0.0",
36568 "filename": "server/api/intZendeskConfiguration/index.js",
36569 "groupTitle": "Zendesk_Configurations"
36573 "url": "/api/integrations/zendesk/fields",
36574 "title": "Creates a new Zendesk Field",
36577 "title": "Example usage:",
36578 "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",
36582 "name": "CreateZendesk_Fields",
36583 "group": "Zendesk_Fields",
36593 "\"customVariable\"",
36604 "field": "content",
36620 "\"customVariable\""
36623 "field": "keyType",
36630 "field": "keyContent",
36637 "field": "idField",
36644 "field": "nameField",
36651 "field": "customField",
36658 "field": "variableName",
36664 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36665 "version": "0.0.0",
36666 "filename": "server/api/intZendeskField/index.js",
36667 "groupTitle": "Zendesk_Fields"
36671 "url": "/api/integrations/zendesk/fields/{id}",
36672 "title": "Deletes a Zendesk Field",
36675 "title": "Example usage:",
36676 "content": "curl https://{domain}/api/integrations/zendesk/fields/{id} -v -u {name}:{password} -X DELETE",
36680 "name": "DeleteZendesk_Fields",
36681 "group": "Zendesk_Fields",
36682 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36683 "version": "0.0.0",
36684 "filename": "server/api/intZendeskField/index.js",
36685 "groupTitle": "Zendesk_Fields"
36689 "url": "/api/integrations/zendesk/fields",
36690 "title": "Gets a list of Zendesk Fields",
36693 "title": "Example usage:",
36694 "content": "curl https://{domain}/api/integrations/zendesk/fields -v -u {name}:{password}",
36698 "name": "GetZendesk_Fields",
36699 "group": "Zendesk_Fields",
36700 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
36701 "version": "0.0.0",
36702 "filename": "server/api/intZendeskField/index.js",
36703 "groupTitle": "Zendesk_Fields"
36707 "url": "/api/integrations/zendesk/fields/{id}",
36708 "title": "Gets a single Zendesk Field",
36711 "title": "Example usage:",
36712 "content": "curl https://{domain}/api/integrations/zendesk/fields/{id} -v -u {name}:{password}",
36716 "name": "ShowZendesk_Fields",
36717 "group": "Zendesk_Fields",
36718 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36719 "version": "0.0.0",
36720 "filename": "server/api/intZendeskField/index.js",
36721 "groupTitle": "Zendesk_Fields"
36725 "url": "/api/integrations/zendesk/fields/{id}",
36726 "title": "Update an existing Zendesk Field",
36729 "title": "Example usage:",
36730 "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",
36734 "name": "updateZendesk_Fields",
36735 "group": "Zendesk_Fields",
36736 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36737 "version": "0.0.0",
36738 "filename": "server/api/intZendeskField/index.js",
36739 "groupTitle": "Zendesk_Fields"
36743 "url": "/api/integrations/zoho/accounts",
36744 "title": "Creates a new Zoho Account",
36747 "title": "Example usage:",
36748 "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",
36752 "name": "CreateZoho_Accounts",
36753 "group": "Zoho_Accounts",
36768 "field": "description",
36789 "field": "clientId",
36796 "field": "clientSecret",
36803 "field": "serverUrl",
36817 "field": "refreshToken",
36823 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36824 "version": "0.0.0",
36825 "filename": "server/api/intZohoAccount/index.js",
36826 "groupTitle": "Zoho_Accounts"
36830 "url": "/api/integrations/zoho/accounts/{id}",
36831 "title": "Deletes a Zoho Account",
36834 "title": "Example usage:",
36835 "content": "curl https://{domain}/api/integrations/zoho/accounts/{id} -v -u {name}:{password} -X DELETE",
36839 "name": "DeleteZoho_Accounts",
36840 "group": "Zoho_Accounts",
36841 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36842 "version": "0.0.0",
36843 "filename": "server/api/intZohoAccount/index.js",
36844 "groupTitle": "Zoho_Accounts"
36848 "url": "/api/integrations/zoho/accounts",
36849 "title": "Gets a list of Zoho Accounts",
36852 "title": "Example usage:",
36853 "content": "curl https://{domain}/api/integrations/zoho/accounts -v -u {name}:{password}",
36857 "name": "GetZoho_Accounts",
36858 "group": "Zoho_Accounts",
36859 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
36860 "version": "0.0.0",
36861 "filename": "server/api/intZohoAccount/index.js",
36862 "groupTitle": "Zoho_Accounts"
36866 "url": "/api/integrations/zoho/accounts/{id}",
36867 "title": "Gets a single Zoho Account",
36870 "title": "Example usage:",
36871 "content": "curl https://{domain}/api/integrations/zoho/accounts/{id} -v -u {name}:{password}",
36875 "name": "ShowZoho_Accounts",
36876 "group": "Zoho_Accounts",
36877 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36878 "version": "0.0.0",
36879 "filename": "server/api/intZohoAccount/index.js",
36880 "groupTitle": "Zoho_Accounts"
36884 "url": "/api/integrations/zoho/accounts/{id}/configurations",
36885 "title": "Creates new configuration",
36888 "title": "Example usage:",
36889 "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",
36893 "name": "addConfiguration",
36894 "group": "Zoho_Accounts",
36895 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36896 "version": "0.0.0",
36897 "filename": "server/api/intZohoAccount/index.js",
36898 "groupTitle": "Zoho_Accounts"
36902 "url": "/api/integrations/zoho/accounts/{id}/configurations",
36903 "title": "Gets account configurations",
36906 "title": "Example usage:",
36907 "content": "curl https://{domain}/api/integrations/zoho/accounts/{id}/configurations -v -u {name}:{password} -X GET",
36911 "name": "getConfigurations",
36912 "group": "Zoho_Accounts",
36913 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36914 "version": "0.0.0",
36915 "filename": "server/api/intZohoAccount/index.js",
36916 "groupTitle": "Zoho_Accounts"
36920 "url": "/api/integrations/zoho/accounts/{id}/fields",
36921 "title": "Gets account fields",
36924 "title": "Example usage:",
36925 "content": "curl https://{domain}/api/integrations/zoho/accounts/{id}/fields -v -u {name}:{password} -X GET",
36929 "name": "getFields",
36930 "group": "Zoho_Accounts",
36931 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36932 "version": "0.0.0",
36933 "filename": "server/api/intZohoAccount/index.js",
36934 "groupTitle": "Zoho_Accounts"
36938 "url": "/api/integrations/zoho/accounts/{id}",
36939 "title": "Update an existing Zoho Account",
36942 "title": "Example usage:",
36943 "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",
36947 "name": "updateZoho_Accounts",
36948 "group": "Zoho_Accounts",
36949 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36950 "version": "0.0.0",
36951 "filename": "server/api/intZohoAccount/index.js",
36952 "groupTitle": "Zoho_Accounts"
36956 "url": "/api/integrations/zoho/configurations",
36957 "title": "Creates a new Zoho Configuration",
36960 "title": "Example usage:",
36961 "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",
36965 "name": "CreateZoho_Configurations",
36966 "group": "Zoho_Configurations",
36986 "field": "moduleCreate",
36993 "\"contact_lead\"",
36998 "field": "moduleSearch",
37005 "field": "description",
37011 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37012 "version": "0.0.0",
37013 "filename": "server/api/intZohoConfiguration/index.js",
37014 "groupTitle": "Zoho_Configurations"
37018 "url": "/api/integrations/zoho/configurations/{id}",
37019 "title": "Deletes a Zoho Configuration",
37022 "title": "Example usage:",
37023 "content": "curl https://{domain}/api/integrations/zoho/configurations/{id} -v -u {name}:{password} -X DELETE",
37027 "name": "DeleteZoho_Configurations",
37028 "group": "Zoho_Configurations",
37029 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37030 "version": "0.0.0",
37031 "filename": "server/api/intZohoConfiguration/index.js",
37032 "groupTitle": "Zoho_Configurations"
37036 "url": "/api/integrations/zoho/configurations",
37037 "title": "Gets a list of Zoho Configurations",
37040 "title": "Example usage:",
37041 "content": "curl https://{domain}/api/integrations/zoho/configurations -v -u {name}:{password}",
37045 "name": "GetZoho_Configurations",
37046 "group": "Zoho_Configurations",
37047 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
37048 "version": "0.0.0",
37049 "filename": "server/api/intZohoConfiguration/index.js",
37050 "groupTitle": "Zoho_Configurations"
37054 "url": "/api/integrations/zoho/configurations/{id}",
37055 "title": "Gets a single Zoho Configuration",
37058 "title": "Example usage:",
37059 "content": "curl https://{domain}/api/integrations/zoho/configurations/{id} -v -u {name}:{password}",
37063 "name": "ShowZoho_Configurations",
37064 "group": "Zoho_Configurations",
37065 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37066 "version": "0.0.0",
37067 "filename": "server/api/intZohoConfiguration/index.js",
37068 "groupTitle": "Zoho_Configurations"
37072 "url": "/api/integrations/zoho/configurations/{id}/descriptions",
37073 "title": "Gets configurations descriptions",
37076 "title": "Example usage:",
37077 "content": "curl https://{domain}/api/integrations/zoho/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
37081 "name": "getDescriptions",
37082 "group": "Zoho_Configurations",
37083 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37084 "version": "0.0.0",
37085 "filename": "server/api/intZohoConfiguration/index.js",
37086 "groupTitle": "Zoho_Configurations"
37090 "url": "/api/integrations/zoho/configurations/{id}/fields",
37091 "title": "Gets configurations fields",
37094 "title": "Example usage:",
37095 "content": "curl https://{domain}/api/integrations/zoho/configurations/{id}/fields -v -u {name}:{password} -X GET",
37099 "name": "getFields",
37100 "group": "Zoho_Configurations",
37101 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37102 "version": "0.0.0",
37103 "filename": "server/api/intZohoConfiguration/index.js",
37104 "groupTitle": "Zoho_Configurations"
37108 "url": "/api/integrations/zoho/configurations/{id}/subjects",
37109 "title": "Gets configurations subjects",
37112 "title": "Example usage:",
37113 "content": "curl https://{domain}/api/integrations/zoho/configurations/{id}/subjects -v -u {name}:{password} -X GET",
37117 "name": "getSubjects",
37118 "group": "Zoho_Configurations",
37119 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37120 "version": "0.0.0",
37121 "filename": "server/api/intZohoConfiguration/index.js",
37122 "groupTitle": "Zoho_Configurations"
37126 "url": "/api/integrations/zoho/configurations/{id}",
37127 "title": "Update an existing Zoho Configuration",
37130 "title": "Example usage:",
37131 "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",
37135 "name": "updateZoho_Configurations",
37136 "group": "Zoho_Configurations",
37137 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37138 "version": "0.0.0",
37139 "filename": "server/api/intZohoConfiguration/index.js",
37140 "groupTitle": "Zoho_Configurations"
37144 "url": "/api/integrations/zoho/fields",
37145 "title": "Creates a new Zoho Field",
37148 "title": "Example usage:",
37149 "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",
37153 "name": "CreateZoho_Fields",
37154 "group": "Zoho_Fields",
37164 "\"customVariable\"",
37175 "field": "content",
37191 "\"customVariable\""
37194 "field": "keyType",
37201 "field": "keyContent",
37208 "field": "idField",
37215 "field": "nameField",
37222 "field": "customField",
37229 "field": "variableName",
37235 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37236 "version": "0.0.0",
37237 "filename": "server/api/intZohoField/index.js",
37238 "groupTitle": "Zoho_Fields"
37242 "url": "/api/integrations/zoho/fields/{id}",
37243 "title": "Deletes a Zoho Field",
37246 "title": "Example usage:",
37247 "content": "curl https://{domain}/api/integrations/zoho/fields/{id} -v -u {name}:{password} -X DELETE",
37251 "name": "DeleteZoho_Fields",
37252 "group": "Zoho_Fields",
37253 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37254 "version": "0.0.0",
37255 "filename": "server/api/intZohoField/index.js",
37256 "groupTitle": "Zoho_Fields"
37260 "url": "/api/integrations/zoho/fields",
37261 "title": "Gets a list of Zoho Fields",
37264 "title": "Example usage:",
37265 "content": "curl https://{domain}/api/integrations/zoho/fields -v -u {name}:{password}",
37269 "name": "GetZoho_Fields",
37270 "group": "Zoho_Fields",
37271 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
37272 "version": "0.0.0",
37273 "filename": "server/api/intZohoField/index.js",
37274 "groupTitle": "Zoho_Fields"
37278 "url": "/api/integrations/zoho/fields/{id}",
37279 "title": "Gets a single Zoho Field",
37282 "title": "Example usage:",
37283 "content": "curl https://{domain}/api/integrations/zoho/fields/{id} -v -u {name}:{password}",
37287 "name": "ShowZoho_Fields",
37288 "group": "Zoho_Fields",
37289 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37290 "version": "0.0.0",
37291 "filename": "server/api/intZohoField/index.js",
37292 "groupTitle": "Zoho_Fields"
37296 "url": "/api/integrations/zoho/fields/{id}",
37297 "title": "Update an existing Zoho Field",
37300 "title": "Example usage:",
37301 "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",
37305 "name": "updateZoho_Fields",
37306 "group": "Zoho_Fields",
37307 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37308 "version": "0.0.0",
37309 "filename": "server/api/intZohoField/index.js",
37310 "groupTitle": "Zoho_Fields"
37315 "title": "Creates a new Cdr",
37318 "title": "Example usage:",
37319 "content": "curl https://{domain}/api/cdr -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
37323 "name": "CreateCdrs",
37332 "field": "calldate",
37360 "field": "dcontext",
37367 "field": "channel",
37374 "field": "dstchannel",
37381 "field": "lastapp",
37388 "field": "lastdata",
37395 "field": "duration",
37402 "field": "billsec",
37409 "field": "disposition",
37416 "field": "amaflags",
37423 "field": "accountcode",
37430 "field": "userfield",
37437 "field": "uniqueid",
37444 "field": "linkedid",
37451 "field": "sequence",
37458 "field": "peeraccount",
37478 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37479 "version": "0.0.0",
37480 "filename": "server/api/cdr/index.js",
37481 "groupTitle": "cdr"
37485 "url": "/api/cdr/{id}",
37486 "title": "Deletes a Cdr",
37489 "title": "Example usage:",
37490 "content": "curl https://{domain}/api/cdr/{id} -v -u {name}:{password} -X DELETE",
37494 "name": "DeleteCdrs",
37496 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37497 "version": "0.0.0",
37498 "filename": "server/api/cdr/index.js",
37499 "groupTitle": "cdr"
37503 "url": "/api/cdr/describe",
37504 "title": "Gets table info about Cdrs",
37507 "title": "Example usage:",
37508 "content": "curl https://{domain}/api/cdr/describe -v -u {name}:{password}",
37512 "name": "DescribeCdrs",
37514 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37515 "version": "0.0.0",
37516 "filename": "server/api/cdr/index.js",
37517 "groupTitle": "cdr"
37522 "title": "Gets a list of Cdrs",
37525 "title": "Example usage:",
37526 "content": "curl https://{domain}/api/cdr -v -u {name}:{password}",
37532 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
37533 "version": "0.0.0",
37534 "filename": "server/api/cdr/index.js",
37535 "groupTitle": "cdr"
37539 "url": "/api/cdr/{id}",
37540 "title": "Gets a single Cdr",
37543 "title": "Example usage:",
37544 "content": "curl https://{domain}/api/cdr/{id} -v -u {name}:{password}",
37548 "name": "ShowCdrs",
37550 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37551 "version": "0.0.0",
37552 "filename": "server/api/cdr/index.js",
37553 "groupTitle": "cdr"
37557 "url": "/api/cdr/{id}",
37558 "title": "Update an existing Cdr",
37561 "title": "Example usage:",
37562 "content": "curl https://{domain}/api/cdr/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
37566 "name": "updateCdrs",
37568 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37569 "version": "0.0.0",
37570 "filename": "server/api/cdr/index.js",
37571 "groupTitle": "cdr"
37575 "url": "/api/voiceQueuesLog",
37576 "title": "Creates a new VoiceQueuesLog",
37579 "title": "Example usage:",
37580 "content": "curl https://{domain}/api/voiceQueuesLog -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
37584 "name": "CreateVoiceQueuesLogs",
37585 "group": "voiceQueuesLog",
37607 "field": "queuename",
37676 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37677 "version": "0.0.0",
37678 "filename": "server/api/voiceQueuesLog/index.js",
37679 "groupTitle": "voiceQueuesLog"
37683 "url": "/api/voiceQueuesLog/{id}",
37684 "title": "Deletes a VoiceQueuesLog",
37687 "title": "Example usage:",
37688 "content": "curl https://{domain}/api/voiceQueuesLog/{id} -v -u {name}:{password} -X DELETE",
37692 "name": "DeleteVoiceQueuesLogs",
37693 "group": "voiceQueuesLog",
37694 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37695 "version": "0.0.0",
37696 "filename": "server/api/voiceQueuesLog/index.js",
37697 "groupTitle": "voiceQueuesLog"
37701 "url": "/api/voiceQueuesLog",
37702 "title": "Gets a list of VoiceQueuesLogs",
37705 "title": "Example usage:",
37706 "content": "curl https://{domain}/api/voiceQueuesLog -v -u {name}:{password}",
37710 "name": "GetVoiceQueuesLogs",
37711 "group": "voiceQueuesLog",
37712 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
37713 "version": "0.0.0",
37714 "filename": "server/api/voiceQueuesLog/index.js",
37715 "groupTitle": "voiceQueuesLog"
37719 "url": "/api/voiceQueuesLog/{id}",
37720 "title": "Gets a single VoiceQueuesLog",
37723 "title": "Example usage:",
37724 "content": "curl https://{domain}/api/voiceQueuesLog/{id} -v -u {name}:{password}",
37728 "name": "ShowVoiceQueuesLogs",
37729 "group": "voiceQueuesLog",
37730 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37731 "version": "0.0.0",
37732 "filename": "server/api/voiceQueuesLog/index.js",
37733 "groupTitle": "voiceQueuesLog"
37737 "url": "/api/voiceQueuesLog/{id}",
37738 "title": "Update an existing VoiceQueuesLog",
37741 "title": "Example usage:",
37742 "content": "curl https://{domain}/api/voiceQueuesLog/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
37746 "name": "updateVoiceQueuesLogs",
37747 "group": "voiceQueuesLog",
37748 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37749 "version": "0.0.0",
37750 "filename": "server/api/voiceQueuesLog/index.js",
37751 "groupTitle": "voiceQueuesLog"