4 "url": "/api/actions/{id}",
5 "title": "Deletes a Action",
8 "title": "Example usage:",
9 "content": "curl https://{domain}/api/actions/{id} -v -u {name}:{password} -X DELETE",
13 "name": "DeleteActions",
15 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17 "filename": "server/api/action/index.js",
18 "groupTitle": "Actions"
22 "url": "/api/actions/{id}",
23 "title": "Update an existing Action",
26 "title": "Example usage:",
27 "content": "curl https://{domain}/api/actions/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
31 "name": "updateActions",
33 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35 "filename": "server/api/action/index.js",
36 "groupTitle": "Actions"
40 "url": "/api/analytics/custom_reports",
41 "title": "Creates a new Analytic Custom Report",
44 "title": "Example usage:",
45 "content": "curl https://{domain}/api/analytics/custom_reports -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
49 "name": "CreateAnalytic_Custom_Reports",
50 "group": "Analytic_Custom_Reports",
65 "field": "description",
86 "field": "conditions",
99 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
101 "filename": "server/api/analyticCustomReport/index.js",
102 "groupTitle": "Analytic_Custom_Reports"
106 "url": "/api/analytics/custom_reports/{id}",
107 "title": "Deletes a Analytic Custom Report",
110 "title": "Example usage:",
111 "content": "curl https://{domain}/api/analytics/custom_reports/{id} -v -u {name}:{password} -X DELETE",
115 "name": "DeleteAnalytic_Custom_Reports",
116 "group": "Analytic_Custom_Reports",
117 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
119 "filename": "server/api/analyticCustomReport/index.js",
120 "groupTitle": "Analytic_Custom_Reports"
124 "url": "/api/analytics/custom_reports",
125 "title": "Gets a list of Analytic Custom Reports",
128 "title": "Example usage:",
129 "content": "curl https://{domain}/api/analytics/custom_reports -v -u {name}:{password}",
133 "name": "GetAnalytic_Custom_Reports",
134 "group": "Analytic_Custom_Reports",
135 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/analytics/custom_reports?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/analytics/custom_reports?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/analytics/custom_reports?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/analytics/custom_reports?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/analytics/custom_reports?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
137 "filename": "server/api/analyticCustomReport/index.js",
138 "groupTitle": "Analytic_Custom_Reports"
142 "url": "/api/analytics/custom_reports/{id}",
143 "title": "Gets a single Analytic Custom Report",
146 "title": "Example usage:",
147 "content": "curl https://{domain}/api/analytics/custom_reports/{id} -v -u {name}:{password}",
151 "name": "ShowAnalytic_Custom_Reports",
152 "group": "Analytic_Custom_Reports",
153 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
155 "filename": "server/api/analyticCustomReport/index.js",
156 "groupTitle": "Analytic_Custom_Reports"
160 "url": "/api/analytics/custom_reports/{id}/preview",
161 "title": "Report Preview",
164 "title": "Example usage:",
165 "content": "curl https://{domain}/api/analytics/custom_reports/{id}/preview -v -u {name}:{password} -X GET",
170 "group": "Analytic_Custom_Reports",
171 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
173 "filename": "server/api/analyticCustomReport/index.js",
174 "groupTitle": "Analytic_Custom_Reports"
178 "url": "/api/analytics/custom_reports/{id}/query",
179 "title": "Report Query SQL",
182 "title": "Example usage:",
183 "content": "curl https://{domain}/api/analytics/custom_reports/{id}/query -v -u {name}:{password} -X GET",
188 "group": "Analytic_Custom_Reports",
189 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
191 "filename": "server/api/analyticCustomReport/index.js",
192 "groupTitle": "Analytic_Custom_Reports"
196 "url": "/api/analytics/custom_reports/{id}/run",
197 "title": "Report Run",
200 "title": "Example usage:",
201 "content": "curl https://{domain}/api/analytics/custom_reports/{id}/run -v -u {name}:{password} -X GET",
206 "group": "Analytic_Custom_Reports",
207 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
209 "filename": "server/api/analyticCustomReport/index.js",
210 "groupTitle": "Analytic_Custom_Reports"
214 "url": "/api/analytics/custom_reports/{id}",
215 "title": "Update an existing Analytic Custom Report",
218 "title": "Example usage:",
219 "content": "curl https://{domain}/api/analytics/custom_reports/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
223 "name": "updateAnalytic_Custom_Reports",
224 "group": "Analytic_Custom_Reports",
225 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
227 "filename": "server/api/analyticCustomReport/index.js",
228 "groupTitle": "Analytic_Custom_Reports"
232 "url": "/api/analytics/default_reports",
233 "title": "Creates a new Analytic Default Report",
236 "title": "Example usage:",
237 "content": "curl https://{domain}/api/analytics/default_reports -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
241 "name": "CreateAnalytic_Default_Reports",
242 "group": "Analytic_Default_Reports",
257 "field": "description",
278 "field": "conditions",
291 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
293 "filename": "server/api/analyticDefaultReport/index.js",
294 "groupTitle": "Analytic_Default_Reports"
298 "url": "/api/analytics/default_reports/{id}",
299 "title": "Deletes a Analytic Default Report",
302 "title": "Example usage:",
303 "content": "curl https://{domain}/api/analytics/default_reports/{id} -v -u {name}:{password} -X DELETE",
307 "name": "DeleteAnalytic_Default_Reports",
308 "group": "Analytic_Default_Reports",
309 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
311 "filename": "server/api/analyticDefaultReport/index.js",
312 "groupTitle": "Analytic_Default_Reports"
316 "url": "/api/analytics/default_reports",
317 "title": "Gets a list of Analytic Default Reports",
320 "title": "Example usage:",
321 "content": "curl https://{domain}/api/analytics/default_reports -v -u {name}:{password}",
325 "name": "GetAnalytic_Default_Reports",
326 "group": "Analytic_Default_Reports",
327 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/analytics/default_reports?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/analytics/default_reports?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/analytics/default_reports?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/analytics/default_reports?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/analytics/default_reports?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
329 "filename": "server/api/analyticDefaultReport/index.js",
330 "groupTitle": "Analytic_Default_Reports"
334 "url": "/api/analytics/default_reports/{id}",
335 "title": "Gets a single Analytic Default Report",
338 "title": "Example usage:",
339 "content": "curl https://{domain}/api/analytics/default_reports/{id} -v -u {name}:{password}",
343 "name": "ShowAnalytic_Default_Reports",
344 "group": "Analytic_Default_Reports",
345 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
347 "filename": "server/api/analyticDefaultReport/index.js",
348 "groupTitle": "Analytic_Default_Reports"
352 "url": "/api/analytics/default_reports/{id}/preview",
353 "title": "Report Preview",
356 "title": "Example usage:",
357 "content": "curl https://{domain}/api/analytics/default_reports/{id}/preview -v -u {name}:{password} -X GET",
362 "group": "Analytic_Default_Reports",
363 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
365 "filename": "server/api/analyticDefaultReport/index.js",
366 "groupTitle": "Analytic_Default_Reports"
370 "url": "/api/analytics/default_reports/{id}/query",
371 "title": "Report Query SQL",
374 "title": "Example usage:",
375 "content": "curl https://{domain}/api/analytics/default_reports/{id}/query -v -u {name}:{password} -X GET",
380 "group": "Analytic_Default_Reports",
381 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
383 "filename": "server/api/analyticDefaultReport/index.js",
384 "groupTitle": "Analytic_Default_Reports"
388 "url": "/api/analytics/default_reports/{id}/run",
389 "title": "Report Run",
392 "title": "Example usage:",
393 "content": "curl https://{domain}/api/analytics/default_reports/{id}/run -v -u {name}:{password} -X GET",
398 "group": "Analytic_Default_Reports",
399 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
401 "filename": "server/api/analyticDefaultReport/index.js",
402 "groupTitle": "Analytic_Default_Reports"
406 "url": "/api/analytics/default_reports/{id}",
407 "title": "Update an existing Analytic Default Report",
410 "title": "Example usage:",
411 "content": "curl https://{domain}/api/analytics/default_reports/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
415 "name": "updateAnalytic_Default_Reports",
416 "group": "Analytic_Default_Reports",
417 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
419 "filename": "server/api/analyticDefaultReport/index.js",
420 "groupTitle": "Analytic_Default_Reports"
424 "url": "/api/analytics/extracted_reports",
425 "title": "Creates a new Analytic Extracted Report",
428 "title": "Example usage:",
429 "content": "curl https://{domain}/api/analytics/extracted_reports -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
433 "name": "CreateAnalytic_Extacted_Reports",
434 "group": "Analytic_Extracted_Reports",
475 "field": "startDate",
514 "field": "reportType",
520 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
522 "filename": "server/api/analyticExtractedReport/index.js",
523 "groupTitle": "Analytic_Extracted_Reports"
527 "url": "/api/analytics/extracted_reports/{id}",
528 "title": "Deletes a Analytic Extracted Report",
531 "title": "Example usage:",
532 "content": "curl https://{domain}/api/analytics/extracted_reports/{id} -v -u {name}:{password} -X DELETE",
536 "name": "DeleteAnalytic_Extacted_Reports",
537 "group": "Analytic_Extracted_Reports",
538 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
540 "filename": "server/api/analyticExtractedReport/index.js",
541 "groupTitle": "Analytic_Extracted_Reports"
545 "url": "/api/analytics/extracted_reports",
546 "title": "Gets a list of Analytic Extacted Reports",
549 "title": "Example usage:",
550 "content": "curl https://{domain}/api/analytics/extracted_reports -v -u {name}:{password}",
554 "name": "GetAnalytic_Extacted_Reports",
555 "group": "Analytic_Extracted_Reports",
556 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/analytics/extracted_reports?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/analytics/extracted_reports?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/analytics/extracted_reports?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/analytics/extracted_reports?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/analytics/extracted_reports?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
558 "filename": "server/api/analyticExtractedReport/index.js",
559 "groupTitle": "Analytic_Extracted_Reports"
563 "url": "/api/analytics/extracted_reports/{id}",
564 "title": "Gets a single Analytic Extracted Report",
567 "title": "Example usage:",
568 "content": "curl https://{domain}/api/analytics/extracted_reports/{id} -v -u {name}:{password}",
572 "name": "ShowAnalytic_Extacted_Reports",
573 "group": "Analytic_Extracted_Reports",
574 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
576 "filename": "server/api/analyticExtractedReport/index.js",
577 "groupTitle": "Analytic_Extracted_Reports"
581 "url": "/api/analytics/extracted_reports/{id}/download",
582 "title": "Download Extracted Report",
585 "title": "Example usage:",
586 "content": "curl https://{domain}/api/analytics/extracted_reports/{id}/download -v -u {name}:{password} -X GET",
591 "group": "Analytic_Extracted_Reports",
592 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
594 "filename": "server/api/analyticExtractedReport/index.js",
595 "groupTitle": "Analytic_Extracted_Reports"
599 "url": "/api/analytics/extracted_reports/{id}",
600 "title": "Update an existing Analytic Extracted Report",
603 "title": "Example usage:",
604 "content": "curl https://{domain}/api/analytics/extracted_reports/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
608 "name": "updateAnalytic_Extacted_Reports",
609 "group": "Analytic_Extracted_Reports",
610 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
612 "filename": "server/api/analyticExtractedReport/index.js",
613 "groupTitle": "Analytic_Extracted_Reports"
617 "url": "/api/analytics/field_reports/create_many",
618 "title": "Creates many Analytic Field Reports",
621 "title": "Example usage:",
622 "content": "curl https://{domain}/api/analytics/field_reports/create_many -d '[{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}]' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
626 "name": "BulkCreateAnalytic_Field_Reports",
627 "group": "Analytic_Field_Reports",
683 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
685 "filename": "server/api/analyticFieldReport/index.js",
686 "groupTitle": "Analytic_Field_Reports"
690 "url": "/api/analytics/field_reports/destroy_many?ids={ids}",
691 "title": "Deletes many Analytic Field Reports",
694 "title": "Example usage:",
695 "content": "curl https://{domain}/api/analytics/field_reports/destroy_many?ids=1&ids=2&ids=3 -v -u {name}:{password} -X DELETE",
699 "name": "BulkDeleteAnalytic_Field_Reports",
700 "group": "Analytic_Field_Reports",
701 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
703 "filename": "server/api/analyticFieldReport/index.js",
704 "groupTitle": "Analytic_Field_Reports"
708 "url": "/api/analytics/field_reports",
709 "title": "Creates a new Analytic Field Report",
712 "title": "Example usage:",
713 "content": "curl https://{domain}/api/analytics/field_reports -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
717 "name": "CreateAnalytic_Field_Reports",
718 "group": "Analytic_Field_Reports",
774 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
776 "filename": "server/api/analyticFieldReport/index.js",
777 "groupTitle": "Analytic_Field_Reports"
781 "url": "/api/analytics/field_reports/{id}",
782 "title": "Deletes a Analytic Field Report",
785 "title": "Example usage:",
786 "content": "curl https://{domain}/api/analytics/field_reports/{id} -v -u {name}:{password} -X DELETE",
790 "name": "DeleteAnalytic_Field_Reports",
791 "group": "Analytic_Field_Reports",
792 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
794 "filename": "server/api/analyticFieldReport/index.js",
795 "groupTitle": "Analytic_Field_Reports"
799 "url": "/api/analytics/field_reports",
800 "title": "Gets a list of Analytic Field Reports",
803 "title": "Example usage:",
804 "content": "curl https://{domain}/api/analytics/field_reports -v -u {name}:{password}",
808 "name": "GetAnalytic_Field_Reports",
809 "group": "Analytic_Field_Reports",
810 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/analytics/field_reports?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/analytics/field_reports?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/analytics/field_reports?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/analytics/field_reports?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/analytics/field_reports?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
812 "filename": "server/api/analyticFieldReport/index.js",
813 "groupTitle": "Analytic_Field_Reports"
817 "url": "/api/analytics/field_reports/{id}",
818 "title": "Gets a single Analytic Field Report",
821 "title": "Example usage:",
822 "content": "curl https://{domain}/api/analytics/field_reports/{id} -v -u {name}:{password}",
826 "name": "ShowAnalytic_Field_Reports",
827 "group": "Analytic_Field_Reports",
828 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
830 "filename": "server/api/analyticFieldReport/index.js",
831 "groupTitle": "Analytic_Field_Reports"
835 "url": "/api/analytics/field_reports/{id}/create_many",
836 "title": "Rewrite fields set",
839 "title": "Example usage:",
840 "content": "curl https://{domain}/api/analytics/field_reports/{id}/create_many -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
845 "group": "Analytic_Field_Reports",
846 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
848 "filename": "server/api/analyticFieldReport/index.js",
849 "groupTitle": "Analytic_Field_Reports"
853 "url": "/api/analytics/field_reports/{id}",
854 "title": "Update an existing Analytic Field Report",
857 "title": "Example usage:",
858 "content": "curl https://{domain}/api/analytics/field_reports/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
862 "name": "updateAnalytic_Field_Reports",
863 "group": "Analytic_Field_Reports",
864 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
866 "filename": "server/api/analyticFieldReport/index.js",
867 "groupTitle": "Analytic_Field_Reports"
871 "url": "/api/analytics/metrics",
872 "title": "Creates a new Analytic Metrics",
875 "title": "Example usage:",
876 "content": "curl https://{domain}/api/analytics/metrics -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
880 "name": "CreateAnalytic_Metric",
881 "group": "Analytic_Metrics",
910 "field": "description",
916 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
918 "filename": "server/api/analyticMetric/index.js",
919 "groupTitle": "Analytic_Metrics"
923 "url": "/api/analytics/metrics/{id}",
924 "title": "Deletes a Analytic Metrics",
927 "title": "Example usage:",
928 "content": "curl https://{domain}/api/analytics/metrics/{id} -v -u {name}:{password} -X DELETE",
932 "name": "DeleteAnalytic_Metric",
933 "group": "Analytic_Metrics",
934 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
936 "filename": "server/api/analyticMetric/index.js",
937 "groupTitle": "Analytic_Metrics"
941 "url": "/api/analytics/metrics",
942 "title": "Gets a list of Analytic Metric",
945 "title": "Example usage:",
946 "content": "curl https://{domain}/api/analytics/metrics -v -u {name}:{password}",
950 "name": "GetAnalytic_Metric",
951 "group": "Analytic_Metrics",
952 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/analytics/metrics?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/analytics/metrics?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/analytics/metrics?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/analytics/metrics?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/analytics/metrics?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
954 "filename": "server/api/analyticMetric/index.js",
955 "groupTitle": "Analytic_Metrics"
959 "url": "/api/analytics/metrics/{id}",
960 "title": "Gets a single Analytic Metrics",
963 "title": "Example usage:",
964 "content": "curl https://{domain}/api/analytics/metrics/{id} -v -u {name}:{password}",
968 "name": "ShowAnalytic_Metric",
969 "group": "Analytic_Metrics",
970 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
972 "filename": "server/api/analyticMetric/index.js",
973 "groupTitle": "Analytic_Metrics"
977 "url": "/api/analytics/metrics/{id}",
978 "title": "Update an existing Analytic Metrics",
981 "title": "Example usage:",
982 "content": "curl https://{domain}/api/analytics/metrics/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
986 "name": "updateAnalytic_Metric",
987 "group": "Analytic_Metrics",
988 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
990 "filename": "server/api/analyticMetric/index.js",
991 "groupTitle": "Analytic_Metrics"
995 "url": "/api/analytics/tree_reports",
996 "title": "Creates a new Analytic Tree Report",
999 "title": "Example usage:",
1000 "content": "curl https://{domain}/api/analytics/tree_reports -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
1004 "name": "CreateAnalytic_Tree_Reports",
1005 "group": "Analytic_Tree_Reports",
1019 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1021 "filename": "server/api/analyticTreeReport/index.js",
1022 "groupTitle": "Analytic_Tree_Reports"
1026 "url": "/api/analytics/tree_reports/{id}",
1027 "title": "Deletes a Analytic Tree Report",
1030 "title": "Example usage:",
1031 "content": "curl https://{domain}/api/analytics/tree_reports/{id} -v -u {name}:{password} -X DELETE",
1035 "name": "DeleteAnalytic_Tree_Reports",
1036 "group": "Analytic_Tree_Reports",
1037 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1039 "filename": "server/api/analyticTreeReport/index.js",
1040 "groupTitle": "Analytic_Tree_Reports"
1044 "url": "/api/analytics/tree_reports",
1045 "title": "Gets a list of Analytic Tree Reports",
1048 "title": "Example usage:",
1049 "content": "curl https://{domain}/api/analytics/tree_reports -v -u {name}:{password}",
1053 "name": "GetAnalytic_Tree_Reports",
1054 "group": "Analytic_Tree_Reports",
1055 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/analytics/tree_reports?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/analytics/tree_reports?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/analytics/tree_reports?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/analytics/tree_reports?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/analytics/tree_reports?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
1057 "filename": "server/api/analyticTreeReport/index.js",
1058 "groupTitle": "Analytic_Tree_Reports"
1062 "url": "/api/analytics/tree_reports/{id}",
1063 "title": "Gets a single Analytic Tree Report",
1066 "title": "Example usage:",
1067 "content": "curl https://{domain}/api/analytics/tree_reports/{id} -v -u {name}:{password}",
1071 "name": "ShowAnalytic_Tree_Reports",
1072 "group": "Analytic_Tree_Reports",
1073 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1075 "filename": "server/api/analyticTreeReport/index.js",
1076 "groupTitle": "Analytic_Tree_Reports"
1080 "url": "/api/analytics/tree_reports/{id}",
1081 "title": "Update an existing Analytic Tree Report",
1084 "title": "Example usage:",
1085 "content": "curl https://{domain}/api/analytics/tree_reports/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
1089 "name": "updateAnalytic_Tree_Reports",
1090 "group": "Analytic_Tree_Reports",
1091 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1093 "filename": "server/api/analyticTreeReport/index.js",
1094 "groupTitle": "Analytic_Tree_Reports"
1098 "url": "/api/attachments/clone",
1099 "title": "Clone an existing Attachment",
1102 "title": "Example usage:",
1103 "content": "curl https://{domain}/api/attachments/clone -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
1107 "name": "CloneAttachments",
1108 "group": "Attachments",
1109 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1111 "filename": "server/api/attachment/index.js",
1112 "groupTitle": "Attachments"
1116 "url": "/api/attachments/{id}",
1117 "title": "Deletes a Attachment",
1120 "title": "Example usage:",
1121 "content": "curl https://{domain}/api/attachments/{id} -v -u {name}:{password} -X DELETE",
1125 "name": "DeleteAttachments",
1126 "group": "Attachments",
1127 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1129 "filename": "server/api/attachment/index.js",
1130 "groupTitle": "Attachments"
1134 "url": "/api/attachments",
1135 "title": "Gets a list of Attachments",
1138 "title": "Example usage:",
1139 "content": "curl https://{domain}/api/attachments -v -u {name}:{password}",
1143 "name": "GetAttachments",
1144 "group": "Attachments",
1145 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/attachments?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/attachments?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/attachments?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/attachments?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/attachments?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
1147 "filename": "server/api/attachment/index.js",
1148 "groupTitle": "Attachments"
1152 "url": "/api/attachments/{id}",
1153 "title": "Gets a single Attachment",
1156 "title": "Example usage:",
1157 "content": "curl https://{domain}/api/attachments/{id} -v -u {name}:{password}",
1161 "name": "ShowAttachments",
1162 "group": "Attachments",
1163 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1165 "filename": "server/api/attachment/index.js",
1166 "groupTitle": "Attachments"
1170 "url": "/api/attachments",
1171 "title": "Add attachment",
1174 "title": "Example usage:",
1175 "content": "curl https://{domain}/api/attachments -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
1180 "group": "Attachments",
1181 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1183 "filename": "server/api/attachment/index.js",
1184 "groupTitle": "Attachments"
1188 "url": "/api/attachments/:id/download",
1189 "title": "Download attachment",
1192 "title": "Example usage:",
1193 "content": "curl https://{domain}/api/attachments/:id/download -v -u {name}:{password} -X GET",
1198 "group": "Attachments",
1199 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1201 "filename": "server/api/attachment/index.js",
1202 "groupTitle": "Attachments"
1206 "url": "/api/chat/interactions/{id}/attachment_download",
1207 "title": "Download attachment",
1210 "title": "Example usage:",
1211 "content": "curl https://{domain}/api/chat/interactions/{id}/attachment_download -v -u {name}:{password} -X GET",
1216 "group": "Attachments",
1217 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1219 "filename": "server/api/chatInteraction/index.js",
1220 "groupTitle": "Attachments"
1224 "url": "/api/attachments/{id}",
1225 "title": "Update an existing Attachment",
1228 "title": "Example usage:",
1229 "content": "curl https://{domain}/api/attachments/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
1233 "name": "updateAttachments",
1234 "group": "Attachments",
1235 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1237 "filename": "server/api/attachment/index.js",
1238 "groupTitle": "Attachments"
1242 "url": "/api/auth/local/forgot",
1243 "title": "Creates a new password reset token",
1246 "title": "Example usage:",
1247 "content": "curl https://{domain}/api/auth/local/forgot -d '{\"email\": \"john.doe@xcally.com\"}' \\\n -H \"Content-Type: application/json\" -X POST",
1251 "name": "Local_Forgot_Password",
1252 "group": "Authentication",
1266 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1268 "filename": "server/api/authLocal/index.js",
1269 "groupTitle": "Authentication"
1273 "url": "/api/auth/local/reset/:token",
1274 "title": "Reset user password",
1277 "title": "Example usage:",
1278 "content": "curl https://{domain}/api/auth/local/reset/94b422c1fkdjhg766a198da6997yu6gcc963641d -d '{\"password\": \"My_newP@ssw0rd\"}' \\\n -H \"Content-Type: application/json\" -X POST",
1282 "name": "Local_Reset_Password",
1283 "group": "Authentication",
1291 "field": "password",
1297 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1299 "filename": "server/api/authLocal/index.js",
1300 "groupTitle": "Authentication"
1304 "url": "/api/auth/local",
1305 "title": "Creates a new User token",
1308 "title": "Example usage:",
1309 "content": "curl https://{domain}/api/auth/local -d '{\"name\": \"john.doe\", \"password\": \"password\"}' \\\n -H \"Content-Type: application/json\" -X POST",
1313 "name": "Local_login",
1314 "group": "Authentication",
1329 "field": "password",
1335 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1337 "filename": "server/api/authLocal/index.js",
1338 "groupTitle": "Authentication"
1342 "url": "/api/auth/google",
1343 "title": "Creates a new User token",
1346 "title": "Example usage:",
1347 "content": "curl https://{domain}/api/auth/google -d '{\"name\": \"john.doe\", \"password\": \"password\"}' \\\n -H \"Content-Type: application/json\" -X POST",
1351 "name": "Local_login",
1352 "group": "Authentication",
1367 "field": "password",
1373 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1375 "filename": "server/api/authGoogle/index.js",
1376 "groupTitle": "Authentication"
1380 "url": "/api/automations",
1381 "title": "Creates a new Automation",
1384 "title": "Example usage:",
1385 "content": "curl https://{domain}/api/automations -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
1389 "name": "CreateAutomations",
1390 "group": "Automations",
1412 "field": "description",
1432 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1434 "filename": "server/api/automation/index.js",
1435 "groupTitle": "Automations"
1439 "url": "/api/automations/{id}",
1440 "title": "Deletes a Automation",
1443 "title": "Example usage:",
1444 "content": "curl https://{domain}/api/automations/{id} -v -u {name}:{password} -X DELETE",
1448 "name": "DeleteAutomations",
1449 "group": "Automations",
1450 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1452 "filename": "server/api/automation/index.js",
1453 "groupTitle": "Automations"
1457 "url": "/api/automations",
1458 "title": "Gets a list of Automations",
1461 "title": "Example usage:",
1462 "content": "curl https://{domain}/api/automations -v -u {name}:{password}",
1466 "name": "GetAutomations",
1467 "group": "Automations",
1468 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/automations?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/automations?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/automations?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/automations?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/automations?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
1470 "filename": "server/api/automation/index.js",
1471 "groupTitle": "Automations"
1475 "url": "/api/automations/{id}",
1476 "title": "Gets a single Automation",
1479 "title": "Example usage:",
1480 "content": "curl https://{domain}/api/automations/{id} -v -u {name}:{password}",
1484 "name": "ShowAutomations",
1485 "group": "Automations",
1486 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1488 "filename": "server/api/automation/index.js",
1489 "groupTitle": "Automations"
1493 "url": "/api/automations/{id}/actions",
1494 "title": "Creates new actions",
1497 "title": "Example usage:",
1498 "content": "curl https://{domain}/api/automations/{id}/actions -d '[{\"firstName\": \"John Doe\", \"email\": \"john.doe@xcally.com\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
1502 "name": "addActions",
1503 "group": "Automations",
1519 "description": "<p>Allowed values: contactManager, integration, motionbar, jscripty, urlForward, browser, bot, script</p>"
1526 "description": "<p>contactManager[ListId], integration[intName(zendesk)], motionbar[Popup(0),URL(1),WinApp(2)], urlForward[GET,POST], browser[TemplateId(0),URL(1)]</p>"
1533 "description": "<p>integration[AccountId], motionbar[TemplateId,URL,WinAppPath], urlForward[URL]</p>"
1540 "description": "<p>motionbar[NULL,NULL,WinAppArguments]</p>"
1573 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1575 "filename": "server/api/automation/index.js",
1576 "groupTitle": "Automations"
1580 "url": "/api/automations/{id}/conditions",
1581 "title": "Creates new conditions",
1584 "title": "Example usage:",
1585 "content": "curl https://{domain}/api/automations/{id}/conditions -d '[{\"firstName\": \"John Doe\", \"email\": \"john.doe@xcally.com\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
1589 "name": "addConditions",
1590 "group": "Automations",
1612 "field": "operator",
1625 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1627 "filename": "server/api/automation/index.js",
1628 "groupTitle": "Automations"
1632 "url": "/api/automations/{id}/actions",
1633 "title": "Gets Automation Actions",
1636 "title": "Example usage:",
1637 "content": "curl https://{domain}/api/automations/{id}/actions -v -u {name}:{password} -X GET",
1641 "name": "getActions",
1642 "group": "Automations",
1643 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1645 "filename": "server/api/automation/index.js",
1646 "groupTitle": "Automations"
1650 "url": "/api/automations/{id}/conditions",
1651 "title": "Gets Automation Conditions",
1654 "title": "Example usage:",
1655 "content": "curl https://{domain}/api/automations/{id}/conditions -v -u {name}:{password} -X GET",
1659 "name": "getConditions",
1660 "group": "Automations",
1661 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1663 "filename": "server/api/automation/index.js",
1664 "groupTitle": "Automations"
1668 "url": "/api/automations/{id}",
1669 "title": "Update an existing Automation",
1672 "title": "Example usage:",
1673 "content": "curl https://{domain}/api/automations/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
1677 "name": "updateAutomations",
1678 "group": "Automations",
1679 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1681 "filename": "server/api/automation/index.js",
1682 "groupTitle": "Automations"
1686 "url": "/api/canned_answers",
1687 "title": "Create a new canned answer",
1690 "title": "Example usage:",
1691 "content": "curl https://{domain}/api/canned_answers -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
1696 "group": "Canned_Answers",
1697 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1699 "filename": "server/api/cannedAnswer/index.js",
1700 "groupTitle": "Canned_Answers"
1704 "url": "/api/canned_answers/{id}",
1705 "title": "Deletes a Canned Answer",
1708 "title": "Example usage:",
1709 "content": "curl https://{domain}/api/canned_answers/{id} -v -u {name}:{password} -X DELETE",
1713 "name": "DeleteCanned_Answers",
1714 "group": "Canned_Answers",
1715 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1717 "filename": "server/api/cannedAnswer/index.js",
1718 "groupTitle": "Canned_Answers"
1722 "url": "/api/canned_answers",
1723 "title": "Gets a list of Canned Answers",
1726 "title": "Example usage:",
1727 "content": "curl https://{domain}/api/canned_answers -v -u {name}:{password}",
1731 "name": "GetCanned_Answers",
1732 "group": "Canned_Answers",
1733 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/canned_answers?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/canned_answers?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/canned_answers?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/canned_answers?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/canned_answers?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
1735 "filename": "server/api/cannedAnswer/index.js",
1736 "groupTitle": "Canned_Answers"
1740 "url": "/api/canned_answers/{id}",
1741 "title": "Gets a single Canned Answer",
1744 "title": "Example usage:",
1745 "content": "curl https://{domain}/api/canned_answers/{id} -v -u {name}:{password}",
1749 "name": "ShowCanned_Answers",
1750 "group": "Canned_Answers",
1751 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1753 "filename": "server/api/cannedAnswer/index.js",
1754 "groupTitle": "Canned_Answers"
1758 "url": "/api/canned_answers/{id}",
1759 "title": "Update an existing Canned Answer",
1762 "title": "Example usage:",
1763 "content": "curl https://{domain}/api/canned_answers/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
1767 "name": "updateCanned_Answers",
1768 "group": "Canned_Answers",
1769 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1771 "filename": "server/api/cannedAnswer/index.js",
1772 "groupTitle": "Canned_Answers"
1776 "url": "/chat/internal/users",
1777 "title": "Gets Users Last Messages",
1780 "title": "Example usage:",
1781 "content": "curl https://{domain}/chat/internal/users -v -u {name}:{password} -X GET",
1785 "name": "getLastUsersMessages",
1786 "group": "ChatInternalMessage",
1787 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1789 "filename": "server/api/chatInternalMessage/index.js",
1790 "groupTitle": "ChatInternalMessage"
1794 "url": "/api/chat/applications/{id}",
1795 "title": "Deletes a Application",
1798 "title": "Example usage:",
1799 "content": "curl https://{domain}/api/chat/applications/{id} -v -u {name}:{password} -X DELETE",
1803 "name": "DeleteApplications",
1804 "group": "Chat_Applications",
1805 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1807 "filename": "server/api/chatApplication/index.js",
1808 "groupTitle": "Chat_Applications"
1812 "url": "/api/chat/applications/{id}",
1813 "title": "Gets a single Application",
1816 "title": "Example usage:",
1817 "content": "curl https://{domain}/api/chat/applications/{id} -v -u {name}:{password}",
1821 "name": "ShowApplications",
1822 "group": "Chat_Applications",
1823 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1825 "filename": "server/api/chatApplication/index.js",
1826 "groupTitle": "Chat_Applications"
1830 "url": "/api/chat/applications/{id}",
1831 "title": "Update an existing Application",
1834 "title": "Example usage:",
1835 "content": "curl https://{domain}/api/chat/applications/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
1839 "name": "updateApplications",
1840 "group": "Chat_Applications",
1841 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1843 "filename": "server/api/chatApplication/index.js",
1844 "groupTitle": "Chat_Applications"
1848 "url": "/api/chat/groups",
1849 "title": "Creates a new Group",
1852 "title": "Example usage:",
1853 "content": "curl https://{domain}/api/chat/groups -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
1857 "name": "CreateGroups",
1858 "group": "Chat_Groups",
1873 "field": "description",
1886 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1888 "filename": "server/api/chatGroup/index.js",
1889 "groupTitle": "Chat_Groups"
1893 "url": "/api/chat/groups/{id}",
1894 "title": "Deletes a Group",
1897 "title": "Example usage:",
1898 "content": "curl https://{domain}/api/chat/groups/{id} -v -u {name}:{password} -X DELETE",
1902 "name": "DeleteGroups",
1903 "group": "Chat_Groups",
1904 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1906 "filename": "server/api/chatGroup/index.js",
1907 "groupTitle": "Chat_Groups"
1911 "url": "/api/chat/groups/describe",
1912 "title": "Gets table info about Groups",
1915 "title": "Example usage:",
1916 "content": "curl https://{domain}/api/chat/groups/describe -v -u {name}:{password}",
1920 "name": "DescribeGroups",
1921 "group": "Chat_Groups",
1922 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1924 "filename": "server/api/chatGroup/index.js",
1925 "groupTitle": "Chat_Groups"
1929 "url": "/api/chat/groups",
1930 "title": "Gets a list of Groups",
1933 "title": "Example usage:",
1934 "content": "curl https://{domain}/api/chat/groups -v -u {name}:{password}",
1938 "name": "GetGroups",
1939 "group": "Chat_Groups",
1940 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/chat/groups?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/chat/groups?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/chat/groups?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/chat/groups?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/chat/groups?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
1942 "filename": "server/api/chatGroup/index.js",
1943 "groupTitle": "Chat_Groups"
1947 "url": "/api/chat/groups/{id}/members",
1948 "title": "Removes members from a group",
1951 "title": "Example usage:",
1952 "content": "curl https://{domain}/api/chat/groups/{id}/members?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
1956 "name": "RemoveMembers",
1957 "group": "Chat_Groups",
1958 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1960 "filename": "server/api/chatGroup/index.js",
1961 "groupTitle": "Chat_Groups"
1965 "url": "/api/chat/groups/{id}",
1966 "title": "Gets a single Group",
1969 "title": "Example usage:",
1970 "content": "curl https://{domain}/api/chat/groups/{id} -v -u {name}:{password}",
1974 "name": "ShowGroups",
1975 "group": "Chat_Groups",
1976 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1978 "filename": "server/api/chatGroup/index.js",
1979 "groupTitle": "Chat_Groups"
1983 "url": "/api/chat/groups/{id}/members",
1984 "title": "Add members to chat group",
1987 "title": "Example usage:",
1988 "content": "curl https://{domain}/api/chat/groups/{id}/members -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
1992 "name": "addMembers",
1993 "group": "Chat_Groups",
1994 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1996 "filename": "server/api/chatGroup/index.js",
1997 "groupTitle": "Chat_Groups"
2001 "url": "/api/chat/groups/{id}/messages",
2002 "title": "Creates a new group message",
2005 "title": "Example usage:",
2006 "content": "curl https://{domain}/api/chat/groups/{id}/messages -d '{\"body\": \"Hi operator!\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
2010 "name": "addMessage",
2011 "group": "Chat_Groups",
2012 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2014 "filename": "server/api/chatGroup/index.js",
2015 "groupTitle": "Chat_Groups"
2019 "url": "/api/chat/groups/{id}/members",
2020 "title": "Gets Members",
2023 "title": "Example usage:",
2024 "content": "curl https://{domain}/api/chat/groups/{id}/members -v -u {name}:{password} -X GET",
2028 "name": "getMembers",
2029 "group": "Chat_Groups",
2030 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2032 "filename": "server/api/chatGroup/index.js",
2033 "groupTitle": "Chat_Groups"
2037 "url": "/api/chat/groups/{id}/messages",
2038 "title": "Gets Messages",
2041 "title": "Example usage:",
2042 "content": "curl https://{domain}/api/chat/groups/{id}/messages -v -u {name}:{password} -X GET",
2046 "name": "getMessages",
2047 "group": "Chat_Groups",
2048 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2050 "filename": "server/api/chatGroup/index.js",
2051 "groupTitle": "Chat_Groups"
2055 "url": "/api/chat/groups/{id}/unread",
2056 "title": "Get unread chat group messages",
2059 "title": "Example usage:",
2060 "content": "curl https://{domain}/api/chat/groups/{id}/unread -H 'Content-Type: application/json' -v -u {name}:{password} -X GET",
2065 "group": "Chat_Groups",
2066 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2068 "filename": "server/api/chatGroup/index.js",
2069 "groupTitle": "Chat_Groups"
2073 "url": "/api/chat/groups/{id}",
2074 "title": "Update an existing Group",
2077 "title": "Example usage:",
2078 "content": "curl https://{domain}/api/chat/groups/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
2082 "name": "updateGroups",
2083 "group": "Chat_Groups",
2084 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2086 "filename": "server/api/chatGroup/index.js",
2087 "groupTitle": "Chat_Groups"
2091 "url": "/api/chat/interactions/{id}/tags",
2092 "title": "Add tags to the interaction",
2095 "title": "Example usage:",
2096 "content": "curl https://{domain}/api/chat/interaction/{id}/tags -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
2101 "group": "Chat_Interactions",
2102 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2104 "filename": "server/api/chatInteraction/index.js",
2105 "groupTitle": "Chat_Interactions"
2109 "url": "/api/chat/interactions",
2110 "title": "Creates a new Interaction",
2113 "title": "Example usage:",
2114 "content": "curl https://{domain}/api/chat/interactions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
2118 "name": "CreateInteractions",
2119 "group": "Chat_Interactions",
2134 "field": "ratingValue",
2145 "field": "ratingType",
2152 "field": "ratingMessage",
2159 "field": "pathTranscript",
2166 "field": "mailTranscript",
2173 "field": "closedAt",
2180 "field": "disposition",
2187 "field": "secondDisposition",
2194 "field": "thirdDisposition",
2208 "field": "browserName",
2215 "field": "browserVersion",
2229 "field": "osVersion",
2236 "field": "deviceModel",
2243 "field": "deviceVendor",
2250 "field": "deviceType",
2264 "field": "customerIp",
2271 "field": "formData",
2278 "field": "read1stAt",
2285 "field": "lastMsgAt",
2296 "field": "lastMsgDirection",
2303 "field": "closeReason",
2310 "field": "customerPort",
2317 "field": "vidaooSessionId",
2323 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2325 "filename": "server/api/chatInteraction/index.js",
2326 "groupTitle": "Chat_Interactions"
2330 "url": "/api/chat/interactions/{id}",
2331 "title": "Deletes a Interaction",
2334 "title": "Example usage:",
2335 "content": "curl https://{domain}/api/chat/interactions/{id} -v -u {name}:{password} -X DELETE",
2339 "name": "DeleteInteractions",
2340 "group": "Chat_Interactions",
2341 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2343 "filename": "server/api/chatInteraction/index.js",
2344 "groupTitle": "Chat_Interactions"
2348 "url": "/api/chat/interactions/describe",
2349 "title": "Gets table info about Interactions",
2352 "title": "Example usage:",
2353 "content": "curl https://{domain}/api/chat/interactions/describe -v -u {name}:{password}",
2357 "name": "DescribeInteractions",
2358 "group": "Chat_Interactions",
2359 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2361 "filename": "server/api/chatInteraction/index.js",
2362 "groupTitle": "Chat_Interactions"
2366 "url": "/api/chat/interactions",
2367 "title": "Gets a list of Interactions",
2370 "title": "Example usage:",
2371 "content": "curl https://{domain}/api/chat/interactions -v -u {name}:{password}",
2375 "name": "GetInteractions",
2376 "group": "Chat_Interactions",
2377 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/chat/interactions?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/chat/interactions?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/chat/interactions?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/chat/interactions?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/chat/interactions?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
2379 "filename": "server/api/chatInteraction/index.js",
2380 "groupTitle": "Chat_Interactions"
2384 "url": "/api/chat/interactions/{id}/tags",
2385 "title": "Removes tags from interaction",
2388 "title": "Example usage:",
2389 "content": "curl https://{domain}/api/chat/interactions/{id}/tags?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
2393 "name": "RemoveTags",
2394 "group": "Chat_Interactions",
2395 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2397 "filename": "server/api/chatInteraction/index.js",
2398 "groupTitle": "Chat_Interactions"
2402 "url": "/api/chat/interactions/{id}",
2403 "title": "Gets a single Interaction",
2406 "title": "Example usage:",
2407 "content": "curl https://{domain}/api/chat/interactions/{id} -v -u {name}:{password}",
2411 "name": "ShowInteractions",
2412 "group": "Chat_Interactions",
2413 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2415 "filename": "server/api/chatInteraction/index.js",
2416 "groupTitle": "Chat_Interactions"
2420 "url": "/api/chat/interactions/{id}/abandon",
2421 "title": "Abandon interaction",
2424 "title": "Example usage:",
2425 "content": "curl https://{domain}/api/chat/interactions/{id}/abandon -d '{\"channel\": \"chat\", \"...\": \"...\"}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
2430 "group": "Chat_Interactions",
2431 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <p>This API is used to set as abandon an interaction and stop the routing.</p>",
2433 "filename": "server/api/chatInteraction/index.js",
2434 "groupTitle": "Chat_Interactions"
2438 "url": "/api/chat/interactions/{id}/messages",
2439 "title": "Creates new messages",
2442 "title": "Example usage:",
2443 "content": "curl https://{domain}/api/chat/interactions/{id}/messages -d '[{\"to\": \"+3901119886500\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
2447 "name": "addMessage",
2448 "group": "Chat_Interactions",
2481 "field": "direction",
2495 "field": "providerName",
2502 "field": "providerResponse",
2508 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2510 "filename": "server/api/chatInteraction/index.js",
2511 "groupTitle": "Chat_Interactions"
2515 "url": "/api/chat/interactions/{id}/close",
2516 "title": "Close Interaction",
2519 "title": "Example usage:",
2520 "content": "curl https://{domain}/api/chat/interactions/{id}/close -d '[{\"to\": \"+3901119886500\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
2524 "name": "addMessage",
2525 "group": "Chat_Interactions",
2526 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2528 "filename": "server/api/chatInteraction/index.js",
2529 "groupTitle": "Chat_Interactions"
2533 "url": "/api/chat/interactions/{id}/attachment_upload",
2534 "title": "Add attachment",
2537 "title": "Example usage:",
2538 "content": "curl https://{domain}/api/chat/interactions/{id}/attachment_upload -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
2542 "name": "attachmentUpload",
2543 "group": "Chat_Interactions",
2544 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2546 "filename": "server/api/chatInteraction/index.js",
2547 "groupTitle": "Chat_Interactions"
2551 "url": "/api/chat/interactions/{id}/vidaoo",
2552 "title": "Create Vidaoo Session",
2555 "title": "Example usage:",
2556 "content": "curl https://{domain}/api/chat/interactions/{id}/vidaoo -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
2560 "name": "createVidaooSession",
2561 "group": "Chat_Interactions",
2562 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2564 "filename": "server/api/chatInteraction/index.js",
2565 "groupTitle": "Chat_Interactions"
2569 "url": "/api/chat/interactions/{id}/custom_update",
2570 "title": "Update interaction",
2573 "title": "Example usage:",
2574 "content": "curl https://{domain}/api/chat/interactions/{id}/custom_update -d '{\"channel\": \"chat\", \"...\": \"...\"}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
2578 "name": "customUpdate",
2579 "group": "Chat_Interactions",
2580 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <p>This API is used to update an interaction.</p>",
2582 "filename": "server/api/chatInteraction/index.js",
2583 "groupTitle": "Chat_Interactions"
2587 "url": "/api/chat/interactions/{id}/download",
2588 "title": "Gets interaction",
2591 "title": "Example usage:",
2592 "content": "curl https://{domain}/api/chat/interactions/{id}/download -v -u {name}:{password} -X GET",
2597 "group": "Chat_Interactions",
2598 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2600 "filename": "server/api/chatInteraction/index.js",
2601 "groupTitle": "Chat_Interactions"
2605 "url": "/api/chat/interactions/{id}/messages",
2606 "title": "Gets interaction messages",
2609 "title": "Example usage:",
2610 "content": "curl https://{domain}/api/chat/interactions/{id}/messages -v -u {name}:{password} -X GET",
2614 "name": "getMessages",
2615 "group": "Chat_Interactions",
2616 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2618 "filename": "server/api/chatInteraction/index.js",
2619 "groupTitle": "Chat_Interactions"
2623 "url": "/api/chat/interactions/{id}/my_messages",
2624 "title": "Gets interaction messages",
2627 "title": "Example usage:",
2628 "content": "curl https://{domain}/api/chat/interactions/{id}/my_messages -v -u {name}:{password} -X GET",
2632 "name": "getMyMessages",
2633 "group": "Chat_Interactions",
2634 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2636 "filename": "server/api/chatInteraction/index.js",
2637 "groupTitle": "Chat_Interactions"
2641 "url": "/api/chat/interactions/{id}",
2642 "title": "Update an existing Interaction",
2645 "title": "Example usage:",
2646 "content": "curl https://{domain}/api/chat/interactions/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
2650 "name": "updateInteractions",
2651 "group": "Chat_Interactions",
2652 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2654 "filename": "server/api/chatInteraction/index.js",
2655 "groupTitle": "Chat_Interactions"
2659 "url": "/api/chat/internal/messages",
2660 "title": "Creates a new Message",
2663 "title": "Example usage:",
2664 "content": "curl https://{domain}/api/chat/internal/messages -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
2668 "name": "CreateMessages",
2669 "group": "Chat_Internal_Messages",
2691 "field": "ChatInternalMessageId",
2697 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2699 "filename": "server/api/chatInternalMessage/index.js",
2700 "groupTitle": "Chat_Internal_Messages"
2704 "url": "/api/chat/internal/messages/{id}",
2705 "title": "Deletes a Message",
2708 "title": "Example usage:",
2709 "content": "curl https://{domain}/api/chat/internal/messages/{id} -v -u {name}:{password} -X DELETE",
2713 "name": "DeleteMessages",
2714 "group": "Chat_Internal_Messages",
2715 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2717 "filename": "server/api/chatInternalMessage/index.js",
2718 "groupTitle": "Chat_Internal_Messages"
2722 "url": "/api/chat/internal/messages/describe",
2723 "title": "Gets table info about Messages",
2726 "title": "Example usage:",
2727 "content": "curl https://{domain}/api/chat/internal/messages/describe -v -u {name}:{password}",
2731 "name": "DescribeMessages",
2732 "group": "Chat_Internal_Messages",
2733 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2735 "filename": "server/api/chatInternalMessage/index.js",
2736 "groupTitle": "Chat_Internal_Messages"
2740 "url": "/api/chat/internal/messages",
2741 "title": "Gets a list of Messages",
2744 "title": "Example usage:",
2745 "content": "curl https://{domain}/api/chat/internal/messages -v -u {name}:{password}",
2749 "name": "GetMessages",
2750 "group": "Chat_Internal_Messages",
2751 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/chat/internal/messages?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/chat/internal/messages?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/chat/internal/messages?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/chat/internal/messages?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/chat/internal/messages?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
2753 "filename": "server/api/chatInternalMessage/index.js",
2754 "groupTitle": "Chat_Internal_Messages"
2758 "url": "/api/chat/internal/messages/{id}",
2759 "title": "Gets a single Message",
2762 "title": "Example usage:",
2763 "content": "curl https://{domain}/api/chat/internal/messages/{id} -v -u {name}:{password}",
2767 "name": "ShowMessages",
2768 "group": "Chat_Internal_Messages",
2769 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2771 "filename": "server/api/chatInternalMessage/index.js",
2772 "groupTitle": "Chat_Internal_Messages"
2776 "url": "/api/chat/internal/messages/{id}",
2777 "title": "Update an existing Message",
2780 "title": "Example usage:",
2781 "content": "curl https://{domain}/api/chat/internal/messages/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
2785 "name": "updateMessages",
2786 "group": "Chat_Internal_Messages",
2787 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2789 "filename": "server/api/chatInternalMessage/index.js",
2790 "groupTitle": "Chat_Internal_Messages"
2794 "url": "/api/chat/messages",
2795 "title": "Creates a new Message",
2798 "title": "Example usage:",
2799 "content": "curl https://{domain}/api/chat/messages -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
2803 "name": "CreateMessages",
2804 "group": "Chat_Messages",
2837 "field": "direction",
2851 "field": "providerName",
2858 "field": "providerResponse",
2864 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2866 "filename": "server/api/chatMessage/index.js",
2867 "groupTitle": "Chat_Messages"
2871 "url": "/api/chat/messages/{id}",
2872 "title": "Deletes a Message",
2875 "title": "Example usage:",
2876 "content": "curl https://{domain}/api/chat/messages/{id} -v -u {name}:{password} -X DELETE",
2880 "name": "DeleteMessages",
2881 "group": "Chat_Messages",
2882 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2884 "filename": "server/api/chatMessage/index.js",
2885 "groupTitle": "Chat_Messages"
2889 "url": "/api/chat/messages/describe",
2890 "title": "Gets table info about Messages",
2893 "title": "Example usage:",
2894 "content": "curl https://{domain}/api/chat/messages/describe -v -u {name}:{password}",
2898 "name": "DescribeMessages",
2899 "group": "Chat_Messages",
2900 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2902 "filename": "server/api/chatMessage/index.js",
2903 "groupTitle": "Chat_Messages"
2907 "url": "/api/chat/messages",
2908 "title": "Gets a list of Messages",
2911 "title": "Example usage:",
2912 "content": "curl https://{domain}/api/chat/messages -v -u {name}:{password}",
2916 "name": "GetMessages",
2917 "group": "Chat_Messages",
2918 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/chat/messages?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/chat/messages?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/chat/messages?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/chat/messages?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/chat/messages?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
2920 "filename": "server/api/chatMessage/index.js",
2921 "groupTitle": "Chat_Messages"
2925 "url": "/api/chat/messages/{id}",
2926 "title": "Gets a single Message",
2929 "title": "Example usage:",
2930 "content": "curl https://{domain}/api/chat/messages/{id} -v -u {name}:{password}",
2934 "name": "ShowMessages",
2935 "group": "Chat_Messages",
2936 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2938 "filename": "server/api/chatMessage/index.js",
2939 "groupTitle": "Chat_Messages"
2943 "url": "/api/chat/messages/{id}",
2944 "title": "Update an existing Message",
2947 "title": "Example usage:",
2948 "content": "curl https://{domain}/api/chat/messages/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
2952 "name": "updateMessages",
2953 "group": "Chat_Messages",
2954 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2956 "filename": "server/api/chatMessage/index.js",
2957 "groupTitle": "Chat_Messages"
2961 "url": "/api/chat/offline_messages",
2962 "title": "Creates a new OfflineMessage",
2965 "title": "Example usage:",
2966 "content": "curl https://{domain}/api/chat/offline_messages -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
2970 "name": "CreateOfflineMessages",
2971 "group": "Chat_Offline_Messages",
2985 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2987 "filename": "server/api/chatOfflineMessage/index.js",
2988 "groupTitle": "Chat_Offline_Messages"
2992 "url": "/api/chat/offline_messages/{id}",
2993 "title": "Deletes a OfflineMessage",
2996 "title": "Example usage:",
2997 "content": "curl https://{domain}/api/chat/offline_messages/{id} -v -u {name}:{password} -X DELETE",
3001 "name": "DeleteOfflineMessages",
3002 "group": "Chat_Offline_Messages",
3003 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3005 "filename": "server/api/chatOfflineMessage/index.js",
3006 "groupTitle": "Chat_Offline_Messages"
3010 "url": "/api/chat/offline_messages/describe",
3011 "title": "Gets table info about OfflineMessages",
3014 "title": "Example usage:",
3015 "content": "curl https://{domain}/api/chat/offline_messages/describe -v -u {name}:{password}",
3019 "name": "DescribeOfflineMessages",
3020 "group": "Chat_Offline_Messages",
3021 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3023 "filename": "server/api/chatOfflineMessage/index.js",
3024 "groupTitle": "Chat_Offline_Messages"
3028 "url": "/api/chat/offline_messages",
3029 "title": "Gets a list of OfflineMessages",
3032 "title": "Example usage:",
3033 "content": "curl https://{domain}/api/chat/offline_messages -v -u {name}:{password}",
3037 "name": "GetOfflineMessages",
3038 "group": "Chat_Offline_Messages",
3039 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/chat/offline_messages?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/chat/offline_messages?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/chat/offline_messages?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/chat/offline_messages?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/chat/offline_messages?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
3041 "filename": "server/api/chatOfflineMessage/index.js",
3042 "groupTitle": "Chat_Offline_Messages"
3046 "url": "/api/chat/offline_messages/{id}",
3047 "title": "Gets a single OfflineMessage",
3050 "title": "Example usage:",
3051 "content": "curl https://{domain}/api/chat/offline_messages/{id} -v -u {name}:{password}",
3055 "name": "ShowOfflineMessages",
3056 "group": "Chat_Offline_Messages",
3057 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3059 "filename": "server/api/chatOfflineMessage/index.js",
3060 "groupTitle": "Chat_Offline_Messages"
3064 "url": "/api/chat/offline_messages/{id}",
3065 "title": "Update an existing OfflineMessage",
3068 "title": "Example usage:",
3069 "content": "curl https://{domain}/api/chat/offline_messages/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
3073 "name": "updateOfflineMessages",
3074 "group": "Chat_Offline_Messages",
3075 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3077 "filename": "server/api/chatOfflineMessage/index.js",
3078 "groupTitle": "Chat_Offline_Messages"
3082 "url": "/api/chat/proactive_actions",
3083 "title": "Creates a new Proactive Action",
3086 "title": "Example usage:",
3087 "content": "curl https://{domain}/api/chat/proactive_actions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
3091 "name": "CreateProactive_Actions",
3092 "group": "Chat_Proactive_Actions",
3118 "field": "selector",
3131 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3133 "filename": "server/api/chatProactiveAction/index.js",
3134 "groupTitle": "Chat_Proactive_Actions"
3138 "url": "/api/chat/proactive_actions/{id}",
3139 "title": "Deletes a Proactive Action",
3142 "title": "Example usage:",
3143 "content": "curl https://{domain}/api/chat/proactive_actions/{id} -v -u {name}:{password} -X DELETE",
3147 "name": "DeleteProactive_Actions",
3148 "group": "Chat_Proactive_Actions",
3149 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3151 "filename": "server/api/chatProactiveAction/index.js",
3152 "groupTitle": "Chat_Proactive_Actions"
3156 "url": "/api/chat/proactive_actions/{id}",
3157 "title": "Gets a single Proactive Action",
3160 "title": "Example usage:",
3161 "content": "curl https://{domain}/api/chat/proactive_actions/{id} -v -u {name}:{password}",
3165 "name": "ShowProactive_Actions",
3166 "group": "Chat_Proactive_Actions",
3167 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3169 "filename": "server/api/chatProactiveAction/index.js",
3170 "groupTitle": "Chat_Proactive_Actions"
3174 "url": "/api/chat/proactive_actions/{id}",
3175 "title": "Update an existing Proactive Action",
3178 "title": "Example usage:",
3179 "content": "curl https://{domain}/api/chat/proactive_actions/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
3183 "name": "updateProactive_Actions",
3184 "group": "Chat_Proactive_Actions",
3185 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3187 "filename": "server/api/chatProactiveAction/index.js",
3188 "groupTitle": "Chat_Proactive_Actions"
3192 "url": "/api/chat/reports/queue",
3193 "title": "Creates a new Chat Queue Report",
3196 "title": "Example usage:",
3197 "content": "curl https://{domain}/api/chat/reports/queue -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
3201 "name": "CreateChat_Queue_Reports",
3202 "group": "Chat_Queue_Reports",
3210 "field": "uniqueid",
3238 "field": "acceptAt",
3258 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3260 "filename": "server/api/chatQueueReport/index.js",
3261 "groupTitle": "Chat_Queue_Reports"
3265 "url": "/api/chat/reports/queue/{id}",
3266 "title": "Deletes a Chat Queue Report",
3269 "title": "Example usage:",
3270 "content": "curl https://{domain}/api/chat/reports/queue/{id} -v -u {name}:{password} -X DELETE",
3274 "name": "DeleteChat_Queue_Reports",
3275 "group": "Chat_Queue_Reports",
3276 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3278 "filename": "server/api/chatQueueReport/index.js",
3279 "groupTitle": "Chat_Queue_Reports"
3283 "url": "/api/chat/reports/queue/describe",
3284 "title": "Gets table info about Chat Queue Reports",
3287 "title": "Example usage:",
3288 "content": "curl https://{domain}/api/chat/reports/queue/describe -v -u {name}:{password}",
3292 "name": "DescribeChat_Queue_Reports",
3293 "group": "Chat_Queue_Reports",
3294 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3296 "filename": "server/api/chatQueueReport/index.js",
3297 "groupTitle": "Chat_Queue_Reports"
3301 "url": "/api/chat/reports/queue",
3302 "title": "Gets a list of Chat Queue Reports",
3305 "title": "Example usage:",
3306 "content": "curl https://{domain}/api/chat/reports/queue -v -u {name}:{password}",
3310 "name": "GetChat_Queue_Reports",
3311 "group": "Chat_Queue_Reports",
3312 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/chat/reports/queue?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/chat/reports/queue?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/chat/reports/queue?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/chat/reports/queue?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/chat/reports/queue?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
3314 "filename": "server/api/chatQueueReport/index.js",
3315 "groupTitle": "Chat_Queue_Reports"
3319 "url": "/api/chat/reports/queue/{id}",
3320 "title": "Gets a single Chat Queue Report",
3323 "title": "Example usage:",
3324 "content": "curl https://{domain}/api/chat/reports/queue/{id} -v -u {name}:{password}",
3328 "name": "ShowChat_Queue_Reports",
3329 "group": "Chat_Queue_Reports",
3330 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3332 "filename": "server/api/chatQueueReport/index.js",
3333 "groupTitle": "Chat_Queue_Reports"
3337 "url": "/api/chat/reports/queue/{id}",
3338 "title": "Update an existing Chat Queue Report",
3341 "title": "Example usage:",
3342 "content": "curl https://{domain}/api/chat/reports/queue/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
3346 "name": "updateChat_Queue_Reports",
3347 "group": "Chat_Queue_Reports",
3348 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3350 "filename": "server/api/chatQueueReport/index.js",
3351 "groupTitle": "Chat_Queue_Reports"
3355 "url": "/api/chat/queues/{id}/users",
3356 "title": "Add agents to a queue",
3359 "title": "Example usage:",
3360 "content": "curl https://{domain}/api/chat/queues/{id}/users -d '{\"ids\": [1,2], \"penalty\": 2}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
3364 "name": "AddAgents",
3365 "group": "Chat_Queues",
3366 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3368 "filename": "server/api/chatQueue/index.js",
3369 "groupTitle": "Chat_Queues"
3373 "url": "/api/chat/queues/{id}/teams",
3374 "title": "Add teams to a queue",
3377 "title": "Example usage:",
3378 "content": "curl https://{domain}/api/chat/queues/{id}/teams -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
3383 "group": "Chat_Queues",
3384 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3386 "filename": "server/api/chatQueue/index.js",
3387 "groupTitle": "Chat_Queues"
3391 "url": "/api/chat/queues",
3392 "title": "Creates a new Queue",
3395 "title": "Example usage:",
3396 "content": "curl https://{domain}/api/chat/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
3400 "name": "CreateQueues",
3401 "group": "Chat_Queues",
3416 "field": "description",
3435 "field": "strategy",
3441 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3443 "filename": "server/api/chatQueue/index.js",
3444 "groupTitle": "Chat_Queues"
3448 "url": "/api/chat/queues/{id}",
3449 "title": "Deletes a Queue",
3452 "title": "Example usage:",
3453 "content": "curl https://{domain}/api/chat/queues/{id} -v -u {name}:{password} -X DELETE",
3457 "name": "DeleteQueues",
3458 "group": "Chat_Queues",
3459 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3461 "filename": "server/api/chatQueue/index.js",
3462 "groupTitle": "Chat_Queues"
3466 "url": "/api/chat/queues/describe",
3467 "title": "Gets table info about Queues",
3470 "title": "Example usage:",
3471 "content": "curl https://{domain}/api/chat/queues/describe -v -u {name}:{password}",
3475 "name": "DescribeQueues",
3476 "group": "Chat_Queues",
3477 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3479 "filename": "server/api/chatQueue/index.js",
3480 "groupTitle": "Chat_Queues"
3484 "url": "/api/chat/queues/{id}/users",
3485 "title": "Gets queue agents",
3488 "title": "Example usage:",
3489 "content": "curl https://{domain}/api/chat/queues/{id}/users -v -u {name}:{password} -X POST",
3493 "name": "GetAgents",
3494 "group": "Chat_Queues",
3495 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3497 "filename": "server/api/chatQueue/index.js",
3498 "groupTitle": "Chat_Queues"
3502 "url": "/api/chat/queues/{id}/members",
3503 "title": "GetMembers",
3506 "title": "Example usage:",
3507 "content": "curl https://{domain}/api/chat/queues/{id}/members -v -u {name}:{password}",
3511 "name": "GetMembers",
3512 "group": "Chat_Queues",
3513 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3515 "filename": "server/api/chatQueue/index.js",
3516 "groupTitle": "Chat_Queues"
3520 "url": "/api/chat/queues",
3521 "title": "Gets a list of Queues",
3524 "title": "Example usage:",
3525 "content": "curl https://{domain}/api/chat/queues -v -u {name}:{password}",
3529 "name": "GetQueues",
3530 "group": "Chat_Queues",
3531 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/chat/queues?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/chat/queues?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/chat/queues?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/chat/queues?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/chat/queues?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
3533 "filename": "server/api/chatQueue/index.js",
3534 "groupTitle": "Chat_Queues"
3538 "url": "/api/chat/queues/{id}/teams",
3539 "title": "Gets queues list",
3542 "title": "Example usage:",
3543 "content": "curl https://{domain}/api/chat/queues/{id}/teams -v -u {name}:{password}",
3548 "group": "Chat_Queues",
3549 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3551 "filename": "server/api/chatQueue/index.js",
3552 "groupTitle": "Chat_Queues"
3556 "url": "/api/chat/queues/{id}/users",
3557 "title": "Removes agents from a queue",
3560 "title": "Example usage:",
3561 "content": "curl https://{domain}/api/chat/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
3565 "name": "RemoveAgents",
3566 "group": "Chat_Queues",
3567 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3569 "filename": "server/api/chatQueue/index.js",
3570 "groupTitle": "Chat_Queues"
3574 "url": "/api/chat/queues/{id}",
3575 "title": "Gets a single Queue",
3578 "title": "Example usage:",
3579 "content": "curl https://{domain}/api/chat/queues/{id} -v -u {name}:{password}",
3583 "name": "ShowQueues",
3584 "group": "Chat_Queues",
3585 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3587 "filename": "server/api/chatQueue/index.js",
3588 "groupTitle": "Chat_Queues"
3592 "url": "/api/chat/queues/{id}",
3593 "title": "Update an existing Queue",
3596 "title": "Example usage:",
3597 "content": "curl https://{domain}/api/chat/queues/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
3601 "name": "updateQueues",
3602 "group": "Chat_Queues",
3603 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3605 "filename": "server/api/chatQueue/index.js",
3606 "groupTitle": "Chat_Queues"
3610 "url": "/api/chat/reports/transfer",
3611 "title": "Creates a new Chat Transfer Report",
3614 "title": "Example usage:",
3615 "content": "curl https://{domain}/api/chat/reports/transfer -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
3619 "name": "CreateChat_Transfer_Reports",
3620 "group": "Chat_Transfer_Reports",
3628 "field": "uniqueid",
3647 "field": "transferredAt",
3653 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3655 "filename": "server/api/chatTransferReport/index.js",
3656 "groupTitle": "Chat_Transfer_Reports"
3660 "url": "/api/chat/reports/transfer/{id}",
3661 "title": "Deletes a Chat Transfer Report",
3664 "title": "Example usage:",
3665 "content": "curl https://{domain}/api/chat/reports/transfer/{id} -v -u {name}:{password} -X DELETE",
3669 "name": "DeleteChat_Transfer_Reports",
3670 "group": "Chat_Transfer_Reports",
3671 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3673 "filename": "server/api/chatTransferReport/index.js",
3674 "groupTitle": "Chat_Transfer_Reports"
3678 "url": "/api/chat/reports/transfer/describe",
3679 "title": "Gets table info about Chat Transfer Reports",
3682 "title": "Example usage:",
3683 "content": "curl https://{domain}/api/chat/reports/transfer/describe -v -u {name}:{password}",
3687 "name": "DescribeChat_Transfer_Reports",
3688 "group": "Chat_Transfer_Reports",
3689 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3691 "filename": "server/api/chatTransferReport/index.js",
3692 "groupTitle": "Chat_Transfer_Reports"
3696 "url": "/api/chat/reports/transfer",
3697 "title": "Gets a list of Chat Transfer Reports",
3700 "title": "Example usage:",
3701 "content": "curl https://{domain}/api/chat/reports/transfer -v -u {name}:{password}",
3705 "name": "GetChat_Transfer_Reports",
3706 "group": "Chat_Transfer_Reports",
3707 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/chat/reports/transfer?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/chat/reports/transfer?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/chat/reports/transfer?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/chat/reports/transfer?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/chat/reports/transfer?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
3709 "filename": "server/api/chatTransferReport/index.js",
3710 "groupTitle": "Chat_Transfer_Reports"
3714 "url": "/api/chat/reports/transfer/{id}",
3715 "title": "Gets a single Chat Transfer Report",
3718 "title": "Example usage:",
3719 "content": "curl https://{domain}/api/chat/reports/transfer/{id} -v -u {name}:{password}",
3723 "name": "ShowChat_Transfer_Reports",
3724 "group": "Chat_Transfer_Reports",
3725 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3727 "filename": "server/api/chatTransferReport/index.js",
3728 "groupTitle": "Chat_Transfer_Reports"
3732 "url": "/api/chat/reports/transfer/{id}",
3733 "title": "Update an existing Chat Transfer Report",
3736 "title": "Example usage:",
3737 "content": "curl https://{domain}/api/chat/reports/transfer/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
3741 "name": "updateChat_Transfer_Reports",
3742 "group": "Chat_Transfer_Reports",
3743 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3745 "filename": "server/api/chatTransferReport/index.js",
3746 "groupTitle": "Chat_Transfer_Reports"
3750 "url": "/api/chat/websites/{id}/users",
3751 "title": "Add agents to a website",
3754 "title": "Example usage:",
3755 "content": "curl https://{domain}/api/chat/websites/{id}/users -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
3759 "name": "AddAgents",
3760 "group": "Chat_Websites",
3761 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3763 "filename": "server/api/chatWebsite/index.js",
3764 "groupTitle": "Chat_Websites"
3768 "url": "/api/chat/websites",
3769 "title": "Creates a new Website",
3772 "title": "Example usage:",
3773 "content": "curl https://{domain}/api/chat/websites -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
3777 "name": "CreateWebsites",
3778 "group": "Chat_Websites",
3800 "field": "description",
3814 "field": "mapKeyOffline",
3828 "field": "agentAlias",
3835 "field": "customerAlias",
3849 "field": "color_button",
3856 "field": "textColor",
3863 "field": "fontSize",
3877 "field": "animation",
3888 "field": "header_shape",
3895 "field": "header_online",
3902 "field": "start_chat_button",
3909 "field": "offline_chat_button",
3916 "field": "header_offline",
3923 "field": "download_transcript",
3937 "field": "whiteLabel",
3944 "field": "defaultWhiteLabel",
3958 "field": "closingQuestion",
3965 "field": "formSubmitSuccessMessage",
3972 "field": "formSubmitFailureMessage",
3979 "field": "noteTitle",
3986 "field": "placeholderMessage",
3993 "field": "closingMessage",
4000 "field": "closingMessageButton",
4007 "field": "skipMessageButton",
4014 "field": "conditionAgreement",
4021 "field": "enableRating",
4028 "field": "enableFeedback",
4035 "field": "enableSendButton",
4042 "field": "feedbackTitle",
4053 "field": "ratingType",
4060 "field": "ratingStarsNumber",
4067 "field": "onlineForm",
4074 "field": "offlineForm",
4088 "field": "autoclose",
4095 "field": "enableCustomerWriting",
4102 "field": "forwardTranscript",
4109 "field": "forwardTranscriptMessage",
4116 "field": "forwardOffline",
4123 "field": "forwardOfflineAddress",
4130 "field": "waitingTitle",
4137 "field": "waitingMessage",
4144 "field": "offlineMessageSubject",
4151 "field": "offlineMessageBody",
4158 "field": "enableUnmanagedNote",
4165 "field": "unmanagedMessage",
4172 "field": "skipUnmanaged",
4179 "field": "sendUnmanaged",
4186 "field": "enableCustomerAttachment",
4193 "field": "enableCustomerCheckmarks",
4200 "field": "agentAvatar",
4207 "field": "showAgentAvatar",
4214 "field": "timezone",
4221 "field": "notificationTemplate",
4228 "field": "notificationSound",
4235 "field": "notificationShake",
4242 "field": "hideWhenOffline",
4249 "field": "agentIdentifier",
4256 "field": "waitForTheAssignedAgent",
4263 "field": "alignment",
4270 "field": "verticalAlignment",
4277 "field": "messagesAlignment",
4284 "field": "defaultTitle",
4291 "field": "customerAvatar",
4298 "field": "showCustomerAvatar",
4305 "field": "messageFontSize",
4312 "field": "backgroundColor",
4319 "field": "queueTransfer",
4326 "field": "queueTransferTimeout",
4333 "field": "agentTransfer",
4340 "field": "agentTransferTimeout",
4347 "field": "systemAlias",
4354 "field": "systemAvatar",
4361 "field": "mandatoryDispositionPauseId",
4362 "description": "<p>Status to put when mandatory disposition is enabled</p>"
4368 "field": "mandatoryDisposition",
4369 "description": "<p>Enabled/disables mandatory dispo on a queue</p>"
4375 "field": "vidaooEscalation",
4382 "field": "vidaooApiKey",
4389 "field": "openNewInteraction",
4395 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4397 "filename": "server/api/chatWebsite/index.js",
4398 "groupTitle": "Chat_Websites"
4402 "url": "/api/chat/websites/{id}",
4403 "title": "Deletes a Website",
4406 "title": "Example usage:",
4407 "content": "curl https://{domain}/api/chat/websites/{id} -v -u {name}:{password} -X DELETE",
4411 "name": "DeleteWebsites",
4412 "group": "Chat_Websites",
4413 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4415 "filename": "server/api/chatWebsite/index.js",
4416 "groupTitle": "Chat_Websites"
4420 "url": "/api/chat/websites/describe",
4421 "title": "Gets table info about Websites",
4424 "title": "Example usage:",
4425 "content": "curl https://{domain}/api/chat/websites/describe -v -u {name}:{password}",
4429 "name": "DescribeWebsites",
4430 "group": "Chat_Websites",
4431 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4433 "filename": "server/api/chatWebsite/index.js",
4434 "groupTitle": "Chat_Websites"
4438 "url": "/api/chat/websites/{id}/users",
4439 "title": "Gets agents from website",
4442 "title": "Example usage:",
4443 "content": "curl https://{domain}/api/chat/websites/{id}/users -v -u {name}:{password} -X GET",
4447 "name": "GetAgents",
4448 "group": "Chat_Websites",
4449 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4451 "filename": "server/api/chatWebsite/index.js",
4452 "groupTitle": "Chat_Websites"
4456 "url": "/api/chat/websites",
4457 "title": "Gets a list of Websites",
4460 "title": "Example usage:",
4461 "content": "curl https://{domain}/api/chat/websites -v -u {name}:{password}",
4465 "name": "GetWebsites",
4466 "group": "Chat_Websites",
4467 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
4469 "filename": "server/api/chatWebsite/index.js",
4470 "groupTitle": "Chat_Websites"
4474 "url": "/api/chat/websites/{id}/users",
4475 "title": "Removes agents from a website",
4478 "title": "Example usage:",
4479 "content": "curl https://{domain}/api/chat/websites/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
4483 "name": "RemoveAgents",
4484 "group": "Chat_Websites",
4485 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4487 "filename": "server/api/chatWebsite/index.js",
4488 "groupTitle": "Chat_Websites"
4492 "url": "/api/chat/websites/{id}/canned_answers",
4493 "title": "Removes canned answers from account",
4496 "title": "Example usage:",
4497 "content": "curl https://{domain}/api/chat/websites/{id}/canned_answers?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
4501 "name": "RemoveAnswers",
4502 "group": "Chat_Websites",
4503 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4505 "filename": "server/api/chatWebsite/index.js",
4506 "groupTitle": "Chat_Websites"
4510 "url": "/api/chat/websites/{id}/dispositions",
4511 "title": "Removes canned answers from account",
4514 "title": "Example usage:",
4515 "content": "curl https://{domain}/api/chat/websites/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
4519 "name": "RemoveDispositions",
4520 "group": "Chat_Websites",
4521 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4523 "filename": "server/api/chatWebsite/index.js",
4524 "groupTitle": "Chat_Websites"
4528 "url": "/api/chat/websites/{id}",
4529 "title": "Gets a single Website",
4532 "title": "Example usage:",
4533 "content": "curl https://{domain}/api/chat/websites/{id} -v -u {name}:{password}",
4537 "name": "ShowWebsites",
4538 "group": "Chat_Websites",
4539 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4541 "filename": "server/api/chatWebsite/index.js",
4542 "groupTitle": "Chat_Websites"
4546 "url": "/api/chat/messages/{id}/accept",
4547 "title": "Accepts message",
4550 "title": "Example usage:",
4551 "content": "curl https://{domain}/api/chat/messages/{id}/accept \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
4555 "name": "acceptMessage",
4556 "group": "Chat_Websites",
4557 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4559 "filename": "server/api/chatMessage/index.js",
4560 "groupTitle": "Chat_Websites"
4564 "url": "/api/chat/websites/{id}/canned_answers",
4565 "title": "Creates new canned answer",
4568 "title": "Example usage:",
4569 "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",
4573 "name": "addAnswer",
4574 "group": "Chat_Websites",
4596 "field": "description",
4609 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4611 "filename": "server/api/chatWebsite/index.js",
4612 "groupTitle": "Chat_Websites"
4616 "url": "/api/chat/websites/{id}/applications",
4617 "title": "Creates new applications",
4620 "title": "Example usage:",
4621 "content": "curl https://{domain}/api/chat/websites/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
4625 "name": "addApplications",
4626 "group": "Chat_Websites",
4634 "field": "priority",
4655 "field": "description",
4662 "field": "interval",
4668 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4670 "filename": "server/api/chatWebsite/index.js",
4671 "groupTitle": "Chat_Websites"
4675 "url": "/api/chat/websites/{id}/avatar",
4676 "title": "Add avatar",
4679 "title": "Example usage:",
4680 "content": "curl https://{domain}/api/chat/websites/{id}/avatar -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
4684 "name": "addAvatar",
4685 "group": "Chat_Websites",
4686 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4688 "filename": "server/api/chatWebsite/index.js",
4689 "groupTitle": "Chat_Websites"
4693 "url": "/api/chat/websites/{id}/customer_avatar",
4694 "title": "Add customer avatar",
4697 "title": "Example usage:",
4698 "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",
4702 "name": "addCustomerAvatar",
4703 "group": "Chat_Websites",
4704 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4706 "filename": "server/api/chatWebsite/index.js",
4707 "groupTitle": "Chat_Websites"
4711 "url": "/api/chat/websites/{id}/dispositions",
4712 "title": "Creates new disposition",
4715 "title": "Example usage:",
4716 "content": "curl https://{domain}/api/chat/websites/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
4720 "name": "addDisposition",
4721 "group": "Chat_Websites",
4748 "field": "description",
4754 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4756 "filename": "server/api/chatWebsite/index.js",
4757 "groupTitle": "Chat_Websites"
4761 "url": "/api/chat/accounts/{id}/interactions",
4762 "title": "Creates new interactions",
4765 "title": "Example usage:",
4766 "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",
4770 "name": "addInteraction",
4771 "group": "Chat_Websites",
4786 "field": "ratingValue",
4797 "field": "ratingType",
4804 "field": "ratingMessage",
4811 "field": "pathTranscript",
4818 "field": "mailTranscript",
4825 "field": "closedAt",
4832 "field": "disposition",
4839 "field": "secondDisposition",
4846 "field": "thirdDisposition",
4860 "field": "browserName",
4867 "field": "browserVersion",
4881 "field": "osVersion",
4888 "field": "deviceModel",
4895 "field": "deviceVendor",
4902 "field": "deviceType",
4916 "field": "customerIp",
4923 "field": "formData",
4930 "field": "read1stAt",
4937 "field": "lastMsgAt",
4948 "field": "lastMsgDirection",
4955 "field": "closeReason",
4962 "field": "customerPort",
4969 "field": "vidaooSessionId",
4975 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4977 "filename": "server/api/chatWebsite/index.js",
4978 "groupTitle": "Chat_Websites"
4982 "url": "/api/chat/websites/{id}/logo",
4983 "title": "Add logo",
4986 "title": "Example usage:",
4987 "content": "curl https://{domain}/api/chat/websites/{id}/logo -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
4992 "group": "Chat_Websites",
4993 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4995 "filename": "server/api/chatWebsite/index.js",
4996 "groupTitle": "Chat_Websites"
5000 "url": "/api/chat/websites/{id}/proactive_actions",
5001 "title": "Creates new Proactive Actions",
5004 "title": "Example usage:",
5005 "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",
5009 "name": "addProactiveActions",
5010 "group": "Chat_Websites",
5036 "field": "selector",
5049 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5051 "filename": "server/api/chatWebsite/index.js",
5052 "groupTitle": "Chat_Websites"
5056 "url": "/api/chat/websites/{id}/system_avatar",
5057 "title": "Add system avatar",
5060 "title": "Example usage:",
5061 "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",
5065 "name": "addSystemAvatar",
5066 "group": "Chat_Websites",
5067 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5069 "filename": "server/api/chatWebsite/index.js",
5070 "groupTitle": "Chat_Websites"
5074 "url": "/api/chat/websites/{id}/canned_answers",
5075 "title": "Gets account canned answers",
5078 "title": "Example usage:",
5079 "content": "curl https://{domain}/api/chat/websites/{id}/canned_answers -v -u {name}:{password} -X GET",
5083 "name": "getAnswers",
5084 "group": "Chat_Websites",
5085 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5087 "filename": "server/api/chatWebsite/index.js",
5088 "groupTitle": "Chat_Websites"
5092 "url": "/api/chat/websites/{id}/applications",
5093 "title": "Gets Website Applications",
5096 "title": "Example usage:",
5097 "content": "curl https://{domain}/api/chat/websites/{id}/applications -v -u {name}:{password} -X GET",
5101 "name": "getApplications",
5102 "group": "Chat_Websites",
5103 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5105 "filename": "server/api/chatWebsite/index.js",
5106 "groupTitle": "Chat_Websites"
5110 "url": "/api/chat/websites/{id}/avatar",
5111 "title": "Get avatar",
5114 "title": "Example usage:",
5115 "content": "curl https://{domain}/api/chat/websites/{id}/avatar -v -u {name}:{password} -X GET",
5119 "name": "getAvatar",
5120 "group": "Chat_Websites",
5121 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5123 "filename": "server/api/chatWebsite/index.js",
5124 "groupTitle": "Chat_Websites"
5128 "url": "/api/chat/websites/{id}/customer_avatar",
5129 "title": "Get Customer Avatar",
5132 "title": "Example usage:",
5133 "content": "curl https://{domain}/api/chat/websites/{id}/customer_avatar -v -u {name}:{password} -X GET",
5137 "name": "getCustomerAvatar",
5138 "group": "Chat_Websites",
5139 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5141 "filename": "server/api/chatWebsite/index.js",
5142 "groupTitle": "Chat_Websites"
5146 "url": "/api/chat/websites/{id}/dispositions",
5147 "title": "Gets account dispositions",
5150 "title": "Example usage:",
5151 "content": "curl https://{domain}/api/chat/websites/{id}/dispositions -v -u {name}:{password} -X GET",
5155 "name": "getDispositions",
5156 "group": "Chat_Websites",
5157 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5159 "filename": "server/api/chatWebsite/index.js",
5160 "groupTitle": "Chat_Websites"
5164 "url": "/api/chat/websites/{id}/fields",
5165 "title": "Gets Website Fields",
5168 "title": "Example usage:",
5169 "content": "curl https://{domain}/api/chat/websites/{id}/fields -v -u {name}:{password} -X GET",
5173 "name": "getFields",
5174 "group": "Chat_Websites",
5175 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5177 "filename": "server/api/chatWebsite/index.js",
5178 "groupTitle": "Chat_Websites"
5182 "url": "/api/chat/websites/{id}/interactions",
5183 "title": "Gets Website Interactions",
5186 "title": "Example usage:",
5187 "content": "curl https://{domain}/api/chat/websites/{id}/interactions -v -u {name}:{password} -X GET",
5191 "name": "getInteraction",
5192 "group": "Chat_Websites",
5193 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5195 "filename": "server/api/chatWebsite/index.js",
5196 "groupTitle": "Chat_Websites"
5200 "url": "/api/chat/websites/{id}/logo",
5201 "title": "Get logo",
5204 "title": "Example usage:",
5205 "content": "curl https://{domain}/api/chat/websites/{id}/logo -v -u {name}:{password} -X GET",
5210 "group": "Chat_Websites",
5211 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5213 "filename": "server/api/chatWebsite/index.js",
5214 "groupTitle": "Chat_Websites"
5218 "url": "/api/chat/websites/{id}/offline_messages",
5219 "title": "Gets Website Offline Messages",
5222 "title": "Example usage:",
5223 "content": "curl https://{domain}/api/chat/websites/{id}/offline_messages -v -u {name}:{password} -X GET",
5227 "name": "getOfflineMessages",
5228 "group": "Chat_Websites",
5229 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5231 "filename": "server/api/chatWebsite/index.js",
5232 "groupTitle": "Chat_Websites"
5236 "url": "/api/chat/websites/{id}/proactive_actions",
5237 "title": "Gets Website Proactive Actions",
5240 "title": "Example usage:",
5241 "content": "curl https://{domain}/api/chat/websites/{id}/proactive_actions -v -u {name}:{password} -X GET",
5245 "name": "getProactiveActions",
5246 "group": "Chat_Websites",
5247 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5249 "filename": "server/api/chatWebsite/index.js",
5250 "groupTitle": "Chat_Websites"
5254 "url": "/api/chat/websites/{id}/snippet",
5255 "title": "Gets Website Snippet",
5258 "title": "Example usage:",
5259 "content": "curl https://{domain}/api/chat/websites/{id}/snippet -v -u {name}:{password} -X GET",
5263 "name": "getSnippet",
5264 "group": "Chat_Websites",
5265 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5267 "filename": "server/api/chatWebsite/index.js",
5268 "groupTitle": "Chat_Websites"
5272 "url": "/api/chat/websites/{id}/system_avatar",
5273 "title": "Get System Avatar",
5276 "title": "Example usage:",
5277 "content": "curl https://{domain}/api/chat/websites/{id}/system_avatar -v -u {name}:{password} -X GET",
5281 "name": "getSystemAvatar",
5282 "group": "Chat_Websites",
5283 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5285 "filename": "server/api/chatWebsite/index.js",
5286 "groupTitle": "Chat_Websites"
5290 "url": "/api/chat/websites/{id}/notify",
5291 "title": "Notify new message",
5294 "title": "Example usage:",
5295 "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",
5300 "group": "Chat_Websites",
5301 "description": "<p>Motion 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>",
5303 "filename": "server/api/chatWebsite/index.js",
5304 "groupTitle": "Chat_Websites"
5308 "url": "/api/chat/websites/{id}/offline",
5309 "title": "Offline message",
5312 "title": "Example usage:",
5313 "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",
5318 "group": "Chat_Websites",
5319 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5321 "filename": "server/api/chatWebsite/index.js",
5322 "groupTitle": "Chat_Websites"
5326 "url": "/api/chat/messages/{id}/reject",
5327 "title": "Rejects message",
5330 "title": "Example usage:",
5331 "content": "curl https://{domain}/api/chat/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
5335 "name": "rejectMessage",
5336 "group": "Chat_Websites",
5337 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5339 "filename": "server/api/chatMessage/index.js",
5340 "groupTitle": "Chat_Websites"
5344 "url": "/api/chat/websites/{id}",
5345 "title": "Update an existing Website",
5348 "title": "Example usage:",
5349 "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",
5353 "name": "updateWebsites",
5354 "group": "Chat_Websites",
5355 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5357 "filename": "server/api/chatWebsite/index.js",
5358 "groupTitle": "Chat_Websites"
5362 "url": "/api/cloudProviders",
5363 "title": "Creates a new CloudProvider",
5366 "title": "Example usage:",
5367 "content": "curl https://{domain}/api/cloudProviders -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
5371 "name": "CreateCloudProviders",
5372 "group": "CloudProviders",
5411 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5413 "filename": "server/api/cloudProvider/index.js",
5414 "groupTitle": "CloudProviders"
5418 "url": "/api/cloudProviders/{id}",
5419 "title": "Deletes a CloudProvider",
5422 "title": "Example usage:",
5423 "content": "curl https://{domain}/api/cloudProviders/{id} -v -u {name}:{password} -X DELETE",
5427 "name": "DeleteCloudProviders",
5428 "group": "CloudProviders",
5429 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5431 "filename": "server/api/cloudProvider/index.js",
5432 "groupTitle": "CloudProviders"
5436 "url": "/api/cloudProviders",
5437 "title": "Gets a list of CloudProviders",
5440 "title": "Example usage:",
5441 "content": "curl https://{domain}/api/cloudProviders -v -u {name}:{password}",
5445 "name": "GetCloudProviders",
5446 "group": "CloudProviders",
5447 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
5449 "filename": "server/api/cloudProvider/index.js",
5450 "groupTitle": "CloudProviders"
5454 "url": "/api/cloudProviders/{id}",
5455 "title": "Gets a single CloudProvider",
5458 "title": "Example usage:",
5459 "content": "curl https://{domain}/api/cloudProviders/{id} -v -u {name}:{password}",
5463 "name": "ShowCloudProviders",
5464 "group": "CloudProviders",
5465 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5467 "filename": "server/api/cloudProvider/index.js",
5468 "groupTitle": "CloudProviders"
5472 "url": "/api/cloudProviders/{id}",
5473 "title": "Update an existing CloudProvider",
5476 "title": "Example usage:",
5477 "content": "curl https://{domain}/api/cloudProviders/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
5481 "name": "updateCloudProviders",
5482 "group": "CloudProviders",
5483 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5485 "filename": "server/api/cloudProvider/index.js",
5486 "groupTitle": "CloudProviders"
5490 "url": "/api/cm/companies",
5491 "title": "Creates a new Company",
5494 "title": "Example usage:",
5495 "content": "curl https://{domain}/api/cm/companies -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
5499 "name": "CreateCompanies",
5500 "group": "Cm_Companies",
5522 "field": "companyId",
5564 "field": "postalCode",
5592 "field": "emailDomain",
5606 "field": "sPostalCode",
5620 "field": "sCountry",
5627 "field": "description",
5633 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5635 "filename": "server/api/cmCompany/index.js",
5636 "groupTitle": "Cm_Companies"
5640 "url": "/api/cm/companies/{id}",
5641 "title": "Deletes a Company",
5644 "title": "Example usage:",
5645 "content": "curl https://{domain}/api/cm/companies/{id} -v -u {name}:{password} -X DELETE",
5649 "name": "DeleteCompanies",
5650 "group": "Cm_Companies",
5651 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5653 "filename": "server/api/cmCompany/index.js",
5654 "groupTitle": "Cm_Companies"
5658 "url": "/api/cm/companies/describe",
5659 "title": "Gets table info about Companies",
5662 "title": "Example usage:",
5663 "content": "curl https://{domain}/api/cm/companies/describe -v -u {name}:{password}",
5667 "name": "DescribeCompanies",
5668 "group": "Cm_Companies",
5669 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5671 "filename": "server/api/cmCompany/index.js",
5672 "groupTitle": "Cm_Companies"
5676 "url": "/api/cm/companies",
5677 "title": "Gets a list of Companies",
5680 "title": "Example usage:",
5681 "content": "curl https://{domain}/api/cm/companies -v -u {name}:{password}",
5685 "name": "GetCompanies",
5686 "group": "Cm_Companies",
5687 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
5689 "filename": "server/api/cmCompany/index.js",
5690 "groupTitle": "Cm_Companies"
5694 "url": "/api/cm/companies/{id}",
5695 "title": "Gets a single Company",
5698 "title": "Example usage:",
5699 "content": "curl https://{domain}/api/cm/companies/{id} -v -u {name}:{password}",
5703 "name": "ShowCompanies",
5704 "group": "Cm_Companies",
5705 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5707 "filename": "server/api/cmCompany/index.js",
5708 "groupTitle": "Cm_Companies"
5712 "url": "/api/cm/companies/{id}/contacts",
5713 "title": "Creates new contacts",
5716 "title": "Example usage:",
5717 "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",
5721 "name": "addContacts",
5722 "group": "Cm_Companies",
5730 "field": "firstName",
5737 "field": "lastName",
5751 "field": "postalCode",
5772 "field": "dateOfBirth",
5779 "field": "description",
5821 "field": "facebook",
5877 "field": "telegram",
5891 "field": "priority",
5898 "field": "scheduledat",
5904 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5906 "filename": "server/api/cmCompany/index.js",
5907 "groupTitle": "Cm_Companies"
5911 "url": "/api/cm/companies/{id}/contacts",
5912 "title": "Gets List Contacts",
5915 "title": "Example usage:",
5916 "content": "curl https://{domain}/api/fax/companies/{id}/contacts -v -u {name}:{password} -X GET",
5920 "name": "getContacts",
5921 "group": "Cm_Companies",
5922 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5924 "filename": "server/api/cmCompany/index.js",
5925 "groupTitle": "Cm_Companies"
5929 "url": "/api/cm/companies/{id}",
5930 "title": "Update an existing Company",
5933 "title": "Example usage:",
5934 "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",
5938 "name": "updateCompanies",
5939 "group": "Cm_Companies",
5940 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5942 "filename": "server/api/cmCompany/index.js",
5943 "groupTitle": "Cm_Companies"
5947 "url": "/api/cm/contacts/{id}",
5948 "title": "Deletes a Contact",
5951 "title": "Example usage:",
5952 "content": "curl https://{domain}/api/cm/contacts/{id} -v -u {name}:{password} -X DELETE",
5956 "name": "DeleteContacts",
5957 "group": "Cm_Contacts",
5958 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5960 "filename": "server/api/cmContact/index.js",
5961 "groupTitle": "Cm_Contacts"
5965 "url": "/api/cm/contacts/describe",
5966 "title": "Gets table info about Contacts",
5969 "title": "Example usage:",
5970 "content": "curl https://{domain}/api/cm/contacts/describe -v -u {name}:{password}",
5974 "name": "DescribeContacts",
5975 "group": "Cm_Contacts",
5976 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5978 "filename": "server/api/cmContact/index.js",
5979 "groupTitle": "Cm_Contacts"
5983 "url": "/api/cm/contacts",
5984 "title": "Gets a list of Contacts",
5987 "title": "Example usage:",
5988 "content": "curl https://{domain}/api/cm/contacts -v -u {name}:{password}",
5992 "name": "GetContacts",
5993 "group": "Cm_Contacts",
5994 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
5996 "filename": "server/api/cmContact/index.js",
5997 "groupTitle": "Cm_Contacts"
6001 "url": "/api/cm/contacts/{id}/finals",
6002 "title": "Gets contact hopper finals",
6005 "title": "Example usage:",
6006 "content": "curl https://{domain}/api/cm/contacts/{id}/hopper_finals -v -u {name}:{password} -X GET",
6010 "name": "GetHopperFinals",
6011 "group": "Cm_Contacts",
6012 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6014 "filename": "server/api/cmContact/index.js",
6015 "groupTitle": "Cm_Contacts"
6019 "url": "/api/cm/contacts/{id}/hopper_histories",
6020 "title": "Gets contact hopper histories",
6023 "title": "Example usage:",
6024 "content": "curl https://{domain}/api/cm/contacts/{id}/hopper_histories -v -u {name}:{password} -X GET",
6028 "name": "GetHopperHistories",
6029 "group": "Cm_Contacts",
6030 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6032 "filename": "server/api/cmContact/index.js",
6033 "groupTitle": "Cm_Contacts"
6037 "url": "/api/cm/contacts/{id}/hoppers",
6038 "title": "Gets contact hoppers",
6041 "title": "Example usage:",
6042 "content": "curl https://{domain}/api/cm/contacts/{id}/hoppers -v -u {name}:{password} -X GET",
6046 "name": "GetHoppers",
6047 "group": "Cm_Contacts",
6048 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6050 "filename": "server/api/cmContact/index.js",
6051 "groupTitle": "Cm_Contacts"
6055 "url": "/api/cm/contacts/create_many",
6056 "title": "Create Contacts",
6059 "title": "Example usage:",
6060 "content": "curl https://{domain}/api/cm/contacts/create_many -d '[{\"firstName\": \"John\", \"lastName\": \"doe\", \"...\": \"...\"}]' -v -u {name}:{password} -X POST",
6064 "name": "bulkCreate",
6065 "group": "Cm_Contacts",
6066 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6068 "filename": "server/api/cmContact/index.js",
6069 "groupTitle": "Cm_Contacts"
6073 "url": "/api/cm/contacts",
6074 "title": "Create Contact",
6077 "title": "Example usage:",
6078 "content": "curl https://{domain}/api/cm/contacts -d '{\"firstName\": \"John\", \"lastName\": \"doe\", \"...\": \"...\"}' -v -u {name}:{password} -X POST",
6083 "group": "Cm_Contacts",
6084 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6086 "filename": "server/api/cmContact/index.js",
6087 "groupTitle": "Cm_Contacts"
6091 "url": "/api/cm/contacts/{id}/journey",
6092 "title": "Gets customer journey",
6095 "title": "Example usage:",
6096 "content": "curl https://{domain}/api/cm/contacts/{id}/journey -v -u {name}:{password} -X GET",
6100 "name": "getJourney",
6101 "group": "Cm_Contacts",
6102 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6104 "filename": "server/api/cmContact/index.js",
6105 "groupTitle": "Cm_Contacts"
6109 "url": "/api/cm/contacts/{id}/jscripty_sessions",
6110 "title": "Gets contact hopper blacks",
6113 "title": "Example usage:",
6114 "content": "curl https://{domain}/api/cm/contacts/{id}/hopper_black -v -u {name}:{password} -X GET",
6118 "name": "getJscriptySessions",
6119 "group": "Cm_Contacts",
6120 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6122 "filename": "server/api/cmContact/index.js",
6123 "groupTitle": "Cm_Contacts"
6127 "url": "/api/cm/contacts/{id}/tags",
6128 "title": "Gets configurations tags",
6131 "title": "Example usage:",
6132 "content": "curl https://{domain}/api/cm/contacts/{id}/tags -v -u {name}:{password} -X GET",
6137 "group": "Cm_Contacts",
6138 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6140 "filename": "server/api/cmContact/index.js",
6141 "groupTitle": "Cm_Contacts"
6145 "url": "/api/cm/contacts/merge",
6146 "title": "Merge Contact",
6149 "title": "Example usage:",
6150 "content": "curl https://{domain}/api/cm/contacts/merge -d '{\"from\": 1, \"to\": 2}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
6155 "group": "Cm_Contacts",
6156 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6158 "filename": "server/api/cmContact/index.js",
6159 "groupTitle": "Cm_Contacts"
6163 "url": "/api/cm/contacts/{id}/tags",
6164 "title": "Sets new tags",
6167 "title": "Example usage:",
6168 "content": "curl https://{domain}/api/cm/contacts/{id}/tags -d '{\"ids\": [1,12]}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
6173 "group": "Cm_Contacts",
6174 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6176 "filename": "server/api/cmContact/index.js",
6177 "groupTitle": "Cm_Contacts"
6181 "url": "/api/cm/contacts/{id}",
6182 "title": "Gets a single Contact",
6185 "title": "Example usage:",
6186 "content": "curl https://{domain}/api/cm/contacts/{id} -v -u {name}:{password} -X GET",
6191 "group": "Cm_Contacts",
6192 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6194 "filename": "server/api/cmContact/index.js",
6195 "groupTitle": "Cm_Contacts"
6199 "url": "/api/cm/contacts/{id}",
6200 "title": "Update a single Contact",
6203 "title": "Example usage:",
6204 "content": "curl https://{domain}/api/cm/contacts/{id} -d '{\"firstName\": \"John\", \"lastName\": \"Doe\"}' -v -u {name}:{password} -X PUT",
6209 "group": "Cm_Contacts",
6210 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6212 "filename": "server/api/cmContact/index.js",
6213 "groupTitle": "Cm_Contacts"
6217 "url": "/api/cm/custom_fields/{id}",
6218 "title": "Deletes a Custom Field",
6221 "title": "Example usage:",
6222 "content": "curl https://{domain}/api/cm/custom_fields/{id} -v -u {name}:{password} -X DELETE",
6226 "name": "DeleteCustom_Fields",
6227 "group": "Cm_Custom_Fields",
6228 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6230 "filename": "server/api/cmCustomField/index.js",
6231 "groupTitle": "Cm_Custom_Fields"
6235 "url": "/api/cm/custom_fields",
6236 "title": "Gets a list of Custom Fields",
6239 "title": "Example usage:",
6240 "content": "curl https://{domain}/api/cm/custom_fields -v -u {name}:{password}",
6244 "name": "GetCustom_Fields",
6245 "group": "Cm_Custom_Fields",
6246 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
6248 "filename": "server/api/cmCustomField/index.js",
6249 "groupTitle": "Cm_Custom_Fields"
6253 "url": "/api/cm/custom_fields/{id}",
6254 "title": "Gets a single Custom Field",
6257 "title": "Example usage:",
6258 "content": "curl https://{domain}/api/cm/custom_fields/{id} -v -u {name}:{password}",
6262 "name": "ShowCustom_Fields",
6263 "group": "Cm_Custom_Fields",
6264 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6266 "filename": "server/api/cmCustomField/index.js",
6267 "groupTitle": "Cm_Custom_Fields"
6271 "url": "/api/cm/custom_fields/{id}",
6272 "title": "Update an existing Custom Field",
6275 "title": "Example usage:",
6276 "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",
6280 "name": "updateCustom_Fields",
6281 "group": "Cm_Custom_Fields",
6282 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6284 "filename": "server/api/cmCustomField/index.js",
6285 "groupTitle": "Cm_Custom_Fields"
6289 "url": "/api/cm/hopper",
6290 "title": "Creates a new Hopper",
6293 "title": "Example usage:",
6294 "content": "curl https://{domain}/api/cm/hopper -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
6298 "name": "CreateHopper",
6299 "group": "Cm_Hopper",
6321 "field": "scheduledat",
6328 "field": "countbusyretry",
6335 "field": "countcongestionretry",
6342 "field": "countnoanswerretry",
6349 "field": "callback",
6356 "field": "callbackuniqueid",
6363 "field": "callbackat",
6370 "field": "priority",
6377 "field": "recallme",
6384 "field": "ContactId",
6405 "field": "VoiceQueueId",
6412 "field": "CampaignId",
6419 "field": "countnosuchnumberretry",
6426 "field": "countdropretry",
6433 "field": "countabandonedretry",
6440 "field": "countmachineretry",
6447 "field": "countagentrejectretry",
6453 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6455 "filename": "server/api/cmHopper/index.js",
6456 "groupTitle": "Cm_Hopper"
6460 "url": "/api/cm/hopper/describe",
6461 "title": "Gets table info about Hopper",
6464 "title": "Example usage:",
6465 "content": "curl https://{domain}/api/cm/hopper/describe -v -u {name}:{password}",
6469 "name": "DescribeHopper",
6470 "group": "Cm_Hopper",
6471 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6473 "filename": "server/api/cmHopper/index.js",
6474 "groupTitle": "Cm_Hopper"
6478 "url": "/api/cm/hopper",
6479 "title": "Gets a list of Hopper",
6482 "title": "Example usage:",
6483 "content": "curl https://{domain}/api/cm/hopper -v -u {name}:{password}",
6487 "name": "GetHopper",
6488 "group": "Cm_Hopper",
6489 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
6491 "filename": "server/api/cmHopper/index.js",
6492 "groupTitle": "Cm_Hopper"
6496 "url": "/api/cm/hopper/{id}",
6497 "title": "Gets a single Hopper",
6500 "title": "Example usage:",
6501 "content": "curl https://{domain}/api/cm/hopper/{id} -v -u {name}:{password}",
6505 "name": "ShowHopper",
6506 "group": "Cm_Hopper",
6507 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6509 "filename": "server/api/cmHopper/index.js",
6510 "groupTitle": "Cm_Hopper"
6514 "url": "/api/cm/hopper_black/{id}",
6515 "title": "Deletes a Hopper Black",
6518 "title": "Example usage:",
6519 "content": "curl https://{domain}/api/cm/hopper_black/{id} -v -u {name}:{password} -X DELETE",
6523 "name": "DeleteHopper_Black",
6524 "group": "Cm_Hopper_Black",
6525 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6527 "filename": "server/api/cmHopperBlack/index.js",
6528 "groupTitle": "Cm_Hopper_Black"
6532 "url": "/api/cm/hopper_black/describe",
6533 "title": "Gets table info about Hopper Black",
6536 "title": "Example usage:",
6537 "content": "curl https://{domain}/api/cm/hopper_black/describe -v -u {name}:{password}",
6541 "name": "DescribeHopper_Black",
6542 "group": "Cm_Hopper_Black",
6543 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6545 "filename": "server/api/cmHopperBlack/index.js",
6546 "groupTitle": "Cm_Hopper_Black"
6550 "url": "/api/cm/hopper_black",
6551 "title": "Gets a list of Hopper Black",
6554 "title": "Example usage:",
6555 "content": "curl https://{domain}/api/cm/hopper_black -v -u {name}:{password}",
6559 "name": "GetHopper_Black",
6560 "group": "Cm_Hopper_Black",
6561 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
6563 "filename": "server/api/cmHopperBlack/index.js",
6564 "groupTitle": "Cm_Hopper_Black"
6568 "url": "/api/cm/hopper_black/{id}",
6569 "title": "Gets a single Hopper Black",
6572 "title": "Example usage:",
6573 "content": "curl https://{domain}/api/cm/hopper_black/{id} -v -u {name}:{password}",
6577 "name": "ShowHopper_Black",
6578 "group": "Cm_Hopper_Black",
6579 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6581 "filename": "server/api/cmHopperBlack/index.js",
6582 "groupTitle": "Cm_Hopper_Black"
6586 "url": "/api/cm/hopper_black/{id}",
6587 "title": "Update an existing Hopper Black",
6590 "title": "Example usage:",
6591 "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",
6595 "name": "updateHopper_Black",
6596 "group": "Cm_Hopper_Black",
6597 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6599 "filename": "server/api/cmHopperBlack/index.js",
6600 "groupTitle": "Cm_Hopper_Black"
6604 "url": "/api/cm/hopper_final/checkContactHopper",
6605 "title": "Check if contact is in hopper",
6608 "title": "Example usage:",
6609 "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",
6613 "name": "/checkContactHopper",
6614 "group": "Cm_Hopper_Final",
6615 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6617 "filename": "server/api/cmHopperFinal/index.js",
6618 "groupTitle": "Cm_Hopper_Final"
6622 "url": "/api/cm/hopper_final/describe",
6623 "title": "Gets table info about HopperFinal",
6626 "title": "Example usage:",
6627 "content": "curl https://{domain}/api/cm/hopper_final/describe -v -u {name}:{password}",
6631 "name": "DescribeHopperFinal",
6632 "group": "Cm_Hopper_Final",
6633 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6635 "filename": "server/api/cmHopperFinal/index.js",
6636 "groupTitle": "Cm_Hopper_Final"
6640 "url": "/api/cm/hopper_final",
6641 "title": "Gets a list of HopperFinal",
6644 "title": "Example usage:",
6645 "content": "curl https://{domain}/api/cm/hopper_final -v -u {name}:{password}",
6649 "name": "GetHopperFinal",
6650 "group": "Cm_Hopper_Final",
6651 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
6653 "filename": "server/api/cmHopperFinal/index.js",
6654 "groupTitle": "Cm_Hopper_Final"
6658 "url": "/api/cm/hopper_final/{id}",
6659 "title": "Gets a single HopperFinal",
6662 "title": "Example usage:",
6663 "content": "curl https://{domain}/api/cm/hopper_final/{id} -v -u {name}:{password}",
6667 "name": "ShowHopperFinal",
6668 "group": "Cm_Hopper_Final",
6669 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6671 "filename": "server/api/cmHopperFinal/index.js",
6672 "groupTitle": "Cm_Hopper_Final"
6676 "url": "/api/cm/hopper_final/campaign/countAttributes/{id}",
6677 "title": "Return number contacts for attributes",
6680 "title": "Example usage:",
6681 "content": "curl https://{domain}/api/hopper_final/campaign/countAttributes/{id} -d '{\"disposition\": \"OK\"}' -v -u {name}:{password} -X GET",
6685 "name": "countContactsIvrCampaignHopperFinal",
6686 "group": "Cm_Hopper_Final",
6687 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6689 "filename": "server/api/cmHopperFinal/index.js",
6690 "groupTitle": "Cm_Hopper_Final"
6694 "url": "/api/cm/hopper_final/voice/queue/countAttributes/{id}",
6695 "title": "Return number contacts for attributes",
6698 "title": "Example usage:",
6699 "content": "curl https://{domain}/api/hopper_final/voice/queue/countAttributes/{id} -d '{\"disposition\": \"OK\"}' -v -u {name}:{password} -X GET",
6703 "name": "countContactsQueueCampaignHopperFinal",
6704 "group": "Cm_Hopper_Final",
6705 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6707 "filename": "server/api/cmHopperFinal/index.js",
6708 "groupTitle": "Cm_Hopper_Final"
6712 "url": "/api/cm/hopper_final/campaign/{id}",
6713 "title": "Move contacts in hopper",
6716 "title": "Example usage:",
6717 "content": "curl https://{domain}/api/hopper_final/campaign/moveContacts/{id} -d '{\"state\": \"state\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
6721 "name": "moveContactsIvrCampaignHopperFinal",
6722 "group": "Cm_Hopper_Final",
6723 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6725 "filename": "server/api/cmHopperFinal/index.js",
6726 "groupTitle": "Cm_Hopper_Final"
6730 "url": "/api/cm/hopper_final/voice/queue/{id}",
6731 "title": "Move contacts in hopper",
6734 "title": "Example usage:",
6735 "content": "curl https://{domain}/api/hopper_final/voice/queue/moveContacts/{id} -d '{\"state\": \"state\"}' -H 'Content-Type: application/json' -v -u {name}:{password}",
6739 "name": "moveContactsQueueCampaignHopperFinal",
6740 "group": "Cm_Hopper_Final",
6741 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6743 "filename": "server/api/cmHopperFinal/index.js",
6744 "groupTitle": "Cm_Hopper_Final"
6748 "url": "/api/cm/hopper_final/{id}",
6749 "title": "Update a single hopper final",
6752 "title": "Example usage:",
6753 "content": "curl https://{domain}/api/hopper_final/{id} -d '{\"disposition\": \"OK\"}' -v -u {name}:{password} -X PUT",
6758 "group": "Cm_Hopper_Final",
6759 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6761 "filename": "server/api/cmHopperFinal/index.js",
6762 "groupTitle": "Cm_Hopper_Final"
6766 "url": "/api/cm/hopper_history",
6767 "title": "Creates a new HopperHistory",
6770 "title": "Example usage:",
6771 "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",
6775 "name": "CreateHopperHistory",
6776 "group": "Cm_Hopper_History",
6791 "field": "statedesc",
6798 "field": "scheduledat",
6805 "field": "countbusyretry",
6812 "field": "countcongestionretry",
6819 "field": "countnoanswerretry",
6826 "field": "countglobal",
6833 "field": "uniqueid",
6840 "field": "originatecalleridnum",
6847 "field": "originatecalleridname",
6854 "field": "calleridnum",
6861 "field": "calleridname",
6868 "field": "starttime",
6875 "field": "responsetime",
6882 "field": "answertime",
6889 "field": "droptime",
6903 "field": "ringtime",
6910 "field": "holdtime",
6917 "field": "talktime",
6924 "field": "followuptime",
6931 "field": "dropreason",
6938 "field": "campaign",
6945 "field": "campaigntype",
6952 "field": "membername",
6980 "field": "callback",
6987 "field": "callbackuniqueid",
6994 "field": "callbackat",
7001 "field": "recallme",
7008 "field": "editedat",
7022 "field": "countnosuchnumberretry",
7029 "field": "countdropretry",
7036 "field": "countabandonedretry",
7043 "field": "countmachineretry",
7050 "field": "countagentrejectretry",
7056 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7058 "filename": "server/api/cmHopperHistory/index.js",
7059 "groupTitle": "Cm_Hopper_History"
7063 "url": "/api/cm/hopper_history/describe",
7064 "title": "Gets table info about HopperHistory",
7067 "title": "Example usage:",
7068 "content": "curl https://{domain}/api/cm/hopper_history/describe -v -u {name}:{password}",
7072 "name": "DescribeHopperHistory",
7073 "group": "Cm_Hopper_History",
7074 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7076 "filename": "server/api/cmHopperHistory/index.js",
7077 "groupTitle": "Cm_Hopper_History"
7081 "url": "/api/cm/hopper_history",
7082 "title": "Gets a list of HopperHistory",
7085 "title": "Example usage:",
7086 "content": "curl https://{domain}/api/cm/hopper_history -v -u {name}:{password}",
7090 "name": "GetHopperHistory",
7091 "group": "Cm_Hopper_History",
7092 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
7094 "filename": "server/api/cmHopperHistory/index.js",
7095 "groupTitle": "Cm_Hopper_History"
7099 "url": "/api/cm/hopper_history/{id}",
7100 "title": "Gets a single HopperHistory",
7103 "title": "Example usage:",
7104 "content": "curl https://{domain}/api/cm/hopper_history/{id} -v -u {name}:{password}",
7108 "name": "ShowHopperHistory",
7109 "group": "Cm_Hopper_History",
7110 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7112 "filename": "server/api/cmHopperHistory/index.js",
7113 "groupTitle": "Cm_Hopper_History"
7117 "url": "/api/cm/hopper_history/{id}",
7118 "title": "Update a single hopper history",
7121 "title": "Example usage:",
7122 "content": "curl https://{domain}/api/hopper_history/{id} -d '{\"disposition\": \"OK\"}' -v -u {name}:{password} -X PUT",
7127 "group": "Cm_Hopper_History",
7128 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7130 "filename": "server/api/cmHopperHistory/index.js",
7131 "groupTitle": "Cm_Hopper_History"
7135 "url": "/api/cm/hopper/{id}",
7136 "title": "Delete Hopper",
7139 "title": "Example usage:",
7140 "content": "curl https://{domain}/api/cm/hopper/{id} -v -u {name}:{password} -X DELETE",
7145 "group": "Cm_Hopper",
7146 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7148 "filename": "server/api/cmHopper/index.js",
7149 "groupTitle": "Cm_Hopper"
7153 "url": "/api/cm/hopper/opencontacts",
7154 "title": "Gets Open Contacts",
7157 "title": "Example usage:",
7158 "content": "curl https://{domain}/api/cm/hopper/opencontacts -v -u {name}:{password} -X GET",
7162 "name": "getOpenContacts",
7163 "group": "Cm_Hopper",
7164 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7166 "filename": "server/api/cmHopper/index.js",
7167 "groupTitle": "Cm_Hopper"
7171 "url": "/api/cm/hopper/preview",
7172 "title": "Gets Preview Dialer Contacts",
7175 "title": "Example usage:",
7176 "content": "curl https://{domain}/api/cm/hopper/preview -d '{\"hopperIds\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X GET",
7180 "name": "getPreview",
7181 "group": "Cm_Hopper",
7182 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7184 "filename": "server/api/cmHopper/index.js",
7185 "groupTitle": "Cm_Hopper"
7189 "url": "/api/cm/hopper/{id}",
7190 "title": "Update an existing Hopper",
7193 "title": "Example usage:",
7194 "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",
7198 "name": "updateHopper",
7199 "group": "Cm_Hopper",
7200 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7202 "filename": "server/api/cmHopper/index.js",
7203 "groupTitle": "Cm_Hopper"
7207 "url": "/api/cm/lists",
7208 "title": "Creates a new List",
7211 "title": "Example usage:",
7212 "content": "curl https://{domain}/api/cm/lists -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
7216 "name": "CreateLists",
7217 "group": "Cm_Lists",
7232 "field": "description",
7239 "field": "dialPrefix",
7245 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7247 "filename": "server/api/cmList/index.js",
7248 "groupTitle": "Cm_Lists"
7252 "url": "/api/cm/lists/{id}",
7253 "title": "Deletes a List",
7256 "title": "Example usage:",
7257 "content": "curl https://{domain}/api/cm/lists/{id} -v -u {name}:{password} -X DELETE",
7261 "name": "DeleteLists",
7262 "group": "Cm_Lists",
7263 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7265 "filename": "server/api/cmList/index.js",
7266 "groupTitle": "Cm_Lists"
7270 "url": "/api/cm/lists/describe",
7271 "title": "Gets table info about Lists",
7274 "title": "Example usage:",
7275 "content": "curl https://{domain}/api/cm/lists/describe -v -u {name}:{password}",
7279 "name": "DescribeLists",
7280 "group": "Cm_Lists",
7281 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7283 "filename": "server/api/cmList/index.js",
7284 "groupTitle": "Cm_Lists"
7288 "url": "/api/cm/lists/{id}/users",
7289 "title": "Gets agents from list",
7292 "title": "Example usage:",
7293 "content": "curl https://{domain}/api/cm/lists/{id}/users -v -u {name}:{password} -X GET",
7297 "name": "GetAgents",
7298 "group": "Cm_Lists",
7299 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7301 "filename": "server/api/cmList/index.js",
7302 "groupTitle": "Cm_Lists"
7306 "url": "/api/cm/lists",
7307 "title": "Gets a list of Lists",
7310 "title": "Example usage:",
7311 "content": "curl https://{domain}/api/cm/lists -v -u {name}:{password}",
7316 "group": "Cm_Lists",
7317 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
7319 "filename": "server/api/cmList/index.js",
7320 "groupTitle": "Cm_Lists"
7324 "url": "/api/cm/lists/{id}/users",
7325 "title": "Removes agents from a list",
7328 "title": "Example usage:",
7329 "content": "curl https://{domain}/api/cm/lists/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
7333 "name": "RemoveAgents",
7334 "group": "Cm_Lists",
7335 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7337 "filename": "server/api/cmList/index.js",
7338 "groupTitle": "Cm_Lists"
7342 "url": "/api/cm/lists/{id}/dispositions",
7343 "title": "Removes dispositions from account",
7346 "title": "Example usage:",
7347 "content": "curl https://{domain}/api/cm/lists/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
7351 "name": "RemoveDispositions",
7352 "group": "Cm_Lists",
7353 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7355 "filename": "server/api/cmList/index.js",
7356 "groupTitle": "Cm_Lists"
7360 "url": "/api/cm/lists/{id}",
7361 "title": "Gets a single List",
7364 "title": "Example usage:",
7365 "content": "curl https://{domain}/api/cm/lists/{id} -v -u {name}:{password}",
7369 "name": "ShowLists",
7370 "group": "Cm_Lists",
7371 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7373 "filename": "server/api/cmList/index.js",
7374 "groupTitle": "Cm_Lists"
7378 "url": "/api/cm/lists/{id}/users",
7379 "title": "Adds agents to a list",
7382 "title": "Example usage:",
7383 "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",
7387 "name": "addAgents",
7388 "group": "Cm_Lists",
7389 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7391 "filename": "server/api/cmList/index.js",
7392 "groupTitle": "Cm_Lists"
7396 "url": "/api/cm/lists/{id}/contacts",
7397 "title": "Creates new contacts",
7400 "title": "Example usage:",
7401 "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",
7405 "name": "addContacts",
7406 "group": "Cm_Lists",
7414 "field": "firstName",
7421 "field": "lastName",
7435 "field": "postalCode",
7456 "field": "dateOfBirth",
7463 "field": "description",
7505 "field": "facebook",
7561 "field": "telegram",
7575 "field": "priority",
7582 "field": "scheduledat",
7588 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7590 "filename": "server/api/cmList/index.js",
7591 "groupTitle": "Cm_Lists"
7595 "url": "/api/cm/lists/{id}/fields",
7596 "title": "Creates a new custom field",
7599 "title": "Example usage:",
7600 "content": "curl https://{domain}/api/cm/lists/{id}/fields -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
7604 "name": "addCustomField",
7605 "group": "Cm_Lists",
7606 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7608 "filename": "server/api/cmList/index.js",
7609 "groupTitle": "Cm_Lists"
7613 "url": "/api/cm/lists/{id}/dispositions",
7614 "title": "Creates new disposition",
7617 "title": "Example usage:",
7618 "content": "curl https://{domain}/api/cm/lists/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
7622 "name": "addDisposition",
7623 "group": "Cm_Lists",
7650 "field": "description",
7656 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7658 "filename": "server/api/cmList/index.js",
7659 "groupTitle": "Cm_Lists"
7663 "url": "/api/cm/lists/{id}/contacts",
7664 "title": "Gets List Contacts",
7667 "title": "Example usage:",
7668 "content": "curl https://{domain}/api/cm/lists/{id}/contacts -v -u {name}:{password} -X GET",
7672 "name": "getContacts",
7673 "group": "Cm_Lists",
7674 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7676 "filename": "server/api/cmList/index.js",
7677 "groupTitle": "Cm_Lists"
7681 "url": "/api/cm/lists/{id}/fields",
7682 "title": "Gets Custom Fields",
7685 "title": "Example usage:",
7686 "content": "curl https://{domain}/api/cm/lists/{id}/fields -v -u {name}:{password} -X GET",
7690 "name": "getCustomFields",
7691 "group": "Cm_Lists",
7692 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7694 "filename": "server/api/cmList/index.js",
7695 "groupTitle": "Cm_Lists"
7699 "url": "/api/cm/lists/{id}/dispositions",
7700 "title": "Gets list dispositions",
7703 "title": "Example usage:",
7704 "content": "curl https://{domain}/api/cm/lists/{id}/dispositions -v -u {name}:{password} -X GET",
7708 "name": "getDispositions",
7709 "group": "Cm_Lists",
7710 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7712 "filename": "server/api/cmList/index.js",
7713 "groupTitle": "Cm_Lists"
7717 "url": "/api/cm/lists/{id}/contacts/csv",
7718 "title": "Gets CSV List Contacts",
7721 "title": "Example usage:",
7722 "content": "curl https://{domain}/api/cm/lists/{id}/contacts/csv -v -u {name}:{password} -X GET",
7727 "group": "Cm_Lists",
7728 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7730 "filename": "server/api/cmList/index.js",
7731 "groupTitle": "Cm_Lists"
7735 "url": "/api/cm/lists/{id}",
7736 "title": "Update an existing List",
7739 "title": "Example usage:",
7740 "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",
7744 "name": "updateLists",
7745 "group": "Cm_Lists",
7746 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7748 "filename": "server/api/cmList/index.js",
7749 "groupTitle": "Cm_Lists"
7753 "url": "/api/cm/contacts/upload/:id",
7754 "title": "Import new contacts by csv",
7757 "title": "Example usage:",
7758 "content": "curl https://{domain}/api/cm/contacts/upload/:id -v -u {name}:{password} -X POST",
7763 "group": "Cm_contacts",
7764 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7766 "filename": "server/api/cmContact/index.js",
7767 "groupTitle": "Cm_contacts"
7771 "url": "/api/cm/contacts/upload",
7772 "title": "Upload csv",
7775 "title": "Example usage:",
7776 "content": "curl https://{domain}/api/cm/contacts/upload -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
7781 "group": "Cm_contacts",
7782 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7784 "filename": "server/api/cmContact/index.js",
7785 "groupTitle": "Cm_contacts"
7789 "url": "/api/cm/contacts/csv",
7790 "title": "Create new contacts by csv",
7793 "title": "Example usage:",
7794 "content": "curl https://{domain}/api/cm/contacts/csv -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
7798 "name": "uploadCsv",
7799 "group": "Cm_contacts",
7800 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7802 "filename": "server/api/cmContact/index.js",
7803 "groupTitle": "Cm_contacts"
7807 "url": "/api/conditions/{id}",
7808 "title": "Deletes a Condition",
7811 "title": "Example usage:",
7812 "content": "curl https://{domain}/api/conditions/{id} -v -u {name}:{password} -X DELETE",
7816 "name": "DeleteConditions",
7817 "group": "Conditions",
7818 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7820 "filename": "server/api/condition/index.js",
7821 "groupTitle": "Conditions"
7825 "url": "/api/conditions/{id}",
7826 "title": "Update an existing Condition",
7829 "title": "Example usage:",
7830 "content": "curl https://{domain}/api/conditions/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
7834 "name": "updateConditions",
7835 "group": "Conditions",
7836 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7838 "filename": "server/api/condition/index.js",
7839 "groupTitle": "Conditions"
7843 "url": "/api/cm/custom_field",
7844 "title": "Create a new custom field",
7847 "title": "Example usage:",
7848 "content": "curl https://{domain}/api/cm/custom_field -d '{\"name\": \"mycf\", \"type\": \"text\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
7852 "name": "CreateCustomField",
7853 "group": "Custom_Fields",
7854 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7856 "filename": "server/api/cmCustomField/index.js",
7857 "groupTitle": "Custom_Fields"
7861 "url": "/api/dashboards/items",
7862 "title": "Create dasboard item",
7865 "title": "Example usage:",
7866 "content": "curl https://{domain}/api/dashboards/items \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
7871 "group": "Dashboard_Items",
7872 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7874 "filename": "server/api/dashboardItem/index.js",
7875 "groupTitle": "Dashboard_Items"
7879 "url": "/api/dashboards/items/{id}",
7880 "title": "Deletes a Dashboard Item",
7883 "title": "Example usage:",
7884 "content": "curl https://{domain}/api/dashboards/items/{id} -v -u {name}:{password} -X DELETE",
7888 "name": "DeleteDashboard_Items",
7889 "group": "Dashboard_Items",
7890 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7892 "filename": "server/api/dashboardItem/index.js",
7893 "groupTitle": "Dashboard_Items"
7897 "url": "/api/dashboards/items/{id}",
7898 "title": "Gets a single Dashboard Item",
7901 "title": "Example usage:",
7902 "content": "curl https://{domain}/api/dashboards/items/{id} -v -u {name}:{password}",
7906 "name": "ShowDashboard_Items",
7907 "group": "Dashboard_Items",
7908 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7910 "filename": "server/api/dashboardItem/index.js",
7911 "groupTitle": "Dashboard_Items"
7915 "url": "/api/dashboards/items/{id}",
7916 "title": "Update an existing item",
7919 "title": "Example usage:",
7920 "content": "curl https://{domain}/api/dashboards/items/{id} -v -u {name}:{password} -X PUT",
7925 "group": "Dashboard_Items",
7926 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7928 "filename": "server/api/dashboardItem/index.js",
7929 "groupTitle": "Dashboard_Items"
7933 "url": "/api/dashboards/clone",
7934 "title": "Clone an existing Dashboard",
7937 "title": "Example usage:",
7938 "content": "curl https://{domain}/api/dashboards/clone -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
7942 "name": "CloneDashboards",
7943 "group": "Dashboards",
7944 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7946 "filename": "server/api/dashboard/index.js",
7947 "groupTitle": "Dashboards"
7951 "url": "/api/dashboards",
7952 "title": "Creates a new Dashboard",
7955 "title": "Example usage:",
7956 "content": "curl https://{domain}/api/dashboards -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
7960 "name": "CreateDashboards",
7961 "group": "Dashboards",
7976 "field": "description",
7982 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7984 "filename": "server/api/dashboard/index.js",
7985 "groupTitle": "Dashboards"
7989 "url": "/api/dashboards/{id}",
7990 "title": "Deletes a Dashboard",
7993 "title": "Example usage:",
7994 "content": "curl https://{domain}/api/dashboards/{id} -v -u {name}:{password} -X DELETE",
7998 "name": "DeleteDashboards",
7999 "group": "Dashboards",
8000 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8002 "filename": "server/api/dashboard/index.js",
8003 "groupTitle": "Dashboards"
8007 "url": "/api/dashboards",
8008 "title": "Gets a list of Dashboards",
8011 "title": "Example usage:",
8012 "content": "curl https://{domain}/api/dashboards -v -u {name}:{password}",
8016 "name": "GetDashboards",
8017 "group": "Dashboards",
8018 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
8020 "filename": "server/api/dashboard/index.js",
8021 "groupTitle": "Dashboards"
8025 "url": "/api/dashboards/{id}",
8026 "title": "Gets a single Dashboard",
8029 "title": "Example usage:",
8030 "content": "curl https://{domain}/api/dashboards/{id} -v -u {name}:{password}",
8034 "name": "ShowDashboards",
8035 "group": "Dashboards",
8036 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8038 "filename": "server/api/dashboard/index.js",
8039 "groupTitle": "Dashboards"
8043 "url": "/api/dashboards/{id}/items",
8044 "title": "Creates new item",
8047 "title": "Example usage:",
8048 "content": "curl https://{domain}/api/dashboards/{id}/items -d '{\"type\": \"counter\", \"...\": \"...\"}]' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
8053 "group": "Dashboards",
8054 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8056 "filename": "server/api/dashboard/index.js",
8057 "groupTitle": "Dashboards"
8061 "url": "/api/dashboards/{id}/items",
8062 "title": "Gets items",
8065 "title": "Example usage:",
8066 "content": "curl https://{domain}/api/dashboards/{id}/items -v -u {name}:{password} -X GET",
8071 "group": "Dashboards",
8072 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8074 "filename": "server/api/dashboard/index.js",
8075 "groupTitle": "Dashboards"
8079 "url": "/api/dashboards/{id}",
8080 "title": "Update an existing Dashboard",
8083 "title": "Example usage:",
8084 "content": "curl https://{domain}/api/dashboards/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
8088 "name": "updateDashboards",
8089 "group": "Dashboards",
8090 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8092 "filename": "server/api/dashboard/index.js",
8093 "groupTitle": "Dashboards"
8097 "url": "/api/integrations/desk/accounts",
8098 "title": "Creates a new Desk Account",
8101 "title": "Example usage:",
8102 "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",
8106 "name": "CreateDesk_Accounts",
8107 "group": "Desk_Accounts",
8122 "field": "description",
8129 "field": "username",
8136 "field": "remoteUri",
8146 "field": "authType",
8153 "field": "password",
8160 "field": "consumerKey",
8167 "field": "consumerSecret",
8181 "field": "tokenSecret",
8188 "field": "serverUrl",
8195 "\"integrationTab\"",
8205 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8207 "filename": "server/api/intDeskAccount/index.js",
8208 "groupTitle": "Desk_Accounts"
8212 "url": "/api/integrations/desk/accounts/{id}",
8213 "title": "Deletes a Desk Account",
8216 "title": "Example usage:",
8217 "content": "curl https://{domain}/api/integrations/desk/accounts/{id} -v -u {name}:{password} -X DELETE",
8221 "name": "DeleteDesk_Accounts",
8222 "group": "Desk_Accounts",
8223 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8225 "filename": "server/api/intDeskAccount/index.js",
8226 "groupTitle": "Desk_Accounts"
8230 "url": "/api/integrations/desk/accounts",
8231 "title": "Gets a list of Desk Accounts",
8234 "title": "Example usage:",
8235 "content": "curl https://{domain}/api/integrations/desk/accounts -v -u {name}:{password}",
8239 "name": "GetDesk_Accounts",
8240 "group": "Desk_Accounts",
8241 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
8243 "filename": "server/api/intDeskAccount/index.js",
8244 "groupTitle": "Desk_Accounts"
8248 "url": "/api/integrations/desk/accounts/{id}",
8249 "title": "Gets a single Desk Account",
8252 "title": "Example usage:",
8253 "content": "curl https://{domain}/api/integrations/desk/accounts/{id} -v -u {name}:{password}",
8257 "name": "ShowDesk_Accounts",
8258 "group": "Desk_Accounts",
8259 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8261 "filename": "server/api/intDeskAccount/index.js",
8262 "groupTitle": "Desk_Accounts"
8266 "url": "/api/integrations/desk/accounts/{id}/configurations",
8267 "title": "Creates new configuration",
8270 "title": "Example usage:",
8271 "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",
8275 "name": "addConfiguration",
8276 "group": "Desk_Accounts",
8277 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8279 "filename": "server/api/intDeskAccount/index.js",
8280 "groupTitle": "Desk_Accounts"
8284 "url": "/api/integrations/desk/accounts/{id}/configurations",
8285 "title": "Gets account configurations",
8288 "title": "Example usage:",
8289 "content": "curl https://{domain}/api/integrations/desk/accounts/{id}/configurations -v -u {name}:{password} -X GET",
8293 "name": "getConfigurations",
8294 "group": "Desk_Accounts",
8295 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8297 "filename": "server/api/intDeskAccount/index.js",
8298 "groupTitle": "Desk_Accounts"
8302 "url": "/api/integrations/desk/accounts/{id}/fields",
8303 "title": "Gets account fields",
8306 "title": "Example usage:",
8307 "content": "curl https://{domain}/api/integrations/desk/accounts/{id}/fields -v -u {name}:{password} -X GET",
8311 "name": "getFields",
8312 "group": "Desk_Accounts",
8313 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8315 "filename": "server/api/intDeskAccount/index.js",
8316 "groupTitle": "Desk_Accounts"
8320 "url": "/api/integrations/desk/accounts/{id}",
8321 "title": "Update an existing Desk Account",
8324 "title": "Example usage:",
8325 "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",
8329 "name": "updateDesk_Accounts",
8330 "group": "Desk_Accounts",
8331 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8333 "filename": "server/api/intDeskAccount/index.js",
8334 "groupTitle": "Desk_Accounts"
8338 "url": "/api/integrations/desk/configurations",
8339 "title": "Creates a new Desk Configuration",
8342 "title": "Example usage:",
8343 "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",
8347 "name": "CreateDesk_Configurations",
8348 "group": "Desk_Configurations",
8363 "field": "description",
8369 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8371 "filename": "server/api/intDeskConfiguration/index.js",
8372 "groupTitle": "Desk_Configurations"
8376 "url": "/api/integrations/desk/configurations/{id}",
8377 "title": "Deletes a Desk Configuration",
8380 "title": "Example usage:",
8381 "content": "curl https://{domain}/api/integrations/desk/configurations/{id} -v -u {name}:{password} -X DELETE",
8385 "name": "DeleteDesk_Configurations",
8386 "group": "Desk_Configurations",
8387 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8389 "filename": "server/api/intDeskConfiguration/index.js",
8390 "groupTitle": "Desk_Configurations"
8394 "url": "/api/integrations/desk/configurations",
8395 "title": "Gets a list of Desk Configurations",
8398 "title": "Example usage:",
8399 "content": "curl https://{domain}/api/integrations/desk/configurations -v -u {name}:{password}",
8403 "name": "GetDesk_Configurations",
8404 "group": "Desk_Configurations",
8405 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
8407 "filename": "server/api/intDeskConfiguration/index.js",
8408 "groupTitle": "Desk_Configurations"
8412 "url": "/api/integrations/desk/configurations/{id}",
8413 "title": "Gets a single Desk Configuration",
8416 "title": "Example usage:",
8417 "content": "curl https://{domain}/api/integrations/desk/configurations/{id} -v -u {name}:{password}",
8421 "name": "ShowDesk_Configurations",
8422 "group": "Desk_Configurations",
8423 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8425 "filename": "server/api/intDeskConfiguration/index.js",
8426 "groupTitle": "Desk_Configurations"
8430 "url": "/api/integrations/desk/configurations/{id}/descriptions",
8431 "title": "Gets configurations descriptions",
8434 "title": "Example usage:",
8435 "content": "curl https://{domain}/api/integrations/desk/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
8439 "name": "getDescriptions",
8440 "group": "Desk_Configurations",
8441 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8443 "filename": "server/api/intDeskConfiguration/index.js",
8444 "groupTitle": "Desk_Configurations"
8448 "url": "/api/integrations/desk/configurations/{id}/fields",
8449 "title": "Gets configurations fields",
8452 "title": "Example usage:",
8453 "content": "curl https://{domain}/api/integrations/desk/configurations/{id}/fields -v -u {name}:{password} -X GET",
8457 "name": "getFields",
8458 "group": "Desk_Configurations",
8459 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8461 "filename": "server/api/intDeskConfiguration/index.js",
8462 "groupTitle": "Desk_Configurations"
8466 "url": "/api/integrations/desk/configurations/{id}/subjects",
8467 "title": "Gets configurations subjects",
8470 "title": "Example usage:",
8471 "content": "curl https://{domain}/api/integrations/desk/configurations/{id}/subjects -v -u {name}:{password} -X GET",
8475 "name": "getSubjects",
8476 "group": "Desk_Configurations",
8477 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8479 "filename": "server/api/intDeskConfiguration/index.js",
8480 "groupTitle": "Desk_Configurations"
8484 "url": "/api/integrations/desk/configurations/{id}/tags",
8485 "title": "Gets configurations tags",
8488 "title": "Example usage:",
8489 "content": "curl https://{domain}/api/integrations/desk/configurations/{id}/tags -v -u {name}:{password} -X GET",
8494 "group": "Desk_Configurations",
8495 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8497 "filename": "server/api/intDeskConfiguration/index.js",
8498 "groupTitle": "Desk_Configurations"
8502 "url": "/api/integrations/desk/configurations/{id}/tags",
8503 "title": "Sets new tags",
8506 "title": "Example usage:",
8507 "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",
8512 "group": "Desk_Configurations",
8513 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8515 "filename": "server/api/intDeskConfiguration/index.js",
8516 "groupTitle": "Desk_Configurations"
8520 "url": "/api/integrations/desk/configurations/{id}",
8521 "title": "Update an existing Desk Configuration",
8524 "title": "Example usage:",
8525 "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",
8529 "name": "updateDesk_Configurations",
8530 "group": "Desk_Configurations",
8531 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8533 "filename": "server/api/intDeskConfiguration/index.js",
8534 "groupTitle": "Desk_Configurations"
8538 "url": "/api/integrations/desk/fields",
8539 "title": "Creates a new Desk Field",
8542 "title": "Example usage:",
8543 "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",
8547 "name": "CreateDesk_Fields",
8548 "group": "Desk_Fields",
8558 "\"customVariable\"",
8586 "\"customVariable\""
8596 "field": "keyContent",
8610 "field": "nameField",
8617 "field": "customField",
8624 "field": "variableName",
8630 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8632 "filename": "server/api/intDeskField/index.js",
8633 "groupTitle": "Desk_Fields"
8637 "url": "/api/integrations/desk/fields/{id}",
8638 "title": "Deletes a Desk Field",
8641 "title": "Example usage:",
8642 "content": "curl https://{domain}/api/integrations/desk/fields/{id} -v -u {name}:{password} -X DELETE",
8646 "name": "DeleteDesk_Fields",
8647 "group": "Desk_Fields",
8648 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8650 "filename": "server/api/intDeskField/index.js",
8651 "groupTitle": "Desk_Fields"
8655 "url": "/api/integrations/desk/fields",
8656 "title": "Gets a list of Desk Fields",
8659 "title": "Example usage:",
8660 "content": "curl https://{domain}/api/integrations/desk/fields -v -u {name}:{password}",
8664 "name": "GetDesk_Fields",
8665 "group": "Desk_Fields",
8666 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
8668 "filename": "server/api/intDeskField/index.js",
8669 "groupTitle": "Desk_Fields"
8673 "url": "/api/integrations/desk/fields/{id}",
8674 "title": "Gets a single Desk Field",
8677 "title": "Example usage:",
8678 "content": "curl https://{domain}/api/integrations/desk/fields/{id} -v -u {name}:{password}",
8682 "name": "ShowDesk_Fields",
8683 "group": "Desk_Fields",
8684 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8686 "filename": "server/api/intDeskField/index.js",
8687 "groupTitle": "Desk_Fields"
8691 "url": "/api/integrations/desk/fields/{id}",
8692 "title": "Update an existing Desk Field",
8695 "title": "Example usage:",
8696 "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",
8700 "name": "updateDesk_Fields",
8701 "group": "Desk_Fields",
8702 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8704 "filename": "server/api/intDeskField/index.js",
8705 "groupTitle": "Desk_Fields"
8709 "url": "/api/dispositions",
8710 "title": "Creates a new Disposition",
8713 "title": "Example usage:",
8714 "content": "curl https://{domain}/api/dispositions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
8718 "name": "CreateDispositions",
8719 "group": "Dispositions",
8746 "field": "description",
8752 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8754 "filename": "server/api/disposition/index.js",
8755 "groupTitle": "Dispositions"
8759 "url": "/api/dispositions/{id}",
8760 "title": "Deletes a Disposition",
8763 "title": "Example usage:",
8764 "content": "curl https://{domain}/api/dispositions/{id} -v -u {name}:{password} -X DELETE",
8768 "name": "DeleteDispositions",
8769 "group": "Dispositions",
8770 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8772 "filename": "server/api/disposition/index.js",
8773 "groupTitle": "Dispositions"
8777 "url": "/api/dispositions",
8778 "title": "Gets a list of Dispositions",
8781 "title": "Example usage:",
8782 "content": "curl https://{domain}/api/dispositions -v -u {name}:{password}",
8786 "name": "GetDispositions",
8787 "group": "Dispositions",
8788 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
8790 "filename": "server/api/disposition/index.js",
8791 "groupTitle": "Dispositions"
8795 "url": "/api/dispositions/{id}",
8796 "title": "Gets a single Disposition",
8799 "title": "Example usage:",
8800 "content": "curl https://{domain}/api/dispositions/{id} -v -u {name}:{password}",
8804 "name": "ShowDispositions",
8805 "group": "Dispositions",
8806 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8808 "filename": "server/api/disposition/index.js",
8809 "groupTitle": "Dispositions"
8813 "url": "/api/dispositions/{id}",
8814 "title": "Update an existing Disposition",
8817 "title": "Example usage:",
8818 "content": "curl https://{domain}/api/dispositions/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
8822 "name": "updateDispositions",
8823 "group": "Dispositions",
8824 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8826 "filename": "server/api/disposition/index.js",
8827 "groupTitle": "Dispositions"
8831 "url": "/api/integrations/dynamics365/accounts",
8832 "title": "Creates a new Dynamics365 Account",
8835 "title": "Example usage:",
8836 "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",
8840 "name": "CreateDynamics365_Accounts",
8841 "group": "Dynamics365_Accounts",
8856 "field": "username",
8863 "field": "password",
8870 "field": "remoteUri",
8877 "field": "tenantId",
8884 "field": "clientId",
8891 "field": "clientSecret",
8898 "field": "serverUrl",
8905 "field": "description",
8911 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8913 "filename": "server/api/intDynamics365Account/index.js",
8914 "groupTitle": "Dynamics365_Accounts"
8918 "url": "/api/integrations/dynamics365/accounts/{id}",
8919 "title": "Deletes a Dynamics365 Account",
8922 "title": "Example usage:",
8923 "content": "curl https://{domain}/api/integrations/dynamics365/accounts/{id} -v -u {name}:{password} -X DELETE",
8927 "name": "DeleteDynamics365_Accounts",
8928 "group": "Dynamics365_Accounts",
8929 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8931 "filename": "server/api/intDynamics365Account/index.js",
8932 "groupTitle": "Dynamics365_Accounts"
8936 "url": "/api/integrations/dynamics365/accounts",
8937 "title": "Gets a list of Dynamics365 Accounts",
8940 "title": "Example usage:",
8941 "content": "curl https://{domain}/api/integrations/dynamics365/accounts -v -u {name}:{password}",
8945 "name": "GetDynamics365_Accounts",
8946 "group": "Dynamics365_Accounts",
8947 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
8949 "filename": "server/api/intDynamics365Account/index.js",
8950 "groupTitle": "Dynamics365_Accounts"
8954 "url": "/api/integrations/dynamics365/accounts/{id}",
8955 "title": "Gets a single Dynamics365 Account",
8958 "title": "Example usage:",
8959 "content": "curl https://{domain}/api/integrations/dynamics365/accounts/{id} -v -u {name}:{password}",
8963 "name": "ShowDynamics365_Accounts",
8964 "group": "Dynamics365_Accounts",
8965 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8967 "filename": "server/api/intDynamics365Account/index.js",
8968 "groupTitle": "Dynamics365_Accounts"
8972 "url": "/api/integrations/dynamics365/accounts/{id}/configurations",
8973 "title": "Creates new configuration",
8976 "title": "Example usage:",
8977 "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",
8981 "name": "addConfiguration",
8982 "group": "Dynamics365_Accounts",
8983 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8985 "filename": "server/api/intDynamics365Account/index.js",
8986 "groupTitle": "Dynamics365_Accounts"
8990 "url": "/api/integrations/dynamics365/accounts/{id}/configurations",
8991 "title": "Gets account configurations",
8994 "title": "Example usage:",
8995 "content": "curl https://{domain}/api/integrations/dynamics365/accounts/{id}/configurations -v -u {name}:{password} -X GET",
8999 "name": "getConfigurations",
9000 "group": "Dynamics365_Accounts",
9001 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9003 "filename": "server/api/intDynamics365Account/index.js",
9004 "groupTitle": "Dynamics365_Accounts"
9008 "url": "/api/integrations/dynamics365/accounts/{id}/fields",
9009 "title": "Gets account fields",
9012 "title": "Example usage:",
9013 "content": "curl https://{domain}/api/integrations/dynamics365/accounts/{id}/fields -v -u {name}:{password} -X GET",
9017 "name": "getFields",
9018 "group": "Dynamics365_Accounts",
9019 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9021 "filename": "server/api/intDynamics365Account/index.js",
9022 "groupTitle": "Dynamics365_Accounts"
9026 "url": "/api/integrations/dynamics365/accounts/{id}",
9027 "title": "Update an existing Dynamics365 Account",
9030 "title": "Example usage:",
9031 "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",
9035 "name": "updateDynamics365_Accounts",
9036 "group": "Dynamics365_Accounts",
9037 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9039 "filename": "server/api/intDynamics365Account/index.js",
9040 "groupTitle": "Dynamics365_Accounts"
9044 "url": "/api/integrations/dynamics365/configurations",
9045 "title": "Creates a new Dynamics365 Configuration",
9048 "title": "Example usage:",
9049 "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",
9053 "name": "CreateDynamics365_Configurations",
9054 "group": "Dynamics365_Configurations",
9069 "field": "description",
9080 "field": "ticketType",
9086 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9088 "filename": "server/api/intDynamics365Configuration/index.js",
9089 "groupTitle": "Dynamics365_Configurations"
9093 "url": "/api/integrations/dynamics365/configurations/{id}",
9094 "title": "Deletes a Dynamics365 Configuration",
9097 "title": "Example usage:",
9098 "content": "curl https://{domain}/api/integrations/dynamics365/configurations/{id} -v -u {name}:{password} -X DELETE",
9102 "name": "DeleteDynamics365_Configurations",
9103 "group": "Dynamics365_Configurations",
9104 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9106 "filename": "server/api/intDynamics365Configuration/index.js",
9107 "groupTitle": "Dynamics365_Configurations"
9111 "url": "/api/integrations/dynamics365/configurations",
9112 "title": "Gets a list of Dynamics365 Configurations",
9115 "title": "Example usage:",
9116 "content": "curl https://{domain}/api/integrations/dynamics365/configurations -v -u {name}:{password}",
9120 "name": "GetDynamics365_Configurations",
9121 "group": "Dynamics365_Configurations",
9122 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
9124 "filename": "server/api/intDynamics365Configuration/index.js",
9125 "groupTitle": "Dynamics365_Configurations"
9129 "url": "/api/integrations/dynamics365/configurations/{id}",
9130 "title": "Gets a single Dynamics365 Configuration",
9133 "title": "Example usage:",
9134 "content": "curl https://{domain}/api/integrations/dynamics365/configurations/{id} -v -u {name}:{password}",
9138 "name": "ShowDynamics365_Configurations",
9139 "group": "Dynamics365_Configurations",
9140 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9142 "filename": "server/api/intDynamics365Configuration/index.js",
9143 "groupTitle": "Dynamics365_Configurations"
9147 "url": "/api/integrations/dynamics365/configurations/{id}/descriptions",
9148 "title": "Gets configurations descriptions",
9151 "title": "Example usage:",
9152 "content": "curl https://{domain}/api/integrations/dynamics365/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
9156 "name": "getDescriptions",
9157 "group": "Dynamics365_Configurations",
9158 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9160 "filename": "server/api/intDynamics365Configuration/index.js",
9161 "groupTitle": "Dynamics365_Configurations"
9165 "url": "/api/integrations/dynamics365/configurations/{id}/fields",
9166 "title": "Gets configurations fields",
9169 "title": "Example usage:",
9170 "content": "curl https://{domain}/api/integrations/zoho/configurations/{id}/fields -v -u {name}:{password} -X GET",
9174 "name": "getFields",
9175 "group": "Dynamics365_Configurations",
9176 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9178 "filename": "server/api/intDynamics365Configuration/index.js",
9179 "groupTitle": "Dynamics365_Configurations"
9183 "url": "/api/integrations/zoho/configurations/{id}/subjects",
9184 "title": "Gets configurations subjects",
9187 "title": "Example usage:",
9188 "content": "curl https://{domain}/api/integrations/dynamics365/configurations/{id}/subjects -v -u {name}:{password} -X GET",
9192 "name": "getSubjects",
9193 "group": "Dynamics365_Configurations",
9194 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9196 "filename": "server/api/intDynamics365Configuration/index.js",
9197 "groupTitle": "Dynamics365_Configurations"
9201 "url": "/api/integrations/dynamics365/configurations/{id}",
9202 "title": "Update an existing Dynamics365 Configuration",
9205 "title": "Example usage:",
9206 "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",
9210 "name": "updateDynamics365_Configurations",
9211 "group": "Dynamics365_Configurations",
9212 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9214 "filename": "server/api/intDynamics365Configuration/index.js",
9215 "groupTitle": "Dynamics365_Configurations"
9219 "url": "/api/integrations/dynamics365/fields",
9220 "title": "Creates a new Dynamics365 Field",
9223 "title": "Example usage:",
9224 "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",
9228 "name": "CreateDynamics365_Fields",
9229 "group": "Dynamics365_Fields",
9239 "\"customVariable\"",
9267 "\"customVariable\""
9277 "field": "keyContent",
9291 "field": "nameField",
9298 "field": "customField",
9305 "field": "variableName",
9311 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9313 "filename": "server/api/intDynamics365Field/index.js",
9314 "groupTitle": "Dynamics365_Fields"
9318 "url": "/api/integrations/dynamics365/fields/{id}",
9319 "title": "Deletes a Dynamics365 Field",
9322 "title": "Example usage:",
9323 "content": "curl https://{domain}/api/integrations/dynamics365/fields/{id} -v -u {name}:{password} -X DELETE",
9327 "name": "DeleteDynamics365_Fields",
9328 "group": "Dynamics365_Fields",
9329 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9331 "filename": "server/api/intDynamics365Field/index.js",
9332 "groupTitle": "Dynamics365_Fields"
9336 "url": "/api/integrations/dynamics365/fields",
9337 "title": "Gets a list of Dynamics365 Fields",
9340 "title": "Example usage:",
9341 "content": "curl https://{domain}/api/integrations/dynamics365/fields -v -u {name}:{password}",
9345 "name": "GetDynamics365_Fields",
9346 "group": "Dynamics365_Fields",
9347 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
9349 "filename": "server/api/intDynamics365Field/index.js",
9350 "groupTitle": "Dynamics365_Fields"
9354 "url": "/api/integrations/dynamics365/fields/{id}",
9355 "title": "Gets a single Dynamics365 Field",
9358 "title": "Example usage:",
9359 "content": "curl https://{domain}/api/integrations/dynamics365/fields/{id} -v -u {name}:{password}",
9363 "name": "ShowDynamics365_Fields",
9364 "group": "Dynamics365_Fields",
9365 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9367 "filename": "server/api/intDynamics365Field/index.js",
9368 "groupTitle": "Dynamics365_Fields"
9372 "url": "/api/integrations/dynamics365/fields/{id}",
9373 "title": "Update an existing Dynamics365 Field",
9376 "title": "Example usage:",
9377 "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",
9381 "name": "updateDynamics365_Fields",
9382 "group": "Dynamics365_Fields",
9383 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9385 "filename": "server/api/intDynamics365Field/index.js",
9386 "groupTitle": "Dynamics365_Fields"
9390 "url": "/api/fax/accounts/{id}/users",
9391 "title": "Add agents to a fax account",
9394 "title": "Example usage:",
9395 "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",
9399 "name": "AddAgents",
9400 "group": "Fax_Accounts",
9401 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9403 "filename": "server/api/faxAccount/index.js",
9404 "groupTitle": "Fax_Accounts"
9408 "url": "/api/fax/accounts",
9409 "title": "Creates a new Account",
9412 "title": "Example usage:",
9413 "content": "curl https://{domain}/api/fax/accounts -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
9417 "name": "CreateAccounts",
9418 "group": "Fax_Accounts",
9433 "field": "description",
9451 "field": "headerinfo",
9458 "field": "localstationid",
9509 "field": "faxdetect",
9516 "field": "t38timeout",
9543 "field": "notificationTemplate",
9550 "field": "notificationSound",
9557 "field": "notificationShake",
9564 "field": "waitForTheAssignedAgent",
9571 "field": "queueTransfer",
9578 "field": "queueTransferTimeout",
9585 "field": "agentTransfer",
9592 "field": "agentTransferTimeout",
9599 "field": "mandatoryDispositionPauseId",
9600 "description": "<p>Status to put when mandatory disposition is enabled</p>"
9606 "field": "mandatoryDisposition",
9607 "description": "<p>Enabled/disables mandatory dispo on a queue</p>"
9612 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9614 "filename": "server/api/faxAccount/index.js",
9615 "groupTitle": "Fax_Accounts"
9619 "url": "/api/fax/accounts/{id}",
9620 "title": "Deletes a Account",
9623 "title": "Example usage:",
9624 "content": "curl https://{domain}/api/fax/accounts/{id} -v -u {name}:{password} -X DELETE",
9628 "name": "DeleteAccounts",
9629 "group": "Fax_Accounts",
9630 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9632 "filename": "server/api/faxAccount/index.js",
9633 "groupTitle": "Fax_Accounts"
9637 "url": "/api/fax/accounts/describe",
9638 "title": "Gets table info about Accounts",
9641 "title": "Example usage:",
9642 "content": "curl https://{domain}/api/fax/accounts/describe -v -u {name}:{password}",
9646 "name": "DescribeAccounts",
9647 "group": "Fax_Accounts",
9648 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9650 "filename": "server/api/faxAccount/index.js",
9651 "groupTitle": "Fax_Accounts"
9655 "url": "/api/fax/accounts",
9656 "title": "Gets a list of Accounts",
9659 "title": "Example usage:",
9660 "content": "curl https://{domain}/api/fax/accounts -v -u {name}:{password}",
9664 "name": "GetAccounts",
9665 "group": "Fax_Accounts",
9666 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
9668 "filename": "server/api/faxAccount/index.js",
9669 "groupTitle": "Fax_Accounts"
9673 "url": "/api/fax/accounts/{id}/users",
9674 "title": "Gets agents from fax account",
9677 "title": "Example usage:",
9678 "content": "curl https://{domain}/api/fax/accounts/{id}/users -v -u {name}:{password} -X GET",
9682 "name": "GetAgents",
9683 "group": "Fax_Accounts",
9684 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9686 "filename": "server/api/faxAccount/index.js",
9687 "groupTitle": "Fax_Accounts"
9691 "url": "/api/fax/accounts/{id}/users",
9692 "title": "Removes agents from a fax account",
9695 "title": "Example usage:",
9696 "content": "curl https://{domain}/api/fax/accounts/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
9700 "name": "RemoveAgents",
9701 "group": "Fax_Accounts",
9702 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9704 "filename": "server/api/faxAccount/index.js",
9705 "groupTitle": "Fax_Accounts"
9709 "url": "/api/fax/accounts/{id}/canned_answers",
9710 "title": "Removes canned answers from account",
9713 "title": "Example usage:",
9714 "content": "curl https://{domain}/api/fax/accounts/{id}/canned_answers?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
9718 "name": "RemoveAnswers",
9719 "group": "Fax_Accounts",
9720 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9722 "filename": "server/api/faxAccount/index.js",
9723 "groupTitle": "Fax_Accounts"
9727 "url": "/api/fax/accounts/{id}/dispositions",
9728 "title": "Removes dispositions from account",
9731 "title": "Example usage:",
9732 "content": "curl https://{domain}/api/fax/accounts/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
9736 "name": "RemoveDispositions",
9737 "group": "Fax_Accounts",
9738 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9740 "filename": "server/api/faxAccount/index.js",
9741 "groupTitle": "Fax_Accounts"
9745 "url": "/api/fax/accounts/{id}",
9746 "title": "Gets a single Account",
9749 "title": "Example usage:",
9750 "content": "curl https://{domain}/api/fax/accounts/{id} -v -u {name}:{password}",
9754 "name": "ShowAccounts",
9755 "group": "Fax_Accounts",
9756 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9758 "filename": "server/api/faxAccount/index.js",
9759 "groupTitle": "Fax_Accounts"
9763 "url": "/api/fax/accounts/{id}/canned_answers",
9764 "title": "Creates new canned answer",
9767 "title": "Example usage:",
9768 "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",
9772 "name": "addAnswer",
9773 "group": "Fax_Accounts",
9795 "field": "description",
9808 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9810 "filename": "server/api/faxAccount/index.js",
9811 "groupTitle": "Fax_Accounts"
9815 "url": "/api/fax/accounts/addaccountapplications",
9816 "title": "Creates new account and applications",
9819 "title": "Example usage:",
9820 "content": "curl https://{domain}/api/fax/accounts/addaccountapplications -d '[{\"name\": \"name\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
9824 "name": "addApplications",
9825 "group": "Fax_Accounts",
9833 "field": "priority",
9854 "field": "description",
9861 "field": "interval",
9867 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9869 "filename": "server/api/faxAccount/index.js",
9870 "groupTitle": "Fax_Accounts"
9874 "url": "/api/fax/accounts/{id}/applications",
9875 "title": "Creates new applications",
9878 "title": "Example usage:",
9879 "content": "curl https://{domain}/api/fax/accounts/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
9883 "name": "addApplications",
9884 "group": "Fax_Accounts",
9892 "field": "priority",
9913 "field": "description",
9920 "field": "interval",
9926 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9928 "filename": "server/api/faxAccount/index.js",
9929 "groupTitle": "Fax_Accounts"
9933 "url": "/api/fax/accounts/{id}/dispositions",
9934 "title": "Creates new disposition",
9937 "title": "Example usage:",
9938 "content": "curl https://{domain}/api/fax/accounts/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
9942 "name": "addDisposition",
9943 "group": "Fax_Accounts",
9970 "field": "description",
9976 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9978 "filename": "server/api/faxAccount/index.js",
9979 "groupTitle": "Fax_Accounts"
9983 "url": "/api/fax/accounts/{id}/interactions",
9984 "title": "Creates new interactions",
9987 "title": "Example usage:",
9988 "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",
9992 "name": "addInteraction",
9993 "group": "Fax_Accounts",
10008 "field": "closedAt",
10015 "field": "disposition",
10022 "field": "secondDisposition",
10029 "field": "thirdDisposition",
10043 "field": "read1stAt",
10061 "field": "firstMsgDirection",
10068 "field": "lastMsgAt",
10079 "field": "lastMsgDirection",
10085 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10086 "version": "0.0.0",
10087 "filename": "server/api/faxAccount/index.js",
10088 "groupTitle": "Fax_Accounts"
10092 "url": "/api/fax/accounts/{id}/canned_answers",
10093 "title": "Gets account canned answers",
10096 "title": "Example usage:",
10097 "content": "curl https://{domain}/api/fax/accounts/{id}/canned_answers -v -u {name}:{password} -X GET",
10101 "name": "getAnswers",
10102 "group": "Fax_Accounts",
10103 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10104 "version": "0.0.0",
10105 "filename": "server/api/faxAccount/index.js",
10106 "groupTitle": "Fax_Accounts"
10110 "url": "/api/fax/accounts/{id}/applications",
10111 "title": "Gets account pplications",
10114 "title": "Example usage:",
10115 "content": "curl https://{domain}/api/fax/accounts/{id}/applications -v -u {name}:{password} -X GET",
10119 "name": "getApplications",
10120 "group": "Fax_Accounts",
10121 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10122 "version": "0.0.0",
10123 "filename": "server/api/faxAccount/index.js",
10124 "groupTitle": "Fax_Accounts"
10128 "url": "/api/fax/accounts/{id}/dispositions",
10129 "title": "Gets account dispositions",
10132 "title": "Example usage:",
10133 "content": "curl https://{domain}/api/fax/accounts/{id}/dispositions -v -u {name}:{password} -X GET",
10137 "name": "getDispositions",
10138 "group": "Fax_Accounts",
10139 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10140 "version": "0.0.0",
10141 "filename": "server/api/faxAccount/index.js",
10142 "groupTitle": "Fax_Accounts"
10146 "url": "/api/fax/accounts/{id}/interactions",
10147 "title": "Gets account interactions",
10150 "title": "Example usage:",
10151 "content": "curl https://{domain}/api/fax/accounts/{id}/interactions -v -u {name}:{password} -X GET",
10155 "name": "getInteraction",
10156 "group": "Fax_Accounts",
10157 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10158 "version": "0.0.0",
10159 "filename": "server/api/faxAccount/index.js",
10160 "groupTitle": "Fax_Accounts"
10164 "url": "/api/fax/accounts/{id}/messages",
10165 "title": "Gets account messages",
10168 "title": "Example usage:",
10169 "content": "curl https://{domain}/api/fax/accounts/{id}/messages -v -u {name}:{password} -X GET",
10173 "name": "getMessages",
10174 "group": "Fax_Accounts",
10175 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10176 "version": "0.0.0",
10177 "filename": "server/api/faxAccount/index.js",
10178 "groupTitle": "Fax_Accounts"
10182 "url": "/api/fax/accounts/{id}/send",
10183 "title": "Send new fax",
10186 "title": "Example usage:",
10187 "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",
10192 "group": "Fax_Accounts",
10193 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10194 "version": "0.0.0",
10195 "filename": "server/api/faxAccount/index.js",
10196 "groupTitle": "Fax_Accounts"
10200 "url": "/api/fax/accounts/{id}",
10201 "title": "Update an existing Account",
10204 "title": "Example usage:",
10205 "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",
10209 "name": "updateAccounts",
10210 "group": "Fax_Accounts",
10211 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10212 "version": "0.0.0",
10213 "filename": "server/api/faxAccount/index.js",
10214 "groupTitle": "Fax_Accounts"
10218 "url": "/api/fax/accounts/updateaccountapplications",
10219 "title": "Update account and applications",
10222 "title": "Example usage:",
10223 "content": "curl https://{domain}/api/fax/accounts/updateaccountapplications -d '[{\"name\": \"name\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
10227 "name": "updateApplications",
10228 "group": "Fax_Accounts",
10236 "field": "priority",
10250 "field": "appdata",
10257 "field": "description",
10264 "field": "interval",
10270 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10271 "version": "0.0.0",
10272 "filename": "server/api/faxAccount/index.js",
10273 "groupTitle": "Fax_Accounts"
10277 "url": "/api/fax/applications",
10278 "title": "Creates a new Application",
10281 "title": "Example usage:",
10282 "content": "curl https://{domain}/api/fax/applications -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
10286 "name": "CreateApplications",
10287 "group": "Fax_Applications",
10295 "field": "priority",
10309 "field": "appdata",
10316 "field": "description",
10323 "field": "interval",
10329 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10330 "version": "0.0.0",
10331 "filename": "server/api/faxApplication/index.js",
10332 "groupTitle": "Fax_Applications"
10336 "url": "/api/fax/applications/{id}",
10337 "title": "Deletes a Application",
10340 "title": "Example usage:",
10341 "content": "curl https://{domain}/api/fax/applications/{id} -v -u {name}:{password} -X DELETE",
10345 "name": "DeleteApplications",
10346 "group": "Fax_Applications",
10347 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10348 "version": "0.0.0",
10349 "filename": "server/api/faxApplication/index.js",
10350 "groupTitle": "Fax_Applications"
10354 "url": "/api/fax/applications",
10355 "title": "Gets a list of Applications",
10358 "title": "Example usage:",
10359 "content": "curl https://{domain}/api/fax/applications -v -u {name}:{password}",
10363 "name": "GetApplications",
10364 "group": "Fax_Applications",
10365 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
10366 "version": "0.0.0",
10367 "filename": "server/api/faxApplication/index.js",
10368 "groupTitle": "Fax_Applications"
10372 "url": "/api/fax/applications/{id}",
10373 "title": "Gets a single Application",
10376 "title": "Example usage:",
10377 "content": "curl https://{domain}/api/fax/applications/{id} -v -u {name}:{password}",
10381 "name": "ShowApplications",
10382 "group": "Fax_Applications",
10383 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10384 "version": "0.0.0",
10385 "filename": "server/api/faxApplication/index.js",
10386 "groupTitle": "Fax_Applications"
10390 "url": "/api/fax/applications/{id}",
10391 "title": "Update an existing Application",
10394 "title": "Example usage:",
10395 "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",
10399 "name": "updateApplications",
10400 "group": "Fax_Applications",
10401 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10402 "version": "0.0.0",
10403 "filename": "server/api/faxApplication/index.js",
10404 "groupTitle": "Fax_Applications"
10408 "url": "/api/fax/interactions/{id}/tags",
10409 "title": "Add tags to the interaction",
10412 "title": "Example usage:",
10413 "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",
10418 "group": "Fax_Interactions",
10419 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10420 "version": "0.0.0",
10421 "filename": "server/api/faxInteraction/index.js",
10422 "groupTitle": "Fax_Interactions"
10426 "url": "/api/fax/interactions",
10427 "title": "Creates a new Interaction",
10430 "title": "Example usage:",
10431 "content": "curl https://{domain}/api/fax/interactions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
10435 "name": "CreateInteractions",
10436 "group": "Fax_Interactions",
10451 "field": "closedAt",
10458 "field": "disposition",
10465 "field": "secondDisposition",
10472 "field": "thirdDisposition",
10486 "field": "read1stAt",
10504 "field": "firstMsgDirection",
10511 "field": "lastMsgAt",
10522 "field": "lastMsgDirection",
10528 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10529 "version": "0.0.0",
10530 "filename": "server/api/faxInteraction/index.js",
10531 "groupTitle": "Fax_Interactions"
10535 "url": "/api/fax/interactions/{id}",
10536 "title": "Deletes a Interaction",
10539 "title": "Example usage:",
10540 "content": "curl https://{domain}/api/fax/interactions/{id} -v -u {name}:{password} -X DELETE",
10544 "name": "DeleteInteractions",
10545 "group": "Fax_Interactions",
10546 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10547 "version": "0.0.0",
10548 "filename": "server/api/faxInteraction/index.js",
10549 "groupTitle": "Fax_Interactions"
10553 "url": "/api/fax/interactions/describe",
10554 "title": "Gets table info about Interactions",
10557 "title": "Example usage:",
10558 "content": "curl https://{domain}/api/fax/interactions/describe -v -u {name}:{password}",
10562 "name": "DescribeInteractions",
10563 "group": "Fax_Interactions",
10564 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10565 "version": "0.0.0",
10566 "filename": "server/api/faxInteraction/index.js",
10567 "groupTitle": "Fax_Interactions"
10571 "url": "/api/fax/interactions",
10572 "title": "Gets a list of Interactions",
10575 "title": "Example usage:",
10576 "content": "curl https://{domain}/api/fax/interactions -v -u {name}:{password}",
10580 "name": "GetInteractions",
10581 "group": "Fax_Interactions",
10582 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
10583 "version": "0.0.0",
10584 "filename": "server/api/faxInteraction/index.js",
10585 "groupTitle": "Fax_Interactions"
10589 "url": "/api/fax/interactions/{id}/tags",
10590 "title": "Removes tags from interaction",
10593 "title": "Example usage:",
10594 "content": "curl https://{domain}/api/fax/interactions/{id}/tags?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
10598 "name": "RemoveTags",
10599 "group": "Fax_Interactions",
10600 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10601 "version": "0.0.0",
10602 "filename": "server/api/faxInteraction/index.js",
10603 "groupTitle": "Fax_Interactions"
10607 "url": "/api/fax/interactions/{id}",
10608 "title": "Gets a single Interaction",
10611 "title": "Example usage:",
10612 "content": "curl https://{domain}/api/fax/interactions/{id} -v -u {name}:{password}",
10616 "name": "ShowInteractions",
10617 "group": "Fax_Interactions",
10618 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10619 "version": "0.0.0",
10620 "filename": "server/api/faxInteraction/index.js",
10621 "groupTitle": "Fax_Interactions"
10625 "url": "/api/fax/interactions/{id}/messages",
10626 "title": "Creates new messages",
10629 "title": "Example usage:",
10630 "content": "curl https://{domain}/api/fax/interactions/{id}/messages -d '[{\"to\": \"+3901119886500\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
10634 "name": "addMessage",
10635 "group": "Fax_Interactions",
10661 "field": "direction",
10668 "field": "failMessage",
10681 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10682 "version": "0.0.0",
10683 "filename": "server/api/faxInteraction/index.js",
10684 "groupTitle": "Fax_Interactions"
10688 "url": "/api/fax/interactions/{id}/download",
10689 "title": "Get interactions",
10692 "title": "Example usage:",
10693 "content": "curl https://{domain}/api/fax/interactions/{id}/download -v -u {name}:{password} -X GET",
10697 "name": "download",
10698 "group": "Fax_Interactions",
10699 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10700 "version": "0.0.0",
10701 "filename": "server/api/faxInteraction/index.js",
10702 "groupTitle": "Fax_Interactions"
10706 "url": "/api/fax/interactions/{id}/messages",
10707 "title": "Gets interaction messages",
10710 "title": "Example usage:",
10711 "content": "curl https://{domain}/api/fax/interactions/{id}/messages -v -u {name}:{password} -X GET",
10715 "name": "getMessages",
10716 "group": "Fax_Interactions",
10717 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10718 "version": "0.0.0",
10719 "filename": "server/api/faxInteraction/index.js",
10720 "groupTitle": "Fax_Interactions"
10724 "url": "/api/fax/interactions/{id}",
10725 "title": "Update an existing Interaction",
10728 "title": "Example usage:",
10729 "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",
10733 "name": "updateInteractions",
10734 "group": "Fax_Interactions",
10735 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10736 "version": "0.0.0",
10737 "filename": "server/api/faxInteraction/index.js",
10738 "groupTitle": "Fax_Interactions"
10742 "url": "/api/fax/messages/{id}/download",
10743 "title": "Get message",
10746 "title": "Example usage:",
10747 "content": "curl https://{domain}/api/fax/messages/{id}/download -v -u {name}:{password} -X GET",
10751 "name": "download",
10752 "group": "Fax_Message",
10753 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10754 "version": "0.0.0",
10755 "filename": "server/api/faxMessage/index.js",
10756 "groupTitle": "Fax_Message"
10760 "url": "/api/fax/messages/{id}",
10761 "title": "Deletes a Message",
10764 "title": "Example usage:",
10765 "content": "curl https://{domain}/api/fax/messages/{id} -v -u {name}:{password} -X DELETE",
10769 "name": "DeleteMessages",
10770 "group": "Fax_Messages",
10771 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10772 "version": "0.0.0",
10773 "filename": "server/api/faxMessage/index.js",
10774 "groupTitle": "Fax_Messages"
10778 "url": "/api/fax/messages/describe",
10779 "title": "Gets table info about Messages",
10782 "title": "Example usage:",
10783 "content": "curl https://{domain}/api/fax/messages/describe -v -u {name}:{password}",
10787 "name": "DescribeMessages",
10788 "group": "Fax_Messages",
10789 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10790 "version": "0.0.0",
10791 "filename": "server/api/faxMessage/index.js",
10792 "groupTitle": "Fax_Messages"
10796 "url": "/api/fax/messages",
10797 "title": "Gets a list of Messages",
10800 "title": "Example usage:",
10801 "content": "curl https://{domain}/api/fax/messages -v -u {name}:{password}",
10805 "name": "GetMessages",
10806 "group": "Fax_Messages",
10807 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
10808 "version": "0.0.0",
10809 "filename": "server/api/faxMessage/index.js",
10810 "groupTitle": "Fax_Messages"
10814 "url": "/api/fax/messages/{id}",
10815 "title": "Gets a single Message",
10818 "title": "Example usage:",
10819 "content": "curl https://{domain}/api/fax/messages/{id} -v -u {name}:{password}",
10823 "name": "ShowMessages",
10824 "group": "Fax_Messages",
10825 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10826 "version": "0.0.0",
10827 "filename": "server/api/faxMessage/index.js",
10828 "groupTitle": "Fax_Messages"
10832 "url": "/api/fax/messages/{id}/accept",
10833 "title": "Accepts message",
10836 "title": "Example usage:",
10837 "content": "curl https://{domain}/api/fax/messages/{id}/accept \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
10841 "name": "acceptMessage",
10842 "group": "Fax_Messages",
10843 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10844 "version": "0.0.0",
10845 "filename": "server/api/faxMessage/index.js",
10846 "groupTitle": "Fax_Messages"
10850 "url": "/api/fax/messages",
10851 "title": "Create message and send Fax",
10854 "title": "Example usage:",
10855 "content": "curl https://{domain}/api/fax/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
10859 "name": "rejectMessage",
10860 "group": "Fax_Messages",
10861 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10862 "version": "0.0.0",
10863 "filename": "server/api/faxMessage/index.js",
10864 "groupTitle": "Fax_Messages"
10868 "url": "/api/fax/messages/{id}/reject",
10869 "title": "Rejects message",
10872 "title": "Example usage:",
10873 "content": "curl https://{domain}/api/fax/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
10877 "name": "rejectMessage",
10878 "group": "Fax_Messages",
10879 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10880 "version": "0.0.0",
10881 "filename": "server/api/faxMessage/index.js",
10882 "groupTitle": "Fax_Messages"
10886 "url": "/api/fax/messages/{id}",
10887 "title": "Update an existing Message",
10890 "title": "Example usage:",
10891 "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",
10895 "name": "updateMessages",
10896 "group": "Fax_Messages",
10897 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10898 "version": "0.0.0",
10899 "filename": "server/api/faxMessage/index.js",
10900 "groupTitle": "Fax_Messages"
10904 "url": "/api/fax/reports/queue",
10905 "title": "Creates a new Fax Queue Report",
10908 "title": "Example usage:",
10909 "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",
10913 "name": "CreateFax_Queue_Reports",
10914 "group": "Fax_Queue_Reports",
10922 "field": "uniqueid",
10943 "field": "leaveAt",
10950 "field": "acceptAt",
10970 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10971 "version": "0.0.0",
10972 "filename": "server/api/faxQueueReport/index.js",
10973 "groupTitle": "Fax_Queue_Reports"
10977 "url": "/api/fax/reports/queue/{id}",
10978 "title": "Deletes a Fax Queue Report",
10981 "title": "Example usage:",
10982 "content": "curl https://{domain}/api/fax/reports/queue/{id} -v -u {name}:{password} -X DELETE",
10986 "name": "DeleteFax_Queue_Reports",
10987 "group": "Fax_Queue_Reports",
10988 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10989 "version": "0.0.0",
10990 "filename": "server/api/faxQueueReport/index.js",
10991 "groupTitle": "Fax_Queue_Reports"
10995 "url": "/api/fax/reports/queue/describe",
10996 "title": "Gets table info about Fax Queue Reports",
10999 "title": "Example usage:",
11000 "content": "curl https://{domain}/api/fax/reports/queue/describe -v -u {name}:{password}",
11004 "name": "DescribeFax_Queue_Reports",
11005 "group": "Fax_Queue_Reports",
11006 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11007 "version": "0.0.0",
11008 "filename": "server/api/faxQueueReport/index.js",
11009 "groupTitle": "Fax_Queue_Reports"
11013 "url": "/api/fax/reports/queue",
11014 "title": "Gets a list of Fax Queue Reports",
11017 "title": "Example usage:",
11018 "content": "curl https://{domain}/api/fax/reports/queue -v -u {name}:{password}",
11022 "name": "GetFax_Queue_Reports",
11023 "group": "Fax_Queue_Reports",
11024 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
11025 "version": "0.0.0",
11026 "filename": "server/api/faxQueueReport/index.js",
11027 "groupTitle": "Fax_Queue_Reports"
11031 "url": "/api/fax/reports/queue/{id}",
11032 "title": "Gets a single Fax Queue Report",
11035 "title": "Example usage:",
11036 "content": "curl https://{domain}/api/fax/reports/queue/{id} -v -u {name}:{password}",
11040 "name": "ShowFax_Queue_Reports",
11041 "group": "Fax_Queue_Reports",
11042 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11043 "version": "0.0.0",
11044 "filename": "server/api/faxQueueReport/index.js",
11045 "groupTitle": "Fax_Queue_Reports"
11049 "url": "/api/fax/reports/queue/{id}",
11050 "title": "Update an existing Fax Queue Report",
11053 "title": "Example usage:",
11054 "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",
11058 "name": "updateFax_Queue_Reports",
11059 "group": "Fax_Queue_Reports",
11060 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11061 "version": "0.0.0",
11062 "filename": "server/api/faxQueueReport/index.js",
11063 "groupTitle": "Fax_Queue_Reports"
11067 "url": "/api/fax/queues/{id}/users",
11068 "title": "Add agents to a queue",
11071 "title": "Example usage:",
11072 "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",
11076 "name": "AddAgents",
11077 "group": "Fax_Queues",
11078 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11079 "version": "0.0.0",
11080 "filename": "server/api/faxQueue/index.js",
11081 "groupTitle": "Fax_Queues"
11085 "url": "/api/fax/queues/{id}/teams",
11086 "title": "Add teams to a queue",
11089 "title": "Example usage:",
11090 "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",
11094 "name": "AddTeams",
11095 "group": "Fax_Queues",
11096 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11097 "version": "0.0.0",
11098 "filename": "server/api/faxQueue/index.js",
11099 "groupTitle": "Fax_Queues"
11103 "url": "/api/fax/queues",
11104 "title": "Creates a new Queue",
11107 "title": "Example usage:",
11108 "content": "curl https://{domain}/api/fax/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
11112 "name": "CreateQueues",
11113 "group": "Fax_Queues",
11128 "field": "description",
11135 "field": "timeout",
11147 "field": "strategy",
11154 "field": "lastAgent",
11160 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11161 "version": "0.0.0",
11162 "filename": "server/api/faxQueue/index.js",
11163 "groupTitle": "Fax_Queues"
11167 "url": "/api/fax/queues/{id}",
11168 "title": "Deletes a Queue",
11171 "title": "Example usage:",
11172 "content": "curl https://{domain}/api/fax/queues/{id} -v -u {name}:{password} -X DELETE",
11176 "name": "DeleteQueues",
11177 "group": "Fax_Queues",
11178 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11179 "version": "0.0.0",
11180 "filename": "server/api/faxQueue/index.js",
11181 "groupTitle": "Fax_Queues"
11185 "url": "/api/fax/queues/describe",
11186 "title": "Gets table info about Queues",
11189 "title": "Example usage:",
11190 "content": "curl https://{domain}/api/fax/queues/describe -v -u {name}:{password}",
11194 "name": "DescribeQueues",
11195 "group": "Fax_Queues",
11196 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11197 "version": "0.0.0",
11198 "filename": "server/api/faxQueue/index.js",
11199 "groupTitle": "Fax_Queues"
11203 "url": "/api/fax/queues/{id}/users",
11204 "title": "Gets queue agents",
11207 "title": "Example usage:",
11208 "content": "curl https://{domain}/api/fax/queues/{id}/users -v -u {name}:{password} -X POST",
11212 "name": "GetAgents",
11213 "group": "Fax_Queues",
11214 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11215 "version": "0.0.0",
11216 "filename": "server/api/faxQueue/index.js",
11217 "groupTitle": "Fax_Queues"
11221 "url": "/api/fax/queues/{id}/members",
11222 "title": "GetMembers",
11225 "title": "Example usage:",
11226 "content": "curl https://{domain}/api/fax/queues/{id}/members -v -u {name}:{password}",
11230 "name": "GetMembers",
11231 "group": "Fax_Queues",
11232 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11233 "version": "0.0.0",
11234 "filename": "server/api/faxQueue/index.js",
11235 "groupTitle": "Fax_Queues"
11239 "url": "/api/fax/queues",
11240 "title": "Gets a list of Queues",
11243 "title": "Example usage:",
11244 "content": "curl https://{domain}/api/fax/queues -v -u {name}:{password}",
11248 "name": "GetQueues",
11249 "group": "Fax_Queues",
11250 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
11251 "version": "0.0.0",
11252 "filename": "server/api/faxQueue/index.js",
11253 "groupTitle": "Fax_Queues"
11257 "url": "/api/fax/queues/{id}/teams",
11258 "title": "Gets queues list",
11261 "title": "Example usage:",
11262 "content": "curl https://{domain}/api/fax/queues/{id}/teams -v -u {name}:{password}",
11266 "name": "GetTeams",
11267 "group": "Fax_Queues",
11268 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11269 "version": "0.0.0",
11270 "filename": "server/api/faxQueue/index.js",
11271 "groupTitle": "Fax_Queues"
11275 "url": "/api/fax/queues/{id}/users",
11276 "title": "Removes agents from a queue",
11279 "title": "Example usage:",
11280 "content": "curl https://{domain}/api/fax/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
11284 "name": "RemoveAgents",
11285 "group": "Fax_Queues",
11286 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11287 "version": "0.0.0",
11288 "filename": "server/api/faxQueue/index.js",
11289 "groupTitle": "Fax_Queues"
11293 "url": "/api/fax/queues/{id}",
11294 "title": "Gets a single Queue",
11297 "title": "Example usage:",
11298 "content": "curl https://{domain}/api/fax/queues/{id} -v -u {name}:{password}",
11302 "name": "ShowQueues",
11303 "group": "Fax_Queues",
11304 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11305 "version": "0.0.0",
11306 "filename": "server/api/faxQueue/index.js",
11307 "groupTitle": "Fax_Queues"
11311 "url": "/api/fax/queues/{id}",
11312 "title": "Update an existing Queue",
11315 "title": "Example usage:",
11316 "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",
11320 "name": "updateQueues",
11321 "group": "Fax_Queues",
11322 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11323 "version": "0.0.0",
11324 "filename": "server/api/faxQueue/index.js",
11325 "groupTitle": "Fax_Queues"
11329 "url": "/api/fax/reports/transfer",
11330 "title": "Creates a new Fax Transfer Report",
11333 "title": "Example usage:",
11334 "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",
11338 "name": "CreateFax_Transfer_Reports",
11339 "group": "Fax_Transfer_Reports",
11347 "field": "uniqueid",
11366 "field": "transferredAt",
11372 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11373 "version": "0.0.0",
11374 "filename": "server/api/faxTransferReport/index.js",
11375 "groupTitle": "Fax_Transfer_Reports"
11379 "url": "/api/fax/reports/transfer/{id}",
11380 "title": "Deletes a Fax Transfer Report",
11383 "title": "Example usage:",
11384 "content": "curl https://{domain}/api/fax/reports/transfer/{id} -v -u {name}:{password} -X DELETE",
11388 "name": "DeleteFax_Transfer_Reports",
11389 "group": "Fax_Transfer_Reports",
11390 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11391 "version": "0.0.0",
11392 "filename": "server/api/faxTransferReport/index.js",
11393 "groupTitle": "Fax_Transfer_Reports"
11397 "url": "/api/fax/reports/transfer/describe",
11398 "title": "Gets table info about Fax Transfer Reports",
11401 "title": "Example usage:",
11402 "content": "curl https://{domain}/api/fax/reports/transfer/describe -v -u {name}:{password}",
11406 "name": "DescribeFax_Transfer_Reports",
11407 "group": "Fax_Transfer_Reports",
11408 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11409 "version": "0.0.0",
11410 "filename": "server/api/faxTransferReport/index.js",
11411 "groupTitle": "Fax_Transfer_Reports"
11415 "url": "/api/fax/reports/transfer",
11416 "title": "Gets a list of Fax Transfer Reports",
11419 "title": "Example usage:",
11420 "content": "curl https://{domain}/api/fax/reports/transfer -v -u {name}:{password}",
11424 "name": "GetFax_Transfer_Reports",
11425 "group": "Fax_Transfer_Reports",
11426 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
11427 "version": "0.0.0",
11428 "filename": "server/api/faxTransferReport/index.js",
11429 "groupTitle": "Fax_Transfer_Reports"
11433 "url": "/api/fax/reports/transfer/{id}",
11434 "title": "Gets a single Fax Transfer Report",
11437 "title": "Example usage:",
11438 "content": "curl https://{domain}/api/fax/reports/transfer/{id} -v -u {name}:{password}",
11442 "name": "ShowFax_Transfer_Reports",
11443 "group": "Fax_Transfer_Reports",
11444 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11445 "version": "0.0.0",
11446 "filename": "server/api/faxTransferReport/index.js",
11447 "groupTitle": "Fax_Transfer_Reports"
11451 "url": "/api/fax/reports/transfer/{id}",
11452 "title": "Update an existing Fax Transfer Report",
11455 "title": "Example usage:",
11456 "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",
11460 "name": "updateFax_Transfer_Reports",
11461 "group": "Fax_Transfer_Reports",
11462 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11463 "version": "0.0.0",
11464 "filename": "server/api/faxTransferReport/index.js",
11465 "groupTitle": "Fax_Transfer_Reports"
11469 "url": "/api/integrations/freshdesk/accounts",
11470 "title": "Creates a new Freshdesk Account",
11473 "title": "Example usage:",
11474 "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",
11478 "name": "CreateFreshdesk_Accounts",
11479 "group": "Freshdesk_Accounts",
11494 "field": "description",
11501 "field": "username",
11515 "field": "remoteUri",
11522 "field": "serverUrl",
11528 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11529 "version": "0.0.0",
11530 "filename": "server/api/intFreshdeskAccount/index.js",
11531 "groupTitle": "Freshdesk_Accounts"
11535 "url": "/api/integrations/freshdesk/accounts/{id}",
11536 "title": "Deletes a Freshdesk Account",
11539 "title": "Example usage:",
11540 "content": "curl https://{domain}/api/integrations/freshdesk/accounts/{id} -v -u {name}:{password} -X DELETE",
11544 "name": "DeleteFreshdesk_Accounts",
11545 "group": "Freshdesk_Accounts",
11546 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11547 "version": "0.0.0",
11548 "filename": "server/api/intFreshdeskAccount/index.js",
11549 "groupTitle": "Freshdesk_Accounts"
11553 "url": "/api/integrations/freshdesk/accounts",
11554 "title": "Gets a list of Freshdesk Accounts",
11557 "title": "Example usage:",
11558 "content": "curl https://{domain}/api/integrations/freshdesk/accounts -v -u {name}:{password}",
11562 "name": "GetFreshdesk_Accounts",
11563 "group": "Freshdesk_Accounts",
11564 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
11565 "version": "0.0.0",
11566 "filename": "server/api/intFreshdeskAccount/index.js",
11567 "groupTitle": "Freshdesk_Accounts"
11571 "url": "/api/integrations/freshdesk/accounts/{id}",
11572 "title": "Gets a single Freshdesk Account",
11575 "title": "Example usage:",
11576 "content": "curl https://{domain}/api/integrations/freshdesk/accounts/{id} -v -u {name}:{password}",
11580 "name": "ShowFreshdesk_Accounts",
11581 "group": "Freshdesk_Accounts",
11582 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11583 "version": "0.0.0",
11584 "filename": "server/api/intFreshdeskAccount/index.js",
11585 "groupTitle": "Freshdesk_Accounts"
11589 "url": "/api/integrations/freshdesk/accounts/{id}/configurations",
11590 "title": "Creates new configuration",
11593 "title": "Example usage:",
11594 "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",
11598 "name": "addConfiguration",
11599 "group": "Freshdesk_Accounts",
11600 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11601 "version": "0.0.0",
11602 "filename": "server/api/intFreshdeskAccount/index.js",
11603 "groupTitle": "Freshdesk_Accounts"
11607 "url": "/api/integrations/freshdesk/accounts/{id}/configurations",
11608 "title": "Gets account configurations",
11611 "title": "Example usage:",
11612 "content": "curl https://{domain}/api/integrations/freshdesk/accounts/{id}/configurations -v -u {name}:{password} -X GET",
11616 "name": "getConfigurations",
11617 "group": "Freshdesk_Accounts",
11618 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11619 "version": "0.0.0",
11620 "filename": "server/api/intFreshdeskAccount/index.js",
11621 "groupTitle": "Freshdesk_Accounts"
11625 "url": "/api/integrations/freshdesk/accounts/{id}/fields",
11626 "title": "Gets account fields",
11629 "title": "Example usage:",
11630 "content": "curl https://{domain}/api/integrations/freshdesk/accounts/{id}/fields -v -u {name}:{password} -X GET",
11634 "name": "getFields",
11635 "group": "Freshdesk_Accounts",
11636 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11637 "version": "0.0.0",
11638 "filename": "server/api/intFreshdeskAccount/index.js",
11639 "groupTitle": "Freshdesk_Accounts"
11643 "url": "/api/integrations/freshdesk/accounts/{id}",
11644 "title": "Update an existing Freshdesk Account",
11647 "title": "Example usage:",
11648 "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",
11652 "name": "updateFreshdesk_Accounts",
11653 "group": "Freshdesk_Accounts",
11654 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11655 "version": "0.0.0",
11656 "filename": "server/api/intFreshdeskAccount/index.js",
11657 "groupTitle": "Freshdesk_Accounts"
11661 "url": "/api/integrations/freshdesk/configurations",
11662 "title": "Creates a new Freshdesk Configuration",
11665 "title": "Example usage:",
11666 "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",
11670 "name": "CreateFreshdesk_Configurations",
11671 "group": "Freshdesk_Configurations",
11686 "field": "description",
11692 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11693 "version": "0.0.0",
11694 "filename": "server/api/intFreshdeskConfiguration/index.js",
11695 "groupTitle": "Freshdesk_Configurations"
11699 "url": "/api/integrations/freshdesk/configurations/{id}",
11700 "title": "Deletes a Freshdesk Configuration",
11703 "title": "Example usage:",
11704 "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id} -v -u {name}:{password} -X DELETE",
11708 "name": "DeleteFreshdesk_Configurations",
11709 "group": "Freshdesk_Configurations",
11710 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11711 "version": "0.0.0",
11712 "filename": "server/api/intFreshdeskConfiguration/index.js",
11713 "groupTitle": "Freshdesk_Configurations"
11717 "url": "/api/integrations/freshdesk/configurations",
11718 "title": "Gets a list of Freshdesk Configurations",
11721 "title": "Example usage:",
11722 "content": "curl https://{domain}/api/integrations/freshdesk/configurations -v -u {name}:{password}",
11726 "name": "GetFreshdesk_Configurations",
11727 "group": "Freshdesk_Configurations",
11728 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
11729 "version": "0.0.0",
11730 "filename": "server/api/intFreshdeskConfiguration/index.js",
11731 "groupTitle": "Freshdesk_Configurations"
11735 "url": "/api/integrations/freshdesk/configurations/{id}",
11736 "title": "Gets a single Freshdesk Configuration",
11739 "title": "Example usage:",
11740 "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id} -v -u {name}:{password}",
11744 "name": "ShowFreshdesk_Configurations",
11745 "group": "Freshdesk_Configurations",
11746 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11747 "version": "0.0.0",
11748 "filename": "server/api/intFreshdeskConfiguration/index.js",
11749 "groupTitle": "Freshdesk_Configurations"
11753 "url": "/api/integrations/freshdesk/configurations/{id}/descriptions",
11754 "title": "Gets configurations descriptions",
11757 "title": "Example usage:",
11758 "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
11762 "name": "getDescriptions",
11763 "group": "Freshdesk_Configurations",
11764 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11765 "version": "0.0.0",
11766 "filename": "server/api/intFreshdeskConfiguration/index.js",
11767 "groupTitle": "Freshdesk_Configurations"
11771 "url": "/api/integrations/freshdesk/configurations/{id}/fields",
11772 "title": "Gets configurations fields",
11775 "title": "Example usage:",
11776 "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id}/fields -v -u {name}:{password} -X GET",
11780 "name": "getFields",
11781 "group": "Freshdesk_Configurations",
11782 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11783 "version": "0.0.0",
11784 "filename": "server/api/intFreshdeskConfiguration/index.js",
11785 "groupTitle": "Freshdesk_Configurations"
11789 "url": "/api/integrations/freshdesk/configurations/{id}/subjects",
11790 "title": "Gets configurations subjects",
11793 "title": "Example usage:",
11794 "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id}/subjects -v -u {name}:{password} -X GET",
11798 "name": "getSubjects",
11799 "group": "Freshdesk_Configurations",
11800 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11801 "version": "0.0.0",
11802 "filename": "server/api/intFreshdeskConfiguration/index.js",
11803 "groupTitle": "Freshdesk_Configurations"
11807 "url": "/api/integrations/freshdesk/configurations/{id}/tags",
11808 "title": "Gets configurations tags",
11811 "title": "Example usage:",
11812 "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id}/tags -v -u {name}:{password} -X GET",
11817 "group": "Freshdesk_Configurations",
11818 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11819 "version": "0.0.0",
11820 "filename": "server/api/intFreshdeskConfiguration/index.js",
11821 "groupTitle": "Freshdesk_Configurations"
11825 "url": "/api/integrations/freshdesk/configurations/{id}/tags",
11826 "title": "Sets new tags",
11829 "title": "Example usage:",
11830 "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",
11835 "group": "Freshdesk_Configurations",
11836 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11837 "version": "0.0.0",
11838 "filename": "server/api/intFreshdeskConfiguration/index.js",
11839 "groupTitle": "Freshdesk_Configurations"
11843 "url": "/api/integrations/freshdesk/configurations/{id}",
11844 "title": "Update an existing Freshdesk Configuration",
11847 "title": "Example usage:",
11848 "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",
11852 "name": "updateFreshdesk_Configurations",
11853 "group": "Freshdesk_Configurations",
11854 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11855 "version": "0.0.0",
11856 "filename": "server/api/intFreshdeskConfiguration/index.js",
11857 "groupTitle": "Freshdesk_Configurations"
11861 "url": "/api/integrations/freshdesk/fields",
11862 "title": "Creates a new Freshdesk Field",
11865 "title": "Example usage:",
11866 "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",
11870 "name": "CreateFreshdesk_Fields",
11871 "group": "Freshdesk_Fields",
11881 "\"customVariable\"",
11893 "field": "content",
11909 "\"customVariable\""
11912 "field": "keyType",
11919 "field": "keyContent",
11926 "field": "idField",
11933 "field": "nameField",
11940 "field": "customField",
11947 "field": "variableName",
11953 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11954 "version": "0.0.0",
11955 "filename": "server/api/intFreshdeskField/index.js",
11956 "groupTitle": "Freshdesk_Fields"
11960 "url": "/api/integrations/freshdesk/fields/{id}",
11961 "title": "Deletes a Freshdesk Field",
11964 "title": "Example usage:",
11965 "content": "curl https://{domain}/api/integrations/freshdesk/fields/{id} -v -u {name}:{password} -X DELETE",
11969 "name": "DeleteFreshdesk_Fields",
11970 "group": "Freshdesk_Fields",
11971 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11972 "version": "0.0.0",
11973 "filename": "server/api/intFreshdeskField/index.js",
11974 "groupTitle": "Freshdesk_Fields"
11978 "url": "/api/integrations/freshdesk/fields",
11979 "title": "Gets a list of Freshdesk Fields",
11982 "title": "Example usage:",
11983 "content": "curl https://{domain}/api/integrations/freshdesk/fields -v -u {name}:{password}",
11987 "name": "GetFreshdesk_Fields",
11988 "group": "Freshdesk_Fields",
11989 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
11990 "version": "0.0.0",
11991 "filename": "server/api/intFreshdeskField/index.js",
11992 "groupTitle": "Freshdesk_Fields"
11996 "url": "/api/integrations/freshdesk/fields/{id}",
11997 "title": "Gets a single Freshdesk Field",
12000 "title": "Example usage:",
12001 "content": "curl https://{domain}/api/integrations/freshdesk/fields/{id} -v -u {name}:{password}",
12005 "name": "ShowFreshdesk_Fields",
12006 "group": "Freshdesk_Fields",
12007 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12008 "version": "0.0.0",
12009 "filename": "server/api/intFreshdeskField/index.js",
12010 "groupTitle": "Freshdesk_Fields"
12014 "url": "/api/integrations/freshdesk/fields/{id}",
12015 "title": "Update an existing Freshdesk Field",
12018 "title": "Example usage:",
12019 "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",
12023 "name": "updateFreshdesk_Fields",
12024 "group": "Freshdesk_Fields",
12025 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12026 "version": "0.0.0",
12027 "filename": "server/api/intFreshdeskField/index.js",
12028 "groupTitle": "Freshdesk_Fields"
12032 "url": "/api/integrations/freshsales/accounts",
12033 "title": "Creates a new Freshsales Account",
12036 "title": "Example usage:",
12037 "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",
12041 "name": "CreateFreshsales_Accounts",
12042 "group": "Freshsales_Accounts",
12057 "field": "description",
12064 "field": "username",
12078 "field": "remoteUri",
12085 "field": "serverUrl",
12091 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12092 "version": "0.0.0",
12093 "filename": "server/api/intFreshsalesAccount/index.js",
12094 "groupTitle": "Freshsales_Accounts"
12098 "url": "/api/integrations/freshsales/accounts/{id}",
12099 "title": "Deletes a Freshsales Account",
12102 "title": "Example usage:",
12103 "content": "curl https://{domain}/api/integrations/freshsales/accounts/{id} -v -u {name}:{password} -X DELETE",
12107 "name": "DeleteFreshsales_Accounts",
12108 "group": "Freshsales_Accounts",
12109 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12110 "version": "0.0.0",
12111 "filename": "server/api/intFreshsalesAccount/index.js",
12112 "groupTitle": "Freshsales_Accounts"
12116 "url": "/api/integrations/freshsales/accounts",
12117 "title": "Gets a list of Freshsales Accounts",
12120 "title": "Example usage:",
12121 "content": "curl https://{domain}/api/integrations/freshsales/accounts -v -u {name}:{password}",
12125 "name": "GetFreshsales_Accounts",
12126 "group": "Freshsales_Accounts",
12127 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
12128 "version": "0.0.0",
12129 "filename": "server/api/intFreshsalesAccount/index.js",
12130 "groupTitle": "Freshsales_Accounts"
12134 "url": "/api/integrations/freshsales/accounts/{id}",
12135 "title": "Gets a single Freshsales Account",
12138 "title": "Example usage:",
12139 "content": "curl https://{domain}/api/integrations/freshsales/accounts/{id} -v -u {name}:{password}",
12143 "name": "ShowFreshsales_Accounts",
12144 "group": "Freshsales_Accounts",
12145 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12146 "version": "0.0.0",
12147 "filename": "server/api/intFreshsalesAccount/index.js",
12148 "groupTitle": "Freshsales_Accounts"
12152 "url": "/api/integrations/freshsales/accounts/{id}/configurations",
12153 "title": "Creates new configuration",
12156 "title": "Example usage:",
12157 "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",
12161 "name": "addConfiguration",
12162 "group": "Freshsales_Accounts",
12163 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12164 "version": "0.0.0",
12165 "filename": "server/api/intFreshsalesAccount/index.js",
12166 "groupTitle": "Freshsales_Accounts"
12170 "url": "/api/integrations/freshsales/accounts/{id}/configurations",
12171 "title": "Gets account configurations",
12174 "title": "Example usage:",
12175 "content": "curl https://{domain}/api/integrations/freshsales/accounts/{id}/configurations -v -u {name}:{password} -X GET",
12179 "name": "getConfigurations",
12180 "group": "Freshsales_Accounts",
12181 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12182 "version": "0.0.0",
12183 "filename": "server/api/intFreshsalesAccount/index.js",
12184 "groupTitle": "Freshsales_Accounts"
12188 "url": "/api/integrations/freshsales/accounts/{id}/fields",
12189 "title": "Gets account fields",
12192 "title": "Example usage:",
12193 "content": "curl https://{domain}/api/integrations/freshsales/accounts/{id}/fields -v -u {name}:{password} -X GET",
12197 "name": "getFields",
12198 "group": "Freshsales_Accounts",
12199 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12200 "version": "0.0.0",
12201 "filename": "server/api/intFreshsalesAccount/index.js",
12202 "groupTitle": "Freshsales_Accounts"
12206 "url": "/api/integrations/freshsales/accounts/{id}",
12207 "title": "Update an existing Freshsales Account",
12210 "title": "Example usage:",
12211 "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",
12215 "name": "updateFreshsales_Accounts",
12216 "group": "Freshsales_Accounts",
12217 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12218 "version": "0.0.0",
12219 "filename": "server/api/intFreshsalesAccount/index.js",
12220 "groupTitle": "Freshsales_Accounts"
12224 "url": "/api/integrations/freshsales/configurations",
12225 "title": "Creates a new Freshsales Configuration",
12228 "title": "Example usage:",
12229 "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",
12233 "name": "CreateFreshsales_Configurations",
12234 "group": "Freshsales_Configurations",
12249 "field": "description",
12255 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12256 "version": "0.0.0",
12257 "filename": "server/api/intFreshsalesConfiguration/index.js",
12258 "groupTitle": "Freshsales_Configurations"
12262 "url": "/api/integrations/freshsales/configurations/{id}",
12263 "title": "Deletes a Freshsales Configuration",
12266 "title": "Example usage:",
12267 "content": "curl https://{domain}/api/integrations/freshsales/configurations/{id} -v -u {name}:{password} -X DELETE",
12271 "name": "DeleteFreshsales_Configurations",
12272 "group": "Freshsales_Configurations",
12273 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12274 "version": "0.0.0",
12275 "filename": "server/api/intFreshsalesConfiguration/index.js",
12276 "groupTitle": "Freshsales_Configurations"
12280 "url": "/api/integrations/freshsales/configurations",
12281 "title": "Gets a list of Freshsales Configurations",
12284 "title": "Example usage:",
12285 "content": "curl https://{domain}/api/integrations/freshsales/configurations -v -u {name}:{password}",
12289 "name": "GetFreshsales_Configurations",
12290 "group": "Freshsales_Configurations",
12291 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
12292 "version": "0.0.0",
12293 "filename": "server/api/intFreshsalesConfiguration/index.js",
12294 "groupTitle": "Freshsales_Configurations"
12298 "url": "/api/integrations/freshsales/configurations/{id}",
12299 "title": "Gets a single Freshsales Configuration",
12302 "title": "Example usage:",
12303 "content": "curl https://{domain}/api/integrations/freshsales/configurations/{id} -v -u {name}:{password}",
12307 "name": "ShowFreshsales_Configurations",
12308 "group": "Freshsales_Configurations",
12309 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12310 "version": "0.0.0",
12311 "filename": "server/api/intFreshsalesConfiguration/index.js",
12312 "groupTitle": "Freshsales_Configurations"
12316 "url": "/api/integrations/freshsales/configurations/{id}/descriptions",
12317 "title": "Gets configurations descriptions",
12320 "title": "Example usage:",
12321 "content": "curl https://{domain}/api/integrations/freshsales/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
12325 "name": "getDescriptions",
12326 "group": "Freshsales_Configurations",
12327 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12328 "version": "0.0.0",
12329 "filename": "server/api/intFreshsalesConfiguration/index.js",
12330 "groupTitle": "Freshsales_Configurations"
12334 "url": "/api/integrations/freshsales/configurations/{id}/fields",
12335 "title": "Gets configurations fields",
12338 "title": "Example usage:",
12339 "content": "curl https://{domain}/api/integrations/freshsales/configurations/{id}/fields -v -u {name}:{password} -X GET",
12343 "name": "getFields",
12344 "group": "Freshsales_Configurations",
12345 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12346 "version": "0.0.0",
12347 "filename": "server/api/intFreshsalesConfiguration/index.js",
12348 "groupTitle": "Freshsales_Configurations"
12352 "url": "/api/integrations/freshsales/configurations/{id}/subjects",
12353 "title": "Gets configurations subjects",
12356 "title": "Example usage:",
12357 "content": "curl https://{domain}/api/integrations/freshsales/configurations/{id}/subjects -v -u {name}:{password} -X GET",
12361 "name": "getSubjects",
12362 "group": "Freshsales_Configurations",
12363 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12364 "version": "0.0.0",
12365 "filename": "server/api/intFreshsalesConfiguration/index.js",
12366 "groupTitle": "Freshsales_Configurations"
12370 "url": "/api/integrations/freshsales/configurations/{id}",
12371 "title": "Update an existing Freshsales Configuration",
12374 "title": "Example usage:",
12375 "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",
12379 "name": "updateFreshsales_Configurations",
12380 "group": "Freshsales_Configurations",
12381 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12382 "version": "0.0.0",
12383 "filename": "server/api/intFreshsalesConfiguration/index.js",
12384 "groupTitle": "Freshsales_Configurations"
12388 "url": "/api/integrations/freshsales/fields",
12389 "title": "Creates a new Freshsales Field",
12392 "title": "Example usage:",
12393 "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",
12397 "name": "CreateFreshsales_Fields",
12398 "group": "Freshsales_Fields",
12408 "\"customVariable\"",
12420 "field": "content",
12436 "\"customVariable\""
12439 "field": "keyType",
12446 "field": "keyContent",
12453 "field": "idField",
12460 "field": "nameField",
12467 "field": "customField",
12474 "field": "variableName",
12480 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12481 "version": "0.0.0",
12482 "filename": "server/api/intFreshsalesField/index.js",
12483 "groupTitle": "Freshsales_Fields"
12487 "url": "/api/integrations/freshsales/fields/{id}",
12488 "title": "Deletes a Freshsales Field",
12491 "title": "Example usage:",
12492 "content": "curl https://{domain}/api/integrations/freshsales/fields/{id} -v -u {name}:{password} -X DELETE",
12496 "name": "DeleteFreshsales_Fields",
12497 "group": "Freshsales_Fields",
12498 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12499 "version": "0.0.0",
12500 "filename": "server/api/intFreshsalesField/index.js",
12501 "groupTitle": "Freshsales_Fields"
12505 "url": "/api/integrations/freshsales/fields",
12506 "title": "Gets a list of Freshsales Fields",
12509 "title": "Example usage:",
12510 "content": "curl https://{domain}/api/integrations/freshsales/fields -v -u {name}:{password}",
12514 "name": "GetFreshsales_Fields",
12515 "group": "Freshsales_Fields",
12516 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
12517 "version": "0.0.0",
12518 "filename": "server/api/intFreshsalesField/index.js",
12519 "groupTitle": "Freshsales_Fields"
12523 "url": "/api/integrations/freshsales/fields/{id}",
12524 "title": "Gets a single Freshsales Field",
12527 "title": "Example usage:",
12528 "content": "curl https://{domain}/api/integrations/freshsales/fields/{id} -v -u {name}:{password}",
12532 "name": "ShowFreshsales_Fields",
12533 "group": "Freshsales_Fields",
12534 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12535 "version": "0.0.0",
12536 "filename": "server/api/intFreshsalesField/index.js",
12537 "groupTitle": "Freshsales_Fields"
12541 "url": "/api/integrations/freshsales/fields/{id}",
12542 "title": "Update an existing Freshsales Field",
12545 "title": "Example usage:",
12546 "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",
12550 "name": "updateFreshsales_Fields",
12551 "group": "Freshsales_Fields",
12552 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12553 "version": "0.0.0",
12554 "filename": "server/api/intFreshsalesField/index.js",
12555 "groupTitle": "Freshsales_Fields"
12559 "url": "/api/campaigns/{id}/blacklists",
12560 "title": "Add blacklists to an IVR campaign",
12563 "title": "Example usage:",
12564 "content": "curl https://{domain}/api/campaigns/{id}/blacklists -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
12568 "name": "AddBlackLists",
12569 "group": "IVR_Campaigns",
12570 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12571 "version": "0.0.0",
12572 "filename": "server/api/campaign/index.js",
12573 "groupTitle": "IVR_Campaigns"
12577 "url": "/api/campaigns/{id}/lists",
12578 "title": "Add lists to an IVR campaign",
12581 "title": "Example usage:",
12582 "content": "curl https://{domain}/api/campaigns/{id}/lists -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
12586 "name": "AddLists",
12587 "group": "IVR_Campaigns",
12588 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12589 "version": "0.0.0",
12590 "filename": "server/api/campaign/index.js",
12591 "groupTitle": "IVR_Campaigns"
12595 "url": "/api/campaigns/clone",
12596 "title": "Clone an existing IVR Campaign",
12599 "title": "Example usage:",
12600 "content": "curl https://{domain}/api/campaigns/clone -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
12604 "name": "CloneIVR_Campaigns",
12605 "group": "IVR_Campaigns",
12606 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12607 "version": "0.0.0",
12608 "filename": "server/api/campaign/index.js",
12609 "groupTitle": "IVR_Campaigns"
12613 "url": "/api/campaigns",
12614 "title": "Creates a new IVR Campaign",
12617 "title": "Example usage:",
12618 "content": "curl https://{domain}/api/campaigns -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
12622 "name": "CreateIVR_Campaigns",
12623 "group": "IVR_Campaigns",
12648 "field": "description",
12656 "description": "<p>Active/Disactive Campaign</p>"
12662 "field": "limitCalls",
12663 "description": "<p>Max 200 calls.</p>"
12669 "field": "dialOriginateCallerIdName",
12676 "field": "dialOriginateCallerIdNumber",
12683 "field": "dialOriginateTimeout",
12684 "description": "<p>Originate Timeout Seconds (min:1, max:999)</p>"
12690 "field": "dialCongestionMaxRetry",
12691 "description": "<p>#Congestion Retry (min:1, max:999)</p>"
12697 "field": "dialCongestionRetryFrequency",
12698 "description": "<p>Congestion Retry Frequency Minutes (min:1, max:99999)</p>"
12704 "field": "dialBusyMaxRetry",
12705 "description": "<p>#Busy Retry (min:1, max:999)</p>"
12711 "field": "dialBusyRetryFrequency",
12712 "description": "<p>Busy Retry Frequency Minutes (min:1, max:99999)</p>"
12718 "field": "dialNoAnswerMaxRetry",
12719 "description": "<p>#NoAnswer Retry (min:1, max:999)</p>"
12725 "field": "dialNoAnswerRetryFrequency",
12726 "description": "<p>NoAnswer Retry Frequency Minutes (min:1, max:99999)</p>"
12732 "field": "dialGlobalMaxRetry",
12733 "description": "<p>#Global Max Retry (min:1, max:999)</p>"
12739 "field": "dialTimezone",
12746 "field": "dialGlobalInterval",
12758 "field": "dialCheckDuplicateType",
12765 "field": "dialAMDActive",
12766 "description": "<p>Active/Disactive AMD</p>"
12772 "field": "dialAMDInitialSilence",
12773 "description": "<p>#AMD Initial Silence</p>"
12779 "field": "dialAMDGreeting",
12780 "description": "<p>#AMD Greeting</p>"
12786 "field": "dialAMDAfterGreetingSilence",
12787 "description": "<p>#AMD After Greeting Silence</p>"
12793 "field": "dialAMDTotalAnalysisTime",
12794 "description": "<p>#AMD Total Analysis Time</p>"
12800 "field": "dialAMDMinWordLength",
12801 "description": "<p>#AMD Min Word Length</p>"
12807 "field": "dialAMDBetweenWordsSilence",
12808 "description": "<p>#AMD Between Words Silence</p>"
12814 "field": "dialAMDMaximumNumberOfWords",
12815 "description": "<p>#AMD Maximum Number Of Words</p>"
12821 "field": "dialAMDSilenceThreshold",
12822 "description": "<p>#AMD Silence Threshold (min:0, max:32767)</p>"
12828 "field": "dialAMDMaximumWordLength",
12829 "description": "<p>#AMD Maximum Word Length</p>"
12839 "field": "dialOrderByScheduledAt",
12846 "field": "dialPrefix",
12853 "field": "dialRandomLastDigitCallerIdNumber",
12854 "description": "<p>Random Last Digit (min:1, max:15)</p>"
12860 "field": "dialCutDigit",
12861 "description": "<p>Cut Digit (min:1, max:15)</p>"
12867 "field": "dialNoSuchNumberMaxRetry",
12868 "description": "<p>#NoSuchNumber Retry (min:1, max:999)</p>"
12874 "field": "dialNoSuchNumberRetryFrequency",
12875 "description": "<p>NoSuchNumber Retry Frequency Minutes (min:1, max:99999)</p>"
12881 "field": "dialDropMaxRetry",
12882 "description": "<p>#Drop Retry (min:1, max:999)</p>"
12888 "field": "dialDropRetryFrequency",
12889 "description": "<p>Drop Retry Frequency Minutes (min:1, max:99999)</p>"
12895 "field": "dialAbandonedMaxRetry",
12896 "description": "<p>#Abandoned Retry (min:1, max:999)</p>"
12902 "field": "dialAbandonedRetryFrequency",
12903 "description": "<p>Abandoned Retry Frequency Minutes (min:1, max:99999)</p>"
12909 "field": "dialMachineMaxRetry",
12910 "description": "<p>#Machine Retry (min:1, max:999)</p>"
12916 "field": "dialMachineRetryFrequency",
12917 "description": "<p>Machine Retry Frequency Minutes (min:1, max:99999)</p>"
12923 "field": "dialAgentRejectMaxRetry",
12924 "description": "<p>#AgentReject Retry (min:1, max:999)</p>"
12930 "field": "dialAgentRejectRetryFrequency",
12931 "description": "<p>AgentReject Retry Frequency Minutes (min:1, max:99999)</p>"
12936 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12937 "version": "0.0.0",
12938 "filename": "server/api/campaign/index.js",
12939 "groupTitle": "IVR_Campaigns"
12943 "url": "/api/campaigns/{id}",
12944 "title": "Deletes a IVR Campaign",
12947 "title": "Example usage:",
12948 "content": "curl https://{domain}/api/campaigns/{id} -v -u {name}:{password} -X DELETE",
12952 "name": "DeleteIVR_Campaigns",
12953 "group": "IVR_Campaigns",
12954 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12955 "version": "0.0.0",
12956 "filename": "server/api/campaign/index.js",
12957 "groupTitle": "IVR_Campaigns"
12961 "url": "/api/campaigns/{id}/blacklists",
12962 "title": "Get IVR campaign blacklists",
12965 "title": "Example usage:",
12966 "content": "curl https://{domain}/api/campaigns/{id}/blacklists -v -u {name}:{password} -X GET",
12970 "name": "GetBlackLists",
12971 "group": "IVR_Campaigns",
12972 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12973 "version": "0.0.0",
12974 "filename": "server/api/campaign/index.js",
12975 "groupTitle": "IVR_Campaigns"
12979 "url": "/api/campaigns/{id}/finals",
12980 "title": "Gets IVR campaign hopper finals",
12983 "title": "Example usage:",
12984 "content": "curl https://{domain}/api/campaigns/{id}/hopper_finals -v -u {name}:{password} -X GET",
12988 "name": "GetHopperFinals",
12989 "group": "IVR_Campaigns",
12990 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12991 "version": "0.0.0",
12992 "filename": "server/api/campaign/index.js",
12993 "groupTitle": "IVR_Campaigns"
12997 "url": "/api/campaigns/{id}/hopper_histories",
12998 "title": "Gets IVR campaign hopper histories",
13001 "title": "Example usage:",
13002 "content": "curl https://{domain}/api/campaigns/{id}/hopper_histories -v -u {name}:{password} -X GET",
13006 "name": "GetHopperHistories",
13007 "group": "IVR_Campaigns",
13008 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13009 "version": "0.0.0",
13010 "filename": "server/api/campaign/index.js",
13011 "groupTitle": "IVR_Campaigns"
13015 "url": "/api/campaigns/{id}/hoppers",
13016 "title": "Gets IVR campaign hoppers",
13019 "title": "Example usage:",
13020 "content": "curl https://{domain}/api/campaigns/{id}/hoppers -v -u {name}:{password} -X GET",
13024 "name": "GetHoppers",
13025 "group": "IVR_Campaigns",
13026 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13027 "version": "0.0.0",
13028 "filename": "server/api/campaign/index.js",
13029 "groupTitle": "IVR_Campaigns"
13033 "url": "/api/campaigns",
13034 "title": "Gets a list of IVR Campaigns",
13037 "title": "Example usage:",
13038 "content": "curl https://{domain}/api/campaigns -v -u {name}:{password}",
13042 "name": "GetIVR_Campaigns",
13043 "group": "IVR_Campaigns",
13044 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
13045 "version": "0.0.0",
13046 "filename": "server/api/campaign/index.js",
13047 "groupTitle": "IVR_Campaigns"
13051 "url": "/api/campaigns/{id}/lists",
13052 "title": "Get IVR campaign lists",
13055 "title": "Example usage:",
13056 "content": "curl https://{domain}/api/campaigns/{id}/lists -v -u {name}:{password} -X GET",
13060 "name": "GetLists",
13061 "group": "IVR_Campaigns",
13062 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13063 "version": "0.0.0",
13064 "filename": "server/api/campaign/index.js",
13065 "groupTitle": "IVR_Campaigns"
13069 "url": "/api/campaigns/{id}/blacklists",
13070 "title": "Remove blacklists from an IVR Campaign",
13073 "title": "Example usage:",
13074 "content": "curl https://{domain}/api/campaigns/{id}/blacklists?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
13078 "name": "RemoveBlackLists",
13079 "group": "IVR_Campaigns",
13080 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13081 "version": "0.0.0",
13082 "filename": "server/api/campaign/index.js",
13083 "groupTitle": "IVR_Campaigns"
13087 "url": "/api/campaigns/{id}/lists",
13088 "title": "Remove lists from an IVR Campaign",
13091 "title": "Example usage:",
13092 "content": "curl https://{domain}/api/campaigns/{id}/lists?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
13096 "name": "RemoveLists",
13097 "group": "IVR_Campaigns",
13098 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13099 "version": "0.0.0",
13100 "filename": "server/api/campaign/index.js",
13101 "groupTitle": "IVR_Campaigns"
13105 "url": "/api/campaigns/{id}",
13106 "title": "Gets a single IVR Campaign",
13109 "title": "Example usage:",
13110 "content": "curl https://{domain}/api/campaigns/{id} -v -u {name}:{password}",
13114 "name": "ShowIVR_Campaigns",
13115 "group": "IVR_Campaigns",
13116 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13117 "version": "0.0.0",
13118 "filename": "server/api/campaign/index.js",
13119 "groupTitle": "IVR_Campaigns"
13123 "url": "/api/campaigns/{id}/blacks",
13124 "title": "Gets IVR campaign hopper blacks",
13127 "title": "Example usage:",
13128 "content": "curl https://{domain}/api/campaigns/{id}/hopper_black -v -u {name}:{password} -X GET",
13132 "name": "getHopperBlacks",
13133 "group": "IVR_Campaigns",
13134 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13135 "version": "0.0.0",
13136 "filename": "server/api/campaign/index.js",
13137 "groupTitle": "IVR_Campaigns"
13141 "url": "/api/campaigns/{id}",
13142 "title": "Update an existing IVR Campaign",
13145 "title": "Example usage:",
13146 "content": "curl https://{domain}/api/campaigns/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
13150 "name": "updateIVR_Campaigns",
13151 "group": "IVR_Campaigns",
13152 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13153 "version": "0.0.0",
13154 "filename": "server/api/campaign/index.js",
13155 "groupTitle": "IVR_Campaigns"
13159 "url": "/api/integrations/reports",
13160 "title": "Creates a new Integration Report",
13163 "title": "Example usage:",
13164 "content": "curl https://{domain}/api/integrations/reports -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
13168 "name": "CreateIntegration_Reports",
13169 "group": "Integration_Reports",
13177 "field": "integration",
13184 "field": "eventChannel",
13191 "field": "exitStatus",
13198 "field": "ticketId",
13205 "field": "integrationId",
13212 "field": "contacts",
13219 "field": "uniqueid",
13226 "field": "calleridnum",
13233 "field": "calleridname",
13247 "field": "interface",
13254 "field": "membername",
13261 "field": "agentcalledAt",
13268 "field": "agentconnectAt",
13275 "field": "holdtime",
13282 "field": "agentcomplete",
13289 "field": "agentcompleteAt",
13296 "field": "talktime",
13303 "field": "agentacw",
13310 "field": "acwtime",
13324 "field": "agentringnoanswer",
13331 "field": "agentringnoanswerAt",
13338 "field": "agentdump",
13345 "field": "agentdumpAt",
13352 "field": "lastevent",
13359 "field": "channel",
13366 "field": "channelstate",
13373 "field": "channelstatedesc",
13380 "field": "connectedlinenum",
13387 "field": "connectedlinename",
13394 "field": "language",
13401 "field": "accountcode",
13408 "field": "context",
13422 "field": "priority",
13429 "field": "destchannel",
13436 "field": "destchannelstate",
13443 "field": "destchannelstatedesc",
13450 "field": "destcalleridnum",
13457 "field": "destcalleridname",
13464 "field": "destconnectedlinenum",
13471 "field": "destconnectedlinename",
13478 "field": "destlanguage",
13485 "field": "destaccountcode",
13492 "field": "destcontext",
13499 "field": "destexten",
13506 "field": "destpriority",
13513 "field": "destuniqueid",
13520 "field": "messageId",
13527 "field": "inReplyTo",
13534 "field": "subject",
13562 "field": "attachment",
13610 "field": "appdata",
13617 "field": "projectId",
13623 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13624 "version": "0.0.0",
13625 "filename": "server/api/integrationReport/index.js",
13626 "groupTitle": "Integration_Reports"
13630 "url": "/api/integrations/reports/{id}",
13631 "title": "Deletes a Integration Report",
13634 "title": "Example usage:",
13635 "content": "curl https://{domain}/api/integrations/reports/{id} -v -u {name}:{password} -X DELETE",
13639 "name": "DeleteIntegration_Reports",
13640 "group": "Integration_Reports",
13641 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13642 "version": "0.0.0",
13643 "filename": "server/api/integrationReport/index.js",
13644 "groupTitle": "Integration_Reports"
13648 "url": "/api/integrations/reports/describe",
13649 "title": "Gets table info about Integration Reports",
13652 "title": "Example usage:",
13653 "content": "curl https://{domain}/api/integrations/reports/describe -v -u {name}:{password}",
13657 "name": "DescribeIntegration_Reports",
13658 "group": "Integration_Reports",
13659 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13660 "version": "0.0.0",
13661 "filename": "server/api/integrationReport/index.js",
13662 "groupTitle": "Integration_Reports"
13666 "url": "/api/integrations/reports",
13667 "title": "Gets a list of Integration Reports",
13670 "title": "Example usage:",
13671 "content": "curl https://{domain}/api/integrations/reports -v -u {name}:{password}",
13675 "name": "GetIntegration_Reports",
13676 "group": "Integration_Reports",
13677 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
13678 "version": "0.0.0",
13679 "filename": "server/api/integrationReport/index.js",
13680 "groupTitle": "Integration_Reports"
13684 "url": "/api/integrations/reports/{id}",
13685 "title": "Gets a single Integration Report",
13688 "title": "Example usage:",
13689 "content": "curl https://{domain}/api/integrations/reports/{id} -v -u {name}:{password}",
13693 "name": "ShowIntegration_Reports",
13694 "group": "Integration_Reports",
13695 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13696 "version": "0.0.0",
13697 "filename": "server/api/integrationReport/index.js",
13698 "groupTitle": "Integration_Reports"
13702 "url": "/api/integrations/reports/{id}",
13703 "title": "Update an existing Integration Report",
13706 "title": "Example usage:",
13707 "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",
13711 "name": "updateIntegration_Reports",
13712 "group": "Integration_Reports",
13713 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13714 "version": "0.0.0",
13715 "filename": "server/api/integrationReport/index.js",
13716 "groupTitle": "Integration_Reports"
13720 "url": "/api/intervals",
13721 "title": "Creates a new Interval",
13724 "title": "Example usage:",
13725 "content": "curl https://{domain}/api/intervals -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
13729 "name": "CreateIntervals",
13730 "group": "Intervals",
13745 "field": "description",
13752 "field": "interval",
13758 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13759 "version": "0.0.0",
13760 "filename": "server/api/interval/index.js",
13761 "groupTitle": "Intervals"
13765 "url": "/api/intervals/{id}",
13766 "title": "Deletes a Interval",
13769 "title": "Example usage:",
13770 "content": "curl https://{domain}/api/intervals/{id} -v -u {name}:{password} -X DELETE",
13774 "name": "DeleteIntervals",
13775 "group": "Intervals",
13776 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13777 "version": "0.0.0",
13778 "filename": "server/api/interval/index.js",
13779 "groupTitle": "Intervals"
13783 "url": "/api/intervals",
13784 "title": "Gets a list of Intervals",
13787 "title": "Example usage:",
13788 "content": "curl https://{domain}/api/intervals -v -u {name}:{password}",
13792 "name": "GetIntervals",
13793 "group": "Intervals",
13794 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
13795 "version": "0.0.0",
13796 "filename": "server/api/interval/index.js",
13797 "groupTitle": "Intervals"
13801 "url": "/api/intervals/{id}",
13802 "title": "Gets a single Interval",
13805 "title": "Example usage:",
13806 "content": "curl https://{domain}/api/intervals/{id} -v -u {name}:{password}",
13810 "name": "ShowIntervals",
13811 "group": "Intervals",
13812 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13813 "version": "0.0.0",
13814 "filename": "server/api/interval/index.js",
13815 "groupTitle": "Intervals"
13819 "url": "/api/intervals/{id}/sub_intervals",
13820 "title": "Creates a new sub interval",
13823 "title": "Example usage:",
13824 "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",
13828 "name": "addInterval",
13829 "group": "Intervals",
13830 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13831 "version": "0.0.0",
13832 "filename": "server/api/interval/index.js",
13833 "groupTitle": "Intervals"
13837 "url": "/api/intervals/{id}/sub_intervals/create_many",
13838 "title": "Create new sub intervals set",
13841 "title": "Example usage:",
13842 "content": "curl https://{domain}/api/intervals/{id}/sub_intervals -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
13846 "name": "addIntervals",
13847 "group": "Intervals",
13848 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13849 "version": "0.0.0",
13850 "filename": "server/api/interval/index.js",
13851 "groupTitle": "Intervals"
13855 "url": "/api/intervals/{id}/sub_intervals",
13856 "title": "Get sub intervals set",
13859 "title": "Example usage:",
13860 "content": "curl https://{domain}/api/intervals/{id}/sub_intervals -v -u {name}:{password} -X GET",
13864 "name": "getIntervals",
13865 "group": "Intervals",
13866 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13867 "version": "0.0.0",
13868 "filename": "server/api/interval/index.js",
13869 "groupTitle": "Intervals"
13873 "url": "/api/intervals/{id}",
13874 "title": "Update an existing Interval",
13877 "title": "Example usage:",
13878 "content": "curl https://{domain}/api/intervals/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
13882 "name": "updateIntervals",
13883 "group": "Intervals",
13884 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13885 "version": "0.0.0",
13886 "filename": "server/api/interval/index.js",
13887 "groupTitle": "Intervals"
13891 "url": "/api/jira",
13892 "title": "Creates a new issue",
13895 "title": "Example usage:",
13896 "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}",
13900 "name": "Creates_Issue",
13912 "field": "issuetype",
13919 "field": "summary",
13926 "field": "description",
13932 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13933 "version": "0.0.0",
13934 "filename": "server/api/jira/index.js",
13935 "groupTitle": "Issue"
13939 "url": "/api/jscripty/answers/reports",
13940 "title": "Creates a new Report",
13943 "title": "Example usage:",
13944 "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",
13948 "name": "CreateReports",
13949 "group": "JscriptyAnswerReport",
13957 "field": "question",
13971 "field": "membername",
13978 "field": "projectname",
13992 "field": "uniqueid",
13999 "field": "calleridname",
14006 "field": "calleridnum",
14013 "field": "questionId",
14019 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14020 "version": "0.0.0",
14021 "filename": "server/api/jscriptyAnswerReport/index.js",
14022 "groupTitle": "JscriptyAnswerReport"
14026 "url": "/api/jscripty/answers/reports/{id}",
14027 "title": "Deletes a Report",
14030 "title": "Example usage:",
14031 "content": "curl https://{domain}/api/jscripty/answers/reports/{id} -v -u {name}:{password} -X DELETE",
14035 "name": "DeleteReports",
14036 "group": "JscriptyAnswerReport",
14037 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14038 "version": "0.0.0",
14039 "filename": "server/api/jscriptyAnswerReport/index.js",
14040 "groupTitle": "JscriptyAnswerReport"
14044 "url": "/api/jscripty/answers/reports/describe",
14045 "title": "Gets table info about Reports",
14048 "title": "Example usage:",
14049 "content": "curl https://{domain}/api/jscripty/answers/reports/describe -v -u {name}:{password}",
14053 "name": "DescribeReports",
14054 "group": "JscriptyAnswerReport",
14055 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14056 "version": "0.0.0",
14057 "filename": "server/api/jscriptyAnswerReport/index.js",
14058 "groupTitle": "JscriptyAnswerReport"
14062 "url": "/api/jscripty/answers/reports",
14063 "title": "Gets a list of Reports",
14066 "title": "Example usage:",
14067 "content": "curl https://{domain}/api/jscripty/answers/reports -v -u {name}:{password}",
14071 "name": "GetReports",
14072 "group": "JscriptyAnswerReport",
14073 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
14074 "version": "0.0.0",
14075 "filename": "server/api/jscriptyAnswerReport/index.js",
14076 "groupTitle": "JscriptyAnswerReport"
14080 "url": "/api/jscripty/answers/reports/{id}",
14081 "title": "Gets a single Report",
14084 "title": "Example usage:",
14085 "content": "curl https://{domain}/api/jscripty/answers/reports/{id} -v -u {name}:{password}",
14089 "name": "ShowReports",
14090 "group": "JscriptyAnswerReport",
14091 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14092 "version": "0.0.0",
14093 "filename": "server/api/jscriptyAnswerReport/index.js",
14094 "groupTitle": "JscriptyAnswerReport"
14098 "url": "/api/jscripty/answers/reports/{id}",
14099 "title": "Update an existing Report",
14102 "title": "Example usage:",
14103 "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",
14107 "name": "updateReports",
14108 "group": "JscriptyAnswerReport",
14109 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14110 "version": "0.0.0",
14111 "filename": "server/api/jscriptyAnswerReport/index.js",
14112 "groupTitle": "JscriptyAnswerReport"
14116 "url": "/api/jscripty/questions/reports",
14117 "title": "Creates a new Report",
14120 "title": "Example usage:",
14121 "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",
14125 "name": "CreateReports",
14126 "group": "JscriptyQuestionReport",
14134 "field": "question",
14148 "field": "membername",
14155 "field": "projectname",
14169 "field": "uniqueid",
14176 "field": "calleridname",
14183 "field": "calleridnum",
14190 "field": "questionId",
14196 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14197 "version": "0.0.0",
14198 "filename": "server/api/jscriptyQuestionReport/index.js",
14199 "groupTitle": "JscriptyQuestionReport"
14203 "url": "/api/jscripty/questions/reports/{id}",
14204 "title": "Deletes a Report",
14207 "title": "Example usage:",
14208 "content": "curl https://{domain}/api/jscripty/questions/reports/{id} -v -u {name}:{password} -X DELETE",
14212 "name": "DeleteReports",
14213 "group": "JscriptyQuestionReport",
14214 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14215 "version": "0.0.0",
14216 "filename": "server/api/jscriptyQuestionReport/index.js",
14217 "groupTitle": "JscriptyQuestionReport"
14221 "url": "/api/jscripty/questions/reports/describe",
14222 "title": "Gets table info about Reports",
14225 "title": "Example usage:",
14226 "content": "curl https://{domain}/api/jscripty/questions/reports/describe -v -u {name}:{password}",
14230 "name": "DescribeReports",
14231 "group": "JscriptyQuestionReport",
14232 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14233 "version": "0.0.0",
14234 "filename": "server/api/jscriptyQuestionReport/index.js",
14235 "groupTitle": "JscriptyQuestionReport"
14239 "url": "/api/jscripty/questions/reports",
14240 "title": "Gets a list of Reports",
14243 "title": "Example usage:",
14244 "content": "curl https://{domain}/api/jscripty/questions/reports -v -u {name}:{password}",
14248 "name": "GetReports",
14249 "group": "JscriptyQuestionReport",
14250 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
14251 "version": "0.0.0",
14252 "filename": "server/api/jscriptyQuestionReport/index.js",
14253 "groupTitle": "JscriptyQuestionReport"
14257 "url": "/api/jscripty/questions/reports/{id}",
14258 "title": "Gets a single Report",
14261 "title": "Example usage:",
14262 "content": "curl https://{domain}/api/jscripty/questions/reports/{id} -v -u {name}:{password}",
14266 "name": "ShowReports",
14267 "group": "JscriptyQuestionReport",
14268 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14269 "version": "0.0.0",
14270 "filename": "server/api/jscriptyQuestionReport/index.js",
14271 "groupTitle": "JscriptyQuestionReport"
14275 "url": "/api/jscripty/questions/reports/{id}",
14276 "title": "Update an existing Report",
14279 "title": "Example usage:",
14280 "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",
14284 "name": "updateReports",
14285 "group": "JscriptyQuestionReport",
14286 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14287 "version": "0.0.0",
14288 "filename": "server/api/jscriptyQuestionReport/index.js",
14289 "groupTitle": "JscriptyQuestionReport"
14293 "url": "/api/jscripty/sessions/reports",
14294 "title": "Creates a new Report",
14297 "title": "Example usage:",
14298 "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",
14302 "name": "CreateReports",
14303 "group": "JscriptySessionReport",
14311 "field": "starttime",
14318 "field": "endtime",
14325 "field": "membername",
14332 "field": "projectname",
14346 "field": "uniqueid",
14353 "field": "calleridname",
14360 "field": "calleridnum",
14367 "field": "completed",
14373 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14374 "version": "0.0.0",
14375 "filename": "server/api/jscriptySessionReport/index.js",
14376 "groupTitle": "JscriptySessionReport"
14380 "url": "/api/jscripty/sessions/reports/{id}",
14381 "title": "Deletes a Report",
14384 "title": "Example usage:",
14385 "content": "curl https://{domain}/api/jscripty/sessions/reports/{id} -v -u {name}:{password} -X DELETE",
14389 "name": "DeleteReports",
14390 "group": "JscriptySessionReport",
14391 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14392 "version": "0.0.0",
14393 "filename": "server/api/jscriptySessionReport/index.js",
14394 "groupTitle": "JscriptySessionReport"
14398 "url": "/api/jscripty/sessions/reports/describe",
14399 "title": "Gets table info about Reports",
14402 "title": "Example usage:",
14403 "content": "curl https://{domain}/api/jscripty/sessions/reports/describe -v -u {name}:{password}",
14407 "name": "DescribeReports",
14408 "group": "JscriptySessionReport",
14409 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14410 "version": "0.0.0",
14411 "filename": "server/api/jscriptySessionReport/index.js",
14412 "groupTitle": "JscriptySessionReport"
14416 "url": "/api/jscripty/sessions/reports",
14417 "title": "Gets a list of Reports",
14420 "title": "Example usage:",
14421 "content": "curl https://{domain}/api/jscripty/sessions/reports -v -u {name}:{password}",
14425 "name": "GetReports",
14426 "group": "JscriptySessionReport",
14427 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
14428 "version": "0.0.0",
14429 "filename": "server/api/jscriptySessionReport/index.js",
14430 "groupTitle": "JscriptySessionReport"
14434 "url": "/api/jscripty/sessions/reports/{id}",
14435 "title": "Gets a single Report",
14438 "title": "Example usage:",
14439 "content": "curl https://{domain}/api/jscripty/sessions/reports/{id} -v -u {name}:{password}",
14443 "name": "ShowReports",
14444 "group": "JscriptySessionReport",
14445 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14446 "version": "0.0.0",
14447 "filename": "server/api/jscriptySessionReport/index.js",
14448 "groupTitle": "JscriptySessionReport"
14452 "url": "/api/jscripty/sessions/reports/{id}/questions",
14453 "title": "Gets Jscripty Session questions",
14456 "title": "Example usage:",
14457 "content": "curl https://{domain}/api/jscripty/sessions/reports/{id}/questions -v -u {name}:{password} -X GET",
14461 "name": "getQuestions",
14462 "group": "JscriptySessionReport",
14463 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14464 "version": "0.0.0",
14465 "filename": "server/api/jscriptySessionReport/index.js",
14466 "groupTitle": "JscriptySessionReport"
14470 "url": "/api/jscripty/sessions/reports/{id}",
14471 "title": "Update an existing Report",
14474 "title": "Example usage:",
14475 "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",
14479 "name": "updateReports",
14480 "group": "JscriptySessionReport",
14481 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14482 "version": "0.0.0",
14483 "filename": "server/api/jscriptySessionReport/index.js",
14484 "groupTitle": "JscriptySessionReport"
14488 "url": "/api/jscripty/projects/clone",
14489 "title": "Clone an existing Project",
14492 "title": "Example usage:",
14493 "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",
14497 "name": "CloneProjects",
14498 "group": "Jscripty_Projects",
14499 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14500 "version": "0.0.0",
14501 "filename": "server/api/jscriptyProject/index.js",
14502 "groupTitle": "Jscripty_Projects"
14506 "url": "/api/jscripty/projects",
14507 "title": "Creates a new Project",
14510 "title": "Example usage:",
14511 "content": "curl https://{domain}/api/jscripty/projects -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
14515 "name": "CreateProjects",
14516 "group": "Jscripty_Projects",
14531 "field": "description",
14538 "field": "formData",
14545 "field": "enableUncompleteSave",
14552 "field": "sendUnpauseOnSubmit",
14558 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14559 "version": "0.0.0",
14560 "filename": "server/api/jscriptyProject/index.js",
14561 "groupTitle": "Jscripty_Projects"
14565 "url": "/api/jscripty/projects/{id}",
14566 "title": "Deletes a Project",
14569 "title": "Example usage:",
14570 "content": "curl https://{domain}/api/jscripty/projects/{id} -v -u {name}:{password} -X DELETE",
14574 "name": "DeleteProjects",
14575 "group": "Jscripty_Projects",
14576 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14577 "version": "0.0.0",
14578 "filename": "server/api/jscriptyProject/index.js",
14579 "groupTitle": "Jscripty_Projects"
14583 "url": "/api/jscripty/projects",
14584 "title": "Gets a list of Projects",
14587 "title": "Example usage:",
14588 "content": "curl https://{domain}/api/jscripty/projects -v -u {name}:{password}",
14592 "name": "GetProjects",
14593 "group": "Jscripty_Projects",
14594 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
14595 "version": "0.0.0",
14596 "filename": "server/api/jscriptyProject/index.js",
14597 "groupTitle": "Jscripty_Projects"
14601 "url": "/api/jscripty/projects/{id}",
14602 "title": "Gets a single Project",
14605 "title": "Example usage:",
14606 "content": "curl https://{domain}/api/jscripty/projects/{id} -v -u {name}:{password}",
14610 "name": "ShowProjects",
14611 "group": "Jscripty_Projects",
14612 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14613 "version": "0.0.0",
14614 "filename": "server/api/jscriptyProject/index.js",
14615 "groupTitle": "Jscripty_Projects"
14619 "url": "/api/jscripty/projects/{id}/answers",
14620 "title": "Gets jscripty project answers",
14623 "title": "Example usage:",
14624 "content": "curl https://{domain}/api/jscripty/projects/{id}/answers -v -u {name}:{password} -X GET",
14628 "name": "getAnswers",
14629 "group": "Jscripty_Projects",
14630 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14631 "version": "0.0.0",
14632 "filename": "server/api/jscriptyProject/index.js",
14633 "groupTitle": "Jscripty_Projects"
14637 "url": "/api/jscripty/projects/{id}/sessions",
14638 "title": "Gets jscripty project sessions",
14641 "title": "Example usage:",
14642 "content": "curl https://{domain}/api/jscripty/projects/{id}/sessions -v -u {name}:{password} -X GET",
14646 "name": "getSessions",
14647 "group": "Jscripty_Projects",
14648 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14649 "version": "0.0.0",
14650 "filename": "server/api/jscriptyProject/index.js",
14651 "groupTitle": "Jscripty_Projects"
14655 "url": "/api/jscripty/projects/{id}/summary",
14656 "title": "Gets jscripty project summary",
14659 "title": "Example usage:",
14660 "content": "curl https://{domain}/api/jscripty/projects/{id}/summary -v -u {name}:{password} -X GET",
14664 "name": "getSummary",
14665 "group": "Jscripty_Projects",
14666 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14667 "version": "0.0.0",
14668 "filename": "server/api/jscriptyProject/index.js",
14669 "groupTitle": "Jscripty_Projects"
14673 "url": "/api/jscripty/projects/{id}",
14674 "title": "Update an existing Project",
14677 "title": "Example usage:",
14678 "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",
14682 "name": "updateProjects",
14683 "group": "Jscripty_Projects",
14684 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14685 "version": "0.0.0",
14686 "filename": "server/api/jscriptyProject/index.js",
14687 "groupTitle": "Jscripty_Projects"
14691 "url": "/api/license",
14692 "title": "Gets License Info",
14695 "title": "Example usage:",
14696 "content": "curl https://{domain}/api/license -v -u {name}:{password} -X GET",
14701 "group": "License",
14702 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14703 "version": "0.0.0",
14704 "filename": "server/api/license/index.js",
14705 "groupTitle": "License"
14709 "url": "/api/license/{id}",
14710 "title": "Update License Info",
14713 "title": "Example usage:",
14714 "content": "curl https://{domain}/api/license/{id} -v -u {name}:{password} -X PUT",
14719 "group": "License",
14720 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14721 "version": "0.0.0",
14722 "filename": "server/api/license/index.js",
14723 "groupTitle": "License"
14727 "url": "/api/mail/accounts/{id}/users",
14728 "title": "Add agents to a mail account",
14731 "title": "Example usage:",
14732 "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",
14736 "name": "AddAgents",
14737 "group": "Mail_Accounts",
14738 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14739 "version": "0.0.0",
14740 "filename": "server/api/mailAccount/index.js",
14741 "groupTitle": "Mail_Accounts"
14745 "url": "/api/mail/accounts/{id}/in_servers",
14746 "title": "Creates a new IMAP server",
14749 "title": "Example usage:",
14750 "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",
14755 "group": "Mail_Accounts",
14763 "field": "description",
14777 "field": "authentication",
14791 "field": "password",
14812 "field": "mailbox",
14819 "field": "connTimeout",
14826 "field": "authTimeout",
14833 "field": "service",
14839 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14840 "version": "0.0.0",
14841 "filename": "server/api/mailAccount/index.js",
14842 "groupTitle": "Mail_Accounts"
14846 "url": "/api/mail/accounts/{id}/out_servers",
14847 "title": "Creates a new SMTP server",
14850 "title": "Example usage:",
14851 "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",
14856 "group": "Mail_Accounts",
14864 "field": "description",
14906 "field": "service",
14913 "field": "authentication",
14919 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14920 "version": "0.0.0",
14921 "filename": "server/api/mailAccount/index.js",
14922 "groupTitle": "Mail_Accounts"
14926 "url": "/api/mail/accounts/{id}",
14927 "title": "Deletes a mail account",
14930 "title": "Example usage:",
14931 "content": "curl https://{domain}/api/mail/accounts/{id} -v -u {name}:{password} -X DELETE",
14935 "name": "DeleteMailAccounts",
14936 "group": "Mail_Accounts",
14937 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14938 "version": "0.0.0",
14939 "filename": "server/api/mailAccount/index.js",
14940 "groupTitle": "Mail_Accounts"
14944 "url": "/api/mail/accounts/describe",
14945 "title": "Gets table info about Accounts",
14948 "title": "Example usage:",
14949 "content": "curl https://{domain}/api/mail/accounts/describe -v -u {name}:{password}",
14953 "name": "DescribeAccounts",
14954 "group": "Mail_Accounts",
14955 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14956 "version": "0.0.0",
14957 "filename": "server/api/mailAccount/index.js",
14958 "groupTitle": "Mail_Accounts"
14962 "url": "/api/mail/accounts",
14963 "title": "Gets a list of Accounts",
14966 "title": "Example usage:",
14967 "content": "curl https://{domain}/api/mail/accounts -v -u {name}:{password}",
14971 "name": "GetAccounts",
14972 "group": "Mail_Accounts",
14973 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
14974 "version": "0.0.0",
14975 "filename": "server/api/mailAccount/index.js",
14976 "groupTitle": "Mail_Accounts"
14980 "url": "/api/mail/accounts/{id}/users",
14981 "title": "Gets agents from mail account",
14984 "title": "Example usage:",
14985 "content": "curl https://{domain}/api/mail/accounts/{id}/users -v -u {name}:{password} -X GET",
14989 "name": "GetAgents",
14990 "group": "Mail_Accounts",
14991 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14992 "version": "0.0.0",
14993 "filename": "server/api/mailAccount/index.js",
14994 "groupTitle": "Mail_Accounts"
14998 "url": "/api/mail/accounts/{id}/in_servers",
14999 "title": "Gets account IMAP server",
15002 "title": "Example usage:",
15003 "content": "curl https://{domain}/api/mail/accounts/{id}/in_servers -v -u {name}:{password} -X GET",
15008 "group": "Mail_Accounts",
15009 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15010 "version": "0.0.0",
15011 "filename": "server/api/mailAccount/index.js",
15012 "groupTitle": "Mail_Accounts"
15016 "url": "/api/mail/accounts/{id}/out_servers",
15017 "title": "Gets account SMTP server",
15020 "title": "Example usage:",
15021 "content": "curl https://{domain}/api/mail/accounts/{id}/out_servers -v -u {name}:{password} -X GET",
15026 "group": "Mail_Accounts",
15027 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15028 "version": "0.0.0",
15029 "filename": "server/api/mailAccount/index.js",
15030 "groupTitle": "Mail_Accounts"
15034 "url": "/api/mail/accounts/{id}/users",
15035 "title": "Removes agents from a mail account",
15038 "title": "Example usage:",
15039 "content": "curl https://{domain}/api/mail/accounts/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
15043 "name": "RemoveAgents",
15044 "group": "Mail_Accounts",
15045 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15046 "version": "0.0.0",
15047 "filename": "server/api/mailAccount/index.js",
15048 "groupTitle": "Mail_Accounts"
15052 "url": "/api/mail/accounts/{id}/canned_answers",
15053 "title": "Removes canned answers from account",
15056 "title": "Example usage:",
15057 "content": "curl https://{domain}/api/mail/accounts/{id}/canned_answers?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
15061 "name": "RemoveAnswers",
15062 "group": "Mail_Accounts",
15063 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15064 "version": "0.0.0",
15065 "filename": "server/api/mailAccount/index.js",
15066 "groupTitle": "Mail_Accounts"
15070 "url": "/api/mail/accounts/{id}/dispositions",
15071 "title": "Removes dispositions from account",
15074 "title": "Example usage:",
15075 "content": "curl https://{domain}/api/mail/accounts/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
15079 "name": "RemoveDispositions",
15080 "group": "Mail_Accounts",
15081 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15082 "version": "0.0.0",
15083 "filename": "server/api/mailAccount/index.js",
15084 "groupTitle": "Mail_Accounts"
15088 "url": "/api/mail/accounts/{id}/in_servers",
15089 "title": "Removes IMAP server from an account",
15092 "title": "Example usage:",
15093 "content": "curl https://{domain}/api/mail/accounts/{id}/in_servers -v -u {name}:{password} -X DELETE",
15097 "name": "RemoveImmap",
15098 "group": "Mail_Accounts",
15099 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15100 "version": "0.0.0",
15101 "filename": "server/api/mailAccount/index.js",
15102 "groupTitle": "Mail_Accounts"
15106 "url": "/api/mail/accounts/{id}/out_servers",
15107 "title": "Removes SMTP server from an account",
15110 "title": "Example usage:",
15111 "content": "curl https://{domain}/api/mail/accounts/{id}/out_servers -v -u {name}:{password} -X DELETE",
15115 "name": "RemoveSmtp",
15116 "group": "Mail_Accounts",
15117 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15118 "version": "0.0.0",
15119 "filename": "server/api/mailAccount/index.js",
15120 "groupTitle": "Mail_Accounts"
15124 "url": "/api/mail/accounts/{id}",
15125 "title": "Gets a single Account",
15128 "title": "Example usage:",
15129 "content": "curl https://{domain}/api/mail/accounts/{id} -v -u {name}:{password}",
15133 "name": "ShowAccounts",
15134 "group": "Mail_Accounts",
15135 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15136 "version": "0.0.0",
15137 "filename": "server/api/mailAccount/index.js",
15138 "groupTitle": "Mail_Accounts"
15142 "url": "/api/mail/accounts/{id}/canned_answers",
15143 "title": "Creates new canned answer",
15146 "title": "Example usage:",
15147 "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",
15151 "name": "addAnswer",
15152 "group": "Mail_Accounts",
15174 "field": "description",
15187 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15188 "version": "0.0.0",
15189 "filename": "server/api/mailAccount/index.js",
15190 "groupTitle": "Mail_Accounts"
15194 "url": "/api/mail/accounts/{id}/applications",
15195 "title": "Creates new applications",
15198 "title": "Example usage:",
15199 "content": "curl https://{domain}/api/mail/accounts/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
15203 "name": "addApplications",
15204 "group": "Mail_Accounts",
15212 "field": "priority",
15226 "field": "appdata",
15233 "field": "description",
15240 "field": "interval",
15246 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15247 "version": "0.0.0",
15248 "filename": "server/api/mailAccount/index.js",
15249 "groupTitle": "Mail_Accounts"
15253 "url": "/api/mail/accounts/{id}/dispositions",
15254 "title": "Creates new disposition",
15257 "title": "Example usage:",
15258 "content": "curl https://{domain}/api/mail/accounts/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
15262 "name": "addDisposition",
15263 "group": "Mail_Accounts",
15290 "field": "description",
15296 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15297 "version": "0.0.0",
15298 "filename": "server/api/mailAccount/index.js",
15299 "groupTitle": "Mail_Accounts"
15303 "url": "/api/mail/accounts/{id}/interactions",
15304 "title": "Creates new interactions",
15307 "title": "Example usage:",
15308 "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",
15312 "name": "addInteraction",
15313 "group": "Mail_Accounts",
15328 "field": "closedAt",
15335 "field": "disposition",
15342 "field": "secondDisposition",
15349 "field": "thirdDisposition",
15363 "field": "inReplyTo",
15384 "field": "subject",
15398 "field": "read1stAt",
15405 "field": "substatus",
15412 "field": "substatusAt",
15423 "field": "firstMsgDirection",
15430 "field": "lastMsgAt",
15441 "field": "lastMsgDirection",
15447 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15448 "version": "0.0.0",
15449 "filename": "server/api/mailAccount/index.js",
15450 "groupTitle": "Mail_Accounts"
15454 "url": "/api/mail/accounts",
15455 "title": "Create a mail account",
15458 "title": "Example usage:",
15459 "content": "curl https://{domain}/api/mail/accounts \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
15464 "group": "Mail_Accounts",
15465 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15466 "version": "0.0.0",
15467 "filename": "server/api/mailAccount/index.js",
15468 "groupTitle": "Mail_Accounts"
15472 "url": "/api/mail/accounts/{id}/canned_answers",
15473 "title": "Gets account canned answers",
15476 "title": "Example usage:",
15477 "content": "curl https://{domain}/api/mail/accounts/{id}/canned_answers -v -u {name}:{password} -X GET",
15481 "name": "getAnswers",
15482 "group": "Mail_Accounts",
15483 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15484 "version": "0.0.0",
15485 "filename": "server/api/mailAccount/index.js",
15486 "groupTitle": "Mail_Accounts"
15490 "url": "/api/mail/accounts/{id}/applications",
15491 "title": "Gets account applications",
15494 "title": "Example usage:",
15495 "content": "curl https://{domain}/api/mail/accounts/{id}/applications -v -u {name}:{password} -X GET",
15499 "name": "getApplications",
15500 "group": "Mail_Accounts",
15501 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15502 "version": "0.0.0",
15503 "filename": "server/api/mailAccount/index.js",
15504 "groupTitle": "Mail_Accounts"
15508 "url": "/api/mail/accounts/{id}/dispositions",
15509 "title": "Gets account dispositions",
15512 "title": "Example usage:",
15513 "content": "curl https://{domain}/api/mail/accounts/{id}/dispositions -v -u {name}:{password} -X GET",
15517 "name": "getDispositions",
15518 "group": "Mail_Accounts",
15519 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15520 "version": "0.0.0",
15521 "filename": "server/api/mailAccount/index.js",
15522 "groupTitle": "Mail_Accounts"
15526 "url": "/api/mail/accounts/{id}/interactions",
15527 "title": "Gets account interactions",
15530 "title": "Example usage:",
15531 "content": "curl https://{domain}/api/mail/accounts/{id}/interactions -v -u {name}:{password} -X GET",
15535 "name": "getInteraction",
15536 "group": "Mail_Accounts",
15537 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15538 "version": "0.0.0",
15539 "filename": "server/api/mailAccount/index.js",
15540 "groupTitle": "Mail_Accounts"
15544 "url": "/api/mail/accounts/{id}/messages",
15545 "title": "Gets account messages",
15548 "title": "Example usage:",
15549 "content": "curl https://{domain}/api/mail/accounts/{id}/messages -v -u {name}:{password} -X GET",
15553 "name": "getMessages",
15554 "group": "Mail_Accounts",
15555 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15556 "version": "0.0.0",
15557 "filename": "server/api/mailAccount/index.js",
15558 "groupTitle": "Mail_Accounts"
15562 "url": "/api/mail/accounts/{id}/send",
15563 "title": "Send new mail",
15566 "title": "Example usage:",
15567 "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",
15571 "name": "sendMail",
15572 "group": "Mail_Accounts",
15573 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15574 "version": "0.0.0",
15575 "filename": "server/api/mailAccount/index.js",
15576 "groupTitle": "Mail_Accounts"
15580 "url": "/api/mail/accounts/{id}",
15581 "title": "Update an existing Account",
15584 "title": "Example usage:",
15585 "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",
15589 "name": "updateAccounts",
15590 "group": "Mail_Accounts",
15591 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15592 "version": "0.0.0",
15593 "filename": "server/api/mailAccount/index.js",
15594 "groupTitle": "Mail_Accounts"
15598 "url": "/api/mail/accounts/{id}/verify",
15599 "title": "Verify mail account",
15602 "title": "Example usage:",
15603 "content": "curl https://{domain}/api/mail/accounts/{id}/verify -v -u {name}:{password} -X GET",
15607 "name": "verifySmtp",
15608 "group": "Mail_Accounts",
15609 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15610 "version": "0.0.0",
15611 "filename": "server/api/mailAccount/index.js",
15612 "groupTitle": "Mail_Accounts"
15616 "url": "/api/mail/applications/{id}",
15617 "title": "Deletes a Application",
15620 "title": "Example usage:",
15621 "content": "curl https://{domain}/api/mail/applications/{id} -v -u {name}:{password} -X DELETE",
15625 "name": "DeleteApplications",
15626 "group": "Mail_Applications",
15627 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15628 "version": "0.0.0",
15629 "filename": "server/api/mailApplication/index.js",
15630 "groupTitle": "Mail_Applications"
15634 "url": "/api/mail/applications/{id}",
15635 "title": "Gets a single Application",
15638 "title": "Example usage:",
15639 "content": "curl https://{domain}/api/mail/applications/{id} -v -u {name}:{password}",
15643 "name": "ShowApplications",
15644 "group": "Mail_Applications",
15645 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15646 "version": "0.0.0",
15647 "filename": "server/api/mailApplication/index.js",
15648 "groupTitle": "Mail_Applications"
15652 "url": "/api/mail/applications/{id}",
15653 "title": "Update an existing Application",
15656 "title": "Example usage:",
15657 "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",
15661 "name": "updateApplications",
15662 "group": "Mail_Applications",
15663 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15664 "version": "0.0.0",
15665 "filename": "server/api/mailApplication/index.js",
15666 "groupTitle": "Mail_Applications"
15670 "url": "/api/mail/interactions/{id}/tags",
15671 "title": "Add tags to the interaction",
15674 "title": "Example usage:",
15675 "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",
15680 "group": "Mail_Interactions",
15681 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15682 "version": "0.0.0",
15683 "filename": "server/api/mailInteraction/index.js",
15684 "groupTitle": "Mail_Interactions"
15688 "url": "/api/mail/interactions",
15689 "title": "Creates a new Interaction",
15692 "title": "Example usage:",
15693 "content": "curl https://{domain}/api/mail/interactions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
15697 "name": "CreateInteractions",
15698 "group": "Mail_Interactions",
15713 "field": "closedAt",
15720 "field": "disposition",
15727 "field": "secondDisposition",
15734 "field": "thirdDisposition",
15748 "field": "inReplyTo",
15769 "field": "subject",
15783 "field": "read1stAt",
15790 "field": "substatus",
15797 "field": "substatusAt",
15808 "field": "firstMsgDirection",
15815 "field": "lastMsgAt",
15826 "field": "lastMsgDirection",
15832 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15833 "version": "0.0.0",
15834 "filename": "server/api/mailInteraction/index.js",
15835 "groupTitle": "Mail_Interactions"
15839 "url": "/api/mail/interactions/{id}",
15840 "title": "Deletes a Interaction",
15843 "title": "Example usage:",
15844 "content": "curl https://{domain}/api/mail/interactions/{id} -v -u {name}:{password} -X DELETE",
15848 "name": "DeleteInteractions",
15849 "group": "Mail_Interactions",
15850 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15851 "version": "0.0.0",
15852 "filename": "server/api/mailInteraction/index.js",
15853 "groupTitle": "Mail_Interactions"
15857 "url": "/api/mail/interactions/describe",
15858 "title": "Gets table info about Interactions",
15861 "title": "Example usage:",
15862 "content": "curl https://{domain}/api/mail/interactions/describe -v -u {name}:{password}",
15866 "name": "DescribeInteractions",
15867 "group": "Mail_Interactions",
15868 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15869 "version": "0.0.0",
15870 "filename": "server/api/mailInteraction/index.js",
15871 "groupTitle": "Mail_Interactions"
15875 "url": "/api/mail/interactions",
15876 "title": "Gets a list of Interactions",
15879 "title": "Example usage:",
15880 "content": "curl https://{domain}/api/mail/interactions -v -u {name}:{password}",
15884 "name": "GetInteractions",
15885 "group": "Mail_Interactions",
15886 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
15887 "version": "0.0.0",
15888 "filename": "server/api/mailInteraction/index.js",
15889 "groupTitle": "Mail_Interactions"
15893 "url": "/api/mail/interactions/{id}/tags",
15894 "title": "Removes tags from interaction",
15897 "title": "Example usage:",
15898 "content": "curl https://{domain}/api/mail/interactions/{id}/tags?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
15902 "name": "RemoveTags",
15903 "group": "Mail_Interactions",
15904 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15905 "version": "0.0.0",
15906 "filename": "server/api/mailInteraction/index.js",
15907 "groupTitle": "Mail_Interactions"
15911 "url": "/api/mail/interactions/{id}",
15912 "title": "Gets a single Interaction",
15915 "title": "Example usage:",
15916 "content": "curl https://{domain}/api/mail/interactions/{id} -v -u {name}:{password}",
15920 "name": "ShowInteractions",
15921 "group": "Mail_Interactions",
15922 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15923 "version": "0.0.0",
15924 "filename": "server/api/mailInteraction/index.js",
15925 "groupTitle": "Mail_Interactions"
15929 "url": "/api/mail/interactions/{id}/messages",
15930 "title": "Creates new message",
15933 "title": "Example usage:",
15934 "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",
15938 "name": "addMessage",
15939 "group": "Mail_Interactions",
15954 "field": "plainBody",
15972 "field": "direction",
15979 "field": "messageId",
16014 "field": "subject",
16049 "field": "originTo",
16056 "field": "originCc",
16067 "field": "originChannel",
16073 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16074 "version": "0.0.0",
16075 "filename": "server/api/mailInteraction/index.js",
16076 "groupTitle": "Mail_Interactions"
16080 "url": "/api/mail/interactions/{id}/download",
16081 "title": "Gets interaction",
16084 "title": "Example usage:",
16085 "content": "curl https://{domain}/api/mail/interactions/{id}/download -v -u {name}:{password} -X GET",
16089 "name": "download",
16090 "group": "Mail_Interactions",
16091 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16092 "version": "0.0.0",
16093 "filename": "server/api/mailInteraction/index.js",
16094 "groupTitle": "Mail_Interactions"
16098 "url": "/api/mail/interactions/{id}/messages",
16099 "title": "Gets interaction messages",
16102 "title": "Example usage:",
16103 "content": "curl https://{domain}/api/mail/interactions/{id}/messages -v -u {name}:{password} -X GET",
16107 "name": "getMessages",
16108 "group": "Mail_Interactions",
16109 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16110 "version": "0.0.0",
16111 "filename": "server/api/mailInteraction/index.js",
16112 "groupTitle": "Mail_Interactions"
16116 "url": "/api/mail/interactions/{id}",
16117 "title": "Update an existing Interaction",
16120 "title": "Example usage:",
16121 "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",
16125 "name": "updateInteractions",
16126 "group": "Mail_Interactions",
16127 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16128 "version": "0.0.0",
16129 "filename": "server/api/mailInteraction/index.js",
16130 "groupTitle": "Mail_Interactions"
16134 "url": "/api/mail/messages/{id}",
16135 "title": "Deletes a Message",
16138 "title": "Example usage:",
16139 "content": "curl https://{domain}/api/mail/messages/{id} -v -u {name}:{password} -X DELETE",
16143 "name": "DeleteMessages",
16144 "group": "Mail_Messages",
16145 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16146 "version": "0.0.0",
16147 "filename": "server/api/mailMessage/index.js",
16148 "groupTitle": "Mail_Messages"
16152 "url": "/api/mail/messages/describe",
16153 "title": "Gets table info about Messages",
16156 "title": "Example usage:",
16157 "content": "curl https://{domain}/api/mail/messages/describe -v -u {name}:{password}",
16161 "name": "DescribeMessages",
16162 "group": "Mail_Messages",
16163 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16164 "version": "0.0.0",
16165 "filename": "server/api/mailMessage/index.js",
16166 "groupTitle": "Mail_Messages"
16170 "url": "/api/mail/messages",
16171 "title": "Gets a list of Messages",
16174 "title": "Example usage:",
16175 "content": "curl https://{domain}/api/mail/messages -v -u {name}:{password}",
16179 "name": "GetMessages",
16180 "group": "Mail_Messages",
16181 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
16182 "version": "0.0.0",
16183 "filename": "server/api/mailMessage/index.js",
16184 "groupTitle": "Mail_Messages"
16188 "url": "/api/mail/messages/{id}",
16189 "title": "Gets a single Message",
16192 "title": "Example usage:",
16193 "content": "curl https://{domain}/api/mail/messages/{id} -v -u {name}:{password}",
16197 "name": "ShowMessages",
16198 "group": "Mail_Messages",
16199 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16200 "version": "0.0.0",
16201 "filename": "server/api/mailMessage/index.js",
16202 "groupTitle": "Mail_Messages"
16206 "url": "/api/mail/messages/{id}/accept",
16207 "title": "Accepts message",
16210 "title": "Example usage:",
16211 "content": "curl https://{domain}/api/mail/messages/{id}/accept \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
16215 "name": "acceptMessage",
16216 "group": "Mail_Messages",
16217 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16218 "version": "0.0.0",
16219 "filename": "server/api/mailMessage/index.js",
16220 "groupTitle": "Mail_Messages"
16224 "url": "/api/mail/messages",
16225 "title": "Create a message",
16228 "title": "Example usage:",
16229 "content": "curl https://{domain}/api/mail/messages \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
16233 "name": "createMessage",
16234 "group": "Mail_Messages",
16235 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16236 "version": "0.0.0",
16237 "filename": "server/api/mailMessage/index.js",
16238 "groupTitle": "Mail_Messages"
16242 "url": "/api/mail/messages/{id}/download",
16243 "title": "Gets message",
16246 "title": "Example usage:",
16247 "content": "curl https://{domain}/api/mail/messages/{id}/download -v -u {name}:{password} -X GET",
16251 "name": "download",
16252 "group": "Mail_Messages",
16253 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16254 "version": "0.0.0",
16255 "filename": "server/api/mailMessage/index.js",
16256 "groupTitle": "Mail_Messages"
16260 "url": "/api/mail/messages/{id}/reject",
16261 "title": "Rejects message",
16264 "title": "Example usage:",
16265 "content": "curl https://{domain}/api/mail/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
16269 "name": "rejectMessage",
16270 "group": "Mail_Messages",
16271 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16272 "version": "0.0.0",
16273 "filename": "server/api/mailMessage/index.js",
16274 "groupTitle": "Mail_Messages"
16278 "url": "/api/mail/messages/{id}",
16279 "title": "Update an existing Message",
16282 "title": "Example usage:",
16283 "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",
16287 "name": "updateMessages",
16288 "group": "Mail_Messages",
16289 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16290 "version": "0.0.0",
16291 "filename": "server/api/mailMessage/index.js",
16292 "groupTitle": "Mail_Messages"
16296 "url": "/api/mail/reports/queue",
16297 "title": "Creates a new Mail Queue Report",
16300 "title": "Example usage:",
16301 "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",
16305 "name": "CreateMail_Queue_Reports",
16306 "group": "Mail_Queue_Reports",
16314 "field": "uniqueid",
16335 "field": "leaveAt",
16342 "field": "acceptAt",
16362 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16363 "version": "0.0.0",
16364 "filename": "server/api/mailQueueReport/index.js",
16365 "groupTitle": "Mail_Queue_Reports"
16369 "url": "/api/mail/reports/queue/{id}",
16370 "title": "Deletes a Mail Queue Report",
16373 "title": "Example usage:",
16374 "content": "curl https://{domain}/api/mail/reports/queue/{id} -v -u {name}:{password} -X DELETE",
16378 "name": "DeleteMail_Queue_Reports",
16379 "group": "Mail_Queue_Reports",
16380 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16381 "version": "0.0.0",
16382 "filename": "server/api/mailQueueReport/index.js",
16383 "groupTitle": "Mail_Queue_Reports"
16387 "url": "/api/mail/reports/queue/describe",
16388 "title": "Gets table info about Mail Queue Reports",
16391 "title": "Example usage:",
16392 "content": "curl https://{domain}/api/mail/reports/queue/describe -v -u {name}:{password}",
16396 "name": "DescribeMail_Queue_Reports",
16397 "group": "Mail_Queue_Reports",
16398 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16399 "version": "0.0.0",
16400 "filename": "server/api/mailQueueReport/index.js",
16401 "groupTitle": "Mail_Queue_Reports"
16405 "url": "/api/mail/reports/queue",
16406 "title": "Gets a list of Mail Queue Reports",
16409 "title": "Example usage:",
16410 "content": "curl https://{domain}/api/mail/reports/queue -v -u {name}:{password}",
16414 "name": "GetMail_Queue_Reports",
16415 "group": "Mail_Queue_Reports",
16416 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
16417 "version": "0.0.0",
16418 "filename": "server/api/mailQueueReport/index.js",
16419 "groupTitle": "Mail_Queue_Reports"
16423 "url": "/api/mail/reports/queue/{id}",
16424 "title": "Gets a single Mail Queue Report",
16427 "title": "Example usage:",
16428 "content": "curl https://{domain}/api/mail/reports/queue/{id} -v -u {name}:{password}",
16432 "name": "ShowMail_Queue_Reports",
16433 "group": "Mail_Queue_Reports",
16434 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16435 "version": "0.0.0",
16436 "filename": "server/api/mailQueueReport/index.js",
16437 "groupTitle": "Mail_Queue_Reports"
16441 "url": "/api/mail/reports/queue/{id}",
16442 "title": "Update an existing Mail Queue Report",
16445 "title": "Example usage:",
16446 "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",
16450 "name": "updateMail_Queue_Reports",
16451 "group": "Mail_Queue_Reports",
16452 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16453 "version": "0.0.0",
16454 "filename": "server/api/mailQueueReport/index.js",
16455 "groupTitle": "Mail_Queue_Reports"
16459 "url": "/api/mail/queues/{id}/users",
16460 "title": "Add agents to a queue",
16463 "title": "Example usage:",
16464 "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",
16468 "name": "AddAgents",
16469 "group": "Mail_Queues",
16470 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16471 "version": "0.0.0",
16472 "filename": "server/api/mailQueue/index.js",
16473 "groupTitle": "Mail_Queues"
16477 "url": "/api/mail/queues/{id}/teams",
16478 "title": "Add teams to a queue",
16481 "title": "Example usage:",
16482 "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",
16486 "name": "AddTeams",
16487 "group": "Mail_Queues",
16488 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16489 "version": "0.0.0",
16490 "filename": "server/api/mailQueue/index.js",
16491 "groupTitle": "Mail_Queues"
16495 "url": "/api/mail/queues",
16496 "title": "Creates a new Queue",
16499 "title": "Example usage:",
16500 "content": "curl https://{domain}/api/mail/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
16504 "name": "CreateQueues",
16505 "group": "Mail_Queues",
16520 "field": "description",
16527 "field": "timeout",
16539 "field": "strategy",
16545 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16546 "version": "0.0.0",
16547 "filename": "server/api/mailQueue/index.js",
16548 "groupTitle": "Mail_Queues"
16552 "url": "/api/mail/queues/{id}",
16553 "title": "Deletes a Queue",
16556 "title": "Example usage:",
16557 "content": "curl https://{domain}/api/mail/queues/{id} -v -u {name}:{password} -X DELETE",
16561 "name": "DeleteQueues",
16562 "group": "Mail_Queues",
16563 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16564 "version": "0.0.0",
16565 "filename": "server/api/mailQueue/index.js",
16566 "groupTitle": "Mail_Queues"
16570 "url": "/api/mail/queues/describe",
16571 "title": "Gets table info about Queues",
16574 "title": "Example usage:",
16575 "content": "curl https://{domain}/api/mail/queues/describe -v -u {name}:{password}",
16579 "name": "DescribeQueues",
16580 "group": "Mail_Queues",
16581 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16582 "version": "0.0.0",
16583 "filename": "server/api/mailQueue/index.js",
16584 "groupTitle": "Mail_Queues"
16588 "url": "/api/mail/queues/{id}/users",
16589 "title": "Gets queue agents",
16592 "title": "Example usage:",
16593 "content": "curl https://{domain}/api/mail/queues/{id}/users -v -u {name}:{password} -X POST",
16597 "name": "GetAgents",
16598 "group": "Mail_Queues",
16599 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16600 "version": "0.0.0",
16601 "filename": "server/api/mailQueue/index.js",
16602 "groupTitle": "Mail_Queues"
16606 "url": "/api/mail/queues/{id}/members",
16607 "title": "GetMembers",
16610 "title": "Example usage:",
16611 "content": "curl https://{domain}/api/mail/queues/{id}/members -v -u {name}:{password}",
16615 "name": "GetMembers",
16616 "group": "Mail_Queues",
16617 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16618 "version": "0.0.0",
16619 "filename": "server/api/mailQueue/index.js",
16620 "groupTitle": "Mail_Queues"
16624 "url": "/api/mail/queues",
16625 "title": "Gets a list of Queues",
16628 "title": "Example usage:",
16629 "content": "curl https://{domain}/api/mail/queues -v -u {name}:{password}",
16633 "name": "GetQueues",
16634 "group": "Mail_Queues",
16635 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
16636 "version": "0.0.0",
16637 "filename": "server/api/mailQueue/index.js",
16638 "groupTitle": "Mail_Queues"
16642 "url": "/api/mail/queues/{id}/teams",
16643 "title": "Gets queues list",
16646 "title": "Example usage:",
16647 "content": "curl https://{domain}/api/mail/queues/{id}/teams -v -u {name}:{password}",
16651 "name": "GetTeams",
16652 "group": "Mail_Queues",
16653 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16654 "version": "0.0.0",
16655 "filename": "server/api/mailQueue/index.js",
16656 "groupTitle": "Mail_Queues"
16660 "url": "/api/mail/queues/{id}/users",
16661 "title": "Removes agents from a queue",
16664 "title": "Example usage:",
16665 "content": "curl https://{domain}/api/mail/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
16669 "name": "RemoveAgents",
16670 "group": "Mail_Queues",
16671 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16672 "version": "0.0.0",
16673 "filename": "server/api/mailQueue/index.js",
16674 "groupTitle": "Mail_Queues"
16678 "url": "/api/mail/queues/{id}",
16679 "title": "Gets a single Queue",
16682 "title": "Example usage:",
16683 "content": "curl https://{domain}/api/mail/queues/{id} -v -u {name}:{password}",
16687 "name": "ShowQueues",
16688 "group": "Mail_Queues",
16689 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16690 "version": "0.0.0",
16691 "filename": "server/api/mailQueue/index.js",
16692 "groupTitle": "Mail_Queues"
16696 "url": "/api/mail/queues/{id}",
16697 "title": "Update an existing Queue",
16700 "title": "Example usage:",
16701 "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",
16705 "name": "updateQueues",
16706 "group": "Mail_Queues",
16707 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16708 "version": "0.0.0",
16709 "filename": "server/api/mailQueue/index.js",
16710 "groupTitle": "Mail_Queues"
16714 "url": "/api/mail/out_servers",
16715 "title": "Creates a new SMTP",
16718 "title": "Example usage:",
16719 "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",
16723 "name": "CreateSMTPs",
16724 "group": "Mail_SMTP",
16732 "field": "description",
16774 "field": "service",
16781 "field": "authentication",
16787 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16788 "version": "0.0.0",
16789 "filename": "server/api/mailServerOut/index.js",
16790 "groupTitle": "Mail_SMTP"
16794 "url": "/api/mail/out_servers/{id}",
16795 "title": "Deletes a SMTP",
16798 "title": "Example usage:",
16799 "content": "curl https://{domain}/api/mail/out_servers/{id} -v -u {name}:{password} -X DELETE",
16803 "name": "DeleteSMTPs",
16804 "group": "Mail_SMTP",
16805 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16806 "version": "0.0.0",
16807 "filename": "server/api/mailServerOut/index.js",
16808 "groupTitle": "Mail_SMTP"
16812 "url": "/api/mail/out_servers",
16813 "title": "Gets a list of SMTPs",
16816 "title": "Example usage:",
16817 "content": "curl https://{domain}/api/mail/out_servers -v -u {name}:{password}",
16821 "name": "GetSMTPs",
16822 "group": "Mail_SMTP",
16823 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
16824 "version": "0.0.0",
16825 "filename": "server/api/mailServerOut/index.js",
16826 "groupTitle": "Mail_SMTP"
16830 "url": "/api/mail/out_servers/{id}",
16831 "title": "Gets a single SMTP",
16834 "title": "Example usage:",
16835 "content": "curl https://{domain}/api/mail/out_servers/{id} -v -u {name}:{password}",
16839 "name": "ShowSMTPs",
16840 "group": "Mail_SMTP",
16841 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16842 "version": "0.0.0",
16843 "filename": "server/api/mailServerOut/index.js",
16844 "groupTitle": "Mail_SMTP"
16848 "url": "/api/mail/out_servers/{id}",
16849 "title": "Update an existing SMTP",
16852 "title": "Example usage:",
16853 "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",
16857 "name": "updateSMTPs",
16858 "group": "Mail_SMTP",
16859 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16860 "version": "0.0.0",
16861 "filename": "server/api/mailServerOut/index.js",
16862 "groupTitle": "Mail_SMTP"
16866 "url": "/api/mail/substatuses",
16867 "title": "Creates a new Queue",
16870 "title": "Example usage:",
16871 "content": "curl https://{domain}/api/mail/substatuses -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
16875 "name": "CreateSubstatuses",
16876 "group": "Mail_Substatuses",
16891 "field": "description",
16897 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16898 "version": "0.0.0",
16899 "filename": "server/api/mailSubstatus/index.js",
16900 "groupTitle": "Mail_Substatuses"
16904 "url": "/api/mail/substatuses/{id}",
16905 "title": "Deletes a Queue",
16908 "title": "Example usage:",
16909 "content": "curl https://{domain}/api/mail/substatuses/{id} -v -u {name}:{password} -X DELETE",
16913 "name": "DeleteSubstatuses",
16914 "group": "Mail_Substatuses",
16915 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16916 "version": "0.0.0",
16917 "filename": "server/api/mailSubstatus/index.js",
16918 "groupTitle": "Mail_Substatuses"
16922 "url": "/api/mail/substatuses/describe",
16923 "title": "Gets table info about Substatuses",
16926 "title": "Example usage:",
16927 "content": "curl https://{domain}/api/mail/substatuses/describe -v -u {name}:{password}",
16931 "name": "DescribeSubstatuses",
16932 "group": "Mail_Substatuses",
16933 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16934 "version": "0.0.0",
16935 "filename": "server/api/mailSubstatus/index.js",
16936 "groupTitle": "Mail_Substatuses"
16940 "url": "/api/mail/substatuses",
16941 "title": "Gets a list of Substatuses",
16944 "title": "Example usage:",
16945 "content": "curl https://{domain}/api/mail/substatuses -v -u {name}:{password}",
16949 "name": "GetSubstatuses",
16950 "group": "Mail_Substatuses",
16951 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
16952 "version": "0.0.0",
16953 "filename": "server/api/mailSubstatus/index.js",
16954 "groupTitle": "Mail_Substatuses"
16958 "url": "/api/mail/substatuses/{id}",
16959 "title": "Gets a single Queue",
16962 "title": "Example usage:",
16963 "content": "curl https://{domain}/api/mail/substatuses/{id} -v -u {name}:{password}",
16967 "name": "ShowSubstatuses",
16968 "group": "Mail_Substatuses",
16969 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16970 "version": "0.0.0",
16971 "filename": "server/api/mailSubstatus/index.js",
16972 "groupTitle": "Mail_Substatuses"
16976 "url": "/api/mail/substatuses/{id}",
16977 "title": "Update an existing Queue",
16980 "title": "Example usage:",
16981 "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",
16985 "name": "updateSubstatuses",
16986 "group": "Mail_Substatuses",
16987 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16988 "version": "0.0.0",
16989 "filename": "server/api/mailSubstatus/index.js",
16990 "groupTitle": "Mail_Substatuses"
16994 "url": "/api/mail/reports/transfer",
16995 "title": "Creates a new Mail Transfer Report",
16998 "title": "Example usage:",
16999 "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",
17003 "name": "CreateMail_Transfer_Reports",
17004 "group": "Mail_Transfer_Reports",
17012 "field": "uniqueid",
17031 "field": "transferredAt",
17037 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17038 "version": "0.0.0",
17039 "filename": "server/api/mailTransferReport/index.js",
17040 "groupTitle": "Mail_Transfer_Reports"
17044 "url": "/api/mail/reports/transfer/{id}",
17045 "title": "Deletes a Mail Transfer Report",
17048 "title": "Example usage:",
17049 "content": "curl https://{domain}/api/mail/reports/transfer/{id} -v -u {name}:{password} -X DELETE",
17053 "name": "DeleteMail_Transfer_Reports",
17054 "group": "Mail_Transfer_Reports",
17055 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17056 "version": "0.0.0",
17057 "filename": "server/api/mailTransferReport/index.js",
17058 "groupTitle": "Mail_Transfer_Reports"
17062 "url": "/api/mail/reports/transfer/describe",
17063 "title": "Gets table info about Mail Transfer Reports",
17066 "title": "Example usage:",
17067 "content": "curl https://{domain}/api/mail/reports/transfer/describe -v -u {name}:{password}",
17071 "name": "DescribeMail_Transfer_Reports",
17072 "group": "Mail_Transfer_Reports",
17073 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17074 "version": "0.0.0",
17075 "filename": "server/api/mailTransferReport/index.js",
17076 "groupTitle": "Mail_Transfer_Reports"
17080 "url": "/api/mail/reports/transfer",
17081 "title": "Gets a list of Mail Transfer Reports",
17084 "title": "Example usage:",
17085 "content": "curl https://{domain}/api/mail/reports/transfer -v -u {name}:{password}",
17089 "name": "GetMail_Transfer_Reports",
17090 "group": "Mail_Transfer_Reports",
17091 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
17092 "version": "0.0.0",
17093 "filename": "server/api/mailTransferReport/index.js",
17094 "groupTitle": "Mail_Transfer_Reports"
17098 "url": "/api/mail/reports/transfer/{id}",
17099 "title": "Gets a single Mail Transfer Report",
17102 "title": "Example usage:",
17103 "content": "curl https://{domain}/api/mail/reports/transfer/{id} -v -u {name}:{password}",
17107 "name": "ShowMail_Transfer_Reports",
17108 "group": "Mail_Transfer_Reports",
17109 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17110 "version": "0.0.0",
17111 "filename": "server/api/mailTransferReport/index.js",
17112 "groupTitle": "Mail_Transfer_Reports"
17116 "url": "/api/mail/reports/transfer/{id}",
17117 "title": "Update an existing Mail Transfer Report",
17120 "title": "Example usage:",
17121 "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",
17125 "name": "updateMail_Transfer_Reports",
17126 "group": "Mail_Transfer_Reports",
17127 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17128 "version": "0.0.0",
17129 "filename": "server/api/mailTransferReport/index.js",
17130 "groupTitle": "Mail_Transfer_Reports"
17134 "url": "/api/members/reports/describe",
17135 "title": "Gets table info about Member Reports",
17138 "title": "Example usage:",
17139 "content": "curl https://{domain}/api/members/reports/describe -v -u {name}:{password}",
17143 "name": "DescribeMember_Reports",
17144 "group": "Member_Reports",
17145 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17146 "version": "0.0.0",
17147 "filename": "server/api/memberReport/index.js",
17148 "groupTitle": "Member_Reports"
17152 "url": "/api/members/reports",
17153 "title": "Gets a list of Member Reports",
17156 "title": "Example usage:",
17157 "content": "curl https://{domain}/api/members/reports -v -u {name}:{password}",
17161 "name": "GetMember_Reports",
17162 "group": "Member_Reports",
17163 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
17164 "version": "0.0.0",
17165 "filename": "server/api/memberReport/index.js",
17166 "groupTitle": "Member_Reports"
17170 "url": "/api/members/reports/{id}",
17171 "title": "Gets a single Member Report",
17174 "title": "Example usage:",
17175 "content": "curl https://{domain}/api/members/reports/{id} -v -u {name}:{password}",
17179 "name": "ShowMember_Reports",
17180 "group": "Member_Reports",
17181 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17182 "version": "0.0.0",
17183 "filename": "server/api/memberReport/index.js",
17184 "groupTitle": "Member_Reports"
17188 "url": "/api/migrations",
17189 "title": "Gets a list of Migrations",
17192 "title": "Example usage:",
17193 "content": "curl https://{domain}/api/migrations -v -u {name}:{password}",
17197 "name": "GetMigrations",
17198 "group": "Migrations",
17199 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
17200 "version": "0.0.0",
17201 "filename": "server/api/migration/index.js",
17202 "groupTitle": "Migrations"
17206 "url": "/api/voice/networks",
17207 "title": "Create a new network",
17210 "title": "Example usage:",
17211 "content": "curl https://{domain}/api/voice/networks -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
17216 "group": "Networks",
17217 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17218 "version": "0.0.0",
17219 "filename": "server/api/network/index.js",
17220 "groupTitle": "Networks"
17224 "url": "/api/voice/networks/{id}",
17225 "title": "Deletes a network",
17228 "title": "Example usage:",
17229 "content": "curl https://{domain}/api/voice/networks/{id} -v -u {name}:{password} -X DELETE",
17234 "group": "Networks",
17235 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17236 "version": "0.0.0",
17237 "filename": "server/api/network/index.js",
17238 "groupTitle": "Networks"
17242 "url": "/api/networks",
17243 "title": "Gets a list of Networks",
17246 "title": "Example usage:",
17247 "content": "curl https://{domain}/api/networks -v -u {name}:{password}",
17251 "name": "GetNetworks",
17252 "group": "Networks",
17253 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
17254 "version": "0.0.0",
17255 "filename": "server/api/network/index.js",
17256 "groupTitle": "Networks"
17260 "url": "/api/networks/{id}",
17261 "title": "Gets a single Network",
17264 "title": "Example usage:",
17265 "content": "curl https://{domain}/api/networks/{id} -v -u {name}:{password}",
17269 "name": "ShowNetworks",
17270 "group": "Networks",
17271 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17272 "version": "0.0.0",
17273 "filename": "server/api/network/index.js",
17274 "groupTitle": "Networks"
17278 "url": "/api/voice/networks/{id}",
17279 "title": "Update an existing network",
17282 "title": "Example usage:",
17283 "content": "curl https://{domain}/api/voice/networks/{id} -v -u {name}:{password} -X PUT",
17288 "group": "Networks",
17289 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17290 "version": "0.0.0",
17291 "filename": "server/api/network/index.js",
17292 "groupTitle": "Networks"
17296 "url": "/api/openchannel/accounts/{id}/users",
17297 "title": "Add agents to a openchannel account",
17300 "title": "Example usage:",
17301 "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",
17305 "name": "AddAgents",
17306 "group": "Openchannel_Accounts",
17307 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17308 "version": "0.0.0",
17309 "filename": "server/api/openchannelAccount/index.js",
17310 "groupTitle": "Openchannel_Accounts"
17314 "url": "/api/openchannel/accounts",
17315 "title": "Creates a new Account",
17318 "title": "Example usage:",
17319 "content": "curl https://{domain}/api/openchannel/accounts -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
17323 "name": "CreateAccounts",
17324 "group": "Openchannel_Accounts",
17339 "field": "description",
17353 "field": "replyUri",
17367 "field": "notificationTemplate",
17374 "field": "notificationSound",
17381 "field": "notificationShake",
17388 "field": "waitForTheAssignedAgent",
17402 "field": "queueTransfer",
17409 "field": "queueTransferTimeout",
17416 "field": "agentTransfer",
17423 "field": "agentTransferTimeout",
17430 "field": "mandatoryDispositionPauseId",
17431 "description": "<p>Status to put when mandatory disposition is enabled</p>"
17437 "field": "mandatoryDisposition",
17438 "description": "<p>Enabled/disables mandatory dispo on a queue</p>"
17443 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17444 "version": "0.0.0",
17445 "filename": "server/api/openchannelAccount/index.js",
17446 "groupTitle": "Openchannel_Accounts"
17450 "url": "/api/openchannel/accounts/{id}",
17451 "title": "Deletes a Account",
17454 "title": "Example usage:",
17455 "content": "curl https://{domain}/api/openchannel/accounts/{id} -v -u {name}:{password} -X DELETE",
17459 "name": "DeleteAccounts",
17460 "group": "Openchannel_Accounts",
17461 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17462 "version": "0.0.0",
17463 "filename": "server/api/openchannelAccount/index.js",
17464 "groupTitle": "Openchannel_Accounts"
17468 "url": "/api/openchannel/accounts/describe",
17469 "title": "Gets table info about Accounts",
17472 "title": "Example usage:",
17473 "content": "curl https://{domain}/api/openchannel/accounts/describe -v -u {name}:{password}",
17477 "name": "DescribeAccounts",
17478 "group": "Openchannel_Accounts",
17479 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17480 "version": "0.0.0",
17481 "filename": "server/api/openchannelAccount/index.js",
17482 "groupTitle": "Openchannel_Accounts"
17486 "url": "/api/openchannel/accounts",
17487 "title": "Gets a list of Accounts",
17490 "title": "Example usage:",
17491 "content": "curl https://{domain}/api/openchannel/accounts -v -u {name}:{password}",
17495 "name": "GetAccounts",
17496 "group": "Openchannel_Accounts",
17497 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
17498 "version": "0.0.0",
17499 "filename": "server/api/openchannelAccount/index.js",
17500 "groupTitle": "Openchannel_Accounts"
17504 "url": "/api/openchannel/accounts/{id}/users",
17505 "title": "Gets agents from openchannel account",
17508 "title": "Example usage:",
17509 "content": "curl https://{domain}/api/openchannel/accounts/{id}/users -v -u {name}:{password} -X GET",
17513 "name": "GetAgents",
17514 "group": "Openchannel_Accounts",
17515 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17516 "version": "0.0.0",
17517 "filename": "server/api/openchannelAccount/index.js",
17518 "groupTitle": "Openchannel_Accounts"
17522 "url": "/api/openchannel/accounts/{id}/users",
17523 "title": "Removes agents from a openchannel account",
17526 "title": "Example usage:",
17527 "content": "curl https://{domain}/api/openchannel/accounts/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
17531 "name": "RemoveAgents",
17532 "group": "Openchannel_Accounts",
17533 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17534 "version": "0.0.0",
17535 "filename": "server/api/openchannelAccount/index.js",
17536 "groupTitle": "Openchannel_Accounts"
17540 "url": "/api/openchannel/accounts/{id}/canned_answers",
17541 "title": "Removes canned answers from account",
17544 "title": "Example usage:",
17545 "content": "curl https://{domain}/api/openchannel/accounts/{id}/canned_answers?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
17549 "name": "RemoveAnswers",
17550 "group": "Openchannel_Accounts",
17551 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17552 "version": "0.0.0",
17553 "filename": "server/api/openchannelAccount/index.js",
17554 "groupTitle": "Openchannel_Accounts"
17558 "url": "/api/openchannel/accounts/{id}/dispositions",
17559 "title": "Removes dispositions from account",
17562 "title": "Example usage:",
17563 "content": "curl https://{domain}/api/openchannel/accounts/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
17567 "name": "RemoveDispositions",
17568 "group": "Openchannel_Accounts",
17569 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17570 "version": "0.0.0",
17571 "filename": "server/api/openchannelAccount/index.js",
17572 "groupTitle": "Openchannel_Accounts"
17576 "url": "/api/openchannel/accounts/{id}",
17577 "title": "Gets a single Account",
17580 "title": "Example usage:",
17581 "content": "curl https://{domain}/api/openchannel/accounts/{id} -v -u {name}:{password}",
17585 "name": "ShowAccounts",
17586 "group": "Openchannel_Accounts",
17587 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17588 "version": "0.0.0",
17589 "filename": "server/api/openchannelAccount/index.js",
17590 "groupTitle": "Openchannel_Accounts"
17594 "url": "/api/openchannel/accounts/{id}/canned_answers",
17595 "title": "Creates new canned answer",
17598 "title": "Example usage:",
17599 "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",
17603 "name": "addAnswer",
17604 "group": "Openchannel_Accounts",
17626 "field": "description",
17639 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17640 "version": "0.0.0",
17641 "filename": "server/api/openchannelAccount/index.js",
17642 "groupTitle": "Openchannel_Accounts"
17646 "url": "/api/openchannel/accounts/{id}/applications",
17647 "title": "Creates new applications",
17650 "title": "Example usage:",
17651 "content": "curl https://{domain}/api/openchannel/accounts/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
17655 "name": "addApplications",
17656 "group": "Openchannel_Accounts",
17664 "field": "priority",
17678 "field": "appdata",
17685 "field": "description",
17692 "field": "interval",
17698 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17699 "version": "0.0.0",
17700 "filename": "server/api/openchannelAccount/index.js",
17701 "groupTitle": "Openchannel_Accounts"
17705 "url": "/api/openchannel/accounts/{id}/dispositions",
17706 "title": "Creates new disposition",
17709 "title": "Example usage:",
17710 "content": "curl https://{domain}/api/openchannel/accounts/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
17714 "name": "addDisposition",
17715 "group": "Openchannel_Accounts",
17742 "field": "description",
17748 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17749 "version": "0.0.0",
17750 "filename": "server/api/openchannelAccount/index.js",
17751 "groupTitle": "Openchannel_Accounts"
17755 "url": "/api/openchannel/accounts/{id}/canned_answers",
17756 "title": "Gets account canned answers",
17759 "title": "Example usage:",
17760 "content": "curl https://{domain}/api/openchannel/accounts/{id}/canned_answers -v -u {name}:{password} -X GET",
17764 "name": "getAnswers",
17765 "group": "Openchannel_Accounts",
17766 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17767 "version": "0.0.0",
17768 "filename": "server/api/openchannelAccount/index.js",
17769 "groupTitle": "Openchannel_Accounts"
17773 "url": "/api/openchannel/accounts/{id}/applications",
17774 "title": "Gets account applications",
17777 "title": "Example usage:",
17778 "content": "curl https://{domain}/api/openchannel/accounts/{id}/applications -v -u {name}:{password} -X GET",
17782 "name": "getApplications",
17783 "group": "Openchannel_Accounts",
17784 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17785 "version": "0.0.0",
17786 "filename": "server/api/openchannelAccount/index.js",
17787 "groupTitle": "Openchannel_Accounts"
17791 "url": "/api/openchannel/accounts/{id}/dispositions",
17792 "title": "Gets account dispositions",
17795 "title": "Example usage:",
17796 "content": "curl https://{domain}/api/openchannel/accounts/{id}/dispositions -v -u {name}:{password} -X GET",
17800 "name": "getDispositions",
17801 "group": "Openchannel_Accounts",
17802 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17803 "version": "0.0.0",
17804 "filename": "server/api/openchannelAccount/index.js",
17805 "groupTitle": "Openchannel_Accounts"
17809 "url": "/api/openchannel/accounts/{id}/interactions",
17810 "title": "Gets Openchannel Account Interactions",
17813 "title": "Example usage:",
17814 "content": "curl https://{domain}/api/openchannel/accounts/{id}/interactions -v -u {name}:{password} -X GET",
17818 "name": "getInteractions",
17819 "group": "Openchannel_Accounts",
17820 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17821 "version": "0.0.0",
17822 "filename": "server/api/openchannelAccount/index.js",
17823 "groupTitle": "Openchannel_Accounts"
17827 "url": "/api/openchannel/accounts/{id}/notify",
17828 "title": "Notify new message",
17831 "title": "Example usage:",
17832 "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",
17837 "group": "Openchannel_Accounts",
17838 "description": "<p>Motion 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>",
17839 "version": "0.0.0",
17840 "filename": "server/api/openchannelAccount/index.js",
17841 "groupTitle": "Openchannel_Accounts"
17845 "url": "/api/openchannel/accounts/{id}/send",
17846 "title": "Send new openchannel message",
17849 "title": "Example usage:",
17850 "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",
17854 "name": "sendOpenchannel",
17855 "group": "Openchannel_Accounts",
17856 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17857 "version": "0.0.0",
17858 "filename": "server/api/openchannelAccount/index.js",
17859 "groupTitle": "Openchannel_Accounts"
17863 "url": "/api/openchannel/accounts/{id}",
17864 "title": "Update an existing Account",
17867 "title": "Example usage:",
17868 "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",
17872 "name": "updateAccounts",
17873 "group": "Openchannel_Accounts",
17874 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17875 "version": "0.0.0",
17876 "filename": "server/api/openchannelAccount/index.js",
17877 "groupTitle": "Openchannel_Accounts"
17881 "url": "/api/openchannel/applications",
17882 "title": "Creates a new Application",
17885 "title": "Example usage:",
17886 "content": "curl https://{domain}/api/openchannel/applications -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
17890 "name": "CreateApplications",
17891 "group": "Openchannel_Applications",
17899 "field": "priority",
17913 "field": "appdata",
17920 "field": "description",
17927 "field": "interval",
17933 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17934 "version": "0.0.0",
17935 "filename": "server/api/openchannelApplication/index.js",
17936 "groupTitle": "Openchannel_Applications"
17940 "url": "/api/openchannel/applications/{id}",
17941 "title": "Deletes a Application",
17944 "title": "Example usage:",
17945 "content": "curl https://{domain}/api/openchannel/applications/{id} -v -u {name}:{password} -X DELETE",
17949 "name": "DeleteApplications",
17950 "group": "Openchannel_Applications",
17951 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17952 "version": "0.0.0",
17953 "filename": "server/api/openchannelApplication/index.js",
17954 "groupTitle": "Openchannel_Applications"
17958 "url": "/api/openchannel/applications",
17959 "title": "Gets a list of Applications",
17962 "title": "Example usage:",
17963 "content": "curl https://{domain}/api/openchannel/applications -v -u {name}:{password}",
17967 "name": "GetApplications",
17968 "group": "Openchannel_Applications",
17969 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
17970 "version": "0.0.0",
17971 "filename": "server/api/openchannelApplication/index.js",
17972 "groupTitle": "Openchannel_Applications"
17976 "url": "/api/openchannel/applications/{id}",
17977 "title": "Gets a single Application",
17980 "title": "Example usage:",
17981 "content": "curl https://{domain}/api/openchannel/applications/{id} -v -u {name}:{password}",
17985 "name": "ShowApplications",
17986 "group": "Openchannel_Applications",
17987 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17988 "version": "0.0.0",
17989 "filename": "server/api/openchannelApplication/index.js",
17990 "groupTitle": "Openchannel_Applications"
17994 "url": "/api/openchannel/applications/{id}",
17995 "title": "Update an existing Application",
17998 "title": "Example usage:",
17999 "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",
18003 "name": "updateApplications",
18004 "group": "Openchannel_Applications",
18005 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18006 "version": "0.0.0",
18007 "filename": "server/api/openchannelApplication/index.js",
18008 "groupTitle": "Openchannel_Applications"
18012 "url": "/api/openchannel/interactions/{id}/tags",
18013 "title": "Add tags to the interaction",
18016 "title": "Example usage:",
18017 "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",
18022 "group": "Openchannel_Interactions",
18023 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18024 "version": "0.0.0",
18025 "filename": "server/api/openchannelInteraction/index.js",
18026 "groupTitle": "Openchannel_Interactions"
18030 "url": "/api/openchannel/interactions",
18031 "title": "Creates a new Interaction",
18034 "title": "Example usage:",
18035 "content": "curl https://{domain}/api/openchannel/interactions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
18039 "name": "CreateInteractions",
18040 "group": "Openchannel_Interactions",
18055 "field": "closedAt",
18062 "field": "disposition",
18069 "field": "secondDisposition",
18076 "field": "thirdDisposition",
18090 "field": "read1stAt",
18097 "field": "threadId",
18104 "field": "externalUrl",
18111 "field": "lastMsgAt",
18122 "field": "lastMsgDirection",
18135 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18136 "version": "0.0.0",
18137 "filename": "server/api/openchannelInteraction/index.js",
18138 "groupTitle": "Openchannel_Interactions"
18142 "url": "/api/openchannel/interactions/{id}",
18143 "title": "Deletes a Interaction",
18146 "title": "Example usage:",
18147 "content": "curl https://{domain}/api/openchannel/interactions/{id} -v -u {name}:{password} -X DELETE",
18151 "name": "DeleteInteractions",
18152 "group": "Openchannel_Interactions",
18153 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18154 "version": "0.0.0",
18155 "filename": "server/api/openchannelInteraction/index.js",
18156 "groupTitle": "Openchannel_Interactions"
18160 "url": "/api/openchannel/interactions/describe",
18161 "title": "Gets table info about Interactions",
18164 "title": "Example usage:",
18165 "content": "curl https://{domain}/api/openchannel/interactions/describe -v -u {name}:{password}",
18169 "name": "DescribeInteractions",
18170 "group": "Openchannel_Interactions",
18171 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18172 "version": "0.0.0",
18173 "filename": "server/api/openchannelInteraction/index.js",
18174 "groupTitle": "Openchannel_Interactions"
18178 "url": "/api/openchannel/interactions",
18179 "title": "Gets a list of Interactions",
18182 "title": "Example usage:",
18183 "content": "curl https://{domain}/api/openchannel/interactions -v -u {name}:{password}",
18187 "name": "GetInteractions",
18188 "group": "Openchannel_Interactions",
18189 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
18190 "version": "0.0.0",
18191 "filename": "server/api/openchannelInteraction/index.js",
18192 "groupTitle": "Openchannel_Interactions"
18196 "url": "/api/openchannel/interactions/{id}/tags",
18197 "title": "Removes tags from interaction",
18200 "title": "Example usage:",
18201 "content": "curl https://{domain}/api/openchannel/interactions/{id}/tags?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
18205 "name": "RemoveTags",
18206 "group": "Openchannel_Interactions",
18207 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18208 "version": "0.0.0",
18209 "filename": "server/api/openchannelInteraction/index.js",
18210 "groupTitle": "Openchannel_Interactions"
18214 "url": "/api/openchannel/interactions/{id}",
18215 "title": "Gets a single Interaction",
18218 "title": "Example usage:",
18219 "content": "curl https://{domain}/api/openchannel/interactions/{id} -v -u {name}:{password}",
18223 "name": "ShowInteractions",
18224 "group": "Openchannel_Interactions",
18225 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18226 "version": "0.0.0",
18227 "filename": "server/api/openchannelInteraction/index.js",
18228 "groupTitle": "Openchannel_Interactions"
18232 "url": "/api/openchannel/interactions/{id}/messages",
18233 "title": "Creates new messages",
18236 "title": "Example usage:",
18237 "content": "curl https://{domain}/api/openchannel/interactions/{id}/messages -d '[{\"to\": \"+3901119886500\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
18241 "name": "addMessage",
18242 "group": "Openchannel_Interactions",
18275 "field": "direction",
18289 "field": "providerName",
18296 "field": "providerResponse",
18302 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18303 "version": "0.0.0",
18304 "filename": "server/api/openchannelInteraction/index.js",
18305 "groupTitle": "Openchannel_Interactions"
18309 "url": "/api/openchannel/interactions/{id}/download",
18310 "title": "Gets interaction",
18313 "title": "Example usage:",
18314 "content": "curl https://{domain}/api/openchannel/interactions/{id}/download -v -u {name}:{password} -X GET",
18318 "name": "download",
18319 "group": "Openchannel_Interactions",
18320 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18321 "version": "0.0.0",
18322 "filename": "server/api/openchannelInteraction/index.js",
18323 "groupTitle": "Openchannel_Interactions"
18327 "url": "/api/openchannel/interactions/{id}/messages",
18328 "title": "Gets interaction messages",
18331 "title": "Example usage:",
18332 "content": "curl https://{domain}/api/openchannel/interactions/{id}/messages -v -u {name}:{password} -X GET",
18336 "name": "getMessages",
18337 "group": "Openchannel_Interactions",
18338 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18339 "version": "0.0.0",
18340 "filename": "server/api/openchannelInteraction/index.js",
18341 "groupTitle": "Openchannel_Interactions"
18345 "url": "/api/openchannel/interactions/{id}",
18346 "title": "Update an existing Interaction",
18349 "title": "Example usage:",
18350 "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",
18354 "name": "updateInteractions",
18355 "group": "Openchannel_Interactions",
18356 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18357 "version": "0.0.0",
18358 "filename": "server/api/openchannelInteraction/index.js",
18359 "groupTitle": "Openchannel_Interactions"
18363 "url": "/api/openchannel/messages",
18364 "title": "Creates a new Message",
18367 "title": "Example usage:",
18368 "content": "curl https://{domain}/api/openchannel/messages -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
18372 "name": "CreateMessages",
18373 "group": "Openchannel_Messages",
18406 "field": "direction",
18420 "field": "providerName",
18427 "field": "providerResponse",
18433 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18434 "version": "0.0.0",
18435 "filename": "server/api/openchannelMessage/index.js",
18436 "groupTitle": "Openchannel_Messages"
18440 "url": "/api/openchannel/messages/{id}",
18441 "title": "Deletes a Message",
18444 "title": "Example usage:",
18445 "content": "curl https://{domain}/api/openchannel/messages/{id} -v -u {name}:{password} -X DELETE",
18449 "name": "DeleteMessages",
18450 "group": "Openchannel_Messages",
18451 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18452 "version": "0.0.0",
18453 "filename": "server/api/openchannelMessage/index.js",
18454 "groupTitle": "Openchannel_Messages"
18458 "url": "/api/openchannel/messages/describe",
18459 "title": "Gets table info about Messages",
18462 "title": "Example usage:",
18463 "content": "curl https://{domain}/api/openchannel/messages/describe -v -u {name}:{password}",
18467 "name": "DescribeMessages",
18468 "group": "Openchannel_Messages",
18469 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18470 "version": "0.0.0",
18471 "filename": "server/api/openchannelMessage/index.js",
18472 "groupTitle": "Openchannel_Messages"
18476 "url": "/api/openchannel/messages",
18477 "title": "Gets a list of Messages",
18480 "title": "Example usage:",
18481 "content": "curl https://{domain}/api/openchannel/messages -v -u {name}:{password}",
18485 "name": "GetMessages",
18486 "group": "Openchannel_Messages",
18487 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
18488 "version": "0.0.0",
18489 "filename": "server/api/openchannelMessage/index.js",
18490 "groupTitle": "Openchannel_Messages"
18494 "url": "/api/openchannel/messages/{id}",
18495 "title": "Gets a single Message",
18498 "title": "Example usage:",
18499 "content": "curl https://{domain}/api/openchannel/messages/{id} -v -u {name}:{password}",
18503 "name": "ShowMessages",
18504 "group": "Openchannel_Messages",
18505 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18506 "version": "0.0.0",
18507 "filename": "server/api/openchannelMessage/index.js",
18508 "groupTitle": "Openchannel_Messages"
18512 "url": "/api/openchannel/messages/{id}/accept",
18513 "title": "Accepts message",
18516 "title": "Example usage:",
18517 "content": "curl https://{domain}/api/openchannel/messages/{id}/accept \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
18521 "name": "acceptMessage",
18522 "group": "Openchannel_Messages",
18523 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18524 "version": "0.0.0",
18525 "filename": "server/api/openchannelMessage/index.js",
18526 "groupTitle": "Openchannel_Messages"
18530 "url": "/api/openchannel/messages/{id}/reject",
18531 "title": "Rejects message",
18534 "title": "Example usage:",
18535 "content": "curl https://{domain}/api/openchannel/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
18539 "name": "rejectMessage",
18540 "group": "Openchannel_Messages",
18541 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18542 "version": "0.0.0",
18543 "filename": "server/api/openchannelMessage/index.js",
18544 "groupTitle": "Openchannel_Messages"
18548 "url": "/api/openchannel/messages/{id}",
18549 "title": "Update an existing Message",
18552 "title": "Example usage:",
18553 "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",
18557 "name": "updateMessages",
18558 "group": "Openchannel_Messages",
18559 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18560 "version": "0.0.0",
18561 "filename": "server/api/openchannelMessage/index.js",
18562 "groupTitle": "Openchannel_Messages"
18566 "url": "/api/openchannel/reports/queue",
18567 "title": "Creates a new Openchannel Queue Report",
18570 "title": "Example usage:",
18571 "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",
18575 "name": "CreateOpenchannel_Queue_Reports",
18576 "group": "Openchannel_Queue_Reports",
18584 "field": "uniqueid",
18605 "field": "leaveAt",
18612 "field": "acceptAt",
18632 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18633 "version": "0.0.0",
18634 "filename": "server/api/openchannelQueueReport/index.js",
18635 "groupTitle": "Openchannel_Queue_Reports"
18639 "url": "/api/openchannel/reports/queue/{id}",
18640 "title": "Deletes a Openchannel Queue Report",
18643 "title": "Example usage:",
18644 "content": "curl https://{domain}/api/openchannel/reports/queue/{id} -v -u {name}:{password} -X DELETE",
18648 "name": "DeleteOpenchannel_Queue_Reports",
18649 "group": "Openchannel_Queue_Reports",
18650 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18651 "version": "0.0.0",
18652 "filename": "server/api/openchannelQueueReport/index.js",
18653 "groupTitle": "Openchannel_Queue_Reports"
18657 "url": "/api/openchannel/reports/queue/describe",
18658 "title": "Gets table info about Openchannel Queue Reports",
18661 "title": "Example usage:",
18662 "content": "curl https://{domain}/api/openchannel/reports/queue/describe -v -u {name}:{password}",
18666 "name": "DescribeOpenchannel_Queue_Reports",
18667 "group": "Openchannel_Queue_Reports",
18668 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18669 "version": "0.0.0",
18670 "filename": "server/api/openchannelQueueReport/index.js",
18671 "groupTitle": "Openchannel_Queue_Reports"
18675 "url": "/api/openchannel/reports/queue",
18676 "title": "Gets a list of Openchannel Queue Reports",
18679 "title": "Example usage:",
18680 "content": "curl https://{domain}/api/openchannel/reports/queue -v -u {name}:{password}",
18684 "name": "GetOpenchannel_Queue_Reports",
18685 "group": "Openchannel_Queue_Reports",
18686 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
18687 "version": "0.0.0",
18688 "filename": "server/api/openchannelQueueReport/index.js",
18689 "groupTitle": "Openchannel_Queue_Reports"
18693 "url": "/api/openchannel/reports/queue/{id}",
18694 "title": "Gets a single Openchannel Queue Report",
18697 "title": "Example usage:",
18698 "content": "curl https://{domain}/api/openchannel/reports/queue/{id} -v -u {name}:{password}",
18702 "name": "ShowOpenchannel_Queue_Reports",
18703 "group": "Openchannel_Queue_Reports",
18704 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18705 "version": "0.0.0",
18706 "filename": "server/api/openchannelQueueReport/index.js",
18707 "groupTitle": "Openchannel_Queue_Reports"
18711 "url": "/api/openchannel/reports/queue/{id}",
18712 "title": "Update an existing Openchannel Queue Report",
18715 "title": "Example usage:",
18716 "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",
18720 "name": "updateOpenchannel_Queue_Reports",
18721 "group": "Openchannel_Queue_Reports",
18722 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18723 "version": "0.0.0",
18724 "filename": "server/api/openchannelQueueReport/index.js",
18725 "groupTitle": "Openchannel_Queue_Reports"
18729 "url": "/api/openchannel/queues/{id}/users",
18730 "title": "Add agents to a queue",
18733 "title": "Example usage:",
18734 "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",
18738 "name": "AddAgents",
18739 "group": "Openchannel_Queues",
18740 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18741 "version": "0.0.0",
18742 "filename": "server/api/openchannelQueue/index.js",
18743 "groupTitle": "Openchannel_Queues"
18747 "url": "/api/openchannel/queues/{id}/teams",
18748 "title": "Add teams to a queue",
18751 "title": "Example usage:",
18752 "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",
18756 "name": "AddTeams",
18757 "group": "Openchannel_Queues",
18758 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18759 "version": "0.0.0",
18760 "filename": "server/api/openchannelQueue/index.js",
18761 "groupTitle": "Openchannel_Queues"
18765 "url": "/api/openchannel/queues",
18766 "title": "Creates a new Queue",
18769 "title": "Example usage:",
18770 "content": "curl https://{domain}/api/openchannel/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
18774 "name": "CreateQueues",
18775 "group": "Openchannel_Queues",
18790 "field": "description",
18797 "field": "timeout",
18809 "field": "strategy",
18815 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18816 "version": "0.0.0",
18817 "filename": "server/api/openchannelQueue/index.js",
18818 "groupTitle": "Openchannel_Queues"
18822 "url": "/api/openchannel/queues/{id}",
18823 "title": "Deletes a Queue",
18826 "title": "Example usage:",
18827 "content": "curl https://{domain}/api/openchannel/queues/{id} -v -u {name}:{password} -X DELETE",
18831 "name": "DeleteQueues",
18832 "group": "Openchannel_Queues",
18833 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18834 "version": "0.0.0",
18835 "filename": "server/api/openchannelQueue/index.js",
18836 "groupTitle": "Openchannel_Queues"
18840 "url": "/api/openchannel/queues/describe",
18841 "title": "Gets table info about Queues",
18844 "title": "Example usage:",
18845 "content": "curl https://{domain}/api/openchannel/queues/describe -v -u {name}:{password}",
18849 "name": "DescribeQueues",
18850 "group": "Openchannel_Queues",
18851 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18852 "version": "0.0.0",
18853 "filename": "server/api/openchannelQueue/index.js",
18854 "groupTitle": "Openchannel_Queues"
18858 "url": "/api/openchannel/queues/{id}/users",
18859 "title": "Gets queue agents",
18862 "title": "Example usage:",
18863 "content": "curl https://{domain}/api/openchannel/queues/{id}/users -v -u {name}:{password} -X POST",
18867 "name": "GetAgents",
18868 "group": "Openchannel_Queues",
18869 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18870 "version": "0.0.0",
18871 "filename": "server/api/openchannelQueue/index.js",
18872 "groupTitle": "Openchannel_Queues"
18876 "url": "/api/openchannel/queues/{id}/members",
18877 "title": "GetMembers",
18880 "title": "Example usage:",
18881 "content": "curl https://{domain}/api/openchannel/queues/{id}/members -v -u {name}:{password}",
18885 "name": "GetMembers",
18886 "group": "Openchannel_Queues",
18887 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18888 "version": "0.0.0",
18889 "filename": "server/api/openchannelQueue/index.js",
18890 "groupTitle": "Openchannel_Queues"
18894 "url": "/api/openchannel/queues",
18895 "title": "Gets a list of Queues",
18898 "title": "Example usage:",
18899 "content": "curl https://{domain}/api/openchannel/queues -v -u {name}:{password}",
18903 "name": "GetQueues",
18904 "group": "Openchannel_Queues",
18905 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
18906 "version": "0.0.0",
18907 "filename": "server/api/openchannelQueue/index.js",
18908 "groupTitle": "Openchannel_Queues"
18912 "url": "/api/openchannel/queues/{id}/teams",
18913 "title": "Gets queues list",
18916 "title": "Example usage:",
18917 "content": "curl https://{domain}/api/openchannel/queues/{id}/teams -v -u {name}:{password}",
18921 "name": "GetTeams",
18922 "group": "Openchannel_Queues",
18923 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18924 "version": "0.0.0",
18925 "filename": "server/api/openchannelQueue/index.js",
18926 "groupTitle": "Openchannel_Queues"
18930 "url": "/api/openchannel/queues/{id}/users",
18931 "title": "Removes agents from a queue",
18934 "title": "Example usage:",
18935 "content": "curl https://{domain}/api/openchannel/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
18939 "name": "RemoveAgents",
18940 "group": "Openchannel_Queues",
18941 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18942 "version": "0.0.0",
18943 "filename": "server/api/openchannelQueue/index.js",
18944 "groupTitle": "Openchannel_Queues"
18948 "url": "/api/openchannel/queues/{id}",
18949 "title": "Gets a single Queue",
18952 "title": "Example usage:",
18953 "content": "curl https://{domain}/api/openchannel/queues/{id} -v -u {name}:{password}",
18957 "name": "ShowQueues",
18958 "group": "Openchannel_Queues",
18959 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18960 "version": "0.0.0",
18961 "filename": "server/api/openchannelQueue/index.js",
18962 "groupTitle": "Openchannel_Queues"
18966 "url": "/api/openchannel/queues/{id}",
18967 "title": "Update an existing Queue",
18970 "title": "Example usage:",
18971 "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",
18975 "name": "updateQueues",
18976 "group": "Openchannel_Queues",
18977 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18978 "version": "0.0.0",
18979 "filename": "server/api/openchannelQueue/index.js",
18980 "groupTitle": "Openchannel_Queues"
18984 "url": "/api/openchannel/reports/transfer",
18985 "title": "Creates a new Openchannel Transfer Report",
18988 "title": "Example usage:",
18989 "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",
18993 "name": "CreateOpenchannel_Transfer_Reports",
18994 "group": "Openchannel_Transfer_Reports",
19002 "field": "uniqueid",
19021 "field": "transferredAt",
19027 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19028 "version": "0.0.0",
19029 "filename": "server/api/openchannelTransferReport/index.js",
19030 "groupTitle": "Openchannel_Transfer_Reports"
19034 "url": "/api/openchannel/reports/transfer/{id}",
19035 "title": "Deletes a Openchannel Transfer Report",
19038 "title": "Example usage:",
19039 "content": "curl https://{domain}/api/openchannel/reports/transfer/{id} -v -u {name}:{password} -X DELETE",
19043 "name": "DeleteOpenchannel_Transfer_Reports",
19044 "group": "Openchannel_Transfer_Reports",
19045 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19046 "version": "0.0.0",
19047 "filename": "server/api/openchannelTransferReport/index.js",
19048 "groupTitle": "Openchannel_Transfer_Reports"
19052 "url": "/api/openchannel/reports/transfer/describe",
19053 "title": "Gets table info about Openchannel Transfer Reports",
19056 "title": "Example usage:",
19057 "content": "curl https://{domain}/api/openchannel/reports/transfer/describe -v -u {name}:{password}",
19061 "name": "DescribeOpenchannel_Transfer_Reports",
19062 "group": "Openchannel_Transfer_Reports",
19063 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19064 "version": "0.0.0",
19065 "filename": "server/api/openchannelTransferReport/index.js",
19066 "groupTitle": "Openchannel_Transfer_Reports"
19070 "url": "/api/openchannel/reports/transfer",
19071 "title": "Gets a list of Openchannel Transfer Reports",
19074 "title": "Example usage:",
19075 "content": "curl https://{domain}/api/openchannel/reports/transfer -v -u {name}:{password}",
19079 "name": "GetOpenchannel_Transfer_Reports",
19080 "group": "Openchannel_Transfer_Reports",
19081 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
19082 "version": "0.0.0",
19083 "filename": "server/api/openchannelTransferReport/index.js",
19084 "groupTitle": "Openchannel_Transfer_Reports"
19088 "url": "/api/openchannel/reports/transfer/{id}",
19089 "title": "Gets a single Openchannel Transfer Report",
19092 "title": "Example usage:",
19093 "content": "curl https://{domain}/api/openchannel/reports/transfer/{id} -v -u {name}:{password}",
19097 "name": "ShowOpenchannel_Transfer_Reports",
19098 "group": "Openchannel_Transfer_Reports",
19099 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19100 "version": "0.0.0",
19101 "filename": "server/api/openchannelTransferReport/index.js",
19102 "groupTitle": "Openchannel_Transfer_Reports"
19106 "url": "/api/openchannel/reports/transfer/{id}",
19107 "title": "Update an existing Openchannel Transfer Report",
19110 "title": "Example usage:",
19111 "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",
19115 "name": "updateOpenchannel_Transfer_Reports",
19116 "group": "Openchannel_Transfer_Reports",
19117 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19118 "version": "0.0.0",
19119 "filename": "server/api/openchannelTransferReport/index.js",
19120 "groupTitle": "Openchannel_Transfer_Reports"
19124 "url": "/api/pauses",
19125 "title": "Creates a new Pause",
19128 "title": "Example usage:",
19129 "content": "curl https://{domain}/api/pauses -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
19133 "name": "CreatePauses",
19149 "field": "description",
19155 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19156 "version": "0.0.0",
19157 "filename": "server/api/pause/index.js",
19158 "groupTitle": "Pauses"
19162 "url": "/api/pauses/{id}",
19163 "title": "Deletes a Pause",
19166 "title": "Example usage:",
19167 "content": "curl https://{domain}/api/pauses/{id} -v -u {name}:{password} -X DELETE",
19171 "name": "DeletePauses",
19173 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19174 "version": "0.0.0",
19175 "filename": "server/api/pause/index.js",
19176 "groupTitle": "Pauses"
19180 "url": "/api/pauses",
19181 "title": "Gets a list of Pauses",
19184 "title": "Example usage:",
19185 "content": "curl https://{domain}/api/pauses -v -u {name}:{password}",
19189 "name": "GetPauses",
19191 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
19192 "version": "0.0.0",
19193 "filename": "server/api/pause/index.js",
19194 "groupTitle": "Pauses"
19198 "url": "/api/pauses/{id}",
19199 "title": "Gets a single Pause",
19202 "title": "Example usage:",
19203 "content": "curl https://{domain}/api/pauses/{id} -v -u {name}:{password}",
19207 "name": "ShowPauses",
19209 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19210 "version": "0.0.0",
19211 "filename": "server/api/pause/index.js",
19212 "groupTitle": "Pauses"
19216 "url": "/api/pauses/{id}",
19217 "title": "Update an existing Pause",
19220 "title": "Example usage:",
19221 "content": "curl https://{domain}/api/pauses/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
19225 "name": "updatePauses",
19227 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19228 "version": "0.0.0",
19229 "filename": "server/api/pause/index.js",
19230 "groupTitle": "Pauses"
19234 "url": "/api/plugins",
19235 "title": "Gets a list of Plugins",
19238 "title": "Example usage:",
19239 "content": "curl https://{domain}/api/plugins -v -u {name}:{password}",
19243 "name": "GetPlugins",
19244 "group": "Plugins",
19245 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
19246 "version": "0.0.0",
19247 "filename": "server/api/plugin/index.js",
19248 "groupTitle": "Plugins"
19252 "url": "/api/plugins/{id}",
19253 "title": "Gets a single Plugin",
19256 "title": "Example usage:",
19257 "content": "curl https://{domain}/api/plugins/{id} -v -u {name}:{password}",
19261 "name": "ShowPlugins",
19262 "group": "Plugins",
19263 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19264 "version": "0.0.0",
19265 "filename": "server/api/plugin/index.js",
19266 "groupTitle": "Plugins"
19270 "url": "/api/plugins/{id}",
19271 "title": "Delete a plugin",
19274 "title": "Example usage:",
19275 "content": "curl https://{domain}/api/plugins/{id} -v -u {name}:{password} -X DELETE",
19279 "name": "destroyPlugin",
19280 "group": "Plugins",
19281 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19282 "version": "0.0.0",
19283 "filename": "server/api/plugin/index.js",
19284 "groupTitle": "Plugins"
19288 "url": "/api/plugins/{id}/download",
19289 "title": "Download plugin source code",
19292 "title": "Example usage:",
19293 "content": "curl https://{domain}/api/plugins/{id}/download -v -u {name}:{password} -X GET",
19297 "name": "download",
19298 "group": "Plugins",
19299 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19300 "version": "0.0.0",
19301 "filename": "server/api/plugin/index.js",
19302 "groupTitle": "Plugins"
19306 "url": "/api/plugins/{id}",
19307 "title": "Update an existing plugin",
19310 "title": "Example usage:",
19311 "content": "curl https://{domain}/api/plugins/{id} -v -u {name}:{password} -X PUT",
19315 "name": "updatePlugin",
19316 "group": "Plugins",
19317 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19318 "version": "0.0.0",
19319 "filename": "server/api/plugin/index.js",
19320 "groupTitle": "Plugins"
19324 "url": "/api/plugins",
19325 "title": "Upload new plugin",
19328 "title": "Example usage:",
19329 "content": "curl https://{domain}/api/plugins -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
19333 "name": "uploadPlugin",
19334 "group": "Plugins",
19335 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19336 "version": "0.0.0",
19337 "filename": "server/api/plugin/index.js",
19338 "groupTitle": "Plugins"
19342 "url": "/api/plugins/webhook?hostname={host}&port={port}&encoding={encoding}&json={json}&path={path}",
19343 "title": "Redirect a plugin request to the specified path",
19346 "title": "Example usage:",
19347 "content": "curl https://{domain}/api/plugins/webhook?port={port}&path={path} -v -u {name}:{password} -X GET",
19351 "name": "webhookPlugin",
19352 "group": "Plugins",
19353 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19354 "version": "0.0.0",
19355 "filename": "server/api/plugin/index.js",
19356 "groupTitle": "Plugins"
19360 "url": "/api/plugins/webhook?hostname={host}&port={port}&encoding={encoding}&json={json}&path={path}",
19361 "title": "Redirect a plugin request to the specified path",
19364 "title": "Example usage:",
19365 "content": "curl https://{domain}/api/plugins/webhook?port={port}&path={path} -H 'Content-Type: application/json' -X POST",
19369 "name": "webhookPlugin",
19370 "group": "Plugins",
19371 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19372 "version": "0.0.0",
19373 "filename": "server/api/plugin/index.js",
19374 "groupTitle": "Plugins"
19378 "url": "/api/pm2/{id}",
19379 "title": "Deletes an existing process",
19382 "title": "Example usage:",
19383 "content": "curl https://{domain}/api/pm2/{id} -v -u {name}:{password} -X DELETE",
19387 "name": "DeletePm2Process",
19389 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19390 "version": "0.0.0",
19391 "filename": "server/api/pm2/index.js",
19392 "groupTitle": "Pm2"
19396 "url": "/api/pm2/{id}",
19397 "title": "Gets a single pm2 process",
19400 "title": "Example usage:",
19401 "content": "curl https://{domain}/api/pm2/{id} -v -u {name}:{password}",
19405 "name": "GetPm2Process",
19407 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19408 "version": "0.0.0",
19409 "filename": "server/api/pm2/index.js",
19410 "groupTitle": "Pm2"
19415 "title": "Gets pm2 processes",
19418 "title": "Example usage:",
19419 "content": "curl https://{domain}/api/pm2 -v -u {name}:{password}",
19423 "name": "GetPm2Processes",
19425 "description": "<p>Motion returns the pm2 processes list.</p>",
19426 "version": "0.0.0",
19427 "filename": "server/api/pm2/index.js",
19428 "groupTitle": "Pm2"
19433 "title": "Start a single pm2 process",
19436 "title": "Example usage:",
19437 "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",
19441 "name": "StartPm2Process",
19463 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19464 "version": "0.0.0",
19465 "filename": "server/api/pm2/index.js",
19466 "groupTitle": "Pm2"
19470 "url": "/api/pm2/{id}",
19471 "title": "Update an existing process",
19474 "title": "Example usage:",
19475 "content": "curl https://{domain}/api/pm2/{id} -d '{\"status\": \"online\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
19479 "name": "UpdatePm2Process",
19481 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19482 "version": "0.0.0",
19483 "filename": "server/api/pm2/index.js",
19484 "groupTitle": "Pm2"
19488 "url": "/api/rpc/campaigns/",
19489 "title": "Gets a list of campaigns",
19492 "title": "Example usage:",
19493 "content": "curl https://{domain}/api/rpc/campaigns -v -u {name}:{password}",
19497 "name": "Campaigns",
19498 "group": "RPC_Realtime",
19499 "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>",
19500 "version": "0.0.0",
19501 "filename": "server/api/rpc/index.js",
19502 "groupTitle": "RPC_Realtime"
19506 "url": "/api/rpc/fax/accounts",
19507 "title": "Gets a list of FaxAccounts",
19510 "title": "Example usage:",
19511 "content": "curl https://{domain}/api/rpc/fax/accounts -v -u {name}:{password}",
19515 "name": "FaxAccounts",
19516 "group": "RPC_Realtime",
19517 "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>",
19518 "version": "0.0.0",
19519 "filename": "server/api/rpc/index.js",
19520 "groupTitle": "RPC_Realtime"
19524 "url": "/api/rpc/agents/:id/capacity",
19525 "title": "Sets agent capacity",
19528 "title": "Example usage:",
19529 "content": "curl https://{domain}/api/rpc/agents/:id/capacity -v -u {name}:{password}",
19533 "name": "RTAgentCapacity",
19534 "group": "RPC_Realtime",
19535 "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>",
19536 "version": "0.0.0",
19537 "filename": "server/api/rpc/index.js",
19538 "groupTitle": "RPC_Realtime"
19542 "url": "/api/rpc/agents",
19543 "title": "Gets a list of RTAgents",
19546 "title": "Example usage:",
19547 "content": "curl https://{domain}/api/rpc/agents -v -u {name}:{password}",
19551 "name": "RTAgents",
19552 "group": "RPC_Realtime",
19553 "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>",
19554 "version": "0.0.0",
19555 "filename": "server/api/rpc/index.js",
19556 "groupTitle": "RPC_Realtime"
19560 "url": "/api/rpc/chat/queues",
19561 "title": "Gets a list of RTChatQueues",
19564 "title": "Example usage:",
19565 "content": "curl https://{domain}/api/rpc/chat/queues -v -u {name}:{password}",
19569 "name": "RTChatQueues",
19570 "group": "RPC_Realtime",
19571 "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>",
19572 "version": "0.0.0",
19573 "filename": "server/api/rpc/index.js",
19574 "groupTitle": "RPC_Realtime"
19578 "url": "/api/rpc/fax/queues",
19579 "title": "Gets a list of RTFaxQueues",
19582 "title": "Example usage:",
19583 "content": "curl https://{domain}/api/rpc/fax/queues -v -u {name}:{password}",
19587 "name": "RTFaxQueues",
19588 "group": "RPC_Realtime",
19589 "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>",
19590 "version": "0.0.0",
19591 "filename": "server/api/rpc/index.js",
19592 "groupTitle": "RPC_Realtime"
19596 "url": "/api/rpc/mail/accounts",
19597 "title": "Gets a list of RTMailAccounts",
19600 "title": "Example usage:",
19601 "content": "curl https://{domain}/api/rpc/mail/accounts -v -u {name}:{password}",
19605 "name": "RTMailAccounts",
19606 "group": "RPC_Realtime",
19607 "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>",
19608 "version": "0.0.0",
19609 "filename": "server/api/rpc/index.js",
19610 "groupTitle": "RPC_Realtime"
19614 "url": "/api/rpc/mail/queues",
19615 "title": "Gets a list of RTMailQueues",
19618 "title": "Example usage:",
19619 "content": "curl https://{domain}/api/rpc/mail/queues -v -u {name}:{password}",
19623 "name": "RTMailQueues",
19624 "group": "RPC_Realtime",
19625 "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>",
19626 "version": "0.0.0",
19627 "filename": "server/api/rpc/index.js",
19628 "groupTitle": "RPC_Realtime"
19632 "url": "/api/rpc/openchannel/queues",
19633 "title": "Gets a list of RTOpenchannelQueues",
19636 "title": "Example usage:",
19637 "content": "curl https://{domain}/api/rpc/openchannel/queues -v -u {name}:{password}",
19641 "name": "RTOpenchannelQueues",
19642 "group": "RPC_Realtime",
19643 "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>",
19644 "version": "0.0.0",
19645 "filename": "server/api/rpc/index.js",
19646 "groupTitle": "RPC_Realtime"
19650 "url": "/api/rpc/outbound/channels",
19651 "title": "Gets a list of RTOutboundChannels",
19654 "title": "Example usage:",
19655 "content": "curl https://{domain}/api/rpc/outbound/channels -v -u {name}:{password}",
19659 "name": "RTOutboundChannels",
19660 "group": "RPC_Realtime",
19661 "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>",
19662 "version": "0.0.0",
19663 "filename": "server/api/rpc/index.js",
19664 "groupTitle": "RPC_Realtime"
19668 "url": "/api/rpc/sms/queues",
19669 "title": "Gets a list of RTSmsQueues",
19672 "title": "Example usage:",
19673 "content": "curl https://{domain}/api/rpc/sms/queues -v -u {name}:{password}",
19677 "name": "RTSmsQueues",
19678 "group": "RPC_Realtime",
19679 "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>",
19680 "version": "0.0.0",
19681 "filename": "server/api/rpc/index.js",
19682 "groupTitle": "RPC_Realtime"
19686 "url": "/api/rpc/telephones",
19687 "title": "Gets a list of RTTelephones",
19690 "title": "Example usage:",
19691 "content": "curl https://{domain}/api/rpc/telephones -v -u {name}:{password}",
19695 "name": "RTTelephones",
19696 "group": "RPC_Realtime",
19697 "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>",
19698 "version": "0.0.0",
19699 "filename": "server/api/rpc/index.js",
19700 "groupTitle": "RPC_Realtime"
19704 "url": "/api/rpc/trunks",
19705 "title": "Gets a list of RTTrunks",
19708 "title": "Example usage:",
19709 "content": "curl https://{domain}/api/rpc/trunks -v -u {name}:{password}",
19713 "name": "RTTrunks",
19714 "group": "RPC_Realtime",
19715 "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>",
19716 "version": "0.0.0",
19717 "filename": "server/api/rpc/index.js",
19718 "groupTitle": "RPC_Realtime"
19722 "url": "/api/rpc/voice/channels",
19723 "title": "Gets a list of RTVoiceChannelMixMonitor",
19726 "title": "Example usage:",
19727 "content": "curl https://{domain}/api/rpc/voice/channels/{uniqueid}/mixmonitor -v -u {name}:{password}",
19731 "name": "RTVoiceChannelMixMonitor",
19732 "group": "RPC_Realtime",
19733 "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>",
19734 "version": "0.0.0",
19735 "filename": "server/api/rpc/index.js",
19736 "groupTitle": "RPC_Realtime"
19740 "url": "/api/rpc/voice/channels",
19741 "title": "Gets a list of RTVoiceChannelStopMixMonitor",
19744 "title": "Example usage:",
19745 "content": "curl https://{domain}/api/rpc/voice/channels/{uniqueid}/stopmixmonitor -v -u {name}:{password}",
19749 "name": "RTVoiceChannelStopMixMonitor",
19750 "group": "RPC_Realtime",
19751 "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>",
19752 "version": "0.0.0",
19753 "filename": "server/api/rpc/index.js",
19754 "groupTitle": "RPC_Realtime"
19758 "url": "/api/rpc/voice/channels",
19759 "title": "Gets a list of RTVoiceChannels",
19762 "title": "Example usage:",
19763 "content": "curl https://{domain}/api/rpc/voice/channels -v -u {name}:{password}",
19767 "name": "RTVoiceChannels",
19768 "group": "RPC_Realtime",
19769 "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>",
19770 "version": "0.0.0",
19771 "filename": "server/api/rpc/index.js",
19772 "groupTitle": "RPC_Realtime"
19776 "url": "/api/rpc/voice/queues/channels/{uniqueid}",
19777 "title": "Gets a single RTVoiceQueueChannel",
19780 "title": "Example usage:",
19781 "content": "curl https://{domain}/api/rpc/voice/queues/channels/{uniqueid} -v -u {name}:{password}",
19785 "name": "RTVoiceQueueChannel",
19786 "group": "RPC_Realtime",
19787 "description": "<p>Motion will return a specific realtime voice queue channel.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19788 "version": "0.0.0",
19789 "filename": "server/api/rpc/index.js",
19790 "groupTitle": "RPC_Realtime"
19794 "url": "/api/rpc/voice/queues/channels/{uniqueid}/hangup",
19795 "title": "Hangup a single RTVoiceQueueChannel",
19798 "title": "Example usage:",
19799 "content": "curl https://{domain}/api/rpc/voice/queues/channels/{uniqueid}/hangup -v -u {name}:{password}",
19803 "name": "RTVoiceQueueChannelHangup",
19804 "group": "RPC_Realtime",
19805 "description": "<p>Motion will hangup a specific realtime voice queue channel.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19806 "version": "0.0.0",
19807 "filename": "server/api/rpc/index.js",
19808 "groupTitle": "RPC_Realtime"
19812 "url": "/api/rpc/voice/queues/channels/{uniqueid}/redirect/{exten}",
19813 "title": "Hangup a single RTVoiceQueueChannel",
19816 "title": "Example usage:",
19817 "content": "curl https://{domain}/api/rpc/voice/queues/channels/{uniqueid}/redirect/{exten} -v -u {name}:{password}",
19821 "name": "RTVoiceQueueChannelRedirect",
19822 "group": "RPC_Realtime",
19823 "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>",
19824 "version": "0.0.0",
19825 "filename": "server/api/rpc/index.js",
19826 "groupTitle": "RPC_Realtime"
19830 "url": "/api/rpc/voice/queues/preview/{id}",
19831 "title": "Gets a single preview contact",
19834 "title": "Example usage:",
19835 "content": "curl https://{domain}/api/rpc/voice/queues/preview/{id} -v -u {name}:{password}",
19839 "name": "RTVoiceQueuePreview",
19840 "group": "RPC_Realtime",
19841 "description": "<p>Motion will return a specific preview contact.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19842 "version": "0.0.0",
19843 "filename": "server/api/rpc/index.js",
19844 "groupTitle": "RPC_Realtime"
19848 "url": "/api/rpc/outbound",
19849 "title": "Gets a list of RTOutbound",
19852 "title": "Example usage:",
19853 "content": "curl https://{domain}/api/rpc/outbound -v -u {name}:{password}",
19857 "name": "RTVoiceQueues",
19858 "group": "RPC_Realtime",
19859 "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>",
19860 "version": "0.0.0",
19861 "filename": "server/api/rpc/index.js",
19862 "groupTitle": "RPC_Realtime"
19866 "url": "/api/rpc/voice/queues",
19867 "title": "Gets a list of RTVoiceQueues",
19870 "title": "Example usage:",
19871 "content": "curl https://{domain}/api/rpc/voice/queues -v -u {name}:{password}",
19875 "name": "RTVoiceQueues",
19876 "group": "RPC_Realtime",
19877 "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>",
19878 "version": "0.0.0",
19879 "filename": "server/api/rpc/index.js",
19880 "groupTitle": "RPC_Realtime"
19884 "url": "/api/rpc/voice/queues/channels",
19885 "title": "Gets a list of RTVoiceQueuesChannels",
19888 "title": "Example usage:",
19889 "content": "curl https://{domain}/api/rpc/voice/queues/channels -v -u {name}:{password}",
19893 "name": "RTVoiceQueuesChannels",
19894 "group": "RPC_Realtime",
19895 "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>",
19896 "version": "0.0.0",
19897 "filename": "server/api/rpc/index.js",
19898 "groupTitle": "RPC_Realtime"
19902 "url": "/api/rpc/chat/queues/{id}",
19903 "title": "Gets a single RTChatQueue",
19906 "title": "Example usage:",
19907 "content": "curl https://{domain}/api/rpc/chat/queues/{id} -v -u {name}:{password}",
19911 "name": "ShowRTChatQueues",
19912 "group": "RPC_Realtime",
19913 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19914 "version": "0.0.0",
19915 "filename": "server/api/rpc/index.js",
19916 "groupTitle": "RPC_Realtime"
19920 "url": "/api/rpc/fax/queues/{id}",
19921 "title": "Gets a single RTFaxQueue",
19924 "title": "Example usage:",
19925 "content": "curl https://{domain}/api/rpc/fax/queues/{id} -v -u {name}:{password}",
19929 "name": "ShowRTFaxQueues",
19930 "group": "RPC_Realtime",
19931 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19932 "version": "0.0.0",
19933 "filename": "server/api/rpc/index.js",
19934 "groupTitle": "RPC_Realtime"
19938 "url": "/api/rpc/mail/queues/{id}",
19939 "title": "Gets a single RTMailQueue",
19942 "title": "Example usage:",
19943 "content": "curl https://{domain}/api/rpc/mail/queues/{id} -v -u {name}:{password}",
19947 "name": "ShowRTMailQueues",
19948 "group": "RPC_Realtime",
19949 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19950 "version": "0.0.0",
19951 "filename": "server/api/rpc/index.js",
19952 "groupTitle": "RPC_Realtime"
19956 "url": "/api/rpc/openchannel/queues/{id}",
19957 "title": "Gets a single RTOpenchannelQueue",
19960 "title": "Example usage:",
19961 "content": "curl https://{domain}/api/rpc/openchannel/queues/{id} -v -u {name}:{password}",
19965 "name": "ShowRTOpenchannelQueues",
19966 "group": "RPC_Realtime",
19967 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19968 "version": "0.0.0",
19969 "filename": "server/api/rpc/index.js",
19970 "groupTitle": "RPC_Realtime"
19974 "url": "/api/rpc/sms/queues/{id}",
19975 "title": "Gets a single RTSmsQueue",
19978 "title": "Example usage:",
19979 "content": "curl https://{domain}/api/rpc/sms/queues/{id} -v -u {name}:{password}",
19983 "name": "ShowRTSmsQueues",
19984 "group": "RPC_Realtime",
19985 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19986 "version": "0.0.0",
19987 "filename": "server/api/rpc/index.js",
19988 "groupTitle": "RPC_Realtime"
19992 "url": "/api/rpc/voice/queues/{id}",
19993 "title": "Gets a single RTVoiceQueue",
19996 "title": "Example usage:",
19997 "content": "curl https://{domain}/api/rpc/voice/queues/{id} -v -u {name}:{password}",
20001 "name": "ShowRTVoiceQueues",
20002 "group": "RPC_Realtime",
20003 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20004 "version": "0.0.0",
20005 "filename": "server/api/rpc/index.js",
20006 "groupTitle": "RPC_Realtime"
20010 "url": "/api/rpc/voice/{id}/queues",
20011 "title": "Updates a single VoiceQueue",
20014 "title": "Example usage:",
20015 "content": "curl https://{domain}/api/rpc/voice/queues/{id} -v -u {name}:{password}",
20019 "name": "UpdateVoiceQueues",
20020 "group": "RPC_Realtime",
20021 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20022 "version": "0.0.0",
20023 "filename": "server/api/rpc/index.js",
20024 "groupTitle": "RPC_Realtime"
20028 "url": "/api/rpc/agents/:id/notify",
20029 "title": "Notify message to a specific agent",
20032 "title": "Example usage:",
20033 "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",
20037 "name": "agentNotify",
20038 "group": "RPC_Realtime",
20039 "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>",
20040 "version": "0.0.0",
20041 "filename": "server/api/rpc/index.js",
20042 "groupTitle": "RPC_Realtime"
20046 "url": "/api/rpc/chat/queues/:id/notify",
20047 "title": "Notify message to a specific queue",
20050 "title": "Example usage:",
20051 "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",
20055 "name": "chatQueueNotify",
20056 "group": "RPC_Realtime",
20057 "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>",
20058 "version": "0.0.0",
20059 "filename": "server/api/rpc/index.js",
20060 "groupTitle": "RPC_Realtime"
20064 "url": "/api/rpc/chat/queues/waitinginteractions",
20065 "title": "Gets a list of chatQueuesWaitingInteractions",
20068 "title": "Example usage:",
20069 "content": "curl https://{domain}/api/rpc/chat/queues/waitinginteractions -v -u {name}:{password}",
20073 "name": "chatQueuesWaitingInteractions",
20074 "group": "RPC_Realtime",
20075 "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>",
20076 "version": "0.0.0",
20077 "filename": "server/api/rpc/index.js",
20078 "groupTitle": "RPC_Realtime"
20082 "url": "/api/rpc/fax/queues/:id/notify",
20083 "title": "Notify message to a specific queue",
20086 "title": "Example usage:",
20087 "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",
20091 "name": "faxQueueNotify",
20092 "group": "RPC_Realtime",
20093 "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>",
20094 "version": "0.0.0",
20095 "filename": "server/api/rpc/index.js",
20096 "groupTitle": "RPC_Realtime"
20100 "url": "/api/rpc/fax/queues/waitinginteractions",
20101 "title": "Gets a list of faxQueuesWaitingInteractions",
20104 "title": "Example usage:",
20105 "content": "curl https://{domain}/api/rpc/fax/queues/waitinginteractions -v -u {name}:{password}",
20109 "name": "faxQueuesWaitingInteractions",
20110 "group": "RPC_Realtime",
20111 "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>",
20112 "version": "0.0.0",
20113 "filename": "server/api/rpc/index.js",
20114 "groupTitle": "RPC_Realtime"
20118 "url": "/api/rpc/mail/queues/:id/notify",
20119 "title": "Notify message to a specific queue",
20122 "title": "Example usage:",
20123 "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",
20127 "name": "mailQueueNotify",
20128 "group": "RPC_Realtime",
20129 "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>",
20130 "version": "0.0.0",
20131 "filename": "server/api/rpc/index.js",
20132 "groupTitle": "RPC_Realtime"
20136 "url": "/api/rpc/mail/queues/waitinginteractions",
20137 "title": "Gets a list of mailQueuesWaitingInteractions",
20140 "title": "Example usage:",
20141 "content": "curl https://{domain}/api/rpc/mail/queues/waitinginteractions -v -u {name}:{password}",
20145 "name": "mailQueuesWaitingInteractions",
20146 "group": "RPC_Realtime",
20147 "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>",
20148 "version": "0.0.0",
20149 "filename": "server/api/rpc/index.js",
20150 "groupTitle": "RPC_Realtime"
20154 "url": "/api/rpc/openchannel/queues/:id/notify",
20155 "title": "Notify message to a specific queue",
20158 "title": "Example usage:",
20159 "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",
20163 "name": "openchannelQueueNotify",
20164 "group": "RPC_Realtime",
20165 "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>",
20166 "version": "0.0.0",
20167 "filename": "server/api/rpc/index.js",
20168 "groupTitle": "RPC_Realtime"
20172 "url": "/api/rpc/openchannel/queues/:id/waitinginteractions",
20173 "title": "Gets a list of openchannelQueuesIdWaitingInteractions",
20176 "title": "Example usage:",
20177 "content": "curl https://{domain}/api/rpc/openchannel/queues/:id/waitinginteractions -v -u {name}:{password}",
20181 "name": "openchannelQueuesIdWaitingInteractions",
20182 "group": "RPC_Realtime",
20183 "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>",
20184 "version": "0.0.0",
20185 "filename": "server/api/rpc/index.js",
20186 "groupTitle": "RPC_Realtime"
20190 "url": "/api/rpc/openchannel/queues/waitinginteractions",
20191 "title": "Gets a list of openchannelQueuesWaitingInteractions",
20194 "title": "Example usage:",
20195 "content": "curl https://{domain}/api/rpc/openchannel/queues/waitinginteractions -v -u {name}:{password}",
20199 "name": "openchannelQueuesWaitingInteractions",
20200 "group": "RPC_Realtime",
20201 "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>",
20202 "version": "0.0.0",
20203 "filename": "server/api/rpc/index.js",
20204 "groupTitle": "RPC_Realtime"
20208 "url": "/api/rpc/sms/queues/:id/notify",
20209 "title": "Notify message to a specific queue",
20212 "title": "Example usage:",
20213 "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",
20217 "name": "smsQueueNotify",
20218 "group": "RPC_Realtime",
20219 "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>",
20220 "version": "0.0.0",
20221 "filename": "server/api/rpc/index.js",
20222 "groupTitle": "RPC_Realtime"
20226 "url": "/api/rpc/sms/queues/waitinginteractions",
20227 "title": "Gets a list of smsQueuesWaitingInteractions",
20230 "title": "Example usage:",
20231 "content": "curl https://{domain}/api/rpc/sms/queues/waitinginteractions -v -u {name}:{password}",
20235 "name": "smsQueuesWaitingInteractions",
20236 "group": "RPC_Realtime",
20237 "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>",
20238 "version": "0.0.0",
20239 "filename": "server/api/rpc/index.js",
20240 "groupTitle": "RPC_Realtime"
20244 "url": "/api/integrations/salesforce/accounts",
20245 "title": "Creates a new Salesforce Account",
20248 "title": "Example usage:",
20249 "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",
20253 "name": "CreateSalesforce_Accounts",
20254 "group": "Salesforce_Accounts",
20269 "field": "description",
20276 "field": "username",
20283 "field": "remoteUri",
20290 "field": "password",
20297 "field": "clientId",
20304 "field": "clientSecret",
20311 "field": "securityToken",
20318 "field": "serverUrl",
20325 "\"integrationTab\"",
20335 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20336 "version": "0.0.0",
20337 "filename": "server/api/intSalesforceAccount/index.js",
20338 "groupTitle": "Salesforce_Accounts"
20342 "url": "/api/integrations/salesforce/accounts/{id}",
20343 "title": "Deletes a Salesforce Account",
20346 "title": "Example usage:",
20347 "content": "curl https://{domain}/api/integrations/salesforce/accounts/{id} -v -u {name}:{password} -X DELETE",
20351 "name": "DeleteSalesforce_Accounts",
20352 "group": "Salesforce_Accounts",
20353 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20354 "version": "0.0.0",
20355 "filename": "server/api/intSalesforceAccount/index.js",
20356 "groupTitle": "Salesforce_Accounts"
20360 "url": "/api/integrations/salesforce/accounts",
20361 "title": "Gets a list of Salesforce Accounts",
20364 "title": "Example usage:",
20365 "content": "curl https://{domain}/api/integrations/salesforce/accounts -v -u {name}:{password}",
20369 "name": "GetSalesforce_Accounts",
20370 "group": "Salesforce_Accounts",
20371 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
20372 "version": "0.0.0",
20373 "filename": "server/api/intSalesforceAccount/index.js",
20374 "groupTitle": "Salesforce_Accounts"
20378 "url": "/api/integrations/salesforce/accounts/{id}",
20379 "title": "Gets a single Salesforce Account",
20382 "title": "Example usage:",
20383 "content": "curl https://{domain}/api/integrations/salesforce/accounts/{id} -v -u {name}:{password}",
20387 "name": "ShowSalesforce_Accounts",
20388 "group": "Salesforce_Accounts",
20389 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20390 "version": "0.0.0",
20391 "filename": "server/api/intSalesforceAccount/index.js",
20392 "groupTitle": "Salesforce_Accounts"
20396 "url": "/api/integrations/salesforce/accounts/{id}/configurations",
20397 "title": "Creates new configuration",
20400 "title": "Example usage:",
20401 "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",
20405 "name": "addConfiguration",
20406 "group": "Salesforce_Accounts",
20407 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20408 "version": "0.0.0",
20409 "filename": "server/api/intSalesforceAccount/index.js",
20410 "groupTitle": "Salesforce_Accounts"
20414 "url": "/api/integrations/salesforce/accounts/{id}/configurations",
20415 "title": "Gets account configurations",
20418 "title": "Example usage:",
20419 "content": "curl https://{domain}/api/integrations/salesforce/accounts/{id}/configurations -v -u {name}:{password} -X GET",
20423 "name": "getConfigurations",
20424 "group": "Salesforce_Accounts",
20425 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20426 "version": "0.0.0",
20427 "filename": "server/api/intSalesforceAccount/index.js",
20428 "groupTitle": "Salesforce_Accounts"
20432 "url": "/api/integrations/salesforce/accounts/{id}/fields",
20433 "title": "Gets account fields",
20436 "title": "Example usage:",
20437 "content": "curl https://{domain}/api/integrations/salesforce/accounts/{id}/fields -v -u {name}:{password} -X GET",
20441 "name": "getFields",
20442 "group": "Salesforce_Accounts",
20443 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20444 "version": "0.0.0",
20445 "filename": "server/api/intSalesforceAccount/index.js",
20446 "groupTitle": "Salesforce_Accounts"
20450 "url": "/api/integrations/salesforce/accounts/{id}",
20451 "title": "Update an existing Salesforce Account",
20454 "title": "Example usage:",
20455 "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",
20459 "name": "updateSalesforce_Accounts",
20460 "group": "Salesforce_Accounts",
20461 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20462 "version": "0.0.0",
20463 "filename": "server/api/intSalesforceAccount/index.js",
20464 "groupTitle": "Salesforce_Accounts"
20468 "url": "/api/integrations/salesforce/configurations",
20469 "title": "Creates a new Salesforce Configuration",
20472 "title": "Example usage:",
20473 "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",
20477 "name": "CreateSalesforce_Configurations",
20478 "group": "Salesforce_Configurations",
20493 "field": "description",
20504 "field": "ticketType",
20511 "\"contact_lead\"",
20514 "\"account_contact_lead\"",
20518 "field": "moduleSearch",
20531 "field": "moduleCreate",
20545 "field": "additionalSearchAccount",
20552 "field": "additionalSearchContact",
20559 "field": "additionalSearchLead",
20565 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20566 "version": "0.0.0",
20567 "filename": "server/api/intSalesforceConfiguration/index.js",
20568 "groupTitle": "Salesforce_Configurations"
20572 "url": "/api/integrations/salesforce/configurations/{id}",
20573 "title": "Deletes a Salesforce Configuration",
20576 "title": "Example usage:",
20577 "content": "curl https://{domain}/api/integrations/salesforce/configurations/{id} -v -u {name}:{password} -X DELETE",
20581 "name": "DeleteSalesforce_Configurations",
20582 "group": "Salesforce_Configurations",
20583 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20584 "version": "0.0.0",
20585 "filename": "server/api/intSalesforceConfiguration/index.js",
20586 "groupTitle": "Salesforce_Configurations"
20590 "url": "/api/integrations/salesforce/configurations",
20591 "title": "Gets a list of Salesforce Configurations",
20594 "title": "Example usage:",
20595 "content": "curl https://{domain}/api/integrations/salesforce/configurations -v -u {name}:{password}",
20599 "name": "GetSalesforce_Configurations",
20600 "group": "Salesforce_Configurations",
20601 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
20602 "version": "0.0.0",
20603 "filename": "server/api/intSalesforceConfiguration/index.js",
20604 "groupTitle": "Salesforce_Configurations"
20608 "url": "/api/integrations/salesforce/configurations/{id}",
20609 "title": "Gets a single Salesforce Configuration",
20612 "title": "Example usage:",
20613 "content": "curl https://{domain}/api/integrations/salesforce/configurations/{id} -v -u {name}:{password}",
20617 "name": "ShowSalesforce_Configurations",
20618 "group": "Salesforce_Configurations",
20619 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20620 "version": "0.0.0",
20621 "filename": "server/api/intSalesforceConfiguration/index.js",
20622 "groupTitle": "Salesforce_Configurations"
20626 "url": "/api/integrations/salesforce/configurations/{id}/descriptions",
20627 "title": "Gets configurations descriptions",
20630 "title": "Example usage:",
20631 "content": "curl https://{domain}/api/integrations/salesforce/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
20635 "name": "getDescriptions",
20636 "group": "Salesforce_Configurations",
20637 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20638 "version": "0.0.0",
20639 "filename": "server/api/intSalesforceConfiguration/index.js",
20640 "groupTitle": "Salesforce_Configurations"
20644 "url": "/api/integrations/salesforce/configurations/{id}/fields",
20645 "title": "Gets configurations fields",
20648 "title": "Example usage:",
20649 "content": "curl https://{domain}/api/integrations/salesforce/configurations/{id}/fields -v -u {name}:{password} -X GET",
20653 "name": "getFields",
20654 "group": "Salesforce_Configurations",
20655 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20656 "version": "0.0.0",
20657 "filename": "server/api/intSalesforceConfiguration/index.js",
20658 "groupTitle": "Salesforce_Configurations"
20662 "url": "/api/integrations/salesforce/configurations/{id}/subjects",
20663 "title": "Gets configurations subjects",
20666 "title": "Example usage:",
20667 "content": "curl https://{domain}/api/integrations/salesforce/configurations/{id}/subjects -v -u {name}:{password} -X GET",
20671 "name": "getSubjects",
20672 "group": "Salesforce_Configurations",
20673 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20674 "version": "0.0.0",
20675 "filename": "server/api/intSalesforceConfiguration/index.js",
20676 "groupTitle": "Salesforce_Configurations"
20680 "url": "/api/integrations/salesforce/configurations/{id}",
20681 "title": "Update an existing Salesforce Configuration",
20684 "title": "Example usage:",
20685 "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",
20689 "name": "updateSalesforce_Configurations",
20690 "group": "Salesforce_Configurations",
20691 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20692 "version": "0.0.0",
20693 "filename": "server/api/intSalesforceConfiguration/index.js",
20694 "groupTitle": "Salesforce_Configurations"
20698 "url": "/api/integrations/salesforce/fields",
20699 "title": "Creates a new Salesforce Field",
20702 "title": "Example usage:",
20703 "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",
20707 "name": "CreateSalesforce_Fields",
20708 "group": "Salesforce_Fields",
20718 "\"customVariable\"",
20730 "field": "content",
20746 "\"customVariable\""
20749 "field": "keyType",
20756 "field": "keyContent",
20763 "field": "idField",
20770 "field": "variableName",
20776 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20777 "version": "0.0.0",
20778 "filename": "server/api/intSalesforceField/index.js",
20779 "groupTitle": "Salesforce_Fields"
20783 "url": "/api/integrations/salesforce/fields/{id}",
20784 "title": "Deletes a Salesforce Field",
20787 "title": "Example usage:",
20788 "content": "curl https://{domain}/api/integrations/salesforce/fields/{id} -v -u {name}:{password} -X DELETE",
20792 "name": "DeleteSalesforce_Fields",
20793 "group": "Salesforce_Fields",
20794 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20795 "version": "0.0.0",
20796 "filename": "server/api/intSalesforceField/index.js",
20797 "groupTitle": "Salesforce_Fields"
20801 "url": "/api/integrations/salesforce/fields",
20802 "title": "Gets a list of Salesforce Fields",
20805 "title": "Example usage:",
20806 "content": "curl https://{domain}/api/integrations/salesforce/fields -v -u {name}:{password}",
20810 "name": "GetSalesforce_Fields",
20811 "group": "Salesforce_Fields",
20812 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
20813 "version": "0.0.0",
20814 "filename": "server/api/intSalesforceField/index.js",
20815 "groupTitle": "Salesforce_Fields"
20819 "url": "/api/integrations/salesforce/fields/{id}",
20820 "title": "Gets a single Salesforce Field",
20823 "title": "Example usage:",
20824 "content": "curl https://{domain}/api/integrations/salesforce/fields/{id} -v -u {name}:{password}",
20828 "name": "ShowSalesforce_Fields",
20829 "group": "Salesforce_Fields",
20830 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20831 "version": "0.0.0",
20832 "filename": "server/api/intSalesforceField/index.js",
20833 "groupTitle": "Salesforce_Fields"
20837 "url": "/api/integrations/salesforce/fields/{id}",
20838 "title": "Update an existing Salesforce Field",
20841 "title": "Example usage:",
20842 "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",
20846 "name": "updateSalesforce_Fields",
20847 "group": "Salesforce_Fields",
20848 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20849 "version": "0.0.0",
20850 "filename": "server/api/intSalesforceField/index.js",
20851 "groupTitle": "Salesforce_Fields"
20855 "url": "/api/schedules",
20856 "title": "Creates a new Schedule",
20859 "title": "Example usage:",
20860 "content": "curl https://{domain}/api/schedules -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
20864 "name": "CreateSchedules",
20865 "group": "Schedules",
20880 "field": "description",
20901 "field": "startAt",
20915 "field": "subtractNumber",
20931 "field": "subtractUnit",
20961 "field": "sendMail",
20989 "field": "sendIfEmpty",
20995 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20996 "version": "0.0.0",
20997 "filename": "server/api/schedule/index.js",
20998 "groupTitle": "Schedules"
21002 "url": "/api/schedules/{id}",
21003 "title": "Deletes a Schedule",
21006 "title": "Example usage:",
21007 "content": "curl https://{domain}/api/schedules/{id} -v -u {name}:{password} -X DELETE",
21011 "name": "DeleteSchedules",
21012 "group": "Schedules",
21013 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21014 "version": "0.0.0",
21015 "filename": "server/api/schedule/index.js",
21016 "groupTitle": "Schedules"
21020 "url": "/api/schedules",
21021 "title": "Gets a list of Schedules",
21024 "title": "Example usage:",
21025 "content": "curl https://{domain}/api/schedules -v -u {name}:{password}",
21029 "name": "GetSchedules",
21030 "group": "Schedules",
21031 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
21032 "version": "0.0.0",
21033 "filename": "server/api/schedule/index.js",
21034 "groupTitle": "Schedules"
21038 "url": "/api/schedules/{id}",
21039 "title": "Gets a single Schedule",
21042 "title": "Example usage:",
21043 "content": "curl https://{domain}/api/schedules/{id} -v -u {name}:{password}",
21047 "name": "ShowSchedules",
21048 "group": "Schedules",
21049 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21050 "version": "0.0.0",
21051 "filename": "server/api/schedule/index.js",
21052 "groupTitle": "Schedules"
21056 "url": "/api/schedules/{id}/run",
21057 "title": "Run Scheduler",
21060 "title": "Example usage:",
21061 "content": "curl https://{domain}/api/schedules/{id}/run -v -u {name}:{password} -X GET",
21066 "group": "Schedules",
21067 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21068 "version": "0.0.0",
21069 "filename": "server/api/schedule/index.js",
21070 "groupTitle": "Schedules"
21074 "url": "/api/schedules/{id}",
21075 "title": "Update an existing Schedule",
21078 "title": "Example usage:",
21079 "content": "curl https://{domain}/api/schedules/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
21083 "name": "updateSchedules",
21084 "group": "Schedules",
21085 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21086 "version": "0.0.0",
21087 "filename": "server/api/schedule/index.js",
21088 "groupTitle": "Schedules"
21092 "url": "/api/screen/recordings",
21093 "title": "Creates a new Recording",
21096 "title": "Example usage:",
21097 "content": "curl https://{domain}/api/screen/recordings -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
21101 "name": "CreateRecordings",
21102 "group": "Screen_Recordings",
21117 "field": "interactionid",
21124 "field": "channel",
21145 "field": "duration",
21152 "field": "startedAt",
21159 "field": "closedAt",
21166 "field": "createdAt",
21173 "field": "updatedAt",
21179 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21180 "version": "0.0.0",
21181 "filename": "server/api/screenRecording/index.js",
21182 "groupTitle": "Screen_Recordings"
21186 "url": "/api/screen/recordings/describe",
21187 "title": "Gets table info about Recordings",
21190 "title": "Example usage:",
21191 "content": "curl https://{domain}/api/screen/recordings/describe -v -u {name}:{password}",
21195 "name": "DescribeRecordings",
21196 "group": "Screen_Recordings",
21197 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21198 "version": "0.0.0",
21199 "filename": "server/api/screenRecording/index.js",
21200 "groupTitle": "Screen_Recordings"
21204 "url": "/api/screen/recordings",
21205 "title": "Gets a list of Recordings",
21208 "title": "Example usage:",
21209 "content": "curl https://{domain}/api/screen/recordings -v -u {name}:{password}",
21213 "name": "GetRecordings",
21214 "group": "Screen_Recordings",
21215 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
21216 "version": "0.0.0",
21217 "filename": "server/api/screenRecording/index.js",
21218 "groupTitle": "Screen_Recordings"
21222 "url": "/api/screen/recordings/{id}",
21223 "title": "Gets a single Recording",
21226 "title": "Example usage:",
21227 "content": "curl https://{domain}/api/screen/recordings/{id} -v -u {name}:{password}",
21231 "name": "ShowRecordings",
21232 "group": "Screen_Recordings",
21233 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21234 "version": "0.0.0",
21235 "filename": "server/api/screenRecording/index.js",
21236 "groupTitle": "Screen_Recordings"
21240 "url": "/api/screen/recordings/{id}",
21241 "title": "Delete screen recording",
21244 "title": "Example usage:",
21245 "content": "curl https://{domain}/api/screen/recordings/{id} -v -u {name}:{password} -X DELETE",
21250 "group": "Screen_Recordings",
21251 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21252 "version": "0.0.0",
21253 "filename": "server/api/screenRecording/index.js",
21254 "groupTitle": "Screen_Recordings"
21258 "url": "/api/screen/recordings/{id}/download",
21259 "title": "Download Recording",
21262 "title": "Example usage:",
21263 "content": "curl https://{domain}/api/screen/recordings/{id}/download -v -u {name}:{password} -X GET",
21267 "name": "download",
21268 "group": "Screen_Recordings",
21269 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21270 "version": "0.0.0",
21271 "filename": "server/api/screenRecording/index.js",
21272 "groupTitle": "Screen_Recordings"
21276 "url": "/api/screen/recordings/{id}",
21277 "title": "Update an existing Recording",
21280 "title": "Example usage:",
21281 "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",
21285 "name": "updateRecordings",
21286 "group": "Screen_Recordings",
21287 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21288 "version": "0.0.0",
21289 "filename": "server/api/screenRecording/index.js",
21290 "groupTitle": "Screen_Recordings"
21294 "url": "/api/integrations/servicenow/accounts",
21295 "title": "Creates a new Servicenow Account",
21298 "title": "Example usage:",
21299 "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",
21303 "name": "CreateServicenow_Accounts",
21304 "group": "Servicenow_Accounts",
21319 "field": "description",
21326 "field": "username",
21333 "field": "password",
21347 "field": "remoteUri",
21354 "field": "serverUrl",
21360 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21361 "version": "0.0.0",
21362 "filename": "server/api/intServicenowAccount/index.js",
21363 "groupTitle": "Servicenow_Accounts"
21367 "url": "/api/integrations/servicenow/accounts/{id}",
21368 "title": "Deletes a Servicenow Account",
21371 "title": "Example usage:",
21372 "content": "curl https://{domain}/api/integrations/servicenow/accounts/{id} -v -u {name}:{password} -X DELETE",
21376 "name": "DeleteServicenow_Accounts",
21377 "group": "Servicenow_Accounts",
21378 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21379 "version": "0.0.0",
21380 "filename": "server/api/intServicenowAccount/index.js",
21381 "groupTitle": "Servicenow_Accounts"
21385 "url": "/api/integrations/servicenow/accounts",
21386 "title": "Gets a list of Servicenow Accounts",
21389 "title": "Example usage:",
21390 "content": "curl https://{domain}/api/integrations/servicenow/accounts -v -u {name}:{password}",
21394 "name": "GetServicenow_Accounts",
21395 "group": "Servicenow_Accounts",
21396 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
21397 "version": "0.0.0",
21398 "filename": "server/api/intServicenowAccount/index.js",
21399 "groupTitle": "Servicenow_Accounts"
21403 "url": "/api/integrations/servicenow/accounts/{id}",
21404 "title": "Gets a single Servicenow Account",
21407 "title": "Example usage:",
21408 "content": "curl https://{domain}/api/integrations/servicenow/accounts/{id} -v -u {name}:{password}",
21412 "name": "ShowServicenow_Accounts",
21413 "group": "Servicenow_Accounts",
21414 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21415 "version": "0.0.0",
21416 "filename": "server/api/intServicenowAccount/index.js",
21417 "groupTitle": "Servicenow_Accounts"
21421 "url": "/api/integrations/servicenow/accounts/{id}/configurations",
21422 "title": "Creates new configuration",
21425 "title": "Example usage:",
21426 "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",
21430 "name": "addConfiguration",
21431 "group": "Servicenow_Accounts",
21432 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21433 "version": "0.0.0",
21434 "filename": "server/api/intServicenowAccount/index.js",
21435 "groupTitle": "Servicenow_Accounts"
21439 "url": "/api/integrations/servicenow/accounts/{id}/configurations",
21440 "title": "Gets account configurations",
21443 "title": "Example usage:",
21444 "content": "curl https://{domain}/api/integrations/servicenow/accounts/{id}/configurations -v -u {name}:{password} -X GET",
21448 "name": "getConfigurations",
21449 "group": "Servicenow_Accounts",
21450 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21451 "version": "0.0.0",
21452 "filename": "server/api/intServicenowAccount/index.js",
21453 "groupTitle": "Servicenow_Accounts"
21457 "url": "/api/integrations/servicenow/accounts/{id}/fields",
21458 "title": "Gets account fields",
21461 "title": "Example usage:",
21462 "content": "curl https://{domain}/api/integrations/servicenow/accounts/{id}/fields -v -u {name}:{password} -X GET",
21466 "name": "getFields",
21467 "group": "Servicenow_Accounts",
21468 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21469 "version": "0.0.0",
21470 "filename": "server/api/intServicenowAccount/index.js",
21471 "groupTitle": "Servicenow_Accounts"
21475 "url": "/api/integrations/servicenow/accounts/{id}",
21476 "title": "Update an existing Servicenow Account",
21479 "title": "Example usage:",
21480 "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",
21484 "name": "updateServicenow_Accounts",
21485 "group": "Servicenow_Accounts",
21486 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21487 "version": "0.0.0",
21488 "filename": "server/api/intServicenowAccount/index.js",
21489 "groupTitle": "Servicenow_Accounts"
21493 "url": "/api/integrations/servicenow/configurations",
21494 "title": "Creates a new Servicenow Configuration",
21497 "title": "Example usage:",
21498 "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",
21502 "name": "CreateServicenow_Configurations",
21503 "group": "Servicenow_Configurations",
21518 "field": "description",
21524 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21525 "version": "0.0.0",
21526 "filename": "server/api/intServicenowConfiguration/index.js",
21527 "groupTitle": "Servicenow_Configurations"
21531 "url": "/api/integrations/servicenow/configurations/{id}",
21532 "title": "Deletes a Servicenow Configuration",
21535 "title": "Example usage:",
21536 "content": "curl https://{domain}/api/integrations/servicenow/configurations/{id} -v -u {name}:{password} -X DELETE",
21540 "name": "DeleteServicenow_Configurations",
21541 "group": "Servicenow_Configurations",
21542 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21543 "version": "0.0.0",
21544 "filename": "server/api/intServicenowConfiguration/index.js",
21545 "groupTitle": "Servicenow_Configurations"
21549 "url": "/api/integrations/servicenow/configurations",
21550 "title": "Gets a list of Servicenow Configurations",
21553 "title": "Example usage:",
21554 "content": "curl https://{domain}/api/integrations/servicenow/configurations -v -u {name}:{password}",
21558 "name": "GetServicenow_Configurations",
21559 "group": "Servicenow_Configurations",
21560 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
21561 "version": "0.0.0",
21562 "filename": "server/api/intServicenowConfiguration/index.js",
21563 "groupTitle": "Servicenow_Configurations"
21567 "url": "/api/integrations/servicenow/configurations/{id}",
21568 "title": "Gets a single Servicenow Configuration",
21571 "title": "Example usage:",
21572 "content": "curl https://{domain}/api/integrations/servicenow/configurations/{id} -v -u {name}:{password}",
21576 "name": "ShowServicenow_Configurations",
21577 "group": "Servicenow_Configurations",
21578 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21579 "version": "0.0.0",
21580 "filename": "server/api/intServicenowConfiguration/index.js",
21581 "groupTitle": "Servicenow_Configurations"
21585 "url": "/api/integrations/servicenow/configurations/{id}/descriptions",
21586 "title": "Gets configurations descriptions",
21589 "title": "Example usage:",
21590 "content": "curl https://{domain}/api/integrations/servicenow/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
21594 "name": "getDescriptions",
21595 "group": "Servicenow_Configurations",
21596 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21597 "version": "0.0.0",
21598 "filename": "server/api/intServicenowConfiguration/index.js",
21599 "groupTitle": "Servicenow_Configurations"
21603 "url": "/api/integrations/servicenow/configurations/{id}/fields",
21604 "title": "Gets configurations fields",
21607 "title": "Example usage:",
21608 "content": "curl https://{domain}/api/integrations/servicenow/configurations/{id}/fields -v -u {name}:{password} -X GET",
21612 "name": "getFields",
21613 "group": "Servicenow_Configurations",
21614 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21615 "version": "0.0.0",
21616 "filename": "server/api/intServicenowConfiguration/index.js",
21617 "groupTitle": "Servicenow_Configurations"
21621 "url": "/api/integrations/servicenow/configurations/{id}/subjects",
21622 "title": "Gets configurations subjects",
21625 "title": "Example usage:",
21626 "content": "curl https://{domain}/api/integrations/servicenow/configurations/{id}/subjects -v -u {name}:{password} -X GET",
21630 "name": "getSubjects",
21631 "group": "Servicenow_Configurations",
21632 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21633 "version": "0.0.0",
21634 "filename": "server/api/intServicenowConfiguration/index.js",
21635 "groupTitle": "Servicenow_Configurations"
21639 "url": "/api/integrations/servicenow/configurations/{id}",
21640 "title": "Update an existing Servicenow Configuration",
21643 "title": "Example usage:",
21644 "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",
21648 "name": "updateServicenow_Configurations",
21649 "group": "Servicenow_Configurations",
21650 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21651 "version": "0.0.0",
21652 "filename": "server/api/intServicenowConfiguration/index.js",
21653 "groupTitle": "Servicenow_Configurations"
21657 "url": "/api/integrations/servicenow/fields",
21658 "title": "Creates a new Servicenow Field",
21661 "title": "Example usage:",
21662 "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",
21666 "name": "CreateServicenow_Fields",
21667 "group": "Servicenow_Fields",
21677 "\"customVariable\"",
21689 "field": "content",
21705 "\"customVariable\""
21708 "field": "keyType",
21715 "field": "keyContent",
21722 "field": "idField",
21729 "field": "nameField",
21736 "field": "customField",
21743 "field": "variableName",
21749 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21750 "version": "0.0.0",
21751 "filename": "server/api/intServicenowField/index.js",
21752 "groupTitle": "Servicenow_Fields"
21756 "url": "/api/integrations/servicenow/fields/{id}",
21757 "title": "Deletes a Servicenow Field",
21760 "title": "Example usage:",
21761 "content": "curl https://{domain}/api/integrations/servicenow/fields/{id} -v -u {name}:{password} -X DELETE",
21765 "name": "DeleteServicenow_Fields",
21766 "group": "Servicenow_Fields",
21767 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21768 "version": "0.0.0",
21769 "filename": "server/api/intServicenowField/index.js",
21770 "groupTitle": "Servicenow_Fields"
21774 "url": "/api/integrations/servicenow/fields",
21775 "title": "Gets a list of Servicenow Fields",
21778 "title": "Example usage:",
21779 "content": "curl https://{domain}/api/integrations/servicenow/fields -v -u {name}:{password}",
21783 "name": "GetServicenow_Fields",
21784 "group": "Servicenow_Fields",
21785 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
21786 "version": "0.0.0",
21787 "filename": "server/api/intServicenowField/index.js",
21788 "groupTitle": "Servicenow_Fields"
21792 "url": "/api/integrations/servicenow/fields/{id}",
21793 "title": "Gets a single Servicenow Field",
21796 "title": "Example usage:",
21797 "content": "curl https://{domain}/api/integrations/servicenow/fields/{id} -v -u {name}:{password}",
21801 "name": "ShowServicenow_Fields",
21802 "group": "Servicenow_Fields",
21803 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21804 "version": "0.0.0",
21805 "filename": "server/api/intServicenowField/index.js",
21806 "groupTitle": "Servicenow_Fields"
21810 "url": "/api/integrations/servicenow/fields/{id}",
21811 "title": "Update an existing Servicenow Field",
21814 "title": "Example usage:",
21815 "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",
21819 "name": "updateServicenow_Fields",
21820 "group": "Servicenow_Fields",
21821 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21822 "version": "0.0.0",
21823 "filename": "server/api/intServicenowField/index.js",
21824 "groupTitle": "Servicenow_Fields"
21828 "url": "/api/settings",
21829 "title": "Gets a list of Settings",
21832 "title": "Example usage:",
21833 "content": "curl https://{domain}/api/settings -v -u {name}:{password}",
21837 "name": "GetSettings",
21838 "group": "Settings",
21839 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
21840 "version": "0.0.0",
21841 "filename": "server/api/setting/index.js",
21842 "groupTitle": "Settings"
21846 "url": "/api/settings/{id}",
21847 "title": "Gets a single Setting",
21850 "title": "Example usage:",
21851 "content": "curl https://{domain}/api/settings/{id} -v -u {name}:{password}",
21855 "name": "ShowSettings",
21856 "group": "Settings",
21857 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21858 "version": "0.0.0",
21859 "filename": "server/api/setting/index.js",
21860 "groupTitle": "Settings"
21864 "url": "/api/settings/{id}/favicon",
21865 "title": "Add Favicon",
21868 "title": "Example usage:",
21869 "content": "curl https://{domain}/api/settings/{id}/favicon -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
21873 "name": "addFavicon",
21874 "group": "Settings",
21875 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21876 "version": "0.0.0",
21877 "filename": "server/api/setting/index.js",
21878 "groupTitle": "Settings"
21882 "url": "/api/settings/{id}/logo",
21883 "title": "Add logo",
21886 "title": "Example usage:",
21887 "content": "curl https://{domain}/api/settings/{id}/logo -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
21892 "group": "Settings",
21893 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21894 "version": "0.0.0",
21895 "filename": "server/api/setting/index.js",
21896 "groupTitle": "Settings"
21900 "url": "/api/settings/{id}/logo_login",
21901 "title": "Add logo login",
21904 "title": "Example usage:",
21905 "content": "curl https://{domain}/api/settings/{id}/logo_login -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
21909 "name": "addLogoLogin",
21910 "group": "Settings",
21911 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21912 "version": "0.0.0",
21913 "filename": "server/api/setting/index.js",
21914 "groupTitle": "Settings"
21918 "url": "/api/settings/{id}/preferred",
21919 "title": "Add Preferred",
21922 "title": "Example usage:",
21923 "content": "curl https://{domain}/api/settings/{id}/preferred -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
21927 "name": "addPreferred",
21928 "group": "Settings",
21929 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21930 "version": "0.0.0",
21931 "filename": "server/api/setting/index.js",
21932 "groupTitle": "Settings"
21936 "url": "/api/settings/now",
21937 "title": "Get Server Current Date",
21940 "title": "Example usage:",
21941 "content": "curl https://{domain}/api/settings/now -v -X GET",
21946 "group": "Settings",
21947 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21948 "version": "0.0.0",
21949 "filename": "server/api/setting/index.js",
21950 "groupTitle": "Settings"
21954 "url": "/api/settings/{id}/favicon",
21955 "title": "Get Favicon",
21958 "title": "Example usage:",
21959 "content": "curl https://{domain}/api/settings/{id}/favicon -v -X GET",
21963 "name": "getFavicon",
21964 "group": "Settings",
21965 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21966 "version": "0.0.0",
21967 "filename": "server/api/setting/index.js",
21968 "groupTitle": "Settings"
21972 "url": "/api/settings/{id}/gdpr",
21973 "title": "Get gdpr settings",
21976 "title": "Example usage:",
21977 "content": "curl https://{domain}/api/settings/{id}/gdpr -v -u {name}:{password} -X GET",
21982 "group": "Settings",
21983 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21984 "version": "0.0.0",
21985 "filename": "server/api/setting/index.js",
21986 "groupTitle": "Settings"
21990 "url": "/api/settings/{id}/logo",
21991 "title": "Get logo",
21994 "title": "Example usage:",
21995 "content": "curl https://{domain}/api/settings/{id}/logo -v -X GET",
22000 "group": "Settings",
22001 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22002 "version": "0.0.0",
22003 "filename": "server/api/setting/index.js",
22004 "groupTitle": "Settings"
22008 "url": "/api/settings/{id}/logo_login",
22009 "title": "Get logo login",
22012 "title": "Example usage:",
22013 "content": "curl https://{domain}/api/settings/{id}/logo_login -v -X GET",
22017 "name": "getLogoLogin",
22018 "group": "Settings",
22019 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22020 "version": "0.0.0",
22021 "filename": "server/api/setting/index.js",
22022 "groupTitle": "Settings"
22026 "url": "/api/settings/{id}/preferred",
22027 "title": "Get Preferred",
22030 "title": "Example usage:",
22031 "content": "curl https://{domain}/api/settings/{id}/preferred -v -X GET",
22035 "name": "getPreferred",
22036 "group": "Settings",
22037 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22038 "version": "0.0.0",
22039 "filename": "server/api/setting/index.js",
22040 "groupTitle": "Settings"
22044 "url": "/api/settings/{id}",
22045 "title": "Update an existing Setting",
22048 "title": "Example usage:",
22049 "content": "curl https://{domain}/api/settings/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
22053 "name": "updateSettings",
22054 "group": "Settings",
22055 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22056 "version": "0.0.0",
22057 "filename": "server/api/setting/index.js",
22058 "groupTitle": "Settings"
22062 "url": "/api/sms/accounts/{id}/users",
22063 "title": "Add agents to a sms account",
22066 "title": "Example usage:",
22067 "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",
22071 "name": "AddAgents",
22072 "group": "Sms_Accounts",
22073 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22074 "version": "0.0.0",
22075 "filename": "server/api/smsAccount/index.js",
22076 "groupTitle": "Sms_Accounts"
22080 "url": "/api/sms/accounts",
22081 "title": "Creates a new Account",
22084 "title": "Example usage:",
22085 "content": "curl https://{domain}/api/sms/accounts -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
22089 "name": "CreateAccounts",
22090 "group": "Sms_Accounts",
22152 "field": "accountSid",
22166 "field": "authToken",
22178 "field": "smsMethod",
22185 "field": "username",
22192 "field": "password",
22206 "field": "applicationId",
22213 "field": "accountId",
22220 "field": "senderString",
22227 "field": "deliveryReport",
22234 "field": "description",
22241 "field": "notificationTemplate",
22248 "field": "notificationSound",
22255 "field": "notificationShake",
22262 "field": "waitForTheAssignedAgent",
22269 "field": "queueTransfer",
22276 "field": "queueTransferTimeout",
22283 "field": "agentTransfer",
22290 "field": "agentTransferTimeout",
22297 "field": "baseUrl",
22304 "field": "mandatoryDispositionPauseId",
22305 "description": "<p>Status to put when mandatory disposition is enabled</p>"
22311 "field": "mandatoryDisposition",
22312 "description": "<p>Enabled/disables mandatory dispo on a queue</p>"
22317 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22318 "version": "0.0.0",
22319 "filename": "server/api/smsAccount/index.js",
22320 "groupTitle": "Sms_Accounts"
22324 "url": "/api/sms/accounts/{id}",
22325 "title": "Deletes a Account",
22328 "title": "Example usage:",
22329 "content": "curl https://{domain}/api/sms/accounts/{id} -v -u {name}:{password} -X DELETE",
22333 "name": "DeleteAccounts",
22334 "group": "Sms_Accounts",
22335 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22336 "version": "0.0.0",
22337 "filename": "server/api/smsAccount/index.js",
22338 "groupTitle": "Sms_Accounts"
22342 "url": "/api/sms/accounts/describe",
22343 "title": "Gets table info about Accounts",
22346 "title": "Example usage:",
22347 "content": "curl https://{domain}/api/sms/accounts/describe -v -u {name}:{password}",
22351 "name": "DescribeAccounts",
22352 "group": "Sms_Accounts",
22353 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22354 "version": "0.0.0",
22355 "filename": "server/api/smsAccount/index.js",
22356 "groupTitle": "Sms_Accounts"
22360 "url": "/api/sms/accounts",
22361 "title": "Gets a list of Accounts",
22364 "title": "Example usage:",
22365 "content": "curl https://{domain}/api/sms/accounts -v -u {name}:{password}",
22369 "name": "GetAccounts",
22370 "group": "Sms_Accounts",
22371 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
22372 "version": "0.0.0",
22373 "filename": "server/api/smsAccount/index.js",
22374 "groupTitle": "Sms_Accounts"
22378 "url": "/api/sms/accounts/{id}/users",
22379 "title": "Gets agents from sms account",
22382 "title": "Example usage:",
22383 "content": "curl https://{domain}/api/sms/accounts/{id}/users -v -u {name}:{password} -X GET",
22387 "name": "GetAgents",
22388 "group": "Sms_Accounts",
22389 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22390 "version": "0.0.0",
22391 "filename": "server/api/smsAccount/index.js",
22392 "groupTitle": "Sms_Accounts"
22396 "url": "/api/sms/accounts/{id}/users",
22397 "title": "Removes agents from a sms account",
22400 "title": "Example usage:",
22401 "content": "curl https://{domain}/api/sms/accounts/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
22405 "name": "RemoveAgents",
22406 "group": "Sms_Accounts",
22407 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22408 "version": "0.0.0",
22409 "filename": "server/api/smsAccount/index.js",
22410 "groupTitle": "Sms_Accounts"
22414 "url": "/api/sms/accounts/{id}/canned_answers",
22415 "title": "Removes canned answers from account",
22418 "title": "Example usage:",
22419 "content": "curl https://{domain}/api/sms/accounts/{id}/canned_answers?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
22423 "name": "RemoveAnswers",
22424 "group": "Sms_Accounts",
22425 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22426 "version": "0.0.0",
22427 "filename": "server/api/smsAccount/index.js",
22428 "groupTitle": "Sms_Accounts"
22432 "url": "/api/sms/accounts/{id}/dispositions",
22433 "title": "Removes dispositions from account",
22436 "title": "Example usage:",
22437 "content": "curl https://{domain}/api/sms/accounts/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
22441 "name": "RemoveDispositions",
22442 "group": "Sms_Accounts",
22443 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22444 "version": "0.0.0",
22445 "filename": "server/api/smsAccount/index.js",
22446 "groupTitle": "Sms_Accounts"
22450 "url": "/api/sms/accounts/{id}",
22451 "title": "Gets a single Account",
22454 "title": "Example usage:",
22455 "content": "curl https://{domain}/api/sms/accounts/{id} -v -u {name}:{password}",
22459 "name": "ShowAccounts",
22460 "group": "Sms_Accounts",
22461 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22462 "version": "0.0.0",
22463 "filename": "server/api/smsAccount/index.js",
22464 "groupTitle": "Sms_Accounts"
22468 "url": "/api/sms/messages/{id}/accept",
22469 "title": "Accepts message",
22472 "title": "Example usage:",
22473 "content": "curl https://{domain}/api/sms/messages/{id}/accept \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
22477 "name": "acceptMessage",
22478 "group": "Sms_Accounts",
22479 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22480 "version": "0.0.0",
22481 "filename": "server/api/smsMessage/index.js",
22482 "groupTitle": "Sms_Accounts"
22486 "url": "/api/sms/accounts/{id}/canned_answers",
22487 "title": "Creates new canned answer",
22490 "title": "Example usage:",
22491 "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",
22495 "name": "addAnswer",
22496 "group": "Sms_Accounts",
22518 "field": "description",
22531 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22532 "version": "0.0.0",
22533 "filename": "server/api/smsAccount/index.js",
22534 "groupTitle": "Sms_Accounts"
22538 "url": "/api/sms/accounts/{id}/applications",
22539 "title": "Creates new applications",
22542 "title": "Example usage:",
22543 "content": "curl https://{domain}/api/sms/accounts/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
22547 "name": "addApplications",
22548 "group": "Sms_Accounts",
22556 "field": "priority",
22570 "field": "appdata",
22577 "field": "description",
22584 "field": "interval",
22590 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22591 "version": "0.0.0",
22592 "filename": "server/api/smsAccount/index.js",
22593 "groupTitle": "Sms_Accounts"
22597 "url": "/api/sms/accounts/{id}/dispositions",
22598 "title": "Creates new disposition",
22601 "title": "Example usage:",
22602 "content": "curl https://{domain}/api/sms/accounts/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
22606 "name": "addDisposition",
22607 "group": "Sms_Accounts",
22634 "field": "description",
22640 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22641 "version": "0.0.0",
22642 "filename": "server/api/smsAccount/index.js",
22643 "groupTitle": "Sms_Accounts"
22647 "url": "/api/sms/accounts/{id}/canned_answers",
22648 "title": "Gets account canned answers",
22651 "title": "Example usage:",
22652 "content": "curl https://{domain}/api/sms/accounts/{id}/canned_answers -v -u {name}:{password} -X GET",
22656 "name": "getAnswers",
22657 "group": "Sms_Accounts",
22658 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22659 "version": "0.0.0",
22660 "filename": "server/api/smsAccount/index.js",
22661 "groupTitle": "Sms_Accounts"
22665 "url": "/api/sms/accounts/{id}/applications",
22666 "title": "Gets account applications",
22669 "title": "Example usage:",
22670 "content": "curl https://{domain}/api/sms/accounts/{id}/applications -v -u {name}:{password} -X GET",
22674 "name": "getApplications",
22675 "group": "Sms_Accounts",
22676 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22677 "version": "0.0.0",
22678 "filename": "server/api/smsAccount/index.js",
22679 "groupTitle": "Sms_Accounts"
22683 "url": "/api/sms/accounts/{id}/dispositions",
22684 "title": "Gets account dispositions",
22687 "title": "Example usage:",
22688 "content": "curl https://{domain}/api/sms/accounts/{id}/dispositions -v -u {name}:{password} -X GET",
22692 "name": "getDispositions",
22693 "group": "Sms_Accounts",
22694 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22695 "version": "0.0.0",
22696 "filename": "server/api/smsAccount/index.js",
22697 "groupTitle": "Sms_Accounts"
22701 "url": "/api/sms/accounts/{id}/interactions",
22702 "title": "Gets Sms Account interactions",
22705 "title": "Example usage:",
22706 "content": "curl https://{domain}/api/sms/accounts/{id}/interactions -v -u {name}:{password} -X GET",
22710 "name": "getInteractions",
22711 "group": "Sms_Accounts",
22712 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22713 "version": "0.0.0",
22714 "filename": "server/api/smsAccount/index.js",
22715 "groupTitle": "Sms_Accounts"
22719 "url": "/api/sms/accounts/{id}/notify",
22720 "title": "Notify new message",
22723 "title": "Example usage:",
22724 "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",
22729 "group": "Sms_Accounts",
22730 "description": "<p>Motion 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>",
22731 "version": "0.0.0",
22732 "filename": "server/api/smsAccount/index.js",
22733 "groupTitle": "Sms_Accounts"
22737 "url": "/api/sms/messages/{id}/reject",
22738 "title": "Rejects message",
22741 "title": "Example usage:",
22742 "content": "curl https://{domain}/api/sms/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
22746 "name": "rejectMessage",
22747 "group": "Sms_Accounts",
22748 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22749 "version": "0.0.0",
22750 "filename": "server/api/smsMessage/index.js",
22751 "groupTitle": "Sms_Accounts"
22755 "url": "/api/sms/accounts/{id}/send",
22756 "title": "Send new sms message",
22759 "title": "Example usage:",
22760 "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",
22765 "group": "Sms_Accounts",
22766 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22767 "version": "0.0.0",
22768 "filename": "server/api/smsAccount/index.js",
22769 "groupTitle": "Sms_Accounts"
22773 "url": "/api/sms/accounts/{id}/status",
22774 "title": "Receive message status as get request",
22777 "title": "Example usage:",
22778 "content": "curl https://{domain}/api/sms/accounts/{id}/status -H 'Content-Type: application/json' -v -X GET",
22782 "name": "statusMessage",
22783 "group": "Sms_Accounts",
22784 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22785 "version": "0.0.0",
22786 "filename": "server/api/smsAccount/index.js",
22787 "groupTitle": "Sms_Accounts"
22791 "url": "/api/sms/messages/{id}/status",
22792 "title": "Receive message status",
22795 "title": "Example usage:",
22796 "content": "curl https://{domain}/api/sms/messages/{id}/status \\ \n -H 'Content-Type: application/json' -v -X POST",
22800 "name": "statusMessage",
22801 "group": "Sms_Accounts",
22802 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22803 "version": "0.0.0",
22804 "filename": "server/api/smsMessage/index.js",
22805 "groupTitle": "Sms_Accounts"
22809 "url": "/api/sms/accounts/{id}/status",
22810 "title": "Receive message status",
22813 "title": "Example usage:",
22814 "content": "curl https://{domain}/api/sms/accounts/{id}/status -H 'Content-Type: application/json' -v -X POST",
22818 "name": "statusMessage",
22819 "group": "Sms_Accounts",
22820 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22821 "version": "0.0.0",
22822 "filename": "server/api/smsAccount/index.js",
22823 "groupTitle": "Sms_Accounts"
22827 "url": "/api/sms/accounts/{id}",
22828 "title": "Update an existing Account",
22831 "title": "Example usage:",
22832 "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",
22836 "name": "updateAccounts",
22837 "group": "Sms_Accounts",
22838 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22839 "version": "0.0.0",
22840 "filename": "server/api/smsAccount/index.js",
22841 "groupTitle": "Sms_Accounts"
22845 "url": "/api/sms/applications",
22846 "title": "Creates a new Application",
22849 "title": "Example usage:",
22850 "content": "curl https://{domain}/api/sms/applications -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
22854 "name": "CreateApplications",
22855 "group": "Sms_Applications",
22863 "field": "priority",
22877 "field": "appdata",
22884 "field": "description",
22891 "field": "interval",
22897 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22898 "version": "0.0.0",
22899 "filename": "server/api/smsApplication/index.js",
22900 "groupTitle": "Sms_Applications"
22904 "url": "/api/sms/applications/{id}",
22905 "title": "Deletes a Application",
22908 "title": "Example usage:",
22909 "content": "curl https://{domain}/api/sms/applications/{id} -v -u {name}:{password} -X DELETE",
22913 "name": "DeleteApplications",
22914 "group": "Sms_Applications",
22915 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22916 "version": "0.0.0",
22917 "filename": "server/api/smsApplication/index.js",
22918 "groupTitle": "Sms_Applications"
22922 "url": "/api/sms/applications",
22923 "title": "Gets a list of Applications",
22926 "title": "Example usage:",
22927 "content": "curl https://{domain}/api/sms/applications -v -u {name}:{password}",
22931 "name": "GetApplications",
22932 "group": "Sms_Applications",
22933 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
22934 "version": "0.0.0",
22935 "filename": "server/api/smsApplication/index.js",
22936 "groupTitle": "Sms_Applications"
22940 "url": "/api/sms/applications/{id}",
22941 "title": "Gets a single Application",
22944 "title": "Example usage:",
22945 "content": "curl https://{domain}/api/sms/applications/{id} -v -u {name}:{password}",
22949 "name": "ShowApplications",
22950 "group": "Sms_Applications",
22951 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22952 "version": "0.0.0",
22953 "filename": "server/api/smsApplication/index.js",
22954 "groupTitle": "Sms_Applications"
22958 "url": "/api/sms/applications/{id}",
22959 "title": "Update an existing Application",
22962 "title": "Example usage:",
22963 "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",
22967 "name": "updateApplications",
22968 "group": "Sms_Applications",
22969 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22970 "version": "0.0.0",
22971 "filename": "server/api/smsApplication/index.js",
22972 "groupTitle": "Sms_Applications"
22976 "url": "/api/sms/interactions/{id}/tags",
22977 "title": "Add tags to the interaction",
22980 "title": "Example usage:",
22981 "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",
22986 "group": "Sms_Interactions",
22987 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22988 "version": "0.0.0",
22989 "filename": "server/api/smsInteraction/index.js",
22990 "groupTitle": "Sms_Interactions"
22994 "url": "/api/sms/interactions",
22995 "title": "Creates a new Interaction",
22998 "title": "Example usage:",
22999 "content": "curl https://{domain}/api/sms/interactions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
23003 "name": "CreateInteractions",
23004 "group": "Sms_Interactions",
23019 "field": "closedAt",
23026 "field": "disposition",
23033 "field": "secondDisposition",
23040 "field": "thirdDisposition",
23061 "field": "read1stAt",
23072 "field": "firstMsgDirection",
23079 "field": "lastMsgAt",
23090 "field": "lastMsgDirection",
23096 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23097 "version": "0.0.0",
23098 "filename": "server/api/smsInteraction/index.js",
23099 "groupTitle": "Sms_Interactions"
23103 "url": "/api/sms/interactions/{id}",
23104 "title": "Deletes a Interaction",
23107 "title": "Example usage:",
23108 "content": "curl https://{domain}/api/sms/interactions/{id} -v -u {name}:{password} -X DELETE",
23112 "name": "DeleteInteractions",
23113 "group": "Sms_Interactions",
23114 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23115 "version": "0.0.0",
23116 "filename": "server/api/smsInteraction/index.js",
23117 "groupTitle": "Sms_Interactions"
23121 "url": "/api/sms/interactions/describe",
23122 "title": "Gets table info about Interactions",
23125 "title": "Example usage:",
23126 "content": "curl https://{domain}/api/sms/interactions/describe -v -u {name}:{password}",
23130 "name": "DescribeInteractions",
23131 "group": "Sms_Interactions",
23132 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23133 "version": "0.0.0",
23134 "filename": "server/api/smsInteraction/index.js",
23135 "groupTitle": "Sms_Interactions"
23139 "url": "/api/sms/interactions",
23140 "title": "Gets a list of Interactions",
23143 "title": "Example usage:",
23144 "content": "curl https://{domain}/api/sms/interactions -v -u {name}:{password}",
23148 "name": "GetInteractions",
23149 "group": "Sms_Interactions",
23150 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
23151 "version": "0.0.0",
23152 "filename": "server/api/smsInteraction/index.js",
23153 "groupTitle": "Sms_Interactions"
23157 "url": "/api/sms/interactions/{id}/tags",
23158 "title": "Removes tags from interaction",
23161 "title": "Example usage:",
23162 "content": "curl https://{domain}/api/sms/interactions/{id}/tags?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
23166 "name": "RemoveTags",
23167 "group": "Sms_Interactions",
23168 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23169 "version": "0.0.0",
23170 "filename": "server/api/smsInteraction/index.js",
23171 "groupTitle": "Sms_Interactions"
23175 "url": "/api/sms/interactions/{id}",
23176 "title": "Gets a single Interaction",
23179 "title": "Example usage:",
23180 "content": "curl https://{domain}/api/sms/interactions/{id} -v -u {name}:{password}",
23184 "name": "ShowInteractions",
23185 "group": "Sms_Interactions",
23186 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23187 "version": "0.0.0",
23188 "filename": "server/api/smsInteraction/index.js",
23189 "groupTitle": "Sms_Interactions"
23193 "url": "/api/sms/interactions/{id}/messages",
23194 "title": "Creates new messages",
23197 "title": "Example usage:",
23198 "content": "curl https://{domain}/api/sms/interactions/{id}/messages -d '[{\"to\": \"+3901119886500\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
23202 "name": "addMessage",
23203 "group": "Sms_Interactions",
23229 "field": "direction",
23236 "field": "messageId",
23264 "field": "providerName",
23271 "field": "providerResponse",
23277 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23278 "version": "0.0.0",
23279 "filename": "server/api/smsInteraction/index.js",
23280 "groupTitle": "Sms_Interactions"
23284 "url": "/api/sms/interactions/{id}/download",
23285 "title": "Gets interaction",
23288 "title": "Example usage:",
23289 "content": "curl https://{domain}/api/sms/interactions/{id}/download -v -u {name}:{password} -X GET",
23293 "name": "download",
23294 "group": "Sms_Interactions",
23295 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23296 "version": "0.0.0",
23297 "filename": "server/api/smsInteraction/index.js",
23298 "groupTitle": "Sms_Interactions"
23302 "url": "/api/sms/interactions/{id}/messages",
23303 "title": "Gets interaction messages",
23306 "title": "Example usage:",
23307 "content": "curl https://{domain}/api/sms/interactions/{id}/messages -v -u {name}:{password} -X GET",
23311 "name": "getMessages",
23312 "group": "Sms_Interactions",
23313 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23314 "version": "0.0.0",
23315 "filename": "server/api/smsInteraction/index.js",
23316 "groupTitle": "Sms_Interactions"
23320 "url": "/api/sms/interactions/{id}",
23321 "title": "Update an existing Interaction",
23324 "title": "Example usage:",
23325 "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",
23329 "name": "updateInteractions",
23330 "group": "Sms_Interactions",
23331 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23332 "version": "0.0.0",
23333 "filename": "server/api/smsInteraction/index.js",
23334 "groupTitle": "Sms_Interactions"
23338 "url": "/api/sms/messages",
23339 "title": "Creates a new Message",
23342 "title": "Example usage:",
23343 "content": "curl https://{domain}/api/sms/messages -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
23347 "name": "CreateMessages",
23348 "group": "Sms_Messages",
23374 "field": "direction",
23381 "field": "messageId",
23409 "field": "providerName",
23416 "field": "providerResponse",
23422 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23423 "version": "0.0.0",
23424 "filename": "server/api/smsMessage/index.js",
23425 "groupTitle": "Sms_Messages"
23429 "url": "/api/sms/messages/{id}",
23430 "title": "Deletes a Message",
23433 "title": "Example usage:",
23434 "content": "curl https://{domain}/api/sms/messages/{id} -v -u {name}:{password} -X DELETE",
23438 "name": "DeleteMessages",
23439 "group": "Sms_Messages",
23440 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23441 "version": "0.0.0",
23442 "filename": "server/api/smsMessage/index.js",
23443 "groupTitle": "Sms_Messages"
23447 "url": "/api/sms/messages/describe",
23448 "title": "Gets table info about Messages",
23451 "title": "Example usage:",
23452 "content": "curl https://{domain}/api/sms/messages/describe -v -u {name}:{password}",
23456 "name": "DescribeMessages",
23457 "group": "Sms_Messages",
23458 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23459 "version": "0.0.0",
23460 "filename": "server/api/smsMessage/index.js",
23461 "groupTitle": "Sms_Messages"
23465 "url": "/api/sms/messages",
23466 "title": "Gets a list of Messages",
23469 "title": "Example usage:",
23470 "content": "curl https://{domain}/api/sms/messages -v -u {name}:{password}",
23474 "name": "GetMessages",
23475 "group": "Sms_Messages",
23476 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
23477 "version": "0.0.0",
23478 "filename": "server/api/smsMessage/index.js",
23479 "groupTitle": "Sms_Messages"
23483 "url": "/api/sms/messages/{id}",
23484 "title": "Gets a single Message",
23487 "title": "Example usage:",
23488 "content": "curl https://{domain}/api/sms/messages/{id} -v -u {name}:{password}",
23492 "name": "ShowMessages",
23493 "group": "Sms_Messages",
23494 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23495 "version": "0.0.0",
23496 "filename": "server/api/smsMessage/index.js",
23497 "groupTitle": "Sms_Messages"
23501 "url": "/api/sms/messages/{id}",
23502 "title": "Update an existing Message",
23505 "title": "Example usage:",
23506 "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",
23510 "name": "updateMessages",
23511 "group": "Sms_Messages",
23512 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23513 "version": "0.0.0",
23514 "filename": "server/api/smsMessage/index.js",
23515 "groupTitle": "Sms_Messages"
23519 "url": "/api/sms/reports/queue",
23520 "title": "Creates a new Sms Queue Report",
23523 "title": "Example usage:",
23524 "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",
23528 "name": "CreateSms_Queue_Reports",
23529 "group": "Sms_Queue_Reports",
23537 "field": "uniqueid",
23558 "field": "leaveAt",
23565 "field": "acceptAt",
23585 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23586 "version": "0.0.0",
23587 "filename": "server/api/smsQueueReport/index.js",
23588 "groupTitle": "Sms_Queue_Reports"
23592 "url": "/api/sms/reports/queue/{id}",
23593 "title": "Deletes a Sms Queue Report",
23596 "title": "Example usage:",
23597 "content": "curl https://{domain}/api/sms/reports/queue/{id} -v -u {name}:{password} -X DELETE",
23601 "name": "DeleteSms_Queue_Reports",
23602 "group": "Sms_Queue_Reports",
23603 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23604 "version": "0.0.0",
23605 "filename": "server/api/smsQueueReport/index.js",
23606 "groupTitle": "Sms_Queue_Reports"
23610 "url": "/api/sms/reports/queue/describe",
23611 "title": "Gets table info about Sms Queue Reports",
23614 "title": "Example usage:",
23615 "content": "curl https://{domain}/api/sms/reports/queue/describe -v -u {name}:{password}",
23619 "name": "DescribeSms_Queue_Reports",
23620 "group": "Sms_Queue_Reports",
23621 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23622 "version": "0.0.0",
23623 "filename": "server/api/smsQueueReport/index.js",
23624 "groupTitle": "Sms_Queue_Reports"
23628 "url": "/api/sms/reports/queue",
23629 "title": "Gets a list of Sms Queue Reports",
23632 "title": "Example usage:",
23633 "content": "curl https://{domain}/api/sms/reports/queue -v -u {name}:{password}",
23637 "name": "GetSms_Queue_Reports",
23638 "group": "Sms_Queue_Reports",
23639 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
23640 "version": "0.0.0",
23641 "filename": "server/api/smsQueueReport/index.js",
23642 "groupTitle": "Sms_Queue_Reports"
23646 "url": "/api/sms/reports/queue/{id}",
23647 "title": "Gets a single Sms Queue Report",
23650 "title": "Example usage:",
23651 "content": "curl https://{domain}/api/sms/reports/queue/{id} -v -u {name}:{password}",
23655 "name": "ShowSms_Queue_Reports",
23656 "group": "Sms_Queue_Reports",
23657 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23658 "version": "0.0.0",
23659 "filename": "server/api/smsQueueReport/index.js",
23660 "groupTitle": "Sms_Queue_Reports"
23664 "url": "/api/sms/reports/queue/{id}",
23665 "title": "Update an existing Sms Queue Report",
23668 "title": "Example usage:",
23669 "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",
23673 "name": "updateSms_Queue_Reports",
23674 "group": "Sms_Queue_Reports",
23675 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23676 "version": "0.0.0",
23677 "filename": "server/api/smsQueueReport/index.js",
23678 "groupTitle": "Sms_Queue_Reports"
23682 "url": "/api/sms/queues/{id}/users",
23683 "title": "Add agents to a queue",
23686 "title": "Example usage:",
23687 "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",
23691 "name": "AddAgents",
23692 "group": "Sms_Queues",
23693 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23694 "version": "0.0.0",
23695 "filename": "server/api/smsQueue/index.js",
23696 "groupTitle": "Sms_Queues"
23700 "url": "/api/sms/queues/{id}/teams",
23701 "title": "Add teams to a queue",
23704 "title": "Example usage:",
23705 "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",
23709 "name": "AddTeams",
23710 "group": "Sms_Queues",
23711 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23712 "version": "0.0.0",
23713 "filename": "server/api/smsQueue/index.js",
23714 "groupTitle": "Sms_Queues"
23718 "url": "/api/sms/queues",
23719 "title": "Creates a new Queue",
23722 "title": "Example usage:",
23723 "content": "curl https://{domain}/api/sms/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
23727 "name": "CreateQueues",
23728 "group": "Sms_Queues",
23743 "field": "description",
23750 "field": "timeout",
23762 "field": "strategy",
23768 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23769 "version": "0.0.0",
23770 "filename": "server/api/smsQueue/index.js",
23771 "groupTitle": "Sms_Queues"
23775 "url": "/api/sms/queues/{id}",
23776 "title": "Deletes a Queue",
23779 "title": "Example usage:",
23780 "content": "curl https://{domain}/api/sms/queues/{id} -v -u {name}:{password} -X DELETE",
23784 "name": "DeleteQueues",
23785 "group": "Sms_Queues",
23786 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23787 "version": "0.0.0",
23788 "filename": "server/api/smsQueue/index.js",
23789 "groupTitle": "Sms_Queues"
23793 "url": "/api/sms/queues/describe",
23794 "title": "Gets table info about Queues",
23797 "title": "Example usage:",
23798 "content": "curl https://{domain}/api/sms/queues/describe -v -u {name}:{password}",
23802 "name": "DescribeQueues",
23803 "group": "Sms_Queues",
23804 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23805 "version": "0.0.0",
23806 "filename": "server/api/smsQueue/index.js",
23807 "groupTitle": "Sms_Queues"
23811 "url": "/api/sms/queues/{id}/users",
23812 "title": "Gets queue agents",
23815 "title": "Example usage:",
23816 "content": "curl https://{domain}/api/sms/queues/{id}/users -v -u {name}:{password} -X POST",
23820 "name": "GetAgents",
23821 "group": "Sms_Queues",
23822 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23823 "version": "0.0.0",
23824 "filename": "server/api/smsQueue/index.js",
23825 "groupTitle": "Sms_Queues"
23829 "url": "/api/sms/queues/{id}/members",
23830 "title": "GetMembers",
23833 "title": "Example usage:",
23834 "content": "curl https://{domain}/api/sms/queues/{id}/members -v -u {name}:{password}",
23838 "name": "GetMembers",
23839 "group": "Sms_Queues",
23840 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23841 "version": "0.0.0",
23842 "filename": "server/api/smsQueue/index.js",
23843 "groupTitle": "Sms_Queues"
23847 "url": "/api/sms/queues",
23848 "title": "Gets a list of Queues",
23851 "title": "Example usage:",
23852 "content": "curl https://{domain}/api/sms/queues -v -u {name}:{password}",
23856 "name": "GetQueues",
23857 "group": "Sms_Queues",
23858 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
23859 "version": "0.0.0",
23860 "filename": "server/api/smsQueue/index.js",
23861 "groupTitle": "Sms_Queues"
23865 "url": "/api/sms/queues/{id}/teams",
23866 "title": "Gets queues list",
23869 "title": "Example usage:",
23870 "content": "curl https://{domain}/api/sms/queues/{id}/teams -v -u {name}:{password}",
23874 "name": "GetTeams",
23875 "group": "Sms_Queues",
23876 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23877 "version": "0.0.0",
23878 "filename": "server/api/smsQueue/index.js",
23879 "groupTitle": "Sms_Queues"
23883 "url": "/api/sms/queues/{id}/users",
23884 "title": "Removes agents from a queue",
23887 "title": "Example usage:",
23888 "content": "curl https://{domain}/api/sms/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
23892 "name": "RemoveAgents",
23893 "group": "Sms_Queues",
23894 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23895 "version": "0.0.0",
23896 "filename": "server/api/smsQueue/index.js",
23897 "groupTitle": "Sms_Queues"
23901 "url": "/api/sms/queues/{id}",
23902 "title": "Gets a single Queue",
23905 "title": "Example usage:",
23906 "content": "curl https://{domain}/api/sms/queues/{id} -v -u {name}:{password}",
23910 "name": "ShowQueues",
23911 "group": "Sms_Queues",
23912 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23913 "version": "0.0.0",
23914 "filename": "server/api/smsQueue/index.js",
23915 "groupTitle": "Sms_Queues"
23919 "url": "/api/sms/queues/{id}",
23920 "title": "Update an existing Queue",
23923 "title": "Example usage:",
23924 "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",
23928 "name": "updateQueues",
23929 "group": "Sms_Queues",
23930 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23931 "version": "0.0.0",
23932 "filename": "server/api/smsQueue/index.js",
23933 "groupTitle": "Sms_Queues"
23937 "url": "/api/sms/reports/transfer",
23938 "title": "Creates a new Sms Transfer Report",
23941 "title": "Example usage:",
23942 "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",
23946 "name": "CreateSms_Transfer_Reports",
23947 "group": "Sms_Transfer_Reports",
23955 "field": "uniqueid",
23974 "field": "transferredAt",
23980 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23981 "version": "0.0.0",
23982 "filename": "server/api/smsTransferReport/index.js",
23983 "groupTitle": "Sms_Transfer_Reports"
23987 "url": "/api/sms/reports/transfer/{id}",
23988 "title": "Deletes a Sms Transfer Report",
23991 "title": "Example usage:",
23992 "content": "curl https://{domain}/api/sms/reports/transfer/{id} -v -u {name}:{password} -X DELETE",
23996 "name": "DeleteSms_Transfer_Reports",
23997 "group": "Sms_Transfer_Reports",
23998 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23999 "version": "0.0.0",
24000 "filename": "server/api/smsTransferReport/index.js",
24001 "groupTitle": "Sms_Transfer_Reports"
24005 "url": "/api/sms/reports/transfer/describe",
24006 "title": "Gets table info about Sms Transfer Reports",
24009 "title": "Example usage:",
24010 "content": "curl https://{domain}/api/sms/reports/transfer/describe -v -u {name}:{password}",
24014 "name": "DescribeSms_Transfer_Reports",
24015 "group": "Sms_Transfer_Reports",
24016 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24017 "version": "0.0.0",
24018 "filename": "server/api/smsTransferReport/index.js",
24019 "groupTitle": "Sms_Transfer_Reports"
24023 "url": "/api/sms/reports/transfer",
24024 "title": "Gets a list of Sms Transfer Reports",
24027 "title": "Example usage:",
24028 "content": "curl https://{domain}/api/sms/reports/transfer -v -u {name}:{password}",
24032 "name": "GetSms_Transfer_Reports",
24033 "group": "Sms_Transfer_Reports",
24034 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
24035 "version": "0.0.0",
24036 "filename": "server/api/smsTransferReport/index.js",
24037 "groupTitle": "Sms_Transfer_Reports"
24041 "url": "/api/sms/reports/transfer/{id}",
24042 "title": "Gets a single Sms Transfer Report",
24045 "title": "Example usage:",
24046 "content": "curl https://{domain}/api/sms/reports/transfer/{id} -v -u {name}:{password}",
24050 "name": "ShowSms_Transfer_Reports",
24051 "group": "Sms_Transfer_Reports",
24052 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24053 "version": "0.0.0",
24054 "filename": "server/api/smsTransferReport/index.js",
24055 "groupTitle": "Sms_Transfer_Reports"
24059 "url": "/api/sms/reports/transfer/{id}",
24060 "title": "Update an existing Sms Transfer Report",
24063 "title": "Example usage:",
24064 "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",
24068 "name": "updateSms_Transfer_Reports",
24069 "group": "Sms_Transfer_Reports",
24070 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24071 "version": "0.0.0",
24072 "filename": "server/api/smsTransferReport/index.js",
24073 "groupTitle": "Sms_Transfer_Reports"
24077 "url": "/api/sounds",
24078 "title": "Gets a list of Sounds",
24081 "title": "Example usage:",
24082 "content": "curl https://{domain}/api/sounds -v -u {name}:{password}",
24086 "name": "GetSounds",
24088 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
24089 "version": "0.0.0",
24090 "filename": "server/api/sound/index.js",
24091 "groupTitle": "Sounds"
24095 "url": "/api/sounds/{id}",
24096 "title": "Gets a single Sound",
24099 "title": "Example usage:",
24100 "content": "curl https://{domain}/api/sounds/{id} -v -u {name}:{password}",
24104 "name": "ShowSounds",
24106 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24107 "version": "0.0.0",
24108 "filename": "server/api/sound/index.js",
24109 "groupTitle": "Sounds"
24113 "url": "/api/sounds",
24114 "title": "Create a new sound",
24117 "title": "Example usage:",
24118 "content": "curl https://{domain}/api/sounds -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
24122 "name": "addSound",
24124 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24125 "version": "0.0.0",
24126 "filename": "server/api/sound/index.js",
24127 "groupTitle": "Sounds"
24131 "url": "/api/sounds/{id}",
24132 "title": "Deletes a sound",
24135 "title": "Example usage:",
24136 "content": "curl https://{domain}/api/sounds/{id} -v -u {name}:{password} -X DELETE",
24140 "name": "destroySound",
24142 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24143 "version": "0.0.0",
24144 "filename": "server/api/sound/index.js",
24145 "groupTitle": "Sounds"
24149 "url": "/api/sounds/{id}/download",
24150 "title": "Download Sound",
24153 "title": "Example usage:",
24154 "content": "curl https://{domain}/api/sounds/{id}/download -v -u {name}:{password} -X GET",
24158 "name": "download",
24160 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24161 "version": "0.0.0",
24162 "filename": "server/api/sound/index.js",
24163 "groupTitle": "Sounds"
24167 "url": "/api/sounds",
24168 "title": "Update an existing new sound",
24171 "title": "Example usage:",
24172 "content": "curl https://{domain}/api/sounds -d '[\"name\": \"sound_name\", \"description\": \"sound_desc\"]' -v -u {name}:{password} -X PUT",
24176 "name": "updateSound",
24178 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24179 "version": "0.0.0",
24180 "filename": "server/api/sound/index.js",
24181 "groupTitle": "Sounds"
24185 "url": "/api/square/details/reports",
24186 "title": "Creates a new Square Detail Report",
24189 "title": "Example usage:",
24190 "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",
24194 "name": "CreateSquare_Detail_Reports",
24195 "group": "Square_Details_Reports",
24203 "field": "uniqueid",
24217 "field": "application",
24231 "field": "project_name",
24238 "field": "callerid",
24244 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24245 "version": "0.0.0",
24246 "filename": "server/api/squareReportDetail/index.js",
24247 "groupTitle": "Square_Details_Reports"
24251 "url": "/api/square/details/reports/{id}",
24252 "title": "Deletes a Square Detail Report",
24255 "title": "Example usage:",
24256 "content": "curl https://{domain}/api/square/details/reports/{id} -v -u {name}:{password} -X DELETE",
24260 "name": "DeleteSquare_Detail_Reports",
24261 "group": "Square_Details_Reports",
24262 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24263 "version": "0.0.0",
24264 "filename": "server/api/squareReportDetail/index.js",
24265 "groupTitle": "Square_Details_Reports"
24269 "url": "/api/square/details/reports/describe",
24270 "title": "Gets table info about Square Detail Reports",
24273 "title": "Example usage:",
24274 "content": "curl https://{domain}/api/square/details/reports/describe -v -u {name}:{password}",
24278 "name": "DescribeSquare_Detail_Reports",
24279 "group": "Square_Details_Reports",
24280 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24281 "version": "0.0.0",
24282 "filename": "server/api/squareReportDetail/index.js",
24283 "groupTitle": "Square_Details_Reports"
24287 "url": "/api/square/details/reports",
24288 "title": "Gets a list of Square Detail Reports",
24291 "title": "Example usage:",
24292 "content": "curl https://{domain}/api/square/details/reports -v -u {name}:{password}",
24296 "name": "GetSquare_Detail_Reports",
24297 "group": "Square_Details_Reports",
24298 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
24299 "version": "0.0.0",
24300 "filename": "server/api/squareReportDetail/index.js",
24301 "groupTitle": "Square_Details_Reports"
24305 "url": "/api/square/details/reports/{id}",
24306 "title": "Gets a single Square Detail Report",
24309 "title": "Example usage:",
24310 "content": "curl https://{domain}/api/square/details/reports/{id} -v -u {name}:{password}",
24314 "name": "ShowSquare_Detail_Reports",
24315 "group": "Square_Details_Reports",
24316 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24317 "version": "0.0.0",
24318 "filename": "server/api/squareReportDetail/index.js",
24319 "groupTitle": "Square_Details_Reports"
24323 "url": "/api/square/details/reports/{id}",
24324 "title": "Update an existing Square Detail Report",
24327 "title": "Example usage:",
24328 "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",
24332 "name": "updateSquare_Detail_Reports",
24333 "group": "Square_Details_Reports",
24334 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24335 "version": "0.0.0",
24336 "filename": "server/api/squareReportDetail/index.js",
24337 "groupTitle": "Square_Details_Reports"
24341 "url": "/api/square/messages",
24342 "title": "Creates a new Message",
24345 "title": "Example usage:",
24346 "content": "curl https://{domain}/api/square/messages -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
24350 "name": "CreateMessages",
24351 "group": "Square_Messages",
24359 "field": "uniqueid",
24377 "field": "direction",
24384 "field": "providerName",
24391 "field": "providerResponse",
24397 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24398 "version": "0.0.0",
24399 "filename": "server/api/squareMessage/index.js",
24400 "groupTitle": "Square_Messages"
24404 "url": "/api/square/messages/{id}",
24405 "title": "Deletes a Message",
24408 "title": "Example usage:",
24409 "content": "curl https://{domain}/api/square/messages/{id} -v -u {name}:{password} -X DELETE",
24413 "name": "DeleteMessages",
24414 "group": "Square_Messages",
24415 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24416 "version": "0.0.0",
24417 "filename": "server/api/squareMessage/index.js",
24418 "groupTitle": "Square_Messages"
24422 "url": "/api/square/messages",
24423 "title": "Gets a list of Messages",
24426 "title": "Example usage:",
24427 "content": "curl https://{domain}/api/square/messages -v -u {name}:{password}",
24431 "name": "GetMessages",
24432 "group": "Square_Messages",
24433 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
24434 "version": "0.0.0",
24435 "filename": "server/api/squareMessage/index.js",
24436 "groupTitle": "Square_Messages"
24440 "url": "/api/square/messages/{id}",
24441 "title": "Gets a single Message",
24444 "title": "Example usage:",
24445 "content": "curl https://{domain}/api/square/messages/{id} -v -u {name}:{password}",
24449 "name": "ShowMessages",
24450 "group": "Square_Messages",
24451 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24452 "version": "0.0.0",
24453 "filename": "server/api/squareMessage/index.js",
24454 "groupTitle": "Square_Messages"
24458 "url": "/api/square/messages/{id}",
24459 "title": "Update an existing Message",
24462 "title": "Example usage:",
24463 "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",
24467 "name": "updateMessages",
24468 "group": "Square_Messages",
24469 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24470 "version": "0.0.0",
24471 "filename": "server/api/squareMessage/index.js",
24472 "groupTitle": "Square_Messages"
24476 "url": "/api/square/odbc",
24477 "title": "Creates a new ODBC",
24480 "title": "Example usage:",
24481 "content": "curl https://{domain}/api/square/odbc -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
24485 "name": "CreateODBCs",
24486 "group": "Square_ODBC",
24508 "field": "description",
24514 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24515 "version": "0.0.0",
24516 "filename": "server/api/squareOdbc/index.js",
24517 "groupTitle": "Square_ODBC"
24521 "url": "/api/square/odbc/{id}",
24522 "title": "Deletes a ODBC",
24525 "title": "Example usage:",
24526 "content": "curl https://{domain}/api/square/odbc/{id} -v -u {name}:{password} -X DELETE",
24530 "name": "DeleteODBCs",
24531 "group": "Square_ODBC",
24532 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24533 "version": "0.0.0",
24534 "filename": "server/api/squareOdbc/index.js",
24535 "groupTitle": "Square_ODBC"
24539 "url": "/api/square/odbc",
24540 "title": "Gets a list of ODBCs",
24543 "title": "Example usage:",
24544 "content": "curl https://{domain}/api/square/odbc -v -u {name}:{password}",
24548 "name": "GetODBCs",
24549 "group": "Square_ODBC",
24550 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
24551 "version": "0.0.0",
24552 "filename": "server/api/squareOdbc/index.js",
24553 "groupTitle": "Square_ODBC"
24557 "url": "/api/square/odbc/{id}",
24558 "title": "Gets a single ODBC",
24561 "title": "Example usage:",
24562 "content": "curl https://{domain}/api/square/odbc/{id} -v -u {name}:{password}",
24566 "name": "ShowODBCs",
24567 "group": "Square_ODBC",
24568 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24569 "version": "0.0.0",
24570 "filename": "server/api/squareOdbc/index.js",
24571 "groupTitle": "Square_ODBC"
24575 "url": "/api/square/odbc/{id}/test",
24576 "title": "Test Odbc",
24579 "title": "Example usage:",
24580 "content": "curl https://{domain}/api/square/odbc/{id}/test -v -u {name}:{password} -X GET",
24585 "group": "Square_ODBC",
24586 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24587 "version": "0.0.0",
24588 "filename": "server/api/squareOdbc/index.js",
24589 "groupTitle": "Square_ODBC"
24593 "url": "/api/square/odbc/{id}",
24594 "title": "Update an existing ODBC",
24597 "title": "Example usage:",
24598 "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",
24602 "name": "updateODBCs",
24603 "group": "Square_ODBC",
24604 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24605 "version": "0.0.0",
24606 "filename": "server/api/squareOdbc/index.js",
24607 "groupTitle": "Square_ODBC"
24611 "url": "/api/square/projects",
24612 "title": "Creates a new Project",
24615 "title": "Example usage:",
24616 "content": "curl https://{domain}/api/square/projects -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
24620 "name": "CreateProjects",
24621 "group": "Square_Projects",
24636 "field": "description",
24650 "field": "preproduction",
24657 "field": "production",
24664 "field": "savedAt",
24671 "field": "publishedAt",
24677 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24678 "version": "0.0.0",
24679 "filename": "server/api/squareProject/index.js",
24680 "groupTitle": "Square_Projects"
24684 "url": "/api/square/projects/{id}",
24685 "title": "Deletes a Project",
24688 "title": "Example usage:",
24689 "content": "curl https://{domain}/api/square/projects/{id} -v -u {name}:{password} -X DELETE",
24693 "name": "DeleteProjects",
24694 "group": "Square_Projects",
24695 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24696 "version": "0.0.0",
24697 "filename": "server/api/squareProject/index.js",
24698 "groupTitle": "Square_Projects"
24702 "url": "/api/square/projects",
24703 "title": "Gets a list of Projects",
24706 "title": "Example usage:",
24707 "content": "curl https://{domain}/api/square/projects -v -u {name}:{password}",
24711 "name": "GetProjects",
24712 "group": "Square_Projects",
24713 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
24714 "version": "0.0.0",
24715 "filename": "server/api/squareProject/index.js",
24716 "groupTitle": "Square_Projects"
24720 "url": "/api/square/projects/{id}",
24721 "title": "Gets a single Project",
24724 "title": "Example usage:",
24725 "content": "curl https://{domain}/api/square/projects/{id} -v -u {name}:{password}",
24729 "name": "ShowProjects",
24730 "group": "Square_Projects",
24731 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24732 "version": "0.0.0",
24733 "filename": "server/api/squareProject/index.js",
24734 "groupTitle": "Square_Projects"
24738 "url": "/api/square/projects/{id}/users",
24739 "title": "Adds user permissions to a Project",
24742 "title": "Example usage:",
24743 "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",
24747 "name": "addUsers",
24748 "group": "Square_Projects",
24749 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24750 "version": "0.0.0",
24751 "filename": "server/api/squareProject/index.js",
24752 "groupTitle": "Square_Projects"
24756 "url": "/api/square/projects/{id}/users",
24757 "title": "Gets users permissions from Project",
24760 "title": "Example usage:",
24761 "content": "curl https://{domain}/api/square/projects/{id}/users -v -u {name}:{password} -X GET",
24765 "name": "getUsers",
24766 "group": "Square_Projects",
24767 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24768 "version": "0.0.0",
24769 "filename": "server/api/squareProject/index.js",
24770 "groupTitle": "Square_Projects"
24774 "url": "/api/square/projects/{id}/users",
24775 "title": "Removes user permissions from a Project",
24778 "title": "Example usage:",
24779 "content": "curl https://{domain}/api/square/projects/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
24783 "name": "removeUsers",
24784 "group": "Square_Projects",
24785 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24786 "version": "0.0.0",
24787 "filename": "server/api/squareProject/index.js",
24788 "groupTitle": "Square_Projects"
24792 "url": "/api/square/projects/{id}",
24793 "title": "Update an existing Project",
24796 "title": "Example usage:",
24797 "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",
24801 "name": "updateProjects",
24802 "group": "Square_Projects",
24803 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24804 "version": "0.0.0",
24805 "filename": "server/api/squareProject/index.js",
24806 "groupTitle": "Square_Projects"
24810 "url": "/api/square/recordings",
24811 "title": "Creates a new Recording",
24814 "title": "Example usage:",
24815 "content": "curl https://{domain}/api/square/recordings -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
24819 "name": "CreateRecordings",
24820 "group": "Square_Recordings",
24828 "field": "uniqueid",
24835 "field": "callerid",
24842 "field": "calleridname",
24849 "field": "context",
24856 "field": "extension",
24863 "field": "priority",
24870 "field": "accountcode",
24884 "field": "projectName",
24891 "field": "saveName",
24898 "field": "filename",
24905 "field": "savePath",
24918 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24919 "version": "0.0.0",
24920 "filename": "server/api/squareRecording/index.js",
24921 "groupTitle": "Square_Recordings"
24925 "url": "/api/square/recordings",
24926 "title": "Gets a list of Recordings",
24929 "title": "Example usage:",
24930 "content": "curl https://{domain}/api/square/recordings -v -u {name}:{password}",
24934 "name": "GetRecordings",
24935 "group": "Square_Recordings",
24936 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
24937 "version": "0.0.0",
24938 "filename": "server/api/squareRecording/index.js",
24939 "groupTitle": "Square_Recordings"
24943 "url": "/api/square/recordings/{id}",
24944 "title": "Gets a single Recording",
24947 "title": "Example usage:",
24948 "content": "curl https://{domain}/api/square/recordings/{id} -v -u {name}:{password}",
24952 "name": "ShowRecordings",
24953 "group": "Square_Recordings",
24954 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24955 "version": "0.0.0",
24956 "filename": "server/api/squareRecording/index.js",
24957 "groupTitle": "Square_Recordings"
24961 "url": "/api/square/recordings/{id}/delete",
24962 "title": "Delete recording",
24965 "title": "Example usage:",
24966 "content": "curl https://{domain}/api/square/recordings/{id}/delete -v -u {name}:{password} -X DELETE",
24971 "group": "Square_Recordings",
24972 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24973 "version": "0.0.0",
24974 "filename": "server/api/squareRecording/index.js",
24975 "groupTitle": "Square_Recordings"
24979 "url": "/api/square/recordings/{id}/download",
24980 "title": "Download Recording",
24983 "title": "Example usage:",
24984 "content": "curl https://{domain}/api/square/recordings/{id}/download -v -u {name}:{password} -X GET",
24988 "name": "download",
24989 "group": "Square_Recordings",
24990 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24991 "version": "0.0.0",
24992 "filename": "server/api/squareRecording/index.js",
24993 "groupTitle": "Square_Recordings"
24997 "url": "/api/square/recordings/{id}",
24998 "title": "Update an existing Recording",
25001 "title": "Example usage:",
25002 "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",
25006 "name": "updateRecordings",
25007 "group": "Square_Recordings",
25008 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25009 "version": "0.0.0",
25010 "filename": "server/api/squareRecording/index.js",
25011 "groupTitle": "Square_Recordings"
25015 "url": "/api/square/reports",
25016 "title": "Creates a new Square Report",
25019 "title": "Example usage:",
25020 "content": "curl https://{domain}/api/square/reports -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
25024 "name": "CreateSquare_Reports",
25025 "group": "Square_Reports",
25033 "field": "network",
25040 "field": "network_script",
25047 "field": "request",
25054 "field": "channel",
25061 "field": "language",
25075 "field": "uniqueid",
25082 "field": "version",
25089 "field": "callerid",
25096 "field": "calleridname",
25103 "field": "callingpres",
25110 "field": "callingani2",
25117 "field": "callington",
25124 "field": "callingtns",
25145 "field": "context",
25152 "field": "extension",
25159 "field": "priority",
25166 "field": "enhanced",
25173 "field": "accountcode",
25180 "field": "threadid",
25187 "field": "project_name",
25201 "field": "leaveAt",
25214 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25215 "version": "0.0.0",
25216 "filename": "server/api/squareReport/index.js",
25217 "groupTitle": "Square_Reports"
25221 "url": "/api/square/reports/{id}",
25222 "title": "Deletes a Square Report",
25225 "title": "Example usage:",
25226 "content": "curl https://{domain}/api/square/reports/{id} -v -u {name}:{password} -X DELETE",
25230 "name": "DeleteSquare_Reports",
25231 "group": "Square_Reports",
25232 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25233 "version": "0.0.0",
25234 "filename": "server/api/squareReport/index.js",
25235 "groupTitle": "Square_Reports"
25239 "url": "/api/square/reports/describe",
25240 "title": "Gets table info about Square Reports",
25243 "title": "Example usage:",
25244 "content": "curl https://{domain}/api/square/reports/describe -v -u {name}:{password}",
25248 "name": "DescribeSquare_Reports",
25249 "group": "Square_Reports",
25250 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25251 "version": "0.0.0",
25252 "filename": "server/api/squareReport/index.js",
25253 "groupTitle": "Square_Reports"
25257 "url": "/api/square/reports",
25258 "title": "Gets a list of Square Reports",
25261 "title": "Example usage:",
25262 "content": "curl https://{domain}/api/square/reports -v -u {name}:{password}",
25266 "name": "GetSquare_Reports",
25267 "group": "Square_Reports",
25268 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
25269 "version": "0.0.0",
25270 "filename": "server/api/squareReport/index.js",
25271 "groupTitle": "Square_Reports"
25275 "url": "/api/square/reports/{id}",
25276 "title": "Gets a single Square Report",
25279 "title": "Example usage:",
25280 "content": "curl https://{domain}/api/square/reports/{id} -v -u {name}:{password}",
25284 "name": "ShowSquare_Reports",
25285 "group": "Square_Reports",
25286 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25287 "version": "0.0.0",
25288 "filename": "server/api/squareReport/index.js",
25289 "groupTitle": "Square_Reports"
25293 "url": "/api/square/reports/{id}",
25294 "title": "Update an existing Square Report",
25297 "title": "Example usage:",
25298 "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",
25302 "name": "updateSquare_Reports",
25303 "group": "Square_Reports",
25304 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25305 "version": "0.0.0",
25306 "filename": "server/api/squareReport/index.js",
25307 "groupTitle": "Square_Reports"
25311 "url": "/api/integrations/sugarcrm/configurations",
25312 "title": "Creates a new SugarCRM Configuration",
25315 "title": "Example usage:",
25316 "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",
25320 "name": "CreateSugarCRM_Configurations",
25321 "group": "SugarCRM_Configurations",
25336 "field": "description",
25342 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25343 "version": "0.0.0",
25344 "filename": "server/api/intSugarcrmConfiguration/index.js",
25345 "groupTitle": "SugarCRM_Configurations"
25349 "url": "/api/integrations/sugarcrm/configurations/{id}",
25350 "title": "Deletes a SugarCRM Configuration",
25353 "title": "Example usage:",
25354 "content": "curl https://{domain}/api/integrations/sugarcrm/configurations/{id} -v -u {name}:{password} -X DELETE",
25358 "name": "DeleteSugarCRM_Configurations",
25359 "group": "SugarCRM_Configurations",
25360 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25361 "version": "0.0.0",
25362 "filename": "server/api/intSugarcrmConfiguration/index.js",
25363 "groupTitle": "SugarCRM_Configurations"
25367 "url": "/api/integrations/sugarcrm/configurations",
25368 "title": "Gets a list of SugarCRM Configurations",
25371 "title": "Example usage:",
25372 "content": "curl https://{domain}/api/integrations/sugarcrm/configurations -v -u {name}:{password}",
25376 "name": "GetSugarCRM_Configurations",
25377 "group": "SugarCRM_Configurations",
25378 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
25379 "version": "0.0.0",
25380 "filename": "server/api/intSugarcrmConfiguration/index.js",
25381 "groupTitle": "SugarCRM_Configurations"
25385 "url": "/api/integrations/sugarcrm/configurations/{id}",
25386 "title": "Gets a single SugarCRM Configuration",
25389 "title": "Example usage:",
25390 "content": "curl https://{domain}/api/integrations/sugarcrm/configurations/{id} -v -u {name}:{password}",
25394 "name": "ShowSugarCRM_Configurations",
25395 "group": "SugarCRM_Configurations",
25396 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25397 "version": "0.0.0",
25398 "filename": "server/api/intSugarcrmConfiguration/index.js",
25399 "groupTitle": "SugarCRM_Configurations"
25403 "url": "/api/integrations/sugarcrm/configurations/{id}",
25404 "title": "Update an existing SugarCRM Configuration",
25407 "title": "Example usage:",
25408 "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",
25412 "name": "updateSugarCRM_Configurations",
25413 "group": "SugarCRM_Configurations",
25414 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25415 "version": "0.0.0",
25416 "filename": "server/api/intSugarcrmConfiguration/index.js",
25417 "groupTitle": "SugarCRM_Configurations"
25421 "url": "/api/integrations/sugarcrm/accounts",
25422 "title": "Creates a new Sugarcrm Account",
25425 "title": "Example usage:",
25426 "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",
25430 "name": "CreateSugarcrm_Accounts",
25431 "group": "Sugarcrm_Accounts",
25446 "field": "description",
25453 "field": "username",
25460 "field": "password",
25467 "field": "remoteUri",
25474 "field": "serverUrl",
25480 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25481 "version": "0.0.0",
25482 "filename": "server/api/intSugarcrmAccount/index.js",
25483 "groupTitle": "Sugarcrm_Accounts"
25487 "url": "/api/integrations/sugarcrm/accounts/{id}",
25488 "title": "Deletes a Sugarcrm Account",
25491 "title": "Example usage:",
25492 "content": "curl https://{domain}/api/integrations/sugarcrm/accounts/{id} -v -u {name}:{password} -X DELETE",
25496 "name": "DeleteSugarcrm_Accounts",
25497 "group": "Sugarcrm_Accounts",
25498 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25499 "version": "0.0.0",
25500 "filename": "server/api/intSugarcrmAccount/index.js",
25501 "groupTitle": "Sugarcrm_Accounts"
25505 "url": "/api/integrations/sugarcrm/accounts",
25506 "title": "Gets a list of Sugarcrm Accounts",
25509 "title": "Example usage:",
25510 "content": "curl https://{domain}/api/integrations/sugarcrm/accounts -v -u {name}:{password}",
25514 "name": "GetSugarcrm_Accounts",
25515 "group": "Sugarcrm_Accounts",
25516 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
25517 "version": "0.0.0",
25518 "filename": "server/api/intSugarcrmAccount/index.js",
25519 "groupTitle": "Sugarcrm_Accounts"
25523 "url": "/api/integrations/sugarcrm/accounts/{id}",
25524 "title": "Gets a single Sugarcrm Account",
25527 "title": "Example usage:",
25528 "content": "curl https://{domain}/api/integrations/sugarcrm/accounts/{id} -v -u {name}:{password}",
25532 "name": "ShowSugarcrm_Accounts",
25533 "group": "Sugarcrm_Accounts",
25534 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25535 "version": "0.0.0",
25536 "filename": "server/api/intSugarcrmAccount/index.js",
25537 "groupTitle": "Sugarcrm_Accounts"
25541 "url": "/api/integrations/sugarcrm/accounts/{id}/configurations",
25542 "title": "Creates new configuration",
25545 "title": "Example usage:",
25546 "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",
25550 "name": "addConfiguration",
25551 "group": "Sugarcrm_Accounts",
25552 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25553 "version": "0.0.0",
25554 "filename": "server/api/intSugarcrmAccount/index.js",
25555 "groupTitle": "Sugarcrm_Accounts"
25559 "url": "/api/integrations/sugarcrm/accounts/{id}/configurations",
25560 "title": "Gets account configurations",
25563 "title": "Example usage:",
25564 "content": "curl https://{domain}/api/integrations/sugarcrm/accounts/{id}/configurations -v -u {name}:{password} -X GET",
25568 "name": "getConfigurations",
25569 "group": "Sugarcrm_Accounts",
25570 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25571 "version": "0.0.0",
25572 "filename": "server/api/intSugarcrmAccount/index.js",
25573 "groupTitle": "Sugarcrm_Accounts"
25577 "url": "/api/integrations/sugarcrm/accounts/{id}/fields",
25578 "title": "Gets account fields",
25581 "title": "Example usage:",
25582 "content": "curl https://{domain}/api/integrations/sugarcrm/accounts/{id}/fields -v -u {name}:{password} -X GET",
25586 "name": "getFields",
25587 "group": "Sugarcrm_Accounts",
25588 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25589 "version": "0.0.0",
25590 "filename": "server/api/intSugarcrmAccount/index.js",
25591 "groupTitle": "Sugarcrm_Accounts"
25595 "url": "/api/integrations/sugarcrm/accounts/{id}",
25596 "title": "Update an existing Sugarcrm Account",
25599 "title": "Example usage:",
25600 "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",
25604 "name": "updateSugarcrm_Accounts",
25605 "group": "Sugarcrm_Accounts",
25606 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25607 "version": "0.0.0",
25608 "filename": "server/api/intSugarcrmAccount/index.js",
25609 "groupTitle": "Sugarcrm_Accounts"
25613 "url": "/api/integrations/sugarcrm/configurations/{id}/descriptions",
25614 "title": "Gets configurations descriptions",
25617 "title": "Example usage:",
25618 "content": "curl https://{domain}/api/integrations/sugarcrm/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
25622 "name": "getDescriptions",
25623 "group": "Sugarcrm_Configurations",
25624 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25625 "version": "0.0.0",
25626 "filename": "server/api/intSugarcrmConfiguration/index.js",
25627 "groupTitle": "Sugarcrm_Configurations"
25631 "url": "/api/integrations/sugarcrm/configurations/{id}/fields",
25632 "title": "Gets configurations fields",
25635 "title": "Example usage:",
25636 "content": "curl https://{domain}/api/integrations/sugarcrm/configurations/{id}/fields -v -u {name}:{password} -X GET",
25640 "name": "getFields",
25641 "group": "Sugarcrm_Configurations",
25642 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25643 "version": "0.0.0",
25644 "filename": "server/api/intSugarcrmConfiguration/index.js",
25645 "groupTitle": "Sugarcrm_Configurations"
25649 "url": "/api/integrations/sugarcrm/configurations/{id}/subjects",
25650 "title": "Gets configurations subjects",
25653 "title": "Example usage:",
25654 "content": "curl https://{domain}/api/integrations/sugarcrm/configurations/{id}/subjects -v -u {name}:{password} -X GET",
25658 "name": "getSubjects",
25659 "group": "Sugarcrm_Configurations",
25660 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25661 "version": "0.0.0",
25662 "filename": "server/api/intSugarcrmConfiguration/index.js",
25663 "groupTitle": "Sugarcrm_Configurations"
25667 "url": "/api/integrations/sugarcrm/fields",
25668 "title": "Creates a new Sugarcrm Field",
25671 "title": "Example usage:",
25672 "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",
25676 "name": "CreateSugarcrm_Fields",
25677 "group": "Sugarcrm_Fields",
25687 "\"customVariable\"",
25699 "field": "content",
25715 "\"customVariable\""
25718 "field": "keyType",
25725 "field": "keyContent",
25732 "field": "idField",
25739 "field": "nameField",
25746 "field": "customField",
25753 "field": "variableName",
25759 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25760 "version": "0.0.0",
25761 "filename": "server/api/intSugarcrmField/index.js",
25762 "groupTitle": "Sugarcrm_Fields"
25766 "url": "/api/integrations/sugarcrm/fields/{id}",
25767 "title": "Deletes a Sugarcrm Field",
25770 "title": "Example usage:",
25771 "content": "curl https://{domain}/api/integrations/sugarcrm/fields/{id} -v -u {name}:{password} -X DELETE",
25775 "name": "DeleteSugarcrm_Fields",
25776 "group": "Sugarcrm_Fields",
25777 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25778 "version": "0.0.0",
25779 "filename": "server/api/intSugarcrmField/index.js",
25780 "groupTitle": "Sugarcrm_Fields"
25784 "url": "/api/integrations/sugarcrm/fields",
25785 "title": "Gets a list of Sugarcrm Fields",
25788 "title": "Example usage:",
25789 "content": "curl https://{domain}/api/integrations/sugarcrm/fields -v -u {name}:{password}",
25793 "name": "GetSugarcrm_Fields",
25794 "group": "Sugarcrm_Fields",
25795 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
25796 "version": "0.0.0",
25797 "filename": "server/api/intSugarcrmField/index.js",
25798 "groupTitle": "Sugarcrm_Fields"
25802 "url": "/api/integrations/sugarcrm/fields/{id}",
25803 "title": "Gets a single Sugarcrm Field",
25806 "title": "Example usage:",
25807 "content": "curl https://{domain}/api/integrations/sugarcrm/fields/{id} -v -u {name}:{password}",
25811 "name": "ShowSugarcrm_Fields",
25812 "group": "Sugarcrm_Fields",
25813 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25814 "version": "0.0.0",
25815 "filename": "server/api/intSugarcrmField/index.js",
25816 "groupTitle": "Sugarcrm_Fields"
25820 "url": "/api/integrations/sugarcrm/fields/{id}",
25821 "title": "Update an existing Sugarcrm Field",
25824 "title": "Example usage:",
25825 "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",
25829 "name": "updateSugarcrm_Fields",
25830 "group": "Sugarcrm_Fields",
25831 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25832 "version": "0.0.0",
25833 "filename": "server/api/intSugarcrmField/index.js",
25834 "groupTitle": "Sugarcrm_Fields"
25838 "url": "/api/system",
25839 "title": "Gets system information",
25842 "title": "Example usage:",
25843 "content": "curl https://{domain}/api/system -v -u {name}:{password}",
25847 "name": "GetSystemInformation",
25848 "group": "System_Information",
25849 "description": "<p>Motion returns the system information.</p>",
25850 "version": "0.0.0",
25851 "filename": "server/api/system/index.js",
25852 "groupTitle": "System_Information"
25856 "url": "/api/system/process",
25857 "title": "Gets system information",
25860 "title": "Example usage:",
25861 "content": "curl https://{domain}/api/system -v -u {name}:{password}",
25865 "name": "GetSystemInformation",
25866 "group": "System_Information",
25867 "description": "<p>Motion returns the system information.</p>",
25868 "version": "0.0.0",
25869 "filename": "server/api/system/index.js",
25870 "groupTitle": "System_Information"
25874 "url": "/api/tags",
25875 "title": "Creates a new Tag",
25878 "title": "Example usage:",
25879 "content": "curl https://{domain}/api/tags -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
25883 "name": "CreateTags",
25906 "field": "description",
25912 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25913 "version": "0.0.0",
25914 "filename": "server/api/tag/index.js",
25915 "groupTitle": "Tags"
25919 "url": "/api/tags/{id}",
25920 "title": "Deletes a Tag",
25923 "title": "Example usage:",
25924 "content": "curl https://{domain}/api/tags/{id} -v -u {name}:{password} -X DELETE",
25928 "name": "DeleteTags",
25930 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25931 "version": "0.0.0",
25932 "filename": "server/api/tag/index.js",
25933 "groupTitle": "Tags"
25937 "url": "/api/tags",
25938 "title": "Gets a list of Tags",
25941 "title": "Example usage:",
25942 "content": "curl https://{domain}/api/tags -v -u {name}:{password}",
25948 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
25949 "version": "0.0.0",
25950 "filename": "server/api/tag/index.js",
25951 "groupTitle": "Tags"
25955 "url": "/api/tags/{id}",
25956 "title": "Gets a single Tag",
25959 "title": "Example usage:",
25960 "content": "curl https://{domain}/api/tags/{id} -v -u {name}:{password}",
25964 "name": "ShowTags",
25966 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25967 "version": "0.0.0",
25968 "filename": "server/api/tag/index.js",
25969 "groupTitle": "Tags"
25973 "url": "/api/tags/{id}",
25974 "title": "Update an existing Tag",
25977 "title": "Example usage:",
25978 "content": "curl https://{domain}/api/tags/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
25982 "name": "updateTags",
25984 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25985 "version": "0.0.0",
25986 "filename": "server/api/tag/index.js",
25987 "groupTitle": "Tags"
25991 "url": "/api/teams/{id}/queues",
25992 "title": "Add queues to a team",
25995 "title": "Example usage:",
25996 "content": "curl https://{domain}/api/teams/{id}/queues -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
26000 "name": "AddQueues",
26002 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26003 "version": "0.0.0",
26004 "filename": "server/api/team/index.js",
26005 "groupTitle": "Teams"
26009 "url": "/api/teams",
26010 "title": "Creates a new Team",
26013 "title": "Example usage:",
26014 "content": "curl https://{domain}/api/teams -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
26018 "name": "CreateTeams",
26034 "field": "description",
26040 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26041 "version": "0.0.0",
26042 "filename": "server/api/team/index.js",
26043 "groupTitle": "Teams"
26047 "url": "/api/teams/{id}",
26048 "title": "Deletes a Team",
26051 "title": "Example usage:",
26052 "content": "curl https://{domain}/api/teams/{id} -v -u {name}:{password} -X DELETE",
26056 "name": "DeleteTeams",
26058 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26059 "version": "0.0.0",
26060 "filename": "server/api/team/index.js",
26061 "groupTitle": "Teams"
26065 "url": "/api/teams/{id}/users",
26066 "title": "Gets agents from team",
26069 "title": "Example usage:",
26070 "content": "curl https://{domain}/api/teams/{id}/users -v -u {name}:{password} -X GET",
26074 "name": "GetAgents",
26076 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26077 "version": "0.0.0",
26078 "filename": "server/api/team/index.js",
26079 "groupTitle": "Teams"
26083 "url": "/api/teams/{id}/queues?channel={channel}",
26084 "title": "Gets Queues list",
26087 "title": "Example usage:",
26088 "content": "curl https://{domain}/api/teams/{id}/queues?channel={channel} -v -u {name}:{password}",
26092 "name": "GetQueues",
26094 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26095 "version": "0.0.0",
26096 "filename": "server/api/team/index.js",
26097 "groupTitle": "Teams"
26101 "url": "/api/teams",
26102 "title": "Gets a list of Teams",
26105 "title": "Example usage:",
26106 "content": "curl https://{domain}/api/teams -v -u {name}:{password}",
26110 "name": "GetTeams",
26112 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
26113 "version": "0.0.0",
26114 "filename": "server/api/team/index.js",
26115 "groupTitle": "Teams"
26119 "url": "/api/teams/{id}/users",
26120 "title": "Removes agents from a team",
26123 "title": "Example usage:",
26124 "content": "curl https://{domain}/api/teams/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
26128 "name": "RemoveAgents",
26130 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26131 "version": "0.0.0",
26132 "filename": "server/api/team/index.js",
26133 "groupTitle": "Teams"
26137 "url": "/api/teams/{id}/queues",
26138 "title": "Remove queues to a team",
26141 "title": "Example usage:",
26142 "content": "curl https://{domain}/api/teams/{id}/queues?channel=voice&ids=1&ids=2 -v -u {name}:{password} -X DELETE",
26146 "name": "RemoveQueues",
26148 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26149 "version": "0.0.0",
26150 "filename": "server/api/team/index.js",
26151 "groupTitle": "Teams"
26155 "url": "/api/chat/queues/{id}/teams",
26156 "title": "Remove teams from a queue",
26159 "title": "Example usage:",
26160 "content": "curl https://{domain}/api/chat/queues/{id}/teams -v -u {name}:{password} -X DELETE",
26164 "name": "RemoveTeams",
26166 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26167 "version": "0.0.0",
26168 "filename": "server/api/chatQueue/index.js",
26169 "groupTitle": "Teams"
26173 "url": "/api/fax/queues/{id}/teams",
26174 "title": "Remove teams from a queue",
26177 "title": "Example usage:",
26178 "content": "curl https://{domain}/api/fax/queues/{id}/teams -v -u {name}:{password} -X DELETE",
26182 "name": "RemoveTeams",
26184 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26185 "version": "0.0.0",
26186 "filename": "server/api/faxQueue/index.js",
26187 "groupTitle": "Teams"
26191 "url": "/api/mail/queues/{id}/teams",
26192 "title": "Remove teams from a queue",
26195 "title": "Example usage:",
26196 "content": "curl https://{domain}/api/mail/queues/{id}/teams -v -u {name}:{password} -X DELETE",
26200 "name": "RemoveTeams",
26202 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26203 "version": "0.0.0",
26204 "filename": "server/api/mailQueue/index.js",
26205 "groupTitle": "Teams"
26209 "url": "/api/sms/queues/{id}/teams",
26210 "title": "Remove teams from a queue",
26213 "title": "Example usage:",
26214 "content": "curl https://{domain}/api/sms/queues/{id}/teams -v -u {name}:{password} -X DELETE",
26218 "name": "RemoveTeams",
26220 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26221 "version": "0.0.0",
26222 "filename": "server/api/smsQueue/index.js",
26223 "groupTitle": "Teams"
26227 "url": "/api/whatsapp/queues/{id}/teams",
26228 "title": "Remove teams from a queue",
26231 "title": "Example usage:",
26232 "content": "curl https://{domain}/api/whatsapp/queues/{id}/teams -v -u {name}:{password} -X DELETE",
26236 "name": "RemoveTeams",
26238 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26239 "version": "0.0.0",
26240 "filename": "server/api/whatsappQueue/index.js",
26241 "groupTitle": "Teams"
26245 "url": "/api/openchannel/queues/{id}/teams",
26246 "title": "Remove teams from a queue",
26249 "title": "Example usage:",
26250 "content": "curl https://{domain}/api/openchannel/queues/{id}/teams -v -u {name}:{password} -X DELETE",
26254 "name": "RemoveTeams",
26256 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26257 "version": "0.0.0",
26258 "filename": "server/api/openchannelQueue/index.js",
26259 "groupTitle": "Teams"
26263 "url": "/api/voice/queues/{id}/teams",
26264 "title": "Remove teams from a queue",
26267 "title": "Example usage:",
26268 "content": "curl https://{domain}/api/voice/queues/{id}/teams -v -u {name}:{password} -X DELETE",
26272 "name": "RemoveTeams",
26274 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26275 "version": "0.0.0",
26276 "filename": "server/api/voiceQueue/index.js",
26277 "groupTitle": "Teams"
26281 "url": "/api/teams/{id}",
26282 "title": "Gets a single Team",
26285 "title": "Example usage:",
26286 "content": "curl https://{domain}/api/teams/{id} -v -u {name}:{password}",
26290 "name": "ShowTeams",
26292 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26293 "version": "0.0.0",
26294 "filename": "server/api/team/index.js",
26295 "groupTitle": "Teams"
26299 "url": "/api/teams/{id}/users",
26300 "title": "Adds agents to a team",
26303 "title": "Example usage:",
26304 "content": "curl https://{domain}/api/teams/{id}/users -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
26308 "name": "addAgents",
26310 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26311 "version": "0.0.0",
26312 "filename": "server/api/team/index.js",
26313 "groupTitle": "Teams"
26317 "url": "/api/teams/{id}",
26318 "title": "Update an existing Team",
26321 "title": "Example usage:",
26322 "content": "curl https://{domain}/api/teams/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
26326 "name": "updateTeams",
26328 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26329 "version": "0.0.0",
26330 "filename": "server/api/team/index.js",
26331 "groupTitle": "Teams"
26335 "url": "/api/templates",
26336 "title": "Creates a new Template",
26339 "title": "Example usage:",
26340 "content": "curl https://{domain}/api/templates -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
26344 "name": "CreateTemplates",
26345 "group": "Templates",
26360 "field": "description",
26373 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26374 "version": "0.0.0",
26375 "filename": "server/api/template/index.js",
26376 "groupTitle": "Templates"
26380 "url": "/api/templates/{id}",
26381 "title": "Deletes a Template",
26384 "title": "Example usage:",
26385 "content": "curl https://{domain}/api/templates/{id} -v -u {name}:{password} -X DELETE",
26389 "name": "DeleteTemplates",
26390 "group": "Templates",
26391 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26392 "version": "0.0.0",
26393 "filename": "server/api/template/index.js",
26394 "groupTitle": "Templates"
26398 "url": "/api/templates",
26399 "title": "Gets a list of Templates",
26402 "title": "Example usage:",
26403 "content": "curl https://{domain}/api/templates -v -u {name}:{password}",
26407 "name": "GetTemplates",
26408 "group": "Templates",
26409 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
26410 "version": "0.0.0",
26411 "filename": "server/api/template/index.js",
26412 "groupTitle": "Templates"
26416 "url": "/api/templates/{id}",
26417 "title": "Gets a single Template",
26420 "title": "Example usage:",
26421 "content": "curl https://{domain}/api/templates/{id} -v -u {name}:{password}",
26425 "name": "ShowTemplates",
26426 "group": "Templates",
26427 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26428 "version": "0.0.0",
26429 "filename": "server/api/template/index.js",
26430 "groupTitle": "Templates"
26434 "url": "/api/templates/{id}",
26435 "title": "Update an existing Template",
26438 "title": "Example usage:",
26439 "content": "curl https://{domain}/api/templates/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
26443 "name": "updateTemplates",
26444 "group": "Templates",
26445 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26446 "version": "0.0.0",
26447 "filename": "server/api/template/index.js",
26448 "groupTitle": "Templates"
26452 "url": "/api/triggers",
26453 "title": "Creates a new Trigger",
26456 "title": "Example usage:",
26457 "content": "curl https://{domain}/api/triggers -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
26461 "name": "CreateTriggers",
26462 "group": "Triggers",
26477 "field": "channel",
26484 "field": "description",
26497 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26498 "version": "0.0.0",
26499 "filename": "server/api/trigger/index.js",
26500 "groupTitle": "Triggers"
26504 "url": "/api/triggers/{id}",
26505 "title": "Deletes a Trigger",
26508 "title": "Example usage:",
26509 "content": "curl https://{domain}/api/triggers/{id} -v -u {name}:{password} -X DELETE",
26513 "name": "DeleteTriggers",
26514 "group": "Triggers",
26515 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26516 "version": "0.0.0",
26517 "filename": "server/api/trigger/index.js",
26518 "groupTitle": "Triggers"
26522 "url": "/api/triggers",
26523 "title": "Gets a list of Triggers",
26526 "title": "Example usage:",
26527 "content": "curl https://{domain}/api/triggers -v -u {name}:{password}",
26531 "name": "GetTriggers",
26532 "group": "Triggers",
26533 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/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>",
26534 "version": "0.0.0",
26535 "filename": "server/api/trigger/index.js",
26536 "groupTitle": "Triggers"
26540 "url": "/api/triggers/{id}",
26541 "title": "Gets a single Trigger",
26544 "title": "Example usage:",
26545 "content": "curl https://{domain}/api/triggers/{id} -v -u {name}:{password}",
26549 "name": "ShowTriggers",
26550 "group": "Triggers",
26551 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26552 "version": "0.0.0",
26553 "filename": "server/api/trigger/index.js",
26554 "groupTitle": "Triggers"
26558 "url": "/api/triggers/{id}/actions",
26559 "title": "Creates new actions",
26562 "title": "Example usage:",
26563 "content": "curl https://{domain}/api/triggers/{id}/actions -d '{\"action\": \"contactManager\",\"data1\": \"1\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
26567 "name": "addAction",
26568 "group": "Triggers",
26584 "description": "<p>Allowed values: contactManager, integration, motionbar, jscripty, urlForward, browser, bot, script</p>"
26591 "description": "<p>contactManager[ListId], integration[intName(zendesk)], motionbar[Popup(0),URL(1),WinApp(2)], urlForward[GET,POST], browser[TemplateId(0),URL(1)]</p>"
26598 "description": "<p>integration[AccountId], motionbar[TemplateId,URL,WinAppPath], urlForward[URL]</p>"
26605 "description": "<p>motionbar[NULL,NULL,WinAppArguments]</p>"
26638 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26639 "version": "0.0.0",
26640 "filename": "server/api/trigger/index.js",
26641 "groupTitle": "Triggers"
26645 "url": "/api/triggers/{id}/all_conditions",
26646 "title": "Creates a new \"AND\"condition",
26649 "title": "Example usage:",
26650 "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",
26654 "name": "addAllCondition",
26655 "group": "Triggers",
26677 "field": "operator",
26690 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26691 "version": "0.0.0",
26692 "filename": "server/api/trigger/index.js",
26693 "groupTitle": "Triggers"
26697 "url": "/api/triggers/{id}/any_conditions",
26698 "title": "Creates a new \"OR\"condition",
26701 "title": "Example usage:",
26702 "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",
26706 "name": "addAnyCondition",
26707 "group": "Triggers",
26729 "field": "operator",
26742 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26743 "version": "0.0.0",
26744 "filename": "server/api/trigger/index.js",
26745 "groupTitle": "Triggers"
26749 "url": "/api/triggers/{id}/actions",
26750 "title": "Gets Trigger Actions",
26753 "title": "Example usage:",
26754 "content": "curl https://{domain}/api/triggers/{id}/actions -v -u {name}:{password} -X GET",
26758 "name": "getActions",
26759 "group": "Triggers",
26760 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26761 "version": "0.0.0",
26762 "filename": "server/api/trigger/index.js",
26763 "groupTitle": "Triggers"
26767 "url": "/api/triggers/{id}/all_conditions",
26768 "title": "Gets \"AND\" Trigger Conditions",
26771 "title": "Example usage:",
26772 "content": "curl https://{domain}/api/triggers/{id}/all_conditions -v -u {name}:{password} -X GET",
26776 "name": "getAllConditions",
26777 "group": "Triggers",
26778 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26779 "version": "0.0.0",
26780 "filename": "server/api/trigger/index.js",
26781 "groupTitle": "Triggers"
26785 "url": "/api/triggers/{id}/any_conditions",
26786 "title": "Gets \"OR\" Trigger Conditions",
26789 "title": "Example usage:",
26790 "content": "curl https://{domain}/api/triggers/{id}/any_conditions -v -u {name}:{password} -X GET",
26794 "name": "getAnyConditions",
26795 "group": "Triggers",
26796 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26797 "version": "0.0.0",
26798 "filename": "server/api/trigger/index.js",
26799 "groupTitle": "Triggers"
26803 "url": "/api/triggers/{id}",
26804 "title": "Update an existing Trigger",
26807 "title": "Example usage:",
26808 "content": "curl https://{domain}/api/triggers/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
26812 "name": "updateTriggers",
26813 "group": "Triggers",
26814 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26815 "version": "0.0.0",
26816 "filename": "server/api/trigger/index.js",
26817 "groupTitle": "Triggers"
26821 "url": "/api/trunks/clone",
26822 "title": "Clone an existing Trunk",
26825 "title": "Example usage:",
26826 "content": "curl https://{domain}/api/trunks/clone -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
26830 "name": "CloneTrunks",
26832 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26833 "version": "0.0.0",
26834 "filename": "server/api/trunk/index.js",
26835 "groupTitle": "Trunks"
26839 "url": "/api/trunks",
26840 "title": "Create a new trunk",
26843 "title": "Example usage:",
26844 "content": "curl https://{domain}/api/trunks -v -u {name}:{password} -X POST",
26876 "field": "context",
26883 "\"ALLOWED_NOT_SCREENED\"",
26884 "\"ALLOWED_PASSED_SCREEN\"",
26885 "\"ALLOWED_FAILED_SCREEN\"",
26887 "\"PROHIB_NOT_SCREENED\"",
26888 "\"PROHIB_PASSED_SCREEN\"",
26889 "\"PROHIB_FAILED_SCREEN\"",
26893 "field": "callingpres",
26921 "field": "md5secret",
26928 "field": "remotesecret",
26935 "field": "transport",
26936 "description": "<p>String is deprecated. Please use an Array as ["udp", "tcp"]</p>"
26949 "field": "dtmfmode",
26963 "field": "directmedia",
26974 "field": "directrtpsetup",
26981 "field": "directmediapermit",
26988 "field": "directmediadeny",
26996 "description": "<p>String is deprecated. Please use an Array as ["force_rport", "comedia"]</p>"
27002 "field": "callgroup",
27009 "field": "namedcallgroup",
27016 "field": "pickupgroup",
27023 "field": "namedpickupgroup",
27030 "field": "language",
27037 "field": "tonezone",
27044 "field": "disallow",
27052 "description": "<p>String is deprecated. Please use an Array as ["ulaw", "alaw", "alaw"]</p>"
27062 "field": "autoframing",
27069 "field": "insecure",
27070 "description": "<p>String is deprecated. Please use an Array as ["port", "invite"]</p>"
27080 "field": "trustrpid",
27091 "field": "trust_id_outbound",
27103 "field": "progressinband",
27114 "field": "promiscredir",
27125 "field": "useclientcode",
27132 "field": "accountcode",
27146 "field": "callerid",
27153 "field": "amaflags",
27164 "field": "callcounter",
27171 "field": "busylevel",
27182 "field": "allowoverlap",
27193 "field": "allowsubscribe",
27204 "field": "allowtransfer",
27215 "field": "ignoresdpversion",
27222 "field": "subscribecontext",
27229 "field": "template",
27241 "field": "videosupport",
27248 "field": "maxcallbitrate",
27259 "field": "rfc2833compensate",
27266 "field": "mailbox",
27278 "field": "session_timers",
27285 "field": "session_expires",
27292 "field": "session_minse",
27303 "field": "session_refresher",
27310 "field": "t38pt_usertpsource",
27317 "field": "regexten",
27324 "field": "fromdomain",
27331 "field": "fromuser",
27349 "field": "qualify",
27356 "field": "keepalive",
27363 "field": "defaultip",
27370 "field": "defaultuser",
27377 "field": "rtptimeout",
27384 "field": "rtpholdtimeout",
27391 "field": "rtpkeepalive",
27403 "field": "sendrpid",
27410 "field": "outboundproxy",
27417 "field": "callbackextension",
27424 "field": "timert1",
27438 "field": "qualifyfreq",
27445 "field": "contactpermit",
27452 "field": "contactdeny",
27459 "field": "contactacl",
27466 "field": "unsolicited_mailbox",
27473 "field": "use_q850_reason",
27480 "field": "maxforwards",
27491 "field": "encryption",
27513 "field": "force_avp",
27524 "field": "icesupport",
27535 "field": "dtlsenable",
27548 "field": "dtlsverify",
27555 "field": "dtlsrekey",
27562 "field": "dtlscertfile",
27569 "field": "dtlsprivatekey",
27576 "field": "dtlscipher",
27583 "field": "dtlscafile",
27590 "field": "dtlscapath",
27602 "field": "dtlssetup",
27609 "field": "dtlsfingerprint",
27620 "field": "usereqphone",
27627 "field": "recordonfeature",
27634 "field": "recordofffeature",
27641 "field": "call_limit",
27652 "field": "registertrying",
27663 "field": "subscribemwi",
27670 "field": "vmexten",
27677 "field": "mohinterpret",
27684 "field": "mohsuggest",
27691 "field": "parkinglot",
27698 "field": "description",
27719 "field": "canreinvite",
27726 "field": "registry",
27733 "field": "otherFields",
27747 "field": "t38pt_udptl",
27753 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27754 "version": "0.0.0",
27755 "filename": "server/api/trunk/index.js",
27756 "groupTitle": "Trunks"
27760 "url": "/api/trunks/{id}",
27761 "title": "Deletes a trunk",
27764 "title": "Example usage:",
27765 "content": "curl https://{domain}/api/trunks/{id} -v -u {name}:{password} -X DELETE",
27771 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27772 "version": "0.0.0",
27773 "filename": "server/api/trunk/index.js",
27774 "groupTitle": "Trunks"
27778 "url": "/api/trunks",
27779 "title": "Gets a list of Trunks",
27782 "title": "Example usage:",
27783 "content": "curl https://{domain}/api/trunks -v -u {name}:{password}",
27787 "name": "GetTrunks",
27789 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
27790 "version": "0.0.0",
27791 "filename": "server/api/trunk/index.js",
27792 "groupTitle": "Trunks"
27796 "url": "/api/trunks/{id}",
27797 "title": "Gets a single Trunk",
27800 "title": "Example usage:",
27801 "content": "curl https://{domain}/api/trunks/{id} -v -u {name}:{password}",
27805 "name": "ShowTrunks",
27807 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27808 "version": "0.0.0",
27809 "filename": "server/api/trunk/index.js",
27810 "groupTitle": "Trunks"
27814 "url": "/api/trunks/{id}",
27815 "title": "Update an existing trunk",
27818 "title": "Example usage:",
27819 "content": "curl https://{domain}/api/trunks/{id} -v -u {name}:{password} -X PUT",
27825 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27826 "version": "0.0.0",
27827 "filename": "server/api/trunk/index.js",
27828 "groupTitle": "Trunks"
27832 "url": "/api/userNotifications",
27833 "title": "Send notification to user",
27836 "title": "Example usage:",
27837 "content": "curl https://{domain}/api/userNotifications -d '{\"text\": \"Hello!\", \"TemplateId\": 1}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
27842 "group": "UserNotifications",
27843 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27844 "version": "0.0.0",
27845 "filename": "server/api/userNotification/index.js",
27846 "groupTitle": "UserNotifications"
27850 "url": "/api/userProfile/resources",
27851 "title": "Creates a new User Profile Resource",
27854 "title": "Example usage:",
27855 "content": "curl https://{domain}/api/userProfile/resources -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
27859 "name": "CreateUser_Profile_Resources",
27860 "group": "User_Profile_Resources",
27875 "field": "resourceId",
27888 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27889 "version": "0.0.0",
27890 "filename": "server/api/userProfileResource/index.js",
27891 "groupTitle": "User_Profile_Resources"
27895 "url": "/api/userProfile/resources/{id}",
27896 "title": "Deletes a User Profile Resource",
27899 "title": "Example usage:",
27900 "content": "curl https://{domain}/api/userProfile/resources/{id} -v -u {name}:{password} -X DELETE",
27904 "name": "DeleteUser_Profile_Resources",
27905 "group": "User_Profile_Resources",
27906 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27907 "version": "0.0.0",
27908 "filename": "server/api/userProfileResource/index.js",
27909 "groupTitle": "User_Profile_Resources"
27913 "url": "/api/userProfile/resources/describe",
27914 "title": "Gets table info about User Profile Resources",
27917 "title": "Example usage:",
27918 "content": "curl https://{domain}/api/userProfile/resources/describe -v -u {name}:{password}",
27922 "name": "DescribeUser_Profile_Resources",
27923 "group": "User_Profile_Resources",
27924 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27925 "version": "0.0.0",
27926 "filename": "server/api/userProfileResource/index.js",
27927 "groupTitle": "User_Profile_Resources"
27931 "url": "/api/userProfile/resources",
27932 "title": "Gets a list of User Profile Resources",
27935 "title": "Example usage:",
27936 "content": "curl https://{domain}/api/userProfile/resources -v -u {name}:{password}",
27940 "name": "GetUser_Profile_Resources",
27941 "group": "User_Profile_Resources",
27942 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
27943 "version": "0.0.0",
27944 "filename": "server/api/userProfileResource/index.js",
27945 "groupTitle": "User_Profile_Resources"
27949 "url": "/api/userProfile/resources/{id}",
27950 "title": "Gets a single User Profile Resource",
27953 "title": "Example usage:",
27954 "content": "curl https://{domain}/api/userProfile/resources/{id} -v -u {name}:{password}",
27958 "name": "ShowUser_Profile_Resources",
27959 "group": "User_Profile_Resources",
27960 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27961 "version": "0.0.0",
27962 "filename": "server/api/userProfileResource/index.js",
27963 "groupTitle": "User_Profile_Resources"
27967 "url": "/api/userProfile/resources/{id}",
27968 "title": "Update an existing User Profile Resource",
27971 "title": "Example usage:",
27972 "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",
27976 "name": "updateUser_Profile_Resources",
27977 "group": "User_Profile_Resources",
27978 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27979 "version": "0.0.0",
27980 "filename": "server/api/userProfileResource/index.js",
27981 "groupTitle": "User_Profile_Resources"
27985 "url": "/api/userProfile/sections",
27986 "title": "Creates a new User Profile Section",
27989 "title": "Example usage:",
27990 "content": "curl https://{domain}/api/userProfile/sections -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
27994 "name": "CreateUser_Profile_Sections",
27995 "group": "User_Profile_Sections",
28010 "field": "category",
28017 "field": "sectionId",
28024 "field": "enabled",
28031 "field": "autoAssociation",
28038 "field": "crudPermissions",
28044 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28045 "version": "0.0.0",
28046 "filename": "server/api/userProfileSection/index.js",
28047 "groupTitle": "User_Profile_Sections"
28051 "url": "/api/userProfile/sections/{id}",
28052 "title": "Deletes a User Profile Section",
28055 "title": "Example usage:",
28056 "content": "curl https://{domain}/api/userProfile/sections/{id} -v -u {name}:{password} -X DELETE",
28060 "name": "DeleteUser_Profile_Sections",
28061 "group": "User_Profile_Sections",
28062 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28063 "version": "0.0.0",
28064 "filename": "server/api/userProfileSection/index.js",
28065 "groupTitle": "User_Profile_Sections"
28069 "url": "/api/userProfile/sections/describe",
28070 "title": "Gets table info about User Profile Sections",
28073 "title": "Example usage:",
28074 "content": "curl https://{domain}/api/userProfile/sections/describe -v -u {name}:{password}",
28078 "name": "DescribeUser_Profile_Sections",
28079 "group": "User_Profile_Sections",
28080 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28081 "version": "0.0.0",
28082 "filename": "server/api/userProfileSection/index.js",
28083 "groupTitle": "User_Profile_Sections"
28087 "url": "/api/userProfile/sections",
28088 "title": "Gets a list of User Profile Sections",
28091 "title": "Example usage:",
28092 "content": "curl https://{domain}/api/userProfile/sections -v -u {name}:{password}",
28096 "name": "GetUser_Profile_Sections",
28097 "group": "User_Profile_Sections",
28098 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
28099 "version": "0.0.0",
28100 "filename": "server/api/userProfileSection/index.js",
28101 "groupTitle": "User_Profile_Sections"
28105 "url": "/api/userProfile/sections/{id}",
28106 "title": "Gets a single User Profile Section",
28109 "title": "Example usage:",
28110 "content": "curl https://{domain}/api/userProfile/sections/{id} -v -u {name}:{password}",
28114 "name": "ShowUser_Profile_Sections",
28115 "group": "User_Profile_Sections",
28116 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28117 "version": "0.0.0",
28118 "filename": "server/api/userProfileSection/index.js",
28119 "groupTitle": "User_Profile_Sections"
28123 "url": "/api/userProfile/sections/{id}",
28124 "title": "Update an existing User Profile Section",
28127 "title": "Example usage:",
28128 "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",
28132 "name": "updateUser_Profile_Sections",
28133 "group": "User_Profile_Sections",
28134 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28135 "version": "0.0.0",
28136 "filename": "server/api/userProfileSection/index.js",
28137 "groupTitle": "User_Profile_Sections"
28141 "url": "/api/userProfiles/{id}/resources",
28142 "title": "Add resources' permissions to User Profile",
28145 "title": "Example usage:",
28146 "content": "curl https://{domain}/api/userProfiles/{id}/resources -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
28150 "name": "AddResources",
28151 "group": "User_Profiles",
28152 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28153 "version": "0.0.0",
28154 "filename": "server/api/userProfile/index.js",
28155 "groupTitle": "User_Profiles"
28159 "url": "/api/userProfiles/{id}/sections",
28160 "title": "Add sections' permissions to User Profile",
28163 "title": "Example usage:",
28164 "content": "curl https://{domain}/api/userProfiles/{id}/sections -d '[{\"sectionId\": \"name\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
28168 "name": "AddSections",
28169 "group": "User_Profiles",
28170 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28171 "version": "0.0.0",
28172 "filename": "server/api/userProfile/index.js",
28173 "groupTitle": "User_Profiles"
28177 "url": "/api/userProfiles/clone",
28178 "title": "Clone an existing User Profile",
28181 "title": "Example usage:",
28182 "content": "curl https://{domain}/api/userProfiles/clone -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
28186 "name": "CloneUser_Profiles",
28187 "group": "User_Profiles",
28188 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28189 "version": "0.0.0",
28190 "filename": "server/api/userProfile/index.js",
28191 "groupTitle": "User_Profiles"
28195 "url": "/api/userProfiles",
28196 "title": "Creates a new User Profile",
28199 "title": "Example usage:",
28200 "content": "curl https://{domain}/api/userProfiles -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
28204 "name": "CreateUser_Profiles",
28205 "group": "User_Profiles",
28220 "field": "crudPermissions",
28227 "field": "description",
28234 "field": "privacyEnabled",
28240 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28241 "version": "0.0.0",
28242 "filename": "server/api/userProfile/index.js",
28243 "groupTitle": "User_Profiles"
28247 "url": "/api/userProfiles/{id}",
28248 "title": "Deletes a User Profile",
28251 "title": "Example usage:",
28252 "content": "curl https://{domain}/api/userProfiles/{id} -v -u {name}:{password} -X DELETE",
28256 "name": "DeleteUser_Profiles",
28257 "group": "User_Profiles",
28258 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28259 "version": "0.0.0",
28260 "filename": "server/api/userProfile/index.js",
28261 "groupTitle": "User_Profiles"
28265 "url": "/api/userProfiles/describe",
28266 "title": "Gets table info about User Profiles",
28269 "title": "Example usage:",
28270 "content": "curl https://{domain}/api/userProfiles/describe -v -u {name}:{password}",
28274 "name": "DescribeUser_Profiles",
28275 "group": "User_Profiles",
28276 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28277 "version": "0.0.0",
28278 "filename": "server/api/userProfile/index.js",
28279 "groupTitle": "User_Profiles"
28283 "url": "/api/userProfiles/{id}/resources?section={section}",
28284 "title": "Get Resources assigned to a Section",
28287 "title": "Example usage:",
28288 "content": "curl https://{domain}/api/userProfiles/{id}/resources?section={section} -v -u {name}:{password} -X GET",
28292 "name": "GetResources",
28293 "group": "User_Profiles",
28294 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28295 "version": "0.0.0",
28296 "filename": "server/api/userProfile/index.js",
28297 "groupTitle": "User_Profiles"
28301 "url": "/api/userProfiles/{id}/sections",
28302 "title": "Get sections associated to a User Profile",
28305 "title": "Example usage:",
28306 "content": "curl https://{domain}/api/userProfiles/{id}/sections -v -u {name}:{password} -X GET",
28310 "name": "GetSections",
28311 "group": "User_Profiles",
28312 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28313 "version": "0.0.0",
28314 "filename": "server/api/userProfile/index.js",
28315 "groupTitle": "User_Profiles"
28319 "url": "/api/userProfiles",
28320 "title": "Gets a list of User Profiles",
28323 "title": "Example usage:",
28324 "content": "curl https://{domain}/api/userProfiles -v -u {name}:{password}",
28328 "name": "GetUser_Profiles",
28329 "group": "User_Profiles",
28330 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
28331 "version": "0.0.0",
28332 "filename": "server/api/userProfile/index.js",
28333 "groupTitle": "User_Profiles"
28337 "url": "/api/userProfiles/{id}/resources",
28338 "title": "Removes resources' permissions from User Profile",
28341 "title": "Example usage:",
28342 "content": "curl https://{domain}/api/userProfiles/{id}/resources?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
28346 "name": "RemoveResources",
28347 "group": "User_Profiles",
28348 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28349 "version": "0.0.0",
28350 "filename": "server/api/userProfile/index.js",
28351 "groupTitle": "User_Profiles"
28355 "url": "/api/userProfiles/{id}/sections",
28356 "title": "Removes sections' permissions from User Profile",
28359 "title": "Example usage:",
28360 "content": "curl https://{domain}/api/userProfiles/{id}/sections?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
28364 "name": "RemoveSections",
28365 "group": "User_Profiles",
28366 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28367 "version": "0.0.0",
28368 "filename": "server/api/userProfile/index.js",
28369 "groupTitle": "User_Profiles"
28373 "url": "/api/userProfiles/{id}",
28374 "title": "Gets a single User Profile",
28377 "title": "Example usage:",
28378 "content": "curl https://{domain}/api/userProfiles/{id} -v -u {name}:{password}",
28382 "name": "ShowUser_Profiles",
28383 "group": "User_Profiles",
28384 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28385 "version": "0.0.0",
28386 "filename": "server/api/userProfile/index.js",
28387 "groupTitle": "User_Profiles"
28391 "url": "/api/userProfiles/{id}",
28392 "title": "Update an existing User Profile",
28395 "title": "Example usage:",
28396 "content": "curl https://{domain}/api/userProfiles/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
28400 "name": "updateUser_Profiles",
28401 "group": "User_Profiles",
28402 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28403 "version": "0.0.0",
28404 "filename": "server/api/userProfile/index.js",
28405 "groupTitle": "User_Profiles"
28409 "url": "/api/users/{id}/chat_interactions",
28410 "title": "Add chat interaction tabs to an agent",
28413 "title": "Example usage:",
28414 "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",
28418 "name": "AddChatInteractions",
28420 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28421 "version": "0.0.0",
28422 "filename": "server/api/user/index.js",
28423 "groupTitle": "Users"
28427 "url": "/api/users/{id}/chat_websites",
28428 "title": "Add a Chat Website to a user",
28431 "title": "Example usage:",
28432 "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",
28436 "name": "AddChatWebsites",
28438 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28439 "version": "0.0.0",
28440 "filename": "server/api/user/index.js",
28441 "groupTitle": "Users"
28445 "url": "/api/users/{id}/contacts",
28446 "title": "Add contacts to a user",
28449 "title": "Example usage:",
28450 "content": "curl https://{domain}/api/users/{id}/contacts -d '{\"ids\": [1,2]}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
28454 "name": "AddContacts",
28456 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28457 "version": "0.0.0",
28458 "filename": "server/api/user/index.js",
28459 "groupTitle": "Users"
28463 "url": "/api/users/{id}/fax_accounts",
28464 "title": "Add a Fax Account to a user",
28467 "title": "Example usage:",
28468 "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",
28472 "name": "AddFaxAccounts",
28474 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28475 "version": "0.0.0",
28476 "filename": "server/api/user/index.js",
28477 "groupTitle": "Users"
28481 "url": "/api/users/{id}/fax_interactions",
28482 "title": "Add fax interaction tabs to an agent",
28485 "title": "Example usage:",
28486 "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",
28490 "name": "AddFaxInteractions",
28492 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28493 "version": "0.0.0",
28494 "filename": "server/api/user/index.js",
28495 "groupTitle": "Users"
28499 "url": "/api/users/{id}/mail_accounts",
28500 "title": "Add a Mail Account to a user",
28503 "title": "Example usage:",
28504 "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",
28508 "name": "AddMailAccounts",
28510 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28511 "version": "0.0.0",
28512 "filename": "server/api/user/index.js",
28513 "groupTitle": "Users"
28517 "url": "/api/users/{id}/mail_interactions",
28518 "title": "Add mail interaction tabs to an agent",
28521 "title": "Example usage:",
28522 "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",
28526 "name": "AddMailInteractions",
28528 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28529 "version": "0.0.0",
28530 "filename": "server/api/user/index.js",
28531 "groupTitle": "Users"
28535 "url": "/api/users/{id}/openchannel_accounts",
28536 "title": "Add a Open Channel Account to a user",
28539 "title": "Example usage:",
28540 "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",
28544 "name": "AddOpenchannelAccounts",
28546 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28547 "version": "0.0.0",
28548 "filename": "server/api/user/index.js",
28549 "groupTitle": "Users"
28553 "url": "/api/users/{id}/openchannel_interactions",
28554 "title": "Add openchannel interaction tabs to an agent",
28557 "title": "Example usage:",
28558 "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",
28562 "name": "AddOpenchannelInteractions",
28564 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28565 "version": "0.0.0",
28566 "filename": "server/api/user/index.js",
28567 "groupTitle": "Users"
28571 "url": "/api/users/{id}/queues",
28572 "title": "Add queues to an agent",
28575 "title": "Example usage:",
28576 "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",
28580 "name": "AddQueues",
28582 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28583 "version": "0.0.0",
28584 "filename": "server/api/user/index.js",
28585 "groupTitle": "Users"
28589 "url": "/api/users/{id}/sms_accounts",
28590 "title": "Add a Sms Account to a user",
28593 "title": "Example usage:",
28594 "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",
28598 "name": "AddSmsAccounts",
28600 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28601 "version": "0.0.0",
28602 "filename": "server/api/user/index.js",
28603 "groupTitle": "Users"
28607 "url": "/api/users/{id}/sms_interactions",
28608 "title": "Add sms interaction tabs to an agent",
28611 "title": "Example usage:",
28612 "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",
28616 "name": "AddSmsInteractions",
28618 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28619 "version": "0.0.0",
28620 "filename": "server/api/user/index.js",
28621 "groupTitle": "Users"
28625 "url": "/api/users/{id}/square_projects",
28626 "title": "Add a Square Project to a user",
28629 "title": "Example usage:",
28630 "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",
28634 "name": "AddSquareProjects",
28636 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28637 "version": "0.0.0",
28638 "filename": "server/api/user/index.js",
28639 "groupTitle": "Users"
28643 "url": "/api/users/{id}/teams",
28644 "title": "Add teams to an agent",
28647 "title": "Example usage:",
28648 "content": "curl https://{domain}/api/users/{id}/teams -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
28652 "name": "AddTeams",
28654 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28655 "version": "0.0.0",
28656 "filename": "server/api/user/index.js",
28657 "groupTitle": "Users"
28661 "url": "/api/users/{id}/whatsapp_accounts",
28662 "title": "Add a Whatsapp Account to a user",
28665 "title": "Example usage:",
28666 "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",
28670 "name": "AddWhatsappAccounts",
28672 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28673 "version": "0.0.0",
28674 "filename": "server/api/user/index.js",
28675 "groupTitle": "Users"
28679 "url": "/api/users/{id}/whatsapp_interactions",
28680 "title": "Add Whatsapp interaction tabs to an agent",
28683 "title": "Example usage:",
28684 "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",
28688 "name": "AddWhatsappInteractions",
28690 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28691 "version": "0.0.0",
28692 "filename": "server/api/user/index.js",
28693 "groupTitle": "Users"
28697 "url": "/api/users/{id}/password",
28698 "title": "Change user password",
28701 "title": "Example usage:",
28702 "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",
28706 "name": "ChangePwd",
28708 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28709 "version": "0.0.0",
28710 "filename": "server/api/user/index.js",
28711 "groupTitle": "Users"
28715 "url": "/api/users",
28716 "title": "Create a new user",
28719 "title": "Example usage:",
28720 "content": "curl https://{domain}/api/users -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
28726 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28727 "version": "0.0.0",
28728 "filename": "server/api/user/index.js",
28729 "groupTitle": "Users"
28733 "url": "/api/users/{id}/api_key",
28734 "title": "Create a new API access key for the user",
28737 "title": "Example usage:",
28738 "content": "curl https://{domain}/api/users/:id/api_key -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
28742 "name": "CreateApiKey",
28744 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28745 "version": "0.0.0",
28746 "filename": "server/api/user/index.js",
28747 "groupTitle": "Users"
28751 "url": "/api/users/{id}",
28752 "title": "Deletes a user",
28755 "title": "Example usage:",
28756 "content": "curl https://{domain}/api/users/{id} -v -u {name}:{password} -X DELETE",
28762 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28763 "version": "0.0.0",
28764 "filename": "server/api/user/index.js",
28765 "groupTitle": "Users"
28769 "url": "/api/users/describe",
28770 "title": "Gets table info about Users",
28773 "title": "Example usage:",
28774 "content": "curl https://{domain}/api/users/describe -v -u {name}:{password}",
28778 "name": "DescribeUsers",
28780 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28781 "version": "0.0.0",
28782 "filename": "server/api/user/index.js",
28783 "groupTitle": "Users"
28787 "url": "/api/users/{id}/agents",
28788 "title": "GetAgents",
28791 "title": "Example usage:",
28792 "content": "curl https://{domain}/api/users/{id}/agents -v -u {name}:{password} -X GET",
28796 "name": "GetAgents",
28798 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28799 "version": "0.0.0",
28800 "filename": "server/api/user/index.js",
28801 "groupTitle": "Users"
28805 "url": "/api/users/{id}/api_key",
28806 "title": "Get the API access key for the user",
28809 "title": "Example usage:",
28810 "content": "curl https://{domain}/api/users/:id/api_key -v -u {name}:{password} -X GET",
28814 "name": "GetApiKey",
28816 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28817 "version": "0.0.0",
28818 "filename": "server/api/user/index.js",
28819 "groupTitle": "Users"
28823 "url": "/api/users/{id}/groups",
28824 "title": "GetChatGroups",
28827 "title": "Example usage:",
28828 "content": "curl https://{domain}/api/users/{id}/groups -v -u {name}:{password} -X GET",
28832 "name": "GetChatGroups",
28834 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28835 "version": "0.0.0",
28836 "filename": "server/api/user/index.js",
28837 "groupTitle": "Users"
28841 "url": "/api/users/{id}/chat/interactions",
28842 "title": "GetChatInteractions",
28845 "title": "Example usage:",
28846 "content": "curl https://{domain}/api/users/{id}/chat/interactions -v -u {name}:{password} -X GET",
28850 "name": "GetChatInteractions",
28852 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28853 "version": "0.0.0",
28854 "filename": "server/api/user/index.js",
28855 "groupTitle": "Users"
28859 "url": "/api/users/{id}/chat_websites",
28860 "title": "GetChatWebsites",
28863 "title": "Example usage:",
28864 "content": "curl https://{domain}/api/users/{id}/chat_websites -v -u {name}:{password} -X GET",
28868 "name": "GetChatWebsites",
28870 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28871 "version": "0.0.0",
28872 "filename": "server/api/user/index.js",
28873 "groupTitle": "Users"
28877 "url": "/api/users/{id}/contacts",
28878 "title": "GetContacts",
28881 "title": "Example usage:",
28882 "content": "curl https://{domain}/api/users/{id}/contacts -v -u {name}:{password} -X GET",
28886 "name": "GetContacts",
28888 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28889 "version": "0.0.0",
28890 "filename": "server/api/user/index.js",
28891 "groupTitle": "Users"
28895 "url": "/api/users/{id}/fax_accounts",
28896 "title": "GetFaxAccounts",
28899 "title": "Example usage:",
28900 "content": "curl https://{domain}/api/users/{id}/fax_accounts -v -u {name}:{password} -X GET",
28904 "name": "GetFaxAccounts",
28906 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28907 "version": "0.0.0",
28908 "filename": "server/api/user/index.js",
28909 "groupTitle": "Users"
28913 "url": "/api/users/{id}/fax/interactions",
28914 "title": "GetFaxInteractions",
28917 "title": "Example usage:",
28918 "content": "curl https://{domain}/api/users/{id}/fax/interactions -v -u {name}:{password} -X GET",
28922 "name": "GetFaxInteractions",
28924 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28925 "version": "0.0.0",
28926 "filename": "server/api/user/index.js",
28927 "groupTitle": "Users"
28931 "url": "/api/users/{id}/lists",
28932 "title": "GetLists",
28935 "title": "Example usage:",
28936 "content": "curl https://{domain}/api/users/{id}/lists -v -u {name}:{password} -X GET",
28940 "name": "GetLists",
28942 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28943 "version": "0.0.0",
28944 "filename": "server/api/user/index.js",
28945 "groupTitle": "Users"
28949 "url": "/api/users/{id}/mail_accounts",
28950 "title": "GetMailAccounts",
28953 "title": "Example usage:",
28954 "content": "curl https://{domain}/api/users/{id}/mail_accounts -v -u {name}:{password} -X GET",
28958 "name": "GetMailAccounts",
28960 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28961 "version": "0.0.0",
28962 "filename": "server/api/user/index.js",
28963 "groupTitle": "Users"
28967 "url": "/api/users/{id}/mail/interactions",
28968 "title": "GetMailInteractions",
28971 "title": "Example usage:",
28972 "content": "curl https://{domain}/api/users/{id}/mail/interactions -v -u {name}:{password} -X GET",
28976 "name": "GetMailInteractions",
28978 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28979 "version": "0.0.0",
28980 "filename": "server/api/user/index.js",
28981 "groupTitle": "Users"
28985 "url": "/api/users/{id}/openchannel_accounts",
28986 "title": "GetOpenchannelAccounts",
28989 "title": "Example usage:",
28990 "content": "curl https://{domain}/api/users/{id}/openchannel_accounts -v -u {name}:{password} -X GET",
28994 "name": "GetOpenchannelAccounts",
28996 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28997 "version": "0.0.0",
28998 "filename": "server/api/user/index.js",
28999 "groupTitle": "Users"
29003 "url": "/api/users/{id}/openchannel/interactions",
29004 "title": "GetOpenchannelInteractions",
29007 "title": "Example usage:",
29008 "content": "curl https://{domain}/api/users/{id}/openchannel/interactions -v -u {name}:{password}",
29012 "name": "GetOpenchannelInteractions",
29014 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29015 "version": "0.0.0",
29016 "filename": "server/api/user/index.js",
29017 "groupTitle": "Users"
29021 "url": "/api/users/{id}/prefixes",
29022 "title": "GetPrefixes",
29025 "title": "Example usage:",
29026 "content": "curl https://{domain}/api/users/{id}/prefixes -v -u {name}:{password} -X GET",
29030 "name": "GetPrefixes",
29032 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29033 "version": "0.0.0",
29034 "filename": "server/api/user/index.js",
29035 "groupTitle": "Users"
29039 "url": "/api/users/{id}/queues?channel={channel}",
29040 "title": "Gets Queues list",
29043 "title": "Example usage:",
29044 "content": "curl https://{domain}/api/users/{id}/queues/?channel={channel} -v -u {name}:{password} -X GET",
29048 "name": "GetQueues",
29050 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29051 "version": "0.0.0",
29052 "filename": "server/api/user/index.js",
29053 "groupTitle": "Users"
29057 "url": "/api/users/{id}/recordings",
29058 "title": "GetRecordings",
29061 "title": "Example usage:",
29062 "content": "curl https://{domain}/api/users/{id}/recordings -v -u {name}:{password} -X GET",
29066 "name": "GetRecordings",
29068 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29069 "version": "0.0.0",
29070 "filename": "server/api/user/index.js",
29071 "groupTitle": "Users"
29075 "url": "/api/users/{id}/scheduled_calls",
29076 "title": "GetScheduledCalls",
29079 "title": "Example usage:",
29080 "content": "curl https://{domain}/api/users/{id}/scheduled_calls -v -u {name}:{password} -X GET",
29084 "name": "GetScheduledCalls",
29086 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29087 "version": "0.0.0",
29088 "filename": "server/api/user/index.js",
29089 "groupTitle": "Users"
29093 "url": "/api/users/{id}/screen_recordings",
29094 "title": "GetScreenRecordings",
29097 "title": "Example usage:",
29098 "content": "curl https://{domain}/api/users/{id}/screen_recordings -v -u {name}:{password} -X GET",
29102 "name": "GetScreenRecordings",
29104 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29105 "version": "0.0.0",
29106 "filename": "server/api/user/index.js",
29107 "groupTitle": "Users"
29111 "url": "/api/users/{id}/sms_accounts",
29112 "title": "GetSmsAccounts",
29115 "title": "Example usage:",
29116 "content": "curl https://{domain}/api/users/{id}/sms_accounts -v -u {name}:{password} -X GET",
29120 "name": "GetSmsAccounts",
29122 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29123 "version": "0.0.0",
29124 "filename": "server/api/user/index.js",
29125 "groupTitle": "Users"
29129 "url": "/api/users/{id}/sms/interactions",
29130 "title": "GetSmsInteractions",
29133 "title": "Example usage:",
29134 "content": "curl https://{domain}/api/users/{id}/sms/interactions -v -u {name}:{password} -X GET",
29138 "name": "GetSmsInteractions",
29140 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29141 "version": "0.0.0",
29142 "filename": "server/api/user/index.js",
29143 "groupTitle": "Users"
29147 "url": "/api/users/{id}/square_projects",
29148 "title": "GetSquareProjects",
29151 "title": "Example usage:",
29152 "content": "curl https://{domain}/api/users/{id}/square_projects -v -u {name}:{password} -X GET",
29156 "name": "GetSquareProjects",
29158 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29159 "version": "0.0.0",
29160 "filename": "server/api/user/index.js",
29161 "groupTitle": "Users"
29165 "url": "/api/users/{id}/teams",
29166 "title": "GetTeams",
29169 "title": "Example usage:",
29170 "content": "curl https://{domain}/api/users/{id}/teams -v -u {name}:{password} -X GET",
29174 "name": "GetTeams",
29176 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29177 "version": "0.0.0",
29178 "filename": "server/api/user/index.js",
29179 "groupTitle": "Users"
29183 "url": "/api/users",
29184 "title": "Gets a list of Users",
29187 "title": "Example usage:",
29188 "content": "curl https://{domain}/api/users -v -u {name}:{password}",
29192 "name": "GetUsers",
29194 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
29195 "version": "0.0.0",
29196 "filename": "server/api/user/index.js",
29197 "groupTitle": "Users"
29201 "url": "/api/users/{id}/queues_rt",
29202 "title": "GetVoiceQueuesRt",
29205 "title": "Example usage:",
29206 "content": "curl https://{domain}/api/users/{id}/queues_rt -v -u {name}:{password} -X GET",
29210 "name": "GetVoiceQueuesRt",
29212 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29213 "version": "0.0.0",
29214 "filename": "server/api/user/index.js",
29215 "groupTitle": "Users"
29219 "url": "/api/users/{id}/whatsapp_accounts",
29220 "title": "GetWhatsappAccounts",
29223 "title": "Example usage:",
29224 "content": "curl https://{domain}/api/users/{id}/whatsapp_accounts -v -u {name}:{password} -X GET",
29228 "name": "GetWhatsappAccounts",
29230 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29231 "version": "0.0.0",
29232 "filename": "server/api/user/index.js",
29233 "groupTitle": "Users"
29237 "url": "/api/users/{id}/whatsapp/interactions",
29238 "title": "GetWhatsappInteractions",
29241 "title": "Example usage:",
29242 "content": "curl https://{domain}/api/users/{id}/whatsapp/interactions -v -u {name}:{password} -X GET",
29246 "name": "GetWhatsappInteractions",
29248 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29249 "version": "0.0.0",
29250 "filename": "server/api/user/index.js",
29251 "groupTitle": "Users"
29255 "url": "/api/users/{id}/login",
29259 "title": "Example usage:",
29260 "content": "curl https://{domain}/api/users/{id}/login -v -u {name}:{password} -X POST",
29266 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29267 "version": "0.0.0",
29268 "filename": "server/api/user/index.js",
29269 "groupTitle": "Users"
29273 "url": "/api/users/{id}/logout",
29277 "title": "Example usage:",
29278 "content": "curl https://{domain}/api/users/{id}/logout -v -u {name}:{password} -X POST",
29284 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29285 "version": "0.0.0",
29286 "filename": "server/api/user/index.js",
29287 "groupTitle": "Users"
29291 "url": "/api/users/{id}/pause",
29295 "title": "Example usage:",
29296 "content": "curl https://{domain}/api/users/{id}/pause -v -u {name}:{password} -X POST",
29302 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29303 "version": "0.0.0",
29304 "filename": "server/api/user/index.js",
29305 "groupTitle": "Users"
29309 "url": "/api/users/{id}/api_key",
29310 "title": "Remove API access key for the user",
29313 "title": "Example usage:",
29314 "content": "curl https://{domain}/api/users/:id/api_key -v -u {name}:{password} -X DELETE",
29318 "name": "RemoveApiKey",
29320 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29321 "version": "0.0.0",
29322 "filename": "server/api/user/index.js",
29323 "groupTitle": "Users"
29327 "url": "/api/users/{id}/chat_interactions",
29328 "title": "Removes interactions from an agent",
29331 "title": "Example usage:",
29332 "content": "curl https://{domain}/api/users/{id}/chat_interactions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29336 "name": "RemoveChatInteractions",
29338 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29339 "version": "0.0.0",
29340 "filename": "server/api/user/index.js",
29341 "groupTitle": "Users"
29345 "url": "/api/users/{id}/chat_websites",
29346 "title": "Removes a Chat Website from a user",
29349 "title": "Example usage:",
29350 "content": "curl https://{domain}/api/users/{id}/chat_websites?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29354 "name": "RemoveChatWebsites",
29356 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29357 "version": "0.0.0",
29358 "filename": "server/api/user/index.js",
29359 "groupTitle": "Users"
29363 "url": "/api/users/{id}/fax_accounts",
29364 "title": "Removes a Fax Account from a user",
29367 "title": "Example usage:",
29368 "content": "curl https://{domain}/api/users/{id}/fax_accounts?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29372 "name": "RemoveFaxAccounts",
29374 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29375 "version": "0.0.0",
29376 "filename": "server/api/user/index.js",
29377 "groupTitle": "Users"
29381 "url": "/api/users/{id}/fax_interactions",
29382 "title": "Removes interactions from an agent",
29385 "title": "Example usage:",
29386 "content": "curl https://{domain}/api/users/{id}/fax_interactions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29390 "name": "RemoveFaxInteractions",
29392 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29393 "version": "0.0.0",
29394 "filename": "server/api/user/index.js",
29395 "groupTitle": "Users"
29399 "url": "/api/users/{id}/mail_accounts",
29400 "title": "Removes a Mail Account from a user",
29403 "title": "Example usage:",
29404 "content": "curl https://{domain}/api/users/{id}/mail_accounts?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29408 "name": "RemoveMailAccounts",
29410 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29411 "version": "0.0.0",
29412 "filename": "server/api/user/index.js",
29413 "groupTitle": "Users"
29417 "url": "/api/users/{id}/mail_interactions",
29418 "title": "Removes interactions from an agent",
29421 "title": "Example usage:",
29422 "content": "curl https://{domain}/api/users/{id}/mail_interactions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29426 "name": "RemoveMailInteractions",
29428 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29429 "version": "0.0.0",
29430 "filename": "server/api/user/index.js",
29431 "groupTitle": "Users"
29435 "url": "/api/users/{id}/openchannel_accounts",
29436 "title": "Removes a Open Channel Account from a user",
29439 "title": "Example usage:",
29440 "content": "curl https://{domain}/api/users/{id}/openchannel_accounts?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29444 "name": "RemoveOpenchannelAccounts",
29446 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29447 "version": "0.0.0",
29448 "filename": "server/api/user/index.js",
29449 "groupTitle": "Users"
29453 "url": "/api/users/{id}/openchannel_interactions",
29454 "title": "Removes openchannel interactions from an agent",
29457 "title": "Example usage:",
29458 "content": "curl https://{domain}/api/users/{id}/openchannel_interactions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29462 "name": "RemoveOpenchannelInteractions",
29464 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29465 "version": "0.0.0",
29466 "filename": "server/api/user/index.js",
29467 "groupTitle": "Users"
29471 "url": "/api/users/{id}/queues",
29472 "title": "Remove queues to an agent",
29475 "title": "Example usage:",
29476 "content": "curl https://{domain}/api/users/{id}/queues?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29480 "name": "RemoveQueues",
29482 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29483 "version": "0.0.0",
29484 "filename": "server/api/user/index.js",
29485 "groupTitle": "Users"
29489 "url": "/api/users/{id}/sms_accounts",
29490 "title": "Removes a Sms Account from a user",
29493 "title": "Example usage:",
29494 "content": "curl https://{domain}/api/users/{id}/sms_accounts?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29498 "name": "RemoveSmsAccounts",
29500 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29501 "version": "0.0.0",
29502 "filename": "server/api/user/index.js",
29503 "groupTitle": "Users"
29507 "url": "/api/users/{id}/sms_interactions",
29508 "title": "Removes interactions from an agent",
29511 "title": "Example usage:",
29512 "content": "curl https://{domain}/api/users/{id}/sms_interactions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29516 "name": "RemoveSmsInteractions",
29518 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29519 "version": "0.0.0",
29520 "filename": "server/api/user/index.js",
29521 "groupTitle": "Users"
29525 "url": "/api/users/{id}/square_projects",
29526 "title": "Removes a Square Project from a user",
29529 "title": "Example usage:",
29530 "content": "curl https://{domain}/api/users/{id}/square_projects?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29534 "name": "RemoveSquareProjects",
29536 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29537 "version": "0.0.0",
29538 "filename": "server/api/user/index.js",
29539 "groupTitle": "Users"
29543 "url": "/api/users/{id}/teams",
29544 "title": "Removes teams from an agent",
29547 "title": "Example usage:",
29548 "content": "curl https://{domain}/api/users/{id}/teams?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29552 "name": "RemoveTeams",
29554 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29555 "version": "0.0.0",
29556 "filename": "server/api/user/index.js",
29557 "groupTitle": "Users"
29561 "url": "/api/users/{id}/whatsapp_accounts",
29562 "title": "Removes a Whatsapp Account from a user",
29565 "title": "Example usage:",
29566 "content": "curl https://{domain}/api/users/{id}/whatsapp_accounts?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29570 "name": "RemoveWhatsappAccounts",
29572 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29573 "version": "0.0.0",
29574 "filename": "server/api/user/index.js",
29575 "groupTitle": "Users"
29579 "url": "/api/users/{id}/whatsapp_interactions",
29580 "title": "Removes Whatsapp interactions from an agent",
29583 "title": "Example usage:",
29584 "content": "curl https://{domain}/api/users/{id}/whatsapp_interactions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29588 "name": "RemoveWhatsappInteractions",
29590 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29591 "version": "0.0.0",
29592 "filename": "server/api/user/index.js",
29593 "groupTitle": "Users"
29597 "url": "/api/users/{id}",
29598 "title": "Gets a single User",
29601 "title": "Example usage:",
29602 "content": "curl https://{domain}/api/users/{id} -v -u {name}:{password}",
29606 "name": "ShowUsers",
29608 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29609 "version": "0.0.0",
29610 "filename": "server/api/user/index.js",
29611 "groupTitle": "Users"
29615 "url": "/api/users/{id}/unpause",
29616 "title": "Unpause",
29619 "title": "Example usage:",
29620 "content": "curl https://{domain}/api/users/{id}/unpause -v -u {name}:{password} -X POST",
29626 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29627 "version": "0.0.0",
29628 "filename": "server/api/user/index.js",
29629 "groupTitle": "Users"
29633 "url": "/api/users/whoami",
29637 "title": "Example usage:",
29638 "content": "curl https://{domain}/api/users/whoami -v -u {name}:{password} -X GET",
29644 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29645 "version": "0.0.0",
29646 "filename": "server/api/user/index.js",
29647 "groupTitle": "Users"
29651 "url": "/api/users/{id}/avatar",
29652 "title": "Add avatar",
29655 "title": "Example usage:",
29656 "content": "curl https://{domain}/api/users/{id}/avatar -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
29660 "name": "addAvatar",
29662 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29663 "version": "0.0.0",
29664 "filename": "server/api/user/index.js",
29665 "groupTitle": "Users"
29669 "url": "/api/users/create_many",
29670 "title": "Create Users",
29673 "title": "Example usage:",
29674 "content": "curl https://{domain}/api/users/create_many -d '[{\"name\": \"john.doe\", \"role\": \"user\", \"...\": \"...\"}]' -v -u {name}:{password} -X POST",
29678 "name": "bulkCreate",
29680 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29681 "version": "0.0.0",
29682 "filename": "server/api/user/index.js",
29683 "groupTitle": "Users"
29687 "url": "/api/users/{id}/avatar",
29688 "title": "Get avatar",
29691 "title": "Example usage:",
29692 "content": "curl https://{domain}/api/users/{id}/avatar -v -u {name}:{password} -X GET",
29696 "name": "getAvatar",
29698 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29699 "version": "0.0.0",
29700 "filename": "server/api/user/index.js",
29701 "groupTitle": "Users"
29705 "url": "/api/users/{id}/open_tabs",
29706 "title": "Get interactions opened tabs",
29709 "title": "Example usage:",
29710 "content": "curl https://{domain}/api/users/{id}/open_tabs -v -u {name}:{password} -X GET",
29714 "name": "getOpenTabs",
29716 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29717 "version": "0.0.0",
29718 "filename": "server/api/user/index.js",
29719 "groupTitle": "Users"
29723 "url": "/api/users/presence",
29724 "title": "Gets agent presence",
29727 "title": "Example usage:",
29728 "content": "curl https://{domain}/api/users/presence -v -u {name}:{password} -X GET",
29732 "name": "getPresence",
29734 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29735 "version": "0.0.0",
29736 "filename": "server/api/user/index.js",
29737 "groupTitle": "Users"
29741 "url": "/api/users/{id}",
29742 "title": "Update an existing User",
29745 "title": "Example usage:",
29746 "content": "curl https://{domain}/api/users/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
29750 "name": "updateUsers",
29752 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29753 "version": "0.0.0",
29754 "filename": "server/api/user/index.js",
29755 "groupTitle": "Users"
29759 "url": "/api/variables",
29760 "title": "Creates a new Variable",
29763 "title": "Example usage:",
29764 "content": "curl https://{domain}/api/variables -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
29768 "name": "CreateVariables",
29769 "group": "Variables",
29784 "field": "description",
29790 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29791 "version": "0.0.0",
29792 "filename": "server/api/variable/index.js",
29793 "groupTitle": "Variables"
29797 "url": "/api/variables/{id}",
29798 "title": "Deletes a Variable",
29801 "title": "Example usage:",
29802 "content": "curl https://{domain}/api/variables/{id} -v -u {name}:{password} -X DELETE",
29806 "name": "DeleteVariables",
29807 "group": "Variables",
29808 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29809 "version": "0.0.0",
29810 "filename": "server/api/variable/index.js",
29811 "groupTitle": "Variables"
29815 "url": "/api/variables",
29816 "title": "Gets a list of Variables",
29819 "title": "Example usage:",
29820 "content": "curl https://{domain}/api/variables -v -u {name}:{password}",
29824 "name": "GetVariables",
29825 "group": "Variables",
29826 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
29827 "version": "0.0.0",
29828 "filename": "server/api/variable/index.js",
29829 "groupTitle": "Variables"
29833 "url": "/api/variables/{id}",
29834 "title": "Gets a single Variable",
29837 "title": "Example usage:",
29838 "content": "curl https://{domain}/api/variables/{id} -v -u {name}:{password}",
29842 "name": "ShowVariables",
29843 "group": "Variables",
29844 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29845 "version": "0.0.0",
29846 "filename": "server/api/variable/index.js",
29847 "groupTitle": "Variables"
29851 "url": "/api/variables/{id}",
29852 "title": "Update an existing Variable",
29855 "title": "Example usage:",
29856 "content": "curl https://{domain}/api/variables/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
29860 "name": "updateVariables",
29861 "group": "Variables",
29862 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29863 "version": "0.0.0",
29864 "filename": "server/api/variable/index.js",
29865 "groupTitle": "Variables"
29869 "url": "/api/version/fetch",
29870 "title": "Fetch git version",
29873 "title": "Example usage:",
29874 "content": "curl https://{domain}/api/version/fetch -v -u {name}:{password}",
29878 "name": "FetchVersion",
29879 "group": "Version",
29880 "description": "<p>Motion run the following command: git fetch origin master</p>",
29881 "version": "0.0.0",
29882 "filename": "server/api/version/index.js",
29883 "groupTitle": "Version"
29887 "url": "/api/version",
29888 "title": "Gets version",
29891 "title": "Example usage:",
29892 "content": "curl https://{domain}/api/version -v -u {name}:{password}",
29896 "name": "GetVersion",
29897 "group": "Version",
29898 "description": "<p>Motion returns the current and latest motion version.</p>",
29899 "version": "0.0.0",
29900 "filename": "server/api/version/index.js",
29901 "groupTitle": "Version"
29905 "url": "/api/version/migrations",
29906 "title": "Launch database migrations",
29909 "title": "Example usage:",
29910 "content": "curl https://{domain}/api/version/migrations -v -u {name}:{password}",
29914 "name": "MigrateVersion",
29915 "group": "Version",
29916 "description": "<p>Motion launch the database migrations, according to the application version</p>",
29917 "version": "0.0.0",
29918 "filename": "server/api/version/index.js",
29919 "groupTitle": "Version"
29923 "url": "/api/version/pull",
29924 "title": "Pull git version",
29927 "title": "Example usage:",
29928 "content": "curl https://{domain}/api/version/pull -v -u {name}:{password}",
29932 "name": "PullVersion",
29933 "group": "Version",
29934 "description": "<p>Motion run the following command: git pull</p>",
29935 "version": "0.0.0",
29936 "filename": "server/api/version/index.js",
29937 "groupTitle": "Version"
29941 "url": "/api/version/reset",
29942 "title": "Reset git version",
29945 "title": "Example usage:",
29946 "content": "curl https://{domain}/api/version/reset -v -u {name}:{password}",
29950 "name": "ResetVersion",
29951 "group": "Version",
29952 "description": "<p>Motion run the following command: git reset --hard FETCH_HEAD</p>",
29953 "version": "0.0.0",
29954 "filename": "server/api/version/index.js",
29955 "groupTitle": "Version"
29959 "url": "/api/version/restart",
29960 "title": "Restart motion2 after update",
29963 "title": "Example usage:",
29964 "content": "curl https://{domain}/api/version/restart -v -u {name}:{password}",
29968 "name": "RestartVersion",
29969 "group": "Version",
29970 "description": "<p>Motion run the following command: pm2 restart motion</p>",
29971 "version": "0.0.0",
29972 "filename": "server/api/version/index.js",
29973 "groupTitle": "Version"
29977 "url": "/api/voice/agents/reports/describe",
29978 "title": "Gets table info about Agent Reports",
29981 "title": "Example usage:",
29982 "content": "curl https://{domain}/api/voice/agents/reports/describe -v -u {name}:{password}",
29986 "name": "DescribeAgent_Reports",
29987 "group": "Voice_Agent_Reports",
29988 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29989 "version": "0.0.0",
29990 "filename": "server/api/voiceAgentReport/index.js",
29991 "groupTitle": "Voice_Agent_Reports"
29995 "url": "/api/voice/agents/reports",
29996 "title": "Gets a list of Agent Reports",
29999 "title": "Example usage:",
30000 "content": "curl https://{domain}/api/voice/agents/reports -v -u {name}:{password}",
30004 "name": "GetAgent_Reports",
30005 "group": "Voice_Agent_Reports",
30006 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
30007 "version": "0.0.0",
30008 "filename": "server/api/voiceAgentReport/index.js",
30009 "groupTitle": "Voice_Agent_Reports"
30013 "url": "/api/voice/agents/reports/{id}",
30014 "title": "Gets a single Agent Report",
30017 "title": "Example usage:",
30018 "content": "curl https://{domain}/api/voice/agents/reports/{id} -v -u {name}:{password}",
30022 "name": "ShowAgent_Reports",
30023 "group": "Voice_Agent_Reports",
30024 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30025 "version": "0.0.0",
30026 "filename": "server/api/voiceAgentReport/index.js",
30027 "groupTitle": "Voice_Agent_Reports"
30031 "url": "/api/voice/calls/reports/describe",
30032 "title": "Gets table info about Call Reports",
30035 "title": "Example usage:",
30036 "content": "curl https://{domain}/api/voice/calls/reports/describe -v -u {name}:{password}",
30040 "name": "DescribeCall_Reports",
30041 "group": "Voice_Call_Reports",
30042 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30043 "version": "0.0.0",
30044 "filename": "server/api/voiceCallReport/index.js",
30045 "groupTitle": "Voice_Call_Reports"
30049 "url": "/api/voice/calls/reports",
30050 "title": "Gets a list of Call Reports",
30053 "title": "Example usage:",
30054 "content": "curl https://{domain}/api/voice/calls/reports -v -u {name}:{password}",
30058 "name": "GetCall_Reports",
30059 "group": "Voice_Call_Reports",
30060 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
30061 "version": "0.0.0",
30062 "filename": "server/api/voiceCallReport/index.js",
30063 "groupTitle": "Voice_Call_Reports"
30067 "url": "/api/voice/calls/reports/{id}",
30068 "title": "Gets a single Call Report",
30071 "title": "Example usage:",
30072 "content": "curl https://{domain}/api/voice/calls/reports/{id} -v -u {name}:{password}",
30076 "name": "ShowCall_Reports",
30077 "group": "Voice_Call_Reports",
30078 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30079 "version": "0.0.0",
30080 "filename": "server/api/voiceCallReport/index.js",
30081 "groupTitle": "Voice_Call_Reports"
30085 "url": "/api/voice/calls/reports/{id}",
30086 "title": "Update a single cdr",
30089 "title": "Example usage:",
30090 "content": "curl https://{domain}/api/voice/calls/reports/{id} -d '{\"userDispositio\": \"OK\"}' -v -u {name}:{password} -X PUT",
30095 "group": "Voice_Call_Reports",
30096 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30097 "version": "0.0.0",
30098 "filename": "server/api/voiceCallReport/index.js",
30099 "groupTitle": "Voice_Call_Reports"
30103 "url": "/api/voice/chanspy",
30104 "title": "Creates a new ChanSpy",
30107 "title": "Example usage:",
30108 "content": "curl https://{domain}/api/voice/chanspy -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
30112 "name": "CreateChanSpy",
30113 "group": "Voice_ChanSpy",
30135 "field": "options",
30149 "field": "password",
30163 "field": "recordingFormat",
30170 "field": "description",
30176 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30177 "version": "0.0.0",
30178 "filename": "server/api/voiceChanSpy/index.js",
30179 "groupTitle": "Voice_ChanSpy"
30183 "url": "/api/voice/chanspy/{id}",
30184 "title": "Deletes a ChanSpy",
30187 "title": "Example usage:",
30188 "content": "curl https://{domain}/api/voice/chanspy/{id} -v -u {name}:{password} -X DELETE",
30192 "name": "DeleteChanSpy",
30193 "group": "Voice_ChanSpy",
30194 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30195 "version": "0.0.0",
30196 "filename": "server/api/voiceChanSpy/index.js",
30197 "groupTitle": "Voice_ChanSpy"
30201 "url": "/api/voice/chanspy",
30202 "title": "Gets a list of ChanSpy",
30205 "title": "Example usage:",
30206 "content": "curl https://{domain}/api/voice/chanspy -v -u {name}:{password}",
30210 "name": "GetChanSpy",
30211 "group": "Voice_ChanSpy",
30212 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
30213 "version": "0.0.0",
30214 "filename": "server/api/voiceChanSpy/index.js",
30215 "groupTitle": "Voice_ChanSpy"
30219 "url": "/api/voice/chanspy/{id}",
30220 "title": "Gets a single ChanSpy",
30223 "title": "Example usage:",
30224 "content": "curl https://{domain}/api/voice/chanspy/{id} -v -u {name}:{password}",
30228 "name": "ShowChanSpy",
30229 "group": "Voice_ChanSpy",
30230 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30231 "version": "0.0.0",
30232 "filename": "server/api/voiceChanSpy/index.js",
30233 "groupTitle": "Voice_ChanSpy"
30237 "url": "/api/voice/chanspy/{id}",
30238 "title": "Update an existing ChanSpy",
30241 "title": "Example usage:",
30242 "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",
30246 "name": "updateChanSpy",
30247 "group": "Voice_ChanSpy",
30248 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30249 "version": "0.0.0",
30250 "filename": "server/api/voiceChanSpy/index.js",
30251 "groupTitle": "Voice_ChanSpy"
30255 "url": "/api/voice/contexts",
30256 "title": "Create a new context",
30259 "title": "Example usage:",
30260 "content": "curl https://{domain}/api/voice/contexts -v -u {name}:{password} -X POST",
30265 "group": "Voice_Contexts",
30280 "field": "description",
30287 "field": "defaultEntry",
30293 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30294 "version": "0.0.0",
30295 "filename": "server/api/voiceContext/index.js",
30296 "groupTitle": "Voice_Contexts"
30300 "url": "/api/voice/contexts/{id}",
30301 "title": "Deletes a context",
30304 "title": "Example usage:",
30305 "content": "curl https://{domain}/api/voice/contexts/{id} -v -u {name}:{password} -X DELETE",
30310 "group": "Voice_Contexts",
30311 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30312 "version": "0.0.0",
30313 "filename": "server/api/voiceContext/index.js",
30314 "groupTitle": "Voice_Contexts"
30318 "url": "/api/voice/contexts",
30319 "title": "Gets a list of Contexts",
30322 "title": "Example usage:",
30323 "content": "curl https://{domain}/api/voice/contexts -v -u {name}:{password}",
30327 "name": "GetContexts",
30328 "group": "Voice_Contexts",
30329 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
30330 "version": "0.0.0",
30331 "filename": "server/api/voiceContext/index.js",
30332 "groupTitle": "Voice_Contexts"
30336 "url": "/api/voice/contexts/{id}",
30337 "title": "Gets a single Context",
30340 "title": "Example usage:",
30341 "content": "curl https://{domain}/api/voice/contexts/{id} -v -u {name}:{password}",
30345 "name": "ShowContexts",
30346 "group": "Voice_Contexts",
30347 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30348 "version": "0.0.0",
30349 "filename": "server/api/voiceContext/index.js",
30350 "groupTitle": "Voice_Contexts"
30354 "url": "/api/voice/contexts/{id}",
30355 "title": "Update an existing context",
30358 "title": "Example usage:",
30359 "content": "curl https://{domain}/api/voice/contexts/{id} -v -u {name}:{password} -X PUT",
30364 "group": "Voice_Contexts",
30365 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30366 "version": "0.0.0",
30367 "filename": "server/api/voiceContext/index.js",
30368 "groupTitle": "Voice_Contexts"
30372 "url": "/api/voice/dials/reports/describe",
30373 "title": "Gets table info about Dial Reports",
30376 "title": "Example usage:",
30377 "content": "curl https://{domain}/api/voice/dials/reports/describe -v -u {name}:{password}",
30381 "name": "DescribeDial_Reports",
30382 "group": "Voice_Dial_Reports",
30383 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30384 "version": "0.0.0",
30385 "filename": "server/api/voiceDialReport/index.js",
30386 "groupTitle": "Voice_Dial_Reports"
30390 "url": "/api/voice/dials/reports",
30391 "title": "Gets a list of Dial Reports",
30394 "title": "Example usage:",
30395 "content": "curl https://{domain}/api/voice/dials/reports -v -u {name}:{password}",
30399 "name": "GetDial_Reports",
30400 "group": "Voice_Dial_Reports",
30401 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
30402 "version": "0.0.0",
30403 "filename": "server/api/voiceDialReport/index.js",
30404 "groupTitle": "Voice_Dial_Reports"
30408 "url": "/api/voice/dials/reports/{id}",
30409 "title": "Gets a single Dial Report",
30412 "title": "Example usage:",
30413 "content": "curl https://{domain}/api/voice/dials/reports/{id} -v -u {name}:{password}",
30417 "name": "ShowDial_Reports",
30418 "group": "Voice_Dial_Reports",
30419 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30420 "version": "0.0.0",
30421 "filename": "server/api/voiceDialReport/index.js",
30422 "groupTitle": "Voice_Dial_Reports"
30426 "url": "/api/voice/extensions/{id}",
30427 "title": "Deletes a Extension",
30430 "title": "Example usage:",
30431 "content": "curl https://{domain}/api/voice/extensions/{id} -v -u {name}:{password} -X DELETE",
30435 "name": "DeleteExtensions",
30436 "group": "Voice_Extensions",
30437 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30438 "version": "0.0.0",
30439 "filename": "server/api/voiceExtension/index.js",
30440 "groupTitle": "Voice_Extensions"
30444 "url": "/api/voice/extensions",
30445 "title": "Gets a list of Extensions",
30448 "title": "Example usage:",
30449 "content": "curl https://{domain}/api/voice/extensions -v -u {name}:{password}",
30453 "name": "GetExtensions",
30454 "group": "Voice_Extensions",
30455 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
30456 "version": "0.0.0",
30457 "filename": "server/api/voiceExtension/index.js",
30458 "groupTitle": "Voice_Extensions"
30462 "url": "/api/voice/extensions/{id}",
30463 "title": "Gets a single Extension",
30466 "title": "Example usage:",
30467 "content": "curl https://{domain}/api/voice/extensions/{id} -v -u {name}:{password}",
30471 "name": "ShowExtensions",
30472 "group": "Voice_Extensions",
30473 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30474 "version": "0.0.0",
30475 "filename": "server/api/voiceExtension/index.js",
30476 "groupTitle": "Voice_Extensions"
30480 "url": "/api/voice/extensions",
30481 "title": "Create new applications",
30484 "title": "Example usage:",
30485 "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",
30489 "name": "addApplications",
30490 "group": "Voice_Extensions",
30491 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30492 "version": "0.0.0",
30493 "filename": "server/api/voiceExtension/index.js",
30494 "groupTitle": "Voice_Extensions"
30498 "url": "/api/voice/extensions",
30499 "title": "Create an extension",
30502 "title": "Example usage:",
30503 "content": "curl https://{domain}/api/voice/extensions -d '{\"exten\": \"12345\", \"context\": \"from-custom\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
30508 "group": "Voice_Extensions",
30509 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30510 "version": "0.0.0",
30511 "filename": "server/api/voiceExtension/index.js",
30512 "groupTitle": "Voice_Extensions"
30516 "url": "/api/voice/extensions/{id}",
30517 "title": "Update an extension",
30520 "title": "Example usage:",
30521 "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",
30526 "group": "Voice_Extensions",
30527 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30528 "version": "0.0.0",
30529 "filename": "server/api/voiceExtension/index.js",
30530 "groupTitle": "Voice_Extensions"
30534 "url": "/api/voice/mohs",
30535 "title": "Create a new a new MOH",
30538 "title": "Example usage:",
30539 "content": "curl https://{domain}/api/voice/mohs -d '{\"name\": \"xmas_musics\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
30544 "group": "Voice_MOHs",
30545 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30546 "version": "0.0.0",
30547 "filename": "server/api/voiceMusicOnHold/index.js",
30548 "groupTitle": "Voice_MOHs"
30552 "url": "/api/voice/mohs/{id}/sounds",
30553 "title": "Add sound to MOH",
30556 "title": "Example usage:",
30557 "content": "curl https://{domain}/api/voice/mohs/{id}/sounds -d '{\"id\": 1}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
30561 "name": "AddSound",
30562 "group": "Voice_MOHs",
30563 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30564 "version": "0.0.0",
30565 "filename": "server/api/voiceMusicOnHold/index.js",
30566 "groupTitle": "Voice_MOHs"
30570 "url": "/api/voice/mohs/{id}",
30571 "title": "Deletes an MOH",
30574 "title": "Example usage:",
30575 "content": "curl https://{domain}/api/voice/mohs/{id} -v -u {name}:{password} -X DELETE",
30579 "name": "DestroyMoh",
30580 "group": "Voice_MOHs",
30581 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30582 "version": "0.0.0",
30583 "filename": "server/api/voiceMusicOnHold/index.js",
30584 "groupTitle": "Voice_MOHs"
30588 "url": "/api/voice/mohs",
30589 "title": "Gets a list of Music On Holds",
30592 "title": "Example usage:",
30593 "content": "curl https://{domain}/api/voice/mohs -v -u {name}:{password}",
30597 "name": "GetMusic_On_Holds",
30598 "group": "Voice_MOHs",
30599 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
30600 "version": "0.0.0",
30601 "filename": "server/api/voiceMusicOnHold/index.js",
30602 "groupTitle": "Voice_MOHs"
30606 "url": "/api/voice/mohs/{id}/sounds",
30607 "title": "Gets sounds from MOH",
30610 "title": "Example usage:",
30611 "content": "curl https://{domain}/api/voice/mohs/{id}/sounds -v -u {name}:{password} -X DELETE",
30615 "name": "GetSounds",
30616 "group": "Voice_MOHs",
30617 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30618 "version": "0.0.0",
30619 "filename": "server/api/voiceMusicOnHold/index.js",
30620 "groupTitle": "Voice_MOHs"
30624 "url": "/api/voice/mohs/{id}/sounds/{id2}",
30625 "title": "Remove sound from MOH",
30628 "title": "Example usage:",
30629 "content": "curl https://{domain}/api/voice/mohs/{id}/sounds/{id2} -v -u {name}:{password} -X DELETE",
30633 "name": "RemoveSound",
30634 "group": "Voice_MOHs",
30635 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30636 "version": "0.0.0",
30637 "filename": "server/api/voiceMusicOnHold/index.js",
30638 "groupTitle": "Voice_MOHs"
30642 "url": "/api/voice/mohs/{id}",
30643 "title": "Gets a single Music On Hold",
30646 "title": "Example usage:",
30647 "content": "curl https://{domain}/api/voice/mohs/{id} -v -u {name}:{password}",
30651 "name": "ShowMusic_On_Holds",
30652 "group": "Voice_MOHs",
30653 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30654 "version": "0.0.0",
30655 "filename": "server/api/voiceMusicOnHold/index.js",
30656 "groupTitle": "Voice_MOHs"
30660 "url": "/api/voice/mohs/{id}",
30661 "title": "Update an existing Music On Hold",
30664 "title": "Example usage:",
30665 "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",
30669 "name": "updateMusic_On_Holds",
30670 "group": "Voice_MOHs",
30671 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30672 "version": "0.0.0",
30673 "filename": "server/api/voiceMusicOnHold/index.js",
30674 "groupTitle": "Voice_MOHs"
30678 "url": "/api/voice/mails",
30679 "title": "Creates a new Mail",
30682 "title": "Example usage:",
30683 "content": "curl https://{domain}/api/voice/mails -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
30687 "name": "CreateMails",
30688 "group": "Voice_Mails",
30696 "field": "customer_id",
30703 "field": "context",
30710 "field": "mailbox",
30717 "field": "password",
30724 "field": "fullname",
30774 "field": "dialout",
30781 "field": "callback",
30803 "field": "operator",
30814 "field": "envelope",
30825 "field": "sayduration",
30832 "field": "saydurationm",
30843 "field": "sendvoicemail",
30865 "field": "nextaftercmd",
30876 "field": "forcename",
30887 "field": "forcegreetings",
30898 "field": "hidefromdir",
30912 "field": "emailsubject",
30919 "field": "emailbody",
30926 "field": "maxsecs",
30946 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30947 "version": "0.0.0",
30948 "filename": "server/api/voiceMail/index.js",
30949 "groupTitle": "Voice_Mails"
30953 "url": "/api/voice/mails/{id}",
30954 "title": "Deletes a Mail",
30957 "title": "Example usage:",
30958 "content": "curl https://{domain}/api/voice/mails/{id} -v -u {name}:{password} -X DELETE",
30962 "name": "DeleteMails",
30963 "group": "Voice_Mails",
30964 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30965 "version": "0.0.0",
30966 "filename": "server/api/voiceMail/index.js",
30967 "groupTitle": "Voice_Mails"
30971 "url": "/api/voice/mails",
30972 "title": "Gets a list of Mails",
30975 "title": "Example usage:",
30976 "content": "curl https://{domain}/api/voice/mails -v -u {name}:{password}",
30980 "name": "GetMails",
30981 "group": "Voice_Mails",
30982 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
30983 "version": "0.0.0",
30984 "filename": "server/api/voiceMail/index.js",
30985 "groupTitle": "Voice_Mails"
30989 "url": "/api/voice/mails/{id}",
30990 "title": "Gets a single Mail",
30993 "title": "Example usage:",
30994 "content": "curl https://{domain}/api/voice/mails/{id} -v -u {name}:{password}",
30998 "name": "ShowMails",
30999 "group": "Voice_Mails",
31000 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31001 "version": "0.0.0",
31002 "filename": "server/api/voiceMail/index.js",
31003 "groupTitle": "Voice_Mails"
31007 "url": "/api/voice/mails/{id}/messages",
31008 "title": "Gets voice mail messages",
31011 "title": "Example usage:",
31012 "content": "curl https://{domain}/api/voice/mails/{id}/messages -v -u {name}:{password} -X GET",
31016 "name": "getMessages",
31017 "group": "Voice_Mails",
31018 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31019 "version": "0.0.0",
31020 "filename": "server/api/voiceMail/index.js",
31021 "groupTitle": "Voice_Mails"
31025 "url": "/api/voice/mails/{id}",
31026 "title": "Update an existing Mail",
31029 "title": "Example usage:",
31030 "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",
31034 "name": "updateMails",
31035 "group": "Voice_Mails",
31036 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31037 "version": "0.0.0",
31038 "filename": "server/api/voiceMail/index.js",
31039 "groupTitle": "Voice_Mails"
31043 "url": "/api/voice/mails/messages",
31044 "title": "Creates a new Message",
31047 "title": "Example usage:",
31048 "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",
31052 "name": "CreateMessages",
31053 "group": "Voice_Messages",
31082 "field": "context",
31089 "field": "macrocontext",
31096 "field": "callerid",
31103 "field": "origtime",
31110 "field": "duration",
31117 "field": "mailboxuser",
31124 "field": "mailboxcontext",
31131 "field": "recording",
31158 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31159 "version": "0.0.0",
31160 "filename": "server/api/voiceMailMessage/index.js",
31161 "groupTitle": "Voice_Messages"
31165 "url": "/api/voice/mails/messages/{id}",
31166 "title": "Deletes a Message",
31169 "title": "Example usage:",
31170 "content": "curl https://{domain}/api/voice/mails/messages/{id} -v -u {name}:{password} -X DELETE",
31174 "name": "DeleteMessages",
31175 "group": "Voice_Messages",
31176 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31177 "version": "0.0.0",
31178 "filename": "server/api/voiceMailMessage/index.js",
31179 "groupTitle": "Voice_Messages"
31183 "url": "/api/voice/mails/messages",
31184 "title": "Gets a list of Messages",
31187 "title": "Example usage:",
31188 "content": "curl https://{domain}/api/voice/mails/messages -v -u {name}:{password}",
31192 "name": "GetMessages",
31193 "group": "Voice_Messages",
31194 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
31195 "version": "0.0.0",
31196 "filename": "server/api/voiceMailMessage/index.js",
31197 "groupTitle": "Voice_Messages"
31201 "url": "/api/voice/mails/messages/{id}",
31202 "title": "Gets a single Message",
31205 "title": "Example usage:",
31206 "content": "curl https://{domain}/api/voice/mails/messages/{id} -v -u {name}:{password}",
31210 "name": "ShowMessages",
31211 "group": "Voice_Messages",
31212 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31213 "version": "0.0.0",
31214 "filename": "server/api/voiceMailMessage/index.js",
31215 "groupTitle": "Voice_Messages"
31219 "url": "voice/mails/messages/{id}/download",
31220 "title": "Download Voice Message",
31223 "title": "Example usage:",
31224 "content": "curl https://{domain}voice/mails/messages/{id}/download -v -u {name}:{password} -X GET",
31228 "name": "download",
31229 "group": "Voice_Messages",
31230 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31231 "version": "0.0.0",
31232 "filename": "server/api/voiceMailMessage/index.js",
31233 "groupTitle": "Voice_Messages"
31237 "url": "/api/voice/mails/messages/{id}",
31238 "title": "Update an existing Message",
31241 "title": "Example usage:",
31242 "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",
31246 "name": "updateMessages",
31247 "group": "Voice_Messages",
31248 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31249 "version": "0.0.0",
31250 "filename": "server/api/voiceMailMessage/index.js",
31251 "groupTitle": "Voice_Messages"
31255 "url": "/api/voice/prefixes/{id}/users",
31256 "title": "Add agents to a prefix",
31259 "title": "Example usage:",
31260 "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",
31264 "name": "AddAgents",
31265 "group": "Voice_Prefixes",
31266 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31267 "version": "0.0.0",
31268 "filename": "server/api/voicePrefix/index.js",
31269 "groupTitle": "Voice_Prefixes"
31273 "url": "/api/voice/prefixes/{id}",
31274 "title": "Deletes a Prefix",
31277 "title": "Example usage:",
31278 "content": "curl https://{domain}/api/voice/prefixes/{id} -v -u {name}:{password} -X DELETE",
31282 "name": "DeletePrefixes",
31283 "group": "Voice_Prefixes",
31284 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31285 "version": "0.0.0",
31286 "filename": "server/api/voicePrefix/index.js",
31287 "groupTitle": "Voice_Prefixes"
31291 "url": "/api/voice/prefixes/describe",
31292 "title": "Gets table info about Prefixes",
31295 "title": "Example usage:",
31296 "content": "curl https://{domain}/api/voice/prefixes/describe -v -u {name}:{password}",
31300 "name": "DescribePrefixes",
31301 "group": "Voice_Prefixes",
31302 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31303 "version": "0.0.0",
31304 "filename": "server/api/voicePrefix/index.js",
31305 "groupTitle": "Voice_Prefixes"
31309 "url": "/api/voice/prefixes/{id}/users",
31310 "title": "Gets agents from prefix",
31313 "title": "Example usage:",
31314 "content": "curl https://{domain}/api/voice/prefixes/{id}/users -v -u {name}:{password} -X GET",
31318 "name": "GetAgents",
31319 "group": "Voice_Prefixes",
31320 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31321 "version": "0.0.0",
31322 "filename": "server/api/voicePrefix/index.js",
31323 "groupTitle": "Voice_Prefixes"
31327 "url": "/api/voice/prefixes",
31328 "title": "Gets a list of Prefixes",
31331 "title": "Example usage:",
31332 "content": "curl https://{domain}/api/voice/prefixes -v -u {name}:{password}",
31336 "name": "GetPrefixes",
31337 "group": "Voice_Prefixes",
31338 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
31339 "version": "0.0.0",
31340 "filename": "server/api/voicePrefix/index.js",
31341 "groupTitle": "Voice_Prefixes"
31345 "url": "/api/voice/prefixes/{id}/users",
31346 "title": "Removes agents from a prefix",
31349 "title": "Example usage:",
31350 "content": "curl https://{domain}/api/voice/prefixes/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
31354 "name": "RemoveAgents",
31355 "group": "Voice_Prefixes",
31356 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31357 "version": "0.0.0",
31358 "filename": "server/api/voicePrefix/index.js",
31359 "groupTitle": "Voice_Prefixes"
31363 "url": "/api/voice/prefixes/{id}",
31364 "title": "Gets a single Prefix",
31367 "title": "Example usage:",
31368 "content": "curl https://{domain}/api/voice/prefixes/{id} -v -u {name}:{password}",
31372 "name": "ShowPrefixes",
31373 "group": "Voice_Prefixes",
31374 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31375 "version": "0.0.0",
31376 "filename": "server/api/voicePrefix/index.js",
31377 "groupTitle": "Voice_Prefixes"
31381 "url": "/api/voice/prefixes/{id}",
31382 "title": "Update an existing prefix",
31385 "title": "Example usage:",
31386 "content": "curl https://{domain}/api/voice/prefixes/{id} -v -u {name}:{password} -X PUT",
31391 "group": "Voice_Prefixes",
31392 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31393 "version": "0.0.0",
31394 "filename": "server/api/voicePrefix/index.js",
31395 "groupTitle": "Voice_Prefixes"
31399 "url": "/api/voice/prefixes",
31400 "title": "Create a prefix",
31403 "title": "Example usage:",
31404 "content": "curl https://{domain}/api/voice/prefixes -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
31409 "group": "Voice_Prefixes",
31410 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31411 "version": "0.0.0",
31412 "filename": "server/api/voicePrefix/index.js",
31413 "groupTitle": "Voice_Prefixes"
31417 "url": "/api/voice/queues/reports/describe",
31418 "title": "Gets table info about Queue Reports",
31421 "title": "Example usage:",
31422 "content": "curl https://{domain}/api/voice/queues/reports/describe -v -u {name}:{password}",
31426 "name": "DescribeQueue_Reports",
31427 "group": "Voice_Queue_Reports",
31428 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31429 "version": "0.0.0",
31430 "filename": "server/api/voiceQueueReport/index.js",
31431 "groupTitle": "Voice_Queue_Reports"
31435 "url": "/api/voice/queues/reports",
31436 "title": "Gets a list of Queue Reports",
31439 "title": "Example usage:",
31440 "content": "curl https://{domain}/api/voice/queues/reports -v -u {name}:{password}",
31444 "name": "GetQueue_Reports",
31445 "group": "Voice_Queue_Reports",
31446 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
31447 "version": "0.0.0",
31448 "filename": "server/api/voiceQueueReport/index.js",
31449 "groupTitle": "Voice_Queue_Reports"
31453 "url": "/api/voice/queues/reports/{id}",
31454 "title": "Gets a single Queue Report",
31457 "title": "Example usage:",
31458 "content": "curl https://{domain}/api/voice/queues/reports/{id} -v -u {name}:{password}",
31462 "name": "ShowQueue_Reports",
31463 "group": "Voice_Queue_Reports",
31464 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31465 "version": "0.0.0",
31466 "filename": "server/api/voiceQueueReport/index.js",
31467 "groupTitle": "Voice_Queue_Reports"
31471 "url": "/api/voice/queues/reports/index",
31472 "title": "Get Voice Queues Report",
31475 "title": "Example usage:",
31476 "content": "curl https://{domain}/api/voice/queues/reports/index -v -u {name}:{password} -X GET",
31480 "name": "getVoiceQueuesReport",
31481 "group": "Voice_Queue_Reports",
31482 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31483 "version": "0.0.0",
31484 "filename": "server/api/voiceQueueReport/index.js",
31485 "groupTitle": "Voice_Queue_Reports"
31489 "url": "/api/voice/queues/{id}/users",
31490 "title": "Add agents to queue",
31493 "title": "Example usage:",
31494 "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",
31498 "name": "AddAgents",
31499 "group": "Voice_Queues",
31500 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31501 "version": "0.0.0",
31502 "filename": "server/api/voiceQueue/index.js",
31503 "groupTitle": "Voice_Queues"
31507 "url": "/api/voice/queues/{id}/blacklists",
31508 "title": "Add blacklists to a queue",
31511 "title": "Example usage:",
31512 "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",
31516 "name": "AddBlackLists",
31517 "group": "Voice_Queues",
31518 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31519 "version": "0.0.0",
31520 "filename": "server/api/voiceQueue/index.js",
31521 "groupTitle": "Voice_Queues"
31525 "url": "/api/voice/queues/{id}/lists",
31526 "title": "Add lists to a queue",
31529 "title": "Example usage:",
31530 "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",
31534 "name": "AddLists",
31535 "group": "Voice_Queues",
31536 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31537 "version": "0.0.0",
31538 "filename": "server/api/voiceQueue/index.js",
31539 "groupTitle": "Voice_Queues"
31543 "url": "/api/voice/queues/{id}/teams",
31544 "title": "Add teams to queue",
31547 "title": "Example usage:",
31548 "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",
31552 "name": "AddTeams",
31553 "group": "Voice_Queues",
31554 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31555 "version": "0.0.0",
31556 "filename": "server/api/voiceQueue/index.js",
31557 "groupTitle": "Voice_Queues"
31561 "url": "/api/voice/queues/clone",
31562 "title": "Clone an existing Queue",
31565 "title": "Example usage:",
31566 "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",
31570 "name": "CloneQueues",
31571 "group": "Voice_Queues",
31572 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31573 "version": "0.0.0",
31574 "filename": "server/api/voiceQueue/index.js",
31575 "groupTitle": "Voice_Queues"
31579 "url": "/api/voice/queues",
31580 "title": "Creates a new Queue",
31583 "title": "Example usage:",
31584 "content": "curl https://{domain}/api/voice/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
31588 "name": "CreateQueues",
31589 "group": "Voice_Queues",
31615 "field": "musiconhold",
31622 "field": "announce",
31640 "field": "strategy",
31647 "field": "servicelevel",
31654 "field": "context",
31661 "field": "penaltymemberslimit",
31668 "field": "timeout",
31682 "field": "timeoutpriority",
31696 "field": "wrapuptime",
31707 "field": "autofill",
31719 "field": "autopause",
31726 "field": "autopausedelay",
31737 "field": "autopausebusy",
31748 "field": "autopauseunavail",
31766 "field": "setinterfacevar",
31777 "field": "setqueueentryvar",
31788 "field": "setqueuevar",
31799 "field": "eventmemberstatus",
31806 "field": "membermacro",
31813 "field": "membergosub",
31820 "field": "announce_frequency",
31827 "field": "min_announce_frequency",
31834 "field": "periodic_announce_frequency",
31845 "field": "random_periodic_announce",
31856 "field": "relative_periodic_announce",
31868 "field": "announce_holdtime",
31875 "field": "announce_position",
31886 "field": "announce_to_first_user",
31893 "field": "announce_position_limit",
31908 "field": "announce_round_seconds",
31915 "field": "monitor_format",
31922 "field": "monitor_type",
31929 "field": "queue_youarenext",
31936 "field": "queue_thereare",
31943 "field": "queue_callswaiting",
31950 "field": "queue_holdtime",
31957 "field": "queue_minute",
31964 "field": "queue_minutes",
31971 "field": "queue_seconds",
31978 "field": "queue_thankyou",
31985 "field": "queue_reporthold",
31992 "field": "queue_quantity1",
31999 "field": "queue_quantity2",
32006 "field": "queue_periodic_announce",
32013 "field": "queue_less_than",
32020 "field": "periodic_announce",
32027 "field": "joinempty",
32034 "field": "leavewhenempty",
32045 "field": "reportholdtime",
32056 "field": "ringinuse",
32063 "field": "memberdelay",
32074 "field": "timeoutrestart",
32081 "field": "defaultrule",
32088 "field": "description",
32102 "field": "acwTimeout",
32109 "field": "dialActive",
32110 "description": "<p>Active/Disactive Campaign</p>"
32123 "field": "dialMethod",
32124 "description": "<p>Dial Method.</p>"
32130 "field": "dialLimitChannel",
32131 "description": "<p>Max 9999 channels, 0 means unlimited.</p>"
32137 "field": "dialLimitQueue",
32138 "description": "<p>Max 9999 member in queue(min:1, max:9999), 0 means unlimited.</p>"
32144 "field": "dialPowerLevel",
32145 "description": "<p>Power Level: Calls for agents (min:1, max:10).</p>"
32151 "\"agentBusyFactor\"",
32155 "field": "dialPredictiveOptimization",
32156 "description": "<p>Only for predictive method.</p>"
32162 "field": "dialPredictiveOptimizationPercentage",
32163 "description": "<p>Predictive Optimization Percentage (min: 1, max: 95)</p>"
32169 "field": "dialPredictiveInterval",
32170 "description": "<p>Interval Predictive Minutes (min:5 max:30)</p>"
32176 "field": "dialOriginateCallerIdName",
32183 "field": "dialOriginateCallerIdNumber",
32190 "field": "dialOriginateTimeout",
32191 "description": "<p>Originate Timeout Seconds (min:1, max:999)</p>"
32197 "field": "dialQueueOptions",
32198 "description": "<p>https://wiki.asterisk.org/wiki/display/AST/Asterisk+13+Application_Queue</p>"
32204 "field": "dialQueueTimeout",
32205 "description": "<p>Queue Timeout Seconds (min:1, max:999)</p>"
32211 "field": "dialQueueProject",
32212 "description": "<p>AGI queue option (use: agi://127.0.0.1/square,<project_name>)</p>"
32218 "field": "dialCongestionMaxRetry",
32219 "description": "<p>#Congestion Retry (min:1, max:999)</p>"
32225 "field": "dialCongestionRetryFrequency",
32226 "description": "<p>Congestion Retry Frequency Minutes (min:1, max:99999)</p>"
32232 "field": "dialBusyMaxRetry",
32233 "description": "<p>#Busy Retry (min:1, max:999)</p>"
32239 "field": "dialBusyRetryFrequency",
32240 "description": "<p>Busy Retry Frequency Minutes (min:1, max:99999)</p>"
32246 "field": "dialNoAnswerMaxRetry",
32247 "description": "<p>#NoAnswer Retry (min:1, max:999)</p>"
32253 "field": "dialNoAnswerRetryFrequency",
32254 "description": "<p>NoAnswer Retry Frequency Minutes (min:1, max:99999)</p>"
32260 "field": "dialGlobalMaxRetry",
32261 "description": "<p>#Global Max Retry (min:1, max:999)</p>"
32267 "field": "dialTimezone",
32274 "field": "dialGlobalInterval",
32281 "field": "dialPrefix",
32293 "field": "dialCheckDuplicateType",
32300 "field": "dialAMDActive",
32301 "description": "<p>Active/Disactive AMD</p>"
32307 "field": "dialAMDInitialSilence",
32308 "description": "<p>#AMD Initial Silence</p>"
32314 "field": "dialAMDGreeting",
32315 "description": "<p>#AMD Greeting</p>"
32321 "field": "dialAMDAfterGreetingSilence",
32322 "description": "<p>#AMD After Greeting Silence</p>"
32328 "field": "dialAMDTotalAnalysisTime",
32329 "description": "<p>#AMD Total Analysis Time</p>"
32335 "field": "dialAMDMinWordLength",
32336 "description": "<p>#AMD Min Word Length</p>"
32342 "field": "dialAMDBetweenWordsSilence",
32343 "description": "<p>#AMD Between Words Silence</p>"
32349 "field": "dialAMDMaximumNumberOfWords",
32350 "description": "<p>#AMD Maximum Number Of Words</p>"
32356 "field": "dialAMDSilenceThreshold",
32357 "description": "<p>#AMD Silence Threshold (min:0, max:32767)</p>"
32363 "field": "dialAMDMaximumWordLength",
32364 "description": "<p>#AMD Maximum Word Length</p>"
32370 "field": "dialRecallMeTimeout",
32371 "description": "<p>#RecallMe Timeout (min:1)</p>"
32377 "field": "dialRecallInQueue",
32378 "description": "<p>Active/Disactive Recall In Queue</p>"
32388 "field": "dialOrderByScheduledAt",
32395 "field": "dialQueueProject2",
32396 "description": "<p>AGI queue option (use: agi://127.0.0.1/square,<project_name>)</p>"
32402 "field": "dialAgiAfterHangupClient",
32409 "field": "dialAgiAfterHangupAgent",
32416 "field": "dialRandomLastDigitCallerIdNumber",
32417 "description": "<p>Random Last Digit (min:1, max:15)</p>"
32423 "field": "dialCutDigit",
32424 "description": "<p>Cut Digit (min:1, max:15)</p>"
32430 "field": "dialNoSuchNumberMaxRetry",
32431 "description": "<p>#NoSuchNumber Retry (min:1, max:999)</p>"
32437 "field": "dialNoSuchNumberRetryFrequency",
32438 "description": "<p>NoSuchNumber Retry Frequency Minutes (min:1, max:99999)</p>"
32444 "field": "dialDropMaxRetry",
32445 "description": "<p>#Drop Retry (min:1, max:999)</p>"
32451 "field": "dialDropRetryFrequency",
32452 "description": "<p>Drop Retry Frequency Minutes (min:1, max:99999)</p>"
32458 "field": "dialAbandonedMaxRetry",
32459 "description": "<p>#Abandoned Retry (min:1, max:999)</p>"
32465 "field": "dialAbandonedRetryFrequency",
32466 "description": "<p>Abandoned Retry Frequency Minutes (min:1, max:99999)</p>"
32472 "field": "dialMachineMaxRetry",
32473 "description": "<p>#Machine Retry (min:1, max:999)</p>"
32479 "field": "dialMachineRetryFrequency",
32480 "description": "<p>Machine Retry Frequency Minutes (min:1, max:99999)</p>"
32486 "field": "dialAgentRejectMaxRetry",
32487 "description": "<p>#AgentReject Retry (min:1, max:999)</p>"
32493 "field": "dialAgentRejectRetryFrequency",
32494 "description": "<p>AgentReject Retry Frequency Minutes (min:1, max:99999)</p>"
32500 "field": "mandatoryDispositionPauseId",
32501 "description": "<p>Status to put when mandatory disposition is enabled</p>"
32507 "field": "mandatoryDisposition",
32508 "description": "<p>Enabled/disables mandatory dispo on a queue</p>"
32514 "field": "dialPredictiveIntervalMaxThreshold",
32521 "field": "dialPredictiveIntervalMinThreshold",
32527 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32528 "version": "0.0.0",
32529 "filename": "server/api/voiceQueue/index.js",
32530 "groupTitle": "Voice_Queues"
32534 "url": "/api/voice/queues/{id}",
32535 "title": "Deletes a Queue",
32538 "title": "Example usage:",
32539 "content": "curl https://{domain}/api/voice/queues/{id} -v -u {name}:{password} -X DELETE",
32543 "name": "DeleteQueues",
32544 "group": "Voice_Queues",
32545 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32546 "version": "0.0.0",
32547 "filename": "server/api/voiceQueue/index.js",
32548 "groupTitle": "Voice_Queues"
32552 "url": "/api/voice/queues/{id}/users",
32553 "title": "Gets queue agents",
32556 "title": "Example usage:",
32557 "content": "curl https://{domain}/api/voice/queues/{id}/users -v -u {name}:{password} -X GET",
32561 "name": "GetAgents",
32562 "group": "Voice_Queues",
32563 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32564 "version": "0.0.0",
32565 "filename": "server/api/voiceQueue/index.js",
32566 "groupTitle": "Voice_Queues"
32570 "url": "/api/voice/queues/{id}/blacklists",
32571 "title": "Get queue blacklists",
32574 "title": "Example usage:",
32575 "content": "curl https://{domain}/api/voice/queues/{id}/blacklists -v -u {name}:{password} -X GET",
32579 "name": "GetBlackLists",
32580 "group": "Voice_Queues",
32581 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32582 "version": "0.0.0",
32583 "filename": "server/api/voiceQueue/index.js",
32584 "groupTitle": "Voice_Queues"
32588 "url": "/api/voice/queues/{id}/finals",
32589 "title": "Gets queue hopper finals",
32592 "title": "Example usage:",
32593 "content": "curl https://{domain}/api/voice/queues/{id}/hopper_finals -v -u {name}:{password} -X GET",
32597 "name": "GetHopperFinals",
32598 "group": "Voice_Queues",
32599 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32600 "version": "0.0.0",
32601 "filename": "server/api/voiceQueue/index.js",
32602 "groupTitle": "Voice_Queues"
32606 "url": "/api/voice/queues/{id}/hopper_histories",
32607 "title": "Gets queue hopper histories",
32610 "title": "Example usage:",
32611 "content": "curl https://{domain}/api/voice/queues/{id}/hopper_histories -v -u {name}:{password} -X GET",
32615 "name": "GetHopperHistories",
32616 "group": "Voice_Queues",
32617 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32618 "version": "0.0.0",
32619 "filename": "server/api/voiceQueue/index.js",
32620 "groupTitle": "Voice_Queues"
32624 "url": "/api/voice/queues/{id}/hoppers",
32625 "title": "Gets queue hoppers",
32628 "title": "Example usage:",
32629 "content": "curl https://{domain}/api/voice/queues/{id}/hoppers -v -u {name}:{password} -X GET",
32633 "name": "GetHoppers",
32634 "group": "Voice_Queues",
32635 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32636 "version": "0.0.0",
32637 "filename": "server/api/voiceQueue/index.js",
32638 "groupTitle": "Voice_Queues"
32642 "url": "/api/voice/queues/{id}/lists",
32643 "title": "Get queue lists",
32646 "title": "Example usage:",
32647 "content": "curl https://{domain}/api/voice/queues/{id}/lists -v -u {name}:{password} -X GET",
32651 "name": "GetLists",
32652 "group": "Voice_Queues",
32653 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32654 "version": "0.0.0",
32655 "filename": "server/api/voiceQueue/index.js",
32656 "groupTitle": "Voice_Queues"
32660 "url": "/api/voice/queues/{id}/members",
32661 "title": "Gets queue members",
32664 "title": "Example usage:",
32665 "content": "curl https://{domain}/api/voice/queues/{id}/members -v -u {name}:{password} -X GET",
32669 "name": "GetMembers",
32670 "group": "Voice_Queues",
32671 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32672 "version": "0.0.0",
32673 "filename": "server/api/voiceQueue/index.js",
32674 "groupTitle": "Voice_Queues"
32678 "url": "/api/voice/queues",
32679 "title": "Gets a list of Queues",
32682 "title": "Example usage:",
32683 "content": "curl https://{domain}/api/voice/queues -v -u {name}:{password}",
32687 "name": "GetQueues",
32688 "group": "Voice_Queues",
32689 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
32690 "version": "0.0.0",
32691 "filename": "server/api/voiceQueue/index.js",
32692 "groupTitle": "Voice_Queues"
32696 "url": "/api/voice/queues/{id}/teams",
32697 "title": "Gets queue team",
32700 "title": "Example usage:",
32701 "content": "curl https://{domain}/api/voice/queues/{id}/teams -v -u {name}:{password} -X GET",
32705 "name": "GetTeams",
32706 "group": "Voice_Queues",
32707 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32708 "version": "0.0.0",
32709 "filename": "server/api/voiceQueue/index.js",
32710 "groupTitle": "Voice_Queues"
32714 "url": "/api/voice/queues/{id}/users",
32715 "title": "Removes agents from a queue",
32718 "title": "Example usage:",
32719 "content": "curl https://{domain}/api/voice/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
32723 "name": "RemoveAgents",
32724 "group": "Voice_Queues",
32725 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32726 "version": "0.0.0",
32727 "filename": "server/api/voiceQueue/index.js",
32728 "groupTitle": "Voice_Queues"
32732 "url": "/api/voice/queues/{id}/blacklists",
32733 "title": "Remove blacklists from a queue",
32736 "title": "Example usage:",
32737 "content": "curl https://{domain}/api/voice/queues/{id}/blacklists?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
32741 "name": "RemoveBlackLists",
32742 "group": "Voice_Queues",
32743 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32744 "version": "0.0.0",
32745 "filename": "server/api/voiceQueue/index.js",
32746 "groupTitle": "Voice_Queues"
32750 "url": "/api/voice/queues/{id}/lists",
32751 "title": "Remove lists from a queue",
32754 "title": "Example usage:",
32755 "content": "curl https://{domain}/api/voice/queues/{id}/lists?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
32759 "name": "RemoveLists",
32760 "group": "Voice_Queues",
32761 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32762 "version": "0.0.0",
32763 "filename": "server/api/voiceQueue/index.js",
32764 "groupTitle": "Voice_Queues"
32768 "url": "/api/voice/queues/{id}",
32769 "title": "Gets a single Queue",
32772 "title": "Example usage:",
32773 "content": "curl https://{domain}/api/voice/queues/{id} -v -u {name}:{password}",
32777 "name": "ShowQueues",
32778 "group": "Voice_Queues",
32779 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32780 "version": "0.0.0",
32781 "filename": "server/api/voiceQueue/index.js",
32782 "groupTitle": "Voice_Queues"
32786 "url": "/api/voice/queues/{id}/blacks",
32787 "title": "Gets queue hopper blacks",
32790 "title": "Example usage:",
32791 "content": "curl https://{domain}/api/voice/queues/{id}/hopper_black -v -u {name}:{password} -X GET",
32795 "name": "getHopperBlacks",
32796 "group": "Voice_Queues",
32797 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32798 "version": "0.0.0",
32799 "filename": "server/api/voiceQueue/index.js",
32800 "groupTitle": "Voice_Queues"
32804 "url": "/api/voice/queues/{id}",
32805 "title": "Update an existing Queue",
32808 "title": "Example usage:",
32809 "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",
32813 "name": "updateQueues",
32814 "group": "Voice_Queues",
32815 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32816 "version": "0.0.0",
32817 "filename": "server/api/voiceQueue/index.js",
32818 "groupTitle": "Voice_Queues"
32822 "url": "/api/voice/recordings",
32823 "title": "Creates a new Recording",
32826 "title": "Example usage:",
32827 "content": "curl https://{domain}/api/voice/recordings -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
32831 "name": "CreateRecordings",
32832 "group": "Voice_Recordings",
32847 "field": "uniqueid",
32854 "field": "channel",
32861 "field": "membername",
32868 "field": "calleridnum",
32875 "field": "calleridname",
32882 "field": "connectedlinenum",
32889 "field": "connectedlinename",
32896 "field": "accountcode",
32903 "field": "context",
32945 "field": "userDisposition",
32952 "field": "userSecondDisposition",
32959 "field": "userThirdDisposition",
32966 "field": "location",
32973 "field": "transcribeName",
32980 "field": "transcribeStatus",
32987 "field": "fileUri",
32994 "field": "fileText",
33001 "field": "failureReason",
33008 "field": "sentiment",
33015 "field": "sPositive",
33022 "field": "sNegative",
33029 "field": "sNeutral",
33043 "field": "tempSentiment",
33050 "field": "createdAt",
33057 "field": "updatedAt",
33063 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33064 "version": "0.0.0",
33065 "filename": "server/api/voiceRecording/index.js",
33066 "groupTitle": "Voice_Recordings"
33070 "url": "/api/voice/recordings/describe",
33071 "title": "Gets table info about Recordings",
33074 "title": "Example usage:",
33075 "content": "curl https://{domain}/api/voice/recordings/describe -v -u {name}:{password}",
33079 "name": "DescribeRecordings",
33080 "group": "Voice_Recordings",
33081 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33082 "version": "0.0.0",
33083 "filename": "server/api/voiceRecording/index.js",
33084 "groupTitle": "Voice_Recordings"
33088 "url": "/api/voice/recordings",
33089 "title": "Gets a list of Recordings",
33092 "title": "Example usage:",
33093 "content": "curl https://{domain}/api/voice/recordings -v -u {name}:{password}",
33097 "name": "GetRecordings",
33098 "group": "Voice_Recordings",
33099 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
33100 "version": "0.0.0",
33101 "filename": "server/api/voiceRecording/index.js",
33102 "groupTitle": "Voice_Recordings"
33106 "url": "/api/voice/recordings/{id}",
33107 "title": "Gets a single Recording",
33110 "title": "Example usage:",
33111 "content": "curl https://{domain}/api/voice/recordings/{id} -v -u {name}:{password}",
33115 "name": "ShowRecordings",
33116 "group": "Voice_Recordings",
33117 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33118 "version": "0.0.0",
33119 "filename": "server/api/voiceRecording/index.js",
33120 "groupTitle": "Voice_Recordings"
33124 "url": "/api/voice/recordings/{id}",
33125 "title": "Delete voice recording",
33128 "title": "Example usage:",
33129 "content": "curl https://{domain}/api/voice/recordings/{id} -v -u {name}:{password} -X DELETE",
33134 "group": "Voice_Recordings",
33135 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33136 "version": "0.0.0",
33137 "filename": "server/api/voiceRecording/index.js",
33138 "groupTitle": "Voice_Recordings"
33142 "url": "/api/voice/recordings/{id}/download",
33143 "title": "Download Recording",
33146 "title": "Example usage:",
33147 "content": "curl https://{domain}/api/voice/recordings/{id}/download -v -u {name}:{password} -X GET",
33151 "name": "download",
33152 "group": "Voice_Recordings",
33153 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33154 "version": "0.0.0",
33155 "filename": "server/api/voiceRecording/index.js",
33156 "groupTitle": "Voice_Recordings"
33160 "url": "/api/voice/recordings/{id}/downloads",
33161 "title": "Download Recording",
33164 "title": "Example usage:",
33165 "content": "curl https://{domain}/api/voice/recordings/{id}/downloads -v -u {name}:{password} -X GET",
33169 "name": "downloads",
33170 "group": "Voice_Recordings",
33171 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33172 "version": "0.0.0",
33173 "filename": "server/api/voiceRecording/index.js",
33174 "groupTitle": "Voice_Recordings"
33178 "url": "/api/voice/recordings/{id}/transcribe",
33179 "title": "Run Transcribe Recording",
33182 "title": "Example usage:",
33183 "content": "curl https://{domain}/api/voice/recordings/{id}/transcribe -d '{\"runSentiment\": \"true\"}' -v -u {name}:{password} -X POST",
33187 "name": "transcribe",
33188 "group": "Voice_Recordings",
33189 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33190 "version": "0.0.0",
33191 "filename": "server/api/voiceRecording/index.js",
33192 "groupTitle": "Voice_Recordings"
33196 "url": "/api/voice/recordings/{id}/transcribe",
33197 "title": "Run Transcribe Recording",
33200 "title": "Example usage:",
33201 "content": "curl https://{domain}/api/voice/recordings/{id}/transcribe -v -u {name}:{password} -X GET",
33205 "name": "transcribe",
33206 "group": "Voice_Recordings",
33207 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33208 "version": "0.0.0",
33209 "filename": "server/api/voiceRecording/index.js",
33210 "groupTitle": "Voice_Recordings"
33214 "url": "/api/voice/recordings/{id}",
33215 "title": "Update an existing Recording",
33218 "title": "Example usage:",
33219 "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",
33223 "name": "updateRecordings",
33224 "group": "Voice_Recordings",
33225 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33226 "version": "0.0.0",
33227 "filename": "server/api/voiceRecording/index.js",
33228 "groupTitle": "Voice_Recordings"
33232 "url": "/api/voice/transfers/reports",
33233 "title": "Creates a new Transfer Report",
33236 "title": "Example usage:",
33237 "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",
33241 "name": "CreateTransfer_Reports",
33242 "group": "Voice_Transfer_Reports",
33268 "field": "transfererchannel",
33275 "field": "transferercalleridnum",
33282 "field": "transferercalleridname",
33289 "field": "transfererconnectedlinenum",
33296 "field": "transfererconnectedlinename",
33303 "field": "transfereraccountcode",
33310 "field": "transferercontext",
33317 "field": "transfererexten",
33324 "field": "transfererlinkedid",
33331 "field": "transfereechannel",
33338 "field": "transfereecalleridnum",
33345 "field": "transfereecalleridname",
33352 "field": "transfereeconnectedlinenum",
33359 "field": "transfereeconnectedlinename",
33366 "field": "transfereeaccountcode",
33373 "field": "transfereecontext",
33380 "field": "transfereeexten",
33387 "field": "transfereelinkedid",
33398 "field": "isexternal",
33405 "field": "context",
33412 "field": "extension",
33418 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33419 "version": "0.0.0",
33420 "filename": "server/api/voiceTransferReport/index.js",
33421 "groupTitle": "Voice_Transfer_Reports"
33425 "url": "/api/voice/transfers/reports/{id}",
33426 "title": "Deletes a Transfer Report",
33429 "title": "Example usage:",
33430 "content": "curl https://{domain}/api/voice/transfers/reports/{id} -v -u {name}:{password} -X DELETE",
33434 "name": "DeleteTransfer_Reports",
33435 "group": "Voice_Transfer_Reports",
33436 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33437 "version": "0.0.0",
33438 "filename": "server/api/voiceTransferReport/index.js",
33439 "groupTitle": "Voice_Transfer_Reports"
33443 "url": "/api/voice/transfers/reports/describe",
33444 "title": "Gets table info about Transfer Reports",
33447 "title": "Example usage:",
33448 "content": "curl https://{domain}/api/voice/transfers/reports/describe -v -u {name}:{password}",
33452 "name": "DescribeTransfer_Reports",
33453 "group": "Voice_Transfer_Reports",
33454 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33455 "version": "0.0.0",
33456 "filename": "server/api/voiceTransferReport/index.js",
33457 "groupTitle": "Voice_Transfer_Reports"
33461 "url": "/api/voice/transfers/reports",
33462 "title": "Gets a list of Transfer Reports",
33465 "title": "Example usage:",
33466 "content": "curl https://{domain}/api/voice/transfers/reports -v -u {name}:{password}",
33470 "name": "GetTransfer_Reports",
33471 "group": "Voice_Transfer_Reports",
33472 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
33473 "version": "0.0.0",
33474 "filename": "server/api/voiceTransferReport/index.js",
33475 "groupTitle": "Voice_Transfer_Reports"
33479 "url": "/api/voice/transfers/reports/{id}",
33480 "title": "Gets a single Transfer Report",
33483 "title": "Example usage:",
33484 "content": "curl https://{domain}/api/voice/transfers/reports/{id} -v -u {name}:{password}",
33488 "name": "ShowTransfer_Reports",
33489 "group": "Voice_Transfer_Reports",
33490 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33491 "version": "0.0.0",
33492 "filename": "server/api/voiceTransferReport/index.js",
33493 "groupTitle": "Voice_Transfer_Reports"
33497 "url": "/api/voice/transfers/reports/{id}",
33498 "title": "Update an existing Transfer Report",
33501 "title": "Example usage:",
33502 "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",
33506 "name": "updateTransfer_Reports",
33507 "group": "Voice_Transfer_Reports",
33508 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33509 "version": "0.0.0",
33510 "filename": "server/api/voiceTransferReport/index.js",
33511 "groupTitle": "Voice_Transfer_Reports"
33515 "url": "/api/integrations/vtiger/accounts",
33516 "title": "Creates a new Vtiger Account",
33519 "title": "Example usage:",
33520 "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",
33524 "name": "CreateVtiger_Accounts",
33525 "group": "Vtiger_Accounts",
33540 "field": "description",
33547 "field": "username",
33554 "field": "moduleName",
33561 "field": "remoteUri",
33568 "field": "serverUrl",
33575 "field": "accessKey",
33581 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33582 "version": "0.0.0",
33583 "filename": "server/api/intVtigerAccount/index.js",
33584 "groupTitle": "Vtiger_Accounts"
33588 "url": "/api/integrations/vtiger/accounts/{id}",
33589 "title": "Deletes a Vtiger Account",
33592 "title": "Example usage:",
33593 "content": "curl https://{domain}/api/integrations/vtiger/accounts/{id} -v -u {name}:{password} -X DELETE",
33597 "name": "DeleteVtiger_Accounts",
33598 "group": "Vtiger_Accounts",
33599 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33600 "version": "0.0.0",
33601 "filename": "server/api/intVtigerAccount/index.js",
33602 "groupTitle": "Vtiger_Accounts"
33606 "url": "/api/integrations/vtiger/accounts",
33607 "title": "Gets a list of Vtiger Accounts",
33610 "title": "Example usage:",
33611 "content": "curl https://{domain}/api/integrations/vtiger/accounts -v -u {name}:{password}",
33615 "name": "GetVtiger_Accounts",
33616 "group": "Vtiger_Accounts",
33617 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
33618 "version": "0.0.0",
33619 "filename": "server/api/intVtigerAccount/index.js",
33620 "groupTitle": "Vtiger_Accounts"
33624 "url": "/api/integrations/vtiger/accounts/{id}",
33625 "title": "Gets a single Vtiger Account",
33628 "title": "Example usage:",
33629 "content": "curl https://{domain}/api/integrations/vtiger/accounts/{id} -v -u {name}:{password}",
33633 "name": "ShowVtiger_Accounts",
33634 "group": "Vtiger_Accounts",
33635 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33636 "version": "0.0.0",
33637 "filename": "server/api/intVtigerAccount/index.js",
33638 "groupTitle": "Vtiger_Accounts"
33642 "url": "/api/integrations/vtiger/accounts/{id}/configurations",
33643 "title": "Creates new configuration",
33646 "title": "Example usage:",
33647 "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",
33651 "name": "addConfiguration",
33652 "group": "Vtiger_Accounts",
33653 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33654 "version": "0.0.0",
33655 "filename": "server/api/intVtigerAccount/index.js",
33656 "groupTitle": "Vtiger_Accounts"
33660 "url": "/api/integrations/vtiger/accounts/{id}/configurations",
33661 "title": "Gets account configurations",
33664 "title": "Example usage:",
33665 "content": "curl https://{domain}/api/integrations/vtiger/accounts/{id}/configurations -v -u {name}:{password} -X GET",
33669 "name": "getConfigurations",
33670 "group": "Vtiger_Accounts",
33671 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33672 "version": "0.0.0",
33673 "filename": "server/api/intVtigerAccount/index.js",
33674 "groupTitle": "Vtiger_Accounts"
33678 "url": "/api/integrations/vtiger/accounts/{id}/fields",
33679 "title": "Gets account fields",
33682 "title": "Example usage:",
33683 "content": "curl https://{domain}/api/integrations/vtiger/accounts/{id}/fields -v -u {name}:{password} -X GET",
33687 "name": "getFields",
33688 "group": "Vtiger_Accounts",
33689 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33690 "version": "0.0.0",
33691 "filename": "server/api/intVtigerAccount/index.js",
33692 "groupTitle": "Vtiger_Accounts"
33696 "url": "/api/integrations/vtiger/accounts/{id}",
33697 "title": "Update an existing Vtiger Account",
33700 "title": "Example usage:",
33701 "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",
33705 "name": "updateVtiger_Accounts",
33706 "group": "Vtiger_Accounts",
33707 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33708 "version": "0.0.0",
33709 "filename": "server/api/intVtigerAccount/index.js",
33710 "groupTitle": "Vtiger_Accounts"
33714 "url": "/api/integrations/vtiger/configurations",
33715 "title": "Creates a new Vtiger Configuration",
33718 "title": "Example usage:",
33719 "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",
33723 "name": "CreateVtiger_Configurations",
33724 "group": "Vtiger_Configurations",
33739 "field": "description",
33745 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33746 "version": "0.0.0",
33747 "filename": "server/api/intVtigerConfiguration/index.js",
33748 "groupTitle": "Vtiger_Configurations"
33752 "url": "/api/integrations/vtiger/configurations/{id}",
33753 "title": "Deletes a Vtiger Configuration",
33756 "title": "Example usage:",
33757 "content": "curl https://{domain}/api/integrations/vtiger/configurations/{id} -v -u {name}:{password} -X DELETE",
33761 "name": "DeleteVtiger_Configurations",
33762 "group": "Vtiger_Configurations",
33763 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33764 "version": "0.0.0",
33765 "filename": "server/api/intVtigerConfiguration/index.js",
33766 "groupTitle": "Vtiger_Configurations"
33770 "url": "/api/integrations/vtiger/configurations",
33771 "title": "Gets a list of Vtiger Configurations",
33774 "title": "Example usage:",
33775 "content": "curl https://{domain}/api/integrations/vtiger/configurations -v -u {name}:{password}",
33779 "name": "GetVtiger_Configurations",
33780 "group": "Vtiger_Configurations",
33781 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
33782 "version": "0.0.0",
33783 "filename": "server/api/intVtigerConfiguration/index.js",
33784 "groupTitle": "Vtiger_Configurations"
33788 "url": "/api/integrations/vtiger/configurations/{id}",
33789 "title": "Gets a single Vtiger Configuration",
33792 "title": "Example usage:",
33793 "content": "curl https://{domain}/api/integrations/vtiger/configurations/{id} -v -u {name}:{password}",
33797 "name": "ShowVtiger_Configurations",
33798 "group": "Vtiger_Configurations",
33799 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33800 "version": "0.0.0",
33801 "filename": "server/api/intVtigerConfiguration/index.js",
33802 "groupTitle": "Vtiger_Configurations"
33806 "url": "/api/integrations/vtiger/configurations/{id}/descriptions",
33807 "title": "Gets configurations descriptions",
33810 "title": "Example usage:",
33811 "content": "curl https://{domain}/api/integrations/vtiger/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
33815 "name": "getDescriptions",
33816 "group": "Vtiger_Configurations",
33817 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33818 "version": "0.0.0",
33819 "filename": "server/api/intVtigerConfiguration/index.js",
33820 "groupTitle": "Vtiger_Configurations"
33824 "url": "/api/integrations/vtiger/configurations/{id}/fields",
33825 "title": "Gets configurations fields",
33828 "title": "Example usage:",
33829 "content": "curl https://{domain}/api/integrations/vtiger/configurations/{id}/fields -v -u {name}:{password} -X GET",
33833 "name": "getFields",
33834 "group": "Vtiger_Configurations",
33835 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33836 "version": "0.0.0",
33837 "filename": "server/api/intVtigerConfiguration/index.js",
33838 "groupTitle": "Vtiger_Configurations"
33842 "url": "/api/integrations/vtiger/configurations/{id}/subjects",
33843 "title": "Gets configurations subjects",
33846 "title": "Example usage:",
33847 "content": "curl https://{domain}/api/integrations/vtiger/configurations/{id}/subjects -v -u {name}:{password} -X GET",
33851 "name": "getSubjects",
33852 "group": "Vtiger_Configurations",
33853 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33854 "version": "0.0.0",
33855 "filename": "server/api/intVtigerConfiguration/index.js",
33856 "groupTitle": "Vtiger_Configurations"
33860 "url": "/api/integrations/vtiger/configurations/{id}",
33861 "title": "Update an existing Vtiger Configuration",
33864 "title": "Example usage:",
33865 "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",
33869 "name": "updateVtiger_Configurations",
33870 "group": "Vtiger_Configurations",
33871 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33872 "version": "0.0.0",
33873 "filename": "server/api/intVtigerConfiguration/index.js",
33874 "groupTitle": "Vtiger_Configurations"
33878 "url": "/api/integrations/vtiger/fields",
33879 "title": "Creates a new Vtiger Field",
33882 "title": "Example usage:",
33883 "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",
33887 "name": "CreateVtiger_Fields",
33888 "group": "Vtiger_Fields",
33898 "\"customVariable\"",
33910 "field": "content",
33926 "\"customVariable\""
33929 "field": "keyType",
33936 "field": "keyContent",
33943 "field": "idField",
33950 "field": "nameField",
33957 "field": "customField",
33964 "field": "variableName",
33970 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</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": "Deletes a Vtiger Field",
33981 "title": "Example usage:",
33982 "content": "curl https://{domain}/api/integrations/vtiger/fields/{id} -v -u {name}:{password} -X DELETE",
33986 "name": "DeleteVtiger_Fields",
33987 "group": "Vtiger_Fields",
33988 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <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/integrations/vtiger/fields",
33996 "title": "Gets a list of Vtiger Fields",
33999 "title": "Example usage:",
34000 "content": "curl https://{domain}/api/integrations/vtiger/fields -v -u {name}:{password}",
34004 "name": "GetVtiger_Fields",
34005 "group": "Vtiger_Fields",
34006 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
34007 "version": "0.0.0",
34008 "filename": "server/api/intVtigerField/index.js",
34009 "groupTitle": "Vtiger_Fields"
34013 "url": "/api/integrations/vtiger/fields/{id}",
34014 "title": "Gets a single Vtiger Field",
34017 "title": "Example usage:",
34018 "content": "curl https://{domain}/api/integrations/vtiger/fields/{id} -v -u {name}:{password}",
34022 "name": "ShowVtiger_Fields",
34023 "group": "Vtiger_Fields",
34024 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34025 "version": "0.0.0",
34026 "filename": "server/api/intVtigerField/index.js",
34027 "groupTitle": "Vtiger_Fields"
34031 "url": "/api/integrations/vtiger/fields/{id}",
34032 "title": "Update an existing Vtiger Field",
34035 "title": "Example usage:",
34036 "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",
34040 "name": "updateVtiger_Fields",
34041 "group": "Vtiger_Fields",
34042 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34043 "version": "0.0.0",
34044 "filename": "server/api/intVtigerField/index.js",
34045 "groupTitle": "Vtiger_Fields"
34049 "url": "/api/webbar/answer",
34050 "title": "answer webrtc call",
34053 "title": "Example usage:",
34054 "content": "curl https://{domain}/api/webbar/answer -d '{\"sessionId\": \"<sessionId>\", \"userId\": 54}' \\\n -H \"Content-Type: application/json\" -X POST",
34058 "name": "Web_Bar_answer",
34067 "field": "sessionId",
34080 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34081 "version": "0.0.0",
34082 "filename": "server/api/webbar/index.js",
34083 "groupTitle": "WebBar"
34087 "url": "/api/webbar/calls",
34088 "title": "webrtc call list",
34091 "title": "Example usage:",
34092 "content": "curl https://{domain}/api/webbar/calls -d '{\"userId\": 54}' \\\n -H \"Content-Type: application/json\" -X POST",
34096 "name": "Web_Bar_calls",
34111 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34112 "version": "0.0.0",
34113 "filename": "server/api/webbar/index.js",
34114 "groupTitle": "WebBar"
34118 "url": "/api/webbar/hangup",
34119 "title": "hangup webrtc call",
34122 "title": "Example usage:",
34123 "content": "curl https://{domain}/api/webbar/hangup -d '{\"sessionId\": \"<sessionId>\", \"userId\": 54}' \\\n -H \"Content-Type: application/json\" -X POST",
34127 "name": "Web_Bar_hangup",
34136 "field": "sessionId",
34149 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34150 "version": "0.0.0",
34151 "filename": "server/api/webbar/index.js",
34152 "groupTitle": "WebBar"
34156 "url": "/api/webbar/unhold",
34157 "title": "unhold webrtc call",
34160 "title": "Example usage:",
34161 "content": "curl https://{domain}/api/webbar/unhold -d '{\"sessionId\": \"<sessionId>\", \"userId\": 54}' \\\n -H \"Content-Type: application/json\" -X POST",
34165 "name": "Web_Bar_hold",
34174 "field": "sessionId",
34187 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34188 "version": "0.0.0",
34189 "filename": "server/api/webbar/index.js",
34190 "groupTitle": "WebBar"
34194 "url": "/api/webbar/hold",
34195 "title": "hold webrtc call",
34198 "title": "Example usage:",
34199 "content": "curl https://{domain}/api/webbar/hold -d '{\"sessionId\": \"<sessionId>\", \"userId\": 54}' \\\n -H \"Content-Type: application/json\" -X POST",
34203 "name": "Web_Bar_hold",
34212 "field": "sessionId",
34225 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34226 "version": "0.0.0",
34227 "filename": "server/api/webbar/index.js",
34228 "groupTitle": "WebBar"
34232 "url": "/api/webbar/originate",
34233 "title": "Originate new webrtc call",
34236 "title": "Example usage:",
34237 "content": "curl https://{domain}/api/webbar/originate -d '{\"callNumber\": \"0119692844\", \"userId\": 54}' \\\n -H \"Content-Type: application/json\" -X POST",
34241 "name": "Web_Bar_originate",
34250 "field": "callNumber",
34264 "field": "callerId",
34271 "field": "callbackUrl",
34277 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34278 "version": "0.0.0",
34279 "filename": "server/api/webbar/index.js",
34280 "groupTitle": "WebBar"
34284 "url": "/api/webbar/transfer",
34285 "title": "blind transfer webrtc call",
34288 "title": "Example usage:",
34289 "content": "curl https://{domain}/api/webbar/transfer -d '{\"userId\": 54, \"sessionId\":\"<sessionId>\", \"transferNumber\":\"<transferNumber>\"}' \\\n -H \"Content-Type: application/json\" -X POST",
34293 "name": "Web_Bar_transfer",
34309 "field": "sessionId",
34316 "field": "transferNumber",
34322 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34323 "version": "0.0.0",
34324 "filename": "server/api/webbar/index.js",
34325 "groupTitle": "WebBar"
34329 "url": "/api/whatsapp/accounts/{id}/users",
34330 "title": "Add agents to a whatsapp account",
34333 "title": "Example usage:",
34334 "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",
34338 "name": "AddAgents",
34339 "group": "Whatsapp_Accounts",
34340 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34341 "version": "0.0.0",
34342 "filename": "server/api/whatsappAccount/index.js",
34343 "groupTitle": "Whatsapp_Accounts"
34347 "url": "/api/whatsapp/accounts",
34348 "title": "Creates a new Account",
34351 "title": "Example usage:",
34352 "content": "curl https://{domain}/api/whatsapp/accounts -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
34356 "name": "CreateAccounts",
34357 "group": "Whatsapp_Accounts",
34410 "field": "accountSid",
34417 "field": "authToken",
34424 "field": "notificationTemplate",
34431 "field": "notificationSound",
34438 "field": "notificationShake",
34445 "field": "waitForTheAssignedAgent",
34452 "field": "queueTransfer",
34459 "field": "queueTransferTimeout",
34466 "field": "agentTransfer",
34473 "field": "agentTransferTimeout",
34480 "field": "mandatoryDispositionPauseId",
34481 "description": "<p>Status to put when mandatory disposition is enabled</p>"
34487 "field": "mandatoryDisposition",
34488 "description": "<p>Enabled/disables mandatory dispo on a queue</p>"
34494 "field": "description",
34500 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34501 "version": "0.0.0",
34502 "filename": "server/api/whatsappAccount/index.js",
34503 "groupTitle": "Whatsapp_Accounts"
34507 "url": "/api/whatsapp/accounts/{id}",
34508 "title": "Deletes a Account",
34511 "title": "Example usage:",
34512 "content": "curl https://{domain}/api/whatsapp/accounts/{id} -v -u {name}:{password} -X DELETE",
34516 "name": "DeleteAccounts",
34517 "group": "Whatsapp_Accounts",
34518 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <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/describe",
34526 "title": "Gets table info about Accounts",
34529 "title": "Example usage:",
34530 "content": "curl https://{domain}/api/whatsapp/accounts/describe -v -u {name}:{password}",
34534 "name": "DescribeAccounts",
34535 "group": "Whatsapp_Accounts",
34536 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</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",
34544 "title": "Gets a list of Accounts",
34547 "title": "Example usage:",
34548 "content": "curl https://{domain}/api/whatsapp/accounts -v -u {name}:{password}",
34552 "name": "GetAccounts",
34553 "group": "Whatsapp_Accounts",
34554 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
34555 "version": "0.0.0",
34556 "filename": "server/api/whatsappAccount/index.js",
34557 "groupTitle": "Whatsapp_Accounts"
34561 "url": "/api/whatsapp/accounts/{id}/users",
34562 "title": "Gets agents from whatsapp account",
34565 "title": "Example usage:",
34566 "content": "curl https://{domain}/api/whatsapp/accounts/{id}/users -v -u {name}:{password} -X GET",
34570 "name": "GetAgents",
34571 "group": "Whatsapp_Accounts",
34572 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <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}/users",
34580 "title": "Removes agents from a whatsapp account",
34583 "title": "Example usage:",
34584 "content": "curl https://{domain}/api/whatsapp/accounts/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
34588 "name": "RemoveAgents",
34589 "group": "Whatsapp_Accounts",
34590 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <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/accounts/{id}/canned_answers",
34598 "title": "Removes canned answers from account",
34601 "title": "Example usage:",
34602 "content": "curl https://{domain}/api/whatsapp/accounts/{id}/canned_answers?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
34606 "name": "RemoveAnswers",
34607 "group": "Whatsapp_Accounts",
34608 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <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/whatsappAccount/index.js",
34611 "groupTitle": "Whatsapp_Accounts"
34615 "url": "/api/whatsapp/accounts/{id}/dispositions",
34616 "title": "Removes dispositions from account",
34619 "title": "Example usage:",
34620 "content": "curl https://{domain}/api/whatsapp/accounts/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
34624 "name": "RemoveDispositions",
34625 "group": "Whatsapp_Accounts",
34626 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34627 "version": "0.0.0",
34628 "filename": "server/api/whatsappAccount/index.js",
34629 "groupTitle": "Whatsapp_Accounts"
34633 "url": "/api/whatsapp/accounts/{id}",
34634 "title": "Gets a single Account",
34637 "title": "Example usage:",
34638 "content": "curl https://{domain}/api/whatsapp/accounts/{id} -v -u {name}:{password}",
34642 "name": "ShowAccounts",
34643 "group": "Whatsapp_Accounts",
34644 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34645 "version": "0.0.0",
34646 "filename": "server/api/whatsappAccount/index.js",
34647 "groupTitle": "Whatsapp_Accounts"
34651 "url": "/api/whatsapp/messages/{id}/accept",
34652 "title": "Accepts message",
34655 "title": "Example usage:",
34656 "content": "curl https://{domain}/api/whatsapp/messages/{id}/accept \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
34660 "name": "acceptMessage",
34661 "group": "Whatsapp_Accounts",
34662 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34663 "version": "0.0.0",
34664 "filename": "server/api/whatsappMessage/index.js",
34665 "groupTitle": "Whatsapp_Accounts"
34669 "url": "/api/whatsapp/accounts/{id}/canned_answers",
34670 "title": "Creates new canned answer",
34673 "title": "Example usage:",
34674 "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",
34678 "name": "addAnswer",
34679 "group": "Whatsapp_Accounts",
34701 "field": "description",
34714 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34715 "version": "0.0.0",
34716 "filename": "server/api/whatsappAccount/index.js",
34717 "groupTitle": "Whatsapp_Accounts"
34721 "url": "/api/whatsapp/accounts/{id}/applications",
34722 "title": "Creates new applications",
34725 "title": "Example usage:",
34726 "content": "curl https://{domain}/api/whatsapp/accounts/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
34730 "name": "addApplications",
34731 "group": "Whatsapp_Accounts",
34739 "field": "priority",
34753 "field": "appdata",
34760 "field": "description",
34767 "field": "interval",
34773 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34774 "version": "0.0.0",
34775 "filename": "server/api/whatsappAccount/index.js",
34776 "groupTitle": "Whatsapp_Accounts"
34780 "url": "/api/whatsapp/accounts/{id}/dispositions",
34781 "title": "Creates new disposition",
34784 "title": "Example usage:",
34785 "content": "curl https://{domain}/api/whatsapp/accounts/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
34789 "name": "addDisposition",
34790 "group": "Whatsapp_Accounts",
34817 "field": "description",
34823 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</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}/canned_answers",
34831 "title": "Gets account canned answers",
34834 "title": "Example usage:",
34835 "content": "curl https://{domain}/api/whatsapp/accounts/{id}/canned_answers -v -u {name}:{password} -X GET",
34839 "name": "getAnswers",
34840 "group": "Whatsapp_Accounts",
34841 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34842 "version": "0.0.0",
34843 "filename": "server/api/whatsappAccount/index.js",
34844 "groupTitle": "Whatsapp_Accounts"
34848 "url": "/api/whatsapp/accounts/{id}/applications",
34849 "title": "Gets account applications",
34852 "title": "Example usage:",
34853 "content": "curl https://{domain}/api/whatsapp/accounts/{id}/applications -v -u {name}:{password} -X GET",
34857 "name": "getApplications",
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/whatsappAccount/index.js",
34862 "groupTitle": "Whatsapp_Accounts"
34866 "url": "/api/whatsapp/accounts/{id}/dispositions",
34867 "title": "Gets account dispositions",
34870 "title": "Example usage:",
34871 "content": "curl https://{domain}/api/whatsapp/accounts/{id}/dispositions -v -u {name}:{password} -X GET",
34875 "name": "getDispositions",
34876 "group": "Whatsapp_Accounts",
34877 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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/accounts/{id}/notify",
34885 "title": "Notify new message",
34888 "title": "Example usage:",
34889 "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",
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> <p>This API is used to create a new whatsapp message to be sent to the system.</p>",
34896 "version": "0.0.0",
34897 "filename": "server/api/whatsappAccount/index.js",
34898 "groupTitle": "Whatsapp_Accounts"
34902 "url": "/api/whatsapp/messages/{id}/reject",
34903 "title": "Rejects message",
34906 "title": "Example usage:",
34907 "content": "curl https://{domain}/api/whatsapp/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
34911 "name": "rejectMessage",
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/whatsappMessage/index.js",
34916 "groupTitle": "Whatsapp_Accounts"
34920 "url": "/api/whatsapp/accounts/{id}/send",
34921 "title": "Send new whatsapp message",
34924 "title": "Example usage:",
34925 "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",
34929 "name": "sendWhatsapp",
34930 "group": "Whatsapp_Accounts",
34931 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34932 "version": "0.0.0",
34933 "filename": "server/api/whatsappAccount/index.js",
34934 "groupTitle": "Whatsapp_Accounts"
34938 "url": "/api/whatsapp/messages/{id}/status",
34939 "title": "Receive message status",
34942 "title": "Example usage:",
34943 "content": "curl https://{domain}/api/whatsapp/messages/{id}/status \\ \n -H 'Content-Type: application/json' -v -X POST",
34947 "name": "statusMessage",
34948 "group": "Whatsapp_Accounts",
34949 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34950 "version": "0.0.0",
34951 "filename": "server/api/whatsappMessage/index.js",
34952 "groupTitle": "Whatsapp_Accounts"
34956 "url": "/api/whatsapp/accounts/{id}",
34957 "title": "Update an existing Account",
34960 "title": "Example usage:",
34961 "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",
34965 "name": "updateAccounts",
34966 "group": "Whatsapp_Accounts",
34967 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34968 "version": "0.0.0",
34969 "filename": "server/api/whatsappAccount/index.js",
34970 "groupTitle": "Whatsapp_Accounts"
34974 "url": "/api/whatsapp/applications",
34975 "title": "Creates a new Application",
34978 "title": "Example usage:",
34979 "content": "curl https://{domain}/api/whatsapp/applications -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
34983 "name": "CreateApplications",
34984 "group": "Whatsapp_Applications",
34992 "field": "priority",
35006 "field": "appdata",
35013 "field": "description",
35020 "field": "interval",
35026 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35027 "version": "0.0.0",
35028 "filename": "server/api/whatsappApplication/index.js",
35029 "groupTitle": "Whatsapp_Applications"
35033 "url": "/api/whatsapp/applications/{id}",
35034 "title": "Deletes a Application",
35037 "title": "Example usage:",
35038 "content": "curl https://{domain}/api/whatsapp/applications/{id} -v -u {name}:{password} -X DELETE",
35042 "name": "DeleteApplications",
35043 "group": "Whatsapp_Applications",
35044 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <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/applications",
35052 "title": "Gets a list of Applications",
35055 "title": "Example usage:",
35056 "content": "curl https://{domain}/api/whatsapp/applications -v -u {name}:{password}",
35060 "name": "GetApplications",
35061 "group": "Whatsapp_Applications",
35062 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
35063 "version": "0.0.0",
35064 "filename": "server/api/whatsappApplication/index.js",
35065 "groupTitle": "Whatsapp_Applications"
35069 "url": "/api/whatsapp/applications/{id}",
35070 "title": "Gets a single Application",
35073 "title": "Example usage:",
35074 "content": "curl https://{domain}/api/whatsapp/applications/{id} -v -u {name}:{password}",
35078 "name": "ShowApplications",
35079 "group": "Whatsapp_Applications",
35080 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35081 "version": "0.0.0",
35082 "filename": "server/api/whatsappApplication/index.js",
35083 "groupTitle": "Whatsapp_Applications"
35087 "url": "/api/whatsapp/applications/{id}",
35088 "title": "Update an existing Application",
35091 "title": "Example usage:",
35092 "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",
35096 "name": "updateApplications",
35097 "group": "Whatsapp_Applications",
35098 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35099 "version": "0.0.0",
35100 "filename": "server/api/whatsappApplication/index.js",
35101 "groupTitle": "Whatsapp_Applications"
35105 "url": "/api/whatsapp/interactions/{id}/tags",
35106 "title": "Add tags to the interaction",
35109 "title": "Example usage:",
35110 "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",
35115 "group": "Whatsapp_Interactions",
35116 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35117 "version": "0.0.0",
35118 "filename": "server/api/whatsappInteraction/index.js",
35119 "groupTitle": "Whatsapp_Interactions"
35123 "url": "/api/whatsapp/interactions",
35124 "title": "Creates a new Interaction",
35127 "title": "Example usage:",
35128 "content": "curl https://{domain}/api/whatsapp/interactions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
35132 "name": "CreateInteractions",
35133 "group": "Whatsapp_Interactions",
35148 "field": "closedAt",
35155 "field": "disposition",
35162 "field": "secondDisposition",
35169 "field": "thirdDisposition",
35190 "field": "read1stAt",
35201 "field": "firstMsgDirection",
35208 "field": "lastMsgAt",
35219 "field": "lastMsgDirection",
35225 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35226 "version": "0.0.0",
35227 "filename": "server/api/whatsappInteraction/index.js",
35228 "groupTitle": "Whatsapp_Interactions"
35232 "url": "/api/whatsapp/interactions/{id}",
35233 "title": "Deletes a Interaction",
35236 "title": "Example usage:",
35237 "content": "curl https://{domain}/api/whatsapp/interactions/{id} -v -u {name}:{password} -X DELETE",
35241 "name": "DeleteInteractions",
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/describe",
35251 "title": "Gets table info about Interactions",
35254 "title": "Example usage:",
35255 "content": "curl https://{domain}/api/whatsapp/interactions/describe -v -u {name}:{password}",
35259 "name": "DescribeInteractions",
35260 "group": "Whatsapp_Interactions",
35261 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</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",
35269 "title": "Gets a list of Interactions",
35272 "title": "Example usage:",
35273 "content": "curl https://{domain}/api/whatsapp/interactions -v -u {name}:{password}",
35277 "name": "GetInteractions",
35278 "group": "Whatsapp_Interactions",
35279 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
35280 "version": "0.0.0",
35281 "filename": "server/api/whatsappInteraction/index.js",
35282 "groupTitle": "Whatsapp_Interactions"
35286 "url": "/api/whatsapp/interactions/{id}/tags",
35287 "title": "Removes tags from interaction",
35290 "title": "Example usage:",
35291 "content": "curl https://{domain}/api/whatsapp/interactions/{id}/tags?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
35295 "name": "RemoveTags",
35296 "group": "Whatsapp_Interactions",
35297 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35298 "version": "0.0.0",
35299 "filename": "server/api/whatsappInteraction/index.js",
35300 "groupTitle": "Whatsapp_Interactions"
35304 "url": "/api/whatsapp/interactions/{id}",
35305 "title": "Gets a single Interaction",
35308 "title": "Example usage:",
35309 "content": "curl https://{domain}/api/whatsapp/interactions/{id} -v -u {name}:{password}",
35313 "name": "ShowInteractions",
35314 "group": "Whatsapp_Interactions",
35315 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35316 "version": "0.0.0",
35317 "filename": "server/api/whatsappInteraction/index.js",
35318 "groupTitle": "Whatsapp_Interactions"
35322 "url": "/api/whatsapp/interactions/{id}/messages",
35323 "title": "Creates new messages",
35326 "title": "Example usage:",
35327 "content": "curl https://{domain}/api/whatsapp/interactions/{id}/messages -d '[{\"to\": \"+3901119886500\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
35331 "name": "addMessage",
35332 "group": "Whatsapp_Interactions",
35358 "field": "direction",
35365 "field": "messageId",
35393 "field": "providerName",
35400 "field": "providerResponse",
35406 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</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/interactions/{id}/download",
35414 "title": "Gets interaction",
35417 "title": "Example usage:",
35418 "content": "curl https://{domain}/api/whatsapp/interactions/{id}/download -v -u {name}:{password} -X GET",
35422 "name": "download",
35423 "group": "Whatsapp_Interactions",
35424 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35425 "version": "0.0.0",
35426 "filename": "server/api/whatsappInteraction/index.js",
35427 "groupTitle": "Whatsapp_Interactions"
35431 "url": "/api/whatsapp/interactions/{id}/messages",
35432 "title": "Gets interaction messages",
35435 "title": "Example usage:",
35436 "content": "curl https://{domain}/api/whatsapp/interactions/{id}/messages -v -u {name}:{password} -X GET",
35440 "name": "getMessages",
35441 "group": "Whatsapp_Interactions",
35442 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35443 "version": "0.0.0",
35444 "filename": "server/api/whatsappInteraction/index.js",
35445 "groupTitle": "Whatsapp_Interactions"
35449 "url": "/api/whatsapp/interactions/{id}",
35450 "title": "Update an existing Interaction",
35453 "title": "Example usage:",
35454 "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",
35458 "name": "updateInteractions",
35459 "group": "Whatsapp_Interactions",
35460 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35461 "version": "0.0.0",
35462 "filename": "server/api/whatsappInteraction/index.js",
35463 "groupTitle": "Whatsapp_Interactions"
35467 "url": "/api/whatsapp/messages",
35468 "title": "Creates a new Message",
35471 "title": "Example usage:",
35472 "content": "curl https://{domain}/api/whatsapp/messages -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
35476 "name": "CreateMessages",
35477 "group": "Whatsapp_Messages",
35503 "field": "direction",
35510 "field": "messageId",
35538 "field": "providerName",
35545 "field": "providerResponse",
35551 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</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": "Deletes a Message",
35562 "title": "Example usage:",
35563 "content": "curl https://{domain}/api/whatsapp/messages/{id} -v -u {name}:{password} -X DELETE",
35567 "name": "DeleteMessages",
35568 "group": "Whatsapp_Messages",
35569 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <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/describe",
35577 "title": "Gets table info about Messages",
35580 "title": "Example usage:",
35581 "content": "curl https://{domain}/api/whatsapp/messages/describe -v -u {name}:{password}",
35585 "name": "DescribeMessages",
35586 "group": "Whatsapp_Messages",
35587 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</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/messages",
35595 "title": "Gets a list of Messages",
35598 "title": "Example usage:",
35599 "content": "curl https://{domain}/api/whatsapp/messages -v -u {name}:{password}",
35603 "name": "GetMessages",
35604 "group": "Whatsapp_Messages",
35605 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
35606 "version": "0.0.0",
35607 "filename": "server/api/whatsappMessage/index.js",
35608 "groupTitle": "Whatsapp_Messages"
35612 "url": "/api/whatsapp/messages/{id}",
35613 "title": "Gets a single Message",
35616 "title": "Example usage:",
35617 "content": "curl https://{domain}/api/whatsapp/messages/{id} -v -u {name}:{password}",
35621 "name": "ShowMessages",
35622 "group": "Whatsapp_Messages",
35623 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35624 "version": "0.0.0",
35625 "filename": "server/api/whatsappMessage/index.js",
35626 "groupTitle": "Whatsapp_Messages"
35630 "url": "/api/whatsapp/messages/{id}",
35631 "title": "Update an existing Message",
35634 "title": "Example usage:",
35635 "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",
35639 "name": "updateMessages",
35640 "group": "Whatsapp_Messages",
35641 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35642 "version": "0.0.0",
35643 "filename": "server/api/whatsappMessage/index.js",
35644 "groupTitle": "Whatsapp_Messages"
35648 "url": "/api/whatsapp/reports/queue",
35649 "title": "Creates a new Whatsapp Queue Report",
35652 "title": "Example usage:",
35653 "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",
35657 "name": "CreateWhatsapp_Queue_Reports",
35658 "group": "Whatsapp_Queue_Reports",
35666 "field": "uniqueid",
35687 "field": "leaveAt",
35694 "field": "acceptAt",
35714 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</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": "Deletes a Whatsapp Queue Report",
35725 "title": "Example usage:",
35726 "content": "curl https://{domain}/api/whatsapp/reports/queue/{id} -v -u {name}:{password} -X DELETE",
35730 "name": "DeleteWhatsapp_Queue_Reports",
35731 "group": "Whatsapp_Queue_Reports",
35732 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <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/describe",
35740 "title": "Gets table info about Whatsapp Queue Reports",
35743 "title": "Example usage:",
35744 "content": "curl https://{domain}/api/whatsapp/reports/queue/describe -v -u {name}:{password}",
35748 "name": "DescribeWhatsapp_Queue_Reports",
35749 "group": "Whatsapp_Queue_Reports",
35750 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</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/reports/queue",
35758 "title": "Gets a list of Whatsapp Queue Reports",
35761 "title": "Example usage:",
35762 "content": "curl https://{domain}/api/whatsapp/reports/queue -v -u {name}:{password}",
35766 "name": "GetWhatsapp_Queue_Reports",
35767 "group": "Whatsapp_Queue_Reports",
35768 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
35769 "version": "0.0.0",
35770 "filename": "server/api/whatsappQueueReport/index.js",
35771 "groupTitle": "Whatsapp_Queue_Reports"
35775 "url": "/api/whatsapp/reports/queue/{id}",
35776 "title": "Gets a single Whatsapp Queue Report",
35779 "title": "Example usage:",
35780 "content": "curl https://{domain}/api/whatsapp/reports/queue/{id} -v -u {name}:{password}",
35784 "name": "ShowWhatsapp_Queue_Reports",
35785 "group": "Whatsapp_Queue_Reports",
35786 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35787 "version": "0.0.0",
35788 "filename": "server/api/whatsappQueueReport/index.js",
35789 "groupTitle": "Whatsapp_Queue_Reports"
35793 "url": "/api/whatsapp/reports/queue/{id}",
35794 "title": "Update an existing Whatsapp Queue Report",
35797 "title": "Example usage:",
35798 "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",
35802 "name": "updateWhatsapp_Queue_Reports",
35803 "group": "Whatsapp_Queue_Reports",
35804 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35805 "version": "0.0.0",
35806 "filename": "server/api/whatsappQueueReport/index.js",
35807 "groupTitle": "Whatsapp_Queue_Reports"
35811 "url": "/api/whatsapp/queues/{id}/users",
35812 "title": "Add agents to a queue",
35815 "title": "Example usage:",
35816 "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",
35820 "name": "AddAgents",
35821 "group": "Whatsapp_Queues",
35822 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35823 "version": "0.0.0",
35824 "filename": "server/api/whatsappQueue/index.js",
35825 "groupTitle": "Whatsapp_Queues"
35829 "url": "/api/whatsapp/queues/{id}/teams",
35830 "title": "Add teams to a queue",
35833 "title": "Example usage:",
35834 "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",
35838 "name": "AddTeams",
35839 "group": "Whatsapp_Queues",
35840 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35841 "version": "0.0.0",
35842 "filename": "server/api/whatsappQueue/index.js",
35843 "groupTitle": "Whatsapp_Queues"
35847 "url": "/api/whatsapp/queues",
35848 "title": "Creates a new Queue",
35851 "title": "Example usage:",
35852 "content": "curl https://{domain}/api/whatsapp/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
35856 "name": "CreateQueues",
35857 "group": "Whatsapp_Queues",
35872 "field": "timeout",
35884 "field": "strategy",
35891 "field": "description",
35897 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</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}",
35905 "title": "Deletes a Queue",
35908 "title": "Example usage:",
35909 "content": "curl https://{domain}/api/whatsapp/queues/{id} -v -u {name}:{password} -X DELETE",
35913 "name": "DeleteQueues",
35914 "group": "Whatsapp_Queues",
35915 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <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/describe",
35923 "title": "Gets table info about Queues",
35926 "title": "Example usage:",
35927 "content": "curl https://{domain}/api/whatsapp/queues/describe -v -u {name}:{password}",
35931 "name": "DescribeQueues",
35932 "group": "Whatsapp_Queues",
35933 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35934 "version": "0.0.0",
35935 "filename": "server/api/whatsappQueue/index.js",
35936 "groupTitle": "Whatsapp_Queues"
35940 "url": "/api/whatsapp/queues/{id}/users",
35941 "title": "Gets queue agents",
35944 "title": "Example usage:",
35945 "content": "curl https://{domain}/api/whatsapp/queues/{id}/users -v -u {name}:{password} -X POST",
35949 "name": "GetAgents",
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}/members",
35959 "title": "GetMembers",
35962 "title": "Example usage:",
35963 "content": "curl https://{domain}/api/whatsapp/queues/{id}/members -v -u {name}:{password}",
35967 "name": "GetMembers",
35968 "group": "Whatsapp_Queues",
35969 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <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",
35977 "title": "Gets a list of Queues",
35980 "title": "Example usage:",
35981 "content": "curl https://{domain}/api/whatsapp/queues -v -u {name}:{password}",
35985 "name": "GetQueues",
35986 "group": "Whatsapp_Queues",
35987 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
35988 "version": "0.0.0",
35989 "filename": "server/api/whatsappQueue/index.js",
35990 "groupTitle": "Whatsapp_Queues"
35994 "url": "/api/whatsapp/queues/{id}/teams",
35995 "title": "Gets queues list",
35998 "title": "Example usage:",
35999 "content": "curl https://{domain}/api/whatsapp/queues/{id}/teams -v -u {name}:{password}",
36003 "name": "GetTeams",
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/queues/{id}/users",
36013 "title": "Removes agents from a queue",
36016 "title": "Example usage:",
36017 "content": "curl https://{domain}/api/whatsapp/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
36021 "name": "RemoveAgents",
36022 "group": "Whatsapp_Queues",
36023 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36024 "version": "0.0.0",
36025 "filename": "server/api/whatsappQueue/index.js",
36026 "groupTitle": "Whatsapp_Queues"
36030 "url": "/api/whatsapp/queues/{id}",
36031 "title": "Gets a single Queue",
36034 "title": "Example usage:",
36035 "content": "curl https://{domain}/api/whatsapp/queues/{id} -v -u {name}:{password}",
36039 "name": "ShowQueues",
36040 "group": "Whatsapp_Queues",
36041 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36042 "version": "0.0.0",
36043 "filename": "server/api/whatsappQueue/index.js",
36044 "groupTitle": "Whatsapp_Queues"
36048 "url": "/api/whatsapp/queues/{id}",
36049 "title": "Update an existing Queue",
36052 "title": "Example usage:",
36053 "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",
36057 "name": "updateQueues",
36058 "group": "Whatsapp_Queues",
36059 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36060 "version": "0.0.0",
36061 "filename": "server/api/whatsappQueue/index.js",
36062 "groupTitle": "Whatsapp_Queues"
36066 "url": "/api/whatsapp/reports/transfer",
36067 "title": "Creates a new Whatsapp Transfer Report",
36070 "title": "Example usage:",
36071 "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",
36075 "name": "CreateWhatsapp_Transfer_Reports",
36076 "group": "Whatsapp_Transfer_Reports",
36084 "field": "uniqueid",
36103 "field": "transferredAt",
36109 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</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": "Deletes a Whatsapp Transfer Report",
36120 "title": "Example usage:",
36121 "content": "curl https://{domain}/api/whatsapp/reports/transfer/{id} -v -u {name}:{password} -X DELETE",
36125 "name": "DeleteWhatsapp_Transfer_Reports",
36126 "group": "Whatsapp_Transfer_Reports",
36127 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <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/describe",
36135 "title": "Gets table info about Whatsapp Transfer Reports",
36138 "title": "Example usage:",
36139 "content": "curl https://{domain}/api/whatsapp/reports/transfer/describe -v -u {name}:{password}",
36143 "name": "DescribeWhatsapp_Transfer_Reports",
36144 "group": "Whatsapp_Transfer_Reports",
36145 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</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/whatsapp/reports/transfer",
36153 "title": "Gets a list of Whatsapp Transfer Reports",
36156 "title": "Example usage:",
36157 "content": "curl https://{domain}/api/whatsapp/reports/transfer -v -u {name}:{password}",
36161 "name": "GetWhatsapp_Transfer_Reports",
36162 "group": "Whatsapp_Transfer_Reports",
36163 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
36164 "version": "0.0.0",
36165 "filename": "server/api/whatsappTransferReport/index.js",
36166 "groupTitle": "Whatsapp_Transfer_Reports"
36170 "url": "/api/whatsapp/reports/transfer/{id}",
36171 "title": "Gets a single Whatsapp Transfer Report",
36174 "title": "Example usage:",
36175 "content": "curl https://{domain}/api/whatsapp/reports/transfer/{id} -v -u {name}:{password}",
36179 "name": "ShowWhatsapp_Transfer_Reports",
36180 "group": "Whatsapp_Transfer_Reports",
36181 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36182 "version": "0.0.0",
36183 "filename": "server/api/whatsappTransferReport/index.js",
36184 "groupTitle": "Whatsapp_Transfer_Reports"
36188 "url": "/api/whatsapp/reports/transfer/{id}",
36189 "title": "Update an existing Whatsapp Transfer Report",
36192 "title": "Example usage:",
36193 "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",
36197 "name": "updateWhatsapp_Transfer_Reports",
36198 "group": "Whatsapp_Transfer_Reports",
36199 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36200 "version": "0.0.0",
36201 "filename": "server/api/whatsappTransferReport/index.js",
36202 "groupTitle": "Whatsapp_Transfer_Reports"
36206 "url": "/api/integrations/zendesk/accounts",
36207 "title": "Creates a new Zendesk Account",
36210 "title": "Example usage:",
36211 "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",
36215 "name": "CreateZendesk_Accounts",
36216 "group": "Zendesk_Accounts",
36231 "field": "description",
36238 "field": "username",
36245 "field": "password",
36259 "field": "remoteUri",
36270 "field": "authType",
36277 "field": "serverUrl",
36284 "\"integrationTab\"",
36294 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</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}",
36302 "title": "Deletes a Zendesk Account",
36305 "title": "Example usage:",
36306 "content": "curl https://{domain}/api/integrations/zendesk/accounts/{id} -v -u {name}:{password} -X DELETE",
36310 "name": "DeleteZendesk_Accounts",
36311 "group": "Zendesk_Accounts",
36312 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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",
36320 "title": "Gets a list of Zendesk Accounts",
36323 "title": "Example usage:",
36324 "content": "curl https://{domain}/api/integrations/zendesk/accounts -v -u {name}:{password}",
36328 "name": "GetZendesk_Accounts",
36329 "group": "Zendesk_Accounts",
36330 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
36331 "version": "0.0.0",
36332 "filename": "server/api/intZendeskAccount/index.js",
36333 "groupTitle": "Zendesk_Accounts"
36337 "url": "/api/integrations/zendesk/accounts/{id}",
36338 "title": "Gets a single Zendesk Account",
36341 "title": "Example usage:",
36342 "content": "curl https://{domain}/api/integrations/zendesk/accounts/{id} -v -u {name}:{password}",
36346 "name": "ShowZendesk_Accounts",
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}/configurations",
36356 "title": "Creates new configuration",
36359 "title": "Example usage:",
36360 "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",
36364 "name": "addConfiguration",
36365 "group": "Zendesk_Accounts",
36366 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</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/accounts/{id}/configurations",
36374 "title": "Gets account configurations",
36377 "title": "Example usage:",
36378 "content": "curl https://{domain}/api/integrations/zendesk/accounts/{id}/configurations -v -u {name}:{password} -X GET",
36382 "name": "getConfigurations",
36383 "group": "Zendesk_Accounts",
36384 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36385 "version": "0.0.0",
36386 "filename": "server/api/intZendeskAccount/index.js",
36387 "groupTitle": "Zendesk_Accounts"
36391 "url": "/api/integrations/zendesk/accounts/{id}/fields",
36392 "title": "Gets account fields",
36395 "title": "Example usage:",
36396 "content": "curl https://{domain}/api/integrations/zendesk/accounts/{id}/fields -v -u {name}:{password} -X GET",
36400 "name": "getFields",
36401 "group": "Zendesk_Accounts",
36402 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36403 "version": "0.0.0",
36404 "filename": "server/api/intZendeskAccount/index.js",
36405 "groupTitle": "Zendesk_Accounts"
36409 "url": "/api/integrations/zendesk/accounts/{id}",
36410 "title": "Update an existing Zendesk Account",
36413 "title": "Example usage:",
36414 "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",
36418 "name": "updateZendesk_Accounts",
36419 "group": "Zendesk_Accounts",
36420 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36421 "version": "0.0.0",
36422 "filename": "server/api/intZendeskAccount/index.js",
36423 "groupTitle": "Zendesk_Accounts"
36427 "url": "/api/integrations/zendesk/configurations",
36428 "title": "Creates a new Zendesk Configuration",
36431 "title": "Example usage:",
36432 "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",
36436 "name": "CreateZendesk_Configurations",
36437 "group": "Zendesk_Configurations",
36452 "field": "description",
36458 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</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}",
36466 "title": "Deletes a Zendesk Configuration",
36469 "title": "Example usage:",
36470 "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id} -v -u {name}:{password} -X DELETE",
36474 "name": "DeleteZendesk_Configurations",
36475 "group": "Zendesk_Configurations",
36476 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <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",
36484 "title": "Gets a list of Zendesk Configurations",
36487 "title": "Example usage:",
36488 "content": "curl https://{domain}/api/integrations/zendesk/configurations -v -u {name}:{password}",
36492 "name": "GetZendesk_Configurations",
36493 "group": "Zendesk_Configurations",
36494 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
36495 "version": "0.0.0",
36496 "filename": "server/api/intZendeskConfiguration/index.js",
36497 "groupTitle": "Zendesk_Configurations"
36501 "url": "/api/integrations/zendesk/configurations/{id}",
36502 "title": "Gets a single Zendesk Configuration",
36505 "title": "Example usage:",
36506 "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id} -v -u {name}:{password}",
36510 "name": "ShowZendesk_Configurations",
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}/descriptions",
36520 "title": "Gets configurations descriptions",
36523 "title": "Example usage:",
36524 "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
36528 "name": "getDescriptions",
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}/fields",
36538 "title": "Gets configurations fields",
36541 "title": "Example usage:",
36542 "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id}/fields -v -u {name}:{password} -X GET",
36546 "name": "getFields",
36547 "group": "Zendesk_Configurations",
36548 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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}/subjects",
36556 "title": "Gets configurations subjects",
36559 "title": "Example usage:",
36560 "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id}/subjects -v -u {name}:{password} -X GET",
36564 "name": "getSubjects",
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/configurations/{id}/tags",
36574 "title": "Gets configurations tags",
36577 "title": "Example usage:",
36578 "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id}/tags -v -u {name}:{password} -X GET",
36583 "group": "Zendesk_Configurations",
36584 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36585 "version": "0.0.0",
36586 "filename": "server/api/intZendeskConfiguration/index.js",
36587 "groupTitle": "Zendesk_Configurations"
36591 "url": "/api/integrations/zendesk/configurations/{id}/tags",
36592 "title": "Sets new tags",
36595 "title": "Example usage:",
36596 "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",
36601 "group": "Zendesk_Configurations",
36602 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36603 "version": "0.0.0",
36604 "filename": "server/api/intZendeskConfiguration/index.js",
36605 "groupTitle": "Zendesk_Configurations"
36609 "url": "/api/integrations/zendesk/configurations/{id}",
36610 "title": "Update an existing Zendesk Configuration",
36613 "title": "Example usage:",
36614 "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",
36618 "name": "updateZendesk_Configurations",
36619 "group": "Zendesk_Configurations",
36620 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36621 "version": "0.0.0",
36622 "filename": "server/api/intZendeskConfiguration/index.js",
36623 "groupTitle": "Zendesk_Configurations"
36627 "url": "/api/integrations/zendesk/fields",
36628 "title": "Creates a new Zendesk Field",
36631 "title": "Example usage:",
36632 "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",
36636 "name": "CreateZendesk_Fields",
36637 "group": "Zendesk_Fields",
36647 "\"customVariable\"",
36659 "field": "content",
36675 "\"customVariable\""
36678 "field": "keyType",
36685 "field": "keyContent",
36692 "field": "idField",
36699 "field": "nameField",
36706 "field": "customField",
36713 "field": "variableName",
36719 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36720 "version": "0.0.0",
36721 "filename": "server/api/intZendeskField/index.js",
36722 "groupTitle": "Zendesk_Fields"
36726 "url": "/api/integrations/zendesk/fields/{id}",
36727 "title": "Deletes a Zendesk Field",
36730 "title": "Example usage:",
36731 "content": "curl https://{domain}/api/integrations/zendesk/fields/{id} -v -u {name}:{password} -X DELETE",
36735 "name": "DeleteZendesk_Fields",
36736 "group": "Zendesk_Fields",
36737 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36738 "version": "0.0.0",
36739 "filename": "server/api/intZendeskField/index.js",
36740 "groupTitle": "Zendesk_Fields"
36744 "url": "/api/integrations/zendesk/fields",
36745 "title": "Gets a list of Zendesk Fields",
36748 "title": "Example usage:",
36749 "content": "curl https://{domain}/api/integrations/zendesk/fields -v -u {name}:{password}",
36753 "name": "GetZendesk_Fields",
36754 "group": "Zendesk_Fields",
36755 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
36756 "version": "0.0.0",
36757 "filename": "server/api/intZendeskField/index.js",
36758 "groupTitle": "Zendesk_Fields"
36762 "url": "/api/integrations/zendesk/fields/{id}",
36763 "title": "Gets a single Zendesk Field",
36766 "title": "Example usage:",
36767 "content": "curl https://{domain}/api/integrations/zendesk/fields/{id} -v -u {name}:{password}",
36771 "name": "ShowZendesk_Fields",
36772 "group": "Zendesk_Fields",
36773 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36774 "version": "0.0.0",
36775 "filename": "server/api/intZendeskField/index.js",
36776 "groupTitle": "Zendesk_Fields"
36780 "url": "/api/integrations/zendesk/fields/{id}",
36781 "title": "Update an existing Zendesk Field",
36784 "title": "Example usage:",
36785 "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",
36789 "name": "updateZendesk_Fields",
36790 "group": "Zendesk_Fields",
36791 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36792 "version": "0.0.0",
36793 "filename": "server/api/intZendeskField/index.js",
36794 "groupTitle": "Zendesk_Fields"
36798 "url": "/api/integrations/zoho/accounts",
36799 "title": "Creates a new Zoho Account",
36802 "title": "Example usage:",
36803 "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",
36807 "name": "CreateZoho_Accounts",
36808 "group": "Zoho_Accounts",
36823 "field": "description",
36844 "field": "clientId",
36851 "field": "clientSecret",
36858 "field": "serverUrl",
36872 "field": "refreshToken",
36878 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36879 "version": "0.0.0",
36880 "filename": "server/api/intZohoAccount/index.js",
36881 "groupTitle": "Zoho_Accounts"
36885 "url": "/api/integrations/zoho/accounts/{id}",
36886 "title": "Deletes a Zoho Account",
36889 "title": "Example usage:",
36890 "content": "curl https://{domain}/api/integrations/zoho/accounts/{id} -v -u {name}:{password} -X DELETE",
36894 "name": "DeleteZoho_Accounts",
36895 "group": "Zoho_Accounts",
36896 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36897 "version": "0.0.0",
36898 "filename": "server/api/intZohoAccount/index.js",
36899 "groupTitle": "Zoho_Accounts"
36903 "url": "/api/integrations/zoho/accounts",
36904 "title": "Gets a list of Zoho Accounts",
36907 "title": "Example usage:",
36908 "content": "curl https://{domain}/api/integrations/zoho/accounts -v -u {name}:{password}",
36912 "name": "GetZoho_Accounts",
36913 "group": "Zoho_Accounts",
36914 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
36915 "version": "0.0.0",
36916 "filename": "server/api/intZohoAccount/index.js",
36917 "groupTitle": "Zoho_Accounts"
36921 "url": "/api/integrations/zoho/accounts/{id}",
36922 "title": "Gets a single Zoho Account",
36925 "title": "Example usage:",
36926 "content": "curl https://{domain}/api/integrations/zoho/accounts/{id} -v -u {name}:{password}",
36930 "name": "ShowZoho_Accounts",
36931 "group": "Zoho_Accounts",
36932 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36933 "version": "0.0.0",
36934 "filename": "server/api/intZohoAccount/index.js",
36935 "groupTitle": "Zoho_Accounts"
36939 "url": "/api/integrations/zoho/accounts/{id}/configurations",
36940 "title": "Creates new configuration",
36943 "title": "Example usage:",
36944 "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",
36948 "name": "addConfiguration",
36949 "group": "Zoho_Accounts",
36950 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36951 "version": "0.0.0",
36952 "filename": "server/api/intZohoAccount/index.js",
36953 "groupTitle": "Zoho_Accounts"
36957 "url": "/api/integrations/zoho/accounts/{id}/configurations",
36958 "title": "Gets account configurations",
36961 "title": "Example usage:",
36962 "content": "curl https://{domain}/api/integrations/zoho/accounts/{id}/configurations -v -u {name}:{password} -X GET",
36966 "name": "getConfigurations",
36967 "group": "Zoho_Accounts",
36968 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36969 "version": "0.0.0",
36970 "filename": "server/api/intZohoAccount/index.js",
36971 "groupTitle": "Zoho_Accounts"
36975 "url": "/api/integrations/zoho/accounts/{id}/fields",
36976 "title": "Gets account fields",
36979 "title": "Example usage:",
36980 "content": "curl https://{domain}/api/integrations/zoho/accounts/{id}/fields -v -u {name}:{password} -X GET",
36984 "name": "getFields",
36985 "group": "Zoho_Accounts",
36986 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36987 "version": "0.0.0",
36988 "filename": "server/api/intZohoAccount/index.js",
36989 "groupTitle": "Zoho_Accounts"
36993 "url": "/api/integrations/zoho/accounts/{id}",
36994 "title": "Update an existing Zoho Account",
36997 "title": "Example usage:",
36998 "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",
37002 "name": "updateZoho_Accounts",
37003 "group": "Zoho_Accounts",
37004 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37005 "version": "0.0.0",
37006 "filename": "server/api/intZohoAccount/index.js",
37007 "groupTitle": "Zoho_Accounts"
37011 "url": "/api/integrations/zoho/configurations",
37012 "title": "Creates a new Zoho Configuration",
37015 "title": "Example usage:",
37016 "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",
37020 "name": "CreateZoho_Configurations",
37021 "group": "Zoho_Configurations",
37041 "field": "moduleCreate",
37048 "\"contact_lead\"",
37053 "field": "moduleSearch",
37060 "field": "description",
37066 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37067 "version": "0.0.0",
37068 "filename": "server/api/intZohoConfiguration/index.js",
37069 "groupTitle": "Zoho_Configurations"
37073 "url": "/api/integrations/zoho/configurations/{id}",
37074 "title": "Deletes a Zoho Configuration",
37077 "title": "Example usage:",
37078 "content": "curl https://{domain}/api/integrations/zoho/configurations/{id} -v -u {name}:{password} -X DELETE",
37082 "name": "DeleteZoho_Configurations",
37083 "group": "Zoho_Configurations",
37084 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37085 "version": "0.0.0",
37086 "filename": "server/api/intZohoConfiguration/index.js",
37087 "groupTitle": "Zoho_Configurations"
37091 "url": "/api/integrations/zoho/configurations",
37092 "title": "Gets a list of Zoho Configurations",
37095 "title": "Example usage:",
37096 "content": "curl https://{domain}/api/integrations/zoho/configurations -v -u {name}:{password}",
37100 "name": "GetZoho_Configurations",
37101 "group": "Zoho_Configurations",
37102 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
37103 "version": "0.0.0",
37104 "filename": "server/api/intZohoConfiguration/index.js",
37105 "groupTitle": "Zoho_Configurations"
37109 "url": "/api/integrations/zoho/configurations/{id}",
37110 "title": "Gets a single Zoho Configuration",
37113 "title": "Example usage:",
37114 "content": "curl https://{domain}/api/integrations/zoho/configurations/{id} -v -u {name}:{password}",
37118 "name": "ShowZoho_Configurations",
37119 "group": "Zoho_Configurations",
37120 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37121 "version": "0.0.0",
37122 "filename": "server/api/intZohoConfiguration/index.js",
37123 "groupTitle": "Zoho_Configurations"
37127 "url": "/api/integrations/zoho/configurations/{id}/descriptions",
37128 "title": "Gets configurations descriptions",
37131 "title": "Example usage:",
37132 "content": "curl https://{domain}/api/integrations/zoho/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
37136 "name": "getDescriptions",
37137 "group": "Zoho_Configurations",
37138 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37139 "version": "0.0.0",
37140 "filename": "server/api/intZohoConfiguration/index.js",
37141 "groupTitle": "Zoho_Configurations"
37145 "url": "/api/integrations/zoho/configurations/{id}/fields",
37146 "title": "Gets configurations fields",
37149 "title": "Example usage:",
37150 "content": "curl https://{domain}/api/integrations/zoho/configurations/{id}/fields -v -u {name}:{password} -X GET",
37154 "name": "getFields",
37155 "group": "Zoho_Configurations",
37156 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37157 "version": "0.0.0",
37158 "filename": "server/api/intZohoConfiguration/index.js",
37159 "groupTitle": "Zoho_Configurations"
37163 "url": "/api/integrations/zoho/configurations/{id}/subjects",
37164 "title": "Gets configurations subjects",
37167 "title": "Example usage:",
37168 "content": "curl https://{domain}/api/integrations/zoho/configurations/{id}/subjects -v -u {name}:{password} -X GET",
37172 "name": "getSubjects",
37173 "group": "Zoho_Configurations",
37174 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37175 "version": "0.0.0",
37176 "filename": "server/api/intZohoConfiguration/index.js",
37177 "groupTitle": "Zoho_Configurations"
37181 "url": "/api/integrations/zoho/configurations/{id}",
37182 "title": "Update an existing Zoho Configuration",
37185 "title": "Example usage:",
37186 "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",
37190 "name": "updateZoho_Configurations",
37191 "group": "Zoho_Configurations",
37192 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37193 "version": "0.0.0",
37194 "filename": "server/api/intZohoConfiguration/index.js",
37195 "groupTitle": "Zoho_Configurations"
37199 "url": "/api/integrations/zoho/fields",
37200 "title": "Creates a new Zoho Field",
37203 "title": "Example usage:",
37204 "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",
37208 "name": "CreateZoho_Fields",
37209 "group": "Zoho_Fields",
37219 "\"customVariable\"",
37231 "field": "content",
37247 "\"customVariable\""
37250 "field": "keyType",
37257 "field": "keyContent",
37264 "field": "idField",
37271 "field": "nameField",
37278 "field": "customField",
37285 "field": "variableName",
37291 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37292 "version": "0.0.0",
37293 "filename": "server/api/intZohoField/index.js",
37294 "groupTitle": "Zoho_Fields"
37298 "url": "/api/integrations/zoho/fields/{id}",
37299 "title": "Deletes a Zoho Field",
37302 "title": "Example usage:",
37303 "content": "curl https://{domain}/api/integrations/zoho/fields/{id} -v -u {name}:{password} -X DELETE",
37307 "name": "DeleteZoho_Fields",
37308 "group": "Zoho_Fields",
37309 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37310 "version": "0.0.0",
37311 "filename": "server/api/intZohoField/index.js",
37312 "groupTitle": "Zoho_Fields"
37316 "url": "/api/integrations/zoho/fields",
37317 "title": "Gets a list of Zoho Fields",
37320 "title": "Example usage:",
37321 "content": "curl https://{domain}/api/integrations/zoho/fields -v -u {name}:{password}",
37325 "name": "GetZoho_Fields",
37326 "group": "Zoho_Fields",
37327 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
37328 "version": "0.0.0",
37329 "filename": "server/api/intZohoField/index.js",
37330 "groupTitle": "Zoho_Fields"
37334 "url": "/api/integrations/zoho/fields/{id}",
37335 "title": "Gets a single Zoho Field",
37338 "title": "Example usage:",
37339 "content": "curl https://{domain}/api/integrations/zoho/fields/{id} -v -u {name}:{password}",
37343 "name": "ShowZoho_Fields",
37344 "group": "Zoho_Fields",
37345 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37346 "version": "0.0.0",
37347 "filename": "server/api/intZohoField/index.js",
37348 "groupTitle": "Zoho_Fields"
37352 "url": "/api/integrations/zoho/fields/{id}",
37353 "title": "Update an existing Zoho Field",
37356 "title": "Example usage:",
37357 "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",
37361 "name": "updateZoho_Fields",
37362 "group": "Zoho_Fields",
37363 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37364 "version": "0.0.0",
37365 "filename": "server/api/intZohoField/index.js",
37366 "groupTitle": "Zoho_Fields"
37371 "title": "Creates a new Cdr",
37374 "title": "Example usage:",
37375 "content": "curl https://{domain}/api/cdr -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
37379 "name": "CreateCdrs",
37388 "field": "calldate",
37416 "field": "dcontext",
37423 "field": "channel",
37430 "field": "dstchannel",
37437 "field": "lastapp",
37444 "field": "lastdata",
37451 "field": "duration",
37458 "field": "billsec",
37465 "field": "disposition",
37472 "field": "amaflags",
37479 "field": "accountcode",
37486 "field": "userfield",
37493 "field": "uniqueid",
37500 "field": "linkedid",
37507 "field": "sequence",
37514 "field": "peeraccount",
37534 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37535 "version": "0.0.0",
37536 "filename": "server/api/cdr/index.js",
37537 "groupTitle": "cdr"
37541 "url": "/api/cdr/{id}",
37542 "title": "Deletes a Cdr",
37545 "title": "Example usage:",
37546 "content": "curl https://{domain}/api/cdr/{id} -v -u {name}:{password} -X DELETE",
37550 "name": "DeleteCdrs",
37552 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37553 "version": "0.0.0",
37554 "filename": "server/api/cdr/index.js",
37555 "groupTitle": "cdr"
37559 "url": "/api/cdr/describe",
37560 "title": "Gets table info about Cdrs",
37563 "title": "Example usage:",
37564 "content": "curl https://{domain}/api/cdr/describe -v -u {name}:{password}",
37568 "name": "DescribeCdrs",
37570 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37571 "version": "0.0.0",
37572 "filename": "server/api/cdr/index.js",
37573 "groupTitle": "cdr"
37578 "title": "Gets a list of Cdrs",
37581 "title": "Example usage:",
37582 "content": "curl https://{domain}/api/cdr -v -u {name}:{password}",
37588 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
37589 "version": "0.0.0",
37590 "filename": "server/api/cdr/index.js",
37591 "groupTitle": "cdr"
37595 "url": "/api/cdr/{id}",
37596 "title": "Gets a single Cdr",
37599 "title": "Example usage:",
37600 "content": "curl https://{domain}/api/cdr/{id} -v -u {name}:{password}",
37604 "name": "ShowCdrs",
37606 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37607 "version": "0.0.0",
37608 "filename": "server/api/cdr/index.js",
37609 "groupTitle": "cdr"
37613 "url": "/api/cdr/{id}",
37614 "title": "Update an existing Cdr",
37617 "title": "Example usage:",
37618 "content": "curl https://{domain}/api/cdr/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
37622 "name": "updateCdrs",
37624 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37625 "version": "0.0.0",
37626 "filename": "server/api/cdr/index.js",
37627 "groupTitle": "cdr"
37631 "url": "/api/voiceQueuesLog",
37632 "title": "Creates a new VoiceQueuesLog",
37635 "title": "Example usage:",
37636 "content": "curl https://{domain}/api/voiceQueuesLog -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
37640 "name": "CreateVoiceQueuesLogs",
37641 "group": "voiceQueuesLog",
37663 "field": "queuename",
37732 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37733 "version": "0.0.0",
37734 "filename": "server/api/voiceQueuesLog/index.js",
37735 "groupTitle": "voiceQueuesLog"
37739 "url": "/api/voiceQueuesLog/{id}",
37740 "title": "Deletes a VoiceQueuesLog",
37743 "title": "Example usage:",
37744 "content": "curl https://{domain}/api/voiceQueuesLog/{id} -v -u {name}:{password} -X DELETE",
37748 "name": "DeleteVoiceQueuesLogs",
37749 "group": "voiceQueuesLog",
37750 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37751 "version": "0.0.0",
37752 "filename": "server/api/voiceQueuesLog/index.js",
37753 "groupTitle": "voiceQueuesLog"
37757 "url": "/api/voiceQueuesLog",
37758 "title": "Gets a list of VoiceQueuesLogs",
37761 "title": "Example usage:",
37762 "content": "curl https://{domain}/api/voiceQueuesLog -v -u {name}:{password}",
37766 "name": "GetVoiceQueuesLogs",
37767 "group": "voiceQueuesLog",
37768 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
37769 "version": "0.0.0",
37770 "filename": "server/api/voiceQueuesLog/index.js",
37771 "groupTitle": "voiceQueuesLog"
37775 "url": "/api/voiceQueuesLog/{id}",
37776 "title": "Gets a single VoiceQueuesLog",
37779 "title": "Example usage:",
37780 "content": "curl https://{domain}/api/voiceQueuesLog/{id} -v -u {name}:{password}",
37784 "name": "ShowVoiceQueuesLogs",
37785 "group": "voiceQueuesLog",
37786 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37787 "version": "0.0.0",
37788 "filename": "server/api/voiceQueuesLog/index.js",
37789 "groupTitle": "voiceQueuesLog"
37793 "url": "/api/voiceQueuesLog/{id}",
37794 "title": "Update an existing VoiceQueuesLog",
37797 "title": "Example usage:",
37798 "content": "curl https://{domain}/api/voiceQueuesLog/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
37802 "name": "updateVoiceQueuesLogs",
37803 "group": "voiceQueuesLog",
37804 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37805 "version": "0.0.0",
37806 "filename": "server/api/voiceQueuesLog/index.js",
37807 "groupTitle": "voiceQueuesLog"