apidoc/api_data.js

   1 define({ "api": [
   2   {
   3     "type": "post",
   4     "url": "/api/cm/hopper/timezone",
   5     "title": "Gets a single TZ data",
   6     "examples": [
   7       {
   8         "title": "Example usage:",
   9         "content": "curl https://{domain}/api/cm/hopper/timezone -d '{\"timezone\": [1]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X GET",
  10         "type": "json"
  11       }
  12     ],
  13     "name": "getTimezone",
  14     "version": "0.0.0",
  15     "filename": "server/api/cmHopper/index.js",
  16     "group": "/var/opt/motion2/server/api/cmHopper/index.js",
  17     "groupTitle": "/var/opt/motion2/server/api/cmHopper/index.js"
  18   },
  19   {
  20     "type": "delete",
  21     "url": "/api/square/projects/{id}/users",
  22     "title": "Removes user permissions from a Project",
  23     "examples": [
  24       {
  25         "title": "Example usage:",
  26         "content": "curl https://{domain}/api/square/projects/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
  27         "type": "json"
  28       }
  29     ],
  30     "version": "0.0.0",
  31     "filename": "server/api/squareProject/index.js",
  32     "group": "/var/opt/motion2/server/api/squareProject/index.js",
  33     "groupTitle": "/var/opt/motion2/server/api/squareProject/index.js",
  34     "name": "DeleteApiSquareProjectsIdUsers"
  35   },
  36   {
  37     "type": "get",
  38     "url": "/api/square/projects/{id}/users",
  39     "title": "Gets users permissions from Project",
  40     "examples": [
  41       {
  42         "title": "Example usage:",
  43         "content": "curl https://{domain}/api/square/projects/{id}/users -v -u {name}:{password} -X GET",
  44         "type": "json"
  45       }
  46     ],
  47     "version": "0.0.0",
  48     "filename": "server/api/squareProject/index.js",
  49     "group": "/var/opt/motion2/server/api/squareProject/index.js",
  50     "groupTitle": "/var/opt/motion2/server/api/squareProject/index.js",
  51     "name": "GetApiSquareProjectsIdUsers"
  52   },
  53   {
  54     "type": "post",
  55     "url": "/api/square/projects/{id}/users",
  56     "title": "Adds user permissions to a Project",
  57     "examples": [
  58       {
  59         "title": "Example usage:",
  60         "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",
  61         "type": "json"
  62       }
  63     ],
  64     "version": "0.0.0",
  65     "filename": "server/api/squareProject/index.js",
  66     "group": "/var/opt/motion2/server/api/squareProject/index.js",
  67     "groupTitle": "/var/opt/motion2/server/api/squareProject/index.js",
  68     "name": "PostApiSquareProjectsIdUsers"
  69   },
  70   {
  71     "type": "delete",
  72     "url": "/api/actions/{id}",
  73     "title": "Deletes a Action",
  74     "examples": [
  75       {
  76         "title": "Example usage:",
  77         "content": "curl https://{domain}/api/actions/{id} -v -u {name}:{password} -X DELETE",
  78         "type": "json"
  79       }
  80     ],
  81     "name": "DeleteActions",
  82     "group": "Actions",
  83     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
  84     "version": "0.0.0",
  85     "filename": "server/api/action/index.js",
  86     "groupTitle": "Actions"
  87   },
  88   {
  89     "type": "put",
  90     "url": "/api/actions/{id}",
  91     "title": "Update an existing Action",
  92     "examples": [
  93       {
  94         "title": "Example usage:",
  95         "content": "curl https://{domain}/api/actions/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
  96         "type": "json"
  97       }
  98     ],
  99     "name": "updateActions",
 100     "group": "Actions",
 101     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 102     "version": "0.0.0",
 103     "filename": "server/api/action/index.js",
 104     "groupTitle": "Actions"
 105   },
 106   {
 107     "type": "post",
 108     "url": "/api/analytics/custom_reports",
 109     "title": "Creates a new Analytic Custom Report",
 110     "examples": [
 111       {
 112         "title": "Example usage:",
 113         "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",
 114         "type": "json"
 115       }
 116     ],
 117     "name": "CreateAnalytic_Custom_Reports",
 118     "group": "Analytic_Custom_Reports",
 119     "parameter": {
 120       "fields": {
 121         "Body": [
 122           {
 123             "group": "Body",
 124             "type": "String",
 125             "optional": false,
 126             "field": "name",
 127             "description": ""
 128           },
 129           {
 130             "group": "Body",
 131             "type": "String",
 132             "optional": true,
 133             "field": "description",
 134             "description": ""
 135           },
 136           {
 137             "group": "Body",
 138             "type": "String",
 139             "optional": true,
 140             "field": "parent",
 141             "description": ""
 142           },
 143           {
 144             "group": "Body",
 145             "type": "String",
 146             "optional": true,
 147             "field": "table",
 148             "description": ""
 149           },
 150           {
 151             "group": "Body",
 152             "type": "Text",
 153             "optional": true,
 154             "field": "conditions",
 155             "description": ""
 156           },
 157           {
 158             "group": "Body",
 159             "type": "Text",
 160             "optional": true,
 161             "field": "joins",
 162             "description": ""
 163           }
 164         ]
 165       }
 166     },
 167     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 168     "version": "0.0.0",
 169     "filename": "server/api/analyticCustomReport/index.js",
 170     "groupTitle": "Analytic_Custom_Reports"
 171   },
 172   {
 173     "type": "delete",
 174     "url": "/api/analytics/custom_reports/{id}",
 175     "title": "Deletes a Analytic Custom Report",
 176     "examples": [
 177       {
 178         "title": "Example usage:",
 179         "content": "curl https://{domain}/api/analytics/custom_reports/{id} -v -u {name}:{password} -X DELETE",
 180         "type": "json"
 181       }
 182     ],
 183     "name": "DeleteAnalytic_Custom_Reports",
 184     "group": "Analytic_Custom_Reports",
 185     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 186     "version": "0.0.0",
 187     "filename": "server/api/analyticCustomReport/index.js",
 188     "groupTitle": "Analytic_Custom_Reports"
 189   },
 190   {
 191     "type": "get",
 192     "url": "/api/analytics/custom_reports",
 193     "title": "Gets a list of Analytic Custom Reports",
 194     "examples": [
 195       {
 196         "title": "Example usage:",
 197         "content": "curl https://{domain}/api/analytics/custom_reports -v -u {name}:{password}",
 198         "type": "json"
 199       }
 200     ],
 201     "name": "GetAnalytic_Custom_Reports",
 202     "group": "Analytic_Custom_Reports",
 203     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
 204     "version": "0.0.0",
 205     "filename": "server/api/analyticCustomReport/index.js",
 206     "groupTitle": "Analytic_Custom_Reports"
 207   },
 208   {
 209     "type": "get",
 210     "url": "/api/analytics/custom_reports/{id}",
 211     "title": "Gets a single Analytic Custom Report",
 212     "examples": [
 213       {
 214         "title": "Example usage:",
 215         "content": "curl https://{domain}/api/analytics/custom_reports/{id} -v -u {name}:{password}",
 216         "type": "json"
 217       }
 218     ],
 219     "name": "ShowAnalytic_Custom_Reports",
 220     "group": "Analytic_Custom_Reports",
 221     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 222     "version": "0.0.0",
 223     "filename": "server/api/analyticCustomReport/index.js",
 224     "groupTitle": "Analytic_Custom_Reports"
 225   },
 226   {
 227     "type": "get",
 228     "url": "/api/analytics/custom_reports/{id}/preview",
 229     "title": "Report Preview",
 230     "examples": [
 231       {
 232         "title": "Example usage:",
 233         "content": "curl https://{domain}/api/analytics/custom_reports/{id}/preview -v -u {name}:{password} -X GET",
 234         "type": "json"
 235       }
 236     ],
 237     "name": "preview",
 238     "group": "Analytic_Custom_Reports",
 239     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 240     "version": "0.0.0",
 241     "filename": "server/api/analyticCustomReport/index.js",
 242     "groupTitle": "Analytic_Custom_Reports"
 243   },
 244   {
 245     "type": "get",
 246     "url": "/api/analytics/custom_reports/{id}/query",
 247     "title": "Report Query SQL",
 248     "examples": [
 249       {
 250         "title": "Example usage:",
 251         "content": "curl https://{domain}/api/analytics/custom_reports/{id}/query -v -u {name}:{password} -X GET",
 252         "type": "json"
 253       }
 254     ],
 255     "name": "query",
 256     "group": "Analytic_Custom_Reports",
 257     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 258     "version": "0.0.0",
 259     "filename": "server/api/analyticCustomReport/index.js",
 260     "groupTitle": "Analytic_Custom_Reports"
 261   },
 262   {
 263     "type": "get",
 264     "url": "/api/analytics/custom_reports/{id}/run",
 265     "title": "Report Run",
 266     "examples": [
 267       {
 268         "title": "Example usage:",
 269         "content": "curl https://{domain}/api/analytics/custom_reports/{id}/run -v -u {name}:{password} -X GET",
 270         "type": "json"
 271       }
 272     ],
 273     "name": "run",
 274     "group": "Analytic_Custom_Reports",
 275     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 276     "version": "0.0.0",
 277     "filename": "server/api/analyticCustomReport/index.js",
 278     "groupTitle": "Analytic_Custom_Reports"
 279   },
 280   {
 281     "type": "put",
 282     "url": "/api/analytics/custom_reports/{id}",
 283     "title": "Update an existing Analytic Custom Report",
 284     "examples": [
 285       {
 286         "title": "Example usage:",
 287         "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",
 288         "type": "json"
 289       }
 290     ],
 291     "name": "updateAnalytic_Custom_Reports",
 292     "group": "Analytic_Custom_Reports",
 293     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 294     "version": "0.0.0",
 295     "filename": "server/api/analyticCustomReport/index.js",
 296     "groupTitle": "Analytic_Custom_Reports"
 297   },
 298   {
 299     "type": "post",
 300     "url": "/api/analytics/default_reports",
 301     "title": "Creates a new Analytic Default Report",
 302     "examples": [
 303       {
 304         "title": "Example usage:",
 305         "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",
 306         "type": "json"
 307       }
 308     ],
 309     "name": "CreateAnalytic_Default_Reports",
 310     "group": "Analytic_Default_Reports",
 311     "parameter": {
 312       "fields": {
 313         "Body": [
 314           {
 315             "group": "Body",
 316             "type": "String",
 317             "optional": false,
 318             "field": "name",
 319             "description": ""
 320           },
 321           {
 322             "group": "Body",
 323             "type": "String",
 324             "optional": true,
 325             "field": "description",
 326             "description": ""
 327           },
 328           {
 329             "group": "Body",
 330             "type": "String",
 331             "optional": true,
 332             "field": "parent",
 333             "description": ""
 334           },
 335           {
 336             "group": "Body",
 337             "type": "String",
 338             "optional": true,
 339             "field": "table",
 340             "description": ""
 341           },
 342           {
 343             "group": "Body",
 344             "type": "Text",
 345             "optional": true,
 346             "field": "conditions",
 347             "description": ""
 348           },
 349           {
 350             "group": "Body",
 351             "type": "Text",
 352             "optional": true,
 353             "field": "joins",
 354             "description": ""
 355           }
 356         ]
 357       }
 358     },
 359     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 360     "version": "0.0.0",
 361     "filename": "server/api/analyticDefaultReport/index.js",
 362     "groupTitle": "Analytic_Default_Reports"
 363   },
 364   {
 365     "type": "delete",
 366     "url": "/api/analytics/default_reports/{id}",
 367     "title": "Deletes a Analytic Default Report",
 368     "examples": [
 369       {
 370         "title": "Example usage:",
 371         "content": "curl https://{domain}/api/analytics/default_reports/{id} -v -u {name}:{password} -X DELETE",
 372         "type": "json"
 373       }
 374     ],
 375     "name": "DeleteAnalytic_Default_Reports",
 376     "group": "Analytic_Default_Reports",
 377     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 378     "version": "0.0.0",
 379     "filename": "server/api/analyticDefaultReport/index.js",
 380     "groupTitle": "Analytic_Default_Reports"
 381   },
 382   {
 383     "type": "get",
 384     "url": "/api/analytics/default_reports",
 385     "title": "Gets a list of Analytic Default Reports",
 386     "examples": [
 387       {
 388         "title": "Example usage:",
 389         "content": "curl https://{domain}/api/analytics/default_reports -v -u {name}:{password}",
 390         "type": "json"
 391       }
 392     ],
 393     "name": "GetAnalytic_Default_Reports",
 394     "group": "Analytic_Default_Reports",
 395     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
 396     "version": "0.0.0",
 397     "filename": "server/api/analyticDefaultReport/index.js",
 398     "groupTitle": "Analytic_Default_Reports"
 399   },
 400   {
 401     "type": "get",
 402     "url": "/api/analytics/default_reports/{id}",
 403     "title": "Gets a single Analytic Default Report",
 404     "examples": [
 405       {
 406         "title": "Example usage:",
 407         "content": "curl https://{domain}/api/analytics/default_reports/{id} -v -u {name}:{password}",
 408         "type": "json"
 409       }
 410     ],
 411     "name": "ShowAnalytic_Default_Reports",
 412     "group": "Analytic_Default_Reports",
 413     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 414     "version": "0.0.0",
 415     "filename": "server/api/analyticDefaultReport/index.js",
 416     "groupTitle": "Analytic_Default_Reports"
 417   },
 418   {
 419     "type": "get",
 420     "url": "/api/analytics/default_reports/{id}/preview",
 421     "title": "Report Preview",
 422     "examples": [
 423       {
 424         "title": "Example usage:",
 425         "content": "curl https://{domain}/api/analytics/default_reports/{id}/preview -v -u {name}:{password} -X GET",
 426         "type": "json"
 427       }
 428     ],
 429     "name": "preview",
 430     "group": "Analytic_Default_Reports",
 431     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 432     "version": "0.0.0",
 433     "filename": "server/api/analyticDefaultReport/index.js",
 434     "groupTitle": "Analytic_Default_Reports"
 435   },
 436   {
 437     "type": "get",
 438     "url": "/api/analytics/default_reports/{id}/query",
 439     "title": "Report Query SQL",
 440     "examples": [
 441       {
 442         "title": "Example usage:",
 443         "content": "curl https://{domain}/api/analytics/default_reports/{id}/query -v -u {name}:{password} -X GET",
 444         "type": "json"
 445       }
 446     ],
 447     "name": "query",
 448     "group": "Analytic_Default_Reports",
 449     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 450     "version": "0.0.0",
 451     "filename": "server/api/analyticDefaultReport/index.js",
 452     "groupTitle": "Analytic_Default_Reports"
 453   },
 454   {
 455     "type": "get",
 456     "url": "/api/analytics/default_reports/{id}/run",
 457     "title": "Report Run",
 458     "examples": [
 459       {
 460         "title": "Example usage:",
 461         "content": "curl https://{domain}/api/analytics/default_reports/{id}/run -v -u {name}:{password} -X GET",
 462         "type": "json"
 463       }
 464     ],
 465     "name": "run",
 466     "group": "Analytic_Default_Reports",
 467     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 468     "version": "0.0.0",
 469     "filename": "server/api/analyticDefaultReport/index.js",
 470     "groupTitle": "Analytic_Default_Reports"
 471   },
 472   {
 473     "type": "put",
 474     "url": "/api/analytics/default_reports/{id}",
 475     "title": "Update an existing Analytic Default Report",
 476     "examples": [
 477       {
 478         "title": "Example usage:",
 479         "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",
 480         "type": "json"
 481       }
 482     ],
 483     "name": "updateAnalytic_Default_Reports",
 484     "group": "Analytic_Default_Reports",
 485     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 486     "version": "0.0.0",
 487     "filename": "server/api/analyticDefaultReport/index.js",
 488     "groupTitle": "Analytic_Default_Reports"
 489   },
 490   {
 491     "type": "post",
 492     "url": "/api/analytics/extracted_reports",
 493     "title": "Creates a new Analytic Extracted Report",
 494     "examples": [
 495       {
 496         "title": "Example usage:",
 497         "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",
 498         "type": "json"
 499       }
 500     ],
 501     "name": "CreateAnalytic_Extacted_Reports",
 502     "group": "Analytic_Extracted_Reports",
 503     "parameter": {
 504       "fields": {
 505         "Body": [
 506           {
 507             "group": "Body",
 508             "type": "String",
 509             "optional": false,
 510             "field": "name",
 511             "description": ""
 512           },
 513           {
 514             "group": "Body",
 515             "type": "String",
 516             "optional": false,
 517             "field": "basename",
 518             "description": ""
 519           },
 520           {
 521             "group": "Body",
 522             "type": "String",
 523             "allowedValues": [
 524               "\"csv\"",
 525               "\"pdf\"",
 526               "\"xlsx\""
 527             ],
 528             "optional": false,
 529             "field": "output",
 530             "description": ""
 531           },
 532           {
 533             "group": "Body",
 534             "type": "String",
 535             "optional": false,
 536             "field": "savename",
 537             "description": ""
 538           },
 539           {
 540             "group": "Body",
 541             "type": "String",
 542             "optional": true,
 543             "field": "startDate",
 544             "description": ""
 545           },
 546           {
 547             "group": "Body",
 548             "type": "String",
 549             "optional": true,
 550             "field": "endDate",
 551             "description": ""
 552           },
 553           {
 554             "group": "Body",
 555             "type": "String",
 556             "optional": true,
 557             "field": "status",
 558             "description": ""
 559           },
 560           {
 561             "group": "Body",
 562             "type": "String",
 563             "allowedValues": [
 564               "\"manual\"",
 565               "\"scheduled\""
 566             ],
 567             "optional": false,
 568             "field": "type",
 569             "description": ""
 570           },
 571           {
 572             "group": "Body",
 573             "type": "Integer",
 574             "optional": true,
 575             "field": "reportId",
 576             "description": ""
 577           },
 578           {
 579             "group": "Body",
 580             "type": "String",
 581             "optional": true,
 582             "field": "reportType",
 583             "description": ""
 584           }
 585         ]
 586       }
 587     },
 588     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 589     "version": "0.0.0",
 590     "filename": "server/api/analyticExtractedReport/index.js",
 591     "groupTitle": "Analytic_Extracted_Reports"
 592   },
 593   {
 594     "type": "delete",
 595     "url": "/api/analytics/extracted_reports/{id}",
 596     "title": "Deletes a Analytic Extracted Report",
 597     "examples": [
 598       {
 599         "title": "Example usage:",
 600         "content": "curl https://{domain}/api/analytics/extracted_reports/{id} -v -u {name}:{password} -X DELETE",
 601         "type": "json"
 602       }
 603     ],
 604     "name": "DeleteAnalytic_Extacted_Reports",
 605     "group": "Analytic_Extracted_Reports",
 606     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 607     "version": "0.0.0",
 608     "filename": "server/api/analyticExtractedReport/index.js",
 609     "groupTitle": "Analytic_Extracted_Reports"
 610   },
 611   {
 612     "type": "get",
 613     "url": "/api/analytics/extracted_reports",
 614     "title": "Gets a list of Analytic Extacted Reports",
 615     "examples": [
 616       {
 617         "title": "Example usage:",
 618         "content": "curl https://{domain}/api/analytics/extracted_reports -v -u {name}:{password}",
 619         "type": "json"
 620       }
 621     ],
 622     "name": "GetAnalytic_Extacted_Reports",
 623     "group": "Analytic_Extracted_Reports",
 624     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
 625     "version": "0.0.0",
 626     "filename": "server/api/analyticExtractedReport/index.js",
 627     "groupTitle": "Analytic_Extracted_Reports"
 628   },
 629   {
 630     "type": "get",
 631     "url": "/api/analytics/extracted_reports/{id}",
 632     "title": "Gets a single Analytic Extracted Report",
 633     "examples": [
 634       {
 635         "title": "Example usage:",
 636         "content": "curl https://{domain}/api/analytics/extracted_reports/{id} -v -u {name}:{password}",
 637         "type": "json"
 638       }
 639     ],
 640     "name": "ShowAnalytic_Extacted_Reports",
 641     "group": "Analytic_Extracted_Reports",
 642     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 643     "version": "0.0.0",
 644     "filename": "server/api/analyticExtractedReport/index.js",
 645     "groupTitle": "Analytic_Extracted_Reports"
 646   },
 647   {
 648     "type": "get",
 649     "url": "/api/analytics/extracted_reports/{id}/download",
 650     "title": "Download Extracted Report",
 651     "examples": [
 652       {
 653         "title": "Example usage:",
 654         "content": "curl https://{domain}/api/analytics/extracted_reports/{id}/download -v -u {name}:{password} -X GET",
 655         "type": "json"
 656       }
 657     ],
 658     "name": "download",
 659     "group": "Analytic_Extracted_Reports",
 660     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 661     "version": "0.0.0",
 662     "filename": "server/api/analyticExtractedReport/index.js",
 663     "groupTitle": "Analytic_Extracted_Reports"
 664   },
 665   {
 666     "type": "put",
 667     "url": "/api/analytics/extracted_reports/{id}",
 668     "title": "Update an existing Analytic Extracted Report",
 669     "examples": [
 670       {
 671         "title": "Example usage:",
 672         "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",
 673         "type": "json"
 674       }
 675     ],
 676     "name": "updateAnalytic_Extacted_Reports",
 677     "group": "Analytic_Extracted_Reports",
 678     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 679     "version": "0.0.0",
 680     "filename": "server/api/analyticExtractedReport/index.js",
 681     "groupTitle": "Analytic_Extracted_Reports"
 682   },
 683   {
 684     "type": "post",
 685     "url": "/api/analytics/field_reports/create_many",
 686     "title": "Creates many Analytic Field Reports",
 687     "examples": [
 688       {
 689         "title": "Example usage:",
 690         "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",
 691         "type": "json"
 692       }
 693     ],
 694     "name": "BulkCreateAnalytic_Field_Reports",
 695     "group": "Analytic_Field_Reports",
 696     "parameter": {
 697       "fields": {
 698         "Body": [
 699           {
 700             "group": "Body",
 701             "type": "Text",
 702             "optional": true,
 703             "field": "field",
 704             "description": ""
 705           },
 706           {
 707             "group": "Body",
 708             "type": "String",
 709             "optional": true,
 710             "field": "alias",
 711             "description": ""
 712           },
 713           {
 714             "group": "Body",
 715             "type": "String",
 716             "optional": true,
 717             "field": "function",
 718             "description": ""
 719           },
 720           {
 721             "group": "Body",
 722             "type": "String",
 723             "optional": true,
 724             "field": "format",
 725             "description": ""
 726           },
 727           {
 728             "group": "Body",
 729             "type": "Boolean",
 730             "optional": true,
 731             "field": "groupBy",
 732             "description": ""
 733           },
 734           {
 735             "group": "Body",
 736             "type": "String",
 737             "optional": true,
 738             "field": "orderBy",
 739             "description": ""
 740           },
 741           {
 742             "group": "Body",
 743             "type": "Boolean",
 744             "optional": true,
 745             "field": "custom",
 746             "description": ""
 747           }
 748         ]
 749       }
 750     },
 751     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 752     "version": "0.0.0",
 753     "filename": "server/api/analyticFieldReport/index.js",
 754     "groupTitle": "Analytic_Field_Reports"
 755   },
 756   {
 757     "type": "delete",
 758     "url": "/api/analytics/field_reports/destroy_many?ids={ids}",
 759     "title": "Deletes many Analytic Field Reports",
 760     "examples": [
 761       {
 762         "title": "Example usage:",
 763         "content": "curl https://{domain}/api/analytics/field_reports/destroy_many?ids=1&ids=2&ids=3 -v -u {name}:{password} -X DELETE",
 764         "type": "json"
 765       }
 766     ],
 767     "name": "BulkDeleteAnalytic_Field_Reports",
 768     "group": "Analytic_Field_Reports",
 769     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 770     "version": "0.0.0",
 771     "filename": "server/api/analyticFieldReport/index.js",
 772     "groupTitle": "Analytic_Field_Reports"
 773   },
 774   {
 775     "type": "post",
 776     "url": "/api/analytics/field_reports",
 777     "title": "Creates a new Analytic Field Report",
 778     "examples": [
 779       {
 780         "title": "Example usage:",
 781         "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",
 782         "type": "json"
 783       }
 784     ],
 785     "name": "CreateAnalytic_Field_Reports",
 786     "group": "Analytic_Field_Reports",
 787     "parameter": {
 788       "fields": {
 789         "Body": [
 790           {
 791             "group": "Body",
 792             "type": "Text",
 793             "optional": true,
 794             "field": "field",
 795             "description": ""
 796           },
 797           {
 798             "group": "Body",
 799             "type": "String",
 800             "optional": true,
 801             "field": "alias",
 802             "description": ""
 803           },
 804           {
 805             "group": "Body",
 806             "type": "String",
 807             "optional": true,
 808             "field": "function",
 809             "description": ""
 810           },
 811           {
 812             "group": "Body",
 813             "type": "String",
 814             "optional": true,
 815             "field": "format",
 816             "description": ""
 817           },
 818           {
 819             "group": "Body",
 820             "type": "Boolean",
 821             "optional": true,
 822             "field": "groupBy",
 823             "description": ""
 824           },
 825           {
 826             "group": "Body",
 827             "type": "String",
 828             "optional": true,
 829             "field": "orderBy",
 830             "description": ""
 831           },
 832           {
 833             "group": "Body",
 834             "type": "Boolean",
 835             "optional": true,
 836             "field": "custom",
 837             "description": ""
 838           }
 839         ]
 840       }
 841     },
 842     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 843     "version": "0.0.0",
 844     "filename": "server/api/analyticFieldReport/index.js",
 845     "groupTitle": "Analytic_Field_Reports"
 846   },
 847   {
 848     "type": "delete",
 849     "url": "/api/analytics/field_reports/{id}",
 850     "title": "Deletes a Analytic Field Report",
 851     "examples": [
 852       {
 853         "title": "Example usage:",
 854         "content": "curl https://{domain}/api/analytics/field_reports/{id} -v -u {name}:{password} -X DELETE",
 855         "type": "json"
 856       }
 857     ],
 858     "name": "DeleteAnalytic_Field_Reports",
 859     "group": "Analytic_Field_Reports",
 860     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 861     "version": "0.0.0",
 862     "filename": "server/api/analyticFieldReport/index.js",
 863     "groupTitle": "Analytic_Field_Reports"
 864   },
 865   {
 866     "type": "get",
 867     "url": "/api/analytics/field_reports",
 868     "title": "Gets a list of Analytic Field Reports",
 869     "examples": [
 870       {
 871         "title": "Example usage:",
 872         "content": "curl https://{domain}/api/analytics/field_reports -v -u {name}:{password}",
 873         "type": "json"
 874       }
 875     ],
 876     "name": "GetAnalytic_Field_Reports",
 877     "group": "Analytic_Field_Reports",
 878     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
 879     "version": "0.0.0",
 880     "filename": "server/api/analyticFieldReport/index.js",
 881     "groupTitle": "Analytic_Field_Reports"
 882   },
 883   {
 884     "type": "get",
 885     "url": "/api/analytics/field_reports/{id}",
 886     "title": "Gets a single Analytic Field Report",
 887     "examples": [
 888       {
 889         "title": "Example usage:",
 890         "content": "curl https://{domain}/api/analytics/field_reports/{id} -v -u {name}:{password}",
 891         "type": "json"
 892       }
 893     ],
 894     "name": "ShowAnalytic_Field_Reports",
 895     "group": "Analytic_Field_Reports",
 896     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 897     "version": "0.0.0",
 898     "filename": "server/api/analyticFieldReport/index.js",
 899     "groupTitle": "Analytic_Field_Reports"
 900   },
 901   {
 902     "type": "post",
 903     "url": "/api/analytics/field_reports/{id}/create_many",
 904     "title": "Rewrite fields set",
 905     "examples": [
 906       {
 907         "title": "Example usage:",
 908         "content": "curl https://{domain}/api/analytics/field_reports/{id}/create_many -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
 909         "type": "json"
 910       }
 911     ],
 912     "name": "addFields",
 913     "group": "Analytic_Field_Reports",
 914     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 915     "version": "0.0.0",
 916     "filename": "server/api/analyticFieldReport/index.js",
 917     "groupTitle": "Analytic_Field_Reports"
 918   },
 919   {
 920     "type": "put",
 921     "url": "/api/analytics/field_reports/{id}",
 922     "title": "Update an existing Analytic Field Report",
 923     "examples": [
 924       {
 925         "title": "Example usage:",
 926         "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",
 927         "type": "json"
 928       }
 929     ],
 930     "name": "updateAnalytic_Field_Reports",
 931     "group": "Analytic_Field_Reports",
 932     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 933     "version": "0.0.0",
 934     "filename": "server/api/analyticFieldReport/index.js",
 935     "groupTitle": "Analytic_Field_Reports"
 936   },
 937   {
 938     "type": "post",
 939     "url": "/api/analytics/metrics",
 940     "title": "Creates a new Analytic Metrics",
 941     "examples": [
 942       {
 943         "title": "Example usage:",
 944         "content": "curl https://{domain}/api/analytics/metrics -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
 945         "type": "json"
 946       }
 947     ],
 948     "name": "CreateAnalytic_Metric",
 949     "group": "Analytic_Metrics",
 950     "parameter": {
 951       "fields": {
 952         "Body": [
 953           {
 954             "group": "Body",
 955             "type": "String",
 956             "optional": false,
 957             "field": "name",
 958             "description": ""
 959           },
 960           {
 961             "group": "Body",
 962             "type": "String",
 963             "optional": true,
 964             "field": "table",
 965             "description": ""
 966           },
 967           {
 968             "group": "Body",
 969             "type": "Text",
 970             "optional": true,
 971             "field": "metric",
 972             "description": ""
 973           },
 974           {
 975             "group": "Body",
 976             "type": "String",
 977             "optional": true,
 978             "field": "description",
 979             "description": ""
 980           }
 981         ]
 982       }
 983     },
 984     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 985     "version": "0.0.0",
 986     "filename": "server/api/analyticMetric/index.js",
 987     "groupTitle": "Analytic_Metrics"
 988   },
 989   {
 990     "type": "delete",
 991     "url": "/api/analytics/metrics/{id}",
 992     "title": "Deletes a Analytic Metrics",
 993     "examples": [
 994       {
 995         "title": "Example usage:",
 996         "content": "curl https://{domain}/api/analytics/metrics/{id} -v -u {name}:{password} -X DELETE",
 997         "type": "json"
 998       }
 999     ],
1000     "name": "DeleteAnalytic_Metric",
1001     "group": "Analytic_Metrics",
1002     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1003     "version": "0.0.0",
1004     "filename": "server/api/analyticMetric/index.js",
1005     "groupTitle": "Analytic_Metrics"
1006   },
1007   {
1008     "type": "get",
1009     "url": "/api/analytics/metrics",
1010     "title": "Gets a list of Analytic Metric",
1011     "examples": [
1012       {
1013         "title": "Example usage:",
1014         "content": "curl https://{domain}/api/analytics/metrics -v -u {name}:{password}",
1015         "type": "json"
1016       }
1017     ],
1018     "name": "GetAnalytic_Metric",
1019     "group": "Analytic_Metrics",
1020     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
1021     "version": "0.0.0",
1022     "filename": "server/api/analyticMetric/index.js",
1023     "groupTitle": "Analytic_Metrics"
1024   },
1025   {
1026     "type": "get",
1027     "url": "/api/analytics/metrics/{id}",
1028     "title": "Gets a single Analytic Metrics",
1029     "examples": [
1030       {
1031         "title": "Example usage:",
1032         "content": "curl https://{domain}/api/analytics/metrics/{id} -v -u {name}:{password}",
1033         "type": "json"
1034       }
1035     ],
1036     "name": "ShowAnalytic_Metric",
1037     "group": "Analytic_Metrics",
1038     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <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     "version": "0.0.0",
1040     "filename": "server/api/analyticMetric/index.js",
1041     "groupTitle": "Analytic_Metrics"
1042   },
1043   {
1044     "type": "put",
1045     "url": "/api/analytics/metrics/{id}",
1046     "title": "Update an existing Analytic Metrics",
1047     "examples": [
1048       {
1049         "title": "Example usage:",
1050         "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",
1051         "type": "json"
1052       }
1053     ],
1054     "name": "updateAnalytic_Metric",
1055     "group": "Analytic_Metrics",
1056     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1057     "version": "0.0.0",
1058     "filename": "server/api/analyticMetric/index.js",
1059     "groupTitle": "Analytic_Metrics"
1060   },
1061   {
1062     "type": "post",
1063     "url": "/api/analytics/tree_reports",
1064     "title": "Creates a new Analytic Tree Report",
1065     "examples": [
1066       {
1067         "title": "Example usage:",
1068         "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",
1069         "type": "json"
1070       }
1071     ],
1072     "name": "CreateAnalytic_Tree_Reports",
1073     "group": "Analytic_Tree_Reports",
1074     "parameter": {
1075       "fields": {
1076         "Body": [
1077           {
1078             "group": "Body",
1079             "type": "Text",
1080             "optional": false,
1081             "field": "tree",
1082             "description": ""
1083           }
1084         ]
1085       }
1086     },
1087     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1088     "version": "0.0.0",
1089     "filename": "server/api/analyticTreeReport/index.js",
1090     "groupTitle": "Analytic_Tree_Reports"
1091   },
1092   {
1093     "type": "delete",
1094     "url": "/api/analytics/tree_reports/{id}",
1095     "title": "Deletes a Analytic Tree Report",
1096     "examples": [
1097       {
1098         "title": "Example usage:",
1099         "content": "curl https://{domain}/api/analytics/tree_reports/{id} -v -u {name}:{password} -X DELETE",
1100         "type": "json"
1101       }
1102     ],
1103     "name": "DeleteAnalytic_Tree_Reports",
1104     "group": "Analytic_Tree_Reports",
1105     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1106     "version": "0.0.0",
1107     "filename": "server/api/analyticTreeReport/index.js",
1108     "groupTitle": "Analytic_Tree_Reports"
1109   },
1110   {
1111     "type": "get",
1112     "url": "/api/analytics/tree_reports",
1113     "title": "Gets a list of Analytic Tree Reports",
1114     "examples": [
1115       {
1116         "title": "Example usage:",
1117         "content": "curl https://{domain}/api/analytics/tree_reports -v -u {name}:{password}",
1118         "type": "json"
1119       }
1120     ],
1121     "name": "GetAnalytic_Tree_Reports",
1122     "group": "Analytic_Tree_Reports",
1123     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
1124     "version": "0.0.0",
1125     "filename": "server/api/analyticTreeReport/index.js",
1126     "groupTitle": "Analytic_Tree_Reports"
1127   },
1128   {
1129     "type": "get",
1130     "url": "/api/analytics/tree_reports/{id}",
1131     "title": "Gets a single Analytic Tree Report",
1132     "examples": [
1133       {
1134         "title": "Example usage:",
1135         "content": "curl https://{domain}/api/analytics/tree_reports/{id} -v -u {name}:{password}",
1136         "type": "json"
1137       }
1138     ],
1139     "name": "ShowAnalytic_Tree_Reports",
1140     "group": "Analytic_Tree_Reports",
1141     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1142     "version": "0.0.0",
1143     "filename": "server/api/analyticTreeReport/index.js",
1144     "groupTitle": "Analytic_Tree_Reports"
1145   },
1146   {
1147     "type": "put",
1148     "url": "/api/analytics/tree_reports/{id}",
1149     "title": "Update an existing Analytic Tree Report",
1150     "examples": [
1151       {
1152         "title": "Example usage:",
1153         "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",
1154         "type": "json"
1155       }
1156     ],
1157     "name": "updateAnalytic_Tree_Reports",
1158     "group": "Analytic_Tree_Reports",
1159     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1160     "version": "0.0.0",
1161     "filename": "server/api/analyticTreeReport/index.js",
1162     "groupTitle": "Analytic_Tree_Reports"
1163   },
1164   {
1165     "type": "post",
1166     "url": "/api/attachments/clone",
1167     "title": "Clone an existing Attachment",
1168     "examples": [
1169       {
1170         "title": "Example usage:",
1171         "content": "curl https://{domain}/api/attachments/clone -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
1172         "type": "json"
1173       }
1174     ],
1175     "name": "CloneAttachments",
1176     "group": "Attachments",
1177     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1178     "version": "0.0.0",
1179     "filename": "server/api/attachment/index.js",
1180     "groupTitle": "Attachments"
1181   },
1182   {
1183     "type": "delete",
1184     "url": "/api/attachments/{id}",
1185     "title": "Deletes a Attachment",
1186     "examples": [
1187       {
1188         "title": "Example usage:",
1189         "content": "curl https://{domain}/api/attachments/{id} -v -u {name}:{password} -X DELETE",
1190         "type": "json"
1191       }
1192     ],
1193     "name": "DeleteAttachments",
1194     "group": "Attachments",
1195     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1196     "version": "0.0.0",
1197     "filename": "server/api/attachment/index.js",
1198     "groupTitle": "Attachments"
1199   },
1200   {
1201     "type": "get",
1202     "url": "/api/attachments",
1203     "title": "Gets a list of Attachments",
1204     "examples": [
1205       {
1206         "title": "Example usage:",
1207         "content": "curl https://{domain}/api/attachments -v -u {name}:{password}",
1208         "type": "json"
1209       }
1210     ],
1211     "name": "GetAttachments",
1212     "group": "Attachments",
1213     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
1214     "version": "0.0.0",
1215     "filename": "server/api/attachment/index.js",
1216     "groupTitle": "Attachments"
1217   },
1218   {
1219     "type": "get",
1220     "url": "/api/attachments/{id}",
1221     "title": "Gets a single Attachment",
1222     "examples": [
1223       {
1224         "title": "Example usage:",
1225         "content": "curl https://{domain}/api/attachments/{id} -v -u {name}:{password}",
1226         "type": "json"
1227       }
1228     ],
1229     "name": "ShowAttachments",
1230     "group": "Attachments",
1231     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1232     "version": "0.0.0",
1233     "filename": "server/api/attachment/index.js",
1234     "groupTitle": "Attachments"
1235   },
1236   {
1237     "type": "post",
1238     "url": "/api/attachments",
1239     "title": "Add attachment",
1240     "examples": [
1241       {
1242         "title": "Example usage:",
1243         "content": "curl https://{domain}/api/attachments -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
1244         "type": "json"
1245       }
1246     ],
1247     "name": "create",
1248     "group": "Attachments",
1249     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1250     "version": "0.0.0",
1251     "filename": "server/api/attachment/index.js",
1252     "groupTitle": "Attachments"
1253   },
1254   {
1255     "type": "get",
1256     "url": "/api/attachments/:id/download",
1257     "title": "Download attachment",
1258     "examples": [
1259       {
1260         "title": "Example usage:",
1261         "content": "curl https://{domain}/api/attachments/:id/download -v -u {name}:{password} -X GET",
1262         "type": "json"
1263       }
1264     ],
1265     "name": "download",
1266     "group": "Attachments",
1267     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1268     "version": "0.0.0",
1269     "filename": "server/api/attachment/index.js",
1270     "groupTitle": "Attachments"
1271   },
1272   {
1273     "type": "get",
1274     "url": "/api/chat/interactions/{id}/attachment_download",
1275     "title": "Download attachment",
1276     "examples": [
1277       {
1278         "title": "Example usage:",
1279         "content": "curl https://{domain}/api/chat/interactions/{id}/attachment_download -v -u {name}:{password} -X GET",
1280         "type": "json"
1281       }
1282     ],
1283     "name": "show",
1284     "group": "Attachments",
1285     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1286     "version": "0.0.0",
1287     "filename": "server/api/chatInteraction/index.js",
1288     "groupTitle": "Attachments"
1289   },
1290   {
1291     "type": "put",
1292     "url": "/api/attachments/{id}",
1293     "title": "Update an existing Attachment",
1294     "examples": [
1295       {
1296         "title": "Example usage:",
1297         "content": "curl https://{domain}/api/attachments/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
1298         "type": "json"
1299       }
1300     ],
1301     "name": "updateAttachments",
1302     "group": "Attachments",
1303     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1304     "version": "0.0.0",
1305     "filename": "server/api/attachment/index.js",
1306     "groupTitle": "Attachments"
1307   },
1308   {
1309     "type": "post",
1310     "url": "/api/auth/local/forgot",
1311     "title": "Creates a new password reset token",
1312     "examples": [
1313       {
1314         "title": "Example usage:",
1315         "content": "curl https://{domain}/api/auth/local/forgot -d '{\"email\": \"john.doe@xcally.com\"}' \\\n -H \"Content-Type: application/json\" -X POST",
1316         "type": "json"
1317       }
1318     ],
1319     "name": "Local_Forgot_Password",
1320     "group": "Authentication",
1321     "parameter": {
1322       "fields": {
1323         "Body": [
1324           {
1325             "group": "Body",
1326             "type": "String",
1327             "optional": false,
1328             "field": "email",
1329             "description": ""
1330           }
1331         ]
1332       }
1333     },
1334     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1335     "version": "0.0.0",
1336     "filename": "server/api/authLocal/index.js",
1337     "groupTitle": "Authentication"
1338   },
1339   {
1340     "type": "post",
1341     "url": "/api/auth/local/reset/:token",
1342     "title": "Reset user password",
1343     "examples": [
1344       {
1345         "title": "Example usage:",
1346         "content": "curl https://{domain}/api/auth/local/reset/94b422c1fkdjhg766a198da6997yu6gcc963641d -d '{\"password\": \"My_newP@ssw0rd\"}' \\\n -H \"Content-Type: application/json\" -X POST",
1347         "type": "json"
1348       }
1349     ],
1350     "name": "Local_Reset_Password",
1351     "group": "Authentication",
1352     "parameter": {
1353       "fields": {
1354         "Body": [
1355           {
1356             "group": "Body",
1357             "type": "String",
1358             "optional": false,
1359             "field": "password",
1360             "description": ""
1361           }
1362         ]
1363       }
1364     },
1365     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1366     "version": "0.0.0",
1367     "filename": "server/api/authLocal/index.js",
1368     "groupTitle": "Authentication"
1369   },
1370   {
1371     "type": "post",
1372     "url": "/api/auth/google",
1373     "title": "Creates a new User token",
1374     "examples": [
1375       {
1376         "title": "Example usage:",
1377         "content": "curl https://{domain}/api/auth/google -d '{\"name\": \"john.doe\", \"password\": \"password\"}' \\\n -H \"Content-Type: application/json\" -X POST",
1378         "type": "json"
1379       }
1380     ],
1381     "name": "Local_login",
1382     "group": "Authentication",
1383     "parameter": {
1384       "fields": {
1385         "Body": [
1386           {
1387             "group": "Body",
1388             "type": "String",
1389             "optional": false,
1390             "field": "name",
1391             "description": ""
1392           },
1393           {
1394             "group": "Body",
1395             "type": "String",
1396             "optional": false,
1397             "field": "password",
1398             "description": ""
1399           }
1400         ]
1401       }
1402     },
1403     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1404     "version": "0.0.0",
1405     "filename": "server/api/authGoogle/index.js",
1406     "groupTitle": "Authentication"
1407   },
1408   {
1409     "type": "post",
1410     "url": "/api/auth/activedirectory",
1411     "title": "Creates a new User token",
1412     "examples": [
1413       {
1414         "title": "Example usage:",
1415         "content": "curl https://{domain}/api/auth/activedirectory -d '{\"name\": \"john.doe\", \"password\": \"password\"}' \\\n -H \"Content-Type: application/json\" -X POST",
1416         "type": "json"
1417       }
1418     ],
1419     "name": "Local_login",
1420     "group": "Authentication",
1421     "parameter": {
1422       "fields": {
1423         "Body": [
1424           {
1425             "group": "Body",
1426             "type": "String",
1427             "optional": false,
1428             "field": "name",
1429             "description": ""
1430           },
1431           {
1432             "group": "Body",
1433             "type": "String",
1434             "optional": false,
1435             "field": "password",
1436             "description": ""
1437           }
1438         ]
1439       }
1440     },
1441     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1442     "version": "0.0.0",
1443     "filename": "server/api/authActiveDirectory/index.js",
1444     "groupTitle": "Authentication"
1445   },
1446   {
1447     "type": "post",
1448     "url": "/api/auth/local",
1449     "title": "Creates a new User token",
1450     "examples": [
1451       {
1452         "title": "Example usage:",
1453         "content": "curl https://{domain}/api/auth/local -d '{\"name\": \"john.doe\", \"password\": \"password\"}' \\\n -H \"Content-Type: application/json\" -X POST",
1454         "type": "json"
1455       }
1456     ],
1457     "name": "Local_login",
1458     "group": "Authentication",
1459     "parameter": {
1460       "fields": {
1461         "Body": [
1462           {
1463             "group": "Body",
1464             "type": "String",
1465             "optional": false,
1466             "field": "name",
1467             "description": ""
1468           },
1469           {
1470             "group": "Body",
1471             "type": "String",
1472             "optional": false,
1473             "field": "password",
1474             "description": ""
1475           }
1476         ]
1477       }
1478     },
1479     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1480     "version": "0.0.0",
1481     "filename": "server/api/authLocal/index.js",
1482     "groupTitle": "Authentication"
1483   },
1484   {
1485     "type": "post",
1486     "url": "/api/automations",
1487     "title": "Creates a new Automation",
1488     "examples": [
1489       {
1490         "title": "Example usage:",
1491         "content": "curl https://{domain}/api/automations -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
1492         "type": "json"
1493       }
1494     ],
1495     "name": "CreateAutomations",
1496     "group": "Automations",
1497     "parameter": {
1498       "fields": {
1499         "Body": [
1500           {
1501             "group": "Body",
1502             "type": "String",
1503             "optional": false,
1504             "field": "name",
1505             "description": ""
1506           },
1507           {
1508             "group": "Body",
1509             "type": "String",
1510             "optional": true,
1511             "field": "channel",
1512             "description": ""
1513           },
1514           {
1515             "group": "Body",
1516             "type": "String",
1517             "optional": true,
1518             "field": "description",
1519             "description": ""
1520           },
1521           {
1522             "group": "Body",
1523             "type": "Boolean",
1524             "optional": true,
1525             "field": "status",
1526             "description": ""
1527           },
1528           {
1529             "group": "Body",
1530             "type": "Integer",
1531             "optional": true,
1532             "field": "timeout",
1533             "description": ""
1534           }
1535         ]
1536       }
1537     },
1538     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1539     "version": "0.0.0",
1540     "filename": "server/api/automation/index.js",
1541     "groupTitle": "Automations"
1542   },
1543   {
1544     "type": "delete",
1545     "url": "/api/automations/{id}",
1546     "title": "Deletes a Automation",
1547     "examples": [
1548       {
1549         "title": "Example usage:",
1550         "content": "curl https://{domain}/api/automations/{id} -v -u {name}:{password} -X DELETE",
1551         "type": "json"
1552       }
1553     ],
1554     "name": "DeleteAutomations",
1555     "group": "Automations",
1556     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1557     "version": "0.0.0",
1558     "filename": "server/api/automation/index.js",
1559     "groupTitle": "Automations"
1560   },
1561   {
1562     "type": "get",
1563     "url": "/api/automations",
1564     "title": "Gets a list of Automations",
1565     "examples": [
1566       {
1567         "title": "Example usage:",
1568         "content": "curl https://{domain}/api/automations -v -u {name}:{password}",
1569         "type": "json"
1570       }
1571     ],
1572     "name": "GetAutomations",
1573     "group": "Automations",
1574     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
1575     "version": "0.0.0",
1576     "filename": "server/api/automation/index.js",
1577     "groupTitle": "Automations"
1578   },
1579   {
1580     "type": "get",
1581     "url": "/api/automations/{id}",
1582     "title": "Gets a single Automation",
1583     "examples": [
1584       {
1585         "title": "Example usage:",
1586         "content": "curl https://{domain}/api/automations/{id} -v -u {name}:{password}",
1587         "type": "json"
1588       }
1589     ],
1590     "name": "ShowAutomations",
1591     "group": "Automations",
1592     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1593     "version": "0.0.0",
1594     "filename": "server/api/automation/index.js",
1595     "groupTitle": "Automations"
1596   },
1597   {
1598     "type": "post",
1599     "url": "/api/automations/{id}/actions",
1600     "title": "Creates new actions",
1601     "examples": [
1602       {
1603         "title": "Example usage:",
1604         "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",
1605         "type": "json"
1606       }
1607     ],
1608     "name": "addActions",
1609     "group": "Automations",
1610     "parameter": {
1611       "fields": {
1612         "Body": [
1613           {
1614             "group": "Body",
1615             "type": "Virtual",
1616             "optional": true,
1617             "field": "name",
1618             "description": ""
1619           },
1620           {
1621             "group": "Body",
1622             "type": "String",
1623             "optional": false,
1624             "field": "action",
1625             "description": "<p>Allowed values: contactManager, integration, motionbar, jscripty, urlForward, browser, bot, script</p>"
1626           },
1627           {
1628             "group": "Body",
1629             "type": "String",
1630             "optional": true,
1631             "field": "data1",
1632             "description": "<p>contactManager[ListId], integration[intName(zendesk)], motionbar[Popup(0),URL(1),WinApp(2)], urlForward[GET,POST], browser[TemplateId(0),URL(1)]</p>"
1633           },
1634           {
1635             "group": "Body",
1636             "type": "String",
1637             "optional": true,
1638             "field": "data2",
1639             "description": "<p>integration[AccountId], motionbar[TemplateId,URL,WinAppPath], urlForward[URL]</p>"
1640           },
1641           {
1642             "group": "Body",
1643             "type": "String",
1644             "optional": true,
1645             "field": "data3",
1646             "description": "<p>motionbar[NULL,NULL,WinAppArguments]</p>"
1647           },
1648           {
1649             "group": "Body",
1650             "type": "String",
1651             "optional": true,
1652             "field": "data4",
1653             "description": ""
1654           },
1655           {
1656             "group": "Body",
1657             "type": "String",
1658             "optional": true,
1659             "field": "data5",
1660             "description": ""
1661           },
1662           {
1663             "group": "Body",
1664             "type": "String",
1665             "optional": true,
1666             "field": "data6",
1667             "description": ""
1668           },
1669           {
1670             "group": "Body",
1671             "type": "Text",
1672             "optional": true,
1673             "field": "data7",
1674             "description": ""
1675           }
1676         ]
1677       }
1678     },
1679     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1680     "version": "0.0.0",
1681     "filename": "server/api/automation/index.js",
1682     "groupTitle": "Automations"
1683   },
1684   {
1685     "type": "post",
1686     "url": "/api/automations/{id}/conditions",
1687     "title": "Creates new conditions",
1688     "examples": [
1689       {
1690         "title": "Example usage:",
1691         "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",
1692         "type": "json"
1693       }
1694     ],
1695     "name": "addConditions",
1696     "group": "Automations",
1697     "parameter": {
1698       "fields": {
1699         "Body": [
1700           {
1701             "group": "Body",
1702             "type": "Virtual",
1703             "optional": true,
1704             "field": "name",
1705             "description": ""
1706           },
1707           {
1708             "group": "Body",
1709             "type": "String",
1710             "optional": false,
1711             "field": "field",
1712             "description": ""
1713           },
1714           {
1715             "group": "Body",
1716             "type": "String",
1717             "optional": false,
1718             "field": "operator",
1719             "description": ""
1720           },
1721           {
1722             "group": "Body",
1723             "type": "String",
1724             "optional": false,
1725             "field": "value",
1726             "description": ""
1727           }
1728         ]
1729       }
1730     },
1731     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1732     "version": "0.0.0",
1733     "filename": "server/api/automation/index.js",
1734     "groupTitle": "Automations"
1735   },
1736   {
1737     "type": "get",
1738     "url": "/api/automations/{id}/actions",
1739     "title": "Gets Automation Actions",
1740     "examples": [
1741       {
1742         "title": "Example usage:",
1743         "content": "curl https://{domain}/api/automations/{id}/actions -v -u {name}:{password} -X GET",
1744         "type": "json"
1745       }
1746     ],
1747     "name": "getActions",
1748     "group": "Automations",
1749     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1750     "version": "0.0.0",
1751     "filename": "server/api/automation/index.js",
1752     "groupTitle": "Automations"
1753   },
1754   {
1755     "type": "get",
1756     "url": "/api/automations/{id}/conditions",
1757     "title": "Gets Automation Conditions",
1758     "examples": [
1759       {
1760         "title": "Example usage:",
1761         "content": "curl https://{domain}/api/automations/{id}/conditions -v -u {name}:{password} -X GET",
1762         "type": "json"
1763       }
1764     ],
1765     "name": "getConditions",
1766     "group": "Automations",
1767     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1768     "version": "0.0.0",
1769     "filename": "server/api/automation/index.js",
1770     "groupTitle": "Automations"
1771   },
1772   {
1773     "type": "put",
1774     "url": "/api/automations/{id}",
1775     "title": "Update an existing Automation",
1776     "examples": [
1777       {
1778         "title": "Example usage:",
1779         "content": "curl https://{domain}/api/automations/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
1780         "type": "json"
1781       }
1782     ],
1783     "name": "updateAutomations",
1784     "group": "Automations",
1785     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1786     "version": "0.0.0",
1787     "filename": "server/api/automation/index.js",
1788     "groupTitle": "Automations"
1789   },
1790   {
1791     "type": "post",
1792     "url": "/api/canned_answers",
1793     "title": "Create a new canned answer",
1794     "examples": [
1795       {
1796         "title": "Example usage:",
1797         "content": "curl https://{domain}/api/canned_answers -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
1798         "type": "json"
1799       }
1800     ],
1801     "name": "Create",
1802     "group": "Canned_Answers",
1803     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1804     "version": "0.0.0",
1805     "filename": "server/api/cannedAnswer/index.js",
1806     "groupTitle": "Canned_Answers"
1807   },
1808   {
1809     "type": "delete",
1810     "url": "/api/canned_answers/{id}",
1811     "title": "Deletes a Canned Answer",
1812     "examples": [
1813       {
1814         "title": "Example usage:",
1815         "content": "curl https://{domain}/api/canned_answers/{id} -v -u {name}:{password} -X DELETE",
1816         "type": "json"
1817       }
1818     ],
1819     "name": "DeleteCanned_Answers",
1820     "group": "Canned_Answers",
1821     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1822     "version": "0.0.0",
1823     "filename": "server/api/cannedAnswer/index.js",
1824     "groupTitle": "Canned_Answers"
1825   },
1826   {
1827     "type": "get",
1828     "url": "/api/canned_answers",
1829     "title": "Gets a list of Canned Answers",
1830     "examples": [
1831       {
1832         "title": "Example usage:",
1833         "content": "curl https://{domain}/api/canned_answers -v -u {name}:{password}",
1834         "type": "json"
1835       }
1836     ],
1837     "name": "GetCanned_Answers",
1838     "group": "Canned_Answers",
1839     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
1840     "version": "0.0.0",
1841     "filename": "server/api/cannedAnswer/index.js",
1842     "groupTitle": "Canned_Answers"
1843   },
1844   {
1845     "type": "get",
1846     "url": "/api/canned_answers/{id}",
1847     "title": "Gets a single Canned Answer",
1848     "examples": [
1849       {
1850         "title": "Example usage:",
1851         "content": "curl https://{domain}/api/canned_answers/{id} -v -u {name}:{password}",
1852         "type": "json"
1853       }
1854     ],
1855     "name": "ShowCanned_Answers",
1856     "group": "Canned_Answers",
1857     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1858     "version": "0.0.0",
1859     "filename": "server/api/cannedAnswer/index.js",
1860     "groupTitle": "Canned_Answers"
1861   },
1862   {
1863     "type": "put",
1864     "url": "/api/canned_answers/{id}",
1865     "title": "Update an existing Canned Answer",
1866     "examples": [
1867       {
1868         "title": "Example usage:",
1869         "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",
1870         "type": "json"
1871       }
1872     ],
1873     "name": "updateCanned_Answers",
1874     "group": "Canned_Answers",
1875     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1876     "version": "0.0.0",
1877     "filename": "server/api/cannedAnswer/index.js",
1878     "groupTitle": "Canned_Answers"
1879   },
1880   {
1881     "type": "get",
1882     "url": "/chat/internal/users",
1883     "title": "Gets Users Last Messages",
1884     "examples": [
1885       {
1886         "title": "Example usage:",
1887         "content": "curl https://{domain}/chat/internal/users -v -u {name}:{password}  -X GET",
1888         "type": "json"
1889       }
1890     ],
1891     "name": "getLastUsersMessages",
1892     "group": "ChatInternalMessage",
1893     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1894     "version": "0.0.0",
1895     "filename": "server/api/chatInternalMessage/index.js",
1896     "groupTitle": "ChatInternalMessage"
1897   },
1898   {
1899     "type": "delete",
1900     "url": "/api/chat/applications/{id}",
1901     "title": "Deletes a Application",
1902     "examples": [
1903       {
1904         "title": "Example usage:",
1905         "content": "curl https://{domain}/api/chat/applications/{id} -v -u {name}:{password} -X DELETE",
1906         "type": "json"
1907       }
1908     ],
1909     "name": "DeleteApplications",
1910     "group": "Chat_Applications",
1911     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1912     "version": "0.0.0",
1913     "filename": "server/api/chatApplication/index.js",
1914     "groupTitle": "Chat_Applications"
1915   },
1916   {
1917     "type": "get",
1918     "url": "/api/chat/applications/{id}",
1919     "title": "Gets a single Application",
1920     "examples": [
1921       {
1922         "title": "Example usage:",
1923         "content": "curl https://{domain}/api/chat/applications/{id} -v -u {name}:{password}",
1924         "type": "json"
1925       }
1926     ],
1927     "name": "ShowApplications",
1928     "group": "Chat_Applications",
1929     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1930     "version": "0.0.0",
1931     "filename": "server/api/chatApplication/index.js",
1932     "groupTitle": "Chat_Applications"
1933   },
1934   {
1935     "type": "put",
1936     "url": "/api/chat/applications/{id}",
1937     "title": "Update an existing Application",
1938     "examples": [
1939       {
1940         "title": "Example usage:",
1941         "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",
1942         "type": "json"
1943       }
1944     ],
1945     "name": "updateApplications",
1946     "group": "Chat_Applications",
1947     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1948     "version": "0.0.0",
1949     "filename": "server/api/chatApplication/index.js",
1950     "groupTitle": "Chat_Applications"
1951   },
1952   {
1953     "type": "post",
1954     "url": "/api/chat/groups",
1955     "title": "Creates a new Group",
1956     "examples": [
1957       {
1958         "title": "Example usage:",
1959         "content": "curl https://{domain}/api/chat/groups -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
1960         "type": "json"
1961       }
1962     ],
1963     "name": "CreateGroups",
1964     "group": "Chat_Groups",
1965     "parameter": {
1966       "fields": {
1967         "Body": [
1968           {
1969             "group": "Body",
1970             "type": "String",
1971             "optional": false,
1972             "field": "name",
1973             "description": ""
1974           },
1975           {
1976             "group": "Body",
1977             "type": "String",
1978             "optional": true,
1979             "field": "description",
1980             "description": ""
1981           },
1982           {
1983             "group": "Body",
1984             "type": "Boolean",
1985             "optional": true,
1986             "field": "write",
1987             "description": ""
1988           }
1989         ]
1990       }
1991     },
1992     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1993     "version": "0.0.0",
1994     "filename": "server/api/chatGroup/index.js",
1995     "groupTitle": "Chat_Groups"
1996   },
1997   {
1998     "type": "delete",
1999     "url": "/api/chat/groups/{id}",
2000     "title": "Deletes a Group",
2001     "examples": [
2002       {
2003         "title": "Example usage:",
2004         "content": "curl https://{domain}/api/chat/groups/{id} -v -u {name}:{password} -X DELETE",
2005         "type": "json"
2006       }
2007     ],
2008     "name": "DeleteGroups",
2009     "group": "Chat_Groups",
2010     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2011     "version": "0.0.0",
2012     "filename": "server/api/chatGroup/index.js",
2013     "groupTitle": "Chat_Groups"
2014   },
2015   {
2016     "type": "get",
2017     "url": "/api/chat/groups/describe",
2018     "title": "Gets table info about Groups",
2019     "examples": [
2020       {
2021         "title": "Example usage:",
2022         "content": "curl https://{domain}/api/chat/groups/describe -v -u {name}:{password}",
2023         "type": "json"
2024       }
2025     ],
2026     "name": "DescribeGroups",
2027     "group": "Chat_Groups",
2028     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2029     "version": "0.0.0",
2030     "filename": "server/api/chatGroup/index.js",
2031     "groupTitle": "Chat_Groups"
2032   },
2033   {
2034     "type": "get",
2035     "url": "/api/chat/groups",
2036     "title": "Gets a list of Groups",
2037     "examples": [
2038       {
2039         "title": "Example usage:",
2040         "content": "curl https://{domain}/api/chat/groups -v -u {name}:{password}",
2041         "type": "json"
2042       }
2043     ],
2044     "name": "GetGroups",
2045     "group": "Chat_Groups",
2046     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
2047     "version": "0.0.0",
2048     "filename": "server/api/chatGroup/index.js",
2049     "groupTitle": "Chat_Groups"
2050   },
2051   {
2052     "type": "delete",
2053     "url": "/api/chat/groups/{id}/members",
2054     "title": "Removes members from a group",
2055     "examples": [
2056       {
2057         "title": "Example usage:",
2058         "content": "curl https://{domain}/api/chat/groups/{id}/members?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
2059         "type": "json"
2060       }
2061     ],
2062     "name": "RemoveMembers",
2063     "group": "Chat_Groups",
2064     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2065     "version": "0.0.0",
2066     "filename": "server/api/chatGroup/index.js",
2067     "groupTitle": "Chat_Groups"
2068   },
2069   {
2070     "type": "get",
2071     "url": "/api/chat/groups/{id}",
2072     "title": "Gets a single Group",
2073     "examples": [
2074       {
2075         "title": "Example usage:",
2076         "content": "curl https://{domain}/api/chat/groups/{id} -v -u {name}:{password}",
2077         "type": "json"
2078       }
2079     ],
2080     "name": "ShowGroups",
2081     "group": "Chat_Groups",
2082     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2083     "version": "0.0.0",
2084     "filename": "server/api/chatGroup/index.js",
2085     "groupTitle": "Chat_Groups"
2086   },
2087   {
2088     "type": "post",
2089     "url": "/api/chat/groups/{id}/members",
2090     "title": "Add members to chat group",
2091     "examples": [
2092       {
2093         "title": "Example usage:",
2094         "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",
2095         "type": "json"
2096       }
2097     ],
2098     "name": "addMembers",
2099     "group": "Chat_Groups",
2100     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2101     "version": "0.0.0",
2102     "filename": "server/api/chatGroup/index.js",
2103     "groupTitle": "Chat_Groups"
2104   },
2105   {
2106     "type": "post",
2107     "url": "/api/chat/groups/{id}/messages",
2108     "title": "Creates a new group message",
2109     "examples": [
2110       {
2111         "title": "Example usage:",
2112         "content": "curl https://{domain}/api/chat/groups/{id}/messages -d '{\"body\": \"Hi operator!\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
2113         "type": "json"
2114       }
2115     ],
2116     "name": "addMessage",
2117     "group": "Chat_Groups",
2118     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2119     "version": "0.0.0",
2120     "filename": "server/api/chatGroup/index.js",
2121     "groupTitle": "Chat_Groups"
2122   },
2123   {
2124     "type": "get",
2125     "url": "/api/chat/groups/{id}/members",
2126     "title": "Gets Members",
2127     "examples": [
2128       {
2129         "title": "Example usage:",
2130         "content": "curl https://{domain}/api/chat/groups/{id}/members -v -u {name}:{password} -X GET",
2131         "type": "json"
2132       }
2133     ],
2134     "name": "getMembers",
2135     "group": "Chat_Groups",
2136     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2137     "version": "0.0.0",
2138     "filename": "server/api/chatGroup/index.js",
2139     "groupTitle": "Chat_Groups"
2140   },
2141   {
2142     "type": "get",
2143     "url": "/api/chat/groups/{id}/messages",
2144     "title": "Gets Messages",
2145     "examples": [
2146       {
2147         "title": "Example usage:",
2148         "content": "curl https://{domain}/api/chat/groups/{id}/messages -v -u {name}:{password} -X GET",
2149         "type": "json"
2150       }
2151     ],
2152     "name": "getMessages",
2153     "group": "Chat_Groups",
2154     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2155     "version": "0.0.0",
2156     "filename": "server/api/chatGroup/index.js",
2157     "groupTitle": "Chat_Groups"
2158   },
2159   {
2160     "type": "get",
2161     "url": "/api/chat/groups/{id}/unread",
2162     "title": "Get unread chat group messages",
2163     "examples": [
2164       {
2165         "title": "Example usage:",
2166         "content": "curl https://{domain}/api/chat/groups/{id}/unread -H 'Content-Type: application/json' -v -u {name}:{password} -X GET",
2167         "type": "json"
2168       }
2169     ],
2170     "name": "getUread",
2171     "group": "Chat_Groups",
2172     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2173     "version": "0.0.0",
2174     "filename": "server/api/chatGroup/index.js",
2175     "groupTitle": "Chat_Groups"
2176   },
2177   {
2178     "type": "put",
2179     "url": "/api/chat/groups/{id}",
2180     "title": "Update an existing Group",
2181     "examples": [
2182       {
2183         "title": "Example usage:",
2184         "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",
2185         "type": "json"
2186       }
2187     ],
2188     "name": "updateGroups",
2189     "group": "Chat_Groups",
2190     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2191     "version": "0.0.0",
2192     "filename": "server/api/chatGroup/index.js",
2193     "groupTitle": "Chat_Groups"
2194   },
2195   {
2196     "type": "post",
2197     "url": "/api/chat/interactions/{id}/tags",
2198     "title": "Add tags to the interaction",
2199     "examples": [
2200       {
2201         "title": "Example usage:",
2202         "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",
2203         "type": "json"
2204       }
2205     ],
2206     "name": "AddTags",
2207     "group": "Chat_Interactions",
2208     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2209     "version": "0.0.0",
2210     "filename": "server/api/chatInteraction/index.js",
2211     "groupTitle": "Chat_Interactions"
2212   },
2213   {
2214     "type": "post",
2215     "url": "/api/chat/interactions",
2216     "title": "Creates a new Interaction",
2217     "examples": [
2218       {
2219         "title": "Example usage:",
2220         "content": "curl https://{domain}/api/chat/interactions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
2221         "type": "json"
2222       }
2223     ],
2224     "name": "CreateInteractions",
2225     "group": "Chat_Interactions",
2226     "parameter": {
2227       "fields": {
2228         "Body": [
2229           {
2230             "group": "Body",
2231             "type": "Boolean",
2232             "optional": true,
2233             "field": "closed",
2234             "description": ""
2235           },
2236           {
2237             "group": "Body",
2238             "type": "Integer",
2239             "optional": true,
2240             "field": "ratingValue",
2241             "description": ""
2242           },
2243           {
2244             "group": "Body",
2245             "type": "String",
2246             "allowedValues": [
2247               "\"star\"",
2248               "\"thumb\""
2249             ],
2250             "optional": true,
2251             "field": "ratingType",
2252             "description": ""
2253           },
2254           {
2255             "group": "Body",
2256             "type": "Text",
2257             "optional": true,
2258             "field": "ratingMessage",
2259             "description": ""
2260           },
2261           {
2262             "group": "Body",
2263             "type": "Text",
2264             "optional": true,
2265             "field": "pathTranscript",
2266             "description": ""
2267           },
2268           {
2269             "group": "Body",
2270             "type": "String",
2271             "optional": true,
2272             "field": "mailTranscript",
2273             "description": ""
2274           },
2275           {
2276             "group": "Body",
2277             "type": "String",
2278             "optional": true,
2279             "field": "closedAt",
2280             "description": ""
2281           },
2282           {
2283             "group": "Body",
2284             "type": "String",
2285             "optional": true,
2286             "field": "disposition",
2287             "description": ""
2288           },
2289           {
2290             "group": "Body",
2291             "type": "String",
2292             "optional": true,
2293             "field": "secondDisposition",
2294             "description": ""
2295           },
2296           {
2297             "group": "Body",
2298             "type": "String",
2299             "optional": true,
2300             "field": "thirdDisposition",
2301             "description": ""
2302           },
2303           {
2304             "group": "Body",
2305             "type": "String",
2306             "optional": true,
2307             "field": "note",
2308             "description": ""
2309           },
2310           {
2311             "group": "Body",
2312             "type": "String",
2313             "optional": true,
2314             "field": "browserName",
2315             "description": ""
2316           },
2317           {
2318             "group": "Body",
2319             "type": "String",
2320             "optional": true,
2321             "field": "browserVersion",
2322             "description": ""
2323           },
2324           {
2325             "group": "Body",
2326             "type": "String",
2327             "optional": true,
2328             "field": "osName",
2329             "description": ""
2330           },
2331           {
2332             "group": "Body",
2333             "type": "String",
2334             "optional": true,
2335             "field": "osVersion",
2336             "description": ""
2337           },
2338           {
2339             "group": "Body",
2340             "type": "String",
2341             "optional": true,
2342             "field": "deviceModel",
2343             "description": ""
2344           },
2345           {
2346             "group": "Body",
2347             "type": "String",
2348             "optional": true,
2349             "field": "deviceVendor",
2350             "description": ""
2351           },
2352           {
2353             "group": "Body",
2354             "type": "String",
2355             "optional": true,
2356             "field": "deviceType",
2357             "description": ""
2358           },
2359           {
2360             "group": "Body",
2361             "type": "Text",
2362             "optional": true,
2363             "field": "referer",
2364             "description": ""
2365           },
2366           {
2367             "group": "Body",
2368             "type": "String",
2369             "optional": true,
2370             "field": "customerIp",
2371             "description": ""
2372           },
2373           {
2374             "group": "Body",
2375             "type": "Text",
2376             "optional": true,
2377             "field": "formData",
2378             "description": ""
2379           },
2380           {
2381             "group": "Body",
2382             "type": "String",
2383             "optional": true,
2384             "field": "read1stAt",
2385             "description": ""
2386           },
2387           {
2388             "group": "Body",
2389             "type": "String",
2390             "optional": true,
2391             "field": "lastMsgAt",
2392             "description": ""
2393           },
2394           {
2395             "group": "Body",
2396             "type": "String",
2397             "allowedValues": [
2398               "\"in\"",
2399               "\"out\""
2400             ],
2401             "optional": false,
2402             "field": "lastMsgDirection",
2403             "description": ""
2404           },
2405           {
2406             "group": "Body",
2407             "type": "String",
2408             "optional": true,
2409             "field": "closeReason",
2410             "description": ""
2411           },
2412           {
2413             "group": "Body",
2414             "type": "String",
2415             "optional": true,
2416             "field": "customerPort",
2417             "description": ""
2418           },
2419           {
2420             "group": "Body",
2421             "type": "Text",
2422             "optional": true,
2423             "field": "vidaooSessionId",
2424             "description": ""
2425           },
2426           {
2427             "group": "Body",
2428             "type": "Boolean",
2429             "optional": true,
2430             "field": "autoreplyExecuted",
2431             "description": ""
2432           }
2433         ]
2434       }
2435     },
2436     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2437     "version": "0.0.0",
2438     "filename": "server/api/chatInteraction/index.js",
2439     "groupTitle": "Chat_Interactions"
2440   },
2441   {
2442     "type": "delete",
2443     "url": "/api/chat/interactions/{id}",
2444     "title": "Deletes a Interaction",
2445     "examples": [
2446       {
2447         "title": "Example usage:",
2448         "content": "curl https://{domain}/api/chat/interactions/{id} -v -u {name}:{password} -X DELETE",
2449         "type": "json"
2450       }
2451     ],
2452     "name": "DeleteInteractions",
2453     "group": "Chat_Interactions",
2454     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2455     "version": "0.0.0",
2456     "filename": "server/api/chatInteraction/index.js",
2457     "groupTitle": "Chat_Interactions"
2458   },
2459   {
2460     "type": "get",
2461     "url": "/api/chat/interactions/describe",
2462     "title": "Gets table info about Interactions",
2463     "examples": [
2464       {
2465         "title": "Example usage:",
2466         "content": "curl https://{domain}/api/chat/interactions/describe -v -u {name}:{password}",
2467         "type": "json"
2468       }
2469     ],
2470     "name": "DescribeInteractions",
2471     "group": "Chat_Interactions",
2472     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2473     "version": "0.0.0",
2474     "filename": "server/api/chatInteraction/index.js",
2475     "groupTitle": "Chat_Interactions"
2476   },
2477   {
2478     "type": "get",
2479     "url": "/api/chat/interactions",
2480     "title": "Gets a list of Interactions",
2481     "examples": [
2482       {
2483         "title": "Example usage:",
2484         "content": "curl https://{domain}/api/chat/interactions -v -u {name}:{password}",
2485         "type": "json"
2486       }
2487     ],
2488     "name": "GetInteractions",
2489     "group": "Chat_Interactions",
2490     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
2491     "version": "0.0.0",
2492     "filename": "server/api/chatInteraction/index.js",
2493     "groupTitle": "Chat_Interactions"
2494   },
2495   {
2496     "type": "delete",
2497     "url": "/api/chat/interactions/{id}/tags",
2498     "title": "Removes tags from interaction",
2499     "examples": [
2500       {
2501         "title": "Example usage:",
2502         "content": "curl https://{domain}/api/chat/interactions/{id}/tags?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
2503         "type": "json"
2504       }
2505     ],
2506     "name": "RemoveTags",
2507     "group": "Chat_Interactions",
2508     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2509     "version": "0.0.0",
2510     "filename": "server/api/chatInteraction/index.js",
2511     "groupTitle": "Chat_Interactions"
2512   },
2513   {
2514     "type": "get",
2515     "url": "/api/chat/interactions/{id}",
2516     "title": "Gets a single Interaction",
2517     "examples": [
2518       {
2519         "title": "Example usage:",
2520         "content": "curl https://{domain}/api/chat/interactions/{id} -v -u {name}:{password}",
2521         "type": "json"
2522       }
2523     ],
2524     "name": "ShowInteractions",
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>",
2527     "version": "0.0.0",
2528     "filename": "server/api/chatInteraction/index.js",
2529     "groupTitle": "Chat_Interactions"
2530   },
2531   {
2532     "type": "put",
2533     "url": "/api/chat/interactions/{id}/abandon",
2534     "title": "Abandon interaction",
2535     "examples": [
2536       {
2537         "title": "Example usage:",
2538         "content": "curl https://{domain}/api/chat/interactions/{id}/abandon -d '{\"channel\": \"chat\", \"...\": \"...\"}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
2539         "type": "json"
2540       }
2541     ],
2542     "name": "abandon",
2543     "group": "Chat_Interactions",
2544     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <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>",
2545     "version": "0.0.0",
2546     "filename": "server/api/chatInteraction/index.js",
2547     "groupTitle": "Chat_Interactions"
2548   },
2549   {
2550     "type": "put",
2551     "url": "/api/chat/interactions/{id}/close",
2552     "title": "Close Interaction",
2553     "examples": [
2554       {
2555         "title": "Example usage:",
2556         "content": "curl https://{domain}/api/chat/interactions/{id}/close -d '[{\"to\": \"+3901119886500\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
2557         "type": "json"
2558       }
2559     ],
2560     "name": "addMessage",
2561     "group": "Chat_Interactions",
2562     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2563     "version": "0.0.0",
2564     "filename": "server/api/chatInteraction/index.js",
2565     "groupTitle": "Chat_Interactions"
2566   },
2567   {
2568     "type": "post",
2569     "url": "/api/chat/interactions/{id}/messages",
2570     "title": "Creates new messages",
2571     "examples": [
2572       {
2573         "title": "Example usage:",
2574         "content": "curl https://{domain}/api/chat/interactions/{id}/messages -d '[{\"to\": \"+3901119886500\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
2575         "type": "json"
2576       }
2577     ],
2578     "name": "addMessage",
2579     "group": "Chat_Interactions",
2580     "parameter": {
2581       "fields": {
2582         "Body": [
2583           {
2584             "group": "Body",
2585             "type": "Text",
2586             "optional": false,
2587             "field": "body",
2588             "description": ""
2589           },
2590           {
2591             "group": "Body",
2592             "type": "Boolean",
2593             "optional": true,
2594             "field": "read",
2595             "description": ""
2596           },
2597           {
2598             "group": "Body",
2599             "type": "Boolean",
2600             "optional": true,
2601             "field": "secret",
2602             "description": ""
2603           },
2604           {
2605             "group": "Body",
2606             "type": "String",
2607             "allowedValues": [
2608               "\"in\"",
2609               "\"out\""
2610             ],
2611             "optional": false,
2612             "field": "direction",
2613             "description": ""
2614           },
2615           {
2616             "group": "Body",
2617             "type": "String",
2618             "optional": true,
2619             "field": "readAt",
2620             "description": ""
2621           },
2622           {
2623             "group": "Body",
2624             "type": "String",
2625             "optional": true,
2626             "field": "providerName",
2627             "description": ""
2628           },
2629           {
2630             "group": "Body",
2631             "type": "Text",
2632             "optional": true,
2633             "field": "providerResponse",
2634             "description": ""
2635           }
2636         ]
2637       }
2638     },
2639     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2640     "version": "0.0.0",
2641     "filename": "server/api/chatInteraction/index.js",
2642     "groupTitle": "Chat_Interactions"
2643   },
2644   {
2645     "type": "post",
2646     "url": "/api/chat/interactions/{id}/attachment_upload",
2647     "title": "Add attachment",
2648     "examples": [
2649       {
2650         "title": "Example usage:",
2651         "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",
2652         "type": "json"
2653       }
2654     ],
2655     "name": "attachmentUpload",
2656     "group": "Chat_Interactions",
2657     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2658     "version": "0.0.0",
2659     "filename": "server/api/chatInteraction/index.js",
2660     "groupTitle": "Chat_Interactions"
2661   },
2662   {
2663     "type": "post",
2664     "url": "/api/chat/interactions/{id}/vidaoo",
2665     "title": "Create Vidaoo Session",
2666     "examples": [
2667       {
2668         "title": "Example usage:",
2669         "content": "curl https://{domain}/api/chat/interactions/{id}/vidaoo  -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
2670         "type": "json"
2671       }
2672     ],
2673     "name": "createVidaooSession",
2674     "group": "Chat_Interactions",
2675     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2676     "version": "0.0.0",
2677     "filename": "server/api/chatInteraction/index.js",
2678     "groupTitle": "Chat_Interactions"
2679   },
2680   {
2681     "type": "put",
2682     "url": "/api/chat/interactions/{id}/custom_update",
2683     "title": "Update interaction",
2684     "examples": [
2685       {
2686         "title": "Example usage:",
2687         "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",
2688         "type": "json"
2689       }
2690     ],
2691     "name": "customUpdate",
2692     "group": "Chat_Interactions",
2693     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <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>",
2694     "version": "0.0.0",
2695     "filename": "server/api/chatInteraction/index.js",
2696     "groupTitle": "Chat_Interactions"
2697   },
2698   {
2699     "type": "get",
2700     "url": "/api/chat/interactions/{id}/download",
2701     "title": "Gets interaction",
2702     "examples": [
2703       {
2704         "title": "Example usage:",
2705         "content": "curl https://{domain}/api/chat/interactions/{id}/download -v -u {name}:{password} -X GET",
2706         "type": "json"
2707       }
2708     ],
2709     "name": "download",
2710     "group": "Chat_Interactions",
2711     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2712     "version": "0.0.0",
2713     "filename": "server/api/chatInteraction/index.js",
2714     "groupTitle": "Chat_Interactions"
2715   },
2716   {
2717     "type": "get",
2718     "url": "/api/chat/interactions/{id}/messages",
2719     "title": "Gets interaction messages",
2720     "examples": [
2721       {
2722         "title": "Example usage:",
2723         "content": "curl https://{domain}/api/chat/interactions/{id}/messages -v -u {name}:{password} -X GET",
2724         "type": "json"
2725       }
2726     ],
2727     "name": "getMessages",
2728     "group": "Chat_Interactions",
2729     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2730     "version": "0.0.0",
2731     "filename": "server/api/chatInteraction/index.js",
2732     "groupTitle": "Chat_Interactions"
2733   },
2734   {
2735     "type": "get",
2736     "url": "/api/chat/interactions/{id}/my_messages",
2737     "title": "Gets interaction messages",
2738     "examples": [
2739       {
2740         "title": "Example usage:",
2741         "content": "curl https://{domain}/api/chat/interactions/{id}/my_messages -v -u {name}:{password} -X GET",
2742         "type": "json"
2743       }
2744     ],
2745     "name": "getMyMessages",
2746     "group": "Chat_Interactions",
2747     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2748     "version": "0.0.0",
2749     "filename": "server/api/chatInteraction/index.js",
2750     "groupTitle": "Chat_Interactions"
2751   },
2752   {
2753     "type": "put",
2754     "url": "/api/chat/interactions/{id}",
2755     "title": "Update an existing Interaction",
2756     "examples": [
2757       {
2758         "title": "Example usage:",
2759         "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",
2760         "type": "json"
2761       }
2762     ],
2763     "name": "updateInteractions",
2764     "group": "Chat_Interactions",
2765     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2766     "version": "0.0.0",
2767     "filename": "server/api/chatInteraction/index.js",
2768     "groupTitle": "Chat_Interactions"
2769   },
2770   {
2771     "type": "post",
2772     "url": "/api/chat/internal/messages",
2773     "title": "Creates a new Message",
2774     "examples": [
2775       {
2776         "title": "Example usage:",
2777         "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",
2778         "type": "json"
2779       }
2780     ],
2781     "name": "CreateMessages",
2782     "group": "Chat_Internal_Messages",
2783     "parameter": {
2784       "fields": {
2785         "Body": [
2786           {
2787             "group": "Body",
2788             "type": "Text",
2789             "optional": false,
2790             "field": "body",
2791             "description": ""
2792           },
2793           {
2794             "group": "Body",
2795             "type": "Boolean",
2796             "optional": true,
2797             "field": "read",
2798             "description": ""
2799           },
2800           {
2801             "group": "Body",
2802             "type": "Integer",
2803             "optional": true,
2804             "field": "ChatInternalMessageId",
2805             "description": ""
2806           }
2807         ]
2808       }
2809     },
2810     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2811     "version": "0.0.0",
2812     "filename": "server/api/chatInternalMessage/index.js",
2813     "groupTitle": "Chat_Internal_Messages"
2814   },
2815   {
2816     "type": "delete",
2817     "url": "/api/chat/internal/messages/{id}",
2818     "title": "Deletes a Message",
2819     "examples": [
2820       {
2821         "title": "Example usage:",
2822         "content": "curl https://{domain}/api/chat/internal/messages/{id} -v -u {name}:{password} -X DELETE",
2823         "type": "json"
2824       }
2825     ],
2826     "name": "DeleteMessages",
2827     "group": "Chat_Internal_Messages",
2828     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2829     "version": "0.0.0",
2830     "filename": "server/api/chatInternalMessage/index.js",
2831     "groupTitle": "Chat_Internal_Messages"
2832   },
2833   {
2834     "type": "get",
2835     "url": "/api/chat/internal/messages/describe",
2836     "title": "Gets table info about Messages",
2837     "examples": [
2838       {
2839         "title": "Example usage:",
2840         "content": "curl https://{domain}/api/chat/internal/messages/describe -v -u {name}:{password}",
2841         "type": "json"
2842       }
2843     ],
2844     "name": "DescribeMessages",
2845     "group": "Chat_Internal_Messages",
2846     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2847     "version": "0.0.0",
2848     "filename": "server/api/chatInternalMessage/index.js",
2849     "groupTitle": "Chat_Internal_Messages"
2850   },
2851   {
2852     "type": "get",
2853     "url": "/api/chat/internal/messages",
2854     "title": "Gets a list of Messages",
2855     "examples": [
2856       {
2857         "title": "Example usage:",
2858         "content": "curl https://{domain}/api/chat/internal/messages -v -u {name}:{password}",
2859         "type": "json"
2860       }
2861     ],
2862     "name": "GetMessages",
2863     "group": "Chat_Internal_Messages",
2864     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
2865     "version": "0.0.0",
2866     "filename": "server/api/chatInternalMessage/index.js",
2867     "groupTitle": "Chat_Internal_Messages"
2868   },
2869   {
2870     "type": "get",
2871     "url": "/api/chat/internal/messages/{id}",
2872     "title": "Gets a single Message",
2873     "examples": [
2874       {
2875         "title": "Example usage:",
2876         "content": "curl https://{domain}/api/chat/internal/messages/{id} -v -u {name}:{password}",
2877         "type": "json"
2878       }
2879     ],
2880     "name": "ShowMessages",
2881     "group": "Chat_Internal_Messages",
2882     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2883     "version": "0.0.0",
2884     "filename": "server/api/chatInternalMessage/index.js",
2885     "groupTitle": "Chat_Internal_Messages"
2886   },
2887   {
2888     "type": "put",
2889     "url": "/api/chat/internal/messages/{id}",
2890     "title": "Update an existing Message",
2891     "examples": [
2892       {
2893         "title": "Example usage:",
2894         "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",
2895         "type": "json"
2896       }
2897     ],
2898     "name": "updateMessages",
2899     "group": "Chat_Internal_Messages",
2900     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2901     "version": "0.0.0",
2902     "filename": "server/api/chatInternalMessage/index.js",
2903     "groupTitle": "Chat_Internal_Messages"
2904   },
2905   {
2906     "type": "post",
2907     "url": "/api/chat/messages",
2908     "title": "Creates a new Message",
2909     "examples": [
2910       {
2911         "title": "Example usage:",
2912         "content": "curl https://{domain}/api/chat/messages -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
2913         "type": "json"
2914       }
2915     ],
2916     "name": "CreateMessages",
2917     "group": "Chat_Messages",
2918     "parameter": {
2919       "fields": {
2920         "Body": [
2921           {
2922             "group": "Body",
2923             "type": "Text",
2924             "optional": false,
2925             "field": "body",
2926             "description": ""
2927           },
2928           {
2929             "group": "Body",
2930             "type": "Boolean",
2931             "optional": true,
2932             "field": "read",
2933             "description": ""
2934           },
2935           {
2936             "group": "Body",
2937             "type": "Boolean",
2938             "optional": true,
2939             "field": "secret",
2940             "description": ""
2941           },
2942           {
2943             "group": "Body",
2944             "type": "String",
2945             "allowedValues": [
2946               "\"in\"",
2947               "\"out\""
2948             ],
2949             "optional": false,
2950             "field": "direction",
2951             "description": ""
2952           },
2953           {
2954             "group": "Body",
2955             "type": "String",
2956             "optional": true,
2957             "field": "readAt",
2958             "description": ""
2959           },
2960           {
2961             "group": "Body",
2962             "type": "String",
2963             "optional": true,
2964             "field": "providerName",
2965             "description": ""
2966           },
2967           {
2968             "group": "Body",
2969             "type": "Text",
2970             "optional": true,
2971             "field": "providerResponse",
2972             "description": ""
2973           }
2974         ]
2975       }
2976     },
2977     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2978     "version": "0.0.0",
2979     "filename": "server/api/chatMessage/index.js",
2980     "groupTitle": "Chat_Messages"
2981   },
2982   {
2983     "type": "delete",
2984     "url": "/api/chat/messages/{id}",
2985     "title": "Deletes a Message",
2986     "examples": [
2987       {
2988         "title": "Example usage:",
2989         "content": "curl https://{domain}/api/chat/messages/{id} -v -u {name}:{password} -X DELETE",
2990         "type": "json"
2991       }
2992     ],
2993     "name": "DeleteMessages",
2994     "group": "Chat_Messages",
2995     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2996     "version": "0.0.0",
2997     "filename": "server/api/chatMessage/index.js",
2998     "groupTitle": "Chat_Messages"
2999   },
3000   {
3001     "type": "get",
3002     "url": "/api/chat/messages/describe",
3003     "title": "Gets table info about Messages",
3004     "examples": [
3005       {
3006         "title": "Example usage:",
3007         "content": "curl https://{domain}/api/chat/messages/describe -v -u {name}:{password}",
3008         "type": "json"
3009       }
3010     ],
3011     "name": "DescribeMessages",
3012     "group": "Chat_Messages",
3013     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3014     "version": "0.0.0",
3015     "filename": "server/api/chatMessage/index.js",
3016     "groupTitle": "Chat_Messages"
3017   },
3018   {
3019     "type": "get",
3020     "url": "/api/chat/messages",
3021     "title": "Gets a list of Messages",
3022     "examples": [
3023       {
3024         "title": "Example usage:",
3025         "content": "curl https://{domain}/api/chat/messages -v -u {name}:{password}",
3026         "type": "json"
3027       }
3028     ],
3029     "name": "GetMessages",
3030     "group": "Chat_Messages",
3031     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
3032     "version": "0.0.0",
3033     "filename": "server/api/chatMessage/index.js",
3034     "groupTitle": "Chat_Messages"
3035   },
3036   {
3037     "type": "get",
3038     "url": "/api/chat/messages/{id}",
3039     "title": "Gets a single Message",
3040     "examples": [
3041       {
3042         "title": "Example usage:",
3043         "content": "curl https://{domain}/api/chat/messages/{id} -v -u {name}:{password}",
3044         "type": "json"
3045       }
3046     ],
3047     "name": "ShowMessages",
3048     "group": "Chat_Messages",
3049     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3050     "version": "0.0.0",
3051     "filename": "server/api/chatMessage/index.js",
3052     "groupTitle": "Chat_Messages"
3053   },
3054   {
3055     "type": "put",
3056     "url": "/api/chat/messages/{id}",
3057     "title": "Update an existing Message",
3058     "examples": [
3059       {
3060         "title": "Example usage:",
3061         "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",
3062         "type": "json"
3063       }
3064     ],
3065     "name": "updateMessages",
3066     "group": "Chat_Messages",
3067     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3068     "version": "0.0.0",
3069     "filename": "server/api/chatMessage/index.js",
3070     "groupTitle": "Chat_Messages"
3071   },
3072   {
3073     "type": "post",
3074     "url": "/api/chat/offline_messages",
3075     "title": "Creates a new OfflineMessage",
3076     "examples": [
3077       {
3078         "title": "Example usage:",
3079         "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",
3080         "type": "json"
3081       }
3082     ],
3083     "name": "CreateOfflineMessages",
3084     "group": "Chat_Offline_Messages",
3085     "parameter": {
3086       "fields": {
3087         "Body": [
3088           {
3089             "group": "Body",
3090             "type": "Text",
3091             "optional": false,
3092             "field": "body",
3093             "description": ""
3094           }
3095         ]
3096       }
3097     },
3098     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3099     "version": "0.0.0",
3100     "filename": "server/api/chatOfflineMessage/index.js",
3101     "groupTitle": "Chat_Offline_Messages"
3102   },
3103   {
3104     "type": "delete",
3105     "url": "/api/chat/offline_messages/{id}",
3106     "title": "Deletes a OfflineMessage",
3107     "examples": [
3108       {
3109         "title": "Example usage:",
3110         "content": "curl https://{domain}/api/chat/offline_messages/{id} -v -u {name}:{password} -X DELETE",
3111         "type": "json"
3112       }
3113     ],
3114     "name": "DeleteOfflineMessages",
3115     "group": "Chat_Offline_Messages",
3116     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3117     "version": "0.0.0",
3118     "filename": "server/api/chatOfflineMessage/index.js",
3119     "groupTitle": "Chat_Offline_Messages"
3120   },
3121   {
3122     "type": "get",
3123     "url": "/api/chat/offline_messages/describe",
3124     "title": "Gets table info about OfflineMessages",
3125     "examples": [
3126       {
3127         "title": "Example usage:",
3128         "content": "curl https://{domain}/api/chat/offline_messages/describe -v -u {name}:{password}",
3129         "type": "json"
3130       }
3131     ],
3132     "name": "DescribeOfflineMessages",
3133     "group": "Chat_Offline_Messages",
3134     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3135     "version": "0.0.0",
3136     "filename": "server/api/chatOfflineMessage/index.js",
3137     "groupTitle": "Chat_Offline_Messages"
3138   },
3139   {
3140     "type": "get",
3141     "url": "/api/chat/offline_messages",
3142     "title": "Gets a list of OfflineMessages",
3143     "examples": [
3144       {
3145         "title": "Example usage:",
3146         "content": "curl https://{domain}/api/chat/offline_messages -v -u {name}:{password}",
3147         "type": "json"
3148       }
3149     ],
3150     "name": "GetOfflineMessages",
3151     "group": "Chat_Offline_Messages",
3152     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
3153     "version": "0.0.0",
3154     "filename": "server/api/chatOfflineMessage/index.js",
3155     "groupTitle": "Chat_Offline_Messages"
3156   },
3157   {
3158     "type": "get",
3159     "url": "/api/chat/offline_messages/{id}",
3160     "title": "Gets a single OfflineMessage",
3161     "examples": [
3162       {
3163         "title": "Example usage:",
3164         "content": "curl https://{domain}/api/chat/offline_messages/{id} -v -u {name}:{password}",
3165         "type": "json"
3166       }
3167     ],
3168     "name": "ShowOfflineMessages",
3169     "group": "Chat_Offline_Messages",
3170     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3171     "version": "0.0.0",
3172     "filename": "server/api/chatOfflineMessage/index.js",
3173     "groupTitle": "Chat_Offline_Messages"
3174   },
3175   {
3176     "type": "put",
3177     "url": "/api/chat/offline_messages/{id}",
3178     "title": "Update an existing OfflineMessage",
3179     "examples": [
3180       {
3181         "title": "Example usage:",
3182         "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",
3183         "type": "json"
3184       }
3185     ],
3186     "name": "updateOfflineMessages",
3187     "group": "Chat_Offline_Messages",
3188     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3189     "version": "0.0.0",
3190     "filename": "server/api/chatOfflineMessage/index.js",
3191     "groupTitle": "Chat_Offline_Messages"
3192   },
3193   {
3194     "type": "post",
3195     "url": "/api/chat/proactive_actions",
3196     "title": "Creates a new Proactive Action",
3197     "examples": [
3198       {
3199         "title": "Example usage:",
3200         "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",
3201         "type": "json"
3202       }
3203     ],
3204     "name": "CreateProactive_Actions",
3205     "group": "Chat_Proactive_Actions",
3206     "parameter": {
3207       "fields": {
3208         "Body": [
3209           {
3210             "group": "Body",
3211             "type": "String",
3212             "optional": false,
3213             "field": "name",
3214             "description": ""
3215           },
3216           {
3217             "group": "Body",
3218             "type": "String",
3219             "allowedValues": [
3220               "\"mouseOver\"",
3221               "\"timeout\""
3222             ],
3223             "optional": true,
3224             "field": "type",
3225             "description": ""
3226           },
3227           {
3228             "group": "Body",
3229             "type": "String",
3230             "optional": true,
3231             "field": "selector",
3232             "description": ""
3233           },
3234           {
3235             "group": "Body",
3236             "type": "Integer",
3237             "optional": true,
3238             "field": "timeout",
3239             "description": ""
3240           }
3241         ]
3242       }
3243     },
3244     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3245     "version": "0.0.0",
3246     "filename": "server/api/chatProactiveAction/index.js",
3247     "groupTitle": "Chat_Proactive_Actions"
3248   },
3249   {
3250     "type": "delete",
3251     "url": "/api/chat/proactive_actions/{id}",
3252     "title": "Deletes a Proactive Action",
3253     "examples": [
3254       {
3255         "title": "Example usage:",
3256         "content": "curl https://{domain}/api/chat/proactive_actions/{id} -v -u {name}:{password} -X DELETE",
3257         "type": "json"
3258       }
3259     ],
3260     "name": "DeleteProactive_Actions",
3261     "group": "Chat_Proactive_Actions",
3262     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3263     "version": "0.0.0",
3264     "filename": "server/api/chatProactiveAction/index.js",
3265     "groupTitle": "Chat_Proactive_Actions"
3266   },
3267   {
3268     "type": "get",
3269     "url": "/api/chat/proactive_actions/{id}",
3270     "title": "Gets a single Proactive Action",
3271     "examples": [
3272       {
3273         "title": "Example usage:",
3274         "content": "curl https://{domain}/api/chat/proactive_actions/{id} -v -u {name}:{password}",
3275         "type": "json"
3276       }
3277     ],
3278     "name": "ShowProactive_Actions",
3279     "group": "Chat_Proactive_Actions",
3280     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3281     "version": "0.0.0",
3282     "filename": "server/api/chatProactiveAction/index.js",
3283     "groupTitle": "Chat_Proactive_Actions"
3284   },
3285   {
3286     "type": "put",
3287     "url": "/api/chat/proactive_actions/{id}",
3288     "title": "Update an existing Proactive Action",
3289     "examples": [
3290       {
3291         "title": "Example usage:",
3292         "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",
3293         "type": "json"
3294       }
3295     ],
3296     "name": "updateProactive_Actions",
3297     "group": "Chat_Proactive_Actions",
3298     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3299     "version": "0.0.0",
3300     "filename": "server/api/chatProactiveAction/index.js",
3301     "groupTitle": "Chat_Proactive_Actions"
3302   },
3303   {
3304     "type": "post",
3305     "url": "/api/chat/reports/queue",
3306     "title": "Creates a new Chat Queue Report",
3307     "examples": [
3308       {
3309         "title": "Example usage:",
3310         "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",
3311         "type": "json"
3312       }
3313     ],
3314     "name": "CreateChat_Queue_Reports",
3315     "group": "Chat_Queue_Reports",
3316     "parameter": {
3317       "fields": {
3318         "Body": [
3319           {
3320             "group": "Body",
3321             "type": "String",
3322             "optional": false,
3323             "field": "uniqueid",
3324             "description": ""
3325           },
3326           {
3327             "group": "Body",
3328             "type": "String",
3329             "optional": true,
3330             "field": "from",
3331             "description": ""
3332           },
3333           {
3334             "group": "Body",
3335             "type": "String",
3336             "optional": true,
3337             "field": "joinAt",
3338             "description": ""
3339           },
3340           {
3341             "group": "Body",
3342             "type": "String",
3343             "optional": true,
3344             "field": "leaveAt",
3345             "description": ""
3346           },
3347           {
3348             "group": "Body",
3349             "type": "String",
3350             "optional": true,
3351             "field": "acceptAt",
3352             "description": ""
3353           },
3354           {
3355             "group": "Body",
3356             "type": "String",
3357             "optional": true,
3358             "field": "exitAt",
3359             "description": ""
3360           },
3361           {
3362             "group": "Body",
3363             "type": "String",
3364             "optional": true,
3365             "field": "reason",
3366             "description": ""
3367           }
3368         ]
3369       }
3370     },
3371     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3372     "version": "0.0.0",
3373     "filename": "server/api/chatQueueReport/index.js",
3374     "groupTitle": "Chat_Queue_Reports"
3375   },
3376   {
3377     "type": "delete",
3378     "url": "/api/chat/reports/queue/{id}",
3379     "title": "Deletes a Chat Queue Report",
3380     "examples": [
3381       {
3382         "title": "Example usage:",
3383         "content": "curl https://{domain}/api/chat/reports/queue/{id} -v -u {name}:{password} -X DELETE",
3384         "type": "json"
3385       }
3386     ],
3387     "name": "DeleteChat_Queue_Reports",
3388     "group": "Chat_Queue_Reports",
3389     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3390     "version": "0.0.0",
3391     "filename": "server/api/chatQueueReport/index.js",
3392     "groupTitle": "Chat_Queue_Reports"
3393   },
3394   {
3395     "type": "get",
3396     "url": "/api/chat/reports/queue/describe",
3397     "title": "Gets table info about Chat Queue Reports",
3398     "examples": [
3399       {
3400         "title": "Example usage:",
3401         "content": "curl https://{domain}/api/chat/reports/queue/describe -v -u {name}:{password}",
3402         "type": "json"
3403       }
3404     ],
3405     "name": "DescribeChat_Queue_Reports",
3406     "group": "Chat_Queue_Reports",
3407     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3408     "version": "0.0.0",
3409     "filename": "server/api/chatQueueReport/index.js",
3410     "groupTitle": "Chat_Queue_Reports"
3411   },
3412   {
3413     "type": "get",
3414     "url": "/api/chat/reports/queue",
3415     "title": "Gets a list of Chat Queue Reports",
3416     "examples": [
3417       {
3418         "title": "Example usage:",
3419         "content": "curl https://{domain}/api/chat/reports/queue -v -u {name}:{password}",
3420         "type": "json"
3421       }
3422     ],
3423     "name": "GetChat_Queue_Reports",
3424     "group": "Chat_Queue_Reports",
3425     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
3426     "version": "0.0.0",
3427     "filename": "server/api/chatQueueReport/index.js",
3428     "groupTitle": "Chat_Queue_Reports"
3429   },
3430   {
3431     "type": "get",
3432     "url": "/api/chat/reports/queue/{id}",
3433     "title": "Gets a single Chat Queue Report",
3434     "examples": [
3435       {
3436         "title": "Example usage:",
3437         "content": "curl https://{domain}/api/chat/reports/queue/{id} -v -u {name}:{password}",
3438         "type": "json"
3439       }
3440     ],
3441     "name": "ShowChat_Queue_Reports",
3442     "group": "Chat_Queue_Reports",
3443     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3444     "version": "0.0.0",
3445     "filename": "server/api/chatQueueReport/index.js",
3446     "groupTitle": "Chat_Queue_Reports"
3447   },
3448   {
3449     "type": "put",
3450     "url": "/api/chat/reports/queue/{id}",
3451     "title": "Update an existing Chat Queue Report",
3452     "examples": [
3453       {
3454         "title": "Example usage:",
3455         "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",
3456         "type": "json"
3457       }
3458     ],
3459     "name": "updateChat_Queue_Reports",
3460     "group": "Chat_Queue_Reports",
3461     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3462     "version": "0.0.0",
3463     "filename": "server/api/chatQueueReport/index.js",
3464     "groupTitle": "Chat_Queue_Reports"
3465   },
3466   {
3467     "type": "post",
3468     "url": "/api/chat/queues/{id}/users",
3469     "title": "Add agents to a queue",
3470     "examples": [
3471       {
3472         "title": "Example usage:",
3473         "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",
3474         "type": "json"
3475       }
3476     ],
3477     "name": "AddAgents",
3478     "group": "Chat_Queues",
3479     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3480     "version": "0.0.0",
3481     "filename": "server/api/chatQueue/index.js",
3482     "groupTitle": "Chat_Queues"
3483   },
3484   {
3485     "type": "post",
3486     "url": "/api/chat/queues/{id}/teams",
3487     "title": "Add teams to a queue",
3488     "examples": [
3489       {
3490         "title": "Example usage:",
3491         "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",
3492         "type": "json"
3493       }
3494     ],
3495     "name": "AddTeams",
3496     "group": "Chat_Queues",
3497     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3498     "version": "0.0.0",
3499     "filename": "server/api/chatQueue/index.js",
3500     "groupTitle": "Chat_Queues"
3501   },
3502   {
3503     "type": "post",
3504     "url": "/api/chat/queues",
3505     "title": "Creates a new Queue",
3506     "examples": [
3507       {
3508         "title": "Example usage:",
3509         "content": "curl https://{domain}/api/chat/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
3510         "type": "json"
3511       }
3512     ],
3513     "name": "CreateQueues",
3514     "group": "Chat_Queues",
3515     "parameter": {
3516       "fields": {
3517         "Body": [
3518           {
3519             "group": "Body",
3520             "type": "String",
3521             "optional": false,
3522             "field": "name",
3523             "description": ""
3524           },
3525           {
3526             "group": "Body",
3527             "type": "String",
3528             "optional": true,
3529             "field": "description",
3530             "description": ""
3531           },
3532           {
3533             "group": "Body",
3534             "type": "Integer",
3535             "optional": true,
3536             "field": "timeout",
3537             "description": ""
3538           },
3539           {
3540             "group": "Body",
3541             "type": "String",
3542             "allowedValues": [
3543               "\"rrmemory\"",
3544               "\"beepall\"",
3545               "\"roundrobin\""
3546             ],
3547             "optional": true,
3548             "field": "strategy",
3549             "description": ""
3550           }
3551         ]
3552       }
3553     },
3554     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3555     "version": "0.0.0",
3556     "filename": "server/api/chatQueue/index.js",
3557     "groupTitle": "Chat_Queues"
3558   },
3559   {
3560     "type": "delete",
3561     "url": "/api/chat/queues/{id}",
3562     "title": "Deletes a Queue",
3563     "examples": [
3564       {
3565         "title": "Example usage:",
3566         "content": "curl https://{domain}/api/chat/queues/{id} -v -u {name}:{password} -X DELETE",
3567         "type": "json"
3568       }
3569     ],
3570     "name": "DeleteQueues",
3571     "group": "Chat_Queues",
3572     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3573     "version": "0.0.0",
3574     "filename": "server/api/chatQueue/index.js",
3575     "groupTitle": "Chat_Queues"
3576   },
3577   {
3578     "type": "get",
3579     "url": "/api/chat/queues/describe",
3580     "title": "Gets table info about Queues",
3581     "examples": [
3582       {
3583         "title": "Example usage:",
3584         "content": "curl https://{domain}/api/chat/queues/describe -v -u {name}:{password}",
3585         "type": "json"
3586       }
3587     ],
3588     "name": "DescribeQueues",
3589     "group": "Chat_Queues",
3590     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3591     "version": "0.0.0",
3592     "filename": "server/api/chatQueue/index.js",
3593     "groupTitle": "Chat_Queues"
3594   },
3595   {
3596     "type": "get",
3597     "url": "/api/chat/queues/{id}/users",
3598     "title": "Gets queue agents",
3599     "examples": [
3600       {
3601         "title": "Example usage:",
3602         "content": "curl https://{domain}/api/chat/queues/{id}/users -v -u {name}:{password} -X POST",
3603         "type": "json"
3604       }
3605     ],
3606     "name": "GetAgents",
3607     "group": "Chat_Queues",
3608     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3609     "version": "0.0.0",
3610     "filename": "server/api/chatQueue/index.js",
3611     "groupTitle": "Chat_Queues"
3612   },
3613   {
3614     "type": "get",
3615     "url": "/api/chat/queues/{id}/members",
3616     "title": "GetMembers",
3617     "examples": [
3618       {
3619         "title": "Example usage:",
3620         "content": "curl https://{domain}/api/chat/queues/{id}/members  -v -u {name}:{password}",
3621         "type": "json"
3622       }
3623     ],
3624     "name": "GetMembers",
3625     "group": "Chat_Queues",
3626     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3627     "version": "0.0.0",
3628     "filename": "server/api/chatQueue/index.js",
3629     "groupTitle": "Chat_Queues"
3630   },
3631   {
3632     "type": "get",
3633     "url": "/api/chat/queues",
3634     "title": "Gets a list of Queues",
3635     "examples": [
3636       {
3637         "title": "Example usage:",
3638         "content": "curl https://{domain}/api/chat/queues -v -u {name}:{password}",
3639         "type": "json"
3640       }
3641     ],
3642     "name": "GetQueues",
3643     "group": "Chat_Queues",
3644     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
3645     "version": "0.0.0",
3646     "filename": "server/api/chatQueue/index.js",
3647     "groupTitle": "Chat_Queues"
3648   },
3649   {
3650     "type": "get",
3651     "url": "/api/chat/queues/{id}/teams",
3652     "title": "Gets queues list",
3653     "examples": [
3654       {
3655         "title": "Example usage:",
3656         "content": "curl https://{domain}/api/chat/queues/{id}/teams -v -u {name}:{password}",
3657         "type": "json"
3658       }
3659     ],
3660     "name": "GetTeams",
3661     "group": "Chat_Queues",
3662     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3663     "version": "0.0.0",
3664     "filename": "server/api/chatQueue/index.js",
3665     "groupTitle": "Chat_Queues"
3666   },
3667   {
3668     "type": "delete",
3669     "url": "/api/chat/queues/{id}/users",
3670     "title": "Removes agents from a queue",
3671     "examples": [
3672       {
3673         "title": "Example usage:",
3674         "content": "curl https://{domain}/api/chat/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
3675         "type": "json"
3676       }
3677     ],
3678     "name": "RemoveAgents",
3679     "group": "Chat_Queues",
3680     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3681     "version": "0.0.0",
3682     "filename": "server/api/chatQueue/index.js",
3683     "groupTitle": "Chat_Queues"
3684   },
3685   {
3686     "type": "get",
3687     "url": "/api/chat/queues/{id}",
3688     "title": "Gets a single Queue",
3689     "examples": [
3690       {
3691         "title": "Example usage:",
3692         "content": "curl https://{domain}/api/chat/queues/{id} -v -u {name}:{password}",
3693         "type": "json"
3694       }
3695     ],
3696     "name": "ShowQueues",
3697     "group": "Chat_Queues",
3698     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3699     "version": "0.0.0",
3700     "filename": "server/api/chatQueue/index.js",
3701     "groupTitle": "Chat_Queues"
3702   },
3703   {
3704     "type": "put",
3705     "url": "/api/chat/queues/{id}",
3706     "title": "Update an existing Queue",
3707     "examples": [
3708       {
3709         "title": "Example usage:",
3710         "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",
3711         "type": "json"
3712       }
3713     ],
3714     "name": "updateQueues",
3715     "group": "Chat_Queues",
3716     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3717     "version": "0.0.0",
3718     "filename": "server/api/chatQueue/index.js",
3719     "groupTitle": "Chat_Queues"
3720   },
3721   {
3722     "type": "post",
3723     "url": "/api/chat/reports/transfer",
3724     "title": "Creates a new Chat Transfer Report",
3725     "examples": [
3726       {
3727         "title": "Example usage:",
3728         "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",
3729         "type": "json"
3730       }
3731     ],
3732     "name": "CreateChat_Transfer_Reports",
3733     "group": "Chat_Transfer_Reports",
3734     "parameter": {
3735       "fields": {
3736         "Body": [
3737           {
3738             "group": "Body",
3739             "type": "String",
3740             "optional": false,
3741             "field": "uniqueid",
3742             "description": ""
3743           },
3744           {
3745             "group": "Body",
3746             "type": "String",
3747             "allowedValues": [
3748               "\"account\"",
3749               "\"agent\"",
3750               "\"queue\""
3751             ],
3752             "optional": false,
3753             "field": "type",
3754             "description": ""
3755           },
3756           {
3757             "group": "Body",
3758             "type": "String",
3759             "optional": false,
3760             "field": "transferredAt",
3761             "description": ""
3762           }
3763         ]
3764       }
3765     },
3766     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3767     "version": "0.0.0",
3768     "filename": "server/api/chatTransferReport/index.js",
3769     "groupTitle": "Chat_Transfer_Reports"
3770   },
3771   {
3772     "type": "delete",
3773     "url": "/api/chat/reports/transfer/{id}",
3774     "title": "Deletes a Chat Transfer Report",
3775     "examples": [
3776       {
3777         "title": "Example usage:",
3778         "content": "curl https://{domain}/api/chat/reports/transfer/{id} -v -u {name}:{password} -X DELETE",
3779         "type": "json"
3780       }
3781     ],
3782     "name": "DeleteChat_Transfer_Reports",
3783     "group": "Chat_Transfer_Reports",
3784     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3785     "version": "0.0.0",
3786     "filename": "server/api/chatTransferReport/index.js",
3787     "groupTitle": "Chat_Transfer_Reports"
3788   },
3789   {
3790     "type": "get",
3791     "url": "/api/chat/reports/transfer/describe",
3792     "title": "Gets table info about Chat Transfer Reports",
3793     "examples": [
3794       {
3795         "title": "Example usage:",
3796         "content": "curl https://{domain}/api/chat/reports/transfer/describe -v -u {name}:{password}",
3797         "type": "json"
3798       }
3799     ],
3800     "name": "DescribeChat_Transfer_Reports",
3801     "group": "Chat_Transfer_Reports",
3802     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3803     "version": "0.0.0",
3804     "filename": "server/api/chatTransferReport/index.js",
3805     "groupTitle": "Chat_Transfer_Reports"
3806   },
3807   {
3808     "type": "get",
3809     "url": "/api/chat/reports/transfer",
3810     "title": "Gets a list of Chat Transfer Reports",
3811     "examples": [
3812       {
3813         "title": "Example usage:",
3814         "content": "curl https://{domain}/api/chat/reports/transfer -v -u {name}:{password}",
3815         "type": "json"
3816       }
3817     ],
3818     "name": "GetChat_Transfer_Reports",
3819     "group": "Chat_Transfer_Reports",
3820     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
3821     "version": "0.0.0",
3822     "filename": "server/api/chatTransferReport/index.js",
3823     "groupTitle": "Chat_Transfer_Reports"
3824   },
3825   {
3826     "type": "get",
3827     "url": "/api/chat/reports/transfer/{id}",
3828     "title": "Gets a single Chat Transfer Report",
3829     "examples": [
3830       {
3831         "title": "Example usage:",
3832         "content": "curl https://{domain}/api/chat/reports/transfer/{id} -v -u {name}:{password}",
3833         "type": "json"
3834       }
3835     ],
3836     "name": "ShowChat_Transfer_Reports",
3837     "group": "Chat_Transfer_Reports",
3838     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3839     "version": "0.0.0",
3840     "filename": "server/api/chatTransferReport/index.js",
3841     "groupTitle": "Chat_Transfer_Reports"
3842   },
3843   {
3844     "type": "put",
3845     "url": "/api/chat/reports/transfer/{id}",
3846     "title": "Update an existing Chat Transfer Report",
3847     "examples": [
3848       {
3849         "title": "Example usage:",
3850         "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",
3851         "type": "json"
3852       }
3853     ],
3854     "name": "updateChat_Transfer_Reports",
3855     "group": "Chat_Transfer_Reports",
3856     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3857     "version": "0.0.0",
3858     "filename": "server/api/chatTransferReport/index.js",
3859     "groupTitle": "Chat_Transfer_Reports"
3860   },
3861   {
3862     "type": "post",
3863     "url": "/api/chat/websites/{id}/users",
3864     "title": "Add agents to a website",
3865     "examples": [
3866       {
3867         "title": "Example usage:",
3868         "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",
3869         "type": "json"
3870       }
3871     ],
3872     "name": "AddAgents",
3873     "group": "Chat_Websites",
3874     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3875     "version": "0.0.0",
3876     "filename": "server/api/chatWebsite/index.js",
3877     "groupTitle": "Chat_Websites"
3878   },
3879   {
3880     "type": "post",
3881     "url": "/api/chat/websites",
3882     "title": "Creates a new Website",
3883     "examples": [
3884       {
3885         "title": "Example usage:",
3886         "content": "curl https://{domain}/api/chat/websites -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
3887         "type": "json"
3888       }
3889     ],
3890     "name": "CreateWebsites",
3891     "group": "Chat_Websites",
3892     "parameter": {
3893       "fields": {
3894         "Body": [
3895           {
3896             "group": "Body",
3897             "type": "String",
3898             "optional": false,
3899             "field": "name",
3900             "description": ""
3901           },
3902           {
3903             "group": "Body",
3904             "type": "String",
3905             "optional": false,
3906             "field": "address",
3907             "description": ""
3908           },
3909           {
3910             "group": "Body",
3911             "type": "String",
3912             "optional": true,
3913             "field": "description",
3914             "description": ""
3915           },
3916           {
3917             "group": "Body",
3918             "type": "String",
3919             "optional": true,
3920             "field": "mapKey",
3921             "description": ""
3922           },
3923           {
3924             "group": "Body",
3925             "type": "String",
3926             "optional": true,
3927             "field": "mapKeyOffline",
3928             "description": ""
3929           },
3930           {
3931             "group": "Body",
3932             "type": "String",
3933             "optional": false,
3934             "field": "key",
3935             "description": ""
3936           },
3937           {
3938             "group": "Body",
3939             "type": "String",
3940             "optional": true,
3941             "field": "agentAlias",
3942             "description": ""
3943           },
3944           {
3945             "group": "Body",
3946             "type": "String",
3947             "optional": true,
3948             "field": "customerAlias",
3949             "description": ""
3950           },
3951           {
3952             "group": "Body",
3953             "type": "String",
3954             "optional": false,
3955             "field": "color",
3956             "description": ""
3957           },
3958           {
3959             "group": "Body",
3960             "type": "String",
3961             "optional": false,
3962             "field": "color_button",
3963             "description": ""
3964           },
3965           {
3966             "group": "Body",
3967             "type": "String",
3968             "optional": false,
3969             "field": "textColor",
3970             "description": ""
3971           },
3972           {
3973             "group": "Body",
3974             "type": "Integer",
3975             "optional": true,
3976             "field": "fontSize",
3977             "description": ""
3978           },
3979           {
3980             "group": "Body",
3981             "type": "String",
3982             "optional": true,
3983             "field": "remote",
3984             "description": ""
3985           },
3986           {
3987             "group": "Body",
3988             "type": "Boolean",
3989             "optional": true,
3990             "field": "animation",
3991             "description": ""
3992           },
3993           {
3994             "group": "Body",
3995             "type": "String",
3996             "allowedValues": [
3997               "\"rounded\"",
3998               "\"squared\""
3999             ],
4000             "optional": true,
4001             "field": "header_shape",
4002             "description": ""
4003           },
4004           {
4005             "group": "Body",
4006             "type": "String",
4007             "optional": true,
4008             "field": "header_online",
4009             "description": ""
4010           },
4011           {
4012             "group": "Body",
4013             "type": "String",
4014             "optional": true,
4015             "field": "start_chat_button",
4016             "description": ""
4017           },
4018           {
4019             "group": "Body",
4020             "type": "String",
4021             "optional": true,
4022             "field": "offline_chat_button",
4023             "description": ""
4024           },
4025           {
4026             "group": "Body",
4027             "type": "String",
4028             "optional": true,
4029             "field": "header_offline",
4030             "description": ""
4031           },
4032           {
4033             "group": "Body",
4034             "type": "Boolean",
4035             "optional": true,
4036             "field": "download_transcript",
4037             "description": ""
4038           },
4039           {
4040             "group": "Body",
4041             "type": "Integer",
4042             "optional": true,
4043             "field": "timeout",
4044             "description": ""
4045           },
4046           {
4047             "group": "Body",
4048             "type": "String",
4049             "optional": true,
4050             "field": "whiteLabel",
4051             "description": ""
4052           },
4053           {
4054             "group": "Body",
4055             "type": "Boolean",
4056             "optional": true,
4057             "field": "defaultWhiteLabel",
4058             "description": ""
4059           },
4060           {
4061             "group": "Body",
4062             "type": "Text",
4063             "optional": true,
4064             "field": "sitepic",
4065             "description": ""
4066           },
4067           {
4068             "group": "Body",
4069             "type": "String",
4070             "optional": true,
4071             "field": "closingQuestion",
4072             "description": ""
4073           },
4074           {
4075             "group": "Body",
4076             "type": "String",
4077             "optional": true,
4078             "field": "formSubmitSuccessMessage",
4079             "description": ""
4080           },
4081           {
4082             "group": "Body",
4083             "type": "String",
4084             "optional": true,
4085             "field": "formSubmitFailureMessage",
4086             "description": ""
4087           },
4088           {
4089             "group": "Body",
4090             "type": "String",
4091             "optional": true,
4092             "field": "noteTitle",
4093             "description": ""
4094           },
4095           {
4096             "group": "Body",
4097             "type": "String",
4098             "optional": true,
4099             "field": "placeholderMessage",
4100             "description": ""
4101           },
4102           {
4103             "group": "Body",
4104             "type": "String",
4105             "optional": true,
4106             "field": "closingMessage",
4107             "description": ""
4108           },
4109           {
4110             "group": "Body",
4111             "type": "String",
4112             "optional": true,
4113             "field": "closingMessageButton",
4114             "description": ""
4115           },
4116           {
4117             "group": "Body",
4118             "type": "String",
4119             "optional": true,
4120             "field": "skipMessageButton",
4121             "description": ""
4122           },
4123           {
4124             "group": "Body",
4125             "type": "Boolean",
4126             "optional": true,
4127             "field": "conditionAgreement",
4128             "description": ""
4129           },
4130           {
4131             "group": "Body",
4132             "type": "Boolean",
4133             "optional": true,
4134             "field": "enableRating",
4135             "description": ""
4136           },
4137           {
4138             "group": "Body",
4139             "type": "Boolean",
4140             "optional": true,
4141             "field": "enableFeedback",
4142             "description": ""
4143           },
4144           {
4145             "group": "Body",
4146             "type": "Boolean",
4147             "optional": true,
4148             "field": "enableSendButton",
4149             "description": ""
4150           },
4151           {
4152             "group": "Body",
4153             "type": "String",
4154             "optional": true,
4155             "field": "feedbackTitle",
4156             "description": ""
4157           },
4158           {
4159             "group": "Body",
4160             "type": "String",
4161             "allowedValues": [
4162               "\"star\"",
4163               "\"thumb\""
4164             ],
4165             "optional": true,
4166             "field": "ratingType",
4167             "description": ""
4168           },
4169           {
4170             "group": "Body",
4171             "type": "Integer",
4172             "optional": true,
4173             "field": "ratingStarsNumber",
4174             "description": ""
4175           },
4176           {
4177             "group": "Body",
4178             "type": "Text",
4179             "optional": true,
4180             "field": "onlineForm",
4181             "description": ""
4182           },
4183           {
4184             "group": "Body",
4185             "type": "Text",
4186             "optional": true,
4187             "field": "offlineForm",
4188             "description": ""
4189           },
4190           {
4191             "group": "Body",
4192             "type": "String",
4193             "optional": true,
4194             "field": "token",
4195             "description": ""
4196           },
4197           {
4198             "group": "Body",
4199             "type": "Boolean",
4200             "optional": true,
4201             "field": "autoclose",
4202             "description": ""
4203           },
4204           {
4205             "group": "Body",
4206             "type": "Boolean",
4207             "optional": true,
4208             "field": "enableCustomerWriting",
4209             "description": ""
4210           },
4211           {
4212             "group": "Body",
4213             "type": "Boolean",
4214             "optional": true,
4215             "field": "forwardTranscript",
4216             "description": ""
4217           },
4218           {
4219             "group": "Body",
4220             "type": "String",
4221             "optional": true,
4222             "field": "forwardTranscriptMessage",
4223             "description": ""
4224           },
4225           {
4226             "group": "Body",
4227             "type": "Boolean",
4228             "optional": true,
4229             "field": "forwardOffline",
4230             "description": ""
4231           },
4232           {
4233             "group": "Body",
4234             "type": "String",
4235             "optional": true,
4236             "field": "forwardOfflineAddress",
4237             "description": ""
4238           },
4239           {
4240             "group": "Body",
4241             "type": "String",
4242             "optional": true,
4243             "field": "waitingTitle",
4244             "description": ""
4245           },
4246           {
4247             "group": "Body",
4248             "type": "String",
4249             "optional": true,
4250             "field": "waitingMessage",
4251             "description": ""
4252           },
4253           {
4254             "group": "Body",
4255             "type": "String",
4256             "optional": true,
4257             "field": "offlineMessageSubject",
4258             "description": ""
4259           },
4260           {
4261             "group": "Body",
4262             "type": "String",
4263             "optional": true,
4264             "field": "offlineMessageBody",
4265             "description": ""
4266           },
4267           {
4268             "group": "Body",
4269             "type": "Boolean",
4270             "optional": true,
4271             "field": "enableUnmanagedNote",
4272             "description": ""
4273           },
4274           {
4275             "group": "Body",
4276             "type": "String",
4277             "optional": true,
4278             "field": "unmanagedMessage",
4279             "description": ""
4280           },
4281           {
4282             "group": "Body",
4283             "type": "String",
4284             "optional": true,
4285             "field": "skipUnmanaged",
4286             "description": ""
4287           },
4288           {
4289             "group": "Body",
4290             "type": "String",
4291             "optional": true,
4292             "field": "sendUnmanaged",
4293             "description": ""
4294           },
4295           {
4296             "group": "Body",
4297             "type": "Boolean",
4298             "optional": true,
4299             "field": "enableCustomerAttachment",
4300             "description": ""
4301           },
4302           {
4303             "group": "Body",
4304             "type": "Boolean",
4305             "optional": true,
4306             "field": "enableCustomerCheckmarks",
4307             "description": ""
4308           },
4309           {
4310             "group": "Body",
4311             "type": "Text",
4312             "optional": true,
4313             "field": "agentAvatar",
4314             "description": ""
4315           },
4316           {
4317             "group": "Body",
4318             "type": "Boolean",
4319             "optional": true,
4320             "field": "showAgentAvatar",
4321             "description": ""
4322           },
4323           {
4324             "group": "Body",
4325             "type": "String",
4326             "optional": true,
4327             "field": "timezone",
4328             "description": ""
4329           },
4330           {
4331             "group": "Body",
4332             "type": "Text",
4333             "optional": true,
4334             "field": "notificationTemplate",
4335             "description": ""
4336           },
4337           {
4338             "group": "Body",
4339             "type": "Boolean",
4340             "optional": true,
4341             "field": "notificationSound",
4342             "description": ""
4343           },
4344           {
4345             "group": "Body",
4346             "type": "Boolean",
4347             "optional": true,
4348             "field": "notificationShake",
4349             "description": ""
4350           },
4351           {
4352             "group": "Body",
4353             "type": "Boolean",
4354             "optional": true,
4355             "field": "hideWhenOffline",
4356             "description": ""
4357           },
4358           {
4359             "group": "Body",
4360             "type": "String",
4361             "optional": true,
4362             "field": "agentIdentifier",
4363             "description": ""
4364           },
4365           {
4366             "group": "Body",
4367             "type": "Integer",
4368             "optional": true,
4369             "field": "waitForTheAssignedAgent",
4370             "description": ""
4371           },
4372           {
4373             "group": "Body",
4374             "type": "String",
4375             "optional": true,
4376             "field": "alignment",
4377             "description": ""
4378           },
4379           {
4380             "group": "Body",
4381             "type": "Integer",
4382             "optional": true,
4383             "field": "verticalAlignment",
4384             "description": ""
4385           },
4386           {
4387             "group": "Body",
4388             "type": "String",
4389             "optional": true,
4390             "field": "labelText",
4391             "description": ""
4392           },
4393           {
4394             "group": "Body",
4395             "type": "String",
4396             "optional": true,
4397             "field": "messagesAlignment",
4398             "description": ""
4399           },
4400           {
4401             "group": "Body",
4402             "type": "String",
4403             "optional": true,
4404             "field": "defaultTitle",
4405             "description": ""
4406           },
4407           {
4408             "group": "Body",
4409             "type": "Text",
4410             "optional": true,
4411             "field": "customerAvatar",
4412             "description": ""
4413           },
4414           {
4415             "group": "Body",
4416             "type": "Boolean",
4417             "optional": true,
4418             "field": "showCustomerAvatar",
4419             "description": ""
4420           },
4421           {
4422             "group": "Body",
4423             "type": "Integer",
4424             "optional": true,
4425             "field": "messageFontSize",
4426             "description": ""
4427           },
4428           {
4429             "group": "Body",
4430             "type": "String",
4431             "optional": false,
4432             "field": "backgroundColor",
4433             "description": ""
4434           },
4435           {
4436             "group": "Body",
4437             "type": "Boolean",
4438             "optional": true,
4439             "field": "queueTransfer",
4440             "description": ""
4441           },
4442           {
4443             "group": "Body",
4444             "type": "Integer",
4445             "optional": true,
4446             "field": "queueTransferTimeout",
4447             "description": ""
4448           },
4449           {
4450             "group": "Body",
4451             "type": "Boolean",
4452             "optional": true,
4453             "field": "agentTransfer",
4454             "description": ""
4455           },
4456           {
4457             "group": "Body",
4458             "type": "Integer",
4459             "optional": true,
4460             "field": "agentTransferTimeout",
4461             "description": ""
4462           },
4463           {
4464             "group": "Body",
4465             "type": "String",
4466             "optional": true,
4467             "field": "systemAlias",
4468             "description": ""
4469           },
4470           {
4471             "group": "Body",
4472             "type": "Text",
4473             "optional": true,
4474             "field": "systemAvatar",
4475             "description": ""
4476           },
4477           {
4478             "group": "Body",
4479             "type": "Integer",
4480             "optional": true,
4481             "field": "mandatoryDispositionPauseId",
4482             "description": "<p>Status to put when mandatory disposition is enabled</p>"
4483           },
4484           {
4485             "group": "Body",
4486             "type": "Boolean",
4487             "optional": true,
4488             "field": "mandatoryDisposition",
4489             "description": "<p>Enabled/disables mandatory dispo on a queue</p>"
4490           },
4491           {
4492             "group": "Body",
4493             "type": "Boolean",
4494             "optional": true,
4495             "field": "vidaooEscalation",
4496             "description": ""
4497           },
4498           {
4499             "group": "Body",
4500             "type": "String",
4501             "optional": true,
4502             "field": "vidaooApiKey",
4503             "description": ""
4504           },
4505           {
4506             "group": "Body",
4507             "type": "String",
4508             "optional": false,
4509             "field": "vidaooTopic",
4510             "description": ""
4511           },
4512           {
4513             "group": "Body",
4514             "type": "String",
4515             "optional": true,
4516             "field": "vidaooNote",
4517             "description": ""
4518           },
4519           {
4520             "group": "Body",
4521             "type": "Text",
4522             "optional": true,
4523             "field": "vidaooMetadata",
4524             "description": ""
4525           },
4526           {
4527             "group": "Body",
4528             "type": "Boolean",
4529             "optional": true,
4530             "field": "openNewInteraction",
4531             "description": ""
4532           },
4533           {
4534             "group": "Body",
4535             "type": "Text",
4536             "optional": true,
4537             "field": "subjectOffline",
4538             "description": ""
4539           }
4540         ]
4541       }
4542     },
4543     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4544     "version": "0.0.0",
4545     "filename": "server/api/chatWebsite/index.js",
4546     "groupTitle": "Chat_Websites"
4547   },
4548   {
4549     "type": "delete",
4550     "url": "/api/chat/websites/{id}",
4551     "title": "Deletes a Website",
4552     "examples": [
4553       {
4554         "title": "Example usage:",
4555         "content": "curl https://{domain}/api/chat/websites/{id} -v -u {name}:{password} -X DELETE",
4556         "type": "json"
4557       }
4558     ],
4559     "name": "DeleteWebsites",
4560     "group": "Chat_Websites",
4561     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4562     "version": "0.0.0",
4563     "filename": "server/api/chatWebsite/index.js",
4564     "groupTitle": "Chat_Websites"
4565   },
4566   {
4567     "type": "get",
4568     "url": "/api/chat/websites/describe",
4569     "title": "Gets table info about Websites",
4570     "examples": [
4571       {
4572         "title": "Example usage:",
4573         "content": "curl https://{domain}/api/chat/websites/describe -v -u {name}:{password}",
4574         "type": "json"
4575       }
4576     ],
4577     "name": "DescribeWebsites",
4578     "group": "Chat_Websites",
4579     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4580     "version": "0.0.0",
4581     "filename": "server/api/chatWebsite/index.js",
4582     "groupTitle": "Chat_Websites"
4583   },
4584   {
4585     "type": "get",
4586     "url": "/api/chat/websites/{id}/users",
4587     "title": "Gets agents from website",
4588     "examples": [
4589       {
4590         "title": "Example usage:",
4591         "content": "curl https://{domain}/api/chat/websites/{id}/users -v -u {name}:{password} -X GET",
4592         "type": "json"
4593       }
4594     ],
4595     "name": "GetAgents",
4596     "group": "Chat_Websites",
4597     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4598     "version": "0.0.0",
4599     "filename": "server/api/chatWebsite/index.js",
4600     "groupTitle": "Chat_Websites"
4601   },
4602   {
4603     "type": "get",
4604     "url": "/api/chat/websites",
4605     "title": "Gets a list of Websites",
4606     "examples": [
4607       {
4608         "title": "Example usage:",
4609         "content": "curl https://{domain}/api/chat/websites -v -u {name}:{password}",
4610         "type": "json"
4611       }
4612     ],
4613     "name": "GetWebsites",
4614     "group": "Chat_Websites",
4615     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
4616     "version": "0.0.0",
4617     "filename": "server/api/chatWebsite/index.js",
4618     "groupTitle": "Chat_Websites"
4619   },
4620   {
4621     "type": "delete",
4622     "url": "/api/chat/websites/{id}/users",
4623     "title": "Removes agents from a website",
4624     "examples": [
4625       {
4626         "title": "Example usage:",
4627         "content": "curl https://{domain}/api/chat/websites/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
4628         "type": "json"
4629       }
4630     ],
4631     "name": "RemoveAgents",
4632     "group": "Chat_Websites",
4633     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4634     "version": "0.0.0",
4635     "filename": "server/api/chatWebsite/index.js",
4636     "groupTitle": "Chat_Websites"
4637   },
4638   {
4639     "type": "delete",
4640     "url": "/api/chat/websites/{id}/canned_answers",
4641     "title": "Removes canned answers from account",
4642     "examples": [
4643       {
4644         "title": "Example usage:",
4645         "content": "curl https://{domain}/api/chat/websites/{id}/canned_answers?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
4646         "type": "json"
4647       }
4648     ],
4649     "name": "RemoveAnswers",
4650     "group": "Chat_Websites",
4651     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4652     "version": "0.0.0",
4653     "filename": "server/api/chatWebsite/index.js",
4654     "groupTitle": "Chat_Websites"
4655   },
4656   {
4657     "type": "delete",
4658     "url": "/api/chat/websites/{id}/dispositions",
4659     "title": "Removes canned answers from account",
4660     "examples": [
4661       {
4662         "title": "Example usage:",
4663         "content": "curl https://{domain}/api/chat/websites/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
4664         "type": "json"
4665       }
4666     ],
4667     "name": "RemoveDispositions",
4668     "group": "Chat_Websites",
4669     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4670     "version": "0.0.0",
4671     "filename": "server/api/chatWebsite/index.js",
4672     "groupTitle": "Chat_Websites"
4673   },
4674   {
4675     "type": "get",
4676     "url": "/api/chat/websites/{id}",
4677     "title": "Gets a single Website",
4678     "examples": [
4679       {
4680         "title": "Example usage:",
4681         "content": "curl https://{domain}/api/chat/websites/{id} -v -u {name}:{password}",
4682         "type": "json"
4683       }
4684     ],
4685     "name": "ShowWebsites",
4686     "group": "Chat_Websites",
4687     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4688     "version": "0.0.0",
4689     "filename": "server/api/chatWebsite/index.js",
4690     "groupTitle": "Chat_Websites"
4691   },
4692   {
4693     "type": "put",
4694     "url": "/api/chat/messages/{id}/accept",
4695     "title": "Accepts message",
4696     "examples": [
4697       {
4698         "title": "Example usage:",
4699         "content": "curl https://{domain}/api/chat/messages/{id}/accept \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
4700         "type": "json"
4701       }
4702     ],
4703     "name": "acceptMessage",
4704     "group": "Chat_Websites",
4705     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4706     "version": "0.0.0",
4707     "filename": "server/api/chatMessage/index.js",
4708     "groupTitle": "Chat_Websites"
4709   },
4710   {
4711     "type": "post",
4712     "url": "/api/chat/websites/{id}/canned_answers",
4713     "title": "Creates new canned answer",
4714     "examples": [
4715       {
4716         "title": "Example usage:",
4717         "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",
4718         "type": "json"
4719       }
4720     ],
4721     "name": "addAnswer",
4722     "group": "Chat_Websites",
4723     "parameter": {
4724       "fields": {
4725         "Body": [
4726           {
4727             "group": "Body",
4728             "type": "String",
4729             "optional": false,
4730             "field": "key",
4731             "description": ""
4732           },
4733           {
4734             "group": "Body",
4735             "type": "Text",
4736             "optional": false,
4737             "field": "value",
4738             "description": ""
4739           },
4740           {
4741             "group": "Body",
4742             "type": "String",
4743             "optional": true,
4744             "field": "description",
4745             "description": ""
4746           },
4747           {
4748             "group": "Body",
4749             "type": "Virtual",
4750             "optional": true,
4751             "field": "name",
4752             "description": ""
4753           }
4754         ]
4755       }
4756     },
4757     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4758     "version": "0.0.0",
4759     "filename": "server/api/chatWebsite/index.js",
4760     "groupTitle": "Chat_Websites"
4761   },
4762   {
4763     "type": "post",
4764     "url": "/api/chat/websites/{id}/applications",
4765     "title": "Creates new applications",
4766     "examples": [
4767       {
4768         "title": "Example usage:",
4769         "content": "curl https://{domain}/api/chat/websites/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
4770         "type": "json"
4771       }
4772     ],
4773     "name": "addApplications",
4774     "group": "Chat_Websites",
4775     "parameter": {
4776       "fields": {
4777         "Body": [
4778           {
4779             "group": "Body",
4780             "type": "Integer",
4781             "optional": false,
4782             "field": "priority",
4783             "description": ""
4784           },
4785           {
4786             "group": "Body",
4787             "type": "String",
4788             "optional": false,
4789             "field": "app",
4790             "description": ""
4791           },
4792           {
4793             "group": "Body",
4794             "type": "Text",
4795             "optional": true,
4796             "field": "appdata",
4797             "description": ""
4798           },
4799           {
4800             "group": "Body",
4801             "type": "String",
4802             "optional": true,
4803             "field": "description",
4804             "description": ""
4805           },
4806           {
4807             "group": "Body",
4808             "type": "String",
4809             "optional": true,
4810             "field": "interval",
4811             "description": ""
4812           }
4813         ]
4814       }
4815     },
4816     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4817     "version": "0.0.0",
4818     "filename": "server/api/chatWebsite/index.js",
4819     "groupTitle": "Chat_Websites"
4820   },
4821   {
4822     "type": "post",
4823     "url": "/api/chat/websites/{id}/avatar",
4824     "title": "Add avatar",
4825     "examples": [
4826       {
4827         "title": "Example usage:",
4828         "content": "curl https://{domain}/api/chat/websites/{id}/avatar -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
4829         "type": "json"
4830       }
4831     ],
4832     "name": "addAvatar",
4833     "group": "Chat_Websites",
4834     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4835     "version": "0.0.0",
4836     "filename": "server/api/chatWebsite/index.js",
4837     "groupTitle": "Chat_Websites"
4838   },
4839   {
4840     "type": "post",
4841     "url": "/api/chat/websites/{id}/customer_avatar",
4842     "title": "Add customer avatar",
4843     "examples": [
4844       {
4845         "title": "Example usage:",
4846         "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",
4847         "type": "json"
4848       }
4849     ],
4850     "name": "addCustomerAvatar",
4851     "group": "Chat_Websites",
4852     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4853     "version": "0.0.0",
4854     "filename": "server/api/chatWebsite/index.js",
4855     "groupTitle": "Chat_Websites"
4856   },
4857   {
4858     "type": "post",
4859     "url": "/api/chat/websites/{id}/dispositions",
4860     "title": "Creates new disposition",
4861     "examples": [
4862       {
4863         "title": "Example usage:",
4864         "content": "curl https://{domain}/api/chat/websites/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
4865         "type": "json"
4866       }
4867     ],
4868     "name": "addDisposition",
4869     "group": "Chat_Websites",
4870     "parameter": {
4871       "fields": {
4872         "Body": [
4873           {
4874             "group": "Body",
4875             "type": "String",
4876             "optional": false,
4877             "field": "name",
4878             "description": ""
4879           },
4880           {
4881             "group": "Body",
4882             "type": "String",
4883             "allowedValues": [
4884               "\"first\"",
4885               "\"second\"",
4886               "\"third\""
4887             ],
4888             "optional": false,
4889             "field": "level",
4890             "description": ""
4891           },
4892           {
4893             "group": "Body",
4894             "type": "String",
4895             "optional": true,
4896             "field": "description",
4897             "description": ""
4898           }
4899         ]
4900       }
4901     },
4902     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4903     "version": "0.0.0",
4904     "filename": "server/api/chatWebsite/index.js",
4905     "groupTitle": "Chat_Websites"
4906   },
4907   {
4908     "type": "post",
4909     "url": "/api/chat/accounts/{id}/interactions",
4910     "title": "Creates new interactions",
4911     "examples": [
4912       {
4913         "title": "Example usage:",
4914         "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",
4915         "type": "json"
4916       }
4917     ],
4918     "name": "addInteraction",
4919     "group": "Chat_Websites",
4920     "parameter": {
4921       "fields": {
4922         "Body": [
4923           {
4924             "group": "Body",
4925             "type": "Boolean",
4926             "optional": true,
4927             "field": "closed",
4928             "description": ""
4929           },
4930           {
4931             "group": "Body",
4932             "type": "Integer",
4933             "optional": true,
4934             "field": "ratingValue",
4935             "description": ""
4936           },
4937           {
4938             "group": "Body",
4939             "type": "String",
4940             "allowedValues": [
4941               "\"star\"",
4942               "\"thumb\""
4943             ],
4944             "optional": true,
4945             "field": "ratingType",
4946             "description": ""
4947           },
4948           {
4949             "group": "Body",
4950             "type": "Text",
4951             "optional": true,
4952             "field": "ratingMessage",
4953             "description": ""
4954           },
4955           {
4956             "group": "Body",
4957             "type": "Text",
4958             "optional": true,
4959             "field": "pathTranscript",
4960             "description": ""
4961           },
4962           {
4963             "group": "Body",
4964             "type": "String",
4965             "optional": true,
4966             "field": "mailTranscript",
4967             "description": ""
4968           },
4969           {
4970             "group": "Body",
4971             "type": "String",
4972             "optional": true,
4973             "field": "closedAt",
4974             "description": ""
4975           },
4976           {
4977             "group": "Body",
4978             "type": "String",
4979             "optional": true,
4980             "field": "disposition",
4981             "description": ""
4982           },
4983           {
4984             "group": "Body",
4985             "type": "String",
4986             "optional": true,
4987             "field": "secondDisposition",
4988             "description": ""
4989           },
4990           {
4991             "group": "Body",
4992             "type": "String",
4993             "optional": true,
4994             "field": "thirdDisposition",
4995             "description": ""
4996           },
4997           {
4998             "group": "Body",
4999             "type": "String",
5000             "optional": true,
5001             "field": "note",
5002             "description": ""
5003           },
5004           {
5005             "group": "Body",
5006             "type": "String",
5007             "optional": true,
5008             "field": "browserName",
5009             "description": ""
5010           },
5011           {
5012             "group": "Body",
5013             "type": "String",
5014             "optional": true,
5015             "field": "browserVersion",
5016             "description": ""
5017           },
5018           {
5019             "group": "Body",
5020             "type": "String",
5021             "optional": true,
5022             "field": "osName",
5023             "description": ""
5024           },
5025           {
5026             "group": "Body",
5027             "type": "String",
5028             "optional": true,
5029             "field": "osVersion",
5030             "description": ""
5031           },
5032           {
5033             "group": "Body",
5034             "type": "String",
5035             "optional": true,
5036             "field": "deviceModel",
5037             "description": ""
5038           },
5039           {
5040             "group": "Body",
5041             "type": "String",
5042             "optional": true,
5043             "field": "deviceVendor",
5044             "description": ""
5045           },
5046           {
5047             "group": "Body",
5048             "type": "String",
5049             "optional": true,
5050             "field": "deviceType",
5051             "description": ""
5052           },
5053           {
5054             "group": "Body",
5055             "type": "Text",
5056             "optional": true,
5057             "field": "referer",
5058             "description": ""
5059           },
5060           {
5061             "group": "Body",
5062             "type": "String",
5063             "optional": true,
5064             "field": "customerIp",
5065             "description": ""
5066           },
5067           {
5068             "group": "Body",
5069             "type": "Text",
5070             "optional": true,
5071             "field": "formData",
5072             "description": ""
5073           },
5074           {
5075             "group": "Body",
5076             "type": "String",
5077             "optional": true,
5078             "field": "read1stAt",
5079             "description": ""
5080           },
5081           {
5082             "group": "Body",
5083             "type": "String",
5084             "optional": true,
5085             "field": "lastMsgAt",
5086             "description": ""
5087           },
5088           {
5089             "group": "Body",
5090             "type": "String",
5091             "allowedValues": [
5092               "\"in\"",
5093               "\"out\""
5094             ],
5095             "optional": false,
5096             "field": "lastMsgDirection",
5097             "description": ""
5098           },
5099           {
5100             "group": "Body",
5101             "type": "String",
5102             "optional": true,
5103             "field": "closeReason",
5104             "description": ""
5105           },
5106           {
5107             "group": "Body",
5108             "type": "String",
5109             "optional": true,
5110             "field": "customerPort",
5111             "description": ""
5112           },
5113           {
5114             "group": "Body",
5115             "type": "Text",
5116             "optional": true,
5117             "field": "vidaooSessionId",
5118             "description": ""
5119           },
5120           {
5121             "group": "Body",
5122             "type": "Boolean",
5123             "optional": true,
5124             "field": "autoreplyExecuted",
5125             "description": ""
5126           }
5127         ]
5128       }
5129     },
5130     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5131     "version": "0.0.0",
5132     "filename": "server/api/chatWebsite/index.js",
5133     "groupTitle": "Chat_Websites"
5134   },
5135   {
5136     "type": "post",
5137     "url": "/api/chat/websites/{id}/logo",
5138     "title": "Add logo",
5139     "examples": [
5140       {
5141         "title": "Example usage:",
5142         "content": "curl https://{domain}/api/chat/websites/{id}/logo -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
5143         "type": "json"
5144       }
5145     ],
5146     "name": "addLogo",
5147     "group": "Chat_Websites",
5148     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5149     "version": "0.0.0",
5150     "filename": "server/api/chatWebsite/index.js",
5151     "groupTitle": "Chat_Websites"
5152   },
5153   {
5154     "type": "post",
5155     "url": "/api/chat/websites/{id}/proactive_actions",
5156     "title": "Creates new Proactive Actions",
5157     "examples": [
5158       {
5159         "title": "Example usage:",
5160         "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",
5161         "type": "json"
5162       }
5163     ],
5164     "name": "addProactiveActions",
5165     "group": "Chat_Websites",
5166     "parameter": {
5167       "fields": {
5168         "Body": [
5169           {
5170             "group": "Body",
5171             "type": "String",
5172             "optional": false,
5173             "field": "name",
5174             "description": ""
5175           },
5176           {
5177             "group": "Body",
5178             "type": "String",
5179             "allowedValues": [
5180               "\"mouseOver\"",
5181               "\"timeout\""
5182             ],
5183             "optional": true,
5184             "field": "type",
5185             "description": ""
5186           },
5187           {
5188             "group": "Body",
5189             "type": "String",
5190             "optional": true,
5191             "field": "selector",
5192             "description": ""
5193           },
5194           {
5195             "group": "Body",
5196             "type": "Integer",
5197             "optional": true,
5198             "field": "timeout",
5199             "description": ""
5200           }
5201         ]
5202       }
5203     },
5204     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5205     "version": "0.0.0",
5206     "filename": "server/api/chatWebsite/index.js",
5207     "groupTitle": "Chat_Websites"
5208   },
5209   {
5210     "type": "post",
5211     "url": "/api/chat/websites/{id}/system_avatar",
5212     "title": "Add system avatar",
5213     "examples": [
5214       {
5215         "title": "Example usage:",
5216         "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",
5217         "type": "json"
5218       }
5219     ],
5220     "name": "addSystemAvatar",
5221     "group": "Chat_Websites",
5222     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5223     "version": "0.0.0",
5224     "filename": "server/api/chatWebsite/index.js",
5225     "groupTitle": "Chat_Websites"
5226   },
5227   {
5228     "type": "get",
5229     "url": "/api/chat/websites/{id}/canned_answers",
5230     "title": "Gets account canned answers",
5231     "examples": [
5232       {
5233         "title": "Example usage:",
5234         "content": "curl https://{domain}/api/chat/websites/{id}/canned_answers -v -u {name}:{password} -X GET",
5235         "type": "json"
5236       }
5237     ],
5238     "name": "getAnswers",
5239     "group": "Chat_Websites",
5240     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5241     "version": "0.0.0",
5242     "filename": "server/api/chatWebsite/index.js",
5243     "groupTitle": "Chat_Websites"
5244   },
5245   {
5246     "type": "get",
5247     "url": "/api/chat/websites/{id}/applications",
5248     "title": "Gets Website Applications",
5249     "examples": [
5250       {
5251         "title": "Example usage:",
5252         "content": "curl https://{domain}/api/chat/websites/{id}/applications -v -u {name}:{password} -X GET",
5253         "type": "json"
5254       }
5255     ],
5256     "name": "getApplications",
5257     "group": "Chat_Websites",
5258     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5259     "version": "0.0.0",
5260     "filename": "server/api/chatWebsite/index.js",
5261     "groupTitle": "Chat_Websites"
5262   },
5263   {
5264     "type": "get",
5265     "url": "/api/chat/websites/{id}/avatar",
5266     "title": "Get avatar",
5267     "examples": [
5268       {
5269         "title": "Example usage:",
5270         "content": "curl https://{domain}/api/chat/websites/{id}/avatar -v -u {name}:{password} -X GET",
5271         "type": "json"
5272       }
5273     ],
5274     "name": "getAvatar",
5275     "group": "Chat_Websites",
5276     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5277     "version": "0.0.0",
5278     "filename": "server/api/chatWebsite/index.js",
5279     "groupTitle": "Chat_Websites"
5280   },
5281   {
5282     "type": "get",
5283     "url": "/api/chat/websites/{id}/customer_avatar",
5284     "title": "Get Customer Avatar",
5285     "examples": [
5286       {
5287         "title": "Example usage:",
5288         "content": "curl https://{domain}/api/chat/websites/{id}/customer_avatar -v -u {name}:{password} -X GET",
5289         "type": "json"
5290       }
5291     ],
5292     "name": "getCustomerAvatar",
5293     "group": "Chat_Websites",
5294     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5295     "version": "0.0.0",
5296     "filename": "server/api/chatWebsite/index.js",
5297     "groupTitle": "Chat_Websites"
5298   },
5299   {
5300     "type": "get",
5301     "url": "/api/chat/websites/{id}/dispositions",
5302     "title": "Gets account dispositions",
5303     "examples": [
5304       {
5305         "title": "Example usage:",
5306         "content": "curl https://{domain}/api/chat/websites/{id}/dispositions -v -u {name}:{password} -X GET",
5307         "type": "json"
5308       }
5309     ],
5310     "name": "getDispositions",
5311     "group": "Chat_Websites",
5312     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5313     "version": "0.0.0",
5314     "filename": "server/api/chatWebsite/index.js",
5315     "groupTitle": "Chat_Websites"
5316   },
5317   {
5318     "type": "get",
5319     "url": "/api/chat/websites/{id}/fields",
5320     "title": "Gets Website Fields",
5321     "examples": [
5322       {
5323         "title": "Example usage:",
5324         "content": "curl https://{domain}/api/chat/websites/{id}/fields -v -u {name}:{password} -X GET",
5325         "type": "json"
5326       }
5327     ],
5328     "name": "getFields",
5329     "group": "Chat_Websites",
5330     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5331     "version": "0.0.0",
5332     "filename": "server/api/chatWebsite/index.js",
5333     "groupTitle": "Chat_Websites"
5334   },
5335   {
5336     "type": "get",
5337     "url": "/api/chat/websites/{id}/interactions",
5338     "title": "Gets Website Interactions",
5339     "examples": [
5340       {
5341         "title": "Example usage:",
5342         "content": "curl https://{domain}/api/chat/websites/{id}/interactions -v -u {name}:{password} -X GET",
5343         "type": "json"
5344       }
5345     ],
5346     "name": "getInteraction",
5347     "group": "Chat_Websites",
5348     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5349     "version": "0.0.0",
5350     "filename": "server/api/chatWebsite/index.js",
5351     "groupTitle": "Chat_Websites"
5352   },
5353   {
5354     "type": "get",
5355     "url": "/api/chat/websites/{id}/logo",
5356     "title": "Get logo",
5357     "examples": [
5358       {
5359         "title": "Example usage:",
5360         "content": "curl https://{domain}/api/chat/websites/{id}/logo -v -u {name}:{password} -X GET",
5361         "type": "json"
5362       }
5363     ],
5364     "name": "getLogo",
5365     "group": "Chat_Websites",
5366     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5367     "version": "0.0.0",
5368     "filename": "server/api/chatWebsite/index.js",
5369     "groupTitle": "Chat_Websites"
5370   },
5371   {
5372     "type": "get",
5373     "url": "/api/chat/websites/{id}/offline_messages",
5374     "title": "Gets Website Offline Messages",
5375     "examples": [
5376       {
5377         "title": "Example usage:",
5378         "content": "curl https://{domain}/api/chat/websites/{id}/offline_messages -v -u {name}:{password} -X GET",
5379         "type": "json"
5380       }
5381     ],
5382     "name": "getOfflineMessages",
5383     "group": "Chat_Websites",
5384     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5385     "version": "0.0.0",
5386     "filename": "server/api/chatWebsite/index.js",
5387     "groupTitle": "Chat_Websites"
5388   },
5389   {
5390     "type": "get",
5391     "url": "/api/chat/websites/{id}/proactive_actions",
5392     "title": "Gets Website Proactive Actions",
5393     "examples": [
5394       {
5395         "title": "Example usage:",
5396         "content": "curl https://{domain}/api/chat/websites/{id}/proactive_actions -v -u {name}:{password} -X GET",
5397         "type": "json"
5398       }
5399     ],
5400     "name": "getProactiveActions",
5401     "group": "Chat_Websites",
5402     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5403     "version": "0.0.0",
5404     "filename": "server/api/chatWebsite/index.js",
5405     "groupTitle": "Chat_Websites"
5406   },
5407   {
5408     "type": "get",
5409     "url": "/api/chat/websites/{id}/snippet",
5410     "title": "Gets Website Snippet",
5411     "examples": [
5412       {
5413         "title": "Example usage:",
5414         "content": "curl https://{domain}/api/chat/websites/{id}/snippet -v -u {name}:{password} -X GET",
5415         "type": "json"
5416       }
5417     ],
5418     "name": "getSnippet",
5419     "group": "Chat_Websites",
5420     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5421     "version": "0.0.0",
5422     "filename": "server/api/chatWebsite/index.js",
5423     "groupTitle": "Chat_Websites"
5424   },
5425   {
5426     "type": "get",
5427     "url": "/api/chat/websites/{id}/system_avatar",
5428     "title": "Get System Avatar",
5429     "examples": [
5430       {
5431         "title": "Example usage:",
5432         "content": "curl https://{domain}/api/chat/websites/{id}/system_avatar -v -u {name}:{password} -X GET",
5433         "type": "json"
5434       }
5435     ],
5436     "name": "getSystemAvatar",
5437     "group": "Chat_Websites",
5438     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5439     "version": "0.0.0",
5440     "filename": "server/api/chatWebsite/index.js",
5441     "groupTitle": "Chat_Websites"
5442   },
5443   {
5444     "type": "post",
5445     "url": "/api/chat/websites/{id}/notify",
5446     "title": "Notify new message",
5447     "examples": [
5448       {
5449         "title": "Example usage:",
5450         "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",
5451         "type": "json"
5452       }
5453     ],
5454     "name": "notify",
5455     "group": "Chat_Websites",
5456     "description": "<p>Motion 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>",
5457     "version": "0.0.0",
5458     "filename": "server/api/chatWebsite/index.js",
5459     "groupTitle": "Chat_Websites"
5460   },
5461   {
5462     "type": "post",
5463     "url": "/api/chat/websites/{id}/offline",
5464     "title": "Offline message",
5465     "examples": [
5466       {
5467         "title": "Example usage:",
5468         "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",
5469         "type": "json"
5470       }
5471     ],
5472     "name": "offline",
5473     "group": "Chat_Websites",
5474     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5475     "version": "0.0.0",
5476     "filename": "server/api/chatWebsite/index.js",
5477     "groupTitle": "Chat_Websites"
5478   },
5479   {
5480     "type": "put",
5481     "url": "/api/chat/messages/{id}/reject",
5482     "title": "Rejects message",
5483     "examples": [
5484       {
5485         "title": "Example usage:",
5486         "content": "curl https://{domain}/api/chat/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
5487         "type": "json"
5488       }
5489     ],
5490     "name": "rejectMessage",
5491     "group": "Chat_Websites",
5492     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5493     "version": "0.0.0",
5494     "filename": "server/api/chatMessage/index.js",
5495     "groupTitle": "Chat_Websites"
5496   },
5497   {
5498     "type": "put",
5499     "url": "/api/chat/websites/{id}",
5500     "title": "Update an existing Website",
5501     "examples": [
5502       {
5503         "title": "Example usage:",
5504         "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",
5505         "type": "json"
5506       }
5507     ],
5508     "name": "updateWebsites",
5509     "group": "Chat_Websites",
5510     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5511     "version": "0.0.0",
5512     "filename": "server/api/chatWebsite/index.js",
5513     "groupTitle": "Chat_Websites"
5514   },
5515   {
5516     "type": "post",
5517     "url": "/api/cloudProviders",
5518     "title": "Creates a new CloudProvider",
5519     "examples": [
5520       {
5521         "title": "Example usage:",
5522         "content": "curl https://{domain}/api/cloudProviders -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
5523         "type": "json"
5524       }
5525     ],
5526     "name": "CreateCloudProviders",
5527     "group": "CloudProviders",
5528     "parameter": {
5529       "fields": {
5530         "Body": [
5531           {
5532             "group": "Body",
5533             "type": "String",
5534             "optional": false,
5535             "field": "name",
5536             "description": ""
5537           },
5538           {
5539             "group": "Body",
5540             "type": "String",
5541             "allowedValues": [
5542               "\"AmazonAWS\"",
5543               "\"Google\""
5544             ],
5545             "optional": false,
5546             "field": "service",
5547             "description": ""
5548           },
5549           {
5550             "group": "Body",
5551             "type": "String",
5552             "optional": true,
5553             "field": "data1",
5554             "description": ""
5555           },
5556           {
5557             "group": "Body",
5558             "type": "String",
5559             "optional": true,
5560             "field": "data2",
5561             "description": ""
5562           }
5563         ]
5564       }
5565     },
5566     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5567     "version": "0.0.0",
5568     "filename": "server/api/cloudProvider/index.js",
5569     "groupTitle": "CloudProviders"
5570   },
5571   {
5572     "type": "delete",
5573     "url": "/api/cloudProviders/{id}",
5574     "title": "Deletes a CloudProvider",
5575     "examples": [
5576       {
5577         "title": "Example usage:",
5578         "content": "curl https://{domain}/api/cloudProviders/{id} -v -u {name}:{password} -X DELETE",
5579         "type": "json"
5580       }
5581     ],
5582     "name": "DeleteCloudProviders",
5583     "group": "CloudProviders",
5584     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5585     "version": "0.0.0",
5586     "filename": "server/api/cloudProvider/index.js",
5587     "groupTitle": "CloudProviders"
5588   },
5589   {
5590     "type": "get",
5591     "url": "/api/cloudProviders",
5592     "title": "Gets a list of CloudProviders",
5593     "examples": [
5594       {
5595         "title": "Example usage:",
5596         "content": "curl https://{domain}/api/cloudProviders -v -u {name}:{password}",
5597         "type": "json"
5598       }
5599     ],
5600     "name": "GetCloudProviders",
5601     "group": "CloudProviders",
5602     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
5603     "version": "0.0.0",
5604     "filename": "server/api/cloudProvider/index.js",
5605     "groupTitle": "CloudProviders"
5606   },
5607   {
5608     "type": "get",
5609     "url": "/api/cloudProviders/oauth2/microsoft/authorize/{id}",
5610     "title": "Generates the Microsoft Identity platform authorization url",
5611     "examples": [
5612       {
5613         "title": "Example usage:",
5614         "content": "curl https://{domain}/api/cloudProviders/oauth2/microsoft/authorize/{id} -v -u {name}:{password}",
5615         "type": "json"
5616       }
5617     ],
5618     "name": "Oauth2MicrosoftAuthorize",
5619     "group": "CloudProviders",
5620     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5621     "version": "0.0.0",
5622     "filename": "server/api/cloudProvider/index.js",
5623     "groupTitle": "CloudProviders"
5624   },
5625   {
5626     "type": "post",
5627     "url": "/api/cloudProviders/oauth2/microsoft/callback",
5628     "title": "Receives an authorization code from Microsoft Identity platform",
5629     "name": "Oauth2MicrosoftCallback",
5630     "group": "CloudProviders",
5631     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5632     "version": "0.0.0",
5633     "filename": "server/api/cloudProvider/index.js",
5634     "groupTitle": "CloudProviders"
5635   },
5636   {
5637     "type": "get",
5638     "url": "/api/cloudProviders/{id}",
5639     "title": "Gets a single CloudProvider",
5640     "examples": [
5641       {
5642         "title": "Example usage:",
5643         "content": "curl https://{domain}/api/cloudProviders/{id} -v -u {name}:{password}",
5644         "type": "json"
5645       }
5646     ],
5647     "name": "ShowCloudProviders",
5648     "group": "CloudProviders",
5649     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5650     "version": "0.0.0",
5651     "filename": "server/api/cloudProvider/index.js",
5652     "groupTitle": "CloudProviders"
5653   },
5654   {
5655     "type": "put",
5656     "url": "/api/cloudProviders/{id}",
5657     "title": "Update an existing CloudProvider",
5658     "examples": [
5659       {
5660         "title": "Example usage:",
5661         "content": "curl https://{domain}/api/cloudProviders/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
5662         "type": "json"
5663       }
5664     ],
5665     "name": "updateCloudProviders",
5666     "group": "CloudProviders",
5667     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5668     "version": "0.0.0",
5669     "filename": "server/api/cloudProvider/index.js",
5670     "groupTitle": "CloudProviders"
5671   },
5672   {
5673     "type": "post",
5674     "url": "/api/cm_contact_has_items",
5675     "title": "Creates a new CmContactHasItem",
5676     "examples": [
5677       {
5678         "title": "Example usage:",
5679         "content": "curl https://{domain}/api/cm_contact_has_items -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
5680         "type": "json"
5681       }
5682     ],
5683     "name": "CreateCmContactHasItems",
5684     "group": "CmContactHasItems",
5685     "parameter": {
5686       "fields": {
5687         "Body": [
5688           {
5689             "group": "Body",
5690             "type": "Integer",
5691             "optional": true,
5692             "field": "CmContactId",
5693             "description": ""
5694           },
5695           {
5696             "group": "Body",
5697             "type": "String",
5698             "optional": true,
5699             "field": "item",
5700             "description": ""
5701           },
5702           {
5703             "group": "Body",
5704             "type": "Integer",
5705             "optional": true,
5706             "field": "ItemTypeId",
5707             "description": ""
5708           },
5709           {
5710             "group": "Body",
5711             "type": "String",
5712             "optional": true,
5713             "field": "ItemClass",
5714             "description": ""
5715           },
5716           {
5717             "group": "Body",
5718             "type": "Integer",
5719             "optional": true,
5720             "field": "OrderBy",
5721             "description": ""
5722           },
5723           {
5724             "group": "Body",
5725             "type": "String",
5726             "optional": true,
5727             "field": "description",
5728             "description": ""
5729           }
5730         ]
5731       }
5732     },
5733     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5734     "version": "0.0.0",
5735     "filename": "server/api/cmContactHasItem/index.js",
5736     "groupTitle": "CmContactHasItems"
5737   },
5738   {
5739     "type": "delete",
5740     "url": "/api/cm_contact_has_items/{id}",
5741     "title": "Deletes a CmContactHasItem",
5742     "examples": [
5743       {
5744         "title": "Example usage:",
5745         "content": "curl https://{domain}/api/cm_contact_has_items/{id} -v -u {name}:{password} -X DELETE",
5746         "type": "json"
5747       }
5748     ],
5749     "name": "DeleteCmContactHasItems",
5750     "group": "CmContactHasItems",
5751     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5752     "version": "0.0.0",
5753     "filename": "server/api/cmContactHasItem/index.js",
5754     "groupTitle": "CmContactHasItems"
5755   },
5756   {
5757     "type": "get",
5758     "url": "/api/cm_contact_has_items",
5759     "title": "Gets a list of CmContactHasItems",
5760     "examples": [
5761       {
5762         "title": "Example usage:",
5763         "content": "curl https://{domain}/api/cm_contact_has_items -v -u {name}:{password}",
5764         "type": "json"
5765       }
5766     ],
5767     "name": "GetCmContactHasItems",
5768     "group": "CmContactHasItems",
5769     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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_contact_has_items?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning 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_contact_has_items?name=john.doe,jane.miller</code></p> <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_contact_has_items?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A 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_contact_has_items?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result 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_contact_has_items?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
5770     "version": "0.0.0",
5771     "filename": "server/api/cmContactHasItem/index.js",
5772     "groupTitle": "CmContactHasItems"
5773   },
5774   {
5775     "type": "get",
5776     "url": "/api/cm_contact_has_items/{id}",
5777     "title": "Gets a single CmContactHasItem",
5778     "examples": [
5779       {
5780         "title": "Example usage:",
5781         "content": "curl https://{domain}/api/cm_contact_has_items/{id} -v -u {name}:{password}",
5782         "type": "json"
5783       }
5784     ],
5785     "name": "ShowCmContactHasItems",
5786     "group": "CmContactHasItems",
5787     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5788     "version": "0.0.0",
5789     "filename": "server/api/cmContactHasItem/index.js",
5790     "groupTitle": "CmContactHasItems"
5791   },
5792   {
5793     "type": "put",
5794     "url": "/api/cm_contact_has_items/{id}",
5795     "title": "Update an existing CmContactHasItem",
5796     "examples": [
5797       {
5798         "title": "Example usage:",
5799         "content": "curl https://{domain}/api/cm_contact_has_items/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
5800         "type": "json"
5801       }
5802     ],
5803     "name": "updateCmContactHasItems",
5804     "group": "CmContactHasItems",
5805     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5806     "version": "0.0.0",
5807     "filename": "server/api/cmContactHasItem/index.js",
5808     "groupTitle": "CmContactHasItems"
5809   },
5810   {
5811     "type": "post",
5812     "url": "/api/cm_hopper_additional_phones",
5813     "title": "Creates a new CmHopperAdditionalPhone",
5814     "examples": [
5815       {
5816         "title": "Example usage:",
5817         "content": "curl https://{domain}/api/cm_hopper_additional_phones -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
5818         "type": "json"
5819       }
5820     ],
5821     "name": "CreateCmHopperAdditionalPhones",
5822     "group": "CmHopperAdditionalPhones",
5823     "parameter": {
5824       "fields": {
5825         "Body": [
5826           {
5827             "group": "Body",
5828             "type": "Integer",
5829             "optional": true,
5830             "field": "CmHopperId",
5831             "description": ""
5832           },
5833           {
5834             "group": "Body",
5835             "type": "String",
5836             "optional": false,
5837             "field": "phone",
5838             "description": ""
5839           },
5840           {
5841             "group": "Body",
5842             "type": "Integer",
5843             "optional": true,
5844             "field": "OrderBy",
5845             "description": ""
5846           },
5847           {
5848             "group": "Body",
5849             "type": "String",
5850             "optional": true,
5851             "field": "scheduledat",
5852             "description": ""
5853           },
5854           {
5855             "group": "Body",
5856             "type": "Integer",
5857             "optional": true,
5858             "field": "countbusyretry",
5859             "description": ""
5860           },
5861           {
5862             "group": "Body",
5863             "type": "Integer",
5864             "optional": true,
5865             "field": "countcongestionretry",
5866             "description": ""
5867           },
5868           {
5869             "group": "Body",
5870             "type": "Integer",
5871             "optional": true,
5872             "field": "countnoanswerretry",
5873             "description": ""
5874           },
5875           {
5876             "group": "Body",
5877             "type": "Integer",
5878             "optional": true,
5879             "field": "countnosuchnumberretry",
5880             "description": ""
5881           },
5882           {
5883             "group": "Body",
5884             "type": "Integer",
5885             "optional": true,
5886             "field": "countdropretry",
5887             "description": ""
5888           },
5889           {
5890             "group": "Body",
5891             "type": "Integer",
5892             "optional": true,
5893             "field": "countabandonedretry",
5894             "description": ""
5895           },
5896           {
5897             "group": "Body",
5898             "type": "Integer",
5899             "optional": true,
5900             "field": "countmachineretry",
5901             "description": ""
5902           },
5903           {
5904             "group": "Body",
5905             "type": "Integer",
5906             "optional": true,
5907             "field": "countagentrejectretry",
5908             "description": ""
5909           }
5910         ]
5911       }
5912     },
5913     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5914     "version": "0.0.0",
5915     "filename": "server/api/cmHopperAdditionalPhone/index.js",
5916     "groupTitle": "CmHopperAdditionalPhones"
5917   },
5918   {
5919     "type": "delete",
5920     "url": "/api/cm_hopper_additional_phones/{id}",
5921     "title": "Deletes a CmHopperAdditionalPhone",
5922     "examples": [
5923       {
5924         "title": "Example usage:",
5925         "content": "curl https://{domain}/api/cm_hopper_additional_phones/{id} -v -u {name}:{password} -X DELETE",
5926         "type": "json"
5927       }
5928     ],
5929     "name": "DeleteCmHopperAdditionalPhones",
5930     "group": "CmHopperAdditionalPhones",
5931     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5932     "version": "0.0.0",
5933     "filename": "server/api/cmHopperAdditionalPhone/index.js",
5934     "groupTitle": "CmHopperAdditionalPhones"
5935   },
5936   {
5937     "type": "get",
5938     "url": "/api/cm_hopper_additional_phones",
5939     "title": "Gets a list of CmHopperAdditionalPhones",
5940     "examples": [
5941       {
5942         "title": "Example usage:",
5943         "content": "curl https://{domain}/api/cm_hopper_additional_phones -v -u {name}:{password}",
5944         "type": "json"
5945       }
5946     ],
5947     "name": "GetCmHopperAdditionalPhones",
5948     "group": "CmHopperAdditionalPhones",
5949     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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_additional_phones?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning 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_additional_phones?name=john.doe,jane.miller</code></p> <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_additional_phones?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A 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_additional_phones?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result 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_additional_phones?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
5950     "version": "0.0.0",
5951     "filename": "server/api/cmHopperAdditionalPhone/index.js",
5952     "groupTitle": "CmHopperAdditionalPhones"
5953   },
5954   {
5955     "type": "get",
5956     "url": "/api/cm_hopper_additional_phones/{id}",
5957     "title": "Gets a single CmHopperAdditionalPhone",
5958     "examples": [
5959       {
5960         "title": "Example usage:",
5961         "content": "curl https://{domain}/api/cm_hopper_additional_phones/{id} -v -u {name}:{password}",
5962         "type": "json"
5963       }
5964     ],
5965     "name": "ShowCmHopperAdditionalPhones",
5966     "group": "CmHopperAdditionalPhones",
5967     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5968     "version": "0.0.0",
5969     "filename": "server/api/cmHopperAdditionalPhone/index.js",
5970     "groupTitle": "CmHopperAdditionalPhones"
5971   },
5972   {
5973     "type": "put",
5974     "url": "/api/cm_hopper_additional_phones/{id}",
5975     "title": "Update an existing CmHopperAdditionalPhone",
5976     "examples": [
5977       {
5978         "title": "Example usage:",
5979         "content": "curl https://{domain}/api/cm_hopper_additional_phones/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
5980         "type": "json"
5981       }
5982     ],
5983     "name": "updateCmHopperAdditionalPhones",
5984     "group": "CmHopperAdditionalPhones",
5985     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5986     "version": "0.0.0",
5987     "filename": "server/api/cmHopperAdditionalPhone/index.js",
5988     "groupTitle": "CmHopperAdditionalPhones"
5989   },
5990   {
5991     "type": "post",
5992     "url": "/api/cm/companies",
5993     "title": "Creates a new Company",
5994     "examples": [
5995       {
5996         "title": "Example usage:",
5997         "content": "curl https://{domain}/api/cm/companies -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
5998         "type": "json"
5999       }
6000     ],
6001     "name": "CreateCompanies",
6002     "group": "Cm_Companies",
6003     "parameter": {
6004       "fields": {
6005         "Body": [
6006           {
6007             "group": "Body",
6008             "type": "String",
6009             "optional": false,
6010             "field": "name",
6011             "description": ""
6012           },
6013           {
6014             "group": "Body",
6015             "type": "String",
6016             "optional": true,
6017             "field": "vat",
6018             "description": ""
6019           },
6020           {
6021             "group": "Body",
6022             "type": "String",
6023             "optional": true,
6024             "field": "companyId",
6025             "description": ""
6026           },
6027           {
6028             "group": "Body",
6029             "type": "String",
6030             "optional": true,
6031             "field": "website",
6032             "description": ""
6033           },
6034           {
6035             "group": "Body",
6036             "type": "String",
6037             "optional": true,
6038             "field": "phone",
6039             "description": ""
6040           },
6041           {
6042             "group": "Body",
6043             "type": "String",
6044             "optional": true,
6045             "field": "fax",
6046             "description": ""
6047           },
6048           {
6049             "group": "Body",
6050             "type": "String",
6051             "optional": true,
6052             "field": "type",
6053             "description": ""
6054           },
6055           {
6056             "group": "Body",
6057             "type": "String",
6058             "optional": true,
6059             "field": "street",
6060             "description": ""
6061           },
6062           {
6063             "group": "Body",
6064             "type": "String",
6065             "optional": true,
6066             "field": "postalCode",
6067             "description": ""
6068           },
6069           {
6070             "group": "Body",
6071             "type": "String",
6072             "optional": true,
6073             "field": "city",
6074             "description": ""
6075           },
6076           {
6077             "group": "Body",
6078             "type": "String",
6079             "optional": true,
6080             "field": "country",
6081             "description": ""
6082           },
6083           {
6084             "group": "Body",
6085             "type": "String",
6086             "optional": true,
6087             "field": "email",
6088             "description": ""
6089           },
6090           {
6091             "group": "Body",
6092             "type": "String",
6093             "optional": true,
6094             "field": "emailDomain",
6095             "description": ""
6096           },
6097           {
6098             "group": "Body",
6099             "type": "String",
6100             "optional": true,
6101             "field": "sStreet",
6102             "description": ""
6103           },
6104           {
6105             "group": "Body",
6106             "type": "String",
6107             "optional": true,
6108             "field": "sPostalCode",
6109             "description": ""
6110           },
6111           {
6112             "group": "Body",
6113             "type": "String",
6114             "optional": true,
6115             "field": "sCity",
6116             "description": ""
6117           },
6118           {
6119             "group": "Body",
6120             "type": "String",
6121             "optional": true,
6122             "field": "sCountry",
6123             "description": ""
6124           },
6125           {
6126             "group": "Body",
6127             "type": "String",
6128             "optional": true,
6129             "field": "description",
6130             "description": ""
6131           }
6132         ]
6133       }
6134     },
6135     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6136     "version": "0.0.0",
6137     "filename": "server/api/cmCompany/index.js",
6138     "groupTitle": "Cm_Companies"
6139   },
6140   {
6141     "type": "delete",
6142     "url": "/api/cm/companies/{id}",
6143     "title": "Deletes a Company",
6144     "examples": [
6145       {
6146         "title": "Example usage:",
6147         "content": "curl https://{domain}/api/cm/companies/{id} -v -u {name}:{password} -X DELETE",
6148         "type": "json"
6149       }
6150     ],
6151     "name": "DeleteCompanies",
6152     "group": "Cm_Companies",
6153     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6154     "version": "0.0.0",
6155     "filename": "server/api/cmCompany/index.js",
6156     "groupTitle": "Cm_Companies"
6157   },
6158   {
6159     "type": "get",
6160     "url": "/api/cm/companies/describe",
6161     "title": "Gets table info about Companies",
6162     "examples": [
6163       {
6164         "title": "Example usage:",
6165         "content": "curl https://{domain}/api/cm/companies/describe -v -u {name}:{password}",
6166         "type": "json"
6167       }
6168     ],
6169     "name": "DescribeCompanies",
6170     "group": "Cm_Companies",
6171     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6172     "version": "0.0.0",
6173     "filename": "server/api/cmCompany/index.js",
6174     "groupTitle": "Cm_Companies"
6175   },
6176   {
6177     "type": "get",
6178     "url": "/api/cm/companies",
6179     "title": "Gets a list of Companies",
6180     "examples": [
6181       {
6182         "title": "Example usage:",
6183         "content": "curl https://{domain}/api/cm/companies -v -u {name}:{password}",
6184         "type": "json"
6185       }
6186     ],
6187     "name": "GetCompanies",
6188     "group": "Cm_Companies",
6189     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
6190     "version": "0.0.0",
6191     "filename": "server/api/cmCompany/index.js",
6192     "groupTitle": "Cm_Companies"
6193   },
6194   {
6195     "type": "get",
6196     "url": "/api/cm/companies/{id}",
6197     "title": "Gets a single Company",
6198     "examples": [
6199       {
6200         "title": "Example usage:",
6201         "content": "curl https://{domain}/api/cm/companies/{id} -v -u {name}:{password}",
6202         "type": "json"
6203       }
6204     ],
6205     "name": "ShowCompanies",
6206     "group": "Cm_Companies",
6207     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6208     "version": "0.0.0",
6209     "filename": "server/api/cmCompany/index.js",
6210     "groupTitle": "Cm_Companies"
6211   },
6212   {
6213     "type": "post",
6214     "url": "/api/cm/companies/{id}/contacts",
6215     "title": "Creates new contacts",
6216     "examples": [
6217       {
6218         "title": "Example usage:",
6219         "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",
6220         "type": "json"
6221       }
6222     ],
6223     "name": "addContacts",
6224     "group": "Cm_Companies",
6225     "parameter": {
6226       "fields": {
6227         "Body": [
6228           {
6229             "group": "Body",
6230             "type": "String",
6231             "optional": false,
6232             "field": "firstName",
6233             "description": ""
6234           },
6235           {
6236             "group": "Body",
6237             "type": "String",
6238             "optional": true,
6239             "field": "lastName",
6240             "description": ""
6241           },
6242           {
6243             "group": "Body",
6244             "type": "String",
6245             "optional": true,
6246             "field": "street",
6247             "description": ""
6248           },
6249           {
6250             "group": "Body",
6251             "type": "String",
6252             "optional": true,
6253             "field": "postalCode",
6254             "description": ""
6255           },
6256           {
6257             "group": "Body",
6258             "type": "String",
6259             "optional": true,
6260             "field": "city",
6261             "description": ""
6262           },
6263           {
6264             "group": "Body",
6265             "type": "String",
6266             "optional": true,
6267             "field": "country",
6268             "description": ""
6269           },
6270           {
6271             "group": "Body",
6272             "type": "String",
6273             "optional": true,
6274             "field": "dateOfBirth",
6275             "description": ""
6276           },
6277           {
6278             "group": "Body",
6279             "type": "Text",
6280             "optional": true,
6281             "field": "description",
6282             "description": ""
6283           },
6284           {
6285             "group": "Body",
6286             "type": "String",
6287             "optional": true,
6288             "field": "phone",
6289             "description": ""
6290           },
6291           {
6292             "group": "Body",
6293             "type": "String",
6294             "optional": true,
6295             "field": "mobile",
6296             "description": ""
6297           },
6298           {
6299             "group": "Body",
6300             "type": "String",
6301             "optional": true,
6302             "field": "fax",
6303             "description": ""
6304           },
6305           {
6306             "group": "Body",
6307             "type": "String",
6308             "optional": true,
6309             "field": "email",
6310             "description": ""
6311           },
6312           {
6313             "group": "Body",
6314             "type": "String",
6315             "optional": true,
6316             "field": "url",
6317             "description": ""
6318           },
6319           {
6320             "group": "Body",
6321             "type": "String",
6322             "optional": true,
6323             "field": "facebook",
6324             "description": ""
6325           },
6326           {
6327             "group": "Body",
6328             "type": "String",
6329             "optional": true,
6330             "field": "fb_data",
6331             "description": ""
6332           },
6333           {
6334             "group": "Body",
6335             "type": "String",
6336             "optional": true,
6337             "field": "twitter",
6338             "description": ""
6339           },
6340           {
6341             "group": "Body",
6342             "type": "String",
6343             "optional": true,
6344             "field": "skype",
6345             "description": ""
6346           },
6347           {
6348             "group": "Body",
6349             "type": "String",
6350             "optional": true,
6351             "field": "teams",
6352             "description": ""
6353           },
6354           {
6355             "group": "Body",
6356             "type": "String",
6357             "optional": true,
6358             "field": "viber",
6359             "description": ""
6360           },
6361           {
6362             "group": "Body",
6363             "type": "String",
6364             "optional": true,
6365             "field": "line",
6366             "description": ""
6367           },
6368           {
6369             "group": "Body",
6370             "type": "String",
6371             "optional": true,
6372             "field": "wechat",
6373             "description": ""
6374           },
6375           {
6376             "group": "Body",
6377             "type": "String",
6378             "optional": true,
6379             "field": "telegram",
6380             "description": ""
6381           },
6382           {
6383             "group": "Body",
6384             "type": "Integer",
6385             "optional": true,
6386             "field": "UserId",
6387             "description": ""
6388           },
6389           {
6390             "group": "Body",
6391             "type": "Integer",
6392             "optional": true,
6393             "field": "priority",
6394             "description": ""
6395           },
6396           {
6397             "group": "Body",
6398             "type": "String",
6399             "optional": true,
6400             "field": "scheduledat",
6401             "description": ""
6402           }
6403         ]
6404       }
6405     },
6406     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6407     "version": "0.0.0",
6408     "filename": "server/api/cmCompany/index.js",
6409     "groupTitle": "Cm_Companies"
6410   },
6411   {
6412     "type": "get",
6413     "url": "/api/cm/companies/{id}/contacts",
6414     "title": "Gets List Contacts",
6415     "examples": [
6416       {
6417         "title": "Example usage:",
6418         "content": "curl https://{domain}/api/fax/companies/{id}/contacts -v -u {name}:{password} -X GET",
6419         "type": "json"
6420       }
6421     ],
6422     "name": "getContacts",
6423     "group": "Cm_Companies",
6424     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6425     "version": "0.0.0",
6426     "filename": "server/api/cmCompany/index.js",
6427     "groupTitle": "Cm_Companies"
6428   },
6429   {
6430     "type": "put",
6431     "url": "/api/cm/companies/{id}",
6432     "title": "Update an existing Company",
6433     "examples": [
6434       {
6435         "title": "Example usage:",
6436         "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",
6437         "type": "json"
6438       }
6439     ],
6440     "name": "updateCompanies",
6441     "group": "Cm_Companies",
6442     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6443     "version": "0.0.0",
6444     "filename": "server/api/cmCompany/index.js",
6445     "groupTitle": "Cm_Companies"
6446   },
6447   {
6448     "type": "delete",
6449     "url": "/api/cm/contacts/{id}",
6450     "title": "Deletes a Contact",
6451     "examples": [
6452       {
6453         "title": "Example usage:",
6454         "content": "curl https://{domain}/api/cm/contacts/{id} -v -u {name}:{password} -X DELETE",
6455         "type": "json"
6456       }
6457     ],
6458     "name": "DeleteContacts",
6459     "group": "Cm_Contacts",
6460     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6461     "version": "0.0.0",
6462     "filename": "server/api/cmContact/index.js",
6463     "groupTitle": "Cm_Contacts"
6464   },
6465   {
6466     "type": "get",
6467     "url": "/api/cm/contacts/describe",
6468     "title": "Gets table info about Contacts",
6469     "examples": [
6470       {
6471         "title": "Example usage:",
6472         "content": "curl https://{domain}/api/cm/contacts/describe -v -u {name}:{password}",
6473         "type": "json"
6474       }
6475     ],
6476     "name": "DescribeContacts",
6477     "group": "Cm_Contacts",
6478     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6479     "version": "0.0.0",
6480     "filename": "server/api/cmContact/index.js",
6481     "groupTitle": "Cm_Contacts"
6482   },
6483   {
6484     "type": "get",
6485     "url": "/api/cm/contacts",
6486     "title": "Gets a list of Contacts",
6487     "examples": [
6488       {
6489         "title": "Example usage:",
6490         "content": "curl https://{domain}/api/cm/contacts -v -u {name}:{password}",
6491         "type": "json"
6492       }
6493     ],
6494     "name": "GetContacts",
6495     "group": "Cm_Contacts",
6496     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/cm/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&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
6497     "version": "0.0.0",
6498     "filename": "server/api/cmContact/index.js",
6499     "groupTitle": "Cm_Contacts"
6500   },
6501   {
6502     "type": "get",
6503     "url": "/api/cm/contacts/{id}/finals",
6504     "title": "Gets contact hopper finals",
6505     "examples": [
6506       {
6507         "title": "Example usage:",
6508         "content": "curl https://{domain}/api/cm/contacts/{id}/hopper_finals -v -u {name}:{password}  -X GET",
6509         "type": "json"
6510       }
6511     ],
6512     "name": "GetHopperFinals",
6513     "group": "Cm_Contacts",
6514     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6515     "version": "0.0.0",
6516     "filename": "server/api/cmContact/index.js",
6517     "groupTitle": "Cm_Contacts"
6518   },
6519   {
6520     "type": "get",
6521     "url": "/api/cm/contacts/{id}/hopper_histories",
6522     "title": "Gets contact hopper histories",
6523     "examples": [
6524       {
6525         "title": "Example usage:",
6526         "content": "curl https://{domain}/api/cm/contacts/{id}/hopper_histories -v -u {name}:{password} -X GET",
6527         "type": "json"
6528       }
6529     ],
6530     "name": "GetHopperHistories",
6531     "group": "Cm_Contacts",
6532     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6533     "version": "0.0.0",
6534     "filename": "server/api/cmContact/index.js",
6535     "groupTitle": "Cm_Contacts"
6536   },
6537   {
6538     "type": "get",
6539     "url": "/api/cm/contacts/{id}/hoppers",
6540     "title": "Gets contact hoppers",
6541     "examples": [
6542       {
6543         "title": "Example usage:",
6544         "content": "curl https://{domain}/api/cm/contacts/{id}/hoppers -v -u {name}:{password} -X GET",
6545         "type": "json"
6546       }
6547     ],
6548     "name": "GetHoppers",
6549     "group": "Cm_Contacts",
6550     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6551     "version": "0.0.0",
6552     "filename": "server/api/cmContact/index.js",
6553     "groupTitle": "Cm_Contacts"
6554   },
6555   {
6556     "type": "post",
6557     "url": "/api/cm/contacts/create_many",
6558     "title": "Create Contacts",
6559     "examples": [
6560       {
6561         "title": "Example usage:",
6562         "content": "curl https://{domain}/api/cm/contacts/create_many -d '[{\"firstName\": \"John\", \"lastName\": \"doe\", \"...\": \"...\"}]' -v -u {name}:{password} -X POST",
6563         "type": "json"
6564       }
6565     ],
6566     "name": "bulkCreate",
6567     "group": "Cm_Contacts",
6568     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6569     "version": "0.0.0",
6570     "filename": "server/api/cmContact/index.js",
6571     "groupTitle": "Cm_Contacts"
6572   },
6573   {
6574     "type": "post",
6575     "url": "/api/cm/contacts",
6576     "title": "Create Contact",
6577     "examples": [
6578       {
6579         "title": "Example usage:",
6580         "content": "curl https://{domain}/api/cm/contacts -d '{\"firstName\": \"John\", \"lastName\": \"doe\", \"...\": \"...\"}' -v -u {name}:{password} -X POST",
6581         "type": "json"
6582       }
6583     ],
6584     "name": "create",
6585     "group": "Cm_Contacts",
6586     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6587     "version": "0.0.0",
6588     "filename": "server/api/cmContact/index.js",
6589     "groupTitle": "Cm_Contacts"
6590   },
6591   {
6592     "type": "post",
6593     "url": "/api/cm/contacts/{id}/duplicatePhones",
6594     "title": "Sets new contact additional phones",
6595     "examples": [
6596       {
6597         "title": "Example usage:",
6598         "content": "curl https://{domain}/api/cm/contacts/{id}/duplicateAdditionalPhones -d '{\"phones\": [p1,p2]}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
6599         "type": "json"
6600       }
6601     ],
6602     "name": "duplicateAdditionalPhones",
6603     "group": "Cm_Contacts",
6604     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6605     "version": "0.0.0",
6606     "filename": "server/api/cmContact/index.js",
6607     "groupTitle": "Cm_Contacts"
6608   },
6609   {
6610     "type": "get",
6611     "url": "/api/cm/contacts/{id}/phones",
6612     "title": "Gets contact phones",
6613     "examples": [
6614       {
6615         "title": "Example usage:",
6616         "content": "curl https://{domain}/api/cm/contacts/{id}/phones -v -u {name}:{password} -X GET",
6617         "type": "json"
6618       }
6619     ],
6620     "name": "getAdditionalPhones",
6621     "group": "Cm_Contacts",
6622     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6623     "version": "0.0.0",
6624     "filename": "server/api/cmContact/index.js",
6625     "groupTitle": "Cm_Contacts"
6626   },
6627   {
6628     "type": "get",
6629     "url": "/api/cm/contacts/{id}/journey",
6630     "title": "Gets customer journey",
6631     "examples": [
6632       {
6633         "title": "Example usage:",
6634         "content": "curl https://{domain}/api/cm/contacts/{id}/journey -v -u {name}:{password}  -X GET",
6635         "type": "json"
6636       }
6637     ],
6638     "name": "getJourney",
6639     "group": "Cm_Contacts",
6640     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6641     "version": "0.0.0",
6642     "filename": "server/api/cmContact/index.js",
6643     "groupTitle": "Cm_Contacts"
6644   },
6645   {
6646     "type": "get",
6647     "url": "/api/cm/contacts/{id}/jscripty_sessions",
6648     "title": "Gets contact hopper blacks",
6649     "examples": [
6650       {
6651         "title": "Example usage:",
6652         "content": "curl https://{domain}/api/cm/contacts/{id}/hopper_black -v -u {name}:{password}  -X GET",
6653         "type": "json"
6654       }
6655     ],
6656     "name": "getJscriptySessions",
6657     "group": "Cm_Contacts",
6658     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6659     "version": "0.0.0",
6660     "filename": "server/api/cmContact/index.js",
6661     "groupTitle": "Cm_Contacts"
6662   },
6663   {
6664     "type": "get",
6665     "url": "/api/cm/contacts/{id}/tags",
6666     "title": "Gets configurations tags",
6667     "examples": [
6668       {
6669         "title": "Example usage:",
6670         "content": "curl https://{domain}/api/cm/contacts/{id}/tags -v -u {name}:{password} -X GET",
6671         "type": "json"
6672       }
6673     ],
6674     "name": "getTags",
6675     "group": "Cm_Contacts",
6676     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6677     "version": "0.0.0",
6678     "filename": "server/api/cmContact/index.js",
6679     "groupTitle": "Cm_Contacts"
6680   },
6681   {
6682     "type": "post",
6683     "url": "/api/cm/contacts/merge",
6684     "title": "Merge Contact",
6685     "examples": [
6686       {
6687         "title": "Example usage:",
6688         "content": "curl https://{domain}/api/cm/contacts/merge -d '{\"from\": 1, \"to\": 2}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
6689         "type": "json"
6690       }
6691     ],
6692     "name": "merge",
6693     "group": "Cm_Contacts",
6694     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6695     "version": "0.0.0",
6696     "filename": "server/api/cmContact/index.js",
6697     "groupTitle": "Cm_Contacts"
6698   },
6699   {
6700     "type": "post",
6701     "url": "/api/cm/contacts/{id}/rescheduleAdditionalPhones",
6702     "title": "Sets new contact additional phones",
6703     "examples": [
6704       {
6705         "title": "Example usage:",
6706         "content": "curl https://{domain}/api/cm/contacts/{id}/rescheduleAdditionalPhones -d '{\"phones\": [p1,p2]}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
6707         "type": "json"
6708       }
6709     ],
6710     "name": "rescheduleAdditionalPhones",
6711     "group": "Cm_Contacts",
6712     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6713     "version": "0.0.0",
6714     "filename": "server/api/cmContact/index.js",
6715     "groupTitle": "Cm_Contacts"
6716   },
6717   {
6718     "type": "post",
6719     "url": "/api/cm/contacts/{id}/phones",
6720     "title": "Sets new contact phones",
6721     "examples": [
6722       {
6723         "title": "Example usage:",
6724         "content": "curl https://{domain}/api/cm/contacts/{id}/phones -d '{\"phones\": [p1,p2]}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
6725         "type": "json"
6726       }
6727     ],
6728     "name": "setAdditionalPhones",
6729     "group": "Cm_Contacts",
6730     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6731     "version": "0.0.0",
6732     "filename": "server/api/cmContact/index.js",
6733     "groupTitle": "Cm_Contacts"
6734   },
6735   {
6736     "type": "post",
6737     "url": "/api/cm/contacts/{id}/tags",
6738     "title": "Sets new tags",
6739     "examples": [
6740       {
6741         "title": "Example usage:",
6742         "content": "curl https://{domain}/api/cm/contacts/{id}/tags -d '{\"ids\": [1,12]}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
6743         "type": "json"
6744       }
6745     ],
6746     "name": "setTags",
6747     "group": "Cm_Contacts",
6748     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6749     "version": "0.0.0",
6750     "filename": "server/api/cmContact/index.js",
6751     "groupTitle": "Cm_Contacts"
6752   },
6753   {
6754     "type": "get",
6755     "url": "/api/cm/contacts/{id}",
6756     "title": "Gets a single Contact",
6757     "examples": [
6758       {
6759         "title": "Example usage:",
6760         "content": "curl https://{domain}/api/cm/contacts/{id} -v -u {name}:{password} -X GET",
6761         "type": "json"
6762       }
6763     ],
6764     "name": "show",
6765     "group": "Cm_Contacts",
6766     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6767     "version": "0.0.0",
6768     "filename": "server/api/cmContact/index.js",
6769     "groupTitle": "Cm_Contacts"
6770   },
6771   {
6772     "type": "put",
6773     "url": "/api/cm/contacts/{id}",
6774     "title": "Update a single Contact",
6775     "examples": [
6776       {
6777         "title": "Example usage:",
6778         "content": "curl https://{domain}/api/cm/contacts/{id} -d '{\"firstName\": \"John\", \"lastName\": \"Doe\"}' -v -u {name}:{password} -X PUT",
6779         "type": "json"
6780       }
6781     ],
6782     "name": "update",
6783     "group": "Cm_Contacts",
6784     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6785     "version": "0.0.0",
6786     "filename": "server/api/cmContact/index.js",
6787     "groupTitle": "Cm_Contacts"
6788   },
6789   {
6790     "type": "delete",
6791     "url": "/api/cm/custom_fields/{id}",
6792     "title": "Deletes a Custom Field",
6793     "examples": [
6794       {
6795         "title": "Example usage:",
6796         "content": "curl https://{domain}/api/cm/custom_fields/{id} -v -u {name}:{password} -X DELETE",
6797         "type": "json"
6798       }
6799     ],
6800     "name": "DeleteCustom_Fields",
6801     "group": "Cm_Custom_Fields",
6802     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6803     "version": "0.0.0",
6804     "filename": "server/api/cmCustomField/index.js",
6805     "groupTitle": "Cm_Custom_Fields"
6806   },
6807   {
6808     "type": "get",
6809     "url": "/api/cm/custom_fields",
6810     "title": "Gets a list of Custom Fields",
6811     "examples": [
6812       {
6813         "title": "Example usage:",
6814         "content": "curl https://{domain}/api/cm/custom_fields -v -u {name}:{password}",
6815         "type": "json"
6816       }
6817     ],
6818     "name": "GetCustom_Fields",
6819     "group": "Cm_Custom_Fields",
6820     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
6821     "version": "0.0.0",
6822     "filename": "server/api/cmCustomField/index.js",
6823     "groupTitle": "Cm_Custom_Fields"
6824   },
6825   {
6826     "type": "get",
6827     "url": "/api/cm/custom_fields/{id}",
6828     "title": "Gets a single Custom Field",
6829     "examples": [
6830       {
6831         "title": "Example usage:",
6832         "content": "curl https://{domain}/api/cm/custom_fields/{id} -v -u {name}:{password}",
6833         "type": "json"
6834       }
6835     ],
6836     "name": "ShowCustom_Fields",
6837     "group": "Cm_Custom_Fields",
6838     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6839     "version": "0.0.0",
6840     "filename": "server/api/cmCustomField/index.js",
6841     "groupTitle": "Cm_Custom_Fields"
6842   },
6843   {
6844     "type": "put",
6845     "url": "/api/cm/custom_fields/{id}",
6846     "title": "Update an existing Custom Field",
6847     "examples": [
6848       {
6849         "title": "Example usage:",
6850         "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",
6851         "type": "json"
6852       }
6853     ],
6854     "name": "updateCustom_Fields",
6855     "group": "Cm_Custom_Fields",
6856     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6857     "version": "0.0.0",
6858     "filename": "server/api/cmCustomField/index.js",
6859     "groupTitle": "Cm_Custom_Fields"
6860   },
6861   {
6862     "type": "post",
6863     "url": "/api/cm/hopper",
6864     "title": "Creates a new Hopper",
6865     "examples": [
6866       {
6867         "title": "Example usage:",
6868         "content": "curl https://{domain}/api/cm/hopper -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
6869         "type": "json"
6870       }
6871     ],
6872     "name": "CreateHopper",
6873     "group": "Cm_Hopper",
6874     "parameter": {
6875       "fields": {
6876         "Body": [
6877           {
6878             "group": "Body",
6879             "type": "String",
6880             "optional": false,
6881             "field": "phone",
6882             "description": ""
6883           },
6884           {
6885             "group": "Body",
6886             "type": "Boolean",
6887             "optional": true,
6888             "field": "active",
6889             "description": ""
6890           },
6891           {
6892             "group": "Body",
6893             "type": "String",
6894             "optional": true,
6895             "field": "scheduledat",
6896             "description": ""
6897           },
6898           {
6899             "group": "Body",
6900             "type": "Integer",
6901             "optional": true,
6902             "field": "countbusyretry",
6903             "description": ""
6904           },
6905           {
6906             "group": "Body",
6907             "type": "Integer",
6908             "optional": true,
6909             "field": "countcongestionretry",
6910             "description": ""
6911           },
6912           {
6913             "group": "Body",
6914             "type": "Integer",
6915             "optional": true,
6916             "field": "countnoanswerretry",
6917             "description": ""
6918           },
6919           {
6920             "group": "Body",
6921             "type": "Boolean",
6922             "optional": true,
6923             "field": "callback",
6924             "description": ""
6925           },
6926           {
6927             "group": "Body",
6928             "type": "String",
6929             "optional": true,
6930             "field": "callbackuniqueid",
6931             "description": ""
6932           },
6933           {
6934             "group": "Body",
6935             "type": "String",
6936             "optional": true,
6937             "field": "callbackat",
6938             "description": ""
6939           },
6940           {
6941             "group": "Body",
6942             "type": "Integer",
6943             "optional": true,
6944             "field": "priority",
6945             "description": ""
6946           },
6947           {
6948             "group": "Body",
6949             "type": "Boolean",
6950             "optional": true,
6951             "field": "recallme",
6952             "description": ""
6953           },
6954           {
6955             "group": "Body",
6956             "type": "Integer",
6957             "optional": true,
6958             "field": "ContactId",
6959             "description": ""
6960           },
6961           {
6962             "group": "Body",
6963             "type": "Integer",
6964             "optional": true,
6965             "field": "ListId",
6966             "description": ""
6967           },
6968           {
6969             "group": "Body",
6970             "type": "Integer",
6971             "optional": true,
6972             "field": "UserId",
6973             "description": ""
6974           },
6975           {
6976             "group": "Body",
6977             "type": "Integer",
6978             "optional": true,
6979             "field": "VoiceQueueId",
6980             "description": ""
6981           },
6982           {
6983             "group": "Body",
6984             "type": "Integer",
6985             "optional": true,
6986             "field": "CampaignId",
6987             "description": ""
6988           },
6989           {
6990             "group": "Body",
6991             "type": "Integer",
6992             "optional": true,
6993             "field": "countnosuchnumberretry",
6994             "description": ""
6995           },
6996           {
6997             "group": "Body",
6998             "type": "Integer",
6999             "optional": true,
7000             "field": "countdropretry",
7001             "description": ""
7002           },
7003           {
7004             "group": "Body",
7005             "type": "Integer",
7006             "optional": true,
7007             "field": "countabandonedretry",
7008             "description": ""
7009           },
7010           {
7011             "group": "Body",
7012             "type": "Integer",
7013             "optional": true,
7014             "field": "countmachineretry",
7015             "description": ""
7016           },
7017           {
7018             "group": "Body",
7019             "type": "Integer",
7020             "optional": true,
7021             "field": "countagentrejectretry",
7022             "description": ""
7023           },
7024           {
7025             "group": "Body",
7026             "type": "Integer",
7027             "optional": true,
7028             "field": "OrderBy",
7029             "description": ""
7030           },
7031           {
7032             "group": "Body",
7033             "type": "String",
7034             "optional": true,
7035             "field": "dialTimezone",
7036             "description": ""
7037           }
7038         ]
7039       }
7040     },
7041     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7042     "version": "0.0.0",
7043     "filename": "server/api/cmHopper/index.js",
7044     "groupTitle": "Cm_Hopper"
7045   },
7046   {
7047     "type": "get",
7048     "url": "/api/cm/hopper/describe",
7049     "title": "Gets table info about Hopper",
7050     "examples": [
7051       {
7052         "title": "Example usage:",
7053         "content": "curl https://{domain}/api/cm/hopper/describe -v -u {name}:{password}",
7054         "type": "json"
7055       }
7056     ],
7057     "name": "DescribeHopper",
7058     "group": "Cm_Hopper",
7059     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7060     "version": "0.0.0",
7061     "filename": "server/api/cmHopper/index.js",
7062     "groupTitle": "Cm_Hopper"
7063   },
7064   {
7065     "type": "get",
7066     "url": "/api/cm/hopper",
7067     "title": "Gets a list of Hopper",
7068     "examples": [
7069       {
7070         "title": "Example usage:",
7071         "content": "curl https://{domain}/api/cm/hopper -v -u {name}:{password}",
7072         "type": "json"
7073       }
7074     ],
7075     "name": "GetHopper",
7076     "group": "Cm_Hopper",
7077     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
7078     "version": "0.0.0",
7079     "filename": "server/api/cmHopper/index.js",
7080     "groupTitle": "Cm_Hopper"
7081   },
7082   {
7083     "type": "get",
7084     "url": "/api/cm/hopper/{id}",
7085     "title": "Gets a single Hopper",
7086     "examples": [
7087       {
7088         "title": "Example usage:",
7089         "content": "curl https://{domain}/api/cm/hopper/{id} -v -u {name}:{password}",
7090         "type": "json"
7091       }
7092     ],
7093     "name": "ShowHopper",
7094     "group": "Cm_Hopper",
7095     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7096     "version": "0.0.0",
7097     "filename": "server/api/cmHopper/index.js",
7098     "groupTitle": "Cm_Hopper"
7099   },
7100   {
7101     "type": "delete",
7102     "url": "/api/cm/hopper_black/{id}",
7103     "title": "Deletes a Hopper Black",
7104     "examples": [
7105       {
7106         "title": "Example usage:",
7107         "content": "curl https://{domain}/api/cm/hopper_black/{id} -v -u {name}:{password} -X DELETE",
7108         "type": "json"
7109       }
7110     ],
7111     "name": "DeleteHopper_Black",
7112     "group": "Cm_Hopper_Black",
7113     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7114     "version": "0.0.0",
7115     "filename": "server/api/cmHopperBlack/index.js",
7116     "groupTitle": "Cm_Hopper_Black"
7117   },
7118   {
7119     "type": "get",
7120     "url": "/api/cm/hopper_black/describe",
7121     "title": "Gets table info about Hopper Black",
7122     "examples": [
7123       {
7124         "title": "Example usage:",
7125         "content": "curl https://{domain}/api/cm/hopper_black/describe -v -u {name}:{password}",
7126         "type": "json"
7127       }
7128     ],
7129     "name": "DescribeHopper_Black",
7130     "group": "Cm_Hopper_Black",
7131     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7132     "version": "0.0.0",
7133     "filename": "server/api/cmHopperBlack/index.js",
7134     "groupTitle": "Cm_Hopper_Black"
7135   },
7136   {
7137     "type": "get",
7138     "url": "/api/cm/hopper_black",
7139     "title": "Gets a list of Hopper Black",
7140     "examples": [
7141       {
7142         "title": "Example usage:",
7143         "content": "curl https://{domain}/api/cm/hopper_black -v -u {name}:{password}",
7144         "type": "json"
7145       }
7146     ],
7147     "name": "GetHopper_Black",
7148     "group": "Cm_Hopper_Black",
7149     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
7150     "version": "0.0.0",
7151     "filename": "server/api/cmHopperBlack/index.js",
7152     "groupTitle": "Cm_Hopper_Black"
7153   },
7154   {
7155     "type": "get",
7156     "url": "/api/cm/hopper_black/{id}",
7157     "title": "Gets a single Hopper Black",
7158     "examples": [
7159       {
7160         "title": "Example usage:",
7161         "content": "curl https://{domain}/api/cm/hopper_black/{id} -v -u {name}:{password}",
7162         "type": "json"
7163       }
7164     ],
7165     "name": "ShowHopper_Black",
7166     "group": "Cm_Hopper_Black",
7167     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7168     "version": "0.0.0",
7169     "filename": "server/api/cmHopperBlack/index.js",
7170     "groupTitle": "Cm_Hopper_Black"
7171   },
7172   {
7173     "type": "put",
7174     "url": "/api/cm/hopper_black/{id}",
7175     "title": "Update an existing Hopper Black",
7176     "examples": [
7177       {
7178         "title": "Example usage:",
7179         "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",
7180         "type": "json"
7181       }
7182     ],
7183     "name": "updateHopper_Black",
7184     "group": "Cm_Hopper_Black",
7185     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7186     "version": "0.0.0",
7187     "filename": "server/api/cmHopperBlack/index.js",
7188     "groupTitle": "Cm_Hopper_Black"
7189   },
7190   {
7191     "type": "post",
7192     "url": "/api/cm/hopper_final/checkContactHopper",
7193     "title": "Check if contact is in hopper",
7194     "examples": [
7195       {
7196         "title": "Example usage:",
7197         "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",
7198         "type": "json"
7199       }
7200     ],
7201     "name": "/checkContactHopper",
7202     "group": "Cm_Hopper_Final",
7203     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7204     "version": "0.0.0",
7205     "filename": "server/api/cmHopperFinal/index.js",
7206     "groupTitle": "Cm_Hopper_Final"
7207   },
7208   {
7209     "type": "get",
7210     "url": "/api/cm/hopper_final/describe",
7211     "title": "Gets table info about HopperFinal",
7212     "examples": [
7213       {
7214         "title": "Example usage:",
7215         "content": "curl https://{domain}/api/cm/hopper_final/describe -v -u {name}:{password}",
7216         "type": "json"
7217       }
7218     ],
7219     "name": "DescribeHopperFinal",
7220     "group": "Cm_Hopper_Final",
7221     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7222     "version": "0.0.0",
7223     "filename": "server/api/cmHopperFinal/index.js",
7224     "groupTitle": "Cm_Hopper_Final"
7225   },
7226   {
7227     "type": "get",
7228     "url": "/api/cm/hopper_final",
7229     "title": "Gets a list of HopperFinal",
7230     "examples": [
7231       {
7232         "title": "Example usage:",
7233         "content": "curl https://{domain}/api/cm/hopper_final -v -u {name}:{password}",
7234         "type": "json"
7235       }
7236     ],
7237     "name": "GetHopperFinal",
7238     "group": "Cm_Hopper_Final",
7239     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
7240     "version": "0.0.0",
7241     "filename": "server/api/cmHopperFinal/index.js",
7242     "groupTitle": "Cm_Hopper_Final"
7243   },
7244   {
7245     "type": "get",
7246     "url": "/api/cm/hopper_final/{id}",
7247     "title": "Gets a single HopperFinal",
7248     "examples": [
7249       {
7250         "title": "Example usage:",
7251         "content": "curl https://{domain}/api/cm/hopper_final/{id} -v -u {name}:{password}",
7252         "type": "json"
7253       }
7254     ],
7255     "name": "ShowHopperFinal",
7256     "group": "Cm_Hopper_Final",
7257     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7258     "version": "0.0.0",
7259     "filename": "server/api/cmHopperFinal/index.js",
7260     "groupTitle": "Cm_Hopper_Final"
7261   },
7262   {
7263     "type": "get",
7264     "url": "/api/cm/hopper_final/campaign/countAttributes/{id}",
7265     "title": "Return number contacts for attributes",
7266     "examples": [
7267       {
7268         "title": "Example usage:",
7269         "content": "curl https://{domain}/api/hopper_final/campaign/countAttributes/{id} -d '{\"disposition\": \"OK\"}' -v -u {name}:{password} -X GET",
7270         "type": "json"
7271       }
7272     ],
7273     "name": "countContactsIvrCampaignHopperFinal",
7274     "group": "Cm_Hopper_Final",
7275     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7276     "version": "0.0.0",
7277     "filename": "server/api/cmHopperFinal/index.js",
7278     "groupTitle": "Cm_Hopper_Final"
7279   },
7280   {
7281     "type": "get",
7282     "url": "/api/cm/hopper_final/voice/queue/countAttributes/{id}",
7283     "title": "Return number contacts for attributes",
7284     "examples": [
7285       {
7286         "title": "Example usage:",
7287         "content": "curl https://{domain}/api/hopper_final/voice/queue/countAttributes/{id} -d '{\"disposition\": \"OK\"}' -v -u {name}:{password} -X GET",
7288         "type": "json"
7289       }
7290     ],
7291     "name": "countContactsQueueCampaignHopperFinal",
7292     "group": "Cm_Hopper_Final",
7293     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7294     "version": "0.0.0",
7295     "filename": "server/api/cmHopperFinal/index.js",
7296     "groupTitle": "Cm_Hopper_Final"
7297   },
7298   {
7299     "type": "post",
7300     "url": "/api/cm/hopper_final/campaign/{id}",
7301     "title": "Move contacts in hopper",
7302     "examples": [
7303       {
7304         "title": "Example usage:",
7305         "content": "curl https://{domain}/api/hopper_final/campaign/moveContacts/{id} -d '{\"state\": \"state\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
7306         "type": "json"
7307       }
7308     ],
7309     "name": "moveContactsIvrCampaignHopperFinal",
7310     "group": "Cm_Hopper_Final",
7311     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7312     "version": "0.0.0",
7313     "filename": "server/api/cmHopperFinal/index.js",
7314     "groupTitle": "Cm_Hopper_Final"
7315   },
7316   {
7317     "type": "post",
7318     "url": "/api/cm/hopper_final/voice/queue/{id}",
7319     "title": "Move contacts in hopper",
7320     "examples": [
7321       {
7322         "title": "Example usage:",
7323         "content": "curl https://{domain}/api/hopper_final/voice/queue/moveContacts/{id} -d '{\"state\": \"state\"}' -H 'Content-Type: application/json' -v -u {name}:{password}",
7324         "type": "json"
7325       }
7326     ],
7327     "name": "moveContactsQueueCampaignHopperFinal",
7328     "group": "Cm_Hopper_Final",
7329     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7330     "version": "0.0.0",
7331     "filename": "server/api/cmHopperFinal/index.js",
7332     "groupTitle": "Cm_Hopper_Final"
7333   },
7334   {
7335     "type": "put",
7336     "url": "/api/cm/hopper_final/{id}",
7337     "title": "Update a single hopper final",
7338     "examples": [
7339       {
7340         "title": "Example usage:",
7341         "content": "curl https://{domain}/api/hopper_final/{id} -d '{\"disposition\": \"OK\"}' -v -u {name}:{password} -X PUT",
7342         "type": "json"
7343       }
7344     ],
7345     "name": "update",
7346     "group": "Cm_Hopper_Final",
7347     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7348     "version": "0.0.0",
7349     "filename": "server/api/cmHopperFinal/index.js",
7350     "groupTitle": "Cm_Hopper_Final"
7351   },
7352   {
7353     "type": "post",
7354     "url": "/api/cm/hopper_history",
7355     "title": "Creates a new HopperHistory",
7356     "examples": [
7357       {
7358         "title": "Example usage:",
7359         "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",
7360         "type": "json"
7361       }
7362     ],
7363     "name": "CreateHopperHistory",
7364     "group": "Cm_Hopper_History",
7365     "parameter": {
7366       "fields": {
7367         "Body": [
7368           {
7369             "group": "Body",
7370             "type": "Integer",
7371             "optional": true,
7372             "field": "state",
7373             "description": ""
7374           },
7375           {
7376             "group": "Body",
7377             "type": "String",
7378             "optional": true,
7379             "field": "statedesc",
7380             "description": ""
7381           },
7382           {
7383             "group": "Body",
7384             "type": "String",
7385             "optional": true,
7386             "field": "scheduledat",
7387             "description": ""
7388           },
7389           {
7390             "group": "Body",
7391             "type": "Integer",
7392             "optional": true,
7393             "field": "countbusyretry",
7394             "description": ""
7395           },
7396           {
7397             "group": "Body",
7398             "type": "Integer",
7399             "optional": true,
7400             "field": "countcongestionretry",
7401             "description": ""
7402           },
7403           {
7404             "group": "Body",
7405             "type": "Integer",
7406             "optional": true,
7407             "field": "countnoanswerretry",
7408             "description": ""
7409           },
7410           {
7411             "group": "Body",
7412             "type": "Integer",
7413             "optional": true,
7414             "field": "countglobal",
7415             "description": ""
7416           },
7417           {
7418             "group": "Body",
7419             "type": "String",
7420             "optional": true,
7421             "field": "uniqueid",
7422             "description": ""
7423           },
7424           {
7425             "group": "Body",
7426             "type": "String",
7427             "optional": true,
7428             "field": "originatecalleridnum",
7429             "description": ""
7430           },
7431           {
7432             "group": "Body",
7433             "type": "String",
7434             "optional": true,
7435             "field": "originatecalleridname",
7436             "description": ""
7437           },
7438           {
7439             "group": "Body",
7440             "type": "String",
7441             "optional": true,
7442             "field": "calleridnum",
7443             "description": ""
7444           },
7445           {
7446             "group": "Body",
7447             "type": "String",
7448             "optional": true,
7449             "field": "calleridname",
7450             "description": ""
7451           },
7452           {
7453             "group": "Body",
7454             "type": "String",
7455             "optional": true,
7456             "field": "starttime",
7457             "description": ""
7458           },
7459           {
7460             "group": "Body",
7461             "type": "String",
7462             "optional": true,
7463             "field": "responsetime",
7464             "description": ""
7465           },
7466           {
7467             "group": "Body",
7468             "type": "String",
7469             "optional": true,
7470             "field": "answertime",
7471             "description": ""
7472           },
7473           {
7474             "group": "Body",
7475             "type": "String",
7476             "optional": true,
7477             "field": "droptime",
7478             "description": ""
7479           },
7480           {
7481             "group": "Body",
7482             "type": "String",
7483             "optional": true,
7484             "field": "endtime",
7485             "description": ""
7486           },
7487           {
7488             "group": "Body",
7489             "type": "Integer",
7490             "optional": true,
7491             "field": "ringtime",
7492             "description": ""
7493           },
7494           {
7495             "group": "Body",
7496             "type": "Integer",
7497             "optional": true,
7498             "field": "holdtime",
7499             "description": ""
7500           },
7501           {
7502             "group": "Body",
7503             "type": "Integer",
7504             "optional": true,
7505             "field": "talktime",
7506             "description": ""
7507           },
7508           {
7509             "group": "Body",
7510             "type": "Integer",
7511             "optional": true,
7512             "field": "followuptime",
7513             "description": ""
7514           },
7515           {
7516             "group": "Body",
7517             "type": "String",
7518             "optional": true,
7519             "field": "dropreason",
7520             "description": ""
7521           },
7522           {
7523             "group": "Body",
7524             "type": "String",
7525             "optional": true,
7526             "field": "campaign",
7527             "description": ""
7528           },
7529           {
7530             "group": "Body",
7531             "type": "String",
7532             "optional": true,
7533             "field": "campaigntype",
7534             "description": ""
7535           },
7536           {
7537             "group": "Body",
7538             "type": "String",
7539             "optional": true,
7540             "field": "membername",
7541             "description": ""
7542           },
7543           {
7544             "group": "Body",
7545             "type": "String",
7546             "optional": true,
7547             "field": "reason",
7548             "description": ""
7549           },
7550           {
7551             "group": "Body",
7552             "type": "Boolean",
7553             "optional": true,
7554             "field": "amd",
7555             "description": ""
7556           },
7557           {
7558             "group": "Body",
7559             "type": "Boolean",
7560             "optional": true,
7561             "field": "fax",
7562             "description": ""
7563           },
7564           {
7565             "group": "Body",
7566             "type": "Boolean",
7567             "optional": true,
7568             "field": "callback",
7569             "description": ""
7570           },
7571           {
7572             "group": "Body",
7573             "type": "String",
7574             "optional": true,
7575             "field": "callbackuniqueid",
7576             "description": ""
7577           },
7578           {
7579             "group": "Body",
7580             "type": "String",
7581             "optional": true,
7582             "field": "callbackat",
7583             "description": ""
7584           },
7585           {
7586             "group": "Body",
7587             "type": "Boolean",
7588             "optional": true,
7589             "field": "recallme",
7590             "description": ""
7591           },
7592           {
7593             "group": "Body",
7594             "type": "String",
7595             "optional": true,
7596             "field": "editedat",
7597             "description": ""
7598           },
7599           {
7600             "group": "Body",
7601             "type": "Boolean",
7602             "optional": true,
7603             "field": "edited",
7604             "description": ""
7605           },
7606           {
7607             "group": "Body",
7608             "type": "Integer",
7609             "optional": true,
7610             "field": "countnosuchnumberretry",
7611             "description": ""
7612           },
7613           {
7614             "group": "Body",
7615             "type": "Integer",
7616             "optional": true,
7617             "field": "countdropretry",
7618             "description": ""
7619           },
7620           {
7621             "group": "Body",
7622             "type": "Integer",
7623             "optional": true,
7624             "field": "countabandonedretry",
7625             "description": ""
7626           },
7627           {
7628             "group": "Body",
7629             "type": "Integer",
7630             "optional": true,
7631             "field": "countmachineretry",
7632             "description": ""
7633           },
7634           {
7635             "group": "Body",
7636             "type": "Integer",
7637             "optional": true,
7638             "field": "countagentrejectretry",
7639             "description": ""
7640           }
7641         ]
7642       }
7643     },
7644     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7645     "version": "0.0.0",
7646     "filename": "server/api/cmHopperHistory/index.js",
7647     "groupTitle": "Cm_Hopper_History"
7648   },
7649   {
7650     "type": "get",
7651     "url": "/api/cm/hopper_history/describe",
7652     "title": "Gets table info about HopperHistory",
7653     "examples": [
7654       {
7655         "title": "Example usage:",
7656         "content": "curl https://{domain}/api/cm/hopper_history/describe -v -u {name}:{password}",
7657         "type": "json"
7658       }
7659     ],
7660     "name": "DescribeHopperHistory",
7661     "group": "Cm_Hopper_History",
7662     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7663     "version": "0.0.0",
7664     "filename": "server/api/cmHopperHistory/index.js",
7665     "groupTitle": "Cm_Hopper_History"
7666   },
7667   {
7668     "type": "get",
7669     "url": "/api/cm/hopper_history",
7670     "title": "Gets a list of HopperHistory",
7671     "examples": [
7672       {
7673         "title": "Example usage:",
7674         "content": "curl https://{domain}/api/cm/hopper_history -v -u {name}:{password}",
7675         "type": "json"
7676       }
7677     ],
7678     "name": "GetHopperHistory",
7679     "group": "Cm_Hopper_History",
7680     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
7681     "version": "0.0.0",
7682     "filename": "server/api/cmHopperHistory/index.js",
7683     "groupTitle": "Cm_Hopper_History"
7684   },
7685   {
7686     "type": "get",
7687     "url": "/api/cm/hopper_history/{id}",
7688     "title": "Gets a single HopperHistory",
7689     "examples": [
7690       {
7691         "title": "Example usage:",
7692         "content": "curl https://{domain}/api/cm/hopper_history/{id} -v -u {name}:{password}",
7693         "type": "json"
7694       }
7695     ],
7696     "name": "ShowHopperHistory",
7697     "group": "Cm_Hopper_History",
7698     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7699     "version": "0.0.0",
7700     "filename": "server/api/cmHopperHistory/index.js",
7701     "groupTitle": "Cm_Hopper_History"
7702   },
7703   {
7704     "type": "put",
7705     "url": "/api/cm/hopper_history/{id}",
7706     "title": "Update a single hopper history",
7707     "examples": [
7708       {
7709         "title": "Example usage:",
7710         "content": "curl https://{domain}/api/hopper_history/{id} -d '{\"disposition\": \"OK\"}' -v -u {name}:{password} -X PUT",
7711         "type": "json"
7712       }
7713     ],
7714     "name": "update",
7715     "group": "Cm_Hopper_History",
7716     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7717     "version": "0.0.0",
7718     "filename": "server/api/cmHopperHistory/index.js",
7719     "groupTitle": "Cm_Hopper_History"
7720   },
7721   {
7722     "type": "delete",
7723     "url": "/api/cm/hopper/{id}",
7724     "title": "Delete Hopper",
7725     "examples": [
7726       {
7727         "title": "Example usage:",
7728         "content": "curl https://{domain}/api/cm/hopper/{id} -v -u {name}:{password} -X DELETE",
7729         "type": "json"
7730       }
7731     ],
7732     "name": "destroy",
7733     "group": "Cm_Hopper",
7734     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7735     "version": "0.0.0",
7736     "filename": "server/api/cmHopper/index.js",
7737     "groupTitle": "Cm_Hopper"
7738   },
7739   {
7740     "type": "get",
7741     "url": "/api/cm/hopper/opencontacts",
7742     "title": "Gets Open Contacts",
7743     "examples": [
7744       {
7745         "title": "Example usage:",
7746         "content": "curl https://{domain}/api/cm/hopper/opencontacts -v -u {name}:{password} -X GET",
7747         "type": "json"
7748       }
7749     ],
7750     "name": "getOpenContacts",
7751     "group": "Cm_Hopper",
7752     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7753     "version": "0.0.0",
7754     "filename": "server/api/cmHopper/index.js",
7755     "groupTitle": "Cm_Hopper"
7756   },
7757   {
7758     "type": "post",
7759     "url": "/api/cm/hopper/preview",
7760     "title": "Gets Preview Dialer Contacts",
7761     "examples": [
7762       {
7763         "title": "Example usage:",
7764         "content": "curl https://{domain}/api/cm/hopper/preview -d '{\"hopperIds\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X GET",
7765         "type": "json"
7766       }
7767     ],
7768     "name": "getPreview",
7769     "group": "Cm_Hopper",
7770     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7771     "version": "0.0.0",
7772     "filename": "server/api/cmHopper/index.js",
7773     "groupTitle": "Cm_Hopper"
7774   },
7775   {
7776     "type": "get",
7777     "url": "/api/cm/hopper/{id}/previewrecall",
7778     "title": "Gets Preview Dialer Contacts for Recall",
7779     "examples": [
7780       {
7781         "title": "Example usage:",
7782         "content": "curl https://{domain}/api/cm/hopper/{id}/previewrecall \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X GET",
7783         "type": "json"
7784       }
7785     ],
7786     "name": "getPreviewRecall",
7787     "group": "Cm_Hopper",
7788     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7789     "version": "0.0.0",
7790     "filename": "server/api/cmHopper/index.js",
7791     "groupTitle": "Cm_Hopper"
7792   },
7793   {
7794     "type": "get",
7795     "url": "/api/cm/hopper/timezones",
7796     "title": "Gets TZs list",
7797     "examples": [
7798       {
7799         "title": "Example usage:",
7800         "content": "curl https://{domain}/api/cm/hopper/timezones -v -u {name}:{password} -X GET",
7801         "type": "json"
7802       }
7803     ],
7804     "name": "getTimezones",
7805     "group": "Cm_Hopper",
7806     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7807     "version": "0.0.0",
7808     "filename": "server/api/cmHopper/index.js",
7809     "groupTitle": "Cm_Hopper"
7810   },
7811   {
7812     "type": "put",
7813     "url": "/api/cm/hopper/{id}",
7814     "title": "Update an existing Hopper",
7815     "examples": [
7816       {
7817         "title": "Example usage:",
7818         "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",
7819         "type": "json"
7820       }
7821     ],
7822     "name": "updateHopper",
7823     "group": "Cm_Hopper",
7824     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7825     "version": "0.0.0",
7826     "filename": "server/api/cmHopper/index.js",
7827     "groupTitle": "Cm_Hopper"
7828   },
7829   {
7830     "type": "post",
7831     "url": "/api/cm/lists",
7832     "title": "Creates a new List",
7833     "examples": [
7834       {
7835         "title": "Example usage:",
7836         "content": "curl https://{domain}/api/cm/lists -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
7837         "type": "json"
7838       }
7839     ],
7840     "name": "CreateLists",
7841     "group": "Cm_Lists",
7842     "parameter": {
7843       "fields": {
7844         "Body": [
7845           {
7846             "group": "Body",
7847             "type": "String",
7848             "optional": false,
7849             "field": "name",
7850             "description": ""
7851           },
7852           {
7853             "group": "Body",
7854             "type": "String",
7855             "optional": true,
7856             "field": "description",
7857             "description": ""
7858           },
7859           {
7860             "group": "Body",
7861             "type": "String",
7862             "optional": true,
7863             "field": "dialPrefix",
7864             "description": ""
7865           }
7866         ]
7867       }
7868     },
7869     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7870     "version": "0.0.0",
7871     "filename": "server/api/cmList/index.js",
7872     "groupTitle": "Cm_Lists"
7873   },
7874   {
7875     "type": "delete",
7876     "url": "/api/cm/lists/{id}",
7877     "title": "Deletes a List",
7878     "examples": [
7879       {
7880         "title": "Example usage:",
7881         "content": "curl https://{domain}/api/cm/lists/{id} -v -u {name}:{password} -X DELETE",
7882         "type": "json"
7883       }
7884     ],
7885     "name": "DeleteLists",
7886     "group": "Cm_Lists",
7887     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7888     "version": "0.0.0",
7889     "filename": "server/api/cmList/index.js",
7890     "groupTitle": "Cm_Lists"
7891   },
7892   {
7893     "type": "get",
7894     "url": "/api/cm/lists/describe",
7895     "title": "Gets table info about Lists",
7896     "examples": [
7897       {
7898         "title": "Example usage:",
7899         "content": "curl https://{domain}/api/cm/lists/describe -v -u {name}:{password}",
7900         "type": "json"
7901       }
7902     ],
7903     "name": "DescribeLists",
7904     "group": "Cm_Lists",
7905     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7906     "version": "0.0.0",
7907     "filename": "server/api/cmList/index.js",
7908     "groupTitle": "Cm_Lists"
7909   },
7910   {
7911     "type": "get",
7912     "url": "/api/cm/lists/{id}/users",
7913     "title": "Gets agents from list",
7914     "examples": [
7915       {
7916         "title": "Example usage:",
7917         "content": "curl https://{domain}/api/cm/lists/{id}/users -v -u {name}:{password} -X GET",
7918         "type": "json"
7919       }
7920     ],
7921     "name": "GetAgents",
7922     "group": "Cm_Lists",
7923     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7924     "version": "0.0.0",
7925     "filename": "server/api/cmList/index.js",
7926     "groupTitle": "Cm_Lists"
7927   },
7928   {
7929     "type": "get",
7930     "url": "/api/cm/lists",
7931     "title": "Gets a list of Lists",
7932     "examples": [
7933       {
7934         "title": "Example usage:",
7935         "content": "curl https://{domain}/api/cm/lists -v -u {name}:{password}",
7936         "type": "json"
7937       }
7938     ],
7939     "name": "GetLists",
7940     "group": "Cm_Lists",
7941     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
7942     "version": "0.0.0",
7943     "filename": "server/api/cmList/index.js",
7944     "groupTitle": "Cm_Lists"
7945   },
7946   {
7947     "type": "delete",
7948     "url": "/api/cm/lists/{id}/users",
7949     "title": "Removes agents from a list",
7950     "examples": [
7951       {
7952         "title": "Example usage:",
7953         "content": "curl https://{domain}/api/cm/lists/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
7954         "type": "json"
7955       }
7956     ],
7957     "name": "RemoveAgents",
7958     "group": "Cm_Lists",
7959     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7960     "version": "0.0.0",
7961     "filename": "server/api/cmList/index.js",
7962     "groupTitle": "Cm_Lists"
7963   },
7964   {
7965     "type": "delete",
7966     "url": "/api/cm/lists/{id}/dispositions",
7967     "title": "Removes dispositions from account",
7968     "examples": [
7969       {
7970         "title": "Example usage:",
7971         "content": "curl https://{domain}/api/cm/lists/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
7972         "type": "json"
7973       }
7974     ],
7975     "name": "RemoveDispositions",
7976     "group": "Cm_Lists",
7977     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7978     "version": "0.0.0",
7979     "filename": "server/api/cmList/index.js",
7980     "groupTitle": "Cm_Lists"
7981   },
7982   {
7983     "type": "get",
7984     "url": "/api/cm/lists/{id}",
7985     "title": "Gets a single List",
7986     "examples": [
7987       {
7988         "title": "Example usage:",
7989         "content": "curl https://{domain}/api/cm/lists/{id} -v -u {name}:{password}",
7990         "type": "json"
7991       }
7992     ],
7993     "name": "ShowLists",
7994     "group": "Cm_Lists",
7995     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7996     "version": "0.0.0",
7997     "filename": "server/api/cmList/index.js",
7998     "groupTitle": "Cm_Lists"
7999   },
8000   {
8001     "type": "post",
8002     "url": "/api/cm/lists/{id}/users",
8003     "title": "Adds agents to a list",
8004     "examples": [
8005       {
8006         "title": "Example usage:",
8007         "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",
8008         "type": "json"
8009       }
8010     ],
8011     "name": "addAgents",
8012     "group": "Cm_Lists",
8013     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8014     "version": "0.0.0",
8015     "filename": "server/api/cmList/index.js",
8016     "groupTitle": "Cm_Lists"
8017   },
8018   {
8019     "type": "post",
8020     "url": "/api/cm/lists/{id}/contacts",
8021     "title": "Creates new contacts",
8022     "examples": [
8023       {
8024         "title": "Example usage:",
8025         "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",
8026         "type": "json"
8027       }
8028     ],
8029     "name": "addContacts",
8030     "group": "Cm_Lists",
8031     "parameter": {
8032       "fields": {
8033         "Body": [
8034           {
8035             "group": "Body",
8036             "type": "String",
8037             "optional": false,
8038             "field": "firstName",
8039             "description": ""
8040           },
8041           {
8042             "group": "Body",
8043             "type": "String",
8044             "optional": true,
8045             "field": "lastName",
8046             "description": ""
8047           },
8048           {
8049             "group": "Body",
8050             "type": "String",
8051             "optional": true,
8052             "field": "street",
8053             "description": ""
8054           },
8055           {
8056             "group": "Body",
8057             "type": "String",
8058             "optional": true,
8059             "field": "postalCode",
8060             "description": ""
8061           },
8062           {
8063             "group": "Body",
8064             "type": "String",
8065             "optional": true,
8066             "field": "city",
8067             "description": ""
8068           },
8069           {
8070             "group": "Body",
8071             "type": "String",
8072             "optional": true,
8073             "field": "country",
8074             "description": ""
8075           },
8076           {
8077             "group": "Body",
8078             "type": "String",
8079             "optional": true,
8080             "field": "dateOfBirth",
8081             "description": ""
8082           },
8083           {
8084             "group": "Body",
8085             "type": "Text",
8086             "optional": true,
8087             "field": "description",
8088             "description": ""
8089           },
8090           {
8091             "group": "Body",
8092             "type": "String",
8093             "optional": true,
8094             "field": "phone",
8095             "description": ""
8096           },
8097           {
8098             "group": "Body",
8099             "type": "String",
8100             "optional": true,
8101             "field": "mobile",
8102             "description": ""
8103           },
8104           {
8105             "group": "Body",
8106             "type": "String",
8107             "optional": true,
8108             "field": "fax",
8109             "description": ""
8110           },
8111           {
8112             "group": "Body",
8113             "type": "String",
8114             "optional": true,
8115             "field": "email",
8116             "description": ""
8117           },
8118           {
8119             "group": "Body",
8120             "type": "String",
8121             "optional": true,
8122             "field": "url",
8123             "description": ""
8124           },
8125           {
8126             "group": "Body",
8127             "type": "String",
8128             "optional": true,
8129             "field": "facebook",
8130             "description": ""
8131           },
8132           {
8133             "group": "Body",
8134             "type": "String",
8135             "optional": true,
8136             "field": "fb_data",
8137             "description": ""
8138           },
8139           {
8140             "group": "Body",
8141             "type": "String",
8142             "optional": true,
8143             "field": "twitter",
8144             "description": ""
8145           },
8146           {
8147             "group": "Body",
8148             "type": "String",
8149             "optional": true,
8150             "field": "skype",
8151             "description": ""
8152           },
8153           {
8154             "group": "Body",
8155             "type": "String",
8156             "optional": true,
8157             "field": "teams",
8158             "description": ""
8159           },
8160           {
8161             "group": "Body",
8162             "type": "String",
8163             "optional": true,
8164             "field": "viber",
8165             "description": ""
8166           },
8167           {
8168             "group": "Body",
8169             "type": "String",
8170             "optional": true,
8171             "field": "line",
8172             "description": ""
8173           },
8174           {
8175             "group": "Body",
8176             "type": "String",
8177             "optional": true,
8178             "field": "wechat",
8179             "description": ""
8180           },
8181           {
8182             "group": "Body",
8183             "type": "String",
8184             "optional": true,
8185             "field": "telegram",
8186             "description": ""
8187           },
8188           {
8189             "group": "Body",
8190             "type": "Integer",
8191             "optional": true,
8192             "field": "UserId",
8193             "description": ""
8194           },
8195           {
8196             "group": "Body",
8197             "type": "Integer",
8198             "optional": true,
8199             "field": "priority",
8200             "description": ""
8201           },
8202           {
8203             "group": "Body",
8204             "type": "String",
8205             "optional": true,
8206             "field": "scheduledat",
8207             "description": ""
8208           }
8209         ]
8210       }
8211     },
8212     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8213     "version": "0.0.0",
8214     "filename": "server/api/cmList/index.js",
8215     "groupTitle": "Cm_Lists"
8216   },
8217   {
8218     "type": "post",
8219     "url": "/api/cm/lists/{id}/fields",
8220     "title": "Creates a new custom field",
8221     "examples": [
8222       {
8223         "title": "Example usage:",
8224         "content": "curl https://{domain}/api/cm/lists/{id}/fields -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
8225         "type": "json"
8226       }
8227     ],
8228     "name": "addCustomField",
8229     "group": "Cm_Lists",
8230     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8231     "version": "0.0.0",
8232     "filename": "server/api/cmList/index.js",
8233     "groupTitle": "Cm_Lists"
8234   },
8235   {
8236     "type": "post",
8237     "url": "/api/cm/lists/{id}/dispositions",
8238     "title": "Creates new disposition",
8239     "examples": [
8240       {
8241         "title": "Example usage:",
8242         "content": "curl https://{domain}/api/cm/lists/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
8243         "type": "json"
8244       }
8245     ],
8246     "name": "addDisposition",
8247     "group": "Cm_Lists",
8248     "parameter": {
8249       "fields": {
8250         "Body": [
8251           {
8252             "group": "Body",
8253             "type": "String",
8254             "optional": false,
8255             "field": "name",
8256             "description": ""
8257           },
8258           {
8259             "group": "Body",
8260             "type": "String",
8261             "allowedValues": [
8262               "\"first\"",
8263               "\"second\"",
8264               "\"third\""
8265             ],
8266             "optional": false,
8267             "field": "level",
8268             "description": ""
8269           },
8270           {
8271             "group": "Body",
8272             "type": "String",
8273             "optional": true,
8274             "field": "description",
8275             "description": ""
8276           }
8277         ]
8278       }
8279     },
8280     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8281     "version": "0.0.0",
8282     "filename": "server/api/cmList/index.js",
8283     "groupTitle": "Cm_Lists"
8284   },
8285   {
8286     "type": "get",
8287     "url": "/api/cm/lists/{id}/contacts",
8288     "title": "Gets List Contacts",
8289     "examples": [
8290       {
8291         "title": "Example usage:",
8292         "content": "curl https://{domain}/api/cm/lists/{id}/contacts -v -u {name}:{password} -X GET",
8293         "type": "json"
8294       }
8295     ],
8296     "name": "getContacts",
8297     "group": "Cm_Lists",
8298     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8299     "version": "0.0.0",
8300     "filename": "server/api/cmList/index.js",
8301     "groupTitle": "Cm_Lists"
8302   },
8303   {
8304     "type": "get",
8305     "url": "/api/cm/lists/{id}/fields",
8306     "title": "Gets Custom Fields",
8307     "examples": [
8308       {
8309         "title": "Example usage:",
8310         "content": "curl https://{domain}/api/cm/lists/{id}/fields -v -u {name}:{password} -X GET",
8311         "type": "json"
8312       }
8313     ],
8314     "name": "getCustomFields",
8315     "group": "Cm_Lists",
8316     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8317     "version": "0.0.0",
8318     "filename": "server/api/cmList/index.js",
8319     "groupTitle": "Cm_Lists"
8320   },
8321   {
8322     "type": "get",
8323     "url": "/api/cm/lists/{id}/dispositions",
8324     "title": "Gets list dispositions",
8325     "examples": [
8326       {
8327         "title": "Example usage:",
8328         "content": "curl https://{domain}/api/cm/lists/{id}/dispositions -v -u {name}:{password} -X GET",
8329         "type": "json"
8330       }
8331     ],
8332     "name": "getDispositions",
8333     "group": "Cm_Lists",
8334     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8335     "version": "0.0.0",
8336     "filename": "server/api/cmList/index.js",
8337     "groupTitle": "Cm_Lists"
8338   },
8339   {
8340     "type": "get",
8341     "url": "/api/cm/lists/global_fields",
8342     "title": "Gets GLOBAL Custom Fields",
8343     "examples": [
8344       {
8345         "title": "Example usage:",
8346         "content": "curl https://{domain}/api/cm/lists/global_fields -v -u {name}:{password} -X GET",
8347         "type": "json"
8348       }
8349     ],
8350     "name": "getGlobalCustomFields",
8351     "group": "Cm_Lists",
8352     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8353     "version": "0.0.0",
8354     "filename": "server/api/cmList/index.js",
8355     "groupTitle": "Cm_Lists"
8356   },
8357   {
8358     "type": "get",
8359     "url": "/api/cm/lists/{id}/contacts/csv",
8360     "title": "Gets CSV List Contacts",
8361     "examples": [
8362       {
8363         "title": "Example usage:",
8364         "content": "curl https://{domain}/api/cm/lists/{id}/contacts/csv -v -u {name}:{password} -X GET",
8365         "type": "json"
8366       }
8367     ],
8368     "name": "grunt",
8369     "group": "Cm_Lists",
8370     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8371     "version": "0.0.0",
8372     "filename": "server/api/cmList/index.js",
8373     "groupTitle": "Cm_Lists"
8374   },
8375   {
8376     "type": "put",
8377     "url": "/api/cm/lists/{id}",
8378     "title": "Update an existing List",
8379     "examples": [
8380       {
8381         "title": "Example usage:",
8382         "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",
8383         "type": "json"
8384       }
8385     ],
8386     "name": "updateLists",
8387     "group": "Cm_Lists",
8388     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <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     "version": "0.0.0",
8390     "filename": "server/api/cmList/index.js",
8391     "groupTitle": "Cm_Lists"
8392   },
8393   {
8394     "type": "post",
8395     "url": "/api/cm/contacts/upload/:id",
8396     "title": "Import new contacts by csv",
8397     "examples": [
8398       {
8399         "title": "Example usage:",
8400         "content": "curl https://{domain}/api/cm/contacts/upload/:id -v -u {name}:{password} -X POST",
8401         "type": "json"
8402       }
8403     ],
8404     "name": "import",
8405     "group": "Cm_contacts",
8406     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8407     "version": "0.0.0",
8408     "filename": "server/api/cmContact/index.js",
8409     "groupTitle": "Cm_contacts"
8410   },
8411   {
8412     "type": "post",
8413     "url": "/api/cm/contacts/uploadUpdates/:id",
8414     "title": "Import existing contacts by csv",
8415     "examples": [
8416       {
8417         "title": "Example usage:",
8418         "content": "curl https://{domain}/api/cm/contacts/uploadUpdates/:id -v -u {name}:{password} -X POST",
8419         "type": "json"
8420       }
8421     ],
8422     "name": "importUpdates",
8423     "group": "Cm_contacts",
8424     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8425     "version": "0.0.0",
8426     "filename": "server/api/cmContact/index.js",
8427     "groupTitle": "Cm_contacts"
8428   },
8429   {
8430     "type": "post",
8431     "url": "/api/cm/contacts/upload",
8432     "title": "Upload csv",
8433     "examples": [
8434       {
8435         "title": "Example usage:",
8436         "content": "curl https://{domain}/api/cm/contacts/upload -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
8437         "type": "json"
8438       }
8439     ],
8440     "name": "upload",
8441     "group": "Cm_contacts",
8442     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8443     "version": "0.0.0",
8444     "filename": "server/api/cmContact/index.js",
8445     "groupTitle": "Cm_contacts"
8446   },
8447   {
8448     "type": "post",
8449     "url": "/api/cm/contacts/csv",
8450     "title": "Create new contacts by csv",
8451     "examples": [
8452       {
8453         "title": "Example usage:",
8454         "content": "curl https://{domain}/api/cm/contacts/csv -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
8455         "type": "json"
8456       }
8457     ],
8458     "name": "uploadCsv",
8459     "group": "Cm_contacts",
8460     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8461     "version": "0.0.0",
8462     "filename": "server/api/cmContact/index.js",
8463     "groupTitle": "Cm_contacts"
8464   },
8465   {
8466     "type": "delete",
8467     "url": "/api/conditions/{id}",
8468     "title": "Deletes a Condition",
8469     "examples": [
8470       {
8471         "title": "Example usage:",
8472         "content": "curl https://{domain}/api/conditions/{id} -v -u {name}:{password} -X DELETE",
8473         "type": "json"
8474       }
8475     ],
8476     "name": "DeleteConditions",
8477     "group": "Conditions",
8478     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <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     "version": "0.0.0",
8480     "filename": "server/api/condition/index.js",
8481     "groupTitle": "Conditions"
8482   },
8483   {
8484     "type": "put",
8485     "url": "/api/conditions/{id}",
8486     "title": "Update an existing Condition",
8487     "examples": [
8488       {
8489         "title": "Example usage:",
8490         "content": "curl https://{domain}/api/conditions/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
8491         "type": "json"
8492       }
8493     ],
8494     "name": "updateConditions",
8495     "group": "Conditions",
8496     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <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     "version": "0.0.0",
8498     "filename": "server/api/condition/index.js",
8499     "groupTitle": "Conditions"
8500   },
8501   {
8502     "type": "post",
8503     "url": "/api/contact_item_types",
8504     "title": "Creates a new ContactItemType",
8505     "examples": [
8506       {
8507         "title": "Example usage:",
8508         "content": "curl https://{domain}/api/contact_item_types -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
8509         "type": "json"
8510       }
8511     ],
8512     "name": "CreateContactItemTypes",
8513     "group": "ContactItemType",
8514     "parameter": {
8515       "fields": {
8516         "Body": [
8517           {
8518             "group": "Body",
8519             "type": "String",
8520             "optional": false,
8521             "field": "name",
8522             "description": ""
8523           },
8524           {
8525             "group": "Body",
8526             "type": "Integer",
8527             "optional": true,
8528             "field": "OrderBy",
8529             "description": ""
8530           },
8531           {
8532             "group": "Body",
8533             "type": "String",
8534             "optional": true,
8535             "field": "rgbBackgroundColor",
8536             "description": ""
8537           }
8538         ]
8539       }
8540     },
8541     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8542     "version": "0.0.0",
8543     "filename": "server/api/contactItemType/index.js",
8544     "groupTitle": "ContactItemType"
8545   },
8546   {
8547     "type": "delete",
8548     "url": "/api/contact_item_types/{id}",
8549     "title": "Deletes a ContactItemType",
8550     "examples": [
8551       {
8552         "title": "Example usage:",
8553         "content": "curl https://{domain}/api/contact_item_types/{id} -v -u {name}:{password} -X DELETE",
8554         "type": "json"
8555       }
8556     ],
8557     "name": "DeleteContactItemTypes",
8558     "group": "ContactItemType",
8559     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8560     "version": "0.0.0",
8561     "filename": "server/api/contactItemType/index.js",
8562     "groupTitle": "ContactItemType"
8563   },
8564   {
8565     "type": "get",
8566     "url": "/api/contact_item_types",
8567     "title": "Gets a list of ContactItemTypes",
8568     "examples": [
8569       {
8570         "title": "Example usage:",
8571         "content": "curl https://{domain}/api/contact_item_types -v -u {name}:{password}",
8572         "type": "json"
8573       }
8574     ],
8575     "name": "GetContactItemTypes",
8576     "group": "ContactItemType",
8577     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/contact_item_types?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/contact_item_types?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/contact_item_types?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/contact_item_types?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/contact_item_types?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
8578     "version": "0.0.0",
8579     "filename": "server/api/contactItemType/index.js",
8580     "groupTitle": "ContactItemType"
8581   },
8582   {
8583     "type": "get",
8584     "url": "/api/contact_item_types/{id}",
8585     "title": "Gets a single ContactItemType",
8586     "examples": [
8587       {
8588         "title": "Example usage:",
8589         "content": "curl https://{domain}/api/contact_item_types/{id} -v -u {name}:{password}",
8590         "type": "json"
8591       }
8592     ],
8593     "name": "ShowContactItemTypes",
8594     "group": "ContactItemType",
8595     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8596     "version": "0.0.0",
8597     "filename": "server/api/contactItemType/index.js",
8598     "groupTitle": "ContactItemType"
8599   },
8600   {
8601     "type": "put",
8602     "url": "/api/contact_item_types/{id}",
8603     "title": "Update an existing ContactItemType",
8604     "examples": [
8605       {
8606         "title": "Example usage:",
8607         "content": "curl https://{domain}/api/contact_item_types/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
8608         "type": "json"
8609       }
8610     ],
8611     "name": "updateContactItemTypes",
8612     "group": "ContactItemType",
8613     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8614     "version": "0.0.0",
8615     "filename": "server/api/contactItemType/index.js",
8616     "groupTitle": "ContactItemType"
8617   },
8618   {
8619     "type": "post",
8620     "url": "/api/cm/custom_field",
8621     "title": "Create a new custom field",
8622     "examples": [
8623       {
8624         "title": "Example usage:",
8625         "content": "curl https://{domain}/api/cm/custom_field  -d '{\"name\": \"mycf\", \"type\": \"text\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
8626         "type": "json"
8627       }
8628     ],
8629     "name": "CreateCustomField",
8630     "group": "Custom_Fields",
8631     "description": "<p>Motion 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     "version": "0.0.0",
8633     "filename": "server/api/cmCustomField/index.js",
8634     "groupTitle": "Custom_Fields"
8635   },
8636   {
8637     "type": "post",
8638     "url": "/api/dashboards/items",
8639     "title": "Create dasboard item",
8640     "examples": [
8641       {
8642         "title": "Example usage:",
8643         "content": "curl https://{domain}/api/dashboards/items \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
8644         "type": "json"
8645       }
8646     ],
8647     "name": "Create",
8648     "group": "Dashboard_Items",
8649     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8650     "version": "0.0.0",
8651     "filename": "server/api/dashboardItem/index.js",
8652     "groupTitle": "Dashboard_Items"
8653   },
8654   {
8655     "type": "delete",
8656     "url": "/api/dashboards/items/{id}",
8657     "title": "Deletes a Dashboard Item",
8658     "examples": [
8659       {
8660         "title": "Example usage:",
8661         "content": "curl https://{domain}/api/dashboards/items/{id} -v -u {name}:{password} -X DELETE",
8662         "type": "json"
8663       }
8664     ],
8665     "name": "DeleteDashboard_Items",
8666     "group": "Dashboard_Items",
8667     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8668     "version": "0.0.0",
8669     "filename": "server/api/dashboardItem/index.js",
8670     "groupTitle": "Dashboard_Items"
8671   },
8672   {
8673     "type": "get",
8674     "url": "/api/dashboards/items/{id}",
8675     "title": "Gets a single Dashboard Item",
8676     "examples": [
8677       {
8678         "title": "Example usage:",
8679         "content": "curl https://{domain}/api/dashboards/items/{id} -v -u {name}:{password}",
8680         "type": "json"
8681       }
8682     ],
8683     "name": "ShowDashboard_Items",
8684     "group": "Dashboard_Items",
8685     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <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     "version": "0.0.0",
8687     "filename": "server/api/dashboardItem/index.js",
8688     "groupTitle": "Dashboard_Items"
8689   },
8690   {
8691     "type": "put",
8692     "url": "/api/dashboards/items/{id}",
8693     "title": "Update an existing item",
8694     "examples": [
8695       {
8696         "title": "Example usage:",
8697         "content": "curl https://{domain}/api/dashboards/items/{id} -v -u {name}:{password} -X PUT",
8698         "type": "json"
8699       }
8700     ],
8701     "name": "Update",
8702     "group": "Dashboard_Items",
8703     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <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     "version": "0.0.0",
8705     "filename": "server/api/dashboardItem/index.js",
8706     "groupTitle": "Dashboard_Items"
8707   },
8708   {
8709     "type": "post",
8710     "url": "/api/dashboards/clone",
8711     "title": "Clone an existing Dashboard",
8712     "examples": [
8713       {
8714         "title": "Example usage:",
8715         "content": "curl https://{domain}/api/dashboards/clone -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
8716         "type": "json"
8717       }
8718     ],
8719     "name": "CloneDashboards",
8720     "group": "Dashboards",
8721     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8722     "version": "0.0.0",
8723     "filename": "server/api/dashboard/index.js",
8724     "groupTitle": "Dashboards"
8725   },
8726   {
8727     "type": "post",
8728     "url": "/api/dashboards",
8729     "title": "Creates a new Dashboard",
8730     "examples": [
8731       {
8732         "title": "Example usage:",
8733         "content": "curl https://{domain}/api/dashboards -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
8734         "type": "json"
8735       }
8736     ],
8737     "name": "CreateDashboards",
8738     "group": "Dashboards",
8739     "parameter": {
8740       "fields": {
8741         "Body": [
8742           {
8743             "group": "Body",
8744             "type": "String",
8745             "optional": false,
8746             "field": "name",
8747             "description": ""
8748           },
8749           {
8750             "group": "Body",
8751             "type": "String",
8752             "optional": true,
8753             "field": "description",
8754             "description": ""
8755           }
8756         ]
8757       }
8758     },
8759     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8760     "version": "0.0.0",
8761     "filename": "server/api/dashboard/index.js",
8762     "groupTitle": "Dashboards"
8763   },
8764   {
8765     "type": "delete",
8766     "url": "/api/dashboards/{id}",
8767     "title": "Deletes a Dashboard",
8768     "examples": [
8769       {
8770         "title": "Example usage:",
8771         "content": "curl https://{domain}/api/dashboards/{id} -v -u {name}:{password} -X DELETE",
8772         "type": "json"
8773       }
8774     ],
8775     "name": "DeleteDashboards",
8776     "group": "Dashboards",
8777     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8778     "version": "0.0.0",
8779     "filename": "server/api/dashboard/index.js",
8780     "groupTitle": "Dashboards"
8781   },
8782   {
8783     "type": "get",
8784     "url": "/api/dashboards",
8785     "title": "Gets a list of Dashboards",
8786     "examples": [
8787       {
8788         "title": "Example usage:",
8789         "content": "curl https://{domain}/api/dashboards -v -u {name}:{password}",
8790         "type": "json"
8791       }
8792     ],
8793     "name": "GetDashboards",
8794     "group": "Dashboards",
8795     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/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&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
8796     "version": "0.0.0",
8797     "filename": "server/api/dashboard/index.js",
8798     "groupTitle": "Dashboards"
8799   },
8800   {
8801     "type": "get",
8802     "url": "/api/dashboards/{id}",
8803     "title": "Gets a single Dashboard",
8804     "examples": [
8805       {
8806         "title": "Example usage:",
8807         "content": "curl https://{domain}/api/dashboards/{id} -v -u {name}:{password}",
8808         "type": "json"
8809       }
8810     ],
8811     "name": "ShowDashboards",
8812     "group": "Dashboards",
8813     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8814     "version": "0.0.0",
8815     "filename": "server/api/dashboard/index.js",
8816     "groupTitle": "Dashboards"
8817   },
8818   {
8819     "type": "post",
8820     "url": "/api/dashboards/{id}/items",
8821     "title": "Creates new item",
8822     "examples": [
8823       {
8824         "title": "Example usage:",
8825         "content": "curl https://{domain}/api/dashboards/{id}/items -d '{\"type\": \"counter\", \"...\": \"...\"}]' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
8826         "type": "json"
8827       }
8828     ],
8829     "name": "addItem",
8830     "group": "Dashboards",
8831     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8832     "version": "0.0.0",
8833     "filename": "server/api/dashboard/index.js",
8834     "groupTitle": "Dashboards"
8835   },
8836   {
8837     "type": "get",
8838     "url": "/api/dashboards/{id}/items",
8839     "title": "Gets items",
8840     "examples": [
8841       {
8842         "title": "Example usage:",
8843         "content": "curl https://{domain}/api/dashboards/{id}/items -v -u {name}:{password} -X GET",
8844         "type": "json"
8845       }
8846     ],
8847     "name": "getItems",
8848     "group": "Dashboards",
8849     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8850     "version": "0.0.0",
8851     "filename": "server/api/dashboard/index.js",
8852     "groupTitle": "Dashboards"
8853   },
8854   {
8855     "type": "put",
8856     "url": "/api/dashboards/{id}",
8857     "title": "Update an existing Dashboard",
8858     "examples": [
8859       {
8860         "title": "Example usage:",
8861         "content": "curl https://{domain}/api/dashboards/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
8862         "type": "json"
8863       }
8864     ],
8865     "name": "updateDashboards",
8866     "group": "Dashboards",
8867     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8868     "version": "0.0.0",
8869     "filename": "server/api/dashboard/index.js",
8870     "groupTitle": "Dashboards"
8871   },
8872   {
8873     "type": "post",
8874     "url": "/api/integrations/desk/accounts",
8875     "title": "Creates a new Desk Account",
8876     "examples": [
8877       {
8878         "title": "Example usage:",
8879         "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",
8880         "type": "json"
8881       }
8882     ],
8883     "name": "CreateDesk_Accounts",
8884     "group": "Desk_Accounts",
8885     "parameter": {
8886       "fields": {
8887         "Body": [
8888           {
8889             "group": "Body",
8890             "type": "String",
8891             "optional": true,
8892             "field": "name",
8893             "description": ""
8894           },
8895           {
8896             "group": "Body",
8897             "type": "String",
8898             "optional": true,
8899             "field": "description",
8900             "description": ""
8901           },
8902           {
8903             "group": "Body",
8904             "type": "String",
8905             "optional": true,
8906             "field": "username",
8907             "description": ""
8908           },
8909           {
8910             "group": "Body",
8911             "type": "String",
8912             "optional": true,
8913             "field": "remoteUri",
8914             "description": ""
8915           },
8916           {
8917             "group": "Body",
8918             "type": "String",
8919             "allowedValues": [
8920               "\"basic\""
8921             ],
8922             "optional": true,
8923             "field": "authType",
8924             "description": ""
8925           },
8926           {
8927             "group": "Body",
8928             "type": "String",
8929             "optional": true,
8930             "field": "password",
8931             "description": ""
8932           },
8933           {
8934             "group": "Body",
8935             "type": "String",
8936             "optional": true,
8937             "field": "consumerKey",
8938             "description": ""
8939           },
8940           {
8941             "group": "Body",
8942             "type": "String",
8943             "optional": true,
8944             "field": "consumerSecret",
8945             "description": ""
8946           },
8947           {
8948             "group": "Body",
8949             "type": "String",
8950             "optional": true,
8951             "field": "token",
8952             "description": ""
8953           },
8954           {
8955             "group": "Body",
8956             "type": "String",
8957             "optional": true,
8958             "field": "tokenSecret",
8959             "description": ""
8960           },
8961           {
8962             "group": "Body",
8963             "type": "String",
8964             "optional": false,
8965             "field": "serverUrl",
8966             "description": ""
8967           },
8968           {
8969             "group": "Body",
8970             "type": "String",
8971             "allowedValues": [
8972               "\"integrationTab\"",
8973               "\"newTab\""
8974             ],
8975             "optional": true,
8976             "field": "type",
8977             "description": ""
8978           }
8979         ]
8980       }
8981     },
8982     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8983     "version": "0.0.0",
8984     "filename": "server/api/intDeskAccount/index.js",
8985     "groupTitle": "Desk_Accounts"
8986   },
8987   {
8988     "type": "delete",
8989     "url": "/api/integrations/desk/accounts/{id}",
8990     "title": "Deletes a Desk Account",
8991     "examples": [
8992       {
8993         "title": "Example usage:",
8994         "content": "curl https://{domain}/api/integrations/desk/accounts/{id} -v -u {name}:{password} -X DELETE",
8995         "type": "json"
8996       }
8997     ],
8998     "name": "DeleteDesk_Accounts",
8999     "group": "Desk_Accounts",
9000     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9001     "version": "0.0.0",
9002     "filename": "server/api/intDeskAccount/index.js",
9003     "groupTitle": "Desk_Accounts"
9004   },
9005   {
9006     "type": "get",
9007     "url": "/api/integrations/desk/accounts",
9008     "title": "Gets a list of Desk Accounts",
9009     "examples": [
9010       {
9011         "title": "Example usage:",
9012         "content": "curl https://{domain}/api/integrations/desk/accounts -v -u {name}:{password}",
9013         "type": "json"
9014       }
9015     ],
9016     "name": "GetDesk_Accounts",
9017     "group": "Desk_Accounts",
9018     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
9019     "version": "0.0.0",
9020     "filename": "server/api/intDeskAccount/index.js",
9021     "groupTitle": "Desk_Accounts"
9022   },
9023   {
9024     "type": "get",
9025     "url": "/api/integrations/desk/accounts/{id}",
9026     "title": "Gets a single Desk Account",
9027     "examples": [
9028       {
9029         "title": "Example usage:",
9030         "content": "curl https://{domain}/api/integrations/desk/accounts/{id} -v -u {name}:{password}",
9031         "type": "json"
9032       }
9033     ],
9034     "name": "ShowDesk_Accounts",
9035     "group": "Desk_Accounts",
9036     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9037     "version": "0.0.0",
9038     "filename": "server/api/intDeskAccount/index.js",
9039     "groupTitle": "Desk_Accounts"
9040   },
9041   {
9042     "type": "post",
9043     "url": "/api/integrations/desk/accounts/{id}/configurations",
9044     "title": "Creates new configuration",
9045     "examples": [
9046       {
9047         "title": "Example usage:",
9048         "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",
9049         "type": "json"
9050       }
9051     ],
9052     "name": "addConfiguration",
9053     "group": "Desk_Accounts",
9054     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9055     "version": "0.0.0",
9056     "filename": "server/api/intDeskAccount/index.js",
9057     "groupTitle": "Desk_Accounts"
9058   },
9059   {
9060     "type": "get",
9061     "url": "/api/integrations/desk/accounts/{id}/configurations",
9062     "title": "Gets account configurations",
9063     "examples": [
9064       {
9065         "title": "Example usage:",
9066         "content": "curl https://{domain}/api/integrations/desk/accounts/{id}/configurations -v -u {name}:{password} -X GET",
9067         "type": "json"
9068       }
9069     ],
9070     "name": "getConfigurations",
9071     "group": "Desk_Accounts",
9072     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9073     "version": "0.0.0",
9074     "filename": "server/api/intDeskAccount/index.js",
9075     "groupTitle": "Desk_Accounts"
9076   },
9077   {
9078     "type": "get",
9079     "url": "/api/integrations/desk/accounts/{id}/fields",
9080     "title": "Gets account fields",
9081     "examples": [
9082       {
9083         "title": "Example usage:",
9084         "content": "curl https://{domain}/api/integrations/desk/accounts/{id}/fields -v -u {name}:{password} -X GET",
9085         "type": "json"
9086       }
9087     ],
9088     "name": "getFields",
9089     "group": "Desk_Accounts",
9090     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9091     "version": "0.0.0",
9092     "filename": "server/api/intDeskAccount/index.js",
9093     "groupTitle": "Desk_Accounts"
9094   },
9095   {
9096     "type": "put",
9097     "url": "/api/integrations/desk/accounts/{id}",
9098     "title": "Update an existing Desk Account",
9099     "examples": [
9100       {
9101         "title": "Example usage:",
9102         "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",
9103         "type": "json"
9104       }
9105     ],
9106     "name": "updateDesk_Accounts",
9107     "group": "Desk_Accounts",
9108     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9109     "version": "0.0.0",
9110     "filename": "server/api/intDeskAccount/index.js",
9111     "groupTitle": "Desk_Accounts"
9112   },
9113   {
9114     "type": "post",
9115     "url": "/api/integrations/desk/configurations",
9116     "title": "Creates a new Desk Configuration",
9117     "examples": [
9118       {
9119         "title": "Example usage:",
9120         "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",
9121         "type": "json"
9122       }
9123     ],
9124     "name": "CreateDesk_Configurations",
9125     "group": "Desk_Configurations",
9126     "parameter": {
9127       "fields": {
9128         "Body": [
9129           {
9130             "group": "Body",
9131             "type": "String",
9132             "optional": true,
9133             "field": "name",
9134             "description": ""
9135           },
9136           {
9137             "group": "Body",
9138             "type": "String",
9139             "optional": true,
9140             "field": "description",
9141             "description": ""
9142           }
9143         ]
9144       }
9145     },
9146     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9147     "version": "0.0.0",
9148     "filename": "server/api/intDeskConfiguration/index.js",
9149     "groupTitle": "Desk_Configurations"
9150   },
9151   {
9152     "type": "delete",
9153     "url": "/api/integrations/desk/configurations/{id}",
9154     "title": "Deletes a Desk Configuration",
9155     "examples": [
9156       {
9157         "title": "Example usage:",
9158         "content": "curl https://{domain}/api/integrations/desk/configurations/{id} -v -u {name}:{password} -X DELETE",
9159         "type": "json"
9160       }
9161     ],
9162     "name": "DeleteDesk_Configurations",
9163     "group": "Desk_Configurations",
9164     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9165     "version": "0.0.0",
9166     "filename": "server/api/intDeskConfiguration/index.js",
9167     "groupTitle": "Desk_Configurations"
9168   },
9169   {
9170     "type": "get",
9171     "url": "/api/integrations/desk/configurations",
9172     "title": "Gets a list of Desk Configurations",
9173     "examples": [
9174       {
9175         "title": "Example usage:",
9176         "content": "curl https://{domain}/api/integrations/desk/configurations -v -u {name}:{password}",
9177         "type": "json"
9178       }
9179     ],
9180     "name": "GetDesk_Configurations",
9181     "group": "Desk_Configurations",
9182     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
9183     "version": "0.0.0",
9184     "filename": "server/api/intDeskConfiguration/index.js",
9185     "groupTitle": "Desk_Configurations"
9186   },
9187   {
9188     "type": "get",
9189     "url": "/api/integrations/desk/configurations/{id}",
9190     "title": "Gets a single Desk Configuration",
9191     "examples": [
9192       {
9193         "title": "Example usage:",
9194         "content": "curl https://{domain}/api/integrations/desk/configurations/{id} -v -u {name}:{password}",
9195         "type": "json"
9196       }
9197     ],
9198     "name": "ShowDesk_Configurations",
9199     "group": "Desk_Configurations",
9200     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9201     "version": "0.0.0",
9202     "filename": "server/api/intDeskConfiguration/index.js",
9203     "groupTitle": "Desk_Configurations"
9204   },
9205   {
9206     "type": "get",
9207     "url": "/api/integrations/desk/configurations/{id}/descriptions",
9208     "title": "Gets configurations descriptions",
9209     "examples": [
9210       {
9211         "title": "Example usage:",
9212         "content": "curl https://{domain}/api/integrations/desk/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
9213         "type": "json"
9214       }
9215     ],
9216     "name": "getDescriptions",
9217     "group": "Desk_Configurations",
9218     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9219     "version": "0.0.0",
9220     "filename": "server/api/intDeskConfiguration/index.js",
9221     "groupTitle": "Desk_Configurations"
9222   },
9223   {
9224     "type": "get",
9225     "url": "/api/integrations/desk/configurations/{id}/fields",
9226     "title": "Gets configurations fields",
9227     "examples": [
9228       {
9229         "title": "Example usage:",
9230         "content": "curl https://{domain}/api/integrations/desk/configurations/{id}/fields -v -u {name}:{password} -X GET",
9231         "type": "json"
9232       }
9233     ],
9234     "name": "getFields",
9235     "group": "Desk_Configurations",
9236     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9237     "version": "0.0.0",
9238     "filename": "server/api/intDeskConfiguration/index.js",
9239     "groupTitle": "Desk_Configurations"
9240   },
9241   {
9242     "type": "get",
9243     "url": "/api/integrations/desk/configurations/{id}/subjects",
9244     "title": "Gets configurations subjects",
9245     "examples": [
9246       {
9247         "title": "Example usage:",
9248         "content": "curl https://{domain}/api/integrations/desk/configurations/{id}/subjects -v -u {name}:{password} -X GET",
9249         "type": "json"
9250       }
9251     ],
9252     "name": "getSubjects",
9253     "group": "Desk_Configurations",
9254     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9255     "version": "0.0.0",
9256     "filename": "server/api/intDeskConfiguration/index.js",
9257     "groupTitle": "Desk_Configurations"
9258   },
9259   {
9260     "type": "get",
9261     "url": "/api/integrations/desk/configurations/{id}/tags",
9262     "title": "Gets configurations tags",
9263     "examples": [
9264       {
9265         "title": "Example usage:",
9266         "content": "curl https://{domain}/api/integrations/desk/configurations/{id}/tags -v -u {name}:{password} -X GET",
9267         "type": "json"
9268       }
9269     ],
9270     "name": "getTags",
9271     "group": "Desk_Configurations",
9272     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9273     "version": "0.0.0",
9274     "filename": "server/api/intDeskConfiguration/index.js",
9275     "groupTitle": "Desk_Configurations"
9276   },
9277   {
9278     "type": "post",
9279     "url": "/api/integrations/desk/configurations/{id}/tags",
9280     "title": "Sets new tags",
9281     "examples": [
9282       {
9283         "title": "Example usage:",
9284         "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",
9285         "type": "json"
9286       }
9287     ],
9288     "name": "setTags",
9289     "group": "Desk_Configurations",
9290     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9291     "version": "0.0.0",
9292     "filename": "server/api/intDeskConfiguration/index.js",
9293     "groupTitle": "Desk_Configurations"
9294   },
9295   {
9296     "type": "put",
9297     "url": "/api/integrations/desk/configurations/{id}",
9298     "title": "Update an existing Desk Configuration",
9299     "examples": [
9300       {
9301         "title": "Example usage:",
9302         "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",
9303         "type": "json"
9304       }
9305     ],
9306     "name": "updateDesk_Configurations",
9307     "group": "Desk_Configurations",
9308     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9309     "version": "0.0.0",
9310     "filename": "server/api/intDeskConfiguration/index.js",
9311     "groupTitle": "Desk_Configurations"
9312   },
9313   {
9314     "type": "post",
9315     "url": "/api/integrations/desk/fields",
9316     "title": "Creates a new Desk Field",
9317     "examples": [
9318       {
9319         "title": "Example usage:",
9320         "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",
9321         "type": "json"
9322       }
9323     ],
9324     "name": "CreateDesk_Fields",
9325     "group": "Desk_Fields",
9326     "parameter": {
9327       "fields": {
9328         "Body": [
9329           {
9330             "group": "Body",
9331             "type": "String",
9332             "allowedValues": [
9333               "\"string\"",
9334               "\"variable\"",
9335               "\"customVariable\"",
9336               "\"keyValue\"",
9337               "\"picklist\""
9338             ],
9339             "optional": true,
9340             "field": "type",
9341             "description": ""
9342           },
9343           {
9344             "group": "Body",
9345             "type": "String",
9346             "optional": true,
9347             "field": "content",
9348             "description": ""
9349           },
9350           {
9351             "group": "Body",
9352             "type": "String",
9353             "optional": true,
9354             "field": "key",
9355             "description": ""
9356           },
9357           {
9358             "group": "Body",
9359             "type": "String",
9360             "allowedValues": [
9361               "\"string\"",
9362               "\"variable\"",
9363               "\"customVariable\""
9364             ],
9365             "optional": true,
9366             "field": "keyType",
9367             "description": ""
9368           },
9369           {
9370             "group": "Body",
9371             "type": "String",
9372             "optional": true,
9373             "field": "keyContent",
9374             "description": ""
9375           },
9376           {
9377             "group": "Body",
9378             "type": "String",
9379             "optional": true,
9380             "field": "idField",
9381             "description": ""
9382           },
9383           {
9384             "group": "Body",
9385             "type": "String",
9386             "optional": true,
9387             "field": "nameField",
9388             "description": ""
9389           },
9390           {
9391             "group": "Body",
9392             "type": "Boolean",
9393             "optional": true,
9394             "field": "customField",
9395             "description": ""
9396           },
9397           {
9398             "group": "Body",
9399             "type": "String",
9400             "optional": true,
9401             "field": "variableName",
9402             "description": ""
9403           }
9404         ]
9405       }
9406     },
9407     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9408     "version": "0.0.0",
9409     "filename": "server/api/intDeskField/index.js",
9410     "groupTitle": "Desk_Fields"
9411   },
9412   {
9413     "type": "delete",
9414     "url": "/api/integrations/desk/fields/{id}",
9415     "title": "Deletes a Desk Field",
9416     "examples": [
9417       {
9418         "title": "Example usage:",
9419         "content": "curl https://{domain}/api/integrations/desk/fields/{id} -v -u {name}:{password} -X DELETE",
9420         "type": "json"
9421       }
9422     ],
9423     "name": "DeleteDesk_Fields",
9424     "group": "Desk_Fields",
9425     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9426     "version": "0.0.0",
9427     "filename": "server/api/intDeskField/index.js",
9428     "groupTitle": "Desk_Fields"
9429   },
9430   {
9431     "type": "get",
9432     "url": "/api/integrations/desk/fields",
9433     "title": "Gets a list of Desk Fields",
9434     "examples": [
9435       {
9436         "title": "Example usage:",
9437         "content": "curl https://{domain}/api/integrations/desk/fields -v -u {name}:{password}",
9438         "type": "json"
9439       }
9440     ],
9441     "name": "GetDesk_Fields",
9442     "group": "Desk_Fields",
9443     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
9444     "version": "0.0.0",
9445     "filename": "server/api/intDeskField/index.js",
9446     "groupTitle": "Desk_Fields"
9447   },
9448   {
9449     "type": "get",
9450     "url": "/api/integrations/desk/fields/{id}",
9451     "title": "Gets a single Desk Field",
9452     "examples": [
9453       {
9454         "title": "Example usage:",
9455         "content": "curl https://{domain}/api/integrations/desk/fields/{id} -v -u {name}:{password}",
9456         "type": "json"
9457       }
9458     ],
9459     "name": "ShowDesk_Fields",
9460     "group": "Desk_Fields",
9461     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9462     "version": "0.0.0",
9463     "filename": "server/api/intDeskField/index.js",
9464     "groupTitle": "Desk_Fields"
9465   },
9466   {
9467     "type": "put",
9468     "url": "/api/integrations/desk/fields/{id}",
9469     "title": "Update an existing Desk Field",
9470     "examples": [
9471       {
9472         "title": "Example usage:",
9473         "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",
9474         "type": "json"
9475       }
9476     ],
9477     "name": "updateDesk_Fields",
9478     "group": "Desk_Fields",
9479     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9480     "version": "0.0.0",
9481     "filename": "server/api/intDeskField/index.js",
9482     "groupTitle": "Desk_Fields"
9483   },
9484   {
9485     "type": "post",
9486     "url": "/api/dispositions",
9487     "title": "Creates a new Disposition",
9488     "examples": [
9489       {
9490         "title": "Example usage:",
9491         "content": "curl https://{domain}/api/dispositions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
9492         "type": "json"
9493       }
9494     ],
9495     "name": "CreateDispositions",
9496     "group": "Dispositions",
9497     "parameter": {
9498       "fields": {
9499         "Body": [
9500           {
9501             "group": "Body",
9502             "type": "String",
9503             "optional": false,
9504             "field": "name",
9505             "description": ""
9506           },
9507           {
9508             "group": "Body",
9509             "type": "String",
9510             "allowedValues": [
9511               "\"first\"",
9512               "\"second\"",
9513               "\"third\""
9514             ],
9515             "optional": false,
9516             "field": "level",
9517             "description": ""
9518           },
9519           {
9520             "group": "Body",
9521             "type": "String",
9522             "optional": true,
9523             "field": "description",
9524             "description": ""
9525           }
9526         ]
9527       }
9528     },
9529     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9530     "version": "0.0.0",
9531     "filename": "server/api/disposition/index.js",
9532     "groupTitle": "Dispositions"
9533   },
9534   {
9535     "type": "delete",
9536     "url": "/api/dispositions/{id}",
9537     "title": "Deletes a Disposition",
9538     "examples": [
9539       {
9540         "title": "Example usage:",
9541         "content": "curl https://{domain}/api/dispositions/{id} -v -u {name}:{password} -X DELETE",
9542         "type": "json"
9543       }
9544     ],
9545     "name": "DeleteDispositions",
9546     "group": "Dispositions",
9547     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9548     "version": "0.0.0",
9549     "filename": "server/api/disposition/index.js",
9550     "groupTitle": "Dispositions"
9551   },
9552   {
9553     "type": "get",
9554     "url": "/api/dispositions",
9555     "title": "Gets a list of Dispositions",
9556     "examples": [
9557       {
9558         "title": "Example usage:",
9559         "content": "curl https://{domain}/api/dispositions -v -u {name}:{password}",
9560         "type": "json"
9561       }
9562     ],
9563     "name": "GetDispositions",
9564     "group": "Dispositions",
9565     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
9566     "version": "0.0.0",
9567     "filename": "server/api/disposition/index.js",
9568     "groupTitle": "Dispositions"
9569   },
9570   {
9571     "type": "get",
9572     "url": "/api/dispositions/{id}",
9573     "title": "Gets a single Disposition",
9574     "examples": [
9575       {
9576         "title": "Example usage:",
9577         "content": "curl https://{domain}/api/dispositions/{id} -v -u {name}:{password}",
9578         "type": "json"
9579       }
9580     ],
9581     "name": "ShowDispositions",
9582     "group": "Dispositions",
9583     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9584     "version": "0.0.0",
9585     "filename": "server/api/disposition/index.js",
9586     "groupTitle": "Dispositions"
9587   },
9588   {
9589     "type": "put",
9590     "url": "/api/dispositions/{id}",
9591     "title": "Update an existing Disposition",
9592     "examples": [
9593       {
9594         "title": "Example usage:",
9595         "content": "curl https://{domain}/api/dispositions/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
9596         "type": "json"
9597       }
9598     ],
9599     "name": "updateDispositions",
9600     "group": "Dispositions",
9601     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9602     "version": "0.0.0",
9603     "filename": "server/api/disposition/index.js",
9604     "groupTitle": "Dispositions"
9605   },
9606   {
9607     "type": "post",
9608     "url": "/api/integrations/dynamics365/accounts",
9609     "title": "Creates a new Dynamics365 Account",
9610     "examples": [
9611       {
9612         "title": "Example usage:",
9613         "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",
9614         "type": "json"
9615       }
9616     ],
9617     "name": "CreateDynamics365_Accounts",
9618     "group": "Dynamics365_Accounts",
9619     "parameter": {
9620       "fields": {
9621         "Body": [
9622           {
9623             "group": "Body",
9624             "type": "String",
9625             "optional": true,
9626             "field": "name",
9627             "description": ""
9628           },
9629           {
9630             "group": "Body",
9631             "type": "String",
9632             "optional": true,
9633             "field": "username",
9634             "description": ""
9635           },
9636           {
9637             "group": "Body",
9638             "type": "String",
9639             "optional": true,
9640             "field": "password",
9641             "description": ""
9642           },
9643           {
9644             "group": "Body",
9645             "type": "String",
9646             "optional": true,
9647             "field": "remoteUri",
9648             "description": ""
9649           },
9650           {
9651             "group": "Body",
9652             "type": "String",
9653             "optional": true,
9654             "field": "tenantId",
9655             "description": ""
9656           },
9657           {
9658             "group": "Body",
9659             "type": "String",
9660             "optional": true,
9661             "field": "clientId",
9662             "description": ""
9663           },
9664           {
9665             "group": "Body",
9666             "type": "String",
9667             "optional": true,
9668             "field": "clientSecret",
9669             "description": ""
9670           },
9671           {
9672             "group": "Body",
9673             "type": "String",
9674             "optional": false,
9675             "field": "serverUrl",
9676             "description": ""
9677           },
9678           {
9679             "group": "Body",
9680             "type": "String",
9681             "optional": true,
9682             "field": "description",
9683             "description": ""
9684           }
9685         ]
9686       }
9687     },
9688     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9689     "version": "0.0.0",
9690     "filename": "server/api/intDynamics365Account/index.js",
9691     "groupTitle": "Dynamics365_Accounts"
9692   },
9693   {
9694     "type": "delete",
9695     "url": "/api/integrations/dynamics365/accounts/{id}",
9696     "title": "Deletes a Dynamics365 Account",
9697     "examples": [
9698       {
9699         "title": "Example usage:",
9700         "content": "curl https://{domain}/api/integrations/dynamics365/accounts/{id} -v -u {name}:{password} -X DELETE",
9701         "type": "json"
9702       }
9703     ],
9704     "name": "DeleteDynamics365_Accounts",
9705     "group": "Dynamics365_Accounts",
9706     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9707     "version": "0.0.0",
9708     "filename": "server/api/intDynamics365Account/index.js",
9709     "groupTitle": "Dynamics365_Accounts"
9710   },
9711   {
9712     "type": "get",
9713     "url": "/api/integrations/dynamics365/accounts",
9714     "title": "Gets a list of Dynamics365 Accounts",
9715     "examples": [
9716       {
9717         "title": "Example usage:",
9718         "content": "curl https://{domain}/api/integrations/dynamics365/accounts -v -u {name}:{password}",
9719         "type": "json"
9720       }
9721     ],
9722     "name": "GetDynamics365_Accounts",
9723     "group": "Dynamics365_Accounts",
9724     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
9725     "version": "0.0.0",
9726     "filename": "server/api/intDynamics365Account/index.js",
9727     "groupTitle": "Dynamics365_Accounts"
9728   },
9729   {
9730     "type": "get",
9731     "url": "/api/integrations/dynamics365/accounts/{id}",
9732     "title": "Gets a single Dynamics365 Account",
9733     "examples": [
9734       {
9735         "title": "Example usage:",
9736         "content": "curl https://{domain}/api/integrations/dynamics365/accounts/{id} -v -u {name}:{password}",
9737         "type": "json"
9738       }
9739     ],
9740     "name": "ShowDynamics365_Accounts",
9741     "group": "Dynamics365_Accounts",
9742     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9743     "version": "0.0.0",
9744     "filename": "server/api/intDynamics365Account/index.js",
9745     "groupTitle": "Dynamics365_Accounts"
9746   },
9747   {
9748     "type": "post",
9749     "url": "/api/integrations/dynamics365/accounts/{id}/configurations",
9750     "title": "Creates new configuration",
9751     "examples": [
9752       {
9753         "title": "Example usage:",
9754         "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",
9755         "type": "json"
9756       }
9757     ],
9758     "name": "addConfiguration",
9759     "group": "Dynamics365_Accounts",
9760     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9761     "version": "0.0.0",
9762     "filename": "server/api/intDynamics365Account/index.js",
9763     "groupTitle": "Dynamics365_Accounts"
9764   },
9765   {
9766     "type": "get",
9767     "url": "/api/integrations/dynamics365/accounts/{id}/configurations",
9768     "title": "Gets account configurations",
9769     "examples": [
9770       {
9771         "title": "Example usage:",
9772         "content": "curl https://{domain}/api/integrations/dynamics365/accounts/{id}/configurations -v -u {name}:{password} -X GET",
9773         "type": "json"
9774       }
9775     ],
9776     "name": "getConfigurations",
9777     "group": "Dynamics365_Accounts",
9778     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9779     "version": "0.0.0",
9780     "filename": "server/api/intDynamics365Account/index.js",
9781     "groupTitle": "Dynamics365_Accounts"
9782   },
9783   {
9784     "type": "get",
9785     "url": "/api/integrations/dynamics365/accounts/{id}/fields",
9786     "title": "Gets account fields",
9787     "examples": [
9788       {
9789         "title": "Example usage:",
9790         "content": "curl https://{domain}/api/integrations/dynamics365/accounts/{id}/fields -v -u {name}:{password} -X GET",
9791         "type": "json"
9792       }
9793     ],
9794     "name": "getFields",
9795     "group": "Dynamics365_Accounts",
9796     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9797     "version": "0.0.0",
9798     "filename": "server/api/intDynamics365Account/index.js",
9799     "groupTitle": "Dynamics365_Accounts"
9800   },
9801   {
9802     "type": "put",
9803     "url": "/api/integrations/dynamics365/accounts/{id}",
9804     "title": "Update an existing Dynamics365 Account",
9805     "examples": [
9806       {
9807         "title": "Example usage:",
9808         "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",
9809         "type": "json"
9810       }
9811     ],
9812     "name": "updateDynamics365_Accounts",
9813     "group": "Dynamics365_Accounts",
9814     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9815     "version": "0.0.0",
9816     "filename": "server/api/intDynamics365Account/index.js",
9817     "groupTitle": "Dynamics365_Accounts"
9818   },
9819   {
9820     "type": "post",
9821     "url": "/api/integrations/dynamics365/configurations",
9822     "title": "Creates a new Dynamics365 Configuration",
9823     "examples": [
9824       {
9825         "title": "Example usage:",
9826         "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",
9827         "type": "json"
9828       }
9829     ],
9830     "name": "CreateDynamics365_Configurations",
9831     "group": "Dynamics365_Configurations",
9832     "parameter": {
9833       "fields": {
9834         "Body": [
9835           {
9836             "group": "Body",
9837             "type": "String",
9838             "optional": true,
9839             "field": "name",
9840             "description": ""
9841           },
9842           {
9843             "group": "Body",
9844             "type": "String",
9845             "optional": true,
9846             "field": "description",
9847             "description": ""
9848           },
9849           {
9850             "group": "Body",
9851             "type": "String",
9852             "allowedValues": [
9853               "\"incident\"",
9854               "\"phonecall\""
9855             ],
9856             "optional": true,
9857             "field": "ticketType",
9858             "description": ""
9859           }
9860         ]
9861       }
9862     },
9863     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9864     "version": "0.0.0",
9865     "filename": "server/api/intDynamics365Configuration/index.js",
9866     "groupTitle": "Dynamics365_Configurations"
9867   },
9868   {
9869     "type": "delete",
9870     "url": "/api/integrations/dynamics365/configurations/{id}",
9871     "title": "Deletes a Dynamics365 Configuration",
9872     "examples": [
9873       {
9874         "title": "Example usage:",
9875         "content": "curl https://{domain}/api/integrations/dynamics365/configurations/{id} -v -u {name}:{password} -X DELETE",
9876         "type": "json"
9877       }
9878     ],
9879     "name": "DeleteDynamics365_Configurations",
9880     "group": "Dynamics365_Configurations",
9881     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9882     "version": "0.0.0",
9883     "filename": "server/api/intDynamics365Configuration/index.js",
9884     "groupTitle": "Dynamics365_Configurations"
9885   },
9886   {
9887     "type": "get",
9888     "url": "/api/integrations/dynamics365/configurations",
9889     "title": "Gets a list of Dynamics365 Configurations",
9890     "examples": [
9891       {
9892         "title": "Example usage:",
9893         "content": "curl https://{domain}/api/integrations/dynamics365/configurations -v -u {name}:{password}",
9894         "type": "json"
9895       }
9896     ],
9897     "name": "GetDynamics365_Configurations",
9898     "group": "Dynamics365_Configurations",
9899     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
9900     "version": "0.0.0",
9901     "filename": "server/api/intDynamics365Configuration/index.js",
9902     "groupTitle": "Dynamics365_Configurations"
9903   },
9904   {
9905     "type": "get",
9906     "url": "/api/integrations/dynamics365/configurations/{id}",
9907     "title": "Gets a single Dynamics365 Configuration",
9908     "examples": [
9909       {
9910         "title": "Example usage:",
9911         "content": "curl https://{domain}/api/integrations/dynamics365/configurations/{id} -v -u {name}:{password}",
9912         "type": "json"
9913       }
9914     ],
9915     "name": "ShowDynamics365_Configurations",
9916     "group": "Dynamics365_Configurations",
9917     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9918     "version": "0.0.0",
9919     "filename": "server/api/intDynamics365Configuration/index.js",
9920     "groupTitle": "Dynamics365_Configurations"
9921   },
9922   {
9923     "type": "get",
9924     "url": "/api/integrations/dynamics365/configurations/{id}/descriptions",
9925     "title": "Gets configurations descriptions",
9926     "examples": [
9927       {
9928         "title": "Example usage:",
9929         "content": "curl https://{domain}/api/integrations/dynamics365/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
9930         "type": "json"
9931       }
9932     ],
9933     "name": "getDescriptions",
9934     "group": "Dynamics365_Configurations",
9935     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9936     "version": "0.0.0",
9937     "filename": "server/api/intDynamics365Configuration/index.js",
9938     "groupTitle": "Dynamics365_Configurations"
9939   },
9940   {
9941     "type": "get",
9942     "url": "/api/integrations/dynamics365/configurations/{id}/fields",
9943     "title": "Gets configurations fields",
9944     "examples": [
9945       {
9946         "title": "Example usage:",
9947         "content": "curl https://{domain}/api/integrations/zoho/configurations/{id}/fields -v -u {name}:{password} -X GET",
9948         "type": "json"
9949       }
9950     ],
9951     "name": "getFields",
9952     "group": "Dynamics365_Configurations",
9953     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9954     "version": "0.0.0",
9955     "filename": "server/api/intDynamics365Configuration/index.js",
9956     "groupTitle": "Dynamics365_Configurations"
9957   },
9958   {
9959     "type": "get",
9960     "url": "/api/integrations/zoho/configurations/{id}/subjects",
9961     "title": "Gets configurations subjects",
9962     "examples": [
9963       {
9964         "title": "Example usage:",
9965         "content": "curl https://{domain}/api/integrations/dynamics365/configurations/{id}/subjects -v -u {name}:{password} -X GET",
9966         "type": "json"
9967       }
9968     ],
9969     "name": "getSubjects",
9970     "group": "Dynamics365_Configurations",
9971     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9972     "version": "0.0.0",
9973     "filename": "server/api/intDynamics365Configuration/index.js",
9974     "groupTitle": "Dynamics365_Configurations"
9975   },
9976   {
9977     "type": "put",
9978     "url": "/api/integrations/dynamics365/configurations/{id}",
9979     "title": "Update an existing Dynamics365 Configuration",
9980     "examples": [
9981       {
9982         "title": "Example usage:",
9983         "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",
9984         "type": "json"
9985       }
9986     ],
9987     "name": "updateDynamics365_Configurations",
9988     "group": "Dynamics365_Configurations",
9989     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9990     "version": "0.0.0",
9991     "filename": "server/api/intDynamics365Configuration/index.js",
9992     "groupTitle": "Dynamics365_Configurations"
9993   },
9994   {
9995     "type": "post",
9996     "url": "/api/integrations/dynamics365/fields",
9997     "title": "Creates a new Dynamics365 Field",
9998     "examples": [
9999       {
10000         "title": "Example usage:",
10001         "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",
10002         "type": "json"
10003       }
10004     ],
10005     "name": "CreateDynamics365_Fields",
10006     "group": "Dynamics365_Fields",
10007     "parameter": {
10008       "fields": {
10009         "Body": [
10010           {
10011             "group": "Body",
10012             "type": "String",
10013             "allowedValues": [
10014               "\"string\"",
10015               "\"variable\"",
10016               "\"customVariable\"",
10017               "\"keyValue\"",
10018               "\"picklist\""
10019             ],
10020             "optional": true,
10021             "field": "type",
10022             "description": ""
10023           },
10024           {
10025             "group": "Body",
10026             "type": "String",
10027             "optional": true,
10028             "field": "content",
10029             "description": ""
10030           },
10031           {
10032             "group": "Body",
10033             "type": "String",
10034             "optional": true,
10035             "field": "key",
10036             "description": ""
10037           },
10038           {
10039             "group": "Body",
10040             "type": "String",
10041             "allowedValues": [
10042               "\"string\"",
10043               "\"variable\"",
10044               "\"customVariable\""
10045             ],
10046             "optional": true,
10047             "field": "keyType",
10048             "description": ""
10049           },
10050           {
10051             "group": "Body",
10052             "type": "String",
10053             "optional": true,
10054             "field": "keyContent",
10055             "description": ""
10056           },
10057           {
10058             "group": "Body",
10059             "type": "String",
10060             "optional": true,
10061             "field": "idField",
10062             "description": ""
10063           },
10064           {
10065             "group": "Body",
10066             "type": "String",
10067             "optional": true,
10068             "field": "nameField",
10069             "description": ""
10070           },
10071           {
10072             "group": "Body",
10073             "type": "Boolean",
10074             "optional": true,
10075             "field": "customField",
10076             "description": ""
10077           },
10078           {
10079             "group": "Body",
10080             "type": "String",
10081             "optional": true,
10082             "field": "variableName",
10083             "description": ""
10084           }
10085         ]
10086       }
10087     },
10088     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10089     "version": "0.0.0",
10090     "filename": "server/api/intDynamics365Field/index.js",
10091     "groupTitle": "Dynamics365_Fields"
10092   },
10093   {
10094     "type": "delete",
10095     "url": "/api/integrations/dynamics365/fields/{id}",
10096     "title": "Deletes a Dynamics365 Field",
10097     "examples": [
10098       {
10099         "title": "Example usage:",
10100         "content": "curl https://{domain}/api/integrations/dynamics365/fields/{id} -v -u {name}:{password} -X DELETE",
10101         "type": "json"
10102       }
10103     ],
10104     "name": "DeleteDynamics365_Fields",
10105     "group": "Dynamics365_Fields",
10106     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10107     "version": "0.0.0",
10108     "filename": "server/api/intDynamics365Field/index.js",
10109     "groupTitle": "Dynamics365_Fields"
10110   },
10111   {
10112     "type": "get",
10113     "url": "/api/integrations/dynamics365/fields",
10114     "title": "Gets a list of Dynamics365 Fields",
10115     "examples": [
10116       {
10117         "title": "Example usage:",
10118         "content": "curl https://{domain}/api/integrations/dynamics365/fields -v -u {name}:{password}",
10119         "type": "json"
10120       }
10121     ],
10122     "name": "GetDynamics365_Fields",
10123     "group": "Dynamics365_Fields",
10124     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
10125     "version": "0.0.0",
10126     "filename": "server/api/intDynamics365Field/index.js",
10127     "groupTitle": "Dynamics365_Fields"
10128   },
10129   {
10130     "type": "get",
10131     "url": "/api/integrations/dynamics365/fields/{id}",
10132     "title": "Gets a single Dynamics365 Field",
10133     "examples": [
10134       {
10135         "title": "Example usage:",
10136         "content": "curl https://{domain}/api/integrations/dynamics365/fields/{id} -v -u {name}:{password}",
10137         "type": "json"
10138       }
10139     ],
10140     "name": "ShowDynamics365_Fields",
10141     "group": "Dynamics365_Fields",
10142     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10143     "version": "0.0.0",
10144     "filename": "server/api/intDynamics365Field/index.js",
10145     "groupTitle": "Dynamics365_Fields"
10146   },
10147   {
10148     "type": "put",
10149     "url": "/api/integrations/dynamics365/fields/{id}",
10150     "title": "Update an existing Dynamics365 Field",
10151     "examples": [
10152       {
10153         "title": "Example usage:",
10154         "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",
10155         "type": "json"
10156       }
10157     ],
10158     "name": "updateDynamics365_Fields",
10159     "group": "Dynamics365_Fields",
10160     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10161     "version": "0.0.0",
10162     "filename": "server/api/intDynamics365Field/index.js",
10163     "groupTitle": "Dynamics365_Fields"
10164   },
10165   {
10166     "type": "post",
10167     "url": "/api/fax/accounts/{id}/users",
10168     "title": "Add agents to a fax account",
10169     "examples": [
10170       {
10171         "title": "Example usage:",
10172         "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",
10173         "type": "json"
10174       }
10175     ],
10176     "name": "AddAgents",
10177     "group": "Fax_Accounts",
10178     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10179     "version": "0.0.0",
10180     "filename": "server/api/faxAccount/index.js",
10181     "groupTitle": "Fax_Accounts"
10182   },
10183   {
10184     "type": "post",
10185     "url": "/api/fax/accounts",
10186     "title": "Creates a new Account",
10187     "examples": [
10188       {
10189         "title": "Example usage:",
10190         "content": "curl https://{domain}/api/fax/accounts -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
10191         "type": "json"
10192       }
10193     ],
10194     "name": "CreateAccounts",
10195     "group": "Fax_Accounts",
10196     "parameter": {
10197       "fields": {
10198         "Body": [
10199           {
10200             "group": "Body",
10201             "type": "String",
10202             "optional": false,
10203             "field": "name",
10204             "description": ""
10205           },
10206           {
10207             "group": "Body",
10208             "type": "String",
10209             "optional": true,
10210             "field": "description",
10211             "description": ""
10212           },
10213           {
10214             "group": "Body",
10215             "type": "String",
10216             "allowedValues": [
10217               "\"yes\"",
10218               "\"no\""
10219             ],
10220             "optional": true,
10221             "field": "ecm",
10222             "description": ""
10223           },
10224           {
10225             "group": "Body",
10226             "type": "String",
10227             "optional": true,
10228             "field": "headerinfo",
10229             "description": ""
10230           },
10231           {
10232             "group": "Body",
10233             "type": "String",
10234             "optional": true,
10235             "field": "localstationid",
10236             "description": ""
10237           },
10238           {
10239             "group": "Body",
10240             "type": "String",
10241             "allowedValues": [
10242               "\"2400\"",
10243               "\"4800\"",
10244               "\"7200\"",
10245               "\"9600\"",
10246               "\"12000\"",
10247               "\"14400\""
10248             ],
10249             "optional": true,
10250             "field": "minrate",
10251             "description": ""
10252           },
10253           {
10254             "group": "Body",
10255             "type": "String",
10256             "allowedValues": [
10257               "\"2400\"",
10258               "\"4800\"",
10259               "\"7200\"",
10260               "\"9600\"",
10261               "\"12000\"",
10262               "\"14400\""
10263             ],
10264             "optional": true,
10265             "field": "maxrate",
10266             "description": ""
10267           },
10268           {
10269             "group": "Body",
10270             "type": "String",
10271             "optional": true,
10272             "field": "modem",
10273             "description": ""
10274           },
10275           {
10276             "group": "Body",
10277             "type": "String",
10278             "optional": true,
10279             "field": "gateway",
10280             "description": ""
10281           },
10282           {
10283             "group": "Body",
10284             "type": "String",
10285             "optional": true,
10286             "field": "faxdetect",
10287             "description": ""
10288           },
10289           {
10290             "group": "Body",
10291             "type": "Integer",
10292             "optional": true,
10293             "field": "t38timeout",
10294             "description": ""
10295           },
10296           {
10297             "group": "Body",
10298             "type": "String",
10299             "allowedValues": [
10300               "\"SIP\"",
10301               "\"IAX\"",
10302               "\"DADHI\"",
10303               "\"KHOMP\""
10304             ],
10305             "optional": true,
10306             "field": "tech",
10307             "description": ""
10308           },
10309           {
10310             "group": "Body",
10311             "type": "String",
10312             "optional": false,
10313             "field": "key",
10314             "description": ""
10315           },
10316           {
10317             "group": "Body",
10318             "type": "Text",
10319             "optional": true,
10320             "field": "notificationTemplate",
10321             "description": ""
10322           },
10323           {
10324             "group": "Body",
10325             "type": "Boolean",
10326             "optional": true,
10327             "field": "notificationSound",
10328             "description": ""
10329           },
10330           {
10331             "group": "Body",
10332             "type": "Boolean",
10333             "optional": true,
10334             "field": "notificationShake",
10335             "description": ""
10336           },
10337           {
10338             "group": "Body",
10339             "type": "Integer",
10340             "optional": true,
10341             "field": "waitForTheAssignedAgent",
10342             "description": ""
10343           },
10344           {
10345             "group": "Body",
10346             "type": "Boolean",
10347             "optional": true,
10348             "field": "queueTransfer",
10349             "description": ""
10350           },
10351           {
10352             "group": "Body",
10353             "type": "Integer",
10354             "optional": true,
10355             "field": "queueTransferTimeout",
10356             "description": ""
10357           },
10358           {
10359             "group": "Body",
10360             "type": "Boolean",
10361             "optional": true,
10362             "field": "agentTransfer",
10363             "description": ""
10364           },
10365           {
10366             "group": "Body",
10367             "type": "Integer",
10368             "optional": true,
10369             "field": "agentTransferTimeout",
10370             "description": ""
10371           },
10372           {
10373             "group": "Body",
10374             "type": "Integer",
10375             "optional": true,
10376             "field": "mandatoryDispositionPauseId",
10377             "description": "<p>Status to put when mandatory disposition is enabled</p>"
10378           },
10379           {
10380             "group": "Body",
10381             "type": "Boolean",
10382             "optional": true,
10383             "field": "mandatoryDisposition",
10384             "description": "<p>Enabled/disables mandatory dispo on a queue</p>"
10385           }
10386         ]
10387       }
10388     },
10389     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10390     "version": "0.0.0",
10391     "filename": "server/api/faxAccount/index.js",
10392     "groupTitle": "Fax_Accounts"
10393   },
10394   {
10395     "type": "delete",
10396     "url": "/api/fax/accounts/{id}",
10397     "title": "Deletes a Account",
10398     "examples": [
10399       {
10400         "title": "Example usage:",
10401         "content": "curl https://{domain}/api/fax/accounts/{id} -v -u {name}:{password} -X DELETE",
10402         "type": "json"
10403       }
10404     ],
10405     "name": "DeleteAccounts",
10406     "group": "Fax_Accounts",
10407     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10408     "version": "0.0.0",
10409     "filename": "server/api/faxAccount/index.js",
10410     "groupTitle": "Fax_Accounts"
10411   },
10412   {
10413     "type": "get",
10414     "url": "/api/fax/accounts/describe",
10415     "title": "Gets table info about Accounts",
10416     "examples": [
10417       {
10418         "title": "Example usage:",
10419         "content": "curl https://{domain}/api/fax/accounts/describe -v -u {name}:{password}",
10420         "type": "json"
10421       }
10422     ],
10423     "name": "DescribeAccounts",
10424     "group": "Fax_Accounts",
10425     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10426     "version": "0.0.0",
10427     "filename": "server/api/faxAccount/index.js",
10428     "groupTitle": "Fax_Accounts"
10429   },
10430   {
10431     "type": "get",
10432     "url": "/api/fax/accounts",
10433     "title": "Gets a list of Accounts",
10434     "examples": [
10435       {
10436         "title": "Example usage:",
10437         "content": "curl https://{domain}/api/fax/accounts -v -u {name}:{password}",
10438         "type": "json"
10439       }
10440     ],
10441     "name": "GetAccounts",
10442     "group": "Fax_Accounts",
10443     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
10444     "version": "0.0.0",
10445     "filename": "server/api/faxAccount/index.js",
10446     "groupTitle": "Fax_Accounts"
10447   },
10448   {
10449     "type": "get",
10450     "url": "/api/fax/accounts/{id}/users",
10451     "title": "Gets agents from fax account",
10452     "examples": [
10453       {
10454         "title": "Example usage:",
10455         "content": "curl https://{domain}/api/fax/accounts/{id}/users -v -u {name}:{password} -X GET",
10456         "type": "json"
10457       }
10458     ],
10459     "name": "GetAgents",
10460     "group": "Fax_Accounts",
10461     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10462     "version": "0.0.0",
10463     "filename": "server/api/faxAccount/index.js",
10464     "groupTitle": "Fax_Accounts"
10465   },
10466   {
10467     "type": "delete",
10468     "url": "/api/fax/accounts/{id}/users",
10469     "title": "Removes agents from a fax account",
10470     "examples": [
10471       {
10472         "title": "Example usage:",
10473         "content": "curl https://{domain}/api/fax/accounts/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
10474         "type": "json"
10475       }
10476     ],
10477     "name": "RemoveAgents",
10478     "group": "Fax_Accounts",
10479     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10480     "version": "0.0.0",
10481     "filename": "server/api/faxAccount/index.js",
10482     "groupTitle": "Fax_Accounts"
10483   },
10484   {
10485     "type": "delete",
10486     "url": "/api/fax/accounts/{id}/canned_answers",
10487     "title": "Removes canned answers from account",
10488     "examples": [
10489       {
10490         "title": "Example usage:",
10491         "content": "curl https://{domain}/api/fax/accounts/{id}/canned_answers?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
10492         "type": "json"
10493       }
10494     ],
10495     "name": "RemoveAnswers",
10496     "group": "Fax_Accounts",
10497     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10498     "version": "0.0.0",
10499     "filename": "server/api/faxAccount/index.js",
10500     "groupTitle": "Fax_Accounts"
10501   },
10502   {
10503     "type": "delete",
10504     "url": "/api/fax/accounts/{id}/dispositions",
10505     "title": "Removes dispositions from account",
10506     "examples": [
10507       {
10508         "title": "Example usage:",
10509         "content": "curl https://{domain}/api/fax/accounts/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
10510         "type": "json"
10511       }
10512     ],
10513     "name": "RemoveDispositions",
10514     "group": "Fax_Accounts",
10515     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10516     "version": "0.0.0",
10517     "filename": "server/api/faxAccount/index.js",
10518     "groupTitle": "Fax_Accounts"
10519   },
10520   {
10521     "type": "get",
10522     "url": "/api/fax/accounts/{id}",
10523     "title": "Gets a single Account",
10524     "examples": [
10525       {
10526         "title": "Example usage:",
10527         "content": "curl https://{domain}/api/fax/accounts/{id} -v -u {name}:{password}",
10528         "type": "json"
10529       }
10530     ],
10531     "name": "ShowAccounts",
10532     "group": "Fax_Accounts",
10533     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10534     "version": "0.0.0",
10535     "filename": "server/api/faxAccount/index.js",
10536     "groupTitle": "Fax_Accounts"
10537   },
10538   {
10539     "type": "post",
10540     "url": "/api/fax/accounts/{id}/canned_answers",
10541     "title": "Creates new canned answer",
10542     "examples": [
10543       {
10544         "title": "Example usage:",
10545         "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",
10546         "type": "json"
10547       }
10548     ],
10549     "name": "addAnswer",
10550     "group": "Fax_Accounts",
10551     "parameter": {
10552       "fields": {
10553         "Body": [
10554           {
10555             "group": "Body",
10556             "type": "String",
10557             "optional": false,
10558             "field": "key",
10559             "description": ""
10560           },
10561           {
10562             "group": "Body",
10563             "type": "Text",
10564             "optional": false,
10565             "field": "value",
10566             "description": ""
10567           },
10568           {
10569             "group": "Body",
10570             "type": "String",
10571             "optional": true,
10572             "field": "description",
10573             "description": ""
10574           },
10575           {
10576             "group": "Body",
10577             "type": "Virtual",
10578             "optional": true,
10579             "field": "name",
10580             "description": ""
10581           }
10582         ]
10583       }
10584     },
10585     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10586     "version": "0.0.0",
10587     "filename": "server/api/faxAccount/index.js",
10588     "groupTitle": "Fax_Accounts"
10589   },
10590   {
10591     "type": "post",
10592     "url": "/api/fax/accounts/{id}/applications",
10593     "title": "Creates new applications",
10594     "examples": [
10595       {
10596         "title": "Example usage:",
10597         "content": "curl https://{domain}/api/fax/accounts/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
10598         "type": "json"
10599       }
10600     ],
10601     "name": "addApplications",
10602     "group": "Fax_Accounts",
10603     "parameter": {
10604       "fields": {
10605         "Body": [
10606           {
10607             "group": "Body",
10608             "type": "Integer",
10609             "optional": false,
10610             "field": "priority",
10611             "description": ""
10612           },
10613           {
10614             "group": "Body",
10615             "type": "String",
10616             "optional": false,
10617             "field": "app",
10618             "description": ""
10619           },
10620           {
10621             "group": "Body",
10622             "type": "Text",
10623             "optional": true,
10624             "field": "appdata",
10625             "description": ""
10626           },
10627           {
10628             "group": "Body",
10629             "type": "String",
10630             "optional": true,
10631             "field": "description",
10632             "description": ""
10633           },
10634           {
10635             "group": "Body",
10636             "type": "String",
10637             "optional": true,
10638             "field": "interval",
10639             "description": ""
10640           }
10641         ]
10642       }
10643     },
10644     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10645     "version": "0.0.0",
10646     "filename": "server/api/faxAccount/index.js",
10647     "groupTitle": "Fax_Accounts"
10648   },
10649   {
10650     "type": "post",
10651     "url": "/api/fax/accounts/addaccountapplications",
10652     "title": "Creates new account and applications",
10653     "examples": [
10654       {
10655         "title": "Example usage:",
10656         "content": "curl https://{domain}/api/fax/accounts/addaccountapplications -d '[{\"name\": \"name\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
10657         "type": "json"
10658       }
10659     ],
10660     "name": "addApplications",
10661     "group": "Fax_Accounts",
10662     "parameter": {
10663       "fields": {
10664         "Body": [
10665           {
10666             "group": "Body",
10667             "type": "Integer",
10668             "optional": false,
10669             "field": "priority",
10670             "description": ""
10671           },
10672           {
10673             "group": "Body",
10674             "type": "String",
10675             "optional": false,
10676             "field": "app",
10677             "description": ""
10678           },
10679           {
10680             "group": "Body",
10681             "type": "Text",
10682             "optional": true,
10683             "field": "appdata",
10684             "description": ""
10685           },
10686           {
10687             "group": "Body",
10688             "type": "String",
10689             "optional": true,
10690             "field": "description",
10691             "description": ""
10692           },
10693           {
10694             "group": "Body",
10695             "type": "String",
10696             "optional": true,
10697             "field": "interval",
10698             "description": ""
10699           }
10700         ]
10701       }
10702     },
10703     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10704     "version": "0.0.0",
10705     "filename": "server/api/faxAccount/index.js",
10706     "groupTitle": "Fax_Accounts"
10707   },
10708   {
10709     "type": "post",
10710     "url": "/api/fax/accounts/{id}/dispositions",
10711     "title": "Creates new disposition",
10712     "examples": [
10713       {
10714         "title": "Example usage:",
10715         "content": "curl https://{domain}/api/fax/accounts/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
10716         "type": "json"
10717       }
10718     ],
10719     "name": "addDisposition",
10720     "group": "Fax_Accounts",
10721     "parameter": {
10722       "fields": {
10723         "Body": [
10724           {
10725             "group": "Body",
10726             "type": "String",
10727             "optional": false,
10728             "field": "name",
10729             "description": ""
10730           },
10731           {
10732             "group": "Body",
10733             "type": "String",
10734             "allowedValues": [
10735               "\"first\"",
10736               "\"second\"",
10737               "\"third\""
10738             ],
10739             "optional": false,
10740             "field": "level",
10741             "description": ""
10742           },
10743           {
10744             "group": "Body",
10745             "type": "String",
10746             "optional": true,
10747             "field": "description",
10748             "description": ""
10749           }
10750         ]
10751       }
10752     },
10753     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10754     "version": "0.0.0",
10755     "filename": "server/api/faxAccount/index.js",
10756     "groupTitle": "Fax_Accounts"
10757   },
10758   {
10759     "type": "post",
10760     "url": "/api/fax/accounts/{id}/interactions",
10761     "title": "Creates new interactions",
10762     "examples": [
10763       {
10764         "title": "Example usage:",
10765         "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",
10766         "type": "json"
10767       }
10768     ],
10769     "name": "addInteraction",
10770     "group": "Fax_Accounts",
10771     "parameter": {
10772       "fields": {
10773         "Body": [
10774           {
10775             "group": "Body",
10776             "type": "Boolean",
10777             "optional": true,
10778             "field": "closed",
10779             "description": ""
10780           },
10781           {
10782             "group": "Body",
10783             "type": "String",
10784             "optional": true,
10785             "field": "closedAt",
10786             "description": ""
10787           },
10788           {
10789             "group": "Body",
10790             "type": "String",
10791             "optional": true,
10792             "field": "disposition",
10793             "description": ""
10794           },
10795           {
10796             "group": "Body",
10797             "type": "String",
10798             "optional": true,
10799             "field": "secondDisposition",
10800             "description": ""
10801           },
10802           {
10803             "group": "Body",
10804             "type": "String",
10805             "optional": true,
10806             "field": "thirdDisposition",
10807             "description": ""
10808           },
10809           {
10810             "group": "Body",
10811             "type": "String",
10812             "optional": true,
10813             "field": "note",
10814             "description": ""
10815           },
10816           {
10817             "group": "Body",
10818             "type": "String",
10819             "optional": true,
10820             "field": "read1stAt",
10821             "description": ""
10822           },
10823           {
10824             "group": "Body",
10825             "type": "String",
10826             "optional": true,
10827             "field": "fax",
10828             "description": ""
10829           },
10830           {
10831             "group": "Body",
10832             "type": "String",
10833             "allowedValues": [
10834               "\"in\"",
10835               "\"out\""
10836             ],
10837             "optional": false,
10838             "field": "firstMsgDirection",
10839             "description": ""
10840           },
10841           {
10842             "group": "Body",
10843             "type": "String",
10844             "optional": true,
10845             "field": "lastMsgAt",
10846             "description": ""
10847           },
10848           {
10849             "group": "Body",
10850             "type": "String",
10851             "allowedValues": [
10852               "\"in\"",
10853               "\"out\""
10854             ],
10855             "optional": false,
10856             "field": "lastMsgDirection",
10857             "description": ""
10858           }
10859         ]
10860       }
10861     },
10862     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10863     "version": "0.0.0",
10864     "filename": "server/api/faxAccount/index.js",
10865     "groupTitle": "Fax_Accounts"
10866   },
10867   {
10868     "type": "get",
10869     "url": "/api/fax/accounts/{id}/canned_answers",
10870     "title": "Gets account canned answers",
10871     "examples": [
10872       {
10873         "title": "Example usage:",
10874         "content": "curl https://{domain}/api/fax/accounts/{id}/canned_answers -v -u {name}:{password} -X GET",
10875         "type": "json"
10876       }
10877     ],
10878     "name": "getAnswers",
10879     "group": "Fax_Accounts",
10880     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10881     "version": "0.0.0",
10882     "filename": "server/api/faxAccount/index.js",
10883     "groupTitle": "Fax_Accounts"
10884   },
10885   {
10886     "type": "get",
10887     "url": "/api/fax/accounts/{id}/applications",
10888     "title": "Gets account pplications",
10889     "examples": [
10890       {
10891         "title": "Example usage:",
10892         "content": "curl https://{domain}/api/fax/accounts/{id}/applications -v -u {name}:{password} -X GET",
10893         "type": "json"
10894       }
10895     ],
10896     "name": "getApplications",
10897     "group": "Fax_Accounts",
10898     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10899     "version": "0.0.0",
10900     "filename": "server/api/faxAccount/index.js",
10901     "groupTitle": "Fax_Accounts"
10902   },
10903   {
10904     "type": "get",
10905     "url": "/api/fax/accounts/{id}/dispositions",
10906     "title": "Gets account dispositions",
10907     "examples": [
10908       {
10909         "title": "Example usage:",
10910         "content": "curl https://{domain}/api/fax/accounts/{id}/dispositions -v -u {name}:{password} -X GET",
10911         "type": "json"
10912       }
10913     ],
10914     "name": "getDispositions",
10915     "group": "Fax_Accounts",
10916     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10917     "version": "0.0.0",
10918     "filename": "server/api/faxAccount/index.js",
10919     "groupTitle": "Fax_Accounts"
10920   },
10921   {
10922     "type": "get",
10923     "url": "/api/fax/accounts/{id}/interactions",
10924     "title": "Gets account interactions",
10925     "examples": [
10926       {
10927         "title": "Example usage:",
10928         "content": "curl https://{domain}/api/fax/accounts/{id}/interactions -v -u {name}:{password} -X GET",
10929         "type": "json"
10930       }
10931     ],
10932     "name": "getInteraction",
10933     "group": "Fax_Accounts",
10934     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10935     "version": "0.0.0",
10936     "filename": "server/api/faxAccount/index.js",
10937     "groupTitle": "Fax_Accounts"
10938   },
10939   {
10940     "type": "get",
10941     "url": "/api/fax/accounts/{id}/messages",
10942     "title": "Gets account messages",
10943     "examples": [
10944       {
10945         "title": "Example usage:",
10946         "content": "curl https://{domain}/api/fax/accounts/{id}/messages -v -u {name}:{password} -X GET",
10947         "type": "json"
10948       }
10949     ],
10950     "name": "getMessages",
10951     "group": "Fax_Accounts",
10952     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10953     "version": "0.0.0",
10954     "filename": "server/api/faxAccount/index.js",
10955     "groupTitle": "Fax_Accounts"
10956   },
10957   {
10958     "type": "post",
10959     "url": "/api/fax/accounts/{id}/send",
10960     "title": "Send new fax",
10961     "examples": [
10962       {
10963         "title": "Example usage:",
10964         "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",
10965         "type": "json"
10966       }
10967     ],
10968     "name": "sendFax",
10969     "group": "Fax_Accounts",
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/faxAccount/index.js",
10973     "groupTitle": "Fax_Accounts"
10974   },
10975   {
10976     "type": "put",
10977     "url": "/api/fax/accounts/{id}",
10978     "title": "Update an existing Account",
10979     "examples": [
10980       {
10981         "title": "Example usage:",
10982         "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",
10983         "type": "json"
10984       }
10985     ],
10986     "name": "updateAccounts",
10987     "group": "Fax_Accounts",
10988     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <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/faxAccount/index.js",
10991     "groupTitle": "Fax_Accounts"
10992   },
10993   {
10994     "type": "post",
10995     "url": "/api/fax/accounts/updateaccountapplications",
10996     "title": "Update account and applications",
10997     "examples": [
10998       {
10999         "title": "Example usage:",
11000         "content": "curl https://{domain}/api/fax/accounts/updateaccountapplications -d '[{\"name\": \"name\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
11001         "type": "json"
11002       }
11003     ],
11004     "name": "updateApplications",
11005     "group": "Fax_Accounts",
11006     "parameter": {
11007       "fields": {
11008         "Body": [
11009           {
11010             "group": "Body",
11011             "type": "Integer",
11012             "optional": false,
11013             "field": "priority",
11014             "description": ""
11015           },
11016           {
11017             "group": "Body",
11018             "type": "String",
11019             "optional": false,
11020             "field": "app",
11021             "description": ""
11022           },
11023           {
11024             "group": "Body",
11025             "type": "Text",
11026             "optional": true,
11027             "field": "appdata",
11028             "description": ""
11029           },
11030           {
11031             "group": "Body",
11032             "type": "String",
11033             "optional": true,
11034             "field": "description",
11035             "description": ""
11036           },
11037           {
11038             "group": "Body",
11039             "type": "String",
11040             "optional": true,
11041             "field": "interval",
11042             "description": ""
11043           }
11044         ]
11045       }
11046     },
11047     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11048     "version": "0.0.0",
11049     "filename": "server/api/faxAccount/index.js",
11050     "groupTitle": "Fax_Accounts"
11051   },
11052   {
11053     "type": "post",
11054     "url": "/api/fax/applications",
11055     "title": "Creates a new Application",
11056     "examples": [
11057       {
11058         "title": "Example usage:",
11059         "content": "curl https://{domain}/api/fax/applications -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
11060         "type": "json"
11061       }
11062     ],
11063     "name": "CreateApplications",
11064     "group": "Fax_Applications",
11065     "parameter": {
11066       "fields": {
11067         "Body": [
11068           {
11069             "group": "Body",
11070             "type": "Integer",
11071             "optional": false,
11072             "field": "priority",
11073             "description": ""
11074           },
11075           {
11076             "group": "Body",
11077             "type": "String",
11078             "optional": false,
11079             "field": "app",
11080             "description": ""
11081           },
11082           {
11083             "group": "Body",
11084             "type": "Text",
11085             "optional": true,
11086             "field": "appdata",
11087             "description": ""
11088           },
11089           {
11090             "group": "Body",
11091             "type": "String",
11092             "optional": true,
11093             "field": "description",
11094             "description": ""
11095           },
11096           {
11097             "group": "Body",
11098             "type": "String",
11099             "optional": true,
11100             "field": "interval",
11101             "description": ""
11102           }
11103         ]
11104       }
11105     },
11106     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11107     "version": "0.0.0",
11108     "filename": "server/api/faxApplication/index.js",
11109     "groupTitle": "Fax_Applications"
11110   },
11111   {
11112     "type": "delete",
11113     "url": "/api/fax/applications/{id}",
11114     "title": "Deletes a Application",
11115     "examples": [
11116       {
11117         "title": "Example usage:",
11118         "content": "curl https://{domain}/api/fax/applications/{id} -v -u {name}:{password} -X DELETE",
11119         "type": "json"
11120       }
11121     ],
11122     "name": "DeleteApplications",
11123     "group": "Fax_Applications",
11124     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11125     "version": "0.0.0",
11126     "filename": "server/api/faxApplication/index.js",
11127     "groupTitle": "Fax_Applications"
11128   },
11129   {
11130     "type": "get",
11131     "url": "/api/fax/applications",
11132     "title": "Gets a list of Applications",
11133     "examples": [
11134       {
11135         "title": "Example usage:",
11136         "content": "curl https://{domain}/api/fax/applications -v -u {name}:{password}",
11137         "type": "json"
11138       }
11139     ],
11140     "name": "GetApplications",
11141     "group": "Fax_Applications",
11142     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
11143     "version": "0.0.0",
11144     "filename": "server/api/faxApplication/index.js",
11145     "groupTitle": "Fax_Applications"
11146   },
11147   {
11148     "type": "get",
11149     "url": "/api/fax/applications/{id}",
11150     "title": "Gets a single Application",
11151     "examples": [
11152       {
11153         "title": "Example usage:",
11154         "content": "curl https://{domain}/api/fax/applications/{id} -v -u {name}:{password}",
11155         "type": "json"
11156       }
11157     ],
11158     "name": "ShowApplications",
11159     "group": "Fax_Applications",
11160     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11161     "version": "0.0.0",
11162     "filename": "server/api/faxApplication/index.js",
11163     "groupTitle": "Fax_Applications"
11164   },
11165   {
11166     "type": "put",
11167     "url": "/api/fax/applications/{id}",
11168     "title": "Update an existing Application",
11169     "examples": [
11170       {
11171         "title": "Example usage:",
11172         "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",
11173         "type": "json"
11174       }
11175     ],
11176     "name": "updateApplications",
11177     "group": "Fax_Applications",
11178     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <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/faxApplication/index.js",
11181     "groupTitle": "Fax_Applications"
11182   },
11183   {
11184     "type": "post",
11185     "url": "/api/fax/interactions/{id}/tags",
11186     "title": "Add tags to the interaction",
11187     "examples": [
11188       {
11189         "title": "Example usage:",
11190         "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",
11191         "type": "json"
11192       }
11193     ],
11194     "name": "AddTags",
11195     "group": "Fax_Interactions",
11196     "description": "<p>Motion will return a HTTP status code <code>201</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/faxInteraction/index.js",
11199     "groupTitle": "Fax_Interactions"
11200   },
11201   {
11202     "type": "post",
11203     "url": "/api/fax/interactions",
11204     "title": "Creates a new Interaction",
11205     "examples": [
11206       {
11207         "title": "Example usage:",
11208         "content": "curl https://{domain}/api/fax/interactions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
11209         "type": "json"
11210       }
11211     ],
11212     "name": "CreateInteractions",
11213     "group": "Fax_Interactions",
11214     "parameter": {
11215       "fields": {
11216         "Body": [
11217           {
11218             "group": "Body",
11219             "type": "Boolean",
11220             "optional": true,
11221             "field": "closed",
11222             "description": ""
11223           },
11224           {
11225             "group": "Body",
11226             "type": "String",
11227             "optional": true,
11228             "field": "closedAt",
11229             "description": ""
11230           },
11231           {
11232             "group": "Body",
11233             "type": "String",
11234             "optional": true,
11235             "field": "disposition",
11236             "description": ""
11237           },
11238           {
11239             "group": "Body",
11240             "type": "String",
11241             "optional": true,
11242             "field": "secondDisposition",
11243             "description": ""
11244           },
11245           {
11246             "group": "Body",
11247             "type": "String",
11248             "optional": true,
11249             "field": "thirdDisposition",
11250             "description": ""
11251           },
11252           {
11253             "group": "Body",
11254             "type": "String",
11255             "optional": true,
11256             "field": "note",
11257             "description": ""
11258           },
11259           {
11260             "group": "Body",
11261             "type": "String",
11262             "optional": true,
11263             "field": "read1stAt",
11264             "description": ""
11265           },
11266           {
11267             "group": "Body",
11268             "type": "String",
11269             "optional": true,
11270             "field": "fax",
11271             "description": ""
11272           },
11273           {
11274             "group": "Body",
11275             "type": "String",
11276             "allowedValues": [
11277               "\"in\"",
11278               "\"out\""
11279             ],
11280             "optional": false,
11281             "field": "firstMsgDirection",
11282             "description": ""
11283           },
11284           {
11285             "group": "Body",
11286             "type": "String",
11287             "optional": true,
11288             "field": "lastMsgAt",
11289             "description": ""
11290           },
11291           {
11292             "group": "Body",
11293             "type": "String",
11294             "allowedValues": [
11295               "\"in\"",
11296               "\"out\""
11297             ],
11298             "optional": false,
11299             "field": "lastMsgDirection",
11300             "description": ""
11301           }
11302         ]
11303       }
11304     },
11305     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11306     "version": "0.0.0",
11307     "filename": "server/api/faxInteraction/index.js",
11308     "groupTitle": "Fax_Interactions"
11309   },
11310   {
11311     "type": "delete",
11312     "url": "/api/fax/interactions/{id}",
11313     "title": "Deletes a Interaction",
11314     "examples": [
11315       {
11316         "title": "Example usage:",
11317         "content": "curl https://{domain}/api/fax/interactions/{id} -v -u {name}:{password} -X DELETE",
11318         "type": "json"
11319       }
11320     ],
11321     "name": "DeleteInteractions",
11322     "group": "Fax_Interactions",
11323     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11324     "version": "0.0.0",
11325     "filename": "server/api/faxInteraction/index.js",
11326     "groupTitle": "Fax_Interactions"
11327   },
11328   {
11329     "type": "get",
11330     "url": "/api/fax/interactions/describe",
11331     "title": "Gets table info about Interactions",
11332     "examples": [
11333       {
11334         "title": "Example usage:",
11335         "content": "curl https://{domain}/api/fax/interactions/describe -v -u {name}:{password}",
11336         "type": "json"
11337       }
11338     ],
11339     "name": "DescribeInteractions",
11340     "group": "Fax_Interactions",
11341     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11342     "version": "0.0.0",
11343     "filename": "server/api/faxInteraction/index.js",
11344     "groupTitle": "Fax_Interactions"
11345   },
11346   {
11347     "type": "get",
11348     "url": "/api/fax/interactions",
11349     "title": "Gets a list of Interactions",
11350     "examples": [
11351       {
11352         "title": "Example usage:",
11353         "content": "curl https://{domain}/api/fax/interactions -v -u {name}:{password}",
11354         "type": "json"
11355       }
11356     ],
11357     "name": "GetInteractions",
11358     "group": "Fax_Interactions",
11359     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
11360     "version": "0.0.0",
11361     "filename": "server/api/faxInteraction/index.js",
11362     "groupTitle": "Fax_Interactions"
11363   },
11364   {
11365     "type": "delete",
11366     "url": "/api/fax/interactions/{id}/tags",
11367     "title": "Removes tags from interaction",
11368     "examples": [
11369       {
11370         "title": "Example usage:",
11371         "content": "curl https://{domain}/api/fax/interactions/{id}/tags?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
11372         "type": "json"
11373       }
11374     ],
11375     "name": "RemoveTags",
11376     "group": "Fax_Interactions",
11377     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11378     "version": "0.0.0",
11379     "filename": "server/api/faxInteraction/index.js",
11380     "groupTitle": "Fax_Interactions"
11381   },
11382   {
11383     "type": "get",
11384     "url": "/api/fax/interactions/{id}",
11385     "title": "Gets a single Interaction",
11386     "examples": [
11387       {
11388         "title": "Example usage:",
11389         "content": "curl https://{domain}/api/fax/interactions/{id} -v -u {name}:{password}",
11390         "type": "json"
11391       }
11392     ],
11393     "name": "ShowInteractions",
11394     "group": "Fax_Interactions",
11395     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11396     "version": "0.0.0",
11397     "filename": "server/api/faxInteraction/index.js",
11398     "groupTitle": "Fax_Interactions"
11399   },
11400   {
11401     "type": "post",
11402     "url": "/api/fax/interactions/{id}/messages",
11403     "title": "Creates new messages",
11404     "examples": [
11405       {
11406         "title": "Example usage:",
11407         "content": "curl https://{domain}/api/fax/interactions/{id}/messages -d '[{\"to\": \"+3901119886500\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
11408         "type": "json"
11409       }
11410     ],
11411     "name": "addMessage",
11412     "group": "Fax_Interactions",
11413     "parameter": {
11414       "fields": {
11415         "Body": [
11416           {
11417             "group": "Body",
11418             "type": "Text",
11419             "optional": false,
11420             "field": "body",
11421             "description": ""
11422           },
11423           {
11424             "group": "Body",
11425             "type": "Boolean",
11426             "optional": true,
11427             "field": "read",
11428             "description": ""
11429           },
11430           {
11431             "group": "Body",
11432             "type": "String",
11433             "allowedValues": [
11434               "\"in\"",
11435               "\"out\""
11436             ],
11437             "optional": false,
11438             "field": "direction",
11439             "description": ""
11440           },
11441           {
11442             "group": "Body",
11443             "type": "Text",
11444             "optional": true,
11445             "field": "failMessage",
11446             "description": ""
11447           },
11448           {
11449             "group": "Body",
11450             "type": "String",
11451             "optional": true,
11452             "field": "readAt",
11453             "description": ""
11454           }
11455         ]
11456       }
11457     },
11458     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11459     "version": "0.0.0",
11460     "filename": "server/api/faxInteraction/index.js",
11461     "groupTitle": "Fax_Interactions"
11462   },
11463   {
11464     "type": "get",
11465     "url": "/api/fax/interactions/{id}/download",
11466     "title": "Get interactions",
11467     "examples": [
11468       {
11469         "title": "Example usage:",
11470         "content": "curl https://{domain}/api/fax/interactions/{id}/download -v -u {name}:{password} -X GET",
11471         "type": "json"
11472       }
11473     ],
11474     "name": "download",
11475     "group": "Fax_Interactions",
11476     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11477     "version": "0.0.0",
11478     "filename": "server/api/faxInteraction/index.js",
11479     "groupTitle": "Fax_Interactions"
11480   },
11481   {
11482     "type": "get",
11483     "url": "/api/fax/interactions/{id}/messages",
11484     "title": "Gets interaction messages",
11485     "examples": [
11486       {
11487         "title": "Example usage:",
11488         "content": "curl https://{domain}/api/fax/interactions/{id}/messages -v -u {name}:{password} -X GET",
11489         "type": "json"
11490       }
11491     ],
11492     "name": "getMessages",
11493     "group": "Fax_Interactions",
11494     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11495     "version": "0.0.0",
11496     "filename": "server/api/faxInteraction/index.js",
11497     "groupTitle": "Fax_Interactions"
11498   },
11499   {
11500     "type": "put",
11501     "url": "/api/fax/interactions/{id}",
11502     "title": "Update an existing Interaction",
11503     "examples": [
11504       {
11505         "title": "Example usage:",
11506         "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",
11507         "type": "json"
11508       }
11509     ],
11510     "name": "updateInteractions",
11511     "group": "Fax_Interactions",
11512     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11513     "version": "0.0.0",
11514     "filename": "server/api/faxInteraction/index.js",
11515     "groupTitle": "Fax_Interactions"
11516   },
11517   {
11518     "type": "get",
11519     "url": "/api/fax/messages/{id}/download",
11520     "title": "Get message",
11521     "examples": [
11522       {
11523         "title": "Example usage:",
11524         "content": "curl https://{domain}/api/fax/messages/{id}/download -v -u {name}:{password} -X GET",
11525         "type": "json"
11526       }
11527     ],
11528     "name": "download",
11529     "group": "Fax_Message",
11530     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11531     "version": "0.0.0",
11532     "filename": "server/api/faxMessage/index.js",
11533     "groupTitle": "Fax_Message"
11534   },
11535   {
11536     "type": "delete",
11537     "url": "/api/fax/messages/{id}",
11538     "title": "Deletes a Message",
11539     "examples": [
11540       {
11541         "title": "Example usage:",
11542         "content": "curl https://{domain}/api/fax/messages/{id} -v -u {name}:{password} -X DELETE",
11543         "type": "json"
11544       }
11545     ],
11546     "name": "DeleteMessages",
11547     "group": "Fax_Messages",
11548     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11549     "version": "0.0.0",
11550     "filename": "server/api/faxMessage/index.js",
11551     "groupTitle": "Fax_Messages"
11552   },
11553   {
11554     "type": "get",
11555     "url": "/api/fax/messages/describe",
11556     "title": "Gets table info about Messages",
11557     "examples": [
11558       {
11559         "title": "Example usage:",
11560         "content": "curl https://{domain}/api/fax/messages/describe -v -u {name}:{password}",
11561         "type": "json"
11562       }
11563     ],
11564     "name": "DescribeMessages",
11565     "group": "Fax_Messages",
11566     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11567     "version": "0.0.0",
11568     "filename": "server/api/faxMessage/index.js",
11569     "groupTitle": "Fax_Messages"
11570   },
11571   {
11572     "type": "get",
11573     "url": "/api/fax/messages",
11574     "title": "Gets a list of Messages",
11575     "examples": [
11576       {
11577         "title": "Example usage:",
11578         "content": "curl https://{domain}/api/fax/messages -v -u {name}:{password}",
11579         "type": "json"
11580       }
11581     ],
11582     "name": "GetMessages",
11583     "group": "Fax_Messages",
11584     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
11585     "version": "0.0.0",
11586     "filename": "server/api/faxMessage/index.js",
11587     "groupTitle": "Fax_Messages"
11588   },
11589   {
11590     "type": "get",
11591     "url": "/api/fax/messages/{id}",
11592     "title": "Gets a single Message",
11593     "examples": [
11594       {
11595         "title": "Example usage:",
11596         "content": "curl https://{domain}/api/fax/messages/{id} -v -u {name}:{password}",
11597         "type": "json"
11598       }
11599     ],
11600     "name": "ShowMessages",
11601     "group": "Fax_Messages",
11602     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11603     "version": "0.0.0",
11604     "filename": "server/api/faxMessage/index.js",
11605     "groupTitle": "Fax_Messages"
11606   },
11607   {
11608     "type": "put",
11609     "url": "/api/fax/messages/{id}/accept",
11610     "title": "Accepts message",
11611     "examples": [
11612       {
11613         "title": "Example usage:",
11614         "content": "curl https://{domain}/api/fax/messages/{id}/accept \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
11615         "type": "json"
11616       }
11617     ],
11618     "name": "acceptMessage",
11619     "group": "Fax_Messages",
11620     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11621     "version": "0.0.0",
11622     "filename": "server/api/faxMessage/index.js",
11623     "groupTitle": "Fax_Messages"
11624   },
11625   {
11626     "type": "post",
11627     "url": "/api/fax/messages",
11628     "title": "Create message and send Fax",
11629     "examples": [
11630       {
11631         "title": "Example usage:",
11632         "content": "curl https://{domain}/api/fax/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
11633         "type": "json"
11634       }
11635     ],
11636     "name": "rejectMessage",
11637     "group": "Fax_Messages",
11638     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11639     "version": "0.0.0",
11640     "filename": "server/api/faxMessage/index.js",
11641     "groupTitle": "Fax_Messages"
11642   },
11643   {
11644     "type": "put",
11645     "url": "/api/fax/messages/{id}/reject",
11646     "title": "Rejects message",
11647     "examples": [
11648       {
11649         "title": "Example usage:",
11650         "content": "curl https://{domain}/api/fax/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
11651         "type": "json"
11652       }
11653     ],
11654     "name": "rejectMessage",
11655     "group": "Fax_Messages",
11656     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11657     "version": "0.0.0",
11658     "filename": "server/api/faxMessage/index.js",
11659     "groupTitle": "Fax_Messages"
11660   },
11661   {
11662     "type": "put",
11663     "url": "/api/fax/messages/{id}",
11664     "title": "Update an existing Message",
11665     "examples": [
11666       {
11667         "title": "Example usage:",
11668         "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",
11669         "type": "json"
11670       }
11671     ],
11672     "name": "updateMessages",
11673     "group": "Fax_Messages",
11674     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11675     "version": "0.0.0",
11676     "filename": "server/api/faxMessage/index.js",
11677     "groupTitle": "Fax_Messages"
11678   },
11679   {
11680     "type": "post",
11681     "url": "/api/fax/reports/queue",
11682     "title": "Creates a new Fax Queue Report",
11683     "examples": [
11684       {
11685         "title": "Example usage:",
11686         "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",
11687         "type": "json"
11688       }
11689     ],
11690     "name": "CreateFax_Queue_Reports",
11691     "group": "Fax_Queue_Reports",
11692     "parameter": {
11693       "fields": {
11694         "Body": [
11695           {
11696             "group": "Body",
11697             "type": "String",
11698             "optional": false,
11699             "field": "uniqueid",
11700             "description": ""
11701           },
11702           {
11703             "group": "Body",
11704             "type": "String",
11705             "optional": true,
11706             "field": "from",
11707             "description": ""
11708           },
11709           {
11710             "group": "Body",
11711             "type": "String",
11712             "optional": true,
11713             "field": "joinAt",
11714             "description": ""
11715           },
11716           {
11717             "group": "Body",
11718             "type": "String",
11719             "optional": true,
11720             "field": "leaveAt",
11721             "description": ""
11722           },
11723           {
11724             "group": "Body",
11725             "type": "String",
11726             "optional": true,
11727             "field": "acceptAt",
11728             "description": ""
11729           },
11730           {
11731             "group": "Body",
11732             "type": "String",
11733             "optional": true,
11734             "field": "exitAt",
11735             "description": ""
11736           },
11737           {
11738             "group": "Body",
11739             "type": "String",
11740             "optional": true,
11741             "field": "reason",
11742             "description": ""
11743           }
11744         ]
11745       }
11746     },
11747     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11748     "version": "0.0.0",
11749     "filename": "server/api/faxQueueReport/index.js",
11750     "groupTitle": "Fax_Queue_Reports"
11751   },
11752   {
11753     "type": "delete",
11754     "url": "/api/fax/reports/queue/{id}",
11755     "title": "Deletes a Fax Queue Report",
11756     "examples": [
11757       {
11758         "title": "Example usage:",
11759         "content": "curl https://{domain}/api/fax/reports/queue/{id} -v -u {name}:{password} -X DELETE",
11760         "type": "json"
11761       }
11762     ],
11763     "name": "DeleteFax_Queue_Reports",
11764     "group": "Fax_Queue_Reports",
11765     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11766     "version": "0.0.0",
11767     "filename": "server/api/faxQueueReport/index.js",
11768     "groupTitle": "Fax_Queue_Reports"
11769   },
11770   {
11771     "type": "get",
11772     "url": "/api/fax/reports/queue/describe",
11773     "title": "Gets table info about Fax Queue Reports",
11774     "examples": [
11775       {
11776         "title": "Example usage:",
11777         "content": "curl https://{domain}/api/fax/reports/queue/describe -v -u {name}:{password}",
11778         "type": "json"
11779       }
11780     ],
11781     "name": "DescribeFax_Queue_Reports",
11782     "group": "Fax_Queue_Reports",
11783     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11784     "version": "0.0.0",
11785     "filename": "server/api/faxQueueReport/index.js",
11786     "groupTitle": "Fax_Queue_Reports"
11787   },
11788   {
11789     "type": "get",
11790     "url": "/api/fax/reports/queue",
11791     "title": "Gets a list of Fax Queue Reports",
11792     "examples": [
11793       {
11794         "title": "Example usage:",
11795         "content": "curl https://{domain}/api/fax/reports/queue -v -u {name}:{password}",
11796         "type": "json"
11797       }
11798     ],
11799     "name": "GetFax_Queue_Reports",
11800     "group": "Fax_Queue_Reports",
11801     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
11802     "version": "0.0.0",
11803     "filename": "server/api/faxQueueReport/index.js",
11804     "groupTitle": "Fax_Queue_Reports"
11805   },
11806   {
11807     "type": "get",
11808     "url": "/api/fax/reports/queue/{id}",
11809     "title": "Gets a single Fax Queue Report",
11810     "examples": [
11811       {
11812         "title": "Example usage:",
11813         "content": "curl https://{domain}/api/fax/reports/queue/{id} -v -u {name}:{password}",
11814         "type": "json"
11815       }
11816     ],
11817     "name": "ShowFax_Queue_Reports",
11818     "group": "Fax_Queue_Reports",
11819     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11820     "version": "0.0.0",
11821     "filename": "server/api/faxQueueReport/index.js",
11822     "groupTitle": "Fax_Queue_Reports"
11823   },
11824   {
11825     "type": "put",
11826     "url": "/api/fax/reports/queue/{id}",
11827     "title": "Update an existing Fax Queue Report",
11828     "examples": [
11829       {
11830         "title": "Example usage:",
11831         "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",
11832         "type": "json"
11833       }
11834     ],
11835     "name": "updateFax_Queue_Reports",
11836     "group": "Fax_Queue_Reports",
11837     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11838     "version": "0.0.0",
11839     "filename": "server/api/faxQueueReport/index.js",
11840     "groupTitle": "Fax_Queue_Reports"
11841   },
11842   {
11843     "type": "post",
11844     "url": "/api/fax/queues/{id}/users",
11845     "title": "Add agents to a queue",
11846     "examples": [
11847       {
11848         "title": "Example usage:",
11849         "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",
11850         "type": "json"
11851       }
11852     ],
11853     "name": "AddAgents",
11854     "group": "Fax_Queues",
11855     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11856     "version": "0.0.0",
11857     "filename": "server/api/faxQueue/index.js",
11858     "groupTitle": "Fax_Queues"
11859   },
11860   {
11861     "type": "post",
11862     "url": "/api/fax/queues/{id}/teams",
11863     "title": "Add teams to a queue",
11864     "examples": [
11865       {
11866         "title": "Example usage:",
11867         "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",
11868         "type": "json"
11869       }
11870     ],
11871     "name": "AddTeams",
11872     "group": "Fax_Queues",
11873     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11874     "version": "0.0.0",
11875     "filename": "server/api/faxQueue/index.js",
11876     "groupTitle": "Fax_Queues"
11877   },
11878   {
11879     "type": "post",
11880     "url": "/api/fax/queues",
11881     "title": "Creates a new Queue",
11882     "examples": [
11883       {
11884         "title": "Example usage:",
11885         "content": "curl https://{domain}/api/fax/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
11886         "type": "json"
11887       }
11888     ],
11889     "name": "CreateQueues",
11890     "group": "Fax_Queues",
11891     "parameter": {
11892       "fields": {
11893         "Body": [
11894           {
11895             "group": "Body",
11896             "type": "String",
11897             "optional": false,
11898             "field": "name",
11899             "description": ""
11900           },
11901           {
11902             "group": "Body",
11903             "type": "String",
11904             "optional": true,
11905             "field": "description",
11906             "description": ""
11907           },
11908           {
11909             "group": "Body",
11910             "type": "Integer",
11911             "optional": false,
11912             "field": "timeout",
11913             "description": ""
11914           },
11915           {
11916             "group": "Body",
11917             "type": "String",
11918             "allowedValues": [
11919               "\"rrmemory\"",
11920               "\"beepall\"",
11921               "\"roundrobin\""
11922             ],
11923             "optional": false,
11924             "field": "strategy",
11925             "description": ""
11926           },
11927           {
11928             "group": "Body",
11929             "type": "Integer",
11930             "optional": true,
11931             "field": "lastAgent",
11932             "description": ""
11933           }
11934         ]
11935       }
11936     },
11937     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11938     "version": "0.0.0",
11939     "filename": "server/api/faxQueue/index.js",
11940     "groupTitle": "Fax_Queues"
11941   },
11942   {
11943     "type": "delete",
11944     "url": "/api/fax/queues/{id}",
11945     "title": "Deletes a Queue",
11946     "examples": [
11947       {
11948         "title": "Example usage:",
11949         "content": "curl https://{domain}/api/fax/queues/{id} -v -u {name}:{password} -X DELETE",
11950         "type": "json"
11951       }
11952     ],
11953     "name": "DeleteQueues",
11954     "group": "Fax_Queues",
11955     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11956     "version": "0.0.0",
11957     "filename": "server/api/faxQueue/index.js",
11958     "groupTitle": "Fax_Queues"
11959   },
11960   {
11961     "type": "get",
11962     "url": "/api/fax/queues/describe",
11963     "title": "Gets table info about Queues",
11964     "examples": [
11965       {
11966         "title": "Example usage:",
11967         "content": "curl https://{domain}/api/fax/queues/describe -v -u {name}:{password}",
11968         "type": "json"
11969       }
11970     ],
11971     "name": "DescribeQueues",
11972     "group": "Fax_Queues",
11973     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11974     "version": "0.0.0",
11975     "filename": "server/api/faxQueue/index.js",
11976     "groupTitle": "Fax_Queues"
11977   },
11978   {
11979     "type": "get",
11980     "url": "/api/fax/queues/{id}/users",
11981     "title": "Gets queue agents",
11982     "examples": [
11983       {
11984         "title": "Example usage:",
11985         "content": "curl https://{domain}/api/fax/queues/{id}/users -v -u {name}:{password} -X POST",
11986         "type": "json"
11987       }
11988     ],
11989     "name": "GetAgents",
11990     "group": "Fax_Queues",
11991     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11992     "version": "0.0.0",
11993     "filename": "server/api/faxQueue/index.js",
11994     "groupTitle": "Fax_Queues"
11995   },
11996   {
11997     "type": "get",
11998     "url": "/api/fax/queues/{id}/members",
11999     "title": "GetMembers",
12000     "examples": [
12001       {
12002         "title": "Example usage:",
12003         "content": "curl https://{domain}/api/fax/queues/{id}/members  -v -u {name}:{password}",
12004         "type": "json"
12005       }
12006     ],
12007     "name": "GetMembers",
12008     "group": "Fax_Queues",
12009     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12010     "version": "0.0.0",
12011     "filename": "server/api/faxQueue/index.js",
12012     "groupTitle": "Fax_Queues"
12013   },
12014   {
12015     "type": "get",
12016     "url": "/api/fax/queues",
12017     "title": "Gets a list of Queues",
12018     "examples": [
12019       {
12020         "title": "Example usage:",
12021         "content": "curl https://{domain}/api/fax/queues -v -u {name}:{password}",
12022         "type": "json"
12023       }
12024     ],
12025     "name": "GetQueues",
12026     "group": "Fax_Queues",
12027     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
12028     "version": "0.0.0",
12029     "filename": "server/api/faxQueue/index.js",
12030     "groupTitle": "Fax_Queues"
12031   },
12032   {
12033     "type": "get",
12034     "url": "/api/fax/queues/{id}/teams",
12035     "title": "Gets queues list",
12036     "examples": [
12037       {
12038         "title": "Example usage:",
12039         "content": "curl https://{domain}/api/fax/queues/{id}/teams -v -u {name}:{password}",
12040         "type": "json"
12041       }
12042     ],
12043     "name": "GetTeams",
12044     "group": "Fax_Queues",
12045     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12046     "version": "0.0.0",
12047     "filename": "server/api/faxQueue/index.js",
12048     "groupTitle": "Fax_Queues"
12049   },
12050   {
12051     "type": "delete",
12052     "url": "/api/fax/queues/{id}/users",
12053     "title": "Removes agents from a queue",
12054     "examples": [
12055       {
12056         "title": "Example usage:",
12057         "content": "curl https://{domain}/api/fax/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
12058         "type": "json"
12059       }
12060     ],
12061     "name": "RemoveAgents",
12062     "group": "Fax_Queues",
12063     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12064     "version": "0.0.0",
12065     "filename": "server/api/faxQueue/index.js",
12066     "groupTitle": "Fax_Queues"
12067   },
12068   {
12069     "type": "get",
12070     "url": "/api/fax/queues/{id}",
12071     "title": "Gets a single Queue",
12072     "examples": [
12073       {
12074         "title": "Example usage:",
12075         "content": "curl https://{domain}/api/fax/queues/{id} -v -u {name}:{password}",
12076         "type": "json"
12077       }
12078     ],
12079     "name": "ShowQueues",
12080     "group": "Fax_Queues",
12081     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12082     "version": "0.0.0",
12083     "filename": "server/api/faxQueue/index.js",
12084     "groupTitle": "Fax_Queues"
12085   },
12086   {
12087     "type": "put",
12088     "url": "/api/fax/queues/{id}",
12089     "title": "Update an existing Queue",
12090     "examples": [
12091       {
12092         "title": "Example usage:",
12093         "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",
12094         "type": "json"
12095       }
12096     ],
12097     "name": "updateQueues",
12098     "group": "Fax_Queues",
12099     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12100     "version": "0.0.0",
12101     "filename": "server/api/faxQueue/index.js",
12102     "groupTitle": "Fax_Queues"
12103   },
12104   {
12105     "type": "post",
12106     "url": "/api/fax/reports/transfer",
12107     "title": "Creates a new Fax Transfer Report",
12108     "examples": [
12109       {
12110         "title": "Example usage:",
12111         "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",
12112         "type": "json"
12113       }
12114     ],
12115     "name": "CreateFax_Transfer_Reports",
12116     "group": "Fax_Transfer_Reports",
12117     "parameter": {
12118       "fields": {
12119         "Body": [
12120           {
12121             "group": "Body",
12122             "type": "String",
12123             "optional": false,
12124             "field": "uniqueid",
12125             "description": ""
12126           },
12127           {
12128             "group": "Body",
12129             "type": "String",
12130             "allowedValues": [
12131               "\"account\"",
12132               "\"agent\"",
12133               "\"queue\""
12134             ],
12135             "optional": false,
12136             "field": "type",
12137             "description": ""
12138           },
12139           {
12140             "group": "Body",
12141             "type": "String",
12142             "optional": false,
12143             "field": "transferredAt",
12144             "description": ""
12145           }
12146         ]
12147       }
12148     },
12149     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12150     "version": "0.0.0",
12151     "filename": "server/api/faxTransferReport/index.js",
12152     "groupTitle": "Fax_Transfer_Reports"
12153   },
12154   {
12155     "type": "delete",
12156     "url": "/api/fax/reports/transfer/{id}",
12157     "title": "Deletes a Fax Transfer Report",
12158     "examples": [
12159       {
12160         "title": "Example usage:",
12161         "content": "curl https://{domain}/api/fax/reports/transfer/{id} -v -u {name}:{password} -X DELETE",
12162         "type": "json"
12163       }
12164     ],
12165     "name": "DeleteFax_Transfer_Reports",
12166     "group": "Fax_Transfer_Reports",
12167     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12168     "version": "0.0.0",
12169     "filename": "server/api/faxTransferReport/index.js",
12170     "groupTitle": "Fax_Transfer_Reports"
12171   },
12172   {
12173     "type": "get",
12174     "url": "/api/fax/reports/transfer/describe",
12175     "title": "Gets table info about Fax Transfer Reports",
12176     "examples": [
12177       {
12178         "title": "Example usage:",
12179         "content": "curl https://{domain}/api/fax/reports/transfer/describe -v -u {name}:{password}",
12180         "type": "json"
12181       }
12182     ],
12183     "name": "DescribeFax_Transfer_Reports",
12184     "group": "Fax_Transfer_Reports",
12185     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12186     "version": "0.0.0",
12187     "filename": "server/api/faxTransferReport/index.js",
12188     "groupTitle": "Fax_Transfer_Reports"
12189   },
12190   {
12191     "type": "get",
12192     "url": "/api/fax/reports/transfer",
12193     "title": "Gets a list of Fax Transfer Reports",
12194     "examples": [
12195       {
12196         "title": "Example usage:",
12197         "content": "curl https://{domain}/api/fax/reports/transfer -v -u {name}:{password}",
12198         "type": "json"
12199       }
12200     ],
12201     "name": "GetFax_Transfer_Reports",
12202     "group": "Fax_Transfer_Reports",
12203     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
12204     "version": "0.0.0",
12205     "filename": "server/api/faxTransferReport/index.js",
12206     "groupTitle": "Fax_Transfer_Reports"
12207   },
12208   {
12209     "type": "get",
12210     "url": "/api/fax/reports/transfer/{id}",
12211     "title": "Gets a single Fax Transfer Report",
12212     "examples": [
12213       {
12214         "title": "Example usage:",
12215         "content": "curl https://{domain}/api/fax/reports/transfer/{id} -v -u {name}:{password}",
12216         "type": "json"
12217       }
12218     ],
12219     "name": "ShowFax_Transfer_Reports",
12220     "group": "Fax_Transfer_Reports",
12221     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12222     "version": "0.0.0",
12223     "filename": "server/api/faxTransferReport/index.js",
12224     "groupTitle": "Fax_Transfer_Reports"
12225   },
12226   {
12227     "type": "put",
12228     "url": "/api/fax/reports/transfer/{id}",
12229     "title": "Update an existing Fax Transfer Report",
12230     "examples": [
12231       {
12232         "title": "Example usage:",
12233         "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",
12234         "type": "json"
12235       }
12236     ],
12237     "name": "updateFax_Transfer_Reports",
12238     "group": "Fax_Transfer_Reports",
12239     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12240     "version": "0.0.0",
12241     "filename": "server/api/faxTransferReport/index.js",
12242     "groupTitle": "Fax_Transfer_Reports"
12243   },
12244   {
12245     "type": "post",
12246     "url": "/api/integrations/freshdesk/accounts",
12247     "title": "Creates a new Freshdesk Account",
12248     "examples": [
12249       {
12250         "title": "Example usage:",
12251         "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",
12252         "type": "json"
12253       }
12254     ],
12255     "name": "CreateFreshdesk_Accounts",
12256     "group": "Freshdesk_Accounts",
12257     "parameter": {
12258       "fields": {
12259         "Body": [
12260           {
12261             "group": "Body",
12262             "type": "String",
12263             "optional": true,
12264             "field": "name",
12265             "description": ""
12266           },
12267           {
12268             "group": "Body",
12269             "type": "String",
12270             "optional": true,
12271             "field": "description",
12272             "description": ""
12273           },
12274           {
12275             "group": "Body",
12276             "type": "String",
12277             "optional": true,
12278             "field": "username",
12279             "description": ""
12280           },
12281           {
12282             "group": "Body",
12283             "type": "String",
12284             "optional": true,
12285             "field": "apiKey",
12286             "description": ""
12287           },
12288           {
12289             "group": "Body",
12290             "type": "String",
12291             "optional": true,
12292             "field": "remoteUri",
12293             "description": ""
12294           },
12295           {
12296             "group": "Body",
12297             "type": "String",
12298             "optional": false,
12299             "field": "serverUrl",
12300             "description": ""
12301           }
12302         ]
12303       }
12304     },
12305     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12306     "version": "0.0.0",
12307     "filename": "server/api/intFreshdeskAccount/index.js",
12308     "groupTitle": "Freshdesk_Accounts"
12309   },
12310   {
12311     "type": "delete",
12312     "url": "/api/integrations/freshdesk/accounts/{id}",
12313     "title": "Deletes a Freshdesk Account",
12314     "examples": [
12315       {
12316         "title": "Example usage:",
12317         "content": "curl https://{domain}/api/integrations/freshdesk/accounts/{id} -v -u {name}:{password} -X DELETE",
12318         "type": "json"
12319       }
12320     ],
12321     "name": "DeleteFreshdesk_Accounts",
12322     "group": "Freshdesk_Accounts",
12323     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12324     "version": "0.0.0",
12325     "filename": "server/api/intFreshdeskAccount/index.js",
12326     "groupTitle": "Freshdesk_Accounts"
12327   },
12328   {
12329     "type": "get",
12330     "url": "/api/integrations/freshdesk/accounts",
12331     "title": "Gets a list of Freshdesk Accounts",
12332     "examples": [
12333       {
12334         "title": "Example usage:",
12335         "content": "curl https://{domain}/api/integrations/freshdesk/accounts -v -u {name}:{password}",
12336         "type": "json"
12337       }
12338     ],
12339     "name": "GetFreshdesk_Accounts",
12340     "group": "Freshdesk_Accounts",
12341     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
12342     "version": "0.0.0",
12343     "filename": "server/api/intFreshdeskAccount/index.js",
12344     "groupTitle": "Freshdesk_Accounts"
12345   },
12346   {
12347     "type": "get",
12348     "url": "/api/integrations/freshdesk/accounts/{id}",
12349     "title": "Gets a single Freshdesk Account",
12350     "examples": [
12351       {
12352         "title": "Example usage:",
12353         "content": "curl https://{domain}/api/integrations/freshdesk/accounts/{id} -v -u {name}:{password}",
12354         "type": "json"
12355       }
12356     ],
12357     "name": "ShowFreshdesk_Accounts",
12358     "group": "Freshdesk_Accounts",
12359     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12360     "version": "0.0.0",
12361     "filename": "server/api/intFreshdeskAccount/index.js",
12362     "groupTitle": "Freshdesk_Accounts"
12363   },
12364   {
12365     "type": "post",
12366     "url": "/api/integrations/freshdesk/accounts/{id}/configurations",
12367     "title": "Creates new configuration",
12368     "examples": [
12369       {
12370         "title": "Example usage:",
12371         "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",
12372         "type": "json"
12373       }
12374     ],
12375     "name": "addConfiguration",
12376     "group": "Freshdesk_Accounts",
12377     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12378     "version": "0.0.0",
12379     "filename": "server/api/intFreshdeskAccount/index.js",
12380     "groupTitle": "Freshdesk_Accounts"
12381   },
12382   {
12383     "type": "get",
12384     "url": "/api/integrations/freshdesk/accounts/{id}/configurations",
12385     "title": "Gets account configurations",
12386     "examples": [
12387       {
12388         "title": "Example usage:",
12389         "content": "curl https://{domain}/api/integrations/freshdesk/accounts/{id}/configurations -v -u {name}:{password} -X GET",
12390         "type": "json"
12391       }
12392     ],
12393     "name": "getConfigurations",
12394     "group": "Freshdesk_Accounts",
12395     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12396     "version": "0.0.0",
12397     "filename": "server/api/intFreshdeskAccount/index.js",
12398     "groupTitle": "Freshdesk_Accounts"
12399   },
12400   {
12401     "type": "get",
12402     "url": "/api/integrations/freshdesk/accounts/{id}/fields",
12403     "title": "Gets account fields",
12404     "examples": [
12405       {
12406         "title": "Example usage:",
12407         "content": "curl https://{domain}/api/integrations/freshdesk/accounts/{id}/fields -v -u {name}:{password} -X GET",
12408         "type": "json"
12409       }
12410     ],
12411     "name": "getFields",
12412     "group": "Freshdesk_Accounts",
12413     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12414     "version": "0.0.0",
12415     "filename": "server/api/intFreshdeskAccount/index.js",
12416     "groupTitle": "Freshdesk_Accounts"
12417   },
12418   {
12419     "type": "put",
12420     "url": "/api/integrations/freshdesk/accounts/{id}",
12421     "title": "Update an existing Freshdesk Account",
12422     "examples": [
12423       {
12424         "title": "Example usage:",
12425         "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",
12426         "type": "json"
12427       }
12428     ],
12429     "name": "updateFreshdesk_Accounts",
12430     "group": "Freshdesk_Accounts",
12431     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12432     "version": "0.0.0",
12433     "filename": "server/api/intFreshdeskAccount/index.js",
12434     "groupTitle": "Freshdesk_Accounts"
12435   },
12436   {
12437     "type": "post",
12438     "url": "/api/integrations/freshdesk/configurations",
12439     "title": "Creates a new Freshdesk Configuration",
12440     "examples": [
12441       {
12442         "title": "Example usage:",
12443         "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",
12444         "type": "json"
12445       }
12446     ],
12447     "name": "CreateFreshdesk_Configurations",
12448     "group": "Freshdesk_Configurations",
12449     "parameter": {
12450       "fields": {
12451         "Body": [
12452           {
12453             "group": "Body",
12454             "type": "String",
12455             "optional": true,
12456             "field": "name",
12457             "description": ""
12458           },
12459           {
12460             "group": "Body",
12461             "type": "String",
12462             "optional": true,
12463             "field": "description",
12464             "description": ""
12465           }
12466         ]
12467       }
12468     },
12469     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12470     "version": "0.0.0",
12471     "filename": "server/api/intFreshdeskConfiguration/index.js",
12472     "groupTitle": "Freshdesk_Configurations"
12473   },
12474   {
12475     "type": "delete",
12476     "url": "/api/integrations/freshdesk/configurations/{id}",
12477     "title": "Deletes a Freshdesk Configuration",
12478     "examples": [
12479       {
12480         "title": "Example usage:",
12481         "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id} -v -u {name}:{password} -X DELETE",
12482         "type": "json"
12483       }
12484     ],
12485     "name": "DeleteFreshdesk_Configurations",
12486     "group": "Freshdesk_Configurations",
12487     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12488     "version": "0.0.0",
12489     "filename": "server/api/intFreshdeskConfiguration/index.js",
12490     "groupTitle": "Freshdesk_Configurations"
12491   },
12492   {
12493     "type": "get",
12494     "url": "/api/integrations/freshdesk/configurations",
12495     "title": "Gets a list of Freshdesk Configurations",
12496     "examples": [
12497       {
12498         "title": "Example usage:",
12499         "content": "curl https://{domain}/api/integrations/freshdesk/configurations -v -u {name}:{password}",
12500         "type": "json"
12501       }
12502     ],
12503     "name": "GetFreshdesk_Configurations",
12504     "group": "Freshdesk_Configurations",
12505     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/integrations/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&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
12506     "version": "0.0.0",
12507     "filename": "server/api/intFreshdeskConfiguration/index.js",
12508     "groupTitle": "Freshdesk_Configurations"
12509   },
12510   {
12511     "type": "get",
12512     "url": "/api/integrations/freshdesk/configurations/{id}",
12513     "title": "Gets a single Freshdesk Configuration",
12514     "examples": [
12515       {
12516         "title": "Example usage:",
12517         "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id} -v -u {name}:{password}",
12518         "type": "json"
12519       }
12520     ],
12521     "name": "ShowFreshdesk_Configurations",
12522     "group": "Freshdesk_Configurations",
12523     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12524     "version": "0.0.0",
12525     "filename": "server/api/intFreshdeskConfiguration/index.js",
12526     "groupTitle": "Freshdesk_Configurations"
12527   },
12528   {
12529     "type": "get",
12530     "url": "/api/integrations/freshdesk/configurations/{id}/descriptions",
12531     "title": "Gets configurations descriptions",
12532     "examples": [
12533       {
12534         "title": "Example usage:",
12535         "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
12536         "type": "json"
12537       }
12538     ],
12539     "name": "getDescriptions",
12540     "group": "Freshdesk_Configurations",
12541     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12542     "version": "0.0.0",
12543     "filename": "server/api/intFreshdeskConfiguration/index.js",
12544     "groupTitle": "Freshdesk_Configurations"
12545   },
12546   {
12547     "type": "get",
12548     "url": "/api/integrations/freshdesk/configurations/{id}/fields",
12549     "title": "Gets configurations fields",
12550     "examples": [
12551       {
12552         "title": "Example usage:",
12553         "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id}/fields -v -u {name}:{password} -X GET",
12554         "type": "json"
12555       }
12556     ],
12557     "name": "getFields",
12558     "group": "Freshdesk_Configurations",
12559     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12560     "version": "0.0.0",
12561     "filename": "server/api/intFreshdeskConfiguration/index.js",
12562     "groupTitle": "Freshdesk_Configurations"
12563   },
12564   {
12565     "type": "get",
12566     "url": "/api/integrations/freshdesk/configurations/{id}/subjects",
12567     "title": "Gets configurations subjects",
12568     "examples": [
12569       {
12570         "title": "Example usage:",
12571         "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id}/subjects -v -u {name}:{password} -X GET",
12572         "type": "json"
12573       }
12574     ],
12575     "name": "getSubjects",
12576     "group": "Freshdesk_Configurations",
12577     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12578     "version": "0.0.0",
12579     "filename": "server/api/intFreshdeskConfiguration/index.js",
12580     "groupTitle": "Freshdesk_Configurations"
12581   },
12582   {
12583     "type": "get",
12584     "url": "/api/integrations/freshdesk/configurations/{id}/tags",
12585     "title": "Gets configurations tags",
12586     "examples": [
12587       {
12588         "title": "Example usage:",
12589         "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id}/tags -v -u {name}:{password} -X GET",
12590         "type": "json"
12591       }
12592     ],
12593     "name": "getTags",
12594     "group": "Freshdesk_Configurations",
12595     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12596     "version": "0.0.0",
12597     "filename": "server/api/intFreshdeskConfiguration/index.js",
12598     "groupTitle": "Freshdesk_Configurations"
12599   },
12600   {
12601     "type": "post",
12602     "url": "/api/integrations/freshdesk/configurations/{id}/tags",
12603     "title": "Sets new tags",
12604     "examples": [
12605       {
12606         "title": "Example usage:",
12607         "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",
12608         "type": "json"
12609       }
12610     ],
12611     "name": "setTags",
12612     "group": "Freshdesk_Configurations",
12613     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12614     "version": "0.0.0",
12615     "filename": "server/api/intFreshdeskConfiguration/index.js",
12616     "groupTitle": "Freshdesk_Configurations"
12617   },
12618   {
12619     "type": "put",
12620     "url": "/api/integrations/freshdesk/configurations/{id}",
12621     "title": "Update an existing Freshdesk Configuration",
12622     "examples": [
12623       {
12624         "title": "Example usage:",
12625         "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",
12626         "type": "json"
12627       }
12628     ],
12629     "name": "updateFreshdesk_Configurations",
12630     "group": "Freshdesk_Configurations",
12631     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12632     "version": "0.0.0",
12633     "filename": "server/api/intFreshdeskConfiguration/index.js",
12634     "groupTitle": "Freshdesk_Configurations"
12635   },
12636   {
12637     "type": "post",
12638     "url": "/api/integrations/freshdesk/fields",
12639     "title": "Creates a new Freshdesk Field",
12640     "examples": [
12641       {
12642         "title": "Example usage:",
12643         "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",
12644         "type": "json"
12645       }
12646     ],
12647     "name": "CreateFreshdesk_Fields",
12648     "group": "Freshdesk_Fields",
12649     "parameter": {
12650       "fields": {
12651         "Body": [
12652           {
12653             "group": "Body",
12654             "type": "String",
12655             "allowedValues": [
12656               "\"string\"",
12657               "\"variable\"",
12658               "\"customVariable\"",
12659               "\"keyValue\"",
12660               "\"picklist\""
12661             ],
12662             "optional": true,
12663             "field": "type",
12664             "description": ""
12665           },
12666           {
12667             "group": "Body",
12668             "type": "String",
12669             "optional": true,
12670             "field": "content",
12671             "description": ""
12672           },
12673           {
12674             "group": "Body",
12675             "type": "String",
12676             "optional": true,
12677             "field": "key",
12678             "description": ""
12679           },
12680           {
12681             "group": "Body",
12682             "type": "String",
12683             "allowedValues": [
12684               "\"string\"",
12685               "\"variable\"",
12686               "\"customVariable\""
12687             ],
12688             "optional": true,
12689             "field": "keyType",
12690             "description": ""
12691           },
12692           {
12693             "group": "Body",
12694             "type": "String",
12695             "optional": true,
12696             "field": "keyContent",
12697             "description": ""
12698           },
12699           {
12700             "group": "Body",
12701             "type": "String",
12702             "optional": true,
12703             "field": "idField",
12704             "description": ""
12705           },
12706           {
12707             "group": "Body",
12708             "type": "String",
12709             "optional": true,
12710             "field": "nameField",
12711             "description": ""
12712           },
12713           {
12714             "group": "Body",
12715             "type": "Boolean",
12716             "optional": true,
12717             "field": "customField",
12718             "description": ""
12719           },
12720           {
12721             "group": "Body",
12722             "type": "String",
12723             "optional": true,
12724             "field": "variableName",
12725             "description": ""
12726           }
12727         ]
12728       }
12729     },
12730     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12731     "version": "0.0.0",
12732     "filename": "server/api/intFreshdeskField/index.js",
12733     "groupTitle": "Freshdesk_Fields"
12734   },
12735   {
12736     "type": "delete",
12737     "url": "/api/integrations/freshdesk/fields/{id}",
12738     "title": "Deletes a Freshdesk Field",
12739     "examples": [
12740       {
12741         "title": "Example usage:",
12742         "content": "curl https://{domain}/api/integrations/freshdesk/fields/{id} -v -u {name}:{password} -X DELETE",
12743         "type": "json"
12744       }
12745     ],
12746     "name": "DeleteFreshdesk_Fields",
12747     "group": "Freshdesk_Fields",
12748     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12749     "version": "0.0.0",
12750     "filename": "server/api/intFreshdeskField/index.js",
12751     "groupTitle": "Freshdesk_Fields"
12752   },
12753   {
12754     "type": "get",
12755     "url": "/api/integrations/freshdesk/fields",
12756     "title": "Gets a list of Freshdesk Fields",
12757     "examples": [
12758       {
12759         "title": "Example usage:",
12760         "content": "curl https://{domain}/api/integrations/freshdesk/fields -v -u {name}:{password}",
12761         "type": "json"
12762       }
12763     ],
12764     "name": "GetFreshdesk_Fields",
12765     "group": "Freshdesk_Fields",
12766     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
12767     "version": "0.0.0",
12768     "filename": "server/api/intFreshdeskField/index.js",
12769     "groupTitle": "Freshdesk_Fields"
12770   },
12771   {
12772     "type": "get",
12773     "url": "/api/integrations/freshdesk/fields/{id}",
12774     "title": "Gets a single Freshdesk Field",
12775     "examples": [
12776       {
12777         "title": "Example usage:",
12778         "content": "curl https://{domain}/api/integrations/freshdesk/fields/{id} -v -u {name}:{password}",
12779         "type": "json"
12780       }
12781     ],
12782     "name": "ShowFreshdesk_Fields",
12783     "group": "Freshdesk_Fields",
12784     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12785     "version": "0.0.0",
12786     "filename": "server/api/intFreshdeskField/index.js",
12787     "groupTitle": "Freshdesk_Fields"
12788   },
12789   {
12790     "type": "put",
12791     "url": "/api/integrations/freshdesk/fields/{id}",
12792     "title": "Update an existing Freshdesk Field",
12793     "examples": [
12794       {
12795         "title": "Example usage:",
12796         "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",
12797         "type": "json"
12798       }
12799     ],
12800     "name": "updateFreshdesk_Fields",
12801     "group": "Freshdesk_Fields",
12802     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12803     "version": "0.0.0",
12804     "filename": "server/api/intFreshdeskField/index.js",
12805     "groupTitle": "Freshdesk_Fields"
12806   },
12807   {
12808     "type": "post",
12809     "url": "/api/integrations/freshsales/accounts",
12810     "title": "Creates a new Freshsales Account",
12811     "examples": [
12812       {
12813         "title": "Example usage:",
12814         "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",
12815         "type": "json"
12816       }
12817     ],
12818     "name": "CreateFreshsales_Accounts",
12819     "group": "Freshsales_Accounts",
12820     "parameter": {
12821       "fields": {
12822         "Body": [
12823           {
12824             "group": "Body",
12825             "type": "String",
12826             "optional": true,
12827             "field": "name",
12828             "description": ""
12829           },
12830           {
12831             "group": "Body",
12832             "type": "String",
12833             "optional": true,
12834             "field": "description",
12835             "description": ""
12836           },
12837           {
12838             "group": "Body",
12839             "type": "String",
12840             "optional": true,
12841             "field": "username",
12842             "description": ""
12843           },
12844           {
12845             "group": "Body",
12846             "type": "String",
12847             "optional": true,
12848             "field": "apiKey",
12849             "description": ""
12850           },
12851           {
12852             "group": "Body",
12853             "type": "String",
12854             "optional": true,
12855             "field": "remoteUri",
12856             "description": ""
12857           },
12858           {
12859             "group": "Body",
12860             "type": "String",
12861             "optional": false,
12862             "field": "serverUrl",
12863             "description": ""
12864           }
12865         ]
12866       }
12867     },
12868     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12869     "version": "0.0.0",
12870     "filename": "server/api/intFreshsalesAccount/index.js",
12871     "groupTitle": "Freshsales_Accounts"
12872   },
12873   {
12874     "type": "delete",
12875     "url": "/api/integrations/freshsales/accounts/{id}",
12876     "title": "Deletes a Freshsales Account",
12877     "examples": [
12878       {
12879         "title": "Example usage:",
12880         "content": "curl https://{domain}/api/integrations/freshsales/accounts/{id} -v -u {name}:{password} -X DELETE",
12881         "type": "json"
12882       }
12883     ],
12884     "name": "DeleteFreshsales_Accounts",
12885     "group": "Freshsales_Accounts",
12886     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12887     "version": "0.0.0",
12888     "filename": "server/api/intFreshsalesAccount/index.js",
12889     "groupTitle": "Freshsales_Accounts"
12890   },
12891   {
12892     "type": "get",
12893     "url": "/api/integrations/freshsales/accounts",
12894     "title": "Gets a list of Freshsales Accounts",
12895     "examples": [
12896       {
12897         "title": "Example usage:",
12898         "content": "curl https://{domain}/api/integrations/freshsales/accounts -v -u {name}:{password}",
12899         "type": "json"
12900       }
12901     ],
12902     "name": "GetFreshsales_Accounts",
12903     "group": "Freshsales_Accounts",
12904     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
12905     "version": "0.0.0",
12906     "filename": "server/api/intFreshsalesAccount/index.js",
12907     "groupTitle": "Freshsales_Accounts"
12908   },
12909   {
12910     "type": "get",
12911     "url": "/api/integrations/freshsales/accounts/{id}",
12912     "title": "Gets a single Freshsales Account",
12913     "examples": [
12914       {
12915         "title": "Example usage:",
12916         "content": "curl https://{domain}/api/integrations/freshsales/accounts/{id} -v -u {name}:{password}",
12917         "type": "json"
12918       }
12919     ],
12920     "name": "ShowFreshsales_Accounts",
12921     "group": "Freshsales_Accounts",
12922     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12923     "version": "0.0.0",
12924     "filename": "server/api/intFreshsalesAccount/index.js",
12925     "groupTitle": "Freshsales_Accounts"
12926   },
12927   {
12928     "type": "post",
12929     "url": "/api/integrations/freshsales/accounts/{id}/configurations",
12930     "title": "Creates new configuration",
12931     "examples": [
12932       {
12933         "title": "Example usage:",
12934         "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",
12935         "type": "json"
12936       }
12937     ],
12938     "name": "addConfiguration",
12939     "group": "Freshsales_Accounts",
12940     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12941     "version": "0.0.0",
12942     "filename": "server/api/intFreshsalesAccount/index.js",
12943     "groupTitle": "Freshsales_Accounts"
12944   },
12945   {
12946     "type": "get",
12947     "url": "/api/integrations/freshsales/accounts/{id}/configurations",
12948     "title": "Gets account configurations",
12949     "examples": [
12950       {
12951         "title": "Example usage:",
12952         "content": "curl https://{domain}/api/integrations/freshsales/accounts/{id}/configurations -v -u {name}:{password} -X GET",
12953         "type": "json"
12954       }
12955     ],
12956     "name": "getConfigurations",
12957     "group": "Freshsales_Accounts",
12958     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12959     "version": "0.0.0",
12960     "filename": "server/api/intFreshsalesAccount/index.js",
12961     "groupTitle": "Freshsales_Accounts"
12962   },
12963   {
12964     "type": "get",
12965     "url": "/api/integrations/freshsales/accounts/{id}/fields",
12966     "title": "Gets account fields",
12967     "examples": [
12968       {
12969         "title": "Example usage:",
12970         "content": "curl https://{domain}/api/integrations/freshsales/accounts/{id}/fields -v -u {name}:{password} -X GET",
12971         "type": "json"
12972       }
12973     ],
12974     "name": "getFields",
12975     "group": "Freshsales_Accounts",
12976     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12977     "version": "0.0.0",
12978     "filename": "server/api/intFreshsalesAccount/index.js",
12979     "groupTitle": "Freshsales_Accounts"
12980   },
12981   {
12982     "type": "put",
12983     "url": "/api/integrations/freshsales/accounts/{id}",
12984     "title": "Update an existing Freshsales Account",
12985     "examples": [
12986       {
12987         "title": "Example usage:",
12988         "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",
12989         "type": "json"
12990       }
12991     ],
12992     "name": "updateFreshsales_Accounts",
12993     "group": "Freshsales_Accounts",
12994     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12995     "version": "0.0.0",
12996     "filename": "server/api/intFreshsalesAccount/index.js",
12997     "groupTitle": "Freshsales_Accounts"
12998   },
12999   {
13000     "type": "post",
13001     "url": "/api/integrations/freshsales/configurations",
13002     "title": "Creates a new Freshsales Configuration",
13003     "examples": [
13004       {
13005         "title": "Example usage:",
13006         "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",
13007         "type": "json"
13008       }
13009     ],
13010     "name": "CreateFreshsales_Configurations",
13011     "group": "Freshsales_Configurations",
13012     "parameter": {
13013       "fields": {
13014         "Body": [
13015           {
13016             "group": "Body",
13017             "type": "String",
13018             "optional": true,
13019             "field": "name",
13020             "description": ""
13021           },
13022           {
13023             "group": "Body",
13024             "type": "String",
13025             "optional": true,
13026             "field": "description",
13027             "description": ""
13028           }
13029         ]
13030       }
13031     },
13032     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13033     "version": "0.0.0",
13034     "filename": "server/api/intFreshsalesConfiguration/index.js",
13035     "groupTitle": "Freshsales_Configurations"
13036   },
13037   {
13038     "type": "delete",
13039     "url": "/api/integrations/freshsales/configurations/{id}",
13040     "title": "Deletes a Freshsales Configuration",
13041     "examples": [
13042       {
13043         "title": "Example usage:",
13044         "content": "curl https://{domain}/api/integrations/freshsales/configurations/{id} -v -u {name}:{password} -X DELETE",
13045         "type": "json"
13046       }
13047     ],
13048     "name": "DeleteFreshsales_Configurations",
13049     "group": "Freshsales_Configurations",
13050     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13051     "version": "0.0.0",
13052     "filename": "server/api/intFreshsalesConfiguration/index.js",
13053     "groupTitle": "Freshsales_Configurations"
13054   },
13055   {
13056     "type": "get",
13057     "url": "/api/integrations/freshsales/configurations",
13058     "title": "Gets a list of Freshsales Configurations",
13059     "examples": [
13060       {
13061         "title": "Example usage:",
13062         "content": "curl https://{domain}/api/integrations/freshsales/configurations -v -u {name}:{password}",
13063         "type": "json"
13064       }
13065     ],
13066     "name": "GetFreshsales_Configurations",
13067     "group": "Freshsales_Configurations",
13068     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
13069     "version": "0.0.0",
13070     "filename": "server/api/intFreshsalesConfiguration/index.js",
13071     "groupTitle": "Freshsales_Configurations"
13072   },
13073   {
13074     "type": "get",
13075     "url": "/api/integrations/freshsales/configurations/{id}",
13076     "title": "Gets a single Freshsales Configuration",
13077     "examples": [
13078       {
13079         "title": "Example usage:",
13080         "content": "curl https://{domain}/api/integrations/freshsales/configurations/{id} -v -u {name}:{password}",
13081         "type": "json"
13082       }
13083     ],
13084     "name": "ShowFreshsales_Configurations",
13085     "group": "Freshsales_Configurations",
13086     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13087     "version": "0.0.0",
13088     "filename": "server/api/intFreshsalesConfiguration/index.js",
13089     "groupTitle": "Freshsales_Configurations"
13090   },
13091   {
13092     "type": "get",
13093     "url": "/api/integrations/freshsales/configurations/{id}/descriptions",
13094     "title": "Gets configurations descriptions",
13095     "examples": [
13096       {
13097         "title": "Example usage:",
13098         "content": "curl https://{domain}/api/integrations/freshsales/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
13099         "type": "json"
13100       }
13101     ],
13102     "name": "getDescriptions",
13103     "group": "Freshsales_Configurations",
13104     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13105     "version": "0.0.0",
13106     "filename": "server/api/intFreshsalesConfiguration/index.js",
13107     "groupTitle": "Freshsales_Configurations"
13108   },
13109   {
13110     "type": "get",
13111     "url": "/api/integrations/freshsales/configurations/{id}/fields",
13112     "title": "Gets configurations fields",
13113     "examples": [
13114       {
13115         "title": "Example usage:",
13116         "content": "curl https://{domain}/api/integrations/freshsales/configurations/{id}/fields -v -u {name}:{password} -X GET",
13117         "type": "json"
13118       }
13119     ],
13120     "name": "getFields",
13121     "group": "Freshsales_Configurations",
13122     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13123     "version": "0.0.0",
13124     "filename": "server/api/intFreshsalesConfiguration/index.js",
13125     "groupTitle": "Freshsales_Configurations"
13126   },
13127   {
13128     "type": "get",
13129     "url": "/api/integrations/freshsales/configurations/{id}/subjects",
13130     "title": "Gets configurations subjects",
13131     "examples": [
13132       {
13133         "title": "Example usage:",
13134         "content": "curl https://{domain}/api/integrations/freshsales/configurations/{id}/subjects -v -u {name}:{password} -X GET",
13135         "type": "json"
13136       }
13137     ],
13138     "name": "getSubjects",
13139     "group": "Freshsales_Configurations",
13140     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13141     "version": "0.0.0",
13142     "filename": "server/api/intFreshsalesConfiguration/index.js",
13143     "groupTitle": "Freshsales_Configurations"
13144   },
13145   {
13146     "type": "put",
13147     "url": "/api/integrations/freshsales/configurations/{id}",
13148     "title": "Update an existing Freshsales Configuration",
13149     "examples": [
13150       {
13151         "title": "Example usage:",
13152         "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",
13153         "type": "json"
13154       }
13155     ],
13156     "name": "updateFreshsales_Configurations",
13157     "group": "Freshsales_Configurations",
13158     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13159     "version": "0.0.0",
13160     "filename": "server/api/intFreshsalesConfiguration/index.js",
13161     "groupTitle": "Freshsales_Configurations"
13162   },
13163   {
13164     "type": "post",
13165     "url": "/api/integrations/freshsales/fields",
13166     "title": "Creates a new Freshsales Field",
13167     "examples": [
13168       {
13169         "title": "Example usage:",
13170         "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",
13171         "type": "json"
13172       }
13173     ],
13174     "name": "CreateFreshsales_Fields",
13175     "group": "Freshsales_Fields",
13176     "parameter": {
13177       "fields": {
13178         "Body": [
13179           {
13180             "group": "Body",
13181             "type": "String",
13182             "allowedValues": [
13183               "\"string\"",
13184               "\"variable\"",
13185               "\"customVariable\"",
13186               "\"keyValue\"",
13187               "\"picklist\""
13188             ],
13189             "optional": true,
13190             "field": "type",
13191             "description": ""
13192           },
13193           {
13194             "group": "Body",
13195             "type": "String",
13196             "optional": true,
13197             "field": "content",
13198             "description": ""
13199           },
13200           {
13201             "group": "Body",
13202             "type": "String",
13203             "optional": true,
13204             "field": "key",
13205             "description": ""
13206           },
13207           {
13208             "group": "Body",
13209             "type": "String",
13210             "allowedValues": [
13211               "\"string\"",
13212               "\"variable\"",
13213               "\"customVariable\""
13214             ],
13215             "optional": true,
13216             "field": "keyType",
13217             "description": ""
13218           },
13219           {
13220             "group": "Body",
13221             "type": "String",
13222             "optional": true,
13223             "field": "keyContent",
13224             "description": ""
13225           },
13226           {
13227             "group": "Body",
13228             "type": "String",
13229             "optional": true,
13230             "field": "idField",
13231             "description": ""
13232           },
13233           {
13234             "group": "Body",
13235             "type": "String",
13236             "optional": true,
13237             "field": "nameField",
13238             "description": ""
13239           },
13240           {
13241             "group": "Body",
13242             "type": "Boolean",
13243             "optional": true,
13244             "field": "customField",
13245             "description": ""
13246           },
13247           {
13248             "group": "Body",
13249             "type": "String",
13250             "optional": true,
13251             "field": "variableName",
13252             "description": ""
13253           }
13254         ]
13255       }
13256     },
13257     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13258     "version": "0.0.0",
13259     "filename": "server/api/intFreshsalesField/index.js",
13260     "groupTitle": "Freshsales_Fields"
13261   },
13262   {
13263     "type": "delete",
13264     "url": "/api/integrations/freshsales/fields/{id}",
13265     "title": "Deletes a Freshsales Field",
13266     "examples": [
13267       {
13268         "title": "Example usage:",
13269         "content": "curl https://{domain}/api/integrations/freshsales/fields/{id} -v -u {name}:{password} -X DELETE",
13270         "type": "json"
13271       }
13272     ],
13273     "name": "DeleteFreshsales_Fields",
13274     "group": "Freshsales_Fields",
13275     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13276     "version": "0.0.0",
13277     "filename": "server/api/intFreshsalesField/index.js",
13278     "groupTitle": "Freshsales_Fields"
13279   },
13280   {
13281     "type": "get",
13282     "url": "/api/integrations/freshsales/fields",
13283     "title": "Gets a list of Freshsales Fields",
13284     "examples": [
13285       {
13286         "title": "Example usage:",
13287         "content": "curl https://{domain}/api/integrations/freshsales/fields -v -u {name}:{password}",
13288         "type": "json"
13289       }
13290     ],
13291     "name": "GetFreshsales_Fields",
13292     "group": "Freshsales_Fields",
13293     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
13294     "version": "0.0.0",
13295     "filename": "server/api/intFreshsalesField/index.js",
13296     "groupTitle": "Freshsales_Fields"
13297   },
13298   {
13299     "type": "get",
13300     "url": "/api/integrations/freshsales/fields/{id}",
13301     "title": "Gets a single Freshsales Field",
13302     "examples": [
13303       {
13304         "title": "Example usage:",
13305         "content": "curl https://{domain}/api/integrations/freshsales/fields/{id} -v -u {name}:{password}",
13306         "type": "json"
13307       }
13308     ],
13309     "name": "ShowFreshsales_Fields",
13310     "group": "Freshsales_Fields",
13311     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13312     "version": "0.0.0",
13313     "filename": "server/api/intFreshsalesField/index.js",
13314     "groupTitle": "Freshsales_Fields"
13315   },
13316   {
13317     "type": "put",
13318     "url": "/api/integrations/freshsales/fields/{id}",
13319     "title": "Update an existing Freshsales Field",
13320     "examples": [
13321       {
13322         "title": "Example usage:",
13323         "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",
13324         "type": "json"
13325       }
13326     ],
13327     "name": "updateFreshsales_Fields",
13328     "group": "Freshsales_Fields",
13329     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13330     "version": "0.0.0",
13331     "filename": "server/api/intFreshsalesField/index.js",
13332     "groupTitle": "Freshsales_Fields"
13333   },
13334   {
13335     "type": "post",
13336     "url": "/api/campaigns/{id}/blacklists",
13337     "title": "Add blacklists to an IVR campaign",
13338     "examples": [
13339       {
13340         "title": "Example usage:",
13341         "content": "curl https://{domain}/api/campaigns/{id}/blacklists -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
13342         "type": "json"
13343       }
13344     ],
13345     "name": "AddBlackLists",
13346     "group": "IVR_Campaigns",
13347     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13348     "version": "0.0.0",
13349     "filename": "server/api/campaign/index.js",
13350     "groupTitle": "IVR_Campaigns"
13351   },
13352   {
13353     "type": "post",
13354     "url": "/api/campaigns/{id}/lists",
13355     "title": "Add lists to an IVR campaign",
13356     "examples": [
13357       {
13358         "title": "Example usage:",
13359         "content": "curl https://{domain}/api/campaigns/{id}/lists -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
13360         "type": "json"
13361       }
13362     ],
13363     "name": "AddLists",
13364     "group": "IVR_Campaigns",
13365     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13366     "version": "0.0.0",
13367     "filename": "server/api/campaign/index.js",
13368     "groupTitle": "IVR_Campaigns"
13369   },
13370   {
13371     "type": "post",
13372     "url": "/api/campaigns/clone",
13373     "title": "Clone an existing IVR Campaign",
13374     "examples": [
13375       {
13376         "title": "Example usage:",
13377         "content": "curl https://{domain}/api/campaigns/clone -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
13378         "type": "json"
13379       }
13380     ],
13381     "name": "CloneIVR_Campaigns",
13382     "group": "IVR_Campaigns",
13383     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13384     "version": "0.0.0",
13385     "filename": "server/api/campaign/index.js",
13386     "groupTitle": "IVR_Campaigns"
13387   },
13388   {
13389     "type": "post",
13390     "url": "/api/campaigns",
13391     "title": "Creates a new IVR Campaign",
13392     "examples": [
13393       {
13394         "title": "Example usage:",
13395         "content": "curl https://{domain}/api/campaigns -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
13396         "type": "json"
13397       }
13398     ],
13399     "name": "CreateIVR_Campaigns",
13400     "group": "IVR_Campaigns",
13401     "parameter": {
13402       "fields": {
13403         "Body": [
13404           {
13405             "group": "Body",
13406             "type": "String",
13407             "optional": false,
13408             "field": "name",
13409             "description": ""
13410           },
13411           {
13412             "group": "Body",
13413             "type": "String",
13414             "allowedValues": [
13415               "\"ivr\""
13416             ],
13417             "optional": false,
13418             "field": "type",
13419             "description": ""
13420           },
13421           {
13422             "group": "Body",
13423             "type": "String",
13424             "optional": true,
13425             "field": "description",
13426             "description": ""
13427           },
13428           {
13429             "group": "Body",
13430             "type": "Boolean",
13431             "optional": true,
13432             "field": "active",
13433             "description": "<p>Active/Disactive Campaign</p>"
13434           },
13435           {
13436             "group": "Body",
13437             "type": "Integer",
13438             "optional": true,
13439             "field": "limitCalls",
13440             "description": "<p>Max 200 calls.</p>"
13441           },
13442           {
13443             "group": "Body",
13444             "type": "String",
13445             "optional": true,
13446             "field": "dialOriginateCallerIdName",
13447             "description": ""
13448           },
13449           {
13450             "group": "Body",
13451             "type": "String",
13452             "optional": true,
13453             "field": "dialOriginateCallerIdNumber",
13454             "description": ""
13455           },
13456           {
13457             "group": "Body",
13458             "type": "Integer",
13459             "optional": true,
13460             "field": "dialOriginateTimeout",
13461             "description": "<p>Originate Timeout Seconds (min:1, max:999)</p>"
13462           },
13463           {
13464             "group": "Body",
13465             "type": "Integer",
13466             "optional": true,
13467             "field": "dialCongestionMaxRetry",
13468             "description": "<p>#Congestion Retry (min:1, max:999)</p>"
13469           },
13470           {
13471             "group": "Body",
13472             "type": "Integer",
13473             "optional": true,
13474             "field": "dialCongestionRetryFrequency",
13475             "description": "<p>Congestion Retry Frequency Minutes (min:1, max:99999)</p>"
13476           },
13477           {
13478             "group": "Body",
13479             "type": "Integer",
13480             "optional": true,
13481             "field": "dialBusyMaxRetry",
13482             "description": "<p>#Busy Retry (min:1, max:999)</p>"
13483           },
13484           {
13485             "group": "Body",
13486             "type": "Integer",
13487             "optional": true,
13488             "field": "dialBusyRetryFrequency",
13489             "description": "<p>Busy Retry Frequency Minutes (min:1, max:99999)</p>"
13490           },
13491           {
13492             "group": "Body",
13493             "type": "Integer",
13494             "optional": true,
13495             "field": "dialNoAnswerMaxRetry",
13496             "description": "<p>#NoAnswer Retry (min:1, max:999)</p>"
13497           },
13498           {
13499             "group": "Body",
13500             "type": "Integer",
13501             "optional": true,
13502             "field": "dialNoAnswerRetryFrequency",
13503             "description": "<p>NoAnswer Retry Frequency Minutes (min:1, max:99999)</p>"
13504           },
13505           {
13506             "group": "Body",
13507             "type": "Integer",
13508             "optional": true,
13509             "field": "dialGlobalMaxRetry",
13510             "description": "<p>#Global Max Retry (min:1, max:999)</p>"
13511           },
13512           {
13513             "group": "Body",
13514             "type": "String",
13515             "optional": true,
13516             "field": "dialTimezone",
13517             "description": ""
13518           },
13519           {
13520             "group": "Body",
13521             "type": "String",
13522             "optional": true,
13523             "field": "dialGlobalInterval",
13524             "description": ""
13525           },
13526           {
13527             "group": "Body",
13528             "type": "String",
13529             "allowedValues": [
13530               "\"always\"",
13531               "\"never\"",
13532               "\"onlyIfOpen\""
13533             ],
13534             "optional": true,
13535             "field": "dialCheckDuplicateType",
13536             "description": ""
13537           },
13538           {
13539             "group": "Body",
13540             "type": "Boolean",
13541             "optional": true,
13542             "field": "dialAMDActive",
13543             "description": "<p>Active/Disactive AMD</p>"
13544           },
13545           {
13546             "group": "Body",
13547             "type": "Integer",
13548             "optional": true,
13549             "field": "dialAMDInitialSilence",
13550             "description": "<p>#AMD Initial Silence</p>"
13551           },
13552           {
13553             "group": "Body",
13554             "type": "Integer",
13555             "optional": true,
13556             "field": "dialAMDGreeting",
13557             "description": "<p>#AMD Greeting</p>"
13558           },
13559           {
13560             "group": "Body",
13561             "type": "Integer",
13562             "optional": true,
13563             "field": "dialAMDAfterGreetingSilence",
13564             "description": "<p>#AMD After Greeting Silence</p>"
13565           },
13566           {
13567             "group": "Body",
13568             "type": "Integer",
13569             "optional": true,
13570             "field": "dialAMDTotalAnalysisTime",
13571             "description": "<p>#AMD Total Analysis Time</p>"
13572           },
13573           {
13574             "group": "Body",
13575             "type": "Integer",
13576             "optional": true,
13577             "field": "dialAMDMinWordLength",
13578             "description": "<p>#AMD Min Word Length</p>"
13579           },
13580           {
13581             "group": "Body",
13582             "type": "Integer",
13583             "optional": true,
13584             "field": "dialAMDBetweenWordsSilence",
13585             "description": "<p>#AMD Between Words Silence</p>"
13586           },
13587           {
13588             "group": "Body",
13589             "type": "Integer",
13590             "optional": true,
13591             "field": "dialAMDMaximumNumberOfWords",
13592             "description": "<p>#AMD Maximum Number Of Words</p>"
13593           },
13594           {
13595             "group": "Body",
13596             "type": "Integer",
13597             "optional": true,
13598             "field": "dialAMDSilenceThreshold",
13599             "description": "<p>#AMD Silence Threshold (min:0, max:32767)</p>"
13600           },
13601           {
13602             "group": "Body",
13603             "type": "Integer",
13604             "optional": true,
13605             "field": "dialAMDMaximumWordLength",
13606             "description": "<p>#AMD Maximum Word Length</p>"
13607           },
13608           {
13609             "group": "Body",
13610             "type": "String",
13611             "allowedValues": [
13612               "\"DESC\"",
13613               "\"ASC\""
13614             ],
13615             "optional": true,
13616             "field": "dialOrderByScheduledAt",
13617             "description": ""
13618           },
13619           {
13620             "group": "Body",
13621             "type": "String",
13622             "optional": true,
13623             "field": "dialPrefix",
13624             "description": ""
13625           },
13626           {
13627             "group": "Body",
13628             "type": "Integer",
13629             "optional": true,
13630             "field": "dialRandomLastDigitCallerIdNumber",
13631             "description": "<p>Random Last Digit (min:1, max:15)</p>"
13632           },
13633           {
13634             "group": "Body",
13635             "type": "Integer",
13636             "optional": true,
13637             "field": "dialCutDigit",
13638             "description": "<p>Cut Digit (min:1, max:15)</p>"
13639           },
13640           {
13641             "group": "Body",
13642             "type": "Integer",
13643             "optional": true,
13644             "field": "dialNoSuchNumberMaxRetry",
13645             "description": "<p>#NoSuchNumber Retry (min:1, max:999)</p>"
13646           },
13647           {
13648             "group": "Body",
13649             "type": "Integer",
13650             "optional": true,
13651             "field": "dialNoSuchNumberRetryFrequency",
13652             "description": "<p>NoSuchNumber Retry Frequency Minutes (min:1, max:99999)</p>"
13653           },
13654           {
13655             "group": "Body",
13656             "type": "Integer",
13657             "optional": true,
13658             "field": "dialDropMaxRetry",
13659             "description": "<p>#Drop Retry (min:1, max:999)</p>"
13660           },
13661           {
13662             "group": "Body",
13663             "type": "Integer",
13664             "optional": true,
13665             "field": "dialDropRetryFrequency",
13666             "description": "<p>Drop Retry Frequency Minutes (min:1, max:99999)</p>"
13667           },
13668           {
13669             "group": "Body",
13670             "type": "Integer",
13671             "optional": true,
13672             "field": "dialAbandonedMaxRetry",
13673             "description": "<p>#Abandoned Retry (min:1, max:999)</p>"
13674           },
13675           {
13676             "group": "Body",
13677             "type": "Integer",
13678             "optional": true,
13679             "field": "dialAbandonedRetryFrequency",
13680             "description": "<p>Abandoned Retry Frequency Minutes (min:1, max:99999)</p>"
13681           },
13682           {
13683             "group": "Body",
13684             "type": "Integer",
13685             "optional": true,
13686             "field": "dialMachineMaxRetry",
13687             "description": "<p>#Machine Retry (min:1, max:999)</p>"
13688           },
13689           {
13690             "group": "Body",
13691             "type": "Integer",
13692             "optional": true,
13693             "field": "dialMachineRetryFrequency",
13694             "description": "<p>Machine Retry Frequency Minutes (min:1, max:99999)</p>"
13695           },
13696           {
13697             "group": "Body",
13698             "type": "Integer",
13699             "optional": true,
13700             "field": "dialAgentRejectMaxRetry",
13701             "description": "<p>#AgentReject Retry (min:1, max:999)</p>"
13702           },
13703           {
13704             "group": "Body",
13705             "type": "Integer",
13706             "optional": true,
13707             "field": "dialAgentRejectRetryFrequency",
13708             "description": "<p>AgentReject Retry Frequency Minutes (min:1, max:99999)</p>"
13709           }
13710         ]
13711       }
13712     },
13713     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13714     "version": "0.0.0",
13715     "filename": "server/api/campaign/index.js",
13716     "groupTitle": "IVR_Campaigns"
13717   },
13718   {
13719     "type": "delete",
13720     "url": "/api/campaigns/{id}",
13721     "title": "Deletes a IVR Campaign",
13722     "examples": [
13723       {
13724         "title": "Example usage:",
13725         "content": "curl https://{domain}/api/campaigns/{id} -v -u {name}:{password} -X DELETE",
13726         "type": "json"
13727       }
13728     ],
13729     "name": "DeleteIVR_Campaigns",
13730     "group": "IVR_Campaigns",
13731     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13732     "version": "0.0.0",
13733     "filename": "server/api/campaign/index.js",
13734     "groupTitle": "IVR_Campaigns"
13735   },
13736   {
13737     "type": "get",
13738     "url": "/api/campaigns/{id}/blacklists",
13739     "title": "Get IVR campaign blacklists",
13740     "examples": [
13741       {
13742         "title": "Example usage:",
13743         "content": "curl https://{domain}/api/campaigns/{id}/blacklists -v -u {name}:{password} -X GET",
13744         "type": "json"
13745       }
13746     ],
13747     "name": "GetBlackLists",
13748     "group": "IVR_Campaigns",
13749     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13750     "version": "0.0.0",
13751     "filename": "server/api/campaign/index.js",
13752     "groupTitle": "IVR_Campaigns"
13753   },
13754   {
13755     "type": "get",
13756     "url": "/api/campaigns/{id}/finals",
13757     "title": "Gets IVR campaign hopper finals",
13758     "examples": [
13759       {
13760         "title": "Example usage:",
13761         "content": "curl https://{domain}/api/campaigns/{id}/hopper_finals -v -u {name}:{password}  -X GET",
13762         "type": "json"
13763       }
13764     ],
13765     "name": "GetHopperFinals",
13766     "group": "IVR_Campaigns",
13767     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13768     "version": "0.0.0",
13769     "filename": "server/api/campaign/index.js",
13770     "groupTitle": "IVR_Campaigns"
13771   },
13772   {
13773     "type": "get",
13774     "url": "/api/campaigns/{id}/hopper_histories",
13775     "title": "Gets IVR campaign hopper histories",
13776     "examples": [
13777       {
13778         "title": "Example usage:",
13779         "content": "curl https://{domain}/api/campaigns/{id}/hopper_histories -v -u {name}:{password} -X GET",
13780         "type": "json"
13781       }
13782     ],
13783     "name": "GetHopperHistories",
13784     "group": "IVR_Campaigns",
13785     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13786     "version": "0.0.0",
13787     "filename": "server/api/campaign/index.js",
13788     "groupTitle": "IVR_Campaigns"
13789   },
13790   {
13791     "type": "get",
13792     "url": "/api/campaigns/{id}/hoppers",
13793     "title": "Gets IVR campaign hoppers",
13794     "examples": [
13795       {
13796         "title": "Example usage:",
13797         "content": "curl https://{domain}/api/campaigns/{id}/hoppers -v -u {name}:{password} -X GET",
13798         "type": "json"
13799       }
13800     ],
13801     "name": "GetHoppers",
13802     "group": "IVR_Campaigns",
13803     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13804     "version": "0.0.0",
13805     "filename": "server/api/campaign/index.js",
13806     "groupTitle": "IVR_Campaigns"
13807   },
13808   {
13809     "type": "get",
13810     "url": "/api/campaigns",
13811     "title": "Gets a list of IVR Campaigns",
13812     "examples": [
13813       {
13814         "title": "Example usage:",
13815         "content": "curl https://{domain}/api/campaigns -v -u {name}:{password}",
13816         "type": "json"
13817       }
13818     ],
13819     "name": "GetIVR_Campaigns",
13820     "group": "IVR_Campaigns",
13821     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
13822     "version": "0.0.0",
13823     "filename": "server/api/campaign/index.js",
13824     "groupTitle": "IVR_Campaigns"
13825   },
13826   {
13827     "type": "get",
13828     "url": "/api/campaigns/{id}/lists",
13829     "title": "Get IVR campaign lists",
13830     "examples": [
13831       {
13832         "title": "Example usage:",
13833         "content": "curl https://{domain}/api/campaigns/{id}/lists -v -u {name}:{password} -X GET",
13834         "type": "json"
13835       }
13836     ],
13837     "name": "GetLists",
13838     "group": "IVR_Campaigns",
13839     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13840     "version": "0.0.0",
13841     "filename": "server/api/campaign/index.js",
13842     "groupTitle": "IVR_Campaigns"
13843   },
13844   {
13845     "type": "delete",
13846     "url": "/api/campaigns/{id}/blacklists",
13847     "title": "Remove blacklists from an IVR Campaign",
13848     "examples": [
13849       {
13850         "title": "Example usage:",
13851         "content": "curl https://{domain}/api/campaigns/{id}/blacklists?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
13852         "type": "json"
13853       }
13854     ],
13855     "name": "RemoveBlackLists",
13856     "group": "IVR_Campaigns",
13857     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13858     "version": "0.0.0",
13859     "filename": "server/api/campaign/index.js",
13860     "groupTitle": "IVR_Campaigns"
13861   },
13862   {
13863     "type": "delete",
13864     "url": "/api/campaigns/{id}/lists",
13865     "title": "Remove lists from an IVR Campaign",
13866     "examples": [
13867       {
13868         "title": "Example usage:",
13869         "content": "curl https://{domain}/api/campaigns/{id}/lists?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
13870         "type": "json"
13871       }
13872     ],
13873     "name": "RemoveLists",
13874     "group": "IVR_Campaigns",
13875     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13876     "version": "0.0.0",
13877     "filename": "server/api/campaign/index.js",
13878     "groupTitle": "IVR_Campaigns"
13879   },
13880   {
13881     "type": "get",
13882     "url": "/api/campaigns/{id}",
13883     "title": "Gets a single IVR Campaign",
13884     "examples": [
13885       {
13886         "title": "Example usage:",
13887         "content": "curl https://{domain}/api/campaigns/{id} -v -u {name}:{password}",
13888         "type": "json"
13889       }
13890     ],
13891     "name": "ShowIVR_Campaigns",
13892     "group": "IVR_Campaigns",
13893     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13894     "version": "0.0.0",
13895     "filename": "server/api/campaign/index.js",
13896     "groupTitle": "IVR_Campaigns"
13897   },
13898   {
13899     "type": "get",
13900     "url": "/api/campaigns/{id}/blacks",
13901     "title": "Gets IVR campaign hopper blacks",
13902     "examples": [
13903       {
13904         "title": "Example usage:",
13905         "content": "curl https://{domain}/api/campaigns/{id}/hopper_black -v -u {name}:{password}  -X GET",
13906         "type": "json"
13907       }
13908     ],
13909     "name": "getHopperBlacks",
13910     "group": "IVR_Campaigns",
13911     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13912     "version": "0.0.0",
13913     "filename": "server/api/campaign/index.js",
13914     "groupTitle": "IVR_Campaigns"
13915   },
13916   {
13917     "type": "put",
13918     "url": "/api/campaigns/{id}",
13919     "title": "Update an existing IVR Campaign",
13920     "examples": [
13921       {
13922         "title": "Example usage:",
13923         "content": "curl https://{domain}/api/campaigns/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
13924         "type": "json"
13925       }
13926     ],
13927     "name": "updateIVR_Campaigns",
13928     "group": "IVR_Campaigns",
13929     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13930     "version": "0.0.0",
13931     "filename": "server/api/campaign/index.js",
13932     "groupTitle": "IVR_Campaigns"
13933   },
13934   {
13935     "type": "post",
13936     "url": "/api/integrations/reports",
13937     "title": "Creates a new Integration Report",
13938     "examples": [
13939       {
13940         "title": "Example usage:",
13941         "content": "curl https://{domain}/api/integrations/reports -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
13942         "type": "json"
13943       }
13944     ],
13945     "name": "CreateIntegration_Reports",
13946     "group": "Integration_Reports",
13947     "parameter": {
13948       "fields": {
13949         "Body": [
13950           {
13951             "group": "Body",
13952             "type": "String",
13953             "optional": true,
13954             "field": "integration",
13955             "description": ""
13956           },
13957           {
13958             "group": "Body",
13959             "type": "String",
13960             "optional": true,
13961             "field": "eventChannel",
13962             "description": ""
13963           },
13964           {
13965             "group": "Body",
13966             "type": "String",
13967             "optional": true,
13968             "field": "exitStatus",
13969             "description": ""
13970           },
13971           {
13972             "group": "Body",
13973             "type": "String",
13974             "optional": true,
13975             "field": "ticketId",
13976             "description": ""
13977           },
13978           {
13979             "group": "Body",
13980             "type": "Integer",
13981             "optional": true,
13982             "field": "integrationId",
13983             "description": ""
13984           },
13985           {
13986             "group": "Body",
13987             "type": "String",
13988             "optional": true,
13989             "field": "contacts",
13990             "description": ""
13991           },
13992           {
13993             "group": "Body",
13994             "type": "String",
13995             "optional": true,
13996             "field": "uniqueid",
13997             "description": ""
13998           },
13999           {
14000             "group": "Body",
14001             "type": "String",
14002             "optional": true,
14003             "field": "calleridnum",
14004             "description": ""
14005           },
14006           {
14007             "group": "Body",
14008             "type": "String",
14009             "optional": true,
14010             "field": "calleridname",
14011             "description": ""
14012           },
14013           {
14014             "group": "Body",
14015             "type": "String",
14016             "optional": true,
14017             "field": "queue",
14018             "description": ""
14019           },
14020           {
14021             "group": "Body",
14022             "type": "String",
14023             "optional": true,
14024             "field": "interface",
14025             "description": ""
14026           },
14027           {
14028             "group": "Body",
14029             "type": "String",
14030             "optional": true,
14031             "field": "membername",
14032             "description": ""
14033           },
14034           {
14035             "group": "Body",
14036             "type": "String",
14037             "optional": true,
14038             "field": "agentcalledAt",
14039             "description": ""
14040           },
14041           {
14042             "group": "Body",
14043             "type": "String",
14044             "optional": true,
14045             "field": "agentconnectAt",
14046             "description": ""
14047           },
14048           {
14049             "group": "Body",
14050             "type": "Integer",
14051             "optional": true,
14052             "field": "holdtime",
14053             "description": ""
14054           },
14055           {
14056             "group": "Body",
14057             "type": "Boolean",
14058             "optional": true,
14059             "field": "agentcomplete",
14060             "description": ""
14061           },
14062           {
14063             "group": "Body",
14064             "type": "String",
14065             "optional": true,
14066             "field": "agentcompleteAt",
14067             "description": ""
14068           },
14069           {
14070             "group": "Body",
14071             "type": "Integer",
14072             "optional": true,
14073             "field": "talktime",
14074             "description": ""
14075           },
14076           {
14077             "group": "Body",
14078             "type": "Boolean",
14079             "optional": true,
14080             "field": "agentacw",
14081             "description": ""
14082           },
14083           {
14084             "group": "Body",
14085             "type": "Integer",
14086             "optional": true,
14087             "field": "acwtime",
14088             "description": ""
14089           },
14090           {
14091             "group": "Body",
14092             "type": "String",
14093             "optional": true,
14094             "field": "reason",
14095             "description": ""
14096           },
14097           {
14098             "group": "Body",
14099             "type": "Boolean",
14100             "optional": true,
14101             "field": "agentringnoanswer",
14102             "description": ""
14103           },
14104           {
14105             "group": "Body",
14106             "type": "String",
14107             "optional": true,
14108             "field": "agentringnoanswerAt",
14109             "description": ""
14110           },
14111           {
14112             "group": "Body",
14113             "type": "Boolean",
14114             "optional": true,
14115             "field": "agentdump",
14116             "description": ""
14117           },
14118           {
14119             "group": "Body",
14120             "type": "String",
14121             "optional": true,
14122             "field": "agentdumpAt",
14123             "description": ""
14124           },
14125           {
14126             "group": "Body",
14127             "type": "String",
14128             "optional": true,
14129             "field": "lastevent",
14130             "description": ""
14131           },
14132           {
14133             "group": "Body",
14134             "type": "String",
14135             "optional": true,
14136             "field": "channel",
14137             "description": ""
14138           },
14139           {
14140             "group": "Body",
14141             "type": "Integer",
14142             "optional": true,
14143             "field": "channelstate",
14144             "description": ""
14145           },
14146           {
14147             "group": "Body",
14148             "type": "String",
14149             "optional": true,
14150             "field": "channelstatedesc",
14151             "description": ""
14152           },
14153           {
14154             "group": "Body",
14155             "type": "String",
14156             "optional": true,
14157             "field": "connectedlinenum",
14158             "description": ""
14159           },
14160           {
14161             "group": "Body",
14162             "type": "String",
14163             "optional": true,
14164             "field": "connectedlinename",
14165             "description": ""
14166           },
14167           {
14168             "group": "Body",
14169             "type": "String",
14170             "optional": true,
14171             "field": "language",
14172             "description": ""
14173           },
14174           {
14175             "group": "Body",
14176             "type": "String",
14177             "optional": true,
14178             "field": "accountcode",
14179             "description": ""
14180           },
14181           {
14182             "group": "Body",
14183             "type": "String",
14184             "optional": true,
14185             "field": "context",
14186             "description": ""
14187           },
14188           {
14189             "group": "Body",
14190             "type": "String",
14191             "optional": true,
14192             "field": "exten",
14193             "description": ""
14194           },
14195           {
14196             "group": "Body",
14197             "type": "String",
14198             "optional": true,
14199             "field": "priority",
14200             "description": ""
14201           },
14202           {
14203             "group": "Body",
14204             "type": "String",
14205             "optional": true,
14206             "field": "destchannel",
14207             "description": ""
14208           },
14209           {
14210             "group": "Body",
14211             "type": "Integer",
14212             "optional": true,
14213             "field": "destchannelstate",
14214             "description": ""
14215           },
14216           {
14217             "group": "Body",
14218             "type": "String",
14219             "optional": true,
14220             "field": "destchannelstatedesc",
14221             "description": ""
14222           },
14223           {
14224             "group": "Body",
14225             "type": "String",
14226             "optional": true,
14227             "field": "destcalleridnum",
14228             "description": ""
14229           },
14230           {
14231             "group": "Body",
14232             "type": "String",
14233             "optional": true,
14234             "field": "destcalleridname",
14235             "description": ""
14236           },
14237           {
14238             "group": "Body",
14239             "type": "String",
14240             "optional": true,
14241             "field": "destconnectedlinenum",
14242             "description": ""
14243           },
14244           {
14245             "group": "Body",
14246             "type": "String",
14247             "optional": true,
14248             "field": "destconnectedlinename",
14249             "description": ""
14250           },
14251           {
14252             "group": "Body",
14253             "type": "String",
14254             "optional": true,
14255             "field": "destlanguage",
14256             "description": ""
14257           },
14258           {
14259             "group": "Body",
14260             "type": "String",
14261             "optional": true,
14262             "field": "destaccountcode",
14263             "description": ""
14264           },
14265           {
14266             "group": "Body",
14267             "type": "String",
14268             "optional": true,
14269             "field": "destcontext",
14270             "description": ""
14271           },
14272           {
14273             "group": "Body",
14274             "type": "String",
14275             "optional": true,
14276             "field": "destexten",
14277             "description": ""
14278           },
14279           {
14280             "group": "Body",
14281             "type": "String",
14282             "optional": true,
14283             "field": "destpriority",
14284             "description": ""
14285           },
14286           {
14287             "group": "Body",
14288             "type": "String",
14289             "optional": true,
14290             "field": "destuniqueid",
14291             "description": ""
14292           },
14293           {
14294             "group": "Body",
14295             "type": "String",
14296             "optional": true,
14297             "field": "messageId",
14298             "description": ""
14299           },
14300           {
14301             "group": "Body",
14302             "type": "String",
14303             "optional": true,
14304             "field": "inReplyTo",
14305             "description": ""
14306           },
14307           {
14308             "group": "Body",
14309             "type": "String",
14310             "optional": true,
14311             "field": "subject",
14312             "description": ""
14313           },
14314           {
14315             "group": "Body",
14316             "type": "String",
14317             "optional": true,
14318             "field": "from",
14319             "description": ""
14320           },
14321           {
14322             "group": "Body",
14323             "type": "String",
14324             "optional": true,
14325             "field": "to",
14326             "description": ""
14327           },
14328           {
14329             "group": "Body",
14330             "type": "String",
14331             "optional": true,
14332             "field": "cc",
14333             "description": ""
14334           },
14335           {
14336             "group": "Body",
14337             "type": "Text",
14338             "optional": true,
14339             "field": "attachment",
14340             "description": ""
14341           },
14342           {
14343             "group": "Body",
14344             "type": "Text",
14345             "optional": true,
14346             "field": "html",
14347             "description": ""
14348           },
14349           {
14350             "group": "Body",
14351             "type": "Text",
14352             "optional": true,
14353             "field": "text",
14354             "description": ""
14355           },
14356           {
14357             "group": "Body",
14358             "type": "String",
14359             "allowedValues": [
14360               "\"SENT\"",
14361               "\"SENDING\"",
14362               "\"RECEIVED\"",
14363               "\"FAILED\""
14364             ],
14365             "optional": true,
14366             "field": "status",
14367             "description": ""
14368           },
14369           {
14370             "group": "Body",
14371             "type": "String",
14372             "optional": true,
14373             "field": "url",
14374             "description": ""
14375           },
14376           {
14377             "group": "Body",
14378             "type": "String",
14379             "optional": true,
14380             "field": "app",
14381             "description": ""
14382           },
14383           {
14384             "group": "Body",
14385             "type": "String",
14386             "optional": true,
14387             "field": "appdata",
14388             "description": ""
14389           },
14390           {
14391             "group": "Body",
14392             "type": "Integer",
14393             "optional": true,
14394             "field": "projectId",
14395             "description": ""
14396           }
14397         ]
14398       }
14399     },
14400     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14401     "version": "0.0.0",
14402     "filename": "server/api/integrationReport/index.js",
14403     "groupTitle": "Integration_Reports"
14404   },
14405   {
14406     "type": "delete",
14407     "url": "/api/integrations/reports/{id}",
14408     "title": "Deletes a Integration Report",
14409     "examples": [
14410       {
14411         "title": "Example usage:",
14412         "content": "curl https://{domain}/api/integrations/reports/{id} -v -u {name}:{password} -X DELETE",
14413         "type": "json"
14414       }
14415     ],
14416     "name": "DeleteIntegration_Reports",
14417     "group": "Integration_Reports",
14418     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14419     "version": "0.0.0",
14420     "filename": "server/api/integrationReport/index.js",
14421     "groupTitle": "Integration_Reports"
14422   },
14423   {
14424     "type": "get",
14425     "url": "/api/integrations/reports/describe",
14426     "title": "Gets table info about Integration Reports",
14427     "examples": [
14428       {
14429         "title": "Example usage:",
14430         "content": "curl https://{domain}/api/integrations/reports/describe -v -u {name}:{password}",
14431         "type": "json"
14432       }
14433     ],
14434     "name": "DescribeIntegration_Reports",
14435     "group": "Integration_Reports",
14436     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14437     "version": "0.0.0",
14438     "filename": "server/api/integrationReport/index.js",
14439     "groupTitle": "Integration_Reports"
14440   },
14441   {
14442     "type": "get",
14443     "url": "/api/integrations/reports",
14444     "title": "Gets a list of Integration Reports",
14445     "examples": [
14446       {
14447         "title": "Example usage:",
14448         "content": "curl https://{domain}/api/integrations/reports -v -u {name}:{password}",
14449         "type": "json"
14450       }
14451     ],
14452     "name": "GetIntegration_Reports",
14453     "group": "Integration_Reports",
14454     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
14455     "version": "0.0.0",
14456     "filename": "server/api/integrationReport/index.js",
14457     "groupTitle": "Integration_Reports"
14458   },
14459   {
14460     "type": "get",
14461     "url": "/api/integrations/reports/{id}",
14462     "title": "Gets a single Integration Report",
14463     "examples": [
14464       {
14465         "title": "Example usage:",
14466         "content": "curl https://{domain}/api/integrations/reports/{id} -v -u {name}:{password}",
14467         "type": "json"
14468       }
14469     ],
14470     "name": "ShowIntegration_Reports",
14471     "group": "Integration_Reports",
14472     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14473     "version": "0.0.0",
14474     "filename": "server/api/integrationReport/index.js",
14475     "groupTitle": "Integration_Reports"
14476   },
14477   {
14478     "type": "put",
14479     "url": "/api/integrations/reports/{id}",
14480     "title": "Update an existing Integration Report",
14481     "examples": [
14482       {
14483         "title": "Example usage:",
14484         "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",
14485         "type": "json"
14486       }
14487     ],
14488     "name": "updateIntegration_Reports",
14489     "group": "Integration_Reports",
14490     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14491     "version": "0.0.0",
14492     "filename": "server/api/integrationReport/index.js",
14493     "groupTitle": "Integration_Reports"
14494   },
14495   {
14496     "type": "post",
14497     "url": "/api/intervals",
14498     "title": "Creates a new Interval",
14499     "examples": [
14500       {
14501         "title": "Example usage:",
14502         "content": "curl https://{domain}/api/intervals -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
14503         "type": "json"
14504       }
14505     ],
14506     "name": "CreateIntervals",
14507     "group": "Intervals",
14508     "parameter": {
14509       "fields": {
14510         "Body": [
14511           {
14512             "group": "Body",
14513             "type": "String",
14514             "optional": true,
14515             "field": "name",
14516             "description": ""
14517           },
14518           {
14519             "group": "Body",
14520             "type": "String",
14521             "optional": true,
14522             "field": "description",
14523             "description": ""
14524           },
14525           {
14526             "group": "Body",
14527             "type": "String",
14528             "optional": true,
14529             "field": "interval",
14530             "description": ""
14531           }
14532         ]
14533       }
14534     },
14535     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14536     "version": "0.0.0",
14537     "filename": "server/api/interval/index.js",
14538     "groupTitle": "Intervals"
14539   },
14540   {
14541     "type": "delete",
14542     "url": "/api/intervals/{id}",
14543     "title": "Deletes a Interval",
14544     "examples": [
14545       {
14546         "title": "Example usage:",
14547         "content": "curl https://{domain}/api/intervals/{id} -v -u {name}:{password} -X DELETE",
14548         "type": "json"
14549       }
14550     ],
14551     "name": "DeleteIntervals",
14552     "group": "Intervals",
14553     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14554     "version": "0.0.0",
14555     "filename": "server/api/interval/index.js",
14556     "groupTitle": "Intervals"
14557   },
14558   {
14559     "type": "get",
14560     "url": "/api/intervals",
14561     "title": "Gets a list of Intervals",
14562     "examples": [
14563       {
14564         "title": "Example usage:",
14565         "content": "curl https://{domain}/api/intervals -v -u {name}:{password}",
14566         "type": "json"
14567       }
14568     ],
14569     "name": "GetIntervals",
14570     "group": "Intervals",
14571     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
14572     "version": "0.0.0",
14573     "filename": "server/api/interval/index.js",
14574     "groupTitle": "Intervals"
14575   },
14576   {
14577     "type": "get",
14578     "url": "/api/intervals/{id}",
14579     "title": "Gets a single Interval",
14580     "examples": [
14581       {
14582         "title": "Example usage:",
14583         "content": "curl https://{domain}/api/intervals/{id} -v -u {name}:{password}",
14584         "type": "json"
14585       }
14586     ],
14587     "name": "ShowIntervals",
14588     "group": "Intervals",
14589     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14590     "version": "0.0.0",
14591     "filename": "server/api/interval/index.js",
14592     "groupTitle": "Intervals"
14593   },
14594   {
14595     "type": "post",
14596     "url": "/api/intervals/{id}/sub_intervals",
14597     "title": "Creates a new sub interval",
14598     "examples": [
14599       {
14600         "title": "Example usage:",
14601         "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",
14602         "type": "json"
14603       }
14604     ],
14605     "name": "addInterval",
14606     "group": "Intervals",
14607     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14608     "version": "0.0.0",
14609     "filename": "server/api/interval/index.js",
14610     "groupTitle": "Intervals"
14611   },
14612   {
14613     "type": "post",
14614     "url": "/api/intervals/{id}/sub_intervals/create_many",
14615     "title": "Create new sub intervals set",
14616     "examples": [
14617       {
14618         "title": "Example usage:",
14619         "content": "curl https://{domain}/api/intervals/{id}/sub_intervals -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
14620         "type": "json"
14621       }
14622     ],
14623     "name": "addIntervals",
14624     "group": "Intervals",
14625     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14626     "version": "0.0.0",
14627     "filename": "server/api/interval/index.js",
14628     "groupTitle": "Intervals"
14629   },
14630   {
14631     "type": "get",
14632     "url": "/api/intervals/{id}/sub_intervals",
14633     "title": "Get sub intervals set",
14634     "examples": [
14635       {
14636         "title": "Example usage:",
14637         "content": "curl https://{domain}/api/intervals/{id}/sub_intervals -v -u {name}:{password} -X GET",
14638         "type": "json"
14639       }
14640     ],
14641     "name": "getIntervals",
14642     "group": "Intervals",
14643     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14644     "version": "0.0.0",
14645     "filename": "server/api/interval/index.js",
14646     "groupTitle": "Intervals"
14647   },
14648   {
14649     "type": "put",
14650     "url": "/api/intervals/{id}",
14651     "title": "Update an existing Interval",
14652     "examples": [
14653       {
14654         "title": "Example usage:",
14655         "content": "curl https://{domain}/api/intervals/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
14656         "type": "json"
14657       }
14658     ],
14659     "name": "updateIntervals",
14660     "group": "Intervals",
14661     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14662     "version": "0.0.0",
14663     "filename": "server/api/interval/index.js",
14664     "groupTitle": "Intervals"
14665   },
14666   {
14667     "type": "post",
14668     "url": "/api/jira",
14669     "title": "Creates a new issue",
14670     "examples": [
14671       {
14672         "title": "Example usage:",
14673         "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}",
14674         "type": "json"
14675       }
14676     ],
14677     "name": "Creates_Issue",
14678     "group": "Issue",
14679     "parameter": {
14680       "fields": {
14681         "Body": [
14682           {
14683             "group": "Body",
14684             "type": "String",
14685             "allowedValues": [
14686               "\"Bug\""
14687             ],
14688             "optional": true,
14689             "field": "issuetype",
14690             "description": ""
14691           },
14692           {
14693             "group": "Body",
14694             "type": "String",
14695             "optional": false,
14696             "field": "summary",
14697             "description": ""
14698           },
14699           {
14700             "group": "Body",
14701             "type": "String",
14702             "optional": false,
14703             "field": "description",
14704             "description": ""
14705           }
14706         ]
14707       }
14708     },
14709     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14710     "version": "0.0.0",
14711     "filename": "server/api/jira/index.js",
14712     "groupTitle": "Issue"
14713   },
14714   {
14715     "type": "post",
14716     "url": "/api/jscripty/answers/reports",
14717     "title": "Creates a new Report",
14718     "examples": [
14719       {
14720         "title": "Example usage:",
14721         "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",
14722         "type": "json"
14723       }
14724     ],
14725     "name": "CreateReports",
14726     "group": "JscriptyAnswerReport",
14727     "parameter": {
14728       "fields": {
14729         "Body": [
14730           {
14731             "group": "Body",
14732             "type": "Text",
14733             "optional": true,
14734             "field": "question",
14735             "description": ""
14736           },
14737           {
14738             "group": "Body",
14739             "type": "Text",
14740             "optional": true,
14741             "field": "answer",
14742             "description": ""
14743           },
14744           {
14745             "group": "Body",
14746             "type": "String",
14747             "optional": true,
14748             "field": "membername",
14749             "description": ""
14750           },
14751           {
14752             "group": "Body",
14753             "type": "String",
14754             "optional": true,
14755             "field": "projectname",
14756             "description": ""
14757           },
14758           {
14759             "group": "Body",
14760             "type": "String",
14761             "optional": true,
14762             "field": "queue",
14763             "description": ""
14764           },
14765           {
14766             "group": "Body",
14767             "type": "String",
14768             "optional": true,
14769             "field": "uniqueid",
14770             "description": ""
14771           },
14772           {
14773             "group": "Body",
14774             "type": "String",
14775             "optional": true,
14776             "field": "calleridname",
14777             "description": ""
14778           },
14779           {
14780             "group": "Body",
14781             "type": "String",
14782             "optional": true,
14783             "field": "calleridnum",
14784             "description": ""
14785           },
14786           {
14787             "group": "Body",
14788             "type": "String",
14789             "optional": true,
14790             "field": "questionId",
14791             "description": ""
14792           }
14793         ]
14794       }
14795     },
14796     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14797     "version": "0.0.0",
14798     "filename": "server/api/jscriptyAnswerReport/index.js",
14799     "groupTitle": "JscriptyAnswerReport"
14800   },
14801   {
14802     "type": "delete",
14803     "url": "/api/jscripty/answers/reports/{id}",
14804     "title": "Deletes a Report",
14805     "examples": [
14806       {
14807         "title": "Example usage:",
14808         "content": "curl https://{domain}/api/jscripty/answers/reports/{id} -v -u {name}:{password} -X DELETE",
14809         "type": "json"
14810       }
14811     ],
14812     "name": "DeleteReports",
14813     "group": "JscriptyAnswerReport",
14814     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14815     "version": "0.0.0",
14816     "filename": "server/api/jscriptyAnswerReport/index.js",
14817     "groupTitle": "JscriptyAnswerReport"
14818   },
14819   {
14820     "type": "get",
14821     "url": "/api/jscripty/answers/reports/describe",
14822     "title": "Gets table info about Reports",
14823     "examples": [
14824       {
14825         "title": "Example usage:",
14826         "content": "curl https://{domain}/api/jscripty/answers/reports/describe -v -u {name}:{password}",
14827         "type": "json"
14828       }
14829     ],
14830     "name": "DescribeReports",
14831     "group": "JscriptyAnswerReport",
14832     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14833     "version": "0.0.0",
14834     "filename": "server/api/jscriptyAnswerReport/index.js",
14835     "groupTitle": "JscriptyAnswerReport"
14836   },
14837   {
14838     "type": "get",
14839     "url": "/api/jscripty/answers/reports",
14840     "title": "Gets a list of Reports",
14841     "examples": [
14842       {
14843         "title": "Example usage:",
14844         "content": "curl https://{domain}/api/jscripty/answers/reports -v -u {name}:{password}",
14845         "type": "json"
14846       }
14847     ],
14848     "name": "GetReports",
14849     "group": "JscriptyAnswerReport",
14850     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
14851     "version": "0.0.0",
14852     "filename": "server/api/jscriptyAnswerReport/index.js",
14853     "groupTitle": "JscriptyAnswerReport"
14854   },
14855   {
14856     "type": "get",
14857     "url": "/api/jscripty/answers/reports/{id}",
14858     "title": "Gets a single Report",
14859     "examples": [
14860       {
14861         "title": "Example usage:",
14862         "content": "curl https://{domain}/api/jscripty/answers/reports/{id} -v -u {name}:{password}",
14863         "type": "json"
14864       }
14865     ],
14866     "name": "ShowReports",
14867     "group": "JscriptyAnswerReport",
14868     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14869     "version": "0.0.0",
14870     "filename": "server/api/jscriptyAnswerReport/index.js",
14871     "groupTitle": "JscriptyAnswerReport"
14872   },
14873   {
14874     "type": "put",
14875     "url": "/api/jscripty/answers/reports/{id}",
14876     "title": "Update an existing Report",
14877     "examples": [
14878       {
14879         "title": "Example usage:",
14880         "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",
14881         "type": "json"
14882       }
14883     ],
14884     "name": "updateReports",
14885     "group": "JscriptyAnswerReport",
14886     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14887     "version": "0.0.0",
14888     "filename": "server/api/jscriptyAnswerReport/index.js",
14889     "groupTitle": "JscriptyAnswerReport"
14890   },
14891   {
14892     "type": "post",
14893     "url": "/api/jscripty/questions/reports",
14894     "title": "Creates a new Report",
14895     "examples": [
14896       {
14897         "title": "Example usage:",
14898         "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",
14899         "type": "json"
14900       }
14901     ],
14902     "name": "CreateReports",
14903     "group": "JscriptyQuestionReport",
14904     "parameter": {
14905       "fields": {
14906         "Body": [
14907           {
14908             "group": "Body",
14909             "type": "Text",
14910             "optional": true,
14911             "field": "question",
14912             "description": ""
14913           },
14914           {
14915             "group": "Body",
14916             "type": "Text",
14917             "optional": true,
14918             "field": "answer",
14919             "description": ""
14920           },
14921           {
14922             "group": "Body",
14923             "type": "String",
14924             "optional": true,
14925             "field": "membername",
14926             "description": ""
14927           },
14928           {
14929             "group": "Body",
14930             "type": "String",
14931             "optional": true,
14932             "field": "projectname",
14933             "description": ""
14934           },
14935           {
14936             "group": "Body",
14937             "type": "String",
14938             "optional": true,
14939             "field": "queue",
14940             "description": ""
14941           },
14942           {
14943             "group": "Body",
14944             "type": "String",
14945             "optional": true,
14946             "field": "uniqueid",
14947             "description": ""
14948           },
14949           {
14950             "group": "Body",
14951             "type": "String",
14952             "optional": true,
14953             "field": "calleridname",
14954             "description": ""
14955           },
14956           {
14957             "group": "Body",
14958             "type": "String",
14959             "optional": true,
14960             "field": "calleridnum",
14961             "description": ""
14962           },
14963           {
14964             "group": "Body",
14965             "type": "String",
14966             "optional": true,
14967             "field": "questionId",
14968             "description": ""
14969           }
14970         ]
14971       }
14972     },
14973     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14974     "version": "0.0.0",
14975     "filename": "server/api/jscriptyQuestionReport/index.js",
14976     "groupTitle": "JscriptyQuestionReport"
14977   },
14978   {
14979     "type": "delete",
14980     "url": "/api/jscripty/questions/reports/{id}",
14981     "title": "Deletes a Report",
14982     "examples": [
14983       {
14984         "title": "Example usage:",
14985         "content": "curl https://{domain}/api/jscripty/questions/reports/{id} -v -u {name}:{password} -X DELETE",
14986         "type": "json"
14987       }
14988     ],
14989     "name": "DeleteReports",
14990     "group": "JscriptyQuestionReport",
14991     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <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/jscriptyQuestionReport/index.js",
14994     "groupTitle": "JscriptyQuestionReport"
14995   },
14996   {
14997     "type": "get",
14998     "url": "/api/jscripty/questions/reports/describe",
14999     "title": "Gets table info about Reports",
15000     "examples": [
15001       {
15002         "title": "Example usage:",
15003         "content": "curl https://{domain}/api/jscripty/questions/reports/describe -v -u {name}:{password}",
15004         "type": "json"
15005       }
15006     ],
15007     "name": "DescribeReports",
15008     "group": "JscriptyQuestionReport",
15009     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15010     "version": "0.0.0",
15011     "filename": "server/api/jscriptyQuestionReport/index.js",
15012     "groupTitle": "JscriptyQuestionReport"
15013   },
15014   {
15015     "type": "get",
15016     "url": "/api/jscripty/questions/reports",
15017     "title": "Gets a list of Reports",
15018     "examples": [
15019       {
15020         "title": "Example usage:",
15021         "content": "curl https://{domain}/api/jscripty/questions/reports -v -u {name}:{password}",
15022         "type": "json"
15023       }
15024     ],
15025     "name": "GetReports",
15026     "group": "JscriptyQuestionReport",
15027     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
15028     "version": "0.0.0",
15029     "filename": "server/api/jscriptyQuestionReport/index.js",
15030     "groupTitle": "JscriptyQuestionReport"
15031   },
15032   {
15033     "type": "get",
15034     "url": "/api/jscripty/questions/reports/{id}",
15035     "title": "Gets a single Report",
15036     "examples": [
15037       {
15038         "title": "Example usage:",
15039         "content": "curl https://{domain}/api/jscripty/questions/reports/{id} -v -u {name}:{password}",
15040         "type": "json"
15041       }
15042     ],
15043     "name": "ShowReports",
15044     "group": "JscriptyQuestionReport",
15045     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <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/jscriptyQuestionReport/index.js",
15048     "groupTitle": "JscriptyQuestionReport"
15049   },
15050   {
15051     "type": "put",
15052     "url": "/api/jscripty/questions/reports/{id}",
15053     "title": "Update an existing Report",
15054     "examples": [
15055       {
15056         "title": "Example usage:",
15057         "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",
15058         "type": "json"
15059       }
15060     ],
15061     "name": "updateReports",
15062     "group": "JscriptyQuestionReport",
15063     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <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/jscriptyQuestionReport/index.js",
15066     "groupTitle": "JscriptyQuestionReport"
15067   },
15068   {
15069     "type": "post",
15070     "url": "/api/jscripty/sessions/reports",
15071     "title": "Creates a new Report",
15072     "examples": [
15073       {
15074         "title": "Example usage:",
15075         "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",
15076         "type": "json"
15077       }
15078     ],
15079     "name": "CreateReports",
15080     "group": "JscriptySessionReport",
15081     "parameter": {
15082       "fields": {
15083         "Body": [
15084           {
15085             "group": "Body",
15086             "type": "String",
15087             "optional": true,
15088             "field": "starttime",
15089             "description": ""
15090           },
15091           {
15092             "group": "Body",
15093             "type": "String",
15094             "optional": true,
15095             "field": "endtime",
15096             "description": ""
15097           },
15098           {
15099             "group": "Body",
15100             "type": "String",
15101             "optional": true,
15102             "field": "membername",
15103             "description": ""
15104           },
15105           {
15106             "group": "Body",
15107             "type": "String",
15108             "optional": true,
15109             "field": "projectname",
15110             "description": ""
15111           },
15112           {
15113             "group": "Body",
15114             "type": "String",
15115             "optional": true,
15116             "field": "queue",
15117             "description": ""
15118           },
15119           {
15120             "group": "Body",
15121             "type": "String",
15122             "optional": true,
15123             "field": "uniqueid",
15124             "description": ""
15125           },
15126           {
15127             "group": "Body",
15128             "type": "String",
15129             "optional": true,
15130             "field": "calleridname",
15131             "description": ""
15132           },
15133           {
15134             "group": "Body",
15135             "type": "String",
15136             "optional": true,
15137             "field": "calleridnum",
15138             "description": ""
15139           },
15140           {
15141             "group": "Body",
15142             "type": "Boolean",
15143             "optional": true,
15144             "field": "completed",
15145             "description": ""
15146           }
15147         ]
15148       }
15149     },
15150     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15151     "version": "0.0.0",
15152     "filename": "server/api/jscriptySessionReport/index.js",
15153     "groupTitle": "JscriptySessionReport"
15154   },
15155   {
15156     "type": "delete",
15157     "url": "/api/jscripty/sessions/reports/{id}",
15158     "title": "Deletes a Report",
15159     "examples": [
15160       {
15161         "title": "Example usage:",
15162         "content": "curl https://{domain}/api/jscripty/sessions/reports/{id} -v -u {name}:{password} -X DELETE",
15163         "type": "json"
15164       }
15165     ],
15166     "name": "DeleteReports",
15167     "group": "JscriptySessionReport",
15168     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15169     "version": "0.0.0",
15170     "filename": "server/api/jscriptySessionReport/index.js",
15171     "groupTitle": "JscriptySessionReport"
15172   },
15173   {
15174     "type": "get",
15175     "url": "/api/jscripty/sessions/reports/describe",
15176     "title": "Gets table info about Reports",
15177     "examples": [
15178       {
15179         "title": "Example usage:",
15180         "content": "curl https://{domain}/api/jscripty/sessions/reports/describe -v -u {name}:{password}",
15181         "type": "json"
15182       }
15183     ],
15184     "name": "DescribeReports",
15185     "group": "JscriptySessionReport",
15186     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15187     "version": "0.0.0",
15188     "filename": "server/api/jscriptySessionReport/index.js",
15189     "groupTitle": "JscriptySessionReport"
15190   },
15191   {
15192     "type": "get",
15193     "url": "/api/jscripty/sessions/reports",
15194     "title": "Gets a list of Reports",
15195     "examples": [
15196       {
15197         "title": "Example usage:",
15198         "content": "curl https://{domain}/api/jscripty/sessions/reports -v -u {name}:{password}",
15199         "type": "json"
15200       }
15201     ],
15202     "name": "GetReports",
15203     "group": "JscriptySessionReport",
15204     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
15205     "version": "0.0.0",
15206     "filename": "server/api/jscriptySessionReport/index.js",
15207     "groupTitle": "JscriptySessionReport"
15208   },
15209   {
15210     "type": "get",
15211     "url": "/api/jscripty/sessions/reports/{id}",
15212     "title": "Gets a single Report",
15213     "examples": [
15214       {
15215         "title": "Example usage:",
15216         "content": "curl https://{domain}/api/jscripty/sessions/reports/{id} -v -u {name}:{password}",
15217         "type": "json"
15218       }
15219     ],
15220     "name": "ShowReports",
15221     "group": "JscriptySessionReport",
15222     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15223     "version": "0.0.0",
15224     "filename": "server/api/jscriptySessionReport/index.js",
15225     "groupTitle": "JscriptySessionReport"
15226   },
15227   {
15228     "type": "get",
15229     "url": "/api/jscripty/sessions/reports/{id}/questions",
15230     "title": "Gets Jscripty Session questions",
15231     "examples": [
15232       {
15233         "title": "Example usage:",
15234         "content": "curl https://{domain}/api/jscripty/sessions/reports/{id}/questions -v -u {name}:{password}  -X GET",
15235         "type": "json"
15236       }
15237     ],
15238     "name": "getQuestions",
15239     "group": "JscriptySessionReport",
15240     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15241     "version": "0.0.0",
15242     "filename": "server/api/jscriptySessionReport/index.js",
15243     "groupTitle": "JscriptySessionReport"
15244   },
15245   {
15246     "type": "put",
15247     "url": "/api/jscripty/sessions/reports/{id}",
15248     "title": "Update an existing Report",
15249     "examples": [
15250       {
15251         "title": "Example usage:",
15252         "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",
15253         "type": "json"
15254       }
15255     ],
15256     "name": "updateReports",
15257     "group": "JscriptySessionReport",
15258     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15259     "version": "0.0.0",
15260     "filename": "server/api/jscriptySessionReport/index.js",
15261     "groupTitle": "JscriptySessionReport"
15262   },
15263   {
15264     "type": "post",
15265     "url": "/api/jscripty/projects/clone",
15266     "title": "Clone an existing Project",
15267     "examples": [
15268       {
15269         "title": "Example usage:",
15270         "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",
15271         "type": "json"
15272       }
15273     ],
15274     "name": "CloneProjects",
15275     "group": "Jscripty_Projects",
15276     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15277     "version": "0.0.0",
15278     "filename": "server/api/jscriptyProject/index.js",
15279     "groupTitle": "Jscripty_Projects"
15280   },
15281   {
15282     "type": "post",
15283     "url": "/api/jscripty/projects",
15284     "title": "Creates a new Project",
15285     "examples": [
15286       {
15287         "title": "Example usage:",
15288         "content": "curl https://{domain}/api/jscripty/projects -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
15289         "type": "json"
15290       }
15291     ],
15292     "name": "CreateProjects",
15293     "group": "Jscripty_Projects",
15294     "parameter": {
15295       "fields": {
15296         "Body": [
15297           {
15298             "group": "Body",
15299             "type": "String",
15300             "optional": true,
15301             "field": "name",
15302             "description": ""
15303           },
15304           {
15305             "group": "Body",
15306             "type": "String",
15307             "optional": true,
15308             "field": "description",
15309             "description": ""
15310           },
15311           {
15312             "group": "Body",
15313             "type": "Text",
15314             "optional": true,
15315             "field": "formData",
15316             "description": ""
15317           },
15318           {
15319             "group": "Body",
15320             "type": "Boolean",
15321             "optional": true,
15322             "field": "enableUncompleteSave",
15323             "description": ""
15324           },
15325           {
15326             "group": "Body",
15327             "type": "Boolean",
15328             "optional": true,
15329             "field": "sendUnpauseOnSubmit",
15330             "description": ""
15331           }
15332         ]
15333       }
15334     },
15335     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15336     "version": "0.0.0",
15337     "filename": "server/api/jscriptyProject/index.js",
15338     "groupTitle": "Jscripty_Projects"
15339   },
15340   {
15341     "type": "delete",
15342     "url": "/api/jscripty/projects/{id}",
15343     "title": "Deletes a Project",
15344     "examples": [
15345       {
15346         "title": "Example usage:",
15347         "content": "curl https://{domain}/api/jscripty/projects/{id} -v -u {name}:{password} -X DELETE",
15348         "type": "json"
15349       }
15350     ],
15351     "name": "DeleteProjects",
15352     "group": "Jscripty_Projects",
15353     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15354     "version": "0.0.0",
15355     "filename": "server/api/jscriptyProject/index.js",
15356     "groupTitle": "Jscripty_Projects"
15357   },
15358   {
15359     "type": "get",
15360     "url": "/api/jscripty/projects",
15361     "title": "Gets a list of Projects",
15362     "examples": [
15363       {
15364         "title": "Example usage:",
15365         "content": "curl https://{domain}/api/jscripty/projects -v -u {name}:{password}",
15366         "type": "json"
15367       }
15368     ],
15369     "name": "GetProjects",
15370     "group": "Jscripty_Projects",
15371     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
15372     "version": "0.0.0",
15373     "filename": "server/api/jscriptyProject/index.js",
15374     "groupTitle": "Jscripty_Projects"
15375   },
15376   {
15377     "type": "get",
15378     "url": "/api/jscripty/projects/{id}",
15379     "title": "Gets a single Project",
15380     "examples": [
15381       {
15382         "title": "Example usage:",
15383         "content": "curl https://{domain}/api/jscripty/projects/{id} -v -u {name}:{password}",
15384         "type": "json"
15385       }
15386     ],
15387     "name": "ShowProjects",
15388     "group": "Jscripty_Projects",
15389     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15390     "version": "0.0.0",
15391     "filename": "server/api/jscriptyProject/index.js",
15392     "groupTitle": "Jscripty_Projects"
15393   },
15394   {
15395     "type": "get",
15396     "url": "/api/jscripty/projects/{id}/answers",
15397     "title": "Gets jscripty project answers",
15398     "examples": [
15399       {
15400         "title": "Example usage:",
15401         "content": "curl https://{domain}/api/jscripty/projects/{id}/answers -v -u {name}:{password}  -X GET",
15402         "type": "json"
15403       }
15404     ],
15405     "name": "getAnswers",
15406     "group": "Jscripty_Projects",
15407     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15408     "version": "0.0.0",
15409     "filename": "server/api/jscriptyProject/index.js",
15410     "groupTitle": "Jscripty_Projects"
15411   },
15412   {
15413     "type": "get",
15414     "url": "/api/jscripty/projects/{id}/sessions",
15415     "title": "Gets jscripty project sessions",
15416     "examples": [
15417       {
15418         "title": "Example usage:",
15419         "content": "curl https://{domain}/api/jscripty/projects/{id}/sessions -v -u {name}:{password}  -X GET",
15420         "type": "json"
15421       }
15422     ],
15423     "name": "getSessions",
15424     "group": "Jscripty_Projects",
15425     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15426     "version": "0.0.0",
15427     "filename": "server/api/jscriptyProject/index.js",
15428     "groupTitle": "Jscripty_Projects"
15429   },
15430   {
15431     "type": "get",
15432     "url": "/api/jscripty/projects/{id}/summary",
15433     "title": "Gets jscripty project summary",
15434     "examples": [
15435       {
15436         "title": "Example usage:",
15437         "content": "curl https://{domain}/api/jscripty/projects/{id}/summary -v -u {name}:{password}  -X GET",
15438         "type": "json"
15439       }
15440     ],
15441     "name": "getSummary",
15442     "group": "Jscripty_Projects",
15443     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15444     "version": "0.0.0",
15445     "filename": "server/api/jscriptyProject/index.js",
15446     "groupTitle": "Jscripty_Projects"
15447   },
15448   {
15449     "type": "put",
15450     "url": "/api/jscripty/projects/{id}",
15451     "title": "Update an existing Project",
15452     "examples": [
15453       {
15454         "title": "Example usage:",
15455         "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",
15456         "type": "json"
15457       }
15458     ],
15459     "name": "updateProjects",
15460     "group": "Jscripty_Projects",
15461     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15462     "version": "0.0.0",
15463     "filename": "server/api/jscriptyProject/index.js",
15464     "groupTitle": "Jscripty_Projects"
15465   },
15466   {
15467     "type": "get",
15468     "url": "/api/license",
15469     "title": "Gets License Info",
15470     "examples": [
15471       {
15472         "title": "Example usage:",
15473         "content": "curl https://{domain}/api/license -v -u {name}:{password} -X GET",
15474         "type": "json"
15475       }
15476     ],
15477     "name": "index",
15478     "group": "License",
15479     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15480     "version": "0.0.0",
15481     "filename": "server/api/license/index.js",
15482     "groupTitle": "License"
15483   },
15484   {
15485     "type": "put",
15486     "url": "/api/license/{id}",
15487     "title": "Update License Info",
15488     "examples": [
15489       {
15490         "title": "Example usage:",
15491         "content": "curl https://{domain}/api/license/{id} -v -u {name}:{password} -X PUT",
15492         "type": "json"
15493       }
15494     ],
15495     "name": "update",
15496     "group": "License",
15497     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15498     "version": "0.0.0",
15499     "filename": "server/api/license/index.js",
15500     "groupTitle": "License"
15501   },
15502   {
15503     "type": "post",
15504     "url": "/api/mail/accounts/{id}/users",
15505     "title": "Add agents to a mail account",
15506     "examples": [
15507       {
15508         "title": "Example usage:",
15509         "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",
15510         "type": "json"
15511       }
15512     ],
15513     "name": "AddAgents",
15514     "group": "Mail_Accounts",
15515     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15516     "version": "0.0.0",
15517     "filename": "server/api/mailAccount/index.js",
15518     "groupTitle": "Mail_Accounts"
15519   },
15520   {
15521     "type": "post",
15522     "url": "/api/mail/accounts/{id}/in_servers",
15523     "title": "Creates a new IMAP server",
15524     "examples": [
15525       {
15526         "title": "Example usage:",
15527         "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",
15528         "type": "json"
15529       }
15530     ],
15531     "name": "AddImap",
15532     "group": "Mail_Accounts",
15533     "parameter": {
15534       "fields": {
15535         "Body": [
15536           {
15537             "group": "Body",
15538             "type": "String",
15539             "optional": true,
15540             "field": "description",
15541             "description": ""
15542           },
15543           {
15544             "group": "Body",
15545             "type": "String",
15546             "optional": true,
15547             "field": "host",
15548             "description": ""
15549           },
15550           {
15551             "group": "Body",
15552             "type": "Boolean",
15553             "optional": true,
15554             "field": "authentication",
15555             "description": ""
15556           },
15557           {
15558             "group": "Body",
15559             "type": "String",
15560             "optional": true,
15561             "field": "user",
15562             "description": ""
15563           },
15564           {
15565             "group": "Body",
15566             "type": "String",
15567             "optional": true,
15568             "field": "password",
15569             "description": ""
15570           },
15571           {
15572             "group": "Body",
15573             "type": "Integer",
15574             "optional": true,
15575             "field": "port",
15576             "description": ""
15577           },
15578           {
15579             "group": "Body",
15580             "type": "Boolean",
15581             "optional": true,
15582             "field": "tls",
15583             "description": ""
15584           },
15585           {
15586             "group": "Body",
15587             "type": "String",
15588             "optional": true,
15589             "field": "mailbox",
15590             "description": ""
15591           },
15592           {
15593             "group": "Body",
15594             "type": "Integer",
15595             "optional": true,
15596             "field": "connTimeout",
15597             "description": ""
15598           },
15599           {
15600             "group": "Body",
15601             "type": "Integer",
15602             "optional": true,
15603             "field": "authTimeout",
15604             "description": ""
15605           },
15606           {
15607             "group": "Body",
15608             "type": "String",
15609             "optional": true,
15610             "field": "service",
15611             "description": ""
15612           }
15613         ]
15614       }
15615     },
15616     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15617     "version": "0.0.0",
15618     "filename": "server/api/mailAccount/index.js",
15619     "groupTitle": "Mail_Accounts"
15620   },
15621   {
15622     "type": "post",
15623     "url": "/api/mail/accounts/{id}/out_servers",
15624     "title": "Creates a new SMTP server",
15625     "examples": [
15626       {
15627         "title": "Example usage:",
15628         "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",
15629         "type": "json"
15630       }
15631     ],
15632     "name": "AddSmtp",
15633     "group": "Mail_Accounts",
15634     "parameter": {
15635       "fields": {
15636         "Body": [
15637           {
15638             "group": "Body",
15639             "type": "String",
15640             "optional": true,
15641             "field": "description",
15642             "description": ""
15643           },
15644           {
15645             "group": "Body",
15646             "type": "String",
15647             "optional": true,
15648             "field": "host",
15649             "description": ""
15650           },
15651           {
15652             "group": "Body",
15653             "type": "String",
15654             "optional": true,
15655             "field": "user",
15656             "description": ""
15657           },
15658           {
15659             "group": "Body",
15660             "type": "String",
15661             "optional": true,
15662             "field": "pass",
15663             "description": ""
15664           },
15665           {
15666             "group": "Body",
15667             "type": "Integer",
15668             "optional": true,
15669             "field": "port",
15670             "description": ""
15671           },
15672           {
15673             "group": "Body",
15674             "type": "Boolean",
15675             "optional": true,
15676             "field": "secure",
15677             "description": ""
15678           },
15679           {
15680             "group": "Body",
15681             "type": "String",
15682             "optional": true,
15683             "field": "service",
15684             "description": ""
15685           },
15686           {
15687             "group": "Body",
15688             "type": "Boolean",
15689             "optional": true,
15690             "field": "authentication",
15691             "description": ""
15692           }
15693         ]
15694       }
15695     },
15696     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15697     "version": "0.0.0",
15698     "filename": "server/api/mailAccount/index.js",
15699     "groupTitle": "Mail_Accounts"
15700   },
15701   {
15702     "type": "delete",
15703     "url": "/api/mail/accounts/{id}",
15704     "title": "Deletes a mail account",
15705     "examples": [
15706       {
15707         "title": "Example usage:",
15708         "content": "curl https://{domain}/api/mail/accounts/{id} -v -u {name}:{password} -X DELETE",
15709         "type": "json"
15710       }
15711     ],
15712     "name": "DeleteMailAccounts",
15713     "group": "Mail_Accounts",
15714     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15715     "version": "0.0.0",
15716     "filename": "server/api/mailAccount/index.js",
15717     "groupTitle": "Mail_Accounts"
15718   },
15719   {
15720     "type": "get",
15721     "url": "/api/mail/accounts/describe",
15722     "title": "Gets table info about Accounts",
15723     "examples": [
15724       {
15725         "title": "Example usage:",
15726         "content": "curl https://{domain}/api/mail/accounts/describe -v -u {name}:{password}",
15727         "type": "json"
15728       }
15729     ],
15730     "name": "DescribeAccounts",
15731     "group": "Mail_Accounts",
15732     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15733     "version": "0.0.0",
15734     "filename": "server/api/mailAccount/index.js",
15735     "groupTitle": "Mail_Accounts"
15736   },
15737   {
15738     "type": "get",
15739     "url": "/api/mail/accounts",
15740     "title": "Gets a list of Accounts",
15741     "examples": [
15742       {
15743         "title": "Example usage:",
15744         "content": "curl https://{domain}/api/mail/accounts -v -u {name}:{password}",
15745         "type": "json"
15746       }
15747     ],
15748     "name": "GetAccounts",
15749     "group": "Mail_Accounts",
15750     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
15751     "version": "0.0.0",
15752     "filename": "server/api/mailAccount/index.js",
15753     "groupTitle": "Mail_Accounts"
15754   },
15755   {
15756     "type": "get",
15757     "url": "/api/mail/accounts/{id}/users",
15758     "title": "Gets agents from mail account",
15759     "examples": [
15760       {
15761         "title": "Example usage:",
15762         "content": "curl https://{domain}/api/mail/accounts/{id}/users -v -u {name}:{password} -X GET",
15763         "type": "json"
15764       }
15765     ],
15766     "name": "GetAgents",
15767     "group": "Mail_Accounts",
15768     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15769     "version": "0.0.0",
15770     "filename": "server/api/mailAccount/index.js",
15771     "groupTitle": "Mail_Accounts"
15772   },
15773   {
15774     "type": "get",
15775     "url": "/api/mail/accounts/{id}/in_servers",
15776     "title": "Gets account IMAP server",
15777     "examples": [
15778       {
15779         "title": "Example usage:",
15780         "content": "curl https://{domain}/api/mail/accounts/{id}/in_servers -v -u {name}:{password} -X GET",
15781         "type": "json"
15782       }
15783     ],
15784     "name": "GetImap",
15785     "group": "Mail_Accounts",
15786     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15787     "version": "0.0.0",
15788     "filename": "server/api/mailAccount/index.js",
15789     "groupTitle": "Mail_Accounts"
15790   },
15791   {
15792     "type": "get",
15793     "url": "/api/mail/accounts/{id}/out_servers",
15794     "title": "Gets account SMTP server",
15795     "examples": [
15796       {
15797         "title": "Example usage:",
15798         "content": "curl https://{domain}/api/mail/accounts/{id}/out_servers -v -u {name}:{password} -X GET",
15799         "type": "json"
15800       }
15801     ],
15802     "name": "GetSmtp",
15803     "group": "Mail_Accounts",
15804     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15805     "version": "0.0.0",
15806     "filename": "server/api/mailAccount/index.js",
15807     "groupTitle": "Mail_Accounts"
15808   },
15809   {
15810     "type": "delete",
15811     "url": "/api/mail/accounts/{id}/users",
15812     "title": "Removes agents from a mail account",
15813     "examples": [
15814       {
15815         "title": "Example usage:",
15816         "content": "curl https://{domain}/api/mail/accounts/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
15817         "type": "json"
15818       }
15819     ],
15820     "name": "RemoveAgents",
15821     "group": "Mail_Accounts",
15822     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15823     "version": "0.0.0",
15824     "filename": "server/api/mailAccount/index.js",
15825     "groupTitle": "Mail_Accounts"
15826   },
15827   {
15828     "type": "delete",
15829     "url": "/api/mail/accounts/{id}/canned_answers",
15830     "title": "Removes canned answers from account",
15831     "examples": [
15832       {
15833         "title": "Example usage:",
15834         "content": "curl https://{domain}/api/mail/accounts/{id}/canned_answers?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
15835         "type": "json"
15836       }
15837     ],
15838     "name": "RemoveAnswers",
15839     "group": "Mail_Accounts",
15840     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15841     "version": "0.0.0",
15842     "filename": "server/api/mailAccount/index.js",
15843     "groupTitle": "Mail_Accounts"
15844   },
15845   {
15846     "type": "delete",
15847     "url": "/api/mail/accounts/{id}/dispositions",
15848     "title": "Removes dispositions from account",
15849     "examples": [
15850       {
15851         "title": "Example usage:",
15852         "content": "curl https://{domain}/api/mail/accounts/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
15853         "type": "json"
15854       }
15855     ],
15856     "name": "RemoveDispositions",
15857     "group": "Mail_Accounts",
15858     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15859     "version": "0.0.0",
15860     "filename": "server/api/mailAccount/index.js",
15861     "groupTitle": "Mail_Accounts"
15862   },
15863   {
15864     "type": "delete",
15865     "url": "/api/mail/accounts/{id}/in_servers",
15866     "title": "Removes IMAP server from an account",
15867     "examples": [
15868       {
15869         "title": "Example usage:",
15870         "content": "curl https://{domain}/api/mail/accounts/{id}/in_servers -v -u {name}:{password} -X DELETE",
15871         "type": "json"
15872       }
15873     ],
15874     "name": "RemoveImmap",
15875     "group": "Mail_Accounts",
15876     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15877     "version": "0.0.0",
15878     "filename": "server/api/mailAccount/index.js",
15879     "groupTitle": "Mail_Accounts"
15880   },
15881   {
15882     "type": "delete",
15883     "url": "/api/mail/accounts/{id}/out_servers",
15884     "title": "Removes SMTP server from an account",
15885     "examples": [
15886       {
15887         "title": "Example usage:",
15888         "content": "curl https://{domain}/api/mail/accounts/{id}/out_servers -v -u {name}:{password} -X DELETE",
15889         "type": "json"
15890       }
15891     ],
15892     "name": "RemoveSmtp",
15893     "group": "Mail_Accounts",
15894     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15895     "version": "0.0.0",
15896     "filename": "server/api/mailAccount/index.js",
15897     "groupTitle": "Mail_Accounts"
15898   },
15899   {
15900     "type": "get",
15901     "url": "/api/mail/accounts/{id}",
15902     "title": "Gets a single Account",
15903     "examples": [
15904       {
15905         "title": "Example usage:",
15906         "content": "curl https://{domain}/api/mail/accounts/{id} -v -u {name}:{password}",
15907         "type": "json"
15908       }
15909     ],
15910     "name": "ShowAccounts",
15911     "group": "Mail_Accounts",
15912     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15913     "version": "0.0.0",
15914     "filename": "server/api/mailAccount/index.js",
15915     "groupTitle": "Mail_Accounts"
15916   },
15917   {
15918     "type": "post",
15919     "url": "/api/mail/accounts/{id}/canned_answers",
15920     "title": "Creates new canned answer",
15921     "examples": [
15922       {
15923         "title": "Example usage:",
15924         "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",
15925         "type": "json"
15926       }
15927     ],
15928     "name": "addAnswer",
15929     "group": "Mail_Accounts",
15930     "parameter": {
15931       "fields": {
15932         "Body": [
15933           {
15934             "group": "Body",
15935             "type": "String",
15936             "optional": false,
15937             "field": "key",
15938             "description": ""
15939           },
15940           {
15941             "group": "Body",
15942             "type": "Text",
15943             "optional": false,
15944             "field": "value",
15945             "description": ""
15946           },
15947           {
15948             "group": "Body",
15949             "type": "String",
15950             "optional": true,
15951             "field": "description",
15952             "description": ""
15953           },
15954           {
15955             "group": "Body",
15956             "type": "Virtual",
15957             "optional": true,
15958             "field": "name",
15959             "description": ""
15960           }
15961         ]
15962       }
15963     },
15964     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15965     "version": "0.0.0",
15966     "filename": "server/api/mailAccount/index.js",
15967     "groupTitle": "Mail_Accounts"
15968   },
15969   {
15970     "type": "post",
15971     "url": "/api/mail/accounts/{id}/applications",
15972     "title": "Creates new applications",
15973     "examples": [
15974       {
15975         "title": "Example usage:",
15976         "content": "curl https://{domain}/api/mail/accounts/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
15977         "type": "json"
15978       }
15979     ],
15980     "name": "addApplications",
15981     "group": "Mail_Accounts",
15982     "parameter": {
15983       "fields": {
15984         "Body": [
15985           {
15986             "group": "Body",
15987             "type": "Integer",
15988             "optional": false,
15989             "field": "priority",
15990             "description": ""
15991           },
15992           {
15993             "group": "Body",
15994             "type": "String",
15995             "optional": false,
15996             "field": "app",
15997             "description": ""
15998           },
15999           {
16000             "group": "Body",
16001             "type": "Text",
16002             "optional": true,
16003             "field": "appdata",
16004             "description": ""
16005           },
16006           {
16007             "group": "Body",
16008             "type": "String",
16009             "optional": true,
16010             "field": "description",
16011             "description": ""
16012           },
16013           {
16014             "group": "Body",
16015             "type": "String",
16016             "optional": true,
16017             "field": "interval",
16018             "description": ""
16019           }
16020         ]
16021       }
16022     },
16023     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16024     "version": "0.0.0",
16025     "filename": "server/api/mailAccount/index.js",
16026     "groupTitle": "Mail_Accounts"
16027   },
16028   {
16029     "type": "post",
16030     "url": "/api/mail/accounts/{id}/dispositions",
16031     "title": "Creates new disposition",
16032     "examples": [
16033       {
16034         "title": "Example usage:",
16035         "content": "curl https://{domain}/api/mail/accounts/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
16036         "type": "json"
16037       }
16038     ],
16039     "name": "addDisposition",
16040     "group": "Mail_Accounts",
16041     "parameter": {
16042       "fields": {
16043         "Body": [
16044           {
16045             "group": "Body",
16046             "type": "String",
16047             "optional": false,
16048             "field": "name",
16049             "description": ""
16050           },
16051           {
16052             "group": "Body",
16053             "type": "String",
16054             "allowedValues": [
16055               "\"first\"",
16056               "\"second\"",
16057               "\"third\""
16058             ],
16059             "optional": false,
16060             "field": "level",
16061             "description": ""
16062           },
16063           {
16064             "group": "Body",
16065             "type": "String",
16066             "optional": true,
16067             "field": "description",
16068             "description": ""
16069           }
16070         ]
16071       }
16072     },
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/mailAccount/index.js",
16076     "groupTitle": "Mail_Accounts"
16077   },
16078   {
16079     "type": "post",
16080     "url": "/api/mail/accounts/{id}/interactions",
16081     "title": "Creates new interactions",
16082     "examples": [
16083       {
16084         "title": "Example usage:",
16085         "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",
16086         "type": "json"
16087       }
16088     ],
16089     "name": "addInteraction",
16090     "group": "Mail_Accounts",
16091     "parameter": {
16092       "fields": {
16093         "Body": [
16094           {
16095             "group": "Body",
16096             "type": "Boolean",
16097             "optional": true,
16098             "field": "closed",
16099             "description": ""
16100           },
16101           {
16102             "group": "Body",
16103             "type": "String",
16104             "optional": true,
16105             "field": "closedAt",
16106             "description": ""
16107           },
16108           {
16109             "group": "Body",
16110             "type": "String",
16111             "optional": true,
16112             "field": "disposition",
16113             "description": ""
16114           },
16115           {
16116             "group": "Body",
16117             "type": "String",
16118             "optional": true,
16119             "field": "secondDisposition",
16120             "description": ""
16121           },
16122           {
16123             "group": "Body",
16124             "type": "String",
16125             "optional": true,
16126             "field": "thirdDisposition",
16127             "description": ""
16128           },
16129           {
16130             "group": "Body",
16131             "type": "String",
16132             "optional": true,
16133             "field": "note",
16134             "description": ""
16135           },
16136           {
16137             "group": "Body",
16138             "type": "String",
16139             "optional": true,
16140             "field": "inReplyTo",
16141             "description": ""
16142           },
16143           {
16144             "group": "Body",
16145             "type": "String",
16146             "optional": true,
16147             "field": "to",
16148             "description": ""
16149           },
16150           {
16151             "group": "Body",
16152             "type": "Text",
16153             "optional": true,
16154             "field": "cc",
16155             "description": ""
16156           },
16157           {
16158             "group": "Body",
16159             "type": "Text",
16160             "optional": true,
16161             "field": "subject",
16162             "description": ""
16163           },
16164           {
16165             "group": "Body",
16166             "type": "Boolean",
16167             "optional": true,
16168             "field": "attach",
16169             "description": ""
16170           },
16171           {
16172             "group": "Body",
16173             "type": "String",
16174             "optional": true,
16175             "field": "read1stAt",
16176             "description": ""
16177           },
16178           {
16179             "group": "Body",
16180             "type": "String",
16181             "optional": true,
16182             "field": "substatus",
16183             "description": ""
16184           },
16185           {
16186             "group": "Body",
16187             "type": "String",
16188             "optional": true,
16189             "field": "substatusAt",
16190             "description": ""
16191           },
16192           {
16193             "group": "Body",
16194             "type": "String",
16195             "allowedValues": [
16196               "\"in\"",
16197               "\"out\""
16198             ],
16199             "optional": false,
16200             "field": "firstMsgDirection",
16201             "description": ""
16202           },
16203           {
16204             "group": "Body",
16205             "type": "String",
16206             "optional": true,
16207             "field": "lastMsgAt",
16208             "description": ""
16209           },
16210           {
16211             "group": "Body",
16212             "type": "String",
16213             "allowedValues": [
16214               "\"in\"",
16215               "\"out\""
16216             ],
16217             "optional": false,
16218             "field": "lastMsgDirection",
16219             "description": ""
16220           },
16221           {
16222             "group": "Body",
16223             "type": "Boolean",
16224             "optional": true,
16225             "field": "autoreplyExecuted",
16226             "description": ""
16227           }
16228         ]
16229       }
16230     },
16231     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16232     "version": "0.0.0",
16233     "filename": "server/api/mailAccount/index.js",
16234     "groupTitle": "Mail_Accounts"
16235   },
16236   {
16237     "type": "post",
16238     "url": "/api/mail/accounts",
16239     "title": "Create a mail account",
16240     "examples": [
16241       {
16242         "title": "Example usage:",
16243         "content": "curl https://{domain}/api/mail/accounts \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
16244         "type": "json"
16245       }
16246     ],
16247     "name": "create",
16248     "group": "Mail_Accounts",
16249     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16250     "version": "0.0.0",
16251     "filename": "server/api/mailAccount/index.js",
16252     "groupTitle": "Mail_Accounts"
16253   },
16254   {
16255     "type": "get",
16256     "url": "/api/mail/accounts/{id}/canned_answers",
16257     "title": "Gets account canned answers",
16258     "examples": [
16259       {
16260         "title": "Example usage:",
16261         "content": "curl https://{domain}/api/mail/accounts/{id}/canned_answers -v -u {name}:{password} -X GET",
16262         "type": "json"
16263       }
16264     ],
16265     "name": "getAnswers",
16266     "group": "Mail_Accounts",
16267     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16268     "version": "0.0.0",
16269     "filename": "server/api/mailAccount/index.js",
16270     "groupTitle": "Mail_Accounts"
16271   },
16272   {
16273     "type": "get",
16274     "url": "/api/mail/accounts/{id}/applications",
16275     "title": "Gets account applications",
16276     "examples": [
16277       {
16278         "title": "Example usage:",
16279         "content": "curl https://{domain}/api/mail/accounts/{id}/applications -v -u {name}:{password} -X GET",
16280         "type": "json"
16281       }
16282     ],
16283     "name": "getApplications",
16284     "group": "Mail_Accounts",
16285     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16286     "version": "0.0.0",
16287     "filename": "server/api/mailAccount/index.js",
16288     "groupTitle": "Mail_Accounts"
16289   },
16290   {
16291     "type": "get",
16292     "url": "/api/mail/accounts/{id}/dispositions",
16293     "title": "Gets account dispositions",
16294     "examples": [
16295       {
16296         "title": "Example usage:",
16297         "content": "curl https://{domain}/api/mail/accounts/{id}/dispositions -v -u {name}:{password} -X GET",
16298         "type": "json"
16299       }
16300     ],
16301     "name": "getDispositions",
16302     "group": "Mail_Accounts",
16303     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16304     "version": "0.0.0",
16305     "filename": "server/api/mailAccount/index.js",
16306     "groupTitle": "Mail_Accounts"
16307   },
16308   {
16309     "type": "get",
16310     "url": "/api/mail/accounts/{id}/interactions",
16311     "title": "Gets account interactions",
16312     "examples": [
16313       {
16314         "title": "Example usage:",
16315         "content": "curl https://{domain}/api/mail/accounts/{id}/interactions -v -u {name}:{password} -X GET",
16316         "type": "json"
16317       }
16318     ],
16319     "name": "getInteraction",
16320     "group": "Mail_Accounts",
16321     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16322     "version": "0.0.0",
16323     "filename": "server/api/mailAccount/index.js",
16324     "groupTitle": "Mail_Accounts"
16325   },
16326   {
16327     "type": "get",
16328     "url": "/api/mail/accounts/{id}/messages",
16329     "title": "Gets account messages",
16330     "examples": [
16331       {
16332         "title": "Example usage:",
16333         "content": "curl https://{domain}/api/mail/accounts/{id}/messages -v -u {name}:{password} -X GET",
16334         "type": "json"
16335       }
16336     ],
16337     "name": "getMessages",
16338     "group": "Mail_Accounts",
16339     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16340     "version": "0.0.0",
16341     "filename": "server/api/mailAccount/index.js",
16342     "groupTitle": "Mail_Accounts"
16343   },
16344   {
16345     "type": "post",
16346     "url": "/api/mail/accounts/{id}/send",
16347     "title": "Send new mail",
16348     "examples": [
16349       {
16350         "title": "Example usage:",
16351         "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",
16352         "type": "json"
16353       }
16354     ],
16355     "name": "sendMail",
16356     "group": "Mail_Accounts",
16357     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16358     "version": "0.0.0",
16359     "filename": "server/api/mailAccount/index.js",
16360     "groupTitle": "Mail_Accounts"
16361   },
16362   {
16363     "type": "put",
16364     "url": "/api/mail/accounts/{id}",
16365     "title": "Update an existing Account",
16366     "examples": [
16367       {
16368         "title": "Example usage:",
16369         "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",
16370         "type": "json"
16371       }
16372     ],
16373     "name": "updateAccounts",
16374     "group": "Mail_Accounts",
16375     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16376     "version": "0.0.0",
16377     "filename": "server/api/mailAccount/index.js",
16378     "groupTitle": "Mail_Accounts"
16379   },
16380   {
16381     "type": "get",
16382     "url": "/api/mail/accounts/{id}/verify",
16383     "title": "Verify mail account",
16384     "examples": [
16385       {
16386         "title": "Example usage:",
16387         "content": "curl https://{domain}/api/mail/accounts/{id}/verify -v -u {name}:{password} -X GET",
16388         "type": "json"
16389       }
16390     ],
16391     "name": "verifySmtp",
16392     "group": "Mail_Accounts",
16393     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16394     "version": "0.0.0",
16395     "filename": "server/api/mailAccount/index.js",
16396     "groupTitle": "Mail_Accounts"
16397   },
16398   {
16399     "type": "delete",
16400     "url": "/api/mail/applications/{id}",
16401     "title": "Deletes a Application",
16402     "examples": [
16403       {
16404         "title": "Example usage:",
16405         "content": "curl https://{domain}/api/mail/applications/{id} -v -u {name}:{password} -X DELETE",
16406         "type": "json"
16407       }
16408     ],
16409     "name": "DeleteApplications",
16410     "group": "Mail_Applications",
16411     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16412     "version": "0.0.0",
16413     "filename": "server/api/mailApplication/index.js",
16414     "groupTitle": "Mail_Applications"
16415   },
16416   {
16417     "type": "get",
16418     "url": "/api/mail/applications/{id}",
16419     "title": "Gets a single Application",
16420     "examples": [
16421       {
16422         "title": "Example usage:",
16423         "content": "curl https://{domain}/api/mail/applications/{id} -v -u {name}:{password}",
16424         "type": "json"
16425       }
16426     ],
16427     "name": "ShowApplications",
16428     "group": "Mail_Applications",
16429     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16430     "version": "0.0.0",
16431     "filename": "server/api/mailApplication/index.js",
16432     "groupTitle": "Mail_Applications"
16433   },
16434   {
16435     "type": "put",
16436     "url": "/api/mail/applications/{id}",
16437     "title": "Update an existing Application",
16438     "examples": [
16439       {
16440         "title": "Example usage:",
16441         "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",
16442         "type": "json"
16443       }
16444     ],
16445     "name": "updateApplications",
16446     "group": "Mail_Applications",
16447     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16448     "version": "0.0.0",
16449     "filename": "server/api/mailApplication/index.js",
16450     "groupTitle": "Mail_Applications"
16451   },
16452   {
16453     "type": "post",
16454     "url": "/api/mail/interactions/{id}/tags",
16455     "title": "Add tags to the interaction",
16456     "examples": [
16457       {
16458         "title": "Example usage:",
16459         "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",
16460         "type": "json"
16461       }
16462     ],
16463     "name": "AddTags",
16464     "group": "Mail_Interactions",
16465     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16466     "version": "0.0.0",
16467     "filename": "server/api/mailInteraction/index.js",
16468     "groupTitle": "Mail_Interactions"
16469   },
16470   {
16471     "type": "post",
16472     "url": "/api/mail/interactions",
16473     "title": "Creates a new Interaction",
16474     "examples": [
16475       {
16476         "title": "Example usage:",
16477         "content": "curl https://{domain}/api/mail/interactions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
16478         "type": "json"
16479       }
16480     ],
16481     "name": "CreateInteractions",
16482     "group": "Mail_Interactions",
16483     "parameter": {
16484       "fields": {
16485         "Body": [
16486           {
16487             "group": "Body",
16488             "type": "Boolean",
16489             "optional": true,
16490             "field": "closed",
16491             "description": ""
16492           },
16493           {
16494             "group": "Body",
16495             "type": "String",
16496             "optional": true,
16497             "field": "closedAt",
16498             "description": ""
16499           },
16500           {
16501             "group": "Body",
16502             "type": "String",
16503             "optional": true,
16504             "field": "disposition",
16505             "description": ""
16506           },
16507           {
16508             "group": "Body",
16509             "type": "String",
16510             "optional": true,
16511             "field": "secondDisposition",
16512             "description": ""
16513           },
16514           {
16515             "group": "Body",
16516             "type": "String",
16517             "optional": true,
16518             "field": "thirdDisposition",
16519             "description": ""
16520           },
16521           {
16522             "group": "Body",
16523             "type": "String",
16524             "optional": true,
16525             "field": "note",
16526             "description": ""
16527           },
16528           {
16529             "group": "Body",
16530             "type": "String",
16531             "optional": true,
16532             "field": "inReplyTo",
16533             "description": ""
16534           },
16535           {
16536             "group": "Body",
16537             "type": "String",
16538             "optional": true,
16539             "field": "to",
16540             "description": ""
16541           },
16542           {
16543             "group": "Body",
16544             "type": "Text",
16545             "optional": true,
16546             "field": "cc",
16547             "description": ""
16548           },
16549           {
16550             "group": "Body",
16551             "type": "Text",
16552             "optional": true,
16553             "field": "subject",
16554             "description": ""
16555           },
16556           {
16557             "group": "Body",
16558             "type": "Boolean",
16559             "optional": true,
16560             "field": "attach",
16561             "description": ""
16562           },
16563           {
16564             "group": "Body",
16565             "type": "String",
16566             "optional": true,
16567             "field": "read1stAt",
16568             "description": ""
16569           },
16570           {
16571             "group": "Body",
16572             "type": "String",
16573             "optional": true,
16574             "field": "substatus",
16575             "description": ""
16576           },
16577           {
16578             "group": "Body",
16579             "type": "String",
16580             "optional": true,
16581             "field": "substatusAt",
16582             "description": ""
16583           },
16584           {
16585             "group": "Body",
16586             "type": "String",
16587             "allowedValues": [
16588               "\"in\"",
16589               "\"out\""
16590             ],
16591             "optional": false,
16592             "field": "firstMsgDirection",
16593             "description": ""
16594           },
16595           {
16596             "group": "Body",
16597             "type": "String",
16598             "optional": true,
16599             "field": "lastMsgAt",
16600             "description": ""
16601           },
16602           {
16603             "group": "Body",
16604             "type": "String",
16605             "allowedValues": [
16606               "\"in\"",
16607               "\"out\""
16608             ],
16609             "optional": false,
16610             "field": "lastMsgDirection",
16611             "description": ""
16612           },
16613           {
16614             "group": "Body",
16615             "type": "Boolean",
16616             "optional": true,
16617             "field": "autoreplyExecuted",
16618             "description": ""
16619           }
16620         ]
16621       }
16622     },
16623     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16624     "version": "0.0.0",
16625     "filename": "server/api/mailInteraction/index.js",
16626     "groupTitle": "Mail_Interactions"
16627   },
16628   {
16629     "type": "delete",
16630     "url": "/api/mail/interactions/{id}",
16631     "title": "Deletes a Interaction",
16632     "examples": [
16633       {
16634         "title": "Example usage:",
16635         "content": "curl https://{domain}/api/mail/interactions/{id} -v -u {name}:{password} -X DELETE",
16636         "type": "json"
16637       }
16638     ],
16639     "name": "DeleteInteractions",
16640     "group": "Mail_Interactions",
16641     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16642     "version": "0.0.0",
16643     "filename": "server/api/mailInteraction/index.js",
16644     "groupTitle": "Mail_Interactions"
16645   },
16646   {
16647     "type": "get",
16648     "url": "/api/mail/interactions/describe",
16649     "title": "Gets table info about Interactions",
16650     "examples": [
16651       {
16652         "title": "Example usage:",
16653         "content": "curl https://{domain}/api/mail/interactions/describe -v -u {name}:{password}",
16654         "type": "json"
16655       }
16656     ],
16657     "name": "DescribeInteractions",
16658     "group": "Mail_Interactions",
16659     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16660     "version": "0.0.0",
16661     "filename": "server/api/mailInteraction/index.js",
16662     "groupTitle": "Mail_Interactions"
16663   },
16664   {
16665     "type": "get",
16666     "url": "/api/mail/interactions",
16667     "title": "Gets a list of Interactions",
16668     "examples": [
16669       {
16670         "title": "Example usage:",
16671         "content": "curl https://{domain}/api/mail/interactions -v -u {name}:{password}",
16672         "type": "json"
16673       }
16674     ],
16675     "name": "GetInteractions",
16676     "group": "Mail_Interactions",
16677     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
16678     "version": "0.0.0",
16679     "filename": "server/api/mailInteraction/index.js",
16680     "groupTitle": "Mail_Interactions"
16681   },
16682   {
16683     "type": "delete",
16684     "url": "/api/mail/interactions/{id}/tags",
16685     "title": "Removes tags from interaction",
16686     "examples": [
16687       {
16688         "title": "Example usage:",
16689         "content": "curl https://{domain}/api/mail/interactions/{id}/tags?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
16690         "type": "json"
16691       }
16692     ],
16693     "name": "RemoveTags",
16694     "group": "Mail_Interactions",
16695     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16696     "version": "0.0.0",
16697     "filename": "server/api/mailInteraction/index.js",
16698     "groupTitle": "Mail_Interactions"
16699   },
16700   {
16701     "type": "get",
16702     "url": "/api/mail/interactions/{id}",
16703     "title": "Gets a single Interaction",
16704     "examples": [
16705       {
16706         "title": "Example usage:",
16707         "content": "curl https://{domain}/api/mail/interactions/{id} -v -u {name}:{password}",
16708         "type": "json"
16709       }
16710     ],
16711     "name": "ShowInteractions",
16712     "group": "Mail_Interactions",
16713     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16714     "version": "0.0.0",
16715     "filename": "server/api/mailInteraction/index.js",
16716     "groupTitle": "Mail_Interactions"
16717   },
16718   {
16719     "type": "post",
16720     "url": "/api/mail/interactions/{id}/messages",
16721     "title": "Creates new message",
16722     "examples": [
16723       {
16724         "title": "Example usage:",
16725         "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",
16726         "type": "json"
16727       }
16728     ],
16729     "name": "addMessage",
16730     "group": "Mail_Interactions",
16731     "parameter": {
16732       "fields": {
16733         "Body": [
16734           {
16735             "group": "Body",
16736             "type": "Text",
16737             "optional": false,
16738             "field": "body",
16739             "description": ""
16740           },
16741           {
16742             "group": "Body",
16743             "type": "Text",
16744             "optional": true,
16745             "field": "plainBody",
16746             "description": ""
16747           },
16748           {
16749             "group": "Body",
16750             "type": "Boolean",
16751             "optional": true,
16752             "field": "read",
16753             "description": ""
16754           },
16755           {
16756             "group": "Body",
16757             "type": "String",
16758             "allowedValues": [
16759               "\"in\"",
16760               "\"out\""
16761             ],
16762             "optional": false,
16763             "field": "direction",
16764             "description": ""
16765           },
16766           {
16767             "group": "Body",
16768             "type": "String",
16769             "optional": true,
16770             "field": "messageId",
16771             "description": ""
16772           },
16773           {
16774             "group": "Body",
16775             "type": "String",
16776             "optional": true,
16777             "field": "from",
16778             "description": ""
16779           },
16780           {
16781             "group": "Body",
16782             "type": "Text",
16783             "optional": true,
16784             "field": "to",
16785             "description": ""
16786           },
16787           {
16788             "group": "Body",
16789             "type": "Text",
16790             "optional": true,
16791             "field": "cc",
16792             "description": ""
16793           },
16794           {
16795             "group": "Body",
16796             "type": "Text",
16797             "optional": true,
16798             "field": "bcc",
16799             "description": ""
16800           },
16801           {
16802             "group": "Body",
16803             "type": "Text",
16804             "optional": true,
16805             "field": "subject",
16806             "description": ""
16807           },
16808           {
16809             "group": "Body",
16810             "type": "String",
16811             "optional": true,
16812             "field": "sentAt",
16813             "description": ""
16814           },
16815           {
16816             "group": "Body",
16817             "type": "Integer",
16818             "optional": true,
16819             "field": "attach",
16820             "description": ""
16821           },
16822           {
16823             "group": "Body",
16824             "type": "Boolean",
16825             "optional": true,
16826             "field": "secret",
16827             "description": ""
16828           },
16829           {
16830             "group": "Body",
16831             "type": "String",
16832             "optional": true,
16833             "field": "readAt",
16834             "description": ""
16835           },
16836           {
16837             "group": "Body",
16838             "type": "Text",
16839             "optional": true,
16840             "field": "originTo",
16841             "description": ""
16842           },
16843           {
16844             "group": "Body",
16845             "type": "Text",
16846             "optional": true,
16847             "field": "originCc",
16848             "description": ""
16849           },
16850           {
16851             "group": "Body",
16852             "type": "String",
16853             "allowedValues": [
16854               "\"Email\"",
16855               "\"Chat\""
16856             ],
16857             "optional": false,
16858             "field": "originChannel",
16859             "description": ""
16860           }
16861         ]
16862       }
16863     },
16864     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16865     "version": "0.0.0",
16866     "filename": "server/api/mailInteraction/index.js",
16867     "groupTitle": "Mail_Interactions"
16868   },
16869   {
16870     "type": "get",
16871     "url": "/api/mail/interactions/{id}/download",
16872     "title": "Gets interaction",
16873     "examples": [
16874       {
16875         "title": "Example usage:",
16876         "content": "curl https://{domain}/api/mail/interactions/{id}/download -v -u {name}:{password} -X GET",
16877         "type": "json"
16878       }
16879     ],
16880     "name": "download",
16881     "group": "Mail_Interactions",
16882     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16883     "version": "0.0.0",
16884     "filename": "server/api/mailInteraction/index.js",
16885     "groupTitle": "Mail_Interactions"
16886   },
16887   {
16888     "type": "get",
16889     "url": "/api/mail/interactions/{id}/messages",
16890     "title": "Gets interaction messages",
16891     "examples": [
16892       {
16893         "title": "Example usage:",
16894         "content": "curl https://{domain}/api/mail/interactions/{id}/messages -v -u {name}:{password} -X GET",
16895         "type": "json"
16896       }
16897     ],
16898     "name": "getMessages",
16899     "group": "Mail_Interactions",
16900     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16901     "version": "0.0.0",
16902     "filename": "server/api/mailInteraction/index.js",
16903     "groupTitle": "Mail_Interactions"
16904   },
16905   {
16906     "type": "put",
16907     "url": "/api/mail/interactions/{id}",
16908     "title": "Update an existing Interaction",
16909     "examples": [
16910       {
16911         "title": "Example usage:",
16912         "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",
16913         "type": "json"
16914       }
16915     ],
16916     "name": "updateInteractions",
16917     "group": "Mail_Interactions",
16918     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16919     "version": "0.0.0",
16920     "filename": "server/api/mailInteraction/index.js",
16921     "groupTitle": "Mail_Interactions"
16922   },
16923   {
16924     "type": "delete",
16925     "url": "/api/mail/messages/{id}",
16926     "title": "Deletes a Message",
16927     "examples": [
16928       {
16929         "title": "Example usage:",
16930         "content": "curl https://{domain}/api/mail/messages/{id} -v -u {name}:{password} -X DELETE",
16931         "type": "json"
16932       }
16933     ],
16934     "name": "DeleteMessages",
16935     "group": "Mail_Messages",
16936     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16937     "version": "0.0.0",
16938     "filename": "server/api/mailMessage/index.js",
16939     "groupTitle": "Mail_Messages"
16940   },
16941   {
16942     "type": "get",
16943     "url": "/api/mail/messages/describe",
16944     "title": "Gets table info about Messages",
16945     "examples": [
16946       {
16947         "title": "Example usage:",
16948         "content": "curl https://{domain}/api/mail/messages/describe -v -u {name}:{password}",
16949         "type": "json"
16950       }
16951     ],
16952     "name": "DescribeMessages",
16953     "group": "Mail_Messages",
16954     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16955     "version": "0.0.0",
16956     "filename": "server/api/mailMessage/index.js",
16957     "groupTitle": "Mail_Messages"
16958   },
16959   {
16960     "type": "get",
16961     "url": "/api/mail/messages",
16962     "title": "Gets a list of Messages",
16963     "examples": [
16964       {
16965         "title": "Example usage:",
16966         "content": "curl https://{domain}/api/mail/messages -v -u {name}:{password}",
16967         "type": "json"
16968       }
16969     ],
16970     "name": "GetMessages",
16971     "group": "Mail_Messages",
16972     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
16973     "version": "0.0.0",
16974     "filename": "server/api/mailMessage/index.js",
16975     "groupTitle": "Mail_Messages"
16976   },
16977   {
16978     "type": "get",
16979     "url": "/api/mail/messages/{id}",
16980     "title": "Gets a single Message",
16981     "examples": [
16982       {
16983         "title": "Example usage:",
16984         "content": "curl https://{domain}/api/mail/messages/{id} -v -u {name}:{password}",
16985         "type": "json"
16986       }
16987     ],
16988     "name": "ShowMessages",
16989     "group": "Mail_Messages",
16990     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16991     "version": "0.0.0",
16992     "filename": "server/api/mailMessage/index.js",
16993     "groupTitle": "Mail_Messages"
16994   },
16995   {
16996     "type": "put",
16997     "url": "/api/mail/messages/{id}/accept",
16998     "title": "Accepts message",
16999     "examples": [
17000       {
17001         "title": "Example usage:",
17002         "content": "curl https://{domain}/api/mail/messages/{id}/accept \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
17003         "type": "json"
17004       }
17005     ],
17006     "name": "acceptMessage",
17007     "group": "Mail_Messages",
17008     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17009     "version": "0.0.0",
17010     "filename": "server/api/mailMessage/index.js",
17011     "groupTitle": "Mail_Messages"
17012   },
17013   {
17014     "type": "post",
17015     "url": "/api/mail/messages",
17016     "title": "Create a message",
17017     "examples": [
17018       {
17019         "title": "Example usage:",
17020         "content": "curl https://{domain}/api/mail/messages \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
17021         "type": "json"
17022       }
17023     ],
17024     "name": "createMessage",
17025     "group": "Mail_Messages",
17026     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17027     "version": "0.0.0",
17028     "filename": "server/api/mailMessage/index.js",
17029     "groupTitle": "Mail_Messages"
17030   },
17031   {
17032     "type": "get",
17033     "url": "/api/mail/messages/{id}/download",
17034     "title": "Gets message",
17035     "examples": [
17036       {
17037         "title": "Example usage:",
17038         "content": "curl https://{domain}/api/mail/messages/{id}/download -v -u {name}:{password} -X GET",
17039         "type": "json"
17040       }
17041     ],
17042     "name": "download",
17043     "group": "Mail_Messages",
17044     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17045     "version": "0.0.0",
17046     "filename": "server/api/mailMessage/index.js",
17047     "groupTitle": "Mail_Messages"
17048   },
17049   {
17050     "type": "put",
17051     "url": "/api/mail/messages/{id}/reject",
17052     "title": "Rejects message",
17053     "examples": [
17054       {
17055         "title": "Example usage:",
17056         "content": "curl https://{domain}/api/mail/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
17057         "type": "json"
17058       }
17059     ],
17060     "name": "rejectMessage",
17061     "group": "Mail_Messages",
17062     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17063     "version": "0.0.0",
17064     "filename": "server/api/mailMessage/index.js",
17065     "groupTitle": "Mail_Messages"
17066   },
17067   {
17068     "type": "put",
17069     "url": "/api/mail/messages/{id}",
17070     "title": "Update an existing Message",
17071     "examples": [
17072       {
17073         "title": "Example usage:",
17074         "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",
17075         "type": "json"
17076       }
17077     ],
17078     "name": "updateMessages",
17079     "group": "Mail_Messages",
17080     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17081     "version": "0.0.0",
17082     "filename": "server/api/mailMessage/index.js",
17083     "groupTitle": "Mail_Messages"
17084   },
17085   {
17086     "type": "post",
17087     "url": "/api/mail/reports/queue",
17088     "title": "Creates a new Mail Queue Report",
17089     "examples": [
17090       {
17091         "title": "Example usage:",
17092         "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",
17093         "type": "json"
17094       }
17095     ],
17096     "name": "CreateMail_Queue_Reports",
17097     "group": "Mail_Queue_Reports",
17098     "parameter": {
17099       "fields": {
17100         "Body": [
17101           {
17102             "group": "Body",
17103             "type": "String",
17104             "optional": false,
17105             "field": "uniqueid",
17106             "description": ""
17107           },
17108           {
17109             "group": "Body",
17110             "type": "String",
17111             "optional": true,
17112             "field": "from",
17113             "description": ""
17114           },
17115           {
17116             "group": "Body",
17117             "type": "String",
17118             "optional": true,
17119             "field": "joinAt",
17120             "description": ""
17121           },
17122           {
17123             "group": "Body",
17124             "type": "String",
17125             "optional": true,
17126             "field": "leaveAt",
17127             "description": ""
17128           },
17129           {
17130             "group": "Body",
17131             "type": "String",
17132             "optional": true,
17133             "field": "acceptAt",
17134             "description": ""
17135           },
17136           {
17137             "group": "Body",
17138             "type": "String",
17139             "optional": true,
17140             "field": "exitAt",
17141             "description": ""
17142           },
17143           {
17144             "group": "Body",
17145             "type": "String",
17146             "optional": true,
17147             "field": "reason",
17148             "description": ""
17149           }
17150         ]
17151       }
17152     },
17153     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17154     "version": "0.0.0",
17155     "filename": "server/api/mailQueueReport/index.js",
17156     "groupTitle": "Mail_Queue_Reports"
17157   },
17158   {
17159     "type": "delete",
17160     "url": "/api/mail/reports/queue/{id}",
17161     "title": "Deletes a Mail Queue Report",
17162     "examples": [
17163       {
17164         "title": "Example usage:",
17165         "content": "curl https://{domain}/api/mail/reports/queue/{id} -v -u {name}:{password} -X DELETE",
17166         "type": "json"
17167       }
17168     ],
17169     "name": "DeleteMail_Queue_Reports",
17170     "group": "Mail_Queue_Reports",
17171     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17172     "version": "0.0.0",
17173     "filename": "server/api/mailQueueReport/index.js",
17174     "groupTitle": "Mail_Queue_Reports"
17175   },
17176   {
17177     "type": "get",
17178     "url": "/api/mail/reports/queue/describe",
17179     "title": "Gets table info about Mail Queue Reports",
17180     "examples": [
17181       {
17182         "title": "Example usage:",
17183         "content": "curl https://{domain}/api/mail/reports/queue/describe -v -u {name}:{password}",
17184         "type": "json"
17185       }
17186     ],
17187     "name": "DescribeMail_Queue_Reports",
17188     "group": "Mail_Queue_Reports",
17189     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17190     "version": "0.0.0",
17191     "filename": "server/api/mailQueueReport/index.js",
17192     "groupTitle": "Mail_Queue_Reports"
17193   },
17194   {
17195     "type": "get",
17196     "url": "/api/mail/reports/queue",
17197     "title": "Gets a list of Mail Queue Reports",
17198     "examples": [
17199       {
17200         "title": "Example usage:",
17201         "content": "curl https://{domain}/api/mail/reports/queue -v -u {name}:{password}",
17202         "type": "json"
17203       }
17204     ],
17205     "name": "GetMail_Queue_Reports",
17206     "group": "Mail_Queue_Reports",
17207     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
17208     "version": "0.0.0",
17209     "filename": "server/api/mailQueueReport/index.js",
17210     "groupTitle": "Mail_Queue_Reports"
17211   },
17212   {
17213     "type": "get",
17214     "url": "/api/mail/reports/queue/{id}",
17215     "title": "Gets a single Mail Queue Report",
17216     "examples": [
17217       {
17218         "title": "Example usage:",
17219         "content": "curl https://{domain}/api/mail/reports/queue/{id} -v -u {name}:{password}",
17220         "type": "json"
17221       }
17222     ],
17223     "name": "ShowMail_Queue_Reports",
17224     "group": "Mail_Queue_Reports",
17225     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17226     "version": "0.0.0",
17227     "filename": "server/api/mailQueueReport/index.js",
17228     "groupTitle": "Mail_Queue_Reports"
17229   },
17230   {
17231     "type": "put",
17232     "url": "/api/mail/reports/queue/{id}",
17233     "title": "Update an existing Mail Queue Report",
17234     "examples": [
17235       {
17236         "title": "Example usage:",
17237         "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",
17238         "type": "json"
17239       }
17240     ],
17241     "name": "updateMail_Queue_Reports",
17242     "group": "Mail_Queue_Reports",
17243     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17244     "version": "0.0.0",
17245     "filename": "server/api/mailQueueReport/index.js",
17246     "groupTitle": "Mail_Queue_Reports"
17247   },
17248   {
17249     "type": "post",
17250     "url": "/api/mail/queues/{id}/users",
17251     "title": "Add agents to a queue",
17252     "examples": [
17253       {
17254         "title": "Example usage:",
17255         "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",
17256         "type": "json"
17257       }
17258     ],
17259     "name": "AddAgents",
17260     "group": "Mail_Queues",
17261     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17262     "version": "0.0.0",
17263     "filename": "server/api/mailQueue/index.js",
17264     "groupTitle": "Mail_Queues"
17265   },
17266   {
17267     "type": "post",
17268     "url": "/api/mail/queues/{id}/teams",
17269     "title": "Add teams to a queue",
17270     "examples": [
17271       {
17272         "title": "Example usage:",
17273         "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",
17274         "type": "json"
17275       }
17276     ],
17277     "name": "AddTeams",
17278     "group": "Mail_Queues",
17279     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17280     "version": "0.0.0",
17281     "filename": "server/api/mailQueue/index.js",
17282     "groupTitle": "Mail_Queues"
17283   },
17284   {
17285     "type": "post",
17286     "url": "/api/mail/queues",
17287     "title": "Creates a new Queue",
17288     "examples": [
17289       {
17290         "title": "Example usage:",
17291         "content": "curl https://{domain}/api/mail/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
17292         "type": "json"
17293       }
17294     ],
17295     "name": "CreateQueues",
17296     "group": "Mail_Queues",
17297     "parameter": {
17298       "fields": {
17299         "Body": [
17300           {
17301             "group": "Body",
17302             "type": "String",
17303             "optional": true,
17304             "field": "name",
17305             "description": ""
17306           },
17307           {
17308             "group": "Body",
17309             "type": "String",
17310             "optional": true,
17311             "field": "description",
17312             "description": ""
17313           },
17314           {
17315             "group": "Body",
17316             "type": "Integer",
17317             "optional": true,
17318             "field": "timeout",
17319             "description": ""
17320           },
17321           {
17322             "group": "Body",
17323             "type": "String",
17324             "allowedValues": [
17325               "\"rrmemory\"",
17326               "\"beepall\"",
17327               "\"roundrobin\""
17328             ],
17329             "optional": true,
17330             "field": "strategy",
17331             "description": ""
17332           }
17333         ]
17334       }
17335     },
17336     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17337     "version": "0.0.0",
17338     "filename": "server/api/mailQueue/index.js",
17339     "groupTitle": "Mail_Queues"
17340   },
17341   {
17342     "type": "delete",
17343     "url": "/api/mail/queues/{id}",
17344     "title": "Deletes a Queue",
17345     "examples": [
17346       {
17347         "title": "Example usage:",
17348         "content": "curl https://{domain}/api/mail/queues/{id} -v -u {name}:{password} -X DELETE",
17349         "type": "json"
17350       }
17351     ],
17352     "name": "DeleteQueues",
17353     "group": "Mail_Queues",
17354     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17355     "version": "0.0.0",
17356     "filename": "server/api/mailQueue/index.js",
17357     "groupTitle": "Mail_Queues"
17358   },
17359   {
17360     "type": "get",
17361     "url": "/api/mail/queues/describe",
17362     "title": "Gets table info about Queues",
17363     "examples": [
17364       {
17365         "title": "Example usage:",
17366         "content": "curl https://{domain}/api/mail/queues/describe -v -u {name}:{password}",
17367         "type": "json"
17368       }
17369     ],
17370     "name": "DescribeQueues",
17371     "group": "Mail_Queues",
17372     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17373     "version": "0.0.0",
17374     "filename": "server/api/mailQueue/index.js",
17375     "groupTitle": "Mail_Queues"
17376   },
17377   {
17378     "type": "get",
17379     "url": "/api/mail/queues/{id}/users",
17380     "title": "Gets queue agents",
17381     "examples": [
17382       {
17383         "title": "Example usage:",
17384         "content": "curl https://{domain}/api/mail/queues/{id}/users -v -u {name}:{password} -X POST",
17385         "type": "json"
17386       }
17387     ],
17388     "name": "GetAgents",
17389     "group": "Mail_Queues",
17390     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17391     "version": "0.0.0",
17392     "filename": "server/api/mailQueue/index.js",
17393     "groupTitle": "Mail_Queues"
17394   },
17395   {
17396     "type": "get",
17397     "url": "/api/mail/queues/{id}/members",
17398     "title": "GetMembers",
17399     "examples": [
17400       {
17401         "title": "Example usage:",
17402         "content": "curl https://{domain}/api/mail/queues/{id}/members  -v -u {name}:{password}",
17403         "type": "json"
17404       }
17405     ],
17406     "name": "GetMembers",
17407     "group": "Mail_Queues",
17408     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17409     "version": "0.0.0",
17410     "filename": "server/api/mailQueue/index.js",
17411     "groupTitle": "Mail_Queues"
17412   },
17413   {
17414     "type": "get",
17415     "url": "/api/mail/queues",
17416     "title": "Gets a list of Queues",
17417     "examples": [
17418       {
17419         "title": "Example usage:",
17420         "content": "curl https://{domain}/api/mail/queues -v -u {name}:{password}",
17421         "type": "json"
17422       }
17423     ],
17424     "name": "GetQueues",
17425     "group": "Mail_Queues",
17426     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
17427     "version": "0.0.0",
17428     "filename": "server/api/mailQueue/index.js",
17429     "groupTitle": "Mail_Queues"
17430   },
17431   {
17432     "type": "get",
17433     "url": "/api/mail/queues/{id}/teams",
17434     "title": "Gets queues list",
17435     "examples": [
17436       {
17437         "title": "Example usage:",
17438         "content": "curl https://{domain}/api/mail/queues/{id}/teams -v -u {name}:{password}",
17439         "type": "json"
17440       }
17441     ],
17442     "name": "GetTeams",
17443     "group": "Mail_Queues",
17444     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17445     "version": "0.0.0",
17446     "filename": "server/api/mailQueue/index.js",
17447     "groupTitle": "Mail_Queues"
17448   },
17449   {
17450     "type": "delete",
17451     "url": "/api/mail/queues/{id}/users",
17452     "title": "Removes agents from a queue",
17453     "examples": [
17454       {
17455         "title": "Example usage:",
17456         "content": "curl https://{domain}/api/mail/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
17457         "type": "json"
17458       }
17459     ],
17460     "name": "RemoveAgents",
17461     "group": "Mail_Queues",
17462     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17463     "version": "0.0.0",
17464     "filename": "server/api/mailQueue/index.js",
17465     "groupTitle": "Mail_Queues"
17466   },
17467   {
17468     "type": "get",
17469     "url": "/api/mail/queues/{id}",
17470     "title": "Gets a single Queue",
17471     "examples": [
17472       {
17473         "title": "Example usage:",
17474         "content": "curl https://{domain}/api/mail/queues/{id} -v -u {name}:{password}",
17475         "type": "json"
17476       }
17477     ],
17478     "name": "ShowQueues",
17479     "group": "Mail_Queues",
17480     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17481     "version": "0.0.0",
17482     "filename": "server/api/mailQueue/index.js",
17483     "groupTitle": "Mail_Queues"
17484   },
17485   {
17486     "type": "put",
17487     "url": "/api/mail/queues/{id}",
17488     "title": "Update an existing Queue",
17489     "examples": [
17490       {
17491         "title": "Example usage:",
17492         "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",
17493         "type": "json"
17494       }
17495     ],
17496     "name": "updateQueues",
17497     "group": "Mail_Queues",
17498     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17499     "version": "0.0.0",
17500     "filename": "server/api/mailQueue/index.js",
17501     "groupTitle": "Mail_Queues"
17502   },
17503   {
17504     "type": "post",
17505     "url": "/api/mail/out_servers",
17506     "title": "Creates a new SMTP",
17507     "examples": [
17508       {
17509         "title": "Example usage:",
17510         "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",
17511         "type": "json"
17512       }
17513     ],
17514     "name": "CreateSMTPs",
17515     "group": "Mail_SMTP",
17516     "parameter": {
17517       "fields": {
17518         "Body": [
17519           {
17520             "group": "Body",
17521             "type": "String",
17522             "optional": true,
17523             "field": "description",
17524             "description": ""
17525           },
17526           {
17527             "group": "Body",
17528             "type": "String",
17529             "optional": true,
17530             "field": "host",
17531             "description": ""
17532           },
17533           {
17534             "group": "Body",
17535             "type": "String",
17536             "optional": true,
17537             "field": "user",
17538             "description": ""
17539           },
17540           {
17541             "group": "Body",
17542             "type": "String",
17543             "optional": true,
17544             "field": "pass",
17545             "description": ""
17546           },
17547           {
17548             "group": "Body",
17549             "type": "Integer",
17550             "optional": true,
17551             "field": "port",
17552             "description": ""
17553           },
17554           {
17555             "group": "Body",
17556             "type": "Boolean",
17557             "optional": true,
17558             "field": "secure",
17559             "description": ""
17560           },
17561           {
17562             "group": "Body",
17563             "type": "String",
17564             "optional": true,
17565             "field": "service",
17566             "description": ""
17567           },
17568           {
17569             "group": "Body",
17570             "type": "Boolean",
17571             "optional": true,
17572             "field": "authentication",
17573             "description": ""
17574           }
17575         ]
17576       }
17577     },
17578     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17579     "version": "0.0.0",
17580     "filename": "server/api/mailServerOut/index.js",
17581     "groupTitle": "Mail_SMTP"
17582   },
17583   {
17584     "type": "delete",
17585     "url": "/api/mail/out_servers/{id}",
17586     "title": "Deletes a SMTP",
17587     "examples": [
17588       {
17589         "title": "Example usage:",
17590         "content": "curl https://{domain}/api/mail/out_servers/{id} -v -u {name}:{password} -X DELETE",
17591         "type": "json"
17592       }
17593     ],
17594     "name": "DeleteSMTPs",
17595     "group": "Mail_SMTP",
17596     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17597     "version": "0.0.0",
17598     "filename": "server/api/mailServerOut/index.js",
17599     "groupTitle": "Mail_SMTP"
17600   },
17601   {
17602     "type": "get",
17603     "url": "/api/mail/out_servers",
17604     "title": "Gets a list of SMTPs",
17605     "examples": [
17606       {
17607         "title": "Example usage:",
17608         "content": "curl https://{domain}/api/mail/out_servers -v -u {name}:{password}",
17609         "type": "json"
17610       }
17611     ],
17612     "name": "GetSMTPs",
17613     "group": "Mail_SMTP",
17614     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
17615     "version": "0.0.0",
17616     "filename": "server/api/mailServerOut/index.js",
17617     "groupTitle": "Mail_SMTP"
17618   },
17619   {
17620     "type": "get",
17621     "url": "/api/mail/out_servers/{id}",
17622     "title": "Gets a single SMTP",
17623     "examples": [
17624       {
17625         "title": "Example usage:",
17626         "content": "curl https://{domain}/api/mail/out_servers/{id} -v -u {name}:{password}",
17627         "type": "json"
17628       }
17629     ],
17630     "name": "ShowSMTPs",
17631     "group": "Mail_SMTP",
17632     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17633     "version": "0.0.0",
17634     "filename": "server/api/mailServerOut/index.js",
17635     "groupTitle": "Mail_SMTP"
17636   },
17637   {
17638     "type": "put",
17639     "url": "/api/mail/out_servers/{id}",
17640     "title": "Update an existing SMTP",
17641     "examples": [
17642       {
17643         "title": "Example usage:",
17644         "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",
17645         "type": "json"
17646       }
17647     ],
17648     "name": "updateSMTPs",
17649     "group": "Mail_SMTP",
17650     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17651     "version": "0.0.0",
17652     "filename": "server/api/mailServerOut/index.js",
17653     "groupTitle": "Mail_SMTP"
17654   },
17655   {
17656     "type": "post",
17657     "url": "/api/mail/substatuses",
17658     "title": "Creates a new Queue",
17659     "examples": [
17660       {
17661         "title": "Example usage:",
17662         "content": "curl https://{domain}/api/mail/substatuses -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
17663         "type": "json"
17664       }
17665     ],
17666     "name": "CreateSubstatuses",
17667     "group": "Mail_Substatuses",
17668     "parameter": {
17669       "fields": {
17670         "Body": [
17671           {
17672             "group": "Body",
17673             "type": "String",
17674             "optional": false,
17675             "field": "name",
17676             "description": ""
17677           },
17678           {
17679             "group": "Body",
17680             "type": "String",
17681             "optional": true,
17682             "field": "description",
17683             "description": ""
17684           }
17685         ]
17686       }
17687     },
17688     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17689     "version": "0.0.0",
17690     "filename": "server/api/mailSubstatus/index.js",
17691     "groupTitle": "Mail_Substatuses"
17692   },
17693   {
17694     "type": "delete",
17695     "url": "/api/mail/substatuses/{id}",
17696     "title": "Deletes a Queue",
17697     "examples": [
17698       {
17699         "title": "Example usage:",
17700         "content": "curl https://{domain}/api/mail/substatuses/{id} -v -u {name}:{password} -X DELETE",
17701         "type": "json"
17702       }
17703     ],
17704     "name": "DeleteSubstatuses",
17705     "group": "Mail_Substatuses",
17706     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17707     "version": "0.0.0",
17708     "filename": "server/api/mailSubstatus/index.js",
17709     "groupTitle": "Mail_Substatuses"
17710   },
17711   {
17712     "type": "get",
17713     "url": "/api/mail/substatuses/describe",
17714     "title": "Gets table info about Substatuses",
17715     "examples": [
17716       {
17717         "title": "Example usage:",
17718         "content": "curl https://{domain}/api/mail/substatuses/describe -v -u {name}:{password}",
17719         "type": "json"
17720       }
17721     ],
17722     "name": "DescribeSubstatuses",
17723     "group": "Mail_Substatuses",
17724     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17725     "version": "0.0.0",
17726     "filename": "server/api/mailSubstatus/index.js",
17727     "groupTitle": "Mail_Substatuses"
17728   },
17729   {
17730     "type": "get",
17731     "url": "/api/mail/substatuses",
17732     "title": "Gets a list of Substatuses",
17733     "examples": [
17734       {
17735         "title": "Example usage:",
17736         "content": "curl https://{domain}/api/mail/substatuses -v -u {name}:{password}",
17737         "type": "json"
17738       }
17739     ],
17740     "name": "GetSubstatuses",
17741     "group": "Mail_Substatuses",
17742     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
17743     "version": "0.0.0",
17744     "filename": "server/api/mailSubstatus/index.js",
17745     "groupTitle": "Mail_Substatuses"
17746   },
17747   {
17748     "type": "get",
17749     "url": "/api/mail/substatuses/{id}",
17750     "title": "Gets a single Queue",
17751     "examples": [
17752       {
17753         "title": "Example usage:",
17754         "content": "curl https://{domain}/api/mail/substatuses/{id} -v -u {name}:{password}",
17755         "type": "json"
17756       }
17757     ],
17758     "name": "ShowSubstatuses",
17759     "group": "Mail_Substatuses",
17760     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17761     "version": "0.0.0",
17762     "filename": "server/api/mailSubstatus/index.js",
17763     "groupTitle": "Mail_Substatuses"
17764   },
17765   {
17766     "type": "put",
17767     "url": "/api/mail/substatuses/{id}",
17768     "title": "Update an existing Queue",
17769     "examples": [
17770       {
17771         "title": "Example usage:",
17772         "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",
17773         "type": "json"
17774       }
17775     ],
17776     "name": "updateSubstatuses",
17777     "group": "Mail_Substatuses",
17778     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17779     "version": "0.0.0",
17780     "filename": "server/api/mailSubstatus/index.js",
17781     "groupTitle": "Mail_Substatuses"
17782   },
17783   {
17784     "type": "post",
17785     "url": "/api/mail/reports/transfer",
17786     "title": "Creates a new Mail Transfer Report",
17787     "examples": [
17788       {
17789         "title": "Example usage:",
17790         "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",
17791         "type": "json"
17792       }
17793     ],
17794     "name": "CreateMail_Transfer_Reports",
17795     "group": "Mail_Transfer_Reports",
17796     "parameter": {
17797       "fields": {
17798         "Body": [
17799           {
17800             "group": "Body",
17801             "type": "String",
17802             "optional": false,
17803             "field": "uniqueid",
17804             "description": ""
17805           },
17806           {
17807             "group": "Body",
17808             "type": "String",
17809             "allowedValues": [
17810               "\"account\"",
17811               "\"agent\"",
17812               "\"queue\""
17813             ],
17814             "optional": false,
17815             "field": "type",
17816             "description": ""
17817           },
17818           {
17819             "group": "Body",
17820             "type": "String",
17821             "optional": false,
17822             "field": "transferredAt",
17823             "description": ""
17824           }
17825         ]
17826       }
17827     },
17828     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17829     "version": "0.0.0",
17830     "filename": "server/api/mailTransferReport/index.js",
17831     "groupTitle": "Mail_Transfer_Reports"
17832   },
17833   {
17834     "type": "delete",
17835     "url": "/api/mail/reports/transfer/{id}",
17836     "title": "Deletes a Mail Transfer Report",
17837     "examples": [
17838       {
17839         "title": "Example usage:",
17840         "content": "curl https://{domain}/api/mail/reports/transfer/{id} -v -u {name}:{password} -X DELETE",
17841         "type": "json"
17842       }
17843     ],
17844     "name": "DeleteMail_Transfer_Reports",
17845     "group": "Mail_Transfer_Reports",
17846     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17847     "version": "0.0.0",
17848     "filename": "server/api/mailTransferReport/index.js",
17849     "groupTitle": "Mail_Transfer_Reports"
17850   },
17851   {
17852     "type": "get",
17853     "url": "/api/mail/reports/transfer/describe",
17854     "title": "Gets table info about Mail Transfer Reports",
17855     "examples": [
17856       {
17857         "title": "Example usage:",
17858         "content": "curl https://{domain}/api/mail/reports/transfer/describe -v -u {name}:{password}",
17859         "type": "json"
17860       }
17861     ],
17862     "name": "DescribeMail_Transfer_Reports",
17863     "group": "Mail_Transfer_Reports",
17864     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17865     "version": "0.0.0",
17866     "filename": "server/api/mailTransferReport/index.js",
17867     "groupTitle": "Mail_Transfer_Reports"
17868   },
17869   {
17870     "type": "get",
17871     "url": "/api/mail/reports/transfer",
17872     "title": "Gets a list of Mail Transfer Reports",
17873     "examples": [
17874       {
17875         "title": "Example usage:",
17876         "content": "curl https://{domain}/api/mail/reports/transfer -v -u {name}:{password}",
17877         "type": "json"
17878       }
17879     ],
17880     "name": "GetMail_Transfer_Reports",
17881     "group": "Mail_Transfer_Reports",
17882     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
17883     "version": "0.0.0",
17884     "filename": "server/api/mailTransferReport/index.js",
17885     "groupTitle": "Mail_Transfer_Reports"
17886   },
17887   {
17888     "type": "get",
17889     "url": "/api/mail/reports/transfer/{id}",
17890     "title": "Gets a single Mail Transfer Report",
17891     "examples": [
17892       {
17893         "title": "Example usage:",
17894         "content": "curl https://{domain}/api/mail/reports/transfer/{id} -v -u {name}:{password}",
17895         "type": "json"
17896       }
17897     ],
17898     "name": "ShowMail_Transfer_Reports",
17899     "group": "Mail_Transfer_Reports",
17900     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17901     "version": "0.0.0",
17902     "filename": "server/api/mailTransferReport/index.js",
17903     "groupTitle": "Mail_Transfer_Reports"
17904   },
17905   {
17906     "type": "put",
17907     "url": "/api/mail/reports/transfer/{id}",
17908     "title": "Update an existing Mail Transfer Report",
17909     "examples": [
17910       {
17911         "title": "Example usage:",
17912         "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",
17913         "type": "json"
17914       }
17915     ],
17916     "name": "updateMail_Transfer_Reports",
17917     "group": "Mail_Transfer_Reports",
17918     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17919     "version": "0.0.0",
17920     "filename": "server/api/mailTransferReport/index.js",
17921     "groupTitle": "Mail_Transfer_Reports"
17922   },
17923   {
17924     "type": "get",
17925     "url": "/api/members/reports/describe",
17926     "title": "Gets table info about Member Reports",
17927     "examples": [
17928       {
17929         "title": "Example usage:",
17930         "content": "curl https://{domain}/api/members/reports/describe -v -u {name}:{password}",
17931         "type": "json"
17932       }
17933     ],
17934     "name": "DescribeMember_Reports",
17935     "group": "Member_Reports",
17936     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17937     "version": "0.0.0",
17938     "filename": "server/api/memberReport/index.js",
17939     "groupTitle": "Member_Reports"
17940   },
17941   {
17942     "type": "get",
17943     "url": "/api/members/reports",
17944     "title": "Gets a list of Member Reports",
17945     "examples": [
17946       {
17947         "title": "Example usage:",
17948         "content": "curl https://{domain}/api/members/reports -v -u {name}:{password}",
17949         "type": "json"
17950       }
17951     ],
17952     "name": "GetMember_Reports",
17953     "group": "Member_Reports",
17954     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
17955     "version": "0.0.0",
17956     "filename": "server/api/memberReport/index.js",
17957     "groupTitle": "Member_Reports"
17958   },
17959   {
17960     "type": "get",
17961     "url": "/api/members/reports/{id}",
17962     "title": "Gets a single Member Report",
17963     "examples": [
17964       {
17965         "title": "Example usage:",
17966         "content": "curl https://{domain}/api/members/reports/{id} -v -u {name}:{password}",
17967         "type": "json"
17968       }
17969     ],
17970     "name": "ShowMember_Reports",
17971     "group": "Member_Reports",
17972     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17973     "version": "0.0.0",
17974     "filename": "server/api/memberReport/index.js",
17975     "groupTitle": "Member_Reports"
17976   },
17977   {
17978     "type": "get",
17979     "url": "/api/migrations",
17980     "title": "Gets a list of Migrations",
17981     "examples": [
17982       {
17983         "title": "Example usage:",
17984         "content": "curl https://{domain}/api/migrations -v -u {name}:{password}",
17985         "type": "json"
17986       }
17987     ],
17988     "name": "GetMigrations",
17989     "group": "Migrations",
17990     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
17991     "version": "0.0.0",
17992     "filename": "server/api/migration/index.js",
17993     "groupTitle": "Migrations"
17994   },
17995   {
17996     "type": "post",
17997     "url": "/api/voice/networks",
17998     "title": "Create a new network",
17999     "examples": [
18000       {
18001         "title": "Example usage:",
18002         "content": "curl https://{domain}/api/voice/networks -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
18003         "type": "json"
18004       }
18005     ],
18006     "name": "Create",
18007     "group": "Networks",
18008     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18009     "version": "0.0.0",
18010     "filename": "server/api/network/index.js",
18011     "groupTitle": "Networks"
18012   },
18013   {
18014     "type": "delete",
18015     "url": "/api/voice/networks/{id}",
18016     "title": "Deletes a network",
18017     "examples": [
18018       {
18019         "title": "Example usage:",
18020         "content": "curl https://{domain}/api/voice/networks/{id} -v -u {name}:{password} -X DELETE",
18021         "type": "json"
18022       }
18023     ],
18024     "name": "Delete",
18025     "group": "Networks",
18026     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18027     "version": "0.0.0",
18028     "filename": "server/api/network/index.js",
18029     "groupTitle": "Networks"
18030   },
18031   {
18032     "type": "get",
18033     "url": "/api/networks",
18034     "title": "Gets a list of Networks",
18035     "examples": [
18036       {
18037         "title": "Example usage:",
18038         "content": "curl https://{domain}/api/networks -v -u {name}:{password}",
18039         "type": "json"
18040       }
18041     ],
18042     "name": "GetNetworks",
18043     "group": "Networks",
18044     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
18045     "version": "0.0.0",
18046     "filename": "server/api/network/index.js",
18047     "groupTitle": "Networks"
18048   },
18049   {
18050     "type": "get",
18051     "url": "/api/networks/{id}",
18052     "title": "Gets a single Network",
18053     "examples": [
18054       {
18055         "title": "Example usage:",
18056         "content": "curl https://{domain}/api/networks/{id} -v -u {name}:{password}",
18057         "type": "json"
18058       }
18059     ],
18060     "name": "ShowNetworks",
18061     "group": "Networks",
18062     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18063     "version": "0.0.0",
18064     "filename": "server/api/network/index.js",
18065     "groupTitle": "Networks"
18066   },
18067   {
18068     "type": "put",
18069     "url": "/api/voice/networks/{id}",
18070     "title": "Update an existing network",
18071     "examples": [
18072       {
18073         "title": "Example usage:",
18074         "content": "curl https://{domain}/api/voice/networks/{id} -v -u {name}:{password} -X PUT",
18075         "type": "json"
18076       }
18077     ],
18078     "name": "Update",
18079     "group": "Networks",
18080     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18081     "version": "0.0.0",
18082     "filename": "server/api/network/index.js",
18083     "groupTitle": "Networks"
18084   },
18085   {
18086     "type": "post",
18087     "url": "/api/openchannel/accounts/{id}/users",
18088     "title": "Add agents to a openchannel account",
18089     "examples": [
18090       {
18091         "title": "Example usage:",
18092         "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",
18093         "type": "json"
18094       }
18095     ],
18096     "name": "AddAgents",
18097     "group": "Openchannel_Accounts",
18098     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18099     "version": "0.0.0",
18100     "filename": "server/api/openchannelAccount/index.js",
18101     "groupTitle": "Openchannel_Accounts"
18102   },
18103   {
18104     "type": "post",
18105     "url": "/api/openchannel/accounts",
18106     "title": "Creates a new Account",
18107     "examples": [
18108       {
18109         "title": "Example usage:",
18110         "content": "curl https://{domain}/api/openchannel/accounts -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
18111         "type": "json"
18112       }
18113     ],
18114     "name": "CreateAccounts",
18115     "group": "Openchannel_Accounts",
18116     "parameter": {
18117       "fields": {
18118         "Body": [
18119           {
18120             "group": "Body",
18121             "type": "String",
18122             "optional": false,
18123             "field": "name",
18124             "description": ""
18125           },
18126           {
18127             "group": "Body",
18128             "type": "String",
18129             "optional": true,
18130             "field": "description",
18131             "description": ""
18132           },
18133           {
18134             "group": "Body",
18135             "type": "String",
18136             "optional": true,
18137             "field": "token",
18138             "description": ""
18139           },
18140           {
18141             "group": "Body",
18142             "type": "String",
18143             "optional": true,
18144             "field": "replyUri",
18145             "description": ""
18146           },
18147           {
18148             "group": "Body",
18149             "type": "String",
18150             "optional": false,
18151             "field": "key",
18152             "description": ""
18153           },
18154           {
18155             "group": "Body",
18156             "type": "Text",
18157             "optional": true,
18158             "field": "notificationTemplate",
18159             "description": ""
18160           },
18161           {
18162             "group": "Body",
18163             "type": "Boolean",
18164             "optional": true,
18165             "field": "notificationSound",
18166             "description": ""
18167           },
18168           {
18169             "group": "Body",
18170             "type": "Boolean",
18171             "optional": true,
18172             "field": "notificationShake",
18173             "description": ""
18174           },
18175           {
18176             "group": "Body",
18177             "type": "Integer",
18178             "optional": true,
18179             "field": "waitForTheAssignedAgent",
18180             "description": ""
18181           },
18182           {
18183             "group": "Body",
18184             "type": "String",
18185             "optional": true,
18186             "field": "mapKey",
18187             "description": ""
18188           },
18189           {
18190             "group": "Body",
18191             "type": "Boolean",
18192             "optional": true,
18193             "field": "queueTransfer",
18194             "description": ""
18195           },
18196           {
18197             "group": "Body",
18198             "type": "Integer",
18199             "optional": true,
18200             "field": "queueTransferTimeout",
18201             "description": ""
18202           },
18203           {
18204             "group": "Body",
18205             "type": "Boolean",
18206             "optional": true,
18207             "field": "agentTransfer",
18208             "description": ""
18209           },
18210           {
18211             "group": "Body",
18212             "type": "Integer",
18213             "optional": true,
18214             "field": "agentTransferTimeout",
18215             "description": ""
18216           },
18217           {
18218             "group": "Body",
18219             "type": "Integer",
18220             "optional": true,
18221             "field": "mandatoryDispositionPauseId",
18222             "description": "<p>Status to put when mandatory disposition is enabled</p>"
18223           },
18224           {
18225             "group": "Body",
18226             "type": "Boolean",
18227             "optional": true,
18228             "field": "mandatoryDisposition",
18229             "description": "<p>Enabled/disables mandatory dispo on a queue</p>"
18230           }
18231         ]
18232       }
18233     },
18234     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18235     "version": "0.0.0",
18236     "filename": "server/api/openchannelAccount/index.js",
18237     "groupTitle": "Openchannel_Accounts"
18238   },
18239   {
18240     "type": "delete",
18241     "url": "/api/openchannel/accounts/{id}",
18242     "title": "Deletes a Account",
18243     "examples": [
18244       {
18245         "title": "Example usage:",
18246         "content": "curl https://{domain}/api/openchannel/accounts/{id} -v -u {name}:{password} -X DELETE",
18247         "type": "json"
18248       }
18249     ],
18250     "name": "DeleteAccounts",
18251     "group": "Openchannel_Accounts",
18252     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18253     "version": "0.0.0",
18254     "filename": "server/api/openchannelAccount/index.js",
18255     "groupTitle": "Openchannel_Accounts"
18256   },
18257   {
18258     "type": "get",
18259     "url": "/api/openchannel/accounts/describe",
18260     "title": "Gets table info about Accounts",
18261     "examples": [
18262       {
18263         "title": "Example usage:",
18264         "content": "curl https://{domain}/api/openchannel/accounts/describe -v -u {name}:{password}",
18265         "type": "json"
18266       }
18267     ],
18268     "name": "DescribeAccounts",
18269     "group": "Openchannel_Accounts",
18270     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18271     "version": "0.0.0",
18272     "filename": "server/api/openchannelAccount/index.js",
18273     "groupTitle": "Openchannel_Accounts"
18274   },
18275   {
18276     "type": "get",
18277     "url": "/api/openchannel/accounts",
18278     "title": "Gets a list of Accounts",
18279     "examples": [
18280       {
18281         "title": "Example usage:",
18282         "content": "curl https://{domain}/api/openchannel/accounts -v -u {name}:{password}",
18283         "type": "json"
18284       }
18285     ],
18286     "name": "GetAccounts",
18287     "group": "Openchannel_Accounts",
18288     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
18289     "version": "0.0.0",
18290     "filename": "server/api/openchannelAccount/index.js",
18291     "groupTitle": "Openchannel_Accounts"
18292   },
18293   {
18294     "type": "get",
18295     "url": "/api/openchannel/accounts/{id}/users",
18296     "title": "Gets agents from openchannel account",
18297     "examples": [
18298       {
18299         "title": "Example usage:",
18300         "content": "curl https://{domain}/api/openchannel/accounts/{id}/users -v -u {name}:{password} -X GET",
18301         "type": "json"
18302       }
18303     ],
18304     "name": "GetAgents",
18305     "group": "Openchannel_Accounts",
18306     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18307     "version": "0.0.0",
18308     "filename": "server/api/openchannelAccount/index.js",
18309     "groupTitle": "Openchannel_Accounts"
18310   },
18311   {
18312     "type": "delete",
18313     "url": "/api/openchannel/accounts/{id}/users",
18314     "title": "Removes agents from a openchannel account",
18315     "examples": [
18316       {
18317         "title": "Example usage:",
18318         "content": "curl https://{domain}/api/openchannel/accounts/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
18319         "type": "json"
18320       }
18321     ],
18322     "name": "RemoveAgents",
18323     "group": "Openchannel_Accounts",
18324     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18325     "version": "0.0.0",
18326     "filename": "server/api/openchannelAccount/index.js",
18327     "groupTitle": "Openchannel_Accounts"
18328   },
18329   {
18330     "type": "delete",
18331     "url": "/api/openchannel/accounts/{id}/canned_answers",
18332     "title": "Removes canned answers from account",
18333     "examples": [
18334       {
18335         "title": "Example usage:",
18336         "content": "curl https://{domain}/api/openchannel/accounts/{id}/canned_answers?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
18337         "type": "json"
18338       }
18339     ],
18340     "name": "RemoveAnswers",
18341     "group": "Openchannel_Accounts",
18342     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18343     "version": "0.0.0",
18344     "filename": "server/api/openchannelAccount/index.js",
18345     "groupTitle": "Openchannel_Accounts"
18346   },
18347   {
18348     "type": "delete",
18349     "url": "/api/openchannel/accounts/{id}/dispositions",
18350     "title": "Removes dispositions from account",
18351     "examples": [
18352       {
18353         "title": "Example usage:",
18354         "content": "curl https://{domain}/api/openchannel/accounts/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
18355         "type": "json"
18356       }
18357     ],
18358     "name": "RemoveDispositions",
18359     "group": "Openchannel_Accounts",
18360     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18361     "version": "0.0.0",
18362     "filename": "server/api/openchannelAccount/index.js",
18363     "groupTitle": "Openchannel_Accounts"
18364   },
18365   {
18366     "type": "get",
18367     "url": "/api/openchannel/accounts/{id}",
18368     "title": "Gets a single Account",
18369     "examples": [
18370       {
18371         "title": "Example usage:",
18372         "content": "curl https://{domain}/api/openchannel/accounts/{id} -v -u {name}:{password}",
18373         "type": "json"
18374       }
18375     ],
18376     "name": "ShowAccounts",
18377     "group": "Openchannel_Accounts",
18378     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18379     "version": "0.0.0",
18380     "filename": "server/api/openchannelAccount/index.js",
18381     "groupTitle": "Openchannel_Accounts"
18382   },
18383   {
18384     "type": "post",
18385     "url": "/api/openchannel/accounts/{id}/canned_answers",
18386     "title": "Creates new canned answer",
18387     "examples": [
18388       {
18389         "title": "Example usage:",
18390         "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",
18391         "type": "json"
18392       }
18393     ],
18394     "name": "addAnswer",
18395     "group": "Openchannel_Accounts",
18396     "parameter": {
18397       "fields": {
18398         "Body": [
18399           {
18400             "group": "Body",
18401             "type": "String",
18402             "optional": false,
18403             "field": "key",
18404             "description": ""
18405           },
18406           {
18407             "group": "Body",
18408             "type": "Text",
18409             "optional": false,
18410             "field": "value",
18411             "description": ""
18412           },
18413           {
18414             "group": "Body",
18415             "type": "String",
18416             "optional": true,
18417             "field": "description",
18418             "description": ""
18419           },
18420           {
18421             "group": "Body",
18422             "type": "Virtual",
18423             "optional": true,
18424             "field": "name",
18425             "description": ""
18426           }
18427         ]
18428       }
18429     },
18430     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18431     "version": "0.0.0",
18432     "filename": "server/api/openchannelAccount/index.js",
18433     "groupTitle": "Openchannel_Accounts"
18434   },
18435   {
18436     "type": "post",
18437     "url": "/api/openchannel/accounts/{id}/applications",
18438     "title": "Creates new applications",
18439     "examples": [
18440       {
18441         "title": "Example usage:",
18442         "content": "curl https://{domain}/api/openchannel/accounts/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
18443         "type": "json"
18444       }
18445     ],
18446     "name": "addApplications",
18447     "group": "Openchannel_Accounts",
18448     "parameter": {
18449       "fields": {
18450         "Body": [
18451           {
18452             "group": "Body",
18453             "type": "Integer",
18454             "optional": false,
18455             "field": "priority",
18456             "description": ""
18457           },
18458           {
18459             "group": "Body",
18460             "type": "String",
18461             "optional": false,
18462             "field": "app",
18463             "description": ""
18464           },
18465           {
18466             "group": "Body",
18467             "type": "Text",
18468             "optional": true,
18469             "field": "appdata",
18470             "description": ""
18471           },
18472           {
18473             "group": "Body",
18474             "type": "String",
18475             "optional": true,
18476             "field": "description",
18477             "description": ""
18478           },
18479           {
18480             "group": "Body",
18481             "type": "String",
18482             "optional": true,
18483             "field": "interval",
18484             "description": ""
18485           }
18486         ]
18487       }
18488     },
18489     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18490     "version": "0.0.0",
18491     "filename": "server/api/openchannelAccount/index.js",
18492     "groupTitle": "Openchannel_Accounts"
18493   },
18494   {
18495     "type": "post",
18496     "url": "/api/openchannel/accounts/{id}/dispositions",
18497     "title": "Creates new disposition",
18498     "examples": [
18499       {
18500         "title": "Example usage:",
18501         "content": "curl https://{domain}/api/openchannel/accounts/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
18502         "type": "json"
18503       }
18504     ],
18505     "name": "addDisposition",
18506     "group": "Openchannel_Accounts",
18507     "parameter": {
18508       "fields": {
18509         "Body": [
18510           {
18511             "group": "Body",
18512             "type": "String",
18513             "optional": false,
18514             "field": "name",
18515             "description": ""
18516           },
18517           {
18518             "group": "Body",
18519             "type": "String",
18520             "allowedValues": [
18521               "\"first\"",
18522               "\"second\"",
18523               "\"third\""
18524             ],
18525             "optional": false,
18526             "field": "level",
18527             "description": ""
18528           },
18529           {
18530             "group": "Body",
18531             "type": "String",
18532             "optional": true,
18533             "field": "description",
18534             "description": ""
18535           }
18536         ]
18537       }
18538     },
18539     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18540     "version": "0.0.0",
18541     "filename": "server/api/openchannelAccount/index.js",
18542     "groupTitle": "Openchannel_Accounts"
18543   },
18544   {
18545     "type": "get",
18546     "url": "/api/openchannel/accounts/{id}/canned_answers",
18547     "title": "Gets account canned answers",
18548     "examples": [
18549       {
18550         "title": "Example usage:",
18551         "content": "curl https://{domain}/api/openchannel/accounts/{id}/canned_answers -v -u {name}:{password} -X GET",
18552         "type": "json"
18553       }
18554     ],
18555     "name": "getAnswers",
18556     "group": "Openchannel_Accounts",
18557     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18558     "version": "0.0.0",
18559     "filename": "server/api/openchannelAccount/index.js",
18560     "groupTitle": "Openchannel_Accounts"
18561   },
18562   {
18563     "type": "get",
18564     "url": "/api/openchannel/accounts/{id}/applications",
18565     "title": "Gets account applications",
18566     "examples": [
18567       {
18568         "title": "Example usage:",
18569         "content": "curl https://{domain}/api/openchannel/accounts/{id}/applications -v -u {name}:{password} -X GET",
18570         "type": "json"
18571       }
18572     ],
18573     "name": "getApplications",
18574     "group": "Openchannel_Accounts",
18575     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18576     "version": "0.0.0",
18577     "filename": "server/api/openchannelAccount/index.js",
18578     "groupTitle": "Openchannel_Accounts"
18579   },
18580   {
18581     "type": "get",
18582     "url": "/api/openchannel/accounts/{id}/dispositions",
18583     "title": "Gets account dispositions",
18584     "examples": [
18585       {
18586         "title": "Example usage:",
18587         "content": "curl https://{domain}/api/openchannel/accounts/{id}/dispositions -v -u {name}:{password} -X GET",
18588         "type": "json"
18589       }
18590     ],
18591     "name": "getDispositions",
18592     "group": "Openchannel_Accounts",
18593     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18594     "version": "0.0.0",
18595     "filename": "server/api/openchannelAccount/index.js",
18596     "groupTitle": "Openchannel_Accounts"
18597   },
18598   {
18599     "type": "get",
18600     "url": "/api/openchannel/accounts/{id}/interactions",
18601     "title": "Gets Openchannel Account Interactions",
18602     "examples": [
18603       {
18604         "title": "Example usage:",
18605         "content": "curl https://{domain}/api/openchannel/accounts/{id}/interactions -v -u {name}:{password} -X GET",
18606         "type": "json"
18607       }
18608     ],
18609     "name": "getInteractions",
18610     "group": "Openchannel_Accounts",
18611     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18612     "version": "0.0.0",
18613     "filename": "server/api/openchannelAccount/index.js",
18614     "groupTitle": "Openchannel_Accounts"
18615   },
18616   {
18617     "type": "post",
18618     "url": "/api/openchannel/accounts/{id}/notify",
18619     "title": "Notify new message",
18620     "examples": [
18621       {
18622         "title": "Example usage:",
18623         "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",
18624         "type": "json"
18625       }
18626     ],
18627     "name": "notify",
18628     "group": "Openchannel_Accounts",
18629     "description": "<p>Motion 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>",
18630     "version": "0.0.0",
18631     "filename": "server/api/openchannelAccount/index.js",
18632     "groupTitle": "Openchannel_Accounts"
18633   },
18634   {
18635     "type": "post",
18636     "url": "/api/openchannel/accounts/{id}/send",
18637     "title": "Send new openchannel message",
18638     "examples": [
18639       {
18640         "title": "Example usage:",
18641         "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",
18642         "type": "json"
18643       }
18644     ],
18645     "name": "sendOpenchannel",
18646     "group": "Openchannel_Accounts",
18647     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18648     "version": "0.0.0",
18649     "filename": "server/api/openchannelAccount/index.js",
18650     "groupTitle": "Openchannel_Accounts"
18651   },
18652   {
18653     "type": "put",
18654     "url": "/api/openchannel/accounts/{id}",
18655     "title": "Update an existing Account",
18656     "examples": [
18657       {
18658         "title": "Example usage:",
18659         "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",
18660         "type": "json"
18661       }
18662     ],
18663     "name": "updateAccounts",
18664     "group": "Openchannel_Accounts",
18665     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18666     "version": "0.0.0",
18667     "filename": "server/api/openchannelAccount/index.js",
18668     "groupTitle": "Openchannel_Accounts"
18669   },
18670   {
18671     "type": "post",
18672     "url": "/api/openchannel/applications",
18673     "title": "Creates a new Application",
18674     "examples": [
18675       {
18676         "title": "Example usage:",
18677         "content": "curl https://{domain}/api/openchannel/applications -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
18678         "type": "json"
18679       }
18680     ],
18681     "name": "CreateApplications",
18682     "group": "Openchannel_Applications",
18683     "parameter": {
18684       "fields": {
18685         "Body": [
18686           {
18687             "group": "Body",
18688             "type": "Integer",
18689             "optional": false,
18690             "field": "priority",
18691             "description": ""
18692           },
18693           {
18694             "group": "Body",
18695             "type": "String",
18696             "optional": false,
18697             "field": "app",
18698             "description": ""
18699           },
18700           {
18701             "group": "Body",
18702             "type": "Text",
18703             "optional": true,
18704             "field": "appdata",
18705             "description": ""
18706           },
18707           {
18708             "group": "Body",
18709             "type": "String",
18710             "optional": true,
18711             "field": "description",
18712             "description": ""
18713           },
18714           {
18715             "group": "Body",
18716             "type": "String",
18717             "optional": true,
18718             "field": "interval",
18719             "description": ""
18720           }
18721         ]
18722       }
18723     },
18724     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18725     "version": "0.0.0",
18726     "filename": "server/api/openchannelApplication/index.js",
18727     "groupTitle": "Openchannel_Applications"
18728   },
18729   {
18730     "type": "delete",
18731     "url": "/api/openchannel/applications/{id}",
18732     "title": "Deletes a Application",
18733     "examples": [
18734       {
18735         "title": "Example usage:",
18736         "content": "curl https://{domain}/api/openchannel/applications/{id} -v -u {name}:{password} -X DELETE",
18737         "type": "json"
18738       }
18739     ],
18740     "name": "DeleteApplications",
18741     "group": "Openchannel_Applications",
18742     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18743     "version": "0.0.0",
18744     "filename": "server/api/openchannelApplication/index.js",
18745     "groupTitle": "Openchannel_Applications"
18746   },
18747   {
18748     "type": "get",
18749     "url": "/api/openchannel/applications",
18750     "title": "Gets a list of Applications",
18751     "examples": [
18752       {
18753         "title": "Example usage:",
18754         "content": "curl https://{domain}/api/openchannel/applications -v -u {name}:{password}",
18755         "type": "json"
18756       }
18757     ],
18758     "name": "GetApplications",
18759     "group": "Openchannel_Applications",
18760     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
18761     "version": "0.0.0",
18762     "filename": "server/api/openchannelApplication/index.js",
18763     "groupTitle": "Openchannel_Applications"
18764   },
18765   {
18766     "type": "get",
18767     "url": "/api/openchannel/applications/{id}",
18768     "title": "Gets a single Application",
18769     "examples": [
18770       {
18771         "title": "Example usage:",
18772         "content": "curl https://{domain}/api/openchannel/applications/{id} -v -u {name}:{password}",
18773         "type": "json"
18774       }
18775     ],
18776     "name": "ShowApplications",
18777     "group": "Openchannel_Applications",
18778     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18779     "version": "0.0.0",
18780     "filename": "server/api/openchannelApplication/index.js",
18781     "groupTitle": "Openchannel_Applications"
18782   },
18783   {
18784     "type": "put",
18785     "url": "/api/openchannel/applications/{id}",
18786     "title": "Update an existing Application",
18787     "examples": [
18788       {
18789         "title": "Example usage:",
18790         "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",
18791         "type": "json"
18792       }
18793     ],
18794     "name": "updateApplications",
18795     "group": "Openchannel_Applications",
18796     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18797     "version": "0.0.0",
18798     "filename": "server/api/openchannelApplication/index.js",
18799     "groupTitle": "Openchannel_Applications"
18800   },
18801   {
18802     "type": "post",
18803     "url": "/api/openchannel/interactions/{id}/tags",
18804     "title": "Add tags to the interaction",
18805     "examples": [
18806       {
18807         "title": "Example usage:",
18808         "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",
18809         "type": "json"
18810       }
18811     ],
18812     "name": "AddTags",
18813     "group": "Openchannel_Interactions",
18814     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18815     "version": "0.0.0",
18816     "filename": "server/api/openchannelInteraction/index.js",
18817     "groupTitle": "Openchannel_Interactions"
18818   },
18819   {
18820     "type": "post",
18821     "url": "/api/openchannel/interactions",
18822     "title": "Creates a new Interaction",
18823     "examples": [
18824       {
18825         "title": "Example usage:",
18826         "content": "curl https://{domain}/api/openchannel/interactions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
18827         "type": "json"
18828       }
18829     ],
18830     "name": "CreateInteractions",
18831     "group": "Openchannel_Interactions",
18832     "parameter": {
18833       "fields": {
18834         "Body": [
18835           {
18836             "group": "Body",
18837             "type": "Boolean",
18838             "optional": true,
18839             "field": "closed",
18840             "description": ""
18841           },
18842           {
18843             "group": "Body",
18844             "type": "String",
18845             "optional": true,
18846             "field": "closedAt",
18847             "description": ""
18848           },
18849           {
18850             "group": "Body",
18851             "type": "String",
18852             "optional": true,
18853             "field": "disposition",
18854             "description": ""
18855           },
18856           {
18857             "group": "Body",
18858             "type": "String",
18859             "optional": true,
18860             "field": "secondDisposition",
18861             "description": ""
18862           },
18863           {
18864             "group": "Body",
18865             "type": "String",
18866             "optional": true,
18867             "field": "thirdDisposition",
18868             "description": ""
18869           },
18870           {
18871             "group": "Body",
18872             "type": "String",
18873             "optional": true,
18874             "field": "note",
18875             "description": ""
18876           },
18877           {
18878             "group": "Body",
18879             "type": "String",
18880             "optional": true,
18881             "field": "read1stAt",
18882             "description": ""
18883           },
18884           {
18885             "group": "Body",
18886             "type": "String",
18887             "optional": true,
18888             "field": "threadId",
18889             "description": ""
18890           },
18891           {
18892             "group": "Body",
18893             "type": "String",
18894             "optional": true,
18895             "field": "externalUrl",
18896             "description": ""
18897           },
18898           {
18899             "group": "Body",
18900             "type": "String",
18901             "optional": true,
18902             "field": "lastMsgAt",
18903             "description": ""
18904           },
18905           {
18906             "group": "Body",
18907             "type": "String",
18908             "allowedValues": [
18909               "\"in\"",
18910               "\"out\""
18911             ],
18912             "optional": false,
18913             "field": "lastMsgDirection",
18914             "description": ""
18915           },
18916           {
18917             "group": "Body",
18918             "type": "String",
18919             "optional": true,
18920             "field": "from",
18921             "description": ""
18922           },
18923           {
18924             "group": "Body",
18925             "type": "Boolean",
18926             "optional": true,
18927             "field": "autoreplyExecuted",
18928             "description": ""
18929           }
18930         ]
18931       }
18932     },
18933     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18934     "version": "0.0.0",
18935     "filename": "server/api/openchannelInteraction/index.js",
18936     "groupTitle": "Openchannel_Interactions"
18937   },
18938   {
18939     "type": "delete",
18940     "url": "/api/openchannel/interactions/{id}",
18941     "title": "Deletes a Interaction",
18942     "examples": [
18943       {
18944         "title": "Example usage:",
18945         "content": "curl https://{domain}/api/openchannel/interactions/{id} -v -u {name}:{password} -X DELETE",
18946         "type": "json"
18947       }
18948     ],
18949     "name": "DeleteInteractions",
18950     "group": "Openchannel_Interactions",
18951     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18952     "version": "0.0.0",
18953     "filename": "server/api/openchannelInteraction/index.js",
18954     "groupTitle": "Openchannel_Interactions"
18955   },
18956   {
18957     "type": "get",
18958     "url": "/api/openchannel/interactions/describe",
18959     "title": "Gets table info about Interactions",
18960     "examples": [
18961       {
18962         "title": "Example usage:",
18963         "content": "curl https://{domain}/api/openchannel/interactions/describe -v -u {name}:{password}",
18964         "type": "json"
18965       }
18966     ],
18967     "name": "DescribeInteractions",
18968     "group": "Openchannel_Interactions",
18969     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18970     "version": "0.0.0",
18971     "filename": "server/api/openchannelInteraction/index.js",
18972     "groupTitle": "Openchannel_Interactions"
18973   },
18974   {
18975     "type": "get",
18976     "url": "/api/openchannel/interactions",
18977     "title": "Gets a list of Interactions",
18978     "examples": [
18979       {
18980         "title": "Example usage:",
18981         "content": "curl https://{domain}/api/openchannel/interactions -v -u {name}:{password}",
18982         "type": "json"
18983       }
18984     ],
18985     "name": "GetInteractions",
18986     "group": "Openchannel_Interactions",
18987     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
18988     "version": "0.0.0",
18989     "filename": "server/api/openchannelInteraction/index.js",
18990     "groupTitle": "Openchannel_Interactions"
18991   },
18992   {
18993     "type": "delete",
18994     "url": "/api/openchannel/interactions/{id}/tags",
18995     "title": "Removes tags from interaction",
18996     "examples": [
18997       {
18998         "title": "Example usage:",
18999         "content": "curl https://{domain}/api/openchannel/interactions/{id}/tags?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
19000         "type": "json"
19001       }
19002     ],
19003     "name": "RemoveTags",
19004     "group": "Openchannel_Interactions",
19005     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19006     "version": "0.0.0",
19007     "filename": "server/api/openchannelInteraction/index.js",
19008     "groupTitle": "Openchannel_Interactions"
19009   },
19010   {
19011     "type": "get",
19012     "url": "/api/openchannel/interactions/{id}",
19013     "title": "Gets a single Interaction",
19014     "examples": [
19015       {
19016         "title": "Example usage:",
19017         "content": "curl https://{domain}/api/openchannel/interactions/{id} -v -u {name}:{password}",
19018         "type": "json"
19019       }
19020     ],
19021     "name": "ShowInteractions",
19022     "group": "Openchannel_Interactions",
19023     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19024     "version": "0.0.0",
19025     "filename": "server/api/openchannelInteraction/index.js",
19026     "groupTitle": "Openchannel_Interactions"
19027   },
19028   {
19029     "type": "post",
19030     "url": "/api/openchannel/interactions/{id}/messages",
19031     "title": "Creates new messages",
19032     "examples": [
19033       {
19034         "title": "Example usage:",
19035         "content": "curl https://{domain}/api/openchannel/interactions/{id}/messages -d '[{\"to\": \"+3901119886500\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
19036         "type": "json"
19037       }
19038     ],
19039     "name": "addMessage",
19040     "group": "Openchannel_Interactions",
19041     "parameter": {
19042       "fields": {
19043         "Body": [
19044           {
19045             "group": "Body",
19046             "type": "Text",
19047             "optional": false,
19048             "field": "body",
19049             "description": ""
19050           },
19051           {
19052             "group": "Body",
19053             "type": "Boolean",
19054             "optional": true,
19055             "field": "read",
19056             "description": ""
19057           },
19058           {
19059             "group": "Body",
19060             "type": "Boolean",
19061             "optional": true,
19062             "field": "secret",
19063             "description": ""
19064           },
19065           {
19066             "group": "Body",
19067             "type": "String",
19068             "allowedValues": [
19069               "\"in\"",
19070               "\"out\""
19071             ],
19072             "optional": false,
19073             "field": "direction",
19074             "description": ""
19075           },
19076           {
19077             "group": "Body",
19078             "type": "String",
19079             "optional": true,
19080             "field": "readAt",
19081             "description": ""
19082           },
19083           {
19084             "group": "Body",
19085             "type": "String",
19086             "optional": true,
19087             "field": "providerName",
19088             "description": ""
19089           },
19090           {
19091             "group": "Body",
19092             "type": "Text",
19093             "optional": true,
19094             "field": "providerResponse",
19095             "description": ""
19096           }
19097         ]
19098       }
19099     },
19100     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19101     "version": "0.0.0",
19102     "filename": "server/api/openchannelInteraction/index.js",
19103     "groupTitle": "Openchannel_Interactions"
19104   },
19105   {
19106     "type": "get",
19107     "url": "/api/openchannel/interactions/{id}/download",
19108     "title": "Gets interaction",
19109     "examples": [
19110       {
19111         "title": "Example usage:",
19112         "content": "curl https://{domain}/api/openchannel/interactions/{id}/download -v -u {name}:{password} -X GET",
19113         "type": "json"
19114       }
19115     ],
19116     "name": "download",
19117     "group": "Openchannel_Interactions",
19118     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19119     "version": "0.0.0",
19120     "filename": "server/api/openchannelInteraction/index.js",
19121     "groupTitle": "Openchannel_Interactions"
19122   },
19123   {
19124     "type": "get",
19125     "url": "/api/openchannel/interactions/{id}/messages",
19126     "title": "Gets interaction messages",
19127     "examples": [
19128       {
19129         "title": "Example usage:",
19130         "content": "curl https://{domain}/api/openchannel/interactions/{id}/messages -v -u {name}:{password} -X GET",
19131         "type": "json"
19132       }
19133     ],
19134     "name": "getMessages",
19135     "group": "Openchannel_Interactions",
19136     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19137     "version": "0.0.0",
19138     "filename": "server/api/openchannelInteraction/index.js",
19139     "groupTitle": "Openchannel_Interactions"
19140   },
19141   {
19142     "type": "put",
19143     "url": "/api/openchannel/interactions/{id}",
19144     "title": "Update an existing Interaction",
19145     "examples": [
19146       {
19147         "title": "Example usage:",
19148         "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",
19149         "type": "json"
19150       }
19151     ],
19152     "name": "updateInteractions",
19153     "group": "Openchannel_Interactions",
19154     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19155     "version": "0.0.0",
19156     "filename": "server/api/openchannelInteraction/index.js",
19157     "groupTitle": "Openchannel_Interactions"
19158   },
19159   {
19160     "type": "post",
19161     "url": "/api/openchannel/messages",
19162     "title": "Creates a new Message",
19163     "examples": [
19164       {
19165         "title": "Example usage:",
19166         "content": "curl https://{domain}/api/openchannel/messages -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
19167         "type": "json"
19168       }
19169     ],
19170     "name": "CreateMessages",
19171     "group": "Openchannel_Messages",
19172     "parameter": {
19173       "fields": {
19174         "Body": [
19175           {
19176             "group": "Body",
19177             "type": "Text",
19178             "optional": false,
19179             "field": "body",
19180             "description": ""
19181           },
19182           {
19183             "group": "Body",
19184             "type": "Boolean",
19185             "optional": true,
19186             "field": "read",
19187             "description": ""
19188           },
19189           {
19190             "group": "Body",
19191             "type": "Boolean",
19192             "optional": true,
19193             "field": "secret",
19194             "description": ""
19195           },
19196           {
19197             "group": "Body",
19198             "type": "String",
19199             "allowedValues": [
19200               "\"in\"",
19201               "\"out\""
19202             ],
19203             "optional": false,
19204             "field": "direction",
19205             "description": ""
19206           },
19207           {
19208             "group": "Body",
19209             "type": "String",
19210             "optional": true,
19211             "field": "readAt",
19212             "description": ""
19213           },
19214           {
19215             "group": "Body",
19216             "type": "String",
19217             "optional": true,
19218             "field": "providerName",
19219             "description": ""
19220           },
19221           {
19222             "group": "Body",
19223             "type": "Text",
19224             "optional": true,
19225             "field": "providerResponse",
19226             "description": ""
19227           }
19228         ]
19229       }
19230     },
19231     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19232     "version": "0.0.0",
19233     "filename": "server/api/openchannelMessage/index.js",
19234     "groupTitle": "Openchannel_Messages"
19235   },
19236   {
19237     "type": "delete",
19238     "url": "/api/openchannel/messages/{id}",
19239     "title": "Deletes a Message",
19240     "examples": [
19241       {
19242         "title": "Example usage:",
19243         "content": "curl https://{domain}/api/openchannel/messages/{id} -v -u {name}:{password} -X DELETE",
19244         "type": "json"
19245       }
19246     ],
19247     "name": "DeleteMessages",
19248     "group": "Openchannel_Messages",
19249     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19250     "version": "0.0.0",
19251     "filename": "server/api/openchannelMessage/index.js",
19252     "groupTitle": "Openchannel_Messages"
19253   },
19254   {
19255     "type": "get",
19256     "url": "/api/openchannel/messages/describe",
19257     "title": "Gets table info about Messages",
19258     "examples": [
19259       {
19260         "title": "Example usage:",
19261         "content": "curl https://{domain}/api/openchannel/messages/describe -v -u {name}:{password}",
19262         "type": "json"
19263       }
19264     ],
19265     "name": "DescribeMessages",
19266     "group": "Openchannel_Messages",
19267     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19268     "version": "0.0.0",
19269     "filename": "server/api/openchannelMessage/index.js",
19270     "groupTitle": "Openchannel_Messages"
19271   },
19272   {
19273     "type": "get",
19274     "url": "/api/openchannel/messages",
19275     "title": "Gets a list of Messages",
19276     "examples": [
19277       {
19278         "title": "Example usage:",
19279         "content": "curl https://{domain}/api/openchannel/messages -v -u {name}:{password}",
19280         "type": "json"
19281       }
19282     ],
19283     "name": "GetMessages",
19284     "group": "Openchannel_Messages",
19285     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
19286     "version": "0.0.0",
19287     "filename": "server/api/openchannelMessage/index.js",
19288     "groupTitle": "Openchannel_Messages"
19289   },
19290   {
19291     "type": "get",
19292     "url": "/api/openchannel/messages/{id}",
19293     "title": "Gets a single Message",
19294     "examples": [
19295       {
19296         "title": "Example usage:",
19297         "content": "curl https://{domain}/api/openchannel/messages/{id} -v -u {name}:{password}",
19298         "type": "json"
19299       }
19300     ],
19301     "name": "ShowMessages",
19302     "group": "Openchannel_Messages",
19303     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19304     "version": "0.0.0",
19305     "filename": "server/api/openchannelMessage/index.js",
19306     "groupTitle": "Openchannel_Messages"
19307   },
19308   {
19309     "type": "put",
19310     "url": "/api/openchannel/messages/{id}/accept",
19311     "title": "Accepts message",
19312     "examples": [
19313       {
19314         "title": "Example usage:",
19315         "content": "curl https://{domain}/api/openchannel/messages/{id}/accept \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
19316         "type": "json"
19317       }
19318     ],
19319     "name": "acceptMessage",
19320     "group": "Openchannel_Messages",
19321     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19322     "version": "0.0.0",
19323     "filename": "server/api/openchannelMessage/index.js",
19324     "groupTitle": "Openchannel_Messages"
19325   },
19326   {
19327     "type": "put",
19328     "url": "/api/openchannel/messages/{id}/reject",
19329     "title": "Rejects message",
19330     "examples": [
19331       {
19332         "title": "Example usage:",
19333         "content": "curl https://{domain}/api/openchannel/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
19334         "type": "json"
19335       }
19336     ],
19337     "name": "rejectMessage",
19338     "group": "Openchannel_Messages",
19339     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19340     "version": "0.0.0",
19341     "filename": "server/api/openchannelMessage/index.js",
19342     "groupTitle": "Openchannel_Messages"
19343   },
19344   {
19345     "type": "put",
19346     "url": "/api/openchannel/messages/{id}",
19347     "title": "Update an existing Message",
19348     "examples": [
19349       {
19350         "title": "Example usage:",
19351         "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",
19352         "type": "json"
19353       }
19354     ],
19355     "name": "updateMessages",
19356     "group": "Openchannel_Messages",
19357     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19358     "version": "0.0.0",
19359     "filename": "server/api/openchannelMessage/index.js",
19360     "groupTitle": "Openchannel_Messages"
19361   },
19362   {
19363     "type": "post",
19364     "url": "/api/openchannel/reports/queue",
19365     "title": "Creates a new Openchannel Queue Report",
19366     "examples": [
19367       {
19368         "title": "Example usage:",
19369         "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",
19370         "type": "json"
19371       }
19372     ],
19373     "name": "CreateOpenchannel_Queue_Reports",
19374     "group": "Openchannel_Queue_Reports",
19375     "parameter": {
19376       "fields": {
19377         "Body": [
19378           {
19379             "group": "Body",
19380             "type": "String",
19381             "optional": false,
19382             "field": "uniqueid",
19383             "description": ""
19384           },
19385           {
19386             "group": "Body",
19387             "type": "String",
19388             "optional": true,
19389             "field": "from",
19390             "description": ""
19391           },
19392           {
19393             "group": "Body",
19394             "type": "String",
19395             "optional": true,
19396             "field": "joinAt",
19397             "description": ""
19398           },
19399           {
19400             "group": "Body",
19401             "type": "String",
19402             "optional": true,
19403             "field": "leaveAt",
19404             "description": ""
19405           },
19406           {
19407             "group": "Body",
19408             "type": "String",
19409             "optional": true,
19410             "field": "acceptAt",
19411             "description": ""
19412           },
19413           {
19414             "group": "Body",
19415             "type": "String",
19416             "optional": true,
19417             "field": "exitAt",
19418             "description": ""
19419           },
19420           {
19421             "group": "Body",
19422             "type": "String",
19423             "optional": true,
19424             "field": "reason",
19425             "description": ""
19426           }
19427         ]
19428       }
19429     },
19430     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19431     "version": "0.0.0",
19432     "filename": "server/api/openchannelQueueReport/index.js",
19433     "groupTitle": "Openchannel_Queue_Reports"
19434   },
19435   {
19436     "type": "delete",
19437     "url": "/api/openchannel/reports/queue/{id}",
19438     "title": "Deletes a Openchannel Queue Report",
19439     "examples": [
19440       {
19441         "title": "Example usage:",
19442         "content": "curl https://{domain}/api/openchannel/reports/queue/{id} -v -u {name}:{password} -X DELETE",
19443         "type": "json"
19444       }
19445     ],
19446     "name": "DeleteOpenchannel_Queue_Reports",
19447     "group": "Openchannel_Queue_Reports",
19448     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19449     "version": "0.0.0",
19450     "filename": "server/api/openchannelQueueReport/index.js",
19451     "groupTitle": "Openchannel_Queue_Reports"
19452   },
19453   {
19454     "type": "get",
19455     "url": "/api/openchannel/reports/queue/describe",
19456     "title": "Gets table info about Openchannel Queue Reports",
19457     "examples": [
19458       {
19459         "title": "Example usage:",
19460         "content": "curl https://{domain}/api/openchannel/reports/queue/describe -v -u {name}:{password}",
19461         "type": "json"
19462       }
19463     ],
19464     "name": "DescribeOpenchannel_Queue_Reports",
19465     "group": "Openchannel_Queue_Reports",
19466     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19467     "version": "0.0.0",
19468     "filename": "server/api/openchannelQueueReport/index.js",
19469     "groupTitle": "Openchannel_Queue_Reports"
19470   },
19471   {
19472     "type": "get",
19473     "url": "/api/openchannel/reports/queue",
19474     "title": "Gets a list of Openchannel Queue Reports",
19475     "examples": [
19476       {
19477         "title": "Example usage:",
19478         "content": "curl https://{domain}/api/openchannel/reports/queue -v -u {name}:{password}",
19479         "type": "json"
19480       }
19481     ],
19482     "name": "GetOpenchannel_Queue_Reports",
19483     "group": "Openchannel_Queue_Reports",
19484     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
19485     "version": "0.0.0",
19486     "filename": "server/api/openchannelQueueReport/index.js",
19487     "groupTitle": "Openchannel_Queue_Reports"
19488   },
19489   {
19490     "type": "get",
19491     "url": "/api/openchannel/reports/queue/{id}",
19492     "title": "Gets a single Openchannel Queue Report",
19493     "examples": [
19494       {
19495         "title": "Example usage:",
19496         "content": "curl https://{domain}/api/openchannel/reports/queue/{id} -v -u {name}:{password}",
19497         "type": "json"
19498       }
19499     ],
19500     "name": "ShowOpenchannel_Queue_Reports",
19501     "group": "Openchannel_Queue_Reports",
19502     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19503     "version": "0.0.0",
19504     "filename": "server/api/openchannelQueueReport/index.js",
19505     "groupTitle": "Openchannel_Queue_Reports"
19506   },
19507   {
19508     "type": "put",
19509     "url": "/api/openchannel/reports/queue/{id}",
19510     "title": "Update an existing Openchannel Queue Report",
19511     "examples": [
19512       {
19513         "title": "Example usage:",
19514         "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",
19515         "type": "json"
19516       }
19517     ],
19518     "name": "updateOpenchannel_Queue_Reports",
19519     "group": "Openchannel_Queue_Reports",
19520     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19521     "version": "0.0.0",
19522     "filename": "server/api/openchannelQueueReport/index.js",
19523     "groupTitle": "Openchannel_Queue_Reports"
19524   },
19525   {
19526     "type": "post",
19527     "url": "/api/openchannel/queues/{id}/users",
19528     "title": "Add agents to a queue",
19529     "examples": [
19530       {
19531         "title": "Example usage:",
19532         "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",
19533         "type": "json"
19534       }
19535     ],
19536     "name": "AddAgents",
19537     "group": "Openchannel_Queues",
19538     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19539     "version": "0.0.0",
19540     "filename": "server/api/openchannelQueue/index.js",
19541     "groupTitle": "Openchannel_Queues"
19542   },
19543   {
19544     "type": "post",
19545     "url": "/api/openchannel/queues/{id}/teams",
19546     "title": "Add teams to a queue",
19547     "examples": [
19548       {
19549         "title": "Example usage:",
19550         "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",
19551         "type": "json"
19552       }
19553     ],
19554     "name": "AddTeams",
19555     "group": "Openchannel_Queues",
19556     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19557     "version": "0.0.0",
19558     "filename": "server/api/openchannelQueue/index.js",
19559     "groupTitle": "Openchannel_Queues"
19560   },
19561   {
19562     "type": "post",
19563     "url": "/api/openchannel/queues",
19564     "title": "Creates a new Queue",
19565     "examples": [
19566       {
19567         "title": "Example usage:",
19568         "content": "curl https://{domain}/api/openchannel/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
19569         "type": "json"
19570       }
19571     ],
19572     "name": "CreateQueues",
19573     "group": "Openchannel_Queues",
19574     "parameter": {
19575       "fields": {
19576         "Body": [
19577           {
19578             "group": "Body",
19579             "type": "String",
19580             "optional": true,
19581             "field": "name",
19582             "description": ""
19583           },
19584           {
19585             "group": "Body",
19586             "type": "String",
19587             "optional": true,
19588             "field": "description",
19589             "description": ""
19590           },
19591           {
19592             "group": "Body",
19593             "type": "Integer",
19594             "optional": true,
19595             "field": "timeout",
19596             "description": ""
19597           },
19598           {
19599             "group": "Body",
19600             "type": "String",
19601             "allowedValues": [
19602               "\"rrmemory\"",
19603               "\"beepall\"",
19604               "\"roundrobin\""
19605             ],
19606             "optional": true,
19607             "field": "strategy",
19608             "description": ""
19609           }
19610         ]
19611       }
19612     },
19613     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19614     "version": "0.0.0",
19615     "filename": "server/api/openchannelQueue/index.js",
19616     "groupTitle": "Openchannel_Queues"
19617   },
19618   {
19619     "type": "delete",
19620     "url": "/api/openchannel/queues/{id}",
19621     "title": "Deletes a Queue",
19622     "examples": [
19623       {
19624         "title": "Example usage:",
19625         "content": "curl https://{domain}/api/openchannel/queues/{id} -v -u {name}:{password} -X DELETE",
19626         "type": "json"
19627       }
19628     ],
19629     "name": "DeleteQueues",
19630     "group": "Openchannel_Queues",
19631     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19632     "version": "0.0.0",
19633     "filename": "server/api/openchannelQueue/index.js",
19634     "groupTitle": "Openchannel_Queues"
19635   },
19636   {
19637     "type": "get",
19638     "url": "/api/openchannel/queues/describe",
19639     "title": "Gets table info about Queues",
19640     "examples": [
19641       {
19642         "title": "Example usage:",
19643         "content": "curl https://{domain}/api/openchannel/queues/describe -v -u {name}:{password}",
19644         "type": "json"
19645       }
19646     ],
19647     "name": "DescribeQueues",
19648     "group": "Openchannel_Queues",
19649     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19650     "version": "0.0.0",
19651     "filename": "server/api/openchannelQueue/index.js",
19652     "groupTitle": "Openchannel_Queues"
19653   },
19654   {
19655     "type": "get",
19656     "url": "/api/openchannel/queues/{id}/users",
19657     "title": "Gets queue agents",
19658     "examples": [
19659       {
19660         "title": "Example usage:",
19661         "content": "curl https://{domain}/api/openchannel/queues/{id}/users -v -u {name}:{password} -X POST",
19662         "type": "json"
19663       }
19664     ],
19665     "name": "GetAgents",
19666     "group": "Openchannel_Queues",
19667     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19668     "version": "0.0.0",
19669     "filename": "server/api/openchannelQueue/index.js",
19670     "groupTitle": "Openchannel_Queues"
19671   },
19672   {
19673     "type": "get",
19674     "url": "/api/openchannel/queues/{id}/members",
19675     "title": "GetMembers",
19676     "examples": [
19677       {
19678         "title": "Example usage:",
19679         "content": "curl https://{domain}/api/openchannel/queues/{id}/members  -v -u {name}:{password}",
19680         "type": "json"
19681       }
19682     ],
19683     "name": "GetMembers",
19684     "group": "Openchannel_Queues",
19685     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19686     "version": "0.0.0",
19687     "filename": "server/api/openchannelQueue/index.js",
19688     "groupTitle": "Openchannel_Queues"
19689   },
19690   {
19691     "type": "get",
19692     "url": "/api/openchannel/queues",
19693     "title": "Gets a list of Queues",
19694     "examples": [
19695       {
19696         "title": "Example usage:",
19697         "content": "curl https://{domain}/api/openchannel/queues -v -u {name}:{password}",
19698         "type": "json"
19699       }
19700     ],
19701     "name": "GetQueues",
19702     "group": "Openchannel_Queues",
19703     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
19704     "version": "0.0.0",
19705     "filename": "server/api/openchannelQueue/index.js",
19706     "groupTitle": "Openchannel_Queues"
19707   },
19708   {
19709     "type": "get",
19710     "url": "/api/openchannel/queues/{id}/teams",
19711     "title": "Gets queues list",
19712     "examples": [
19713       {
19714         "title": "Example usage:",
19715         "content": "curl https://{domain}/api/openchannel/queues/{id}/teams -v -u {name}:{password}",
19716         "type": "json"
19717       }
19718     ],
19719     "name": "GetTeams",
19720     "group": "Openchannel_Queues",
19721     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19722     "version": "0.0.0",
19723     "filename": "server/api/openchannelQueue/index.js",
19724     "groupTitle": "Openchannel_Queues"
19725   },
19726   {
19727     "type": "delete",
19728     "url": "/api/openchannel/queues/{id}/users",
19729     "title": "Removes agents from a queue",
19730     "examples": [
19731       {
19732         "title": "Example usage:",
19733         "content": "curl https://{domain}/api/openchannel/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
19734         "type": "json"
19735       }
19736     ],
19737     "name": "RemoveAgents",
19738     "group": "Openchannel_Queues",
19739     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19740     "version": "0.0.0",
19741     "filename": "server/api/openchannelQueue/index.js",
19742     "groupTitle": "Openchannel_Queues"
19743   },
19744   {
19745     "type": "get",
19746     "url": "/api/openchannel/queues/{id}",
19747     "title": "Gets a single Queue",
19748     "examples": [
19749       {
19750         "title": "Example usage:",
19751         "content": "curl https://{domain}/api/openchannel/queues/{id} -v -u {name}:{password}",
19752         "type": "json"
19753       }
19754     ],
19755     "name": "ShowQueues",
19756     "group": "Openchannel_Queues",
19757     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19758     "version": "0.0.0",
19759     "filename": "server/api/openchannelQueue/index.js",
19760     "groupTitle": "Openchannel_Queues"
19761   },
19762   {
19763     "type": "put",
19764     "url": "/api/openchannel/queues/{id}",
19765     "title": "Update an existing Queue",
19766     "examples": [
19767       {
19768         "title": "Example usage:",
19769         "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",
19770         "type": "json"
19771       }
19772     ],
19773     "name": "updateQueues",
19774     "group": "Openchannel_Queues",
19775     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19776     "version": "0.0.0",
19777     "filename": "server/api/openchannelQueue/index.js",
19778     "groupTitle": "Openchannel_Queues"
19779   },
19780   {
19781     "type": "post",
19782     "url": "/api/openchannel/reports/transfer",
19783     "title": "Creates a new Openchannel Transfer Report",
19784     "examples": [
19785       {
19786         "title": "Example usage:",
19787         "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",
19788         "type": "json"
19789       }
19790     ],
19791     "name": "CreateOpenchannel_Transfer_Reports",
19792     "group": "Openchannel_Transfer_Reports",
19793     "parameter": {
19794       "fields": {
19795         "Body": [
19796           {
19797             "group": "Body",
19798             "type": "String",
19799             "optional": false,
19800             "field": "uniqueid",
19801             "description": ""
19802           },
19803           {
19804             "group": "Body",
19805             "type": "String",
19806             "allowedValues": [
19807               "\"account\"",
19808               "\"agent\"",
19809               "\"queue\""
19810             ],
19811             "optional": false,
19812             "field": "type",
19813             "description": ""
19814           },
19815           {
19816             "group": "Body",
19817             "type": "String",
19818             "optional": false,
19819             "field": "transferredAt",
19820             "description": ""
19821           }
19822         ]
19823       }
19824     },
19825     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19826     "version": "0.0.0",
19827     "filename": "server/api/openchannelTransferReport/index.js",
19828     "groupTitle": "Openchannel_Transfer_Reports"
19829   },
19830   {
19831     "type": "delete",
19832     "url": "/api/openchannel/reports/transfer/{id}",
19833     "title": "Deletes a Openchannel Transfer Report",
19834     "examples": [
19835       {
19836         "title": "Example usage:",
19837         "content": "curl https://{domain}/api/openchannel/reports/transfer/{id} -v -u {name}:{password} -X DELETE",
19838         "type": "json"
19839       }
19840     ],
19841     "name": "DeleteOpenchannel_Transfer_Reports",
19842     "group": "Openchannel_Transfer_Reports",
19843     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19844     "version": "0.0.0",
19845     "filename": "server/api/openchannelTransferReport/index.js",
19846     "groupTitle": "Openchannel_Transfer_Reports"
19847   },
19848   {
19849     "type": "get",
19850     "url": "/api/openchannel/reports/transfer/describe",
19851     "title": "Gets table info about Openchannel Transfer Reports",
19852     "examples": [
19853       {
19854         "title": "Example usage:",
19855         "content": "curl https://{domain}/api/openchannel/reports/transfer/describe -v -u {name}:{password}",
19856         "type": "json"
19857       }
19858     ],
19859     "name": "DescribeOpenchannel_Transfer_Reports",
19860     "group": "Openchannel_Transfer_Reports",
19861     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19862     "version": "0.0.0",
19863     "filename": "server/api/openchannelTransferReport/index.js",
19864     "groupTitle": "Openchannel_Transfer_Reports"
19865   },
19866   {
19867     "type": "get",
19868     "url": "/api/openchannel/reports/transfer",
19869     "title": "Gets a list of Openchannel Transfer Reports",
19870     "examples": [
19871       {
19872         "title": "Example usage:",
19873         "content": "curl https://{domain}/api/openchannel/reports/transfer -v -u {name}:{password}",
19874         "type": "json"
19875       }
19876     ],
19877     "name": "GetOpenchannel_Transfer_Reports",
19878     "group": "Openchannel_Transfer_Reports",
19879     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
19880     "version": "0.0.0",
19881     "filename": "server/api/openchannelTransferReport/index.js",
19882     "groupTitle": "Openchannel_Transfer_Reports"
19883   },
19884   {
19885     "type": "get",
19886     "url": "/api/openchannel/reports/transfer/{id}",
19887     "title": "Gets a single Openchannel Transfer Report",
19888     "examples": [
19889       {
19890         "title": "Example usage:",
19891         "content": "curl https://{domain}/api/openchannel/reports/transfer/{id} -v -u {name}:{password}",
19892         "type": "json"
19893       }
19894     ],
19895     "name": "ShowOpenchannel_Transfer_Reports",
19896     "group": "Openchannel_Transfer_Reports",
19897     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19898     "version": "0.0.0",
19899     "filename": "server/api/openchannelTransferReport/index.js",
19900     "groupTitle": "Openchannel_Transfer_Reports"
19901   },
19902   {
19903     "type": "put",
19904     "url": "/api/openchannel/reports/transfer/{id}",
19905     "title": "Update an existing Openchannel Transfer Report",
19906     "examples": [
19907       {
19908         "title": "Example usage:",
19909         "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",
19910         "type": "json"
19911       }
19912     ],
19913     "name": "updateOpenchannel_Transfer_Reports",
19914     "group": "Openchannel_Transfer_Reports",
19915     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19916     "version": "0.0.0",
19917     "filename": "server/api/openchannelTransferReport/index.js",
19918     "groupTitle": "Openchannel_Transfer_Reports"
19919   },
19920   {
19921     "type": "post",
19922     "url": "/api/pauses",
19923     "title": "Creates a new Pause",
19924     "examples": [
19925       {
19926         "title": "Example usage:",
19927         "content": "curl https://{domain}/api/pauses -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
19928         "type": "json"
19929       }
19930     ],
19931     "name": "CreatePauses",
19932     "group": "Pauses",
19933     "parameter": {
19934       "fields": {
19935         "Body": [
19936           {
19937             "group": "Body",
19938             "type": "String",
19939             "optional": false,
19940             "field": "name",
19941             "description": ""
19942           },
19943           {
19944             "group": "Body",
19945             "type": "String",
19946             "optional": true,
19947             "field": "description",
19948             "description": ""
19949           }
19950         ]
19951       }
19952     },
19953     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19954     "version": "0.0.0",
19955     "filename": "server/api/pause/index.js",
19956     "groupTitle": "Pauses"
19957   },
19958   {
19959     "type": "delete",
19960     "url": "/api/pauses/{id}",
19961     "title": "Deletes a Pause",
19962     "examples": [
19963       {
19964         "title": "Example usage:",
19965         "content": "curl https://{domain}/api/pauses/{id} -v -u {name}:{password} -X DELETE",
19966         "type": "json"
19967       }
19968     ],
19969     "name": "DeletePauses",
19970     "group": "Pauses",
19971     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19972     "version": "0.0.0",
19973     "filename": "server/api/pause/index.js",
19974     "groupTitle": "Pauses"
19975   },
19976   {
19977     "type": "get",
19978     "url": "/api/pauses",
19979     "title": "Gets a list of Pauses",
19980     "examples": [
19981       {
19982         "title": "Example usage:",
19983         "content": "curl https://{domain}/api/pauses -v -u {name}:{password}",
19984         "type": "json"
19985       }
19986     ],
19987     "name": "GetPauses",
19988     "group": "Pauses",
19989     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
19990     "version": "0.0.0",
19991     "filename": "server/api/pause/index.js",
19992     "groupTitle": "Pauses"
19993   },
19994   {
19995     "type": "get",
19996     "url": "/api/pauses/{id}",
19997     "title": "Gets a single Pause",
19998     "examples": [
19999       {
20000         "title": "Example usage:",
20001         "content": "curl https://{domain}/api/pauses/{id} -v -u {name}:{password}",
20002         "type": "json"
20003       }
20004     ],
20005     "name": "ShowPauses",
20006     "group": "Pauses",
20007     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20008     "version": "0.0.0",
20009     "filename": "server/api/pause/index.js",
20010     "groupTitle": "Pauses"
20011   },
20012   {
20013     "type": "put",
20014     "url": "/api/pauses/{id}",
20015     "title": "Update an existing Pause",
20016     "examples": [
20017       {
20018         "title": "Example usage:",
20019         "content": "curl https://{domain}/api/pauses/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
20020         "type": "json"
20021       }
20022     ],
20023     "name": "updatePauses",
20024     "group": "Pauses",
20025     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20026     "version": "0.0.0",
20027     "filename": "server/api/pause/index.js",
20028     "groupTitle": "Pauses"
20029   },
20030   {
20031     "type": "get",
20032     "url": "/api/plugins",
20033     "title": "Gets a list of Plugins",
20034     "examples": [
20035       {
20036         "title": "Example usage:",
20037         "content": "curl https://{domain}/api/plugins -v -u {name}:{password}",
20038         "type": "json"
20039       }
20040     ],
20041     "name": "GetPlugins",
20042     "group": "Plugins",
20043     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
20044     "version": "0.0.0",
20045     "filename": "server/api/plugin/index.js",
20046     "groupTitle": "Plugins"
20047   },
20048   {
20049     "type": "get",
20050     "url": "/api/plugins/{id}",
20051     "title": "Gets a single Plugin",
20052     "examples": [
20053       {
20054         "title": "Example usage:",
20055         "content": "curl https://{domain}/api/plugins/{id} -v -u {name}:{password}",
20056         "type": "json"
20057       }
20058     ],
20059     "name": "ShowPlugins",
20060     "group": "Plugins",
20061     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20062     "version": "0.0.0",
20063     "filename": "server/api/plugin/index.js",
20064     "groupTitle": "Plugins"
20065   },
20066   {
20067     "type": "delete",
20068     "url": "/api/plugins/{id}",
20069     "title": "Delete a plugin",
20070     "examples": [
20071       {
20072         "title": "Example usage:",
20073         "content": "curl https://{domain}/api/plugins/{id} -v -u {name}:{password} -X DELETE",
20074         "type": "json"
20075       }
20076     ],
20077     "name": "destroyPlugin",
20078     "group": "Plugins",
20079     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20080     "version": "0.0.0",
20081     "filename": "server/api/plugin/index.js",
20082     "groupTitle": "Plugins"
20083   },
20084   {
20085     "type": "get",
20086     "url": "/api/plugins/{id}/download",
20087     "title": "Download plugin source code",
20088     "examples": [
20089       {
20090         "title": "Example usage:",
20091         "content": "curl https://{domain}/api/plugins/{id}/download -v -u {name}:{password} -X GET",
20092         "type": "json"
20093       }
20094     ],
20095     "name": "download",
20096     "group": "Plugins",
20097     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20098     "version": "0.0.0",
20099     "filename": "server/api/plugin/index.js",
20100     "groupTitle": "Plugins"
20101   },
20102   {
20103     "type": "put",
20104     "url": "/api/plugins/{id}",
20105     "title": "Update an existing plugin",
20106     "examples": [
20107       {
20108         "title": "Example usage:",
20109         "content": "curl https://{domain}/api/plugins/{id} -v -u {name}:{password} -X PUT",
20110         "type": "json"
20111       }
20112     ],
20113     "name": "updatePlugin",
20114     "group": "Plugins",
20115     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20116     "version": "0.0.0",
20117     "filename": "server/api/plugin/index.js",
20118     "groupTitle": "Plugins"
20119   },
20120   {
20121     "type": "post",
20122     "url": "/api/plugins",
20123     "title": "Upload new plugin",
20124     "examples": [
20125       {
20126         "title": "Example usage:",
20127         "content": "curl https://{domain}/api/plugins -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
20128         "type": "json"
20129       }
20130     ],
20131     "name": "uploadPlugin",
20132     "group": "Plugins",
20133     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20134     "version": "0.0.0",
20135     "filename": "server/api/plugin/index.js",
20136     "groupTitle": "Plugins"
20137   },
20138   {
20139     "type": "get",
20140     "url": "/api/plugins/webhook?hostname={host}&port={port}&encoding={encoding}&json={json}&path={path}",
20141     "title": "Redirect a plugin request to the specified path",
20142     "examples": [
20143       {
20144         "title": "Example usage:",
20145         "content": "curl https://{domain}/api/plugins/webhook?port={port}&path={path} -v -u {name}:{password} -X GET",
20146         "type": "json"
20147       }
20148     ],
20149     "name": "webhookPlugin",
20150     "group": "Plugins",
20151     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20152     "version": "0.0.0",
20153     "filename": "server/api/plugin/index.js",
20154     "groupTitle": "Plugins"
20155   },
20156   {
20157     "type": "post",
20158     "url": "/api/plugins/webhook?hostname={host}&port={port}&encoding={encoding}&json={json}&path={path}",
20159     "title": "Redirect a plugin request to the specified path",
20160     "examples": [
20161       {
20162         "title": "Example usage:",
20163         "content": "curl https://{domain}/api/plugins/webhook?port={port}&path={path} -H 'Content-Type: application/json' -X POST",
20164         "type": "json"
20165       }
20166     ],
20167     "name": "webhookPlugin",
20168     "group": "Plugins",
20169     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20170     "version": "0.0.0",
20171     "filename": "server/api/plugin/index.js",
20172     "groupTitle": "Plugins"
20173   },
20174   {
20175     "type": "delete",
20176     "url": "/api/pm2/{id}",
20177     "title": "Deletes an existing process",
20178     "examples": [
20179       {
20180         "title": "Example usage:",
20181         "content": "curl https://{domain}/api/pm2/{id} -v -u {name}:{password} -X DELETE",
20182         "type": "json"
20183       }
20184     ],
20185     "name": "DeletePm2Process",
20186     "group": "Pm2",
20187     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20188     "version": "0.0.0",
20189     "filename": "server/api/pm2/index.js",
20190     "groupTitle": "Pm2"
20191   },
20192   {
20193     "type": "get",
20194     "url": "/api/pm2/{id}",
20195     "title": "Gets a single pm2 process",
20196     "examples": [
20197       {
20198         "title": "Example usage:",
20199         "content": "curl https://{domain}/api/pm2/{id} -v -u {name}:{password}",
20200         "type": "json"
20201       }
20202     ],
20203     "name": "GetPm2Process",
20204     "group": "Pm2",
20205     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20206     "version": "0.0.0",
20207     "filename": "server/api/pm2/index.js",
20208     "groupTitle": "Pm2"
20209   },
20210   {
20211     "type": "get",
20212     "url": "/api/pm2",
20213     "title": "Gets pm2 processes",
20214     "examples": [
20215       {
20216         "title": "Example usage:",
20217         "content": "curl https://{domain}/api/pm2 -v -u {name}:{password}",
20218         "type": "json"
20219       }
20220     ],
20221     "name": "GetPm2Processes",
20222     "group": "Pm2",
20223     "description": "<p>Motion returns the pm2 processes list.</p>",
20224     "version": "0.0.0",
20225     "filename": "server/api/pm2/index.js",
20226     "groupTitle": "Pm2"
20227   },
20228   {
20229     "type": "post",
20230     "url": "/api/pm2",
20231     "title": "Start a single pm2 process",
20232     "examples": [
20233       {
20234         "title": "Example usage:",
20235         "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",
20236         "type": "json"
20237       }
20238     ],
20239     "name": "StartPm2Process",
20240     "group": "Pm2",
20241     "parameter": {
20242       "fields": {
20243         "Body": [
20244           {
20245             "group": "Body",
20246             "type": "String",
20247             "optional": false,
20248             "field": "name",
20249             "description": ""
20250           },
20251           {
20252             "group": "Body",
20253             "type": "String",
20254             "optional": false,
20255             "field": "script",
20256             "description": ""
20257           }
20258         ]
20259       }
20260     },
20261     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20262     "version": "0.0.0",
20263     "filename": "server/api/pm2/index.js",
20264     "groupTitle": "Pm2"
20265   },
20266   {
20267     "type": "put",
20268     "url": "/api/pm2/{id}",
20269     "title": "Update an existing process",
20270     "examples": [
20271       {
20272         "title": "Example usage:",
20273         "content": "curl https://{domain}/api/pm2/{id} -d '{\"status\": \"online\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
20274         "type": "json"
20275       }
20276     ],
20277     "name": "UpdatePm2Process",
20278     "group": "Pm2",
20279     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20280     "version": "0.0.0",
20281     "filename": "server/api/pm2/index.js",
20282     "groupTitle": "Pm2"
20283   },
20284   {
20285     "type": "get",
20286     "url": "/api/rpc/campaigns/",
20287     "title": "Gets a list of campaigns",
20288     "examples": [
20289       {
20290         "title": "Example usage:",
20291         "content": "curl https://{domain}/api/rpc/campaigns -v -u {name}:{password}",
20292         "type": "json"
20293       }
20294     ],
20295     "name": "Campaigns",
20296     "group": "RPC_Realtime",
20297     "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>",
20298     "version": "0.0.0",
20299     "filename": "server/api/rpc/index.js",
20300     "groupTitle": "RPC_Realtime"
20301   },
20302   {
20303     "type": "get",
20304     "url": "/api/rpc/fax/accounts",
20305     "title": "Gets a list of FaxAccounts",
20306     "examples": [
20307       {
20308         "title": "Example usage:",
20309         "content": "curl https://{domain}/api/rpc/fax/accounts -v -u {name}:{password}",
20310         "type": "json"
20311       }
20312     ],
20313     "name": "FaxAccounts",
20314     "group": "RPC_Realtime",
20315     "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>",
20316     "version": "0.0.0",
20317     "filename": "server/api/rpc/index.js",
20318     "groupTitle": "RPC_Realtime"
20319   },
20320   {
20321     "type": "put",
20322     "url": "/api/rpc/agents/:id/capacity",
20323     "title": "Sets agent capacity",
20324     "examples": [
20325       {
20326         "title": "Example usage:",
20327         "content": "curl https://{domain}/api/rpc/agents/:id/capacity -v -u {name}:{password}",
20328         "type": "json"
20329       }
20330     ],
20331     "name": "RTAgentCapacity",
20332     "group": "RPC_Realtime",
20333     "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>",
20334     "version": "0.0.0",
20335     "filename": "server/api/rpc/index.js",
20336     "groupTitle": "RPC_Realtime"
20337   },
20338   {
20339     "type": "get",
20340     "url": "/api/rpc/agents",
20341     "title": "Gets a list of RTAgents",
20342     "examples": [
20343       {
20344         "title": "Example usage:",
20345         "content": "curl https://{domain}/api/rpc/agents -v -u {name}:{password}",
20346         "type": "json"
20347       }
20348     ],
20349     "name": "RTAgents",
20350     "group": "RPC_Realtime",
20351     "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>",
20352     "version": "0.0.0",
20353     "filename": "server/api/rpc/index.js",
20354     "groupTitle": "RPC_Realtime"
20355   },
20356   {
20357     "type": "get",
20358     "url": "/api/rpc/chat/queues",
20359     "title": "Gets a list of RTChatQueues",
20360     "examples": [
20361       {
20362         "title": "Example usage:",
20363         "content": "curl https://{domain}/api/rpc/chat/queues -v -u {name}:{password}",
20364         "type": "json"
20365       }
20366     ],
20367     "name": "RTChatQueues",
20368     "group": "RPC_Realtime",
20369     "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>",
20370     "version": "0.0.0",
20371     "filename": "server/api/rpc/index.js",
20372     "groupTitle": "RPC_Realtime"
20373   },
20374   {
20375     "type": "get",
20376     "url": "/api/rpc/fax/queues",
20377     "title": "Gets a list of RTFaxQueues",
20378     "examples": [
20379       {
20380         "title": "Example usage:",
20381         "content": "curl https://{domain}/api/rpc/fax/queues -v -u {name}:{password}",
20382         "type": "json"
20383       }
20384     ],
20385     "name": "RTFaxQueues",
20386     "group": "RPC_Realtime",
20387     "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>",
20388     "version": "0.0.0",
20389     "filename": "server/api/rpc/index.js",
20390     "groupTitle": "RPC_Realtime"
20391   },
20392   {
20393     "type": "get",
20394     "url": "/api/rpc/mail/accounts",
20395     "title": "Gets a list of RTMailAccounts",
20396     "examples": [
20397       {
20398         "title": "Example usage:",
20399         "content": "curl https://{domain}/api/rpc/mail/accounts -v -u {name}:{password}",
20400         "type": "json"
20401       }
20402     ],
20403     "name": "RTMailAccounts",
20404     "group": "RPC_Realtime",
20405     "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>",
20406     "version": "0.0.0",
20407     "filename": "server/api/rpc/index.js",
20408     "groupTitle": "RPC_Realtime"
20409   },
20410   {
20411     "type": "get",
20412     "url": "/api/rpc/mail/queues",
20413     "title": "Gets a list of RTMailQueues",
20414     "examples": [
20415       {
20416         "title": "Example usage:",
20417         "content": "curl https://{domain}/api/rpc/mail/queues -v -u {name}:{password}",
20418         "type": "json"
20419       }
20420     ],
20421     "name": "RTMailQueues",
20422     "group": "RPC_Realtime",
20423     "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>",
20424     "version": "0.0.0",
20425     "filename": "server/api/rpc/index.js",
20426     "groupTitle": "RPC_Realtime"
20427   },
20428   {
20429     "type": "get",
20430     "url": "/api/rpc/openchannel/queues",
20431     "title": "Gets a list of RTOpenchannelQueues",
20432     "examples": [
20433       {
20434         "title": "Example usage:",
20435         "content": "curl https://{domain}/api/rpc/openchannel/queues -v -u {name}:{password}",
20436         "type": "json"
20437       }
20438     ],
20439     "name": "RTOpenchannelQueues",
20440     "group": "RPC_Realtime",
20441     "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>",
20442     "version": "0.0.0",
20443     "filename": "server/api/rpc/index.js",
20444     "groupTitle": "RPC_Realtime"
20445   },
20446   {
20447     "type": "get",
20448     "url": "/api/rpc/outbound/channels",
20449     "title": "Gets a list of RTOutboundChannels",
20450     "examples": [
20451       {
20452         "title": "Example usage:",
20453         "content": "curl https://{domain}/api/rpc/outbound/channels -v -u {name}:{password}",
20454         "type": "json"
20455       }
20456     ],
20457     "name": "RTOutboundChannels",
20458     "group": "RPC_Realtime",
20459     "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>",
20460     "version": "0.0.0",
20461     "filename": "server/api/rpc/index.js",
20462     "groupTitle": "RPC_Realtime"
20463   },
20464   {
20465     "type": "get",
20466     "url": "/api/rpc/sms/queues",
20467     "title": "Gets a list of RTSmsQueues",
20468     "examples": [
20469       {
20470         "title": "Example usage:",
20471         "content": "curl https://{domain}/api/rpc/sms/queues -v -u {name}:{password}",
20472         "type": "json"
20473       }
20474     ],
20475     "name": "RTSmsQueues",
20476     "group": "RPC_Realtime",
20477     "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>",
20478     "version": "0.0.0",
20479     "filename": "server/api/rpc/index.js",
20480     "groupTitle": "RPC_Realtime"
20481   },
20482   {
20483     "type": "get",
20484     "url": "/api/rpc/telephones",
20485     "title": "Gets a list of RTTelephones",
20486     "examples": [
20487       {
20488         "title": "Example usage:",
20489         "content": "curl https://{domain}/api/rpc/telephones -v -u {name}:{password}",
20490         "type": "json"
20491       }
20492     ],
20493     "name": "RTTelephones",
20494     "group": "RPC_Realtime",
20495     "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>",
20496     "version": "0.0.0",
20497     "filename": "server/api/rpc/index.js",
20498     "groupTitle": "RPC_Realtime"
20499   },
20500   {
20501     "type": "get",
20502     "url": "/api/rpc/trunks",
20503     "title": "Gets a list of RTTrunks",
20504     "examples": [
20505       {
20506         "title": "Example usage:",
20507         "content": "curl https://{domain}/api/rpc/trunks -v -u {name}:{password}",
20508         "type": "json"
20509       }
20510     ],
20511     "name": "RTTrunks",
20512     "group": "RPC_Realtime",
20513     "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>",
20514     "version": "0.0.0",
20515     "filename": "server/api/rpc/index.js",
20516     "groupTitle": "RPC_Realtime"
20517   },
20518   {
20519     "type": "get",
20520     "url": "/api/rpc/voice/channels",
20521     "title": "Gets a list of RTVoiceChannelMixMonitor",
20522     "examples": [
20523       {
20524         "title": "Example usage:",
20525         "content": "curl https://{domain}/api/rpc/voice/channels/{uniqueid}/mixmonitor -v -u {name}:{password}",
20526         "type": "json"
20527       }
20528     ],
20529     "name": "RTVoiceChannelMixMonitor",
20530     "group": "RPC_Realtime",
20531     "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>",
20532     "version": "0.0.0",
20533     "filename": "server/api/rpc/index.js",
20534     "groupTitle": "RPC_Realtime"
20535   },
20536   {
20537     "type": "get",
20538     "url": "/api/rpc/voice/channels",
20539     "title": "Gets a list of RTVoiceChannelStopMixMonitor",
20540     "examples": [
20541       {
20542         "title": "Example usage:",
20543         "content": "curl https://{domain}/api/rpc/voice/channels/{uniqueid}/stopmixmonitor -v -u {name}:{password}",
20544         "type": "json"
20545       }
20546     ],
20547     "name": "RTVoiceChannelStopMixMonitor",
20548     "group": "RPC_Realtime",
20549     "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>",
20550     "version": "0.0.0",
20551     "filename": "server/api/rpc/index.js",
20552     "groupTitle": "RPC_Realtime"
20553   },
20554   {
20555     "type": "get",
20556     "url": "/api/rpc/voice/channels",
20557     "title": "Gets a list of RTVoiceChannels",
20558     "examples": [
20559       {
20560         "title": "Example usage:",
20561         "content": "curl https://{domain}/api/rpc/voice/channels -v -u {name}:{password}",
20562         "type": "json"
20563       }
20564     ],
20565     "name": "RTVoiceChannels",
20566     "group": "RPC_Realtime",
20567     "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>",
20568     "version": "0.0.0",
20569     "filename": "server/api/rpc/index.js",
20570     "groupTitle": "RPC_Realtime"
20571   },
20572   {
20573     "type": "get",
20574     "url": "/api/rpc/voice/queues/channels/{uniqueid}",
20575     "title": "Gets a single RTVoiceQueueChannel",
20576     "examples": [
20577       {
20578         "title": "Example usage:",
20579         "content": "curl https://{domain}/api/rpc/voice/queues/channels/{uniqueid} -v -u {name}:{password}",
20580         "type": "json"
20581       }
20582     ],
20583     "name": "RTVoiceQueueChannel",
20584     "group": "RPC_Realtime",
20585     "description": "<p>Motion will return a specific realtime voice queue channel.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20586     "version": "0.0.0",
20587     "filename": "server/api/rpc/index.js",
20588     "groupTitle": "RPC_Realtime"
20589   },
20590   {
20591     "type": "get",
20592     "url": "/api/rpc/voice/queues/channels/{uniqueid}/hangup",
20593     "title": "Hangup a single RTVoiceQueueChannel",
20594     "examples": [
20595       {
20596         "title": "Example usage:",
20597         "content": "curl https://{domain}/api/rpc/voice/queues/channels/{uniqueid}/hangup -v -u {name}:{password}",
20598         "type": "json"
20599       }
20600     ],
20601     "name": "RTVoiceQueueChannelHangup",
20602     "group": "RPC_Realtime",
20603     "description": "<p>Motion will hangup a specific realtime voice queue channel.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20604     "version": "0.0.0",
20605     "filename": "server/api/rpc/index.js",
20606     "groupTitle": "RPC_Realtime"
20607   },
20608   {
20609     "type": "get",
20610     "url": "/api/rpc/voice/queues/channels/{uniqueid}/redirect/{exten}",
20611     "title": "Hangup a single RTVoiceQueueChannel",
20612     "examples": [
20613       {
20614         "title": "Example usage:",
20615         "content": "curl https://{domain}/api/rpc/voice/queues/channels/{uniqueid}/redirect/{exten} -v -u {name}:{password}",
20616         "type": "json"
20617       }
20618     ],
20619     "name": "RTVoiceQueueChannelRedirect",
20620     "group": "RPC_Realtime",
20621     "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>",
20622     "version": "0.0.0",
20623     "filename": "server/api/rpc/index.js",
20624     "groupTitle": "RPC_Realtime"
20625   },
20626   {
20627     "type": "get",
20628     "url": "/api/rpc/voice/queues/preview/{id}",
20629     "title": "Gets a single preview contact",
20630     "examples": [
20631       {
20632         "title": "Example usage:",
20633         "content": "curl https://{domain}/api/rpc/voice/queues/preview/{id} -v -u {name}:{password}",
20634         "type": "json"
20635       }
20636     ],
20637     "name": "RTVoiceQueuePreview",
20638     "group": "RPC_Realtime",
20639     "description": "<p>Motion will return a specific preview contact.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20640     "version": "0.0.0",
20641     "filename": "server/api/rpc/index.js",
20642     "groupTitle": "RPC_Realtime"
20643   },
20644   {
20645     "type": "get",
20646     "url": "/api/rpc/voice/queues",
20647     "title": "Gets a list of RTVoiceQueues",
20648     "examples": [
20649       {
20650         "title": "Example usage:",
20651         "content": "curl https://{domain}/api/rpc/voice/queues -v -u {name}:{password}",
20652         "type": "json"
20653       }
20654     ],
20655     "name": "RTVoiceQueues",
20656     "group": "RPC_Realtime",
20657     "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>",
20658     "version": "0.0.0",
20659     "filename": "server/api/rpc/index.js",
20660     "groupTitle": "RPC_Realtime"
20661   },
20662   {
20663     "type": "get",
20664     "url": "/api/rpc/outbound",
20665     "title": "Gets a list of RTOutbound",
20666     "examples": [
20667       {
20668         "title": "Example usage:",
20669         "content": "curl https://{domain}/api/rpc/outbound -v -u {name}:{password}",
20670         "type": "json"
20671       }
20672     ],
20673     "name": "RTVoiceQueues",
20674     "group": "RPC_Realtime",
20675     "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>",
20676     "version": "0.0.0",
20677     "filename": "server/api/rpc/index.js",
20678     "groupTitle": "RPC_Realtime"
20679   },
20680   {
20681     "type": "get",
20682     "url": "/api/rpc/voice/queues/channels",
20683     "title": "Gets a list of RTVoiceQueuesChannels",
20684     "examples": [
20685       {
20686         "title": "Example usage:",
20687         "content": "curl https://{domain}/api/rpc/voice/queues/channels -v -u {name}:{password}",
20688         "type": "json"
20689       }
20690     ],
20691     "name": "RTVoiceQueuesChannels",
20692     "group": "RPC_Realtime",
20693     "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>",
20694     "version": "0.0.0",
20695     "filename": "server/api/rpc/index.js",
20696     "groupTitle": "RPC_Realtime"
20697   },
20698   {
20699     "type": "get",
20700     "url": "/api/rpc/chat/queues/{id}",
20701     "title": "Gets a single RTChatQueue",
20702     "examples": [
20703       {
20704         "title": "Example usage:",
20705         "content": "curl https://{domain}/api/rpc/chat/queues/{id} -v -u {name}:{password}",
20706         "type": "json"
20707       }
20708     ],
20709     "name": "ShowRTChatQueues",
20710     "group": "RPC_Realtime",
20711     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20712     "version": "0.0.0",
20713     "filename": "server/api/rpc/index.js",
20714     "groupTitle": "RPC_Realtime"
20715   },
20716   {
20717     "type": "get",
20718     "url": "/api/rpc/fax/queues/{id}",
20719     "title": "Gets a single RTFaxQueue",
20720     "examples": [
20721       {
20722         "title": "Example usage:",
20723         "content": "curl https://{domain}/api/rpc/fax/queues/{id} -v -u {name}:{password}",
20724         "type": "json"
20725       }
20726     ],
20727     "name": "ShowRTFaxQueues",
20728     "group": "RPC_Realtime",
20729     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20730     "version": "0.0.0",
20731     "filename": "server/api/rpc/index.js",
20732     "groupTitle": "RPC_Realtime"
20733   },
20734   {
20735     "type": "get",
20736     "url": "/api/rpc/mail/queues/{id}",
20737     "title": "Gets a single RTMailQueue",
20738     "examples": [
20739       {
20740         "title": "Example usage:",
20741         "content": "curl https://{domain}/api/rpc/mail/queues/{id} -v -u {name}:{password}",
20742         "type": "json"
20743       }
20744     ],
20745     "name": "ShowRTMailQueues",
20746     "group": "RPC_Realtime",
20747     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20748     "version": "0.0.0",
20749     "filename": "server/api/rpc/index.js",
20750     "groupTitle": "RPC_Realtime"
20751   },
20752   {
20753     "type": "get",
20754     "url": "/api/rpc/openchannel/queues/{id}",
20755     "title": "Gets a single RTOpenchannelQueue",
20756     "examples": [
20757       {
20758         "title": "Example usage:",
20759         "content": "curl https://{domain}/api/rpc/openchannel/queues/{id} -v -u {name}:{password}",
20760         "type": "json"
20761       }
20762     ],
20763     "name": "ShowRTOpenchannelQueues",
20764     "group": "RPC_Realtime",
20765     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20766     "version": "0.0.0",
20767     "filename": "server/api/rpc/index.js",
20768     "groupTitle": "RPC_Realtime"
20769   },
20770   {
20771     "type": "get",
20772     "url": "/api/rpc/sms/queues/{id}",
20773     "title": "Gets a single RTSmsQueue",
20774     "examples": [
20775       {
20776         "title": "Example usage:",
20777         "content": "curl https://{domain}/api/rpc/sms/queues/{id} -v -u {name}:{password}",
20778         "type": "json"
20779       }
20780     ],
20781     "name": "ShowRTSmsQueues",
20782     "group": "RPC_Realtime",
20783     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20784     "version": "0.0.0",
20785     "filename": "server/api/rpc/index.js",
20786     "groupTitle": "RPC_Realtime"
20787   },
20788   {
20789     "type": "get",
20790     "url": "/api/rpc/voice/queues/{id}",
20791     "title": "Gets a single RTVoiceQueue",
20792     "examples": [
20793       {
20794         "title": "Example usage:",
20795         "content": "curl https://{domain}/api/rpc/voice/queues/{id} -v -u {name}:{password}",
20796         "type": "json"
20797       }
20798     ],
20799     "name": "ShowRTVoiceQueues",
20800     "group": "RPC_Realtime",
20801     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20802     "version": "0.0.0",
20803     "filename": "server/api/rpc/index.js",
20804     "groupTitle": "RPC_Realtime"
20805   },
20806   {
20807     "type": "put",
20808     "url": "/api/rpc/voice/{id}/queues",
20809     "title": "Updates a single VoiceQueue",
20810     "examples": [
20811       {
20812         "title": "Example usage:",
20813         "content": "curl https://{domain}/api/rpc/voice/queues/{id} -v -u {name}:{password}",
20814         "type": "json"
20815       }
20816     ],
20817     "name": "UpdateVoiceQueues",
20818     "group": "RPC_Realtime",
20819     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20820     "version": "0.0.0",
20821     "filename": "server/api/rpc/index.js",
20822     "groupTitle": "RPC_Realtime"
20823   },
20824   {
20825     "type": "post",
20826     "url": "/api/rpc/agents/:id/notify",
20827     "title": "Notify message to a specific agent",
20828     "examples": [
20829       {
20830         "title": "Example usage:",
20831         "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",
20832         "type": "json"
20833       }
20834     ],
20835     "name": "agentNotify",
20836     "group": "RPC_Realtime",
20837     "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>",
20838     "version": "0.0.0",
20839     "filename": "server/api/rpc/index.js",
20840     "groupTitle": "RPC_Realtime"
20841   },
20842   {
20843     "type": "post",
20844     "url": "/api/rpc/chat/queues/:id/notify",
20845     "title": "Notify message to a specific queue",
20846     "examples": [
20847       {
20848         "title": "Example usage:",
20849         "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",
20850         "type": "json"
20851       }
20852     ],
20853     "name": "chatQueueNotify",
20854     "group": "RPC_Realtime",
20855     "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>",
20856     "version": "0.0.0",
20857     "filename": "server/api/rpc/index.js",
20858     "groupTitle": "RPC_Realtime"
20859   },
20860   {
20861     "type": "get",
20862     "url": "/api/rpc/chat/queues/waitinginteractions",
20863     "title": "Gets a list of chatQueuesWaitingInteractions",
20864     "examples": [
20865       {
20866         "title": "Example usage:",
20867         "content": "curl https://{domain}/api/rpc/chat/queues/waitinginteractions -v -u {name}:{password}",
20868         "type": "json"
20869       }
20870     ],
20871     "name": "chatQueuesWaitingInteractions",
20872     "group": "RPC_Realtime",
20873     "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>",
20874     "version": "0.0.0",
20875     "filename": "server/api/rpc/index.js",
20876     "groupTitle": "RPC_Realtime"
20877   },
20878   {
20879     "type": "post",
20880     "url": "/api/rpc/fax/queues/:id/notify",
20881     "title": "Notify message to a specific queue",
20882     "examples": [
20883       {
20884         "title": "Example usage:",
20885         "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",
20886         "type": "json"
20887       }
20888     ],
20889     "name": "faxQueueNotify",
20890     "group": "RPC_Realtime",
20891     "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>",
20892     "version": "0.0.0",
20893     "filename": "server/api/rpc/index.js",
20894     "groupTitle": "RPC_Realtime"
20895   },
20896   {
20897     "type": "get",
20898     "url": "/api/rpc/fax/queues/waitinginteractions",
20899     "title": "Gets a list of faxQueuesWaitingInteractions",
20900     "examples": [
20901       {
20902         "title": "Example usage:",
20903         "content": "curl https://{domain}/api/rpc/fax/queues/waitinginteractions -v -u {name}:{password}",
20904         "type": "json"
20905       }
20906     ],
20907     "name": "faxQueuesWaitingInteractions",
20908     "group": "RPC_Realtime",
20909     "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>",
20910     "version": "0.0.0",
20911     "filename": "server/api/rpc/index.js",
20912     "groupTitle": "RPC_Realtime"
20913   },
20914   {
20915     "type": "post",
20916     "url": "/api/rpc/mail/queues/:id/notify",
20917     "title": "Notify message to a specific queue",
20918     "examples": [
20919       {
20920         "title": "Example usage:",
20921         "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",
20922         "type": "json"
20923       }
20924     ],
20925     "name": "mailQueueNotify",
20926     "group": "RPC_Realtime",
20927     "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>",
20928     "version": "0.0.0",
20929     "filename": "server/api/rpc/index.js",
20930     "groupTitle": "RPC_Realtime"
20931   },
20932   {
20933     "type": "get",
20934     "url": "/api/rpc/mail/queues/waitinginteractions",
20935     "title": "Gets a list of mailQueuesWaitingInteractions",
20936     "examples": [
20937       {
20938         "title": "Example usage:",
20939         "content": "curl https://{domain}/api/rpc/mail/queues/waitinginteractions -v -u {name}:{password}",
20940         "type": "json"
20941       }
20942     ],
20943     "name": "mailQueuesWaitingInteractions",
20944     "group": "RPC_Realtime",
20945     "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>",
20946     "version": "0.0.0",
20947     "filename": "server/api/rpc/index.js",
20948     "groupTitle": "RPC_Realtime"
20949   },
20950   {
20951     "type": "post",
20952     "url": "/api/rpc/openchannel/queues/:id/notify",
20953     "title": "Notify message to a specific queue",
20954     "examples": [
20955       {
20956         "title": "Example usage:",
20957         "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",
20958         "type": "json"
20959       }
20960     ],
20961     "name": "openchannelQueueNotify",
20962     "group": "RPC_Realtime",
20963     "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>",
20964     "version": "0.0.0",
20965     "filename": "server/api/rpc/index.js",
20966     "groupTitle": "RPC_Realtime"
20967   },
20968   {
20969     "type": "get",
20970     "url": "/api/rpc/openchannel/queues/:id/waitinginteractions",
20971     "title": "Gets a list of openchannelQueuesIdWaitingInteractions",
20972     "examples": [
20973       {
20974         "title": "Example usage:",
20975         "content": "curl https://{domain}/api/rpc/openchannel/queues/:id/waitinginteractions -v -u {name}:{password}",
20976         "type": "json"
20977       }
20978     ],
20979     "name": "openchannelQueuesIdWaitingInteractions",
20980     "group": "RPC_Realtime",
20981     "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>",
20982     "version": "0.0.0",
20983     "filename": "server/api/rpc/index.js",
20984     "groupTitle": "RPC_Realtime"
20985   },
20986   {
20987     "type": "get",
20988     "url": "/api/rpc/openchannel/queues/waitinginteractions",
20989     "title": "Gets a list of openchannelQueuesWaitingInteractions",
20990     "examples": [
20991       {
20992         "title": "Example usage:",
20993         "content": "curl https://{domain}/api/rpc/openchannel/queues/waitinginteractions -v -u {name}:{password}",
20994         "type": "json"
20995       }
20996     ],
20997     "name": "openchannelQueuesWaitingInteractions",
20998     "group": "RPC_Realtime",
20999     "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>",
21000     "version": "0.0.0",
21001     "filename": "server/api/rpc/index.js",
21002     "groupTitle": "RPC_Realtime"
21003   },
21004   {
21005     "type": "post",
21006     "url": "/api/rpc/sms/queues/:id/notify",
21007     "title": "Notify message to a specific queue",
21008     "examples": [
21009       {
21010         "title": "Example usage:",
21011         "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",
21012         "type": "json"
21013       }
21014     ],
21015     "name": "smsQueueNotify",
21016     "group": "RPC_Realtime",
21017     "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>",
21018     "version": "0.0.0",
21019     "filename": "server/api/rpc/index.js",
21020     "groupTitle": "RPC_Realtime"
21021   },
21022   {
21023     "type": "get",
21024     "url": "/api/rpc/sms/queues/waitinginteractions",
21025     "title": "Gets a list of smsQueuesWaitingInteractions",
21026     "examples": [
21027       {
21028         "title": "Example usage:",
21029         "content": "curl https://{domain}/api/rpc/sms/queues/waitinginteractions -v -u {name}:{password}",
21030         "type": "json"
21031       }
21032     ],
21033     "name": "smsQueuesWaitingInteractions",
21034     "group": "RPC_Realtime",
21035     "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>",
21036     "version": "0.0.0",
21037     "filename": "server/api/rpc/index.js",
21038     "groupTitle": "RPC_Realtime"
21039   },
21040   {
21041     "type": "get",
21042     "url": "/api/realtime/agents",
21043     "title": "Gets realtime agents info",
21044     "examples": [
21045       {
21046         "title": "Example usage:",
21047         "content": "curl https://{domain}/api/realtime/agents -v -u {name}:{password}  -X GET",
21048         "type": "json"
21049       }
21050     ],
21051     "name": "getAgents",
21052     "group": "Realtime",
21053     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21054     "version": "0.0.0",
21055     "filename": "server/api/realtime/index.js",
21056     "groupTitle": "Realtime"
21057   },
21058   {
21059     "type": "get",
21060     "url": "/api/realtime/queues",
21061     "title": "Gets realtime queues info",
21062     "examples": [
21063       {
21064         "title": "Example usage:",
21065         "content": "curl https://{domain}/api/realtime/queues -v -u {name}:{password}  -X GET",
21066         "type": "json"
21067       }
21068     ],
21069     "name": "getQueues",
21070     "group": "Realtime",
21071     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21072     "version": "0.0.0",
21073     "filename": "server/api/realtime/index.js",
21074     "groupTitle": "Realtime"
21075   },
21076   {
21077     "type": "post",
21078     "url": "/api/integrations/salesforce/accounts",
21079     "title": "Creates a new Salesforce Account",
21080     "examples": [
21081       {
21082         "title": "Example usage:",
21083         "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",
21084         "type": "json"
21085       }
21086     ],
21087     "name": "CreateSalesforce_Accounts",
21088     "group": "Salesforce_Accounts",
21089     "parameter": {
21090       "fields": {
21091         "Body": [
21092           {
21093             "group": "Body",
21094             "type": "String",
21095             "optional": true,
21096             "field": "name",
21097             "description": ""
21098           },
21099           {
21100             "group": "Body",
21101             "type": "String",
21102             "optional": true,
21103             "field": "description",
21104             "description": ""
21105           },
21106           {
21107             "group": "Body",
21108             "type": "String",
21109             "optional": true,
21110             "field": "username",
21111             "description": ""
21112           },
21113           {
21114             "group": "Body",
21115             "type": "String",
21116             "optional": true,
21117             "field": "remoteUri",
21118             "description": ""
21119           },
21120           {
21121             "group": "Body",
21122             "type": "String",
21123             "optional": true,
21124             "field": "password",
21125             "description": ""
21126           },
21127           {
21128             "group": "Body",
21129             "type": "String",
21130             "optional": true,
21131             "field": "clientId",
21132             "description": ""
21133           },
21134           {
21135             "group": "Body",
21136             "type": "String",
21137             "optional": true,
21138             "field": "clientSecret",
21139             "description": ""
21140           },
21141           {
21142             "group": "Body",
21143             "type": "String",
21144             "optional": true,
21145             "field": "securityToken",
21146             "description": ""
21147           },
21148           {
21149             "group": "Body",
21150             "type": "String",
21151             "optional": false,
21152             "field": "serverUrl",
21153             "description": ""
21154           },
21155           {
21156             "group": "Body",
21157             "type": "String",
21158             "allowedValues": [
21159               "\"integrationTab\"",
21160               "\"newTab\""
21161             ],
21162             "optional": true,
21163             "field": "type",
21164             "description": ""
21165           }
21166         ]
21167       }
21168     },
21169     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21170     "version": "0.0.0",
21171     "filename": "server/api/intSalesforceAccount/index.js",
21172     "groupTitle": "Salesforce_Accounts"
21173   },
21174   {
21175     "type": "delete",
21176     "url": "/api/integrations/salesforce/accounts/{id}",
21177     "title": "Deletes a Salesforce Account",
21178     "examples": [
21179       {
21180         "title": "Example usage:",
21181         "content": "curl https://{domain}/api/integrations/salesforce/accounts/{id} -v -u {name}:{password} -X DELETE",
21182         "type": "json"
21183       }
21184     ],
21185     "name": "DeleteSalesforce_Accounts",
21186     "group": "Salesforce_Accounts",
21187     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21188     "version": "0.0.0",
21189     "filename": "server/api/intSalesforceAccount/index.js",
21190     "groupTitle": "Salesforce_Accounts"
21191   },
21192   {
21193     "type": "get",
21194     "url": "/api/integrations/salesforce/accounts",
21195     "title": "Gets a list of Salesforce Accounts",
21196     "examples": [
21197       {
21198         "title": "Example usage:",
21199         "content": "curl https://{domain}/api/integrations/salesforce/accounts -v -u {name}:{password}",
21200         "type": "json"
21201       }
21202     ],
21203     "name": "GetSalesforce_Accounts",
21204     "group": "Salesforce_Accounts",
21205     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
21206     "version": "0.0.0",
21207     "filename": "server/api/intSalesforceAccount/index.js",
21208     "groupTitle": "Salesforce_Accounts"
21209   },
21210   {
21211     "type": "get",
21212     "url": "/api/integrations/salesforce/accounts/{id}",
21213     "title": "Gets a single Salesforce Account",
21214     "examples": [
21215       {
21216         "title": "Example usage:",
21217         "content": "curl https://{domain}/api/integrations/salesforce/accounts/{id} -v -u {name}:{password}",
21218         "type": "json"
21219       }
21220     ],
21221     "name": "ShowSalesforce_Accounts",
21222     "group": "Salesforce_Accounts",
21223     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21224     "version": "0.0.0",
21225     "filename": "server/api/intSalesforceAccount/index.js",
21226     "groupTitle": "Salesforce_Accounts"
21227   },
21228   {
21229     "type": "post",
21230     "url": "/api/integrations/salesforce/accounts/{id}/configurations",
21231     "title": "Creates new configuration",
21232     "examples": [
21233       {
21234         "title": "Example usage:",
21235         "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",
21236         "type": "json"
21237       }
21238     ],
21239     "name": "addConfiguration",
21240     "group": "Salesforce_Accounts",
21241     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21242     "version": "0.0.0",
21243     "filename": "server/api/intSalesforceAccount/index.js",
21244     "groupTitle": "Salesforce_Accounts"
21245   },
21246   {
21247     "type": "get",
21248     "url": "/api/integrations/salesforce/accounts/{id}/configurations",
21249     "title": "Gets account configurations",
21250     "examples": [
21251       {
21252         "title": "Example usage:",
21253         "content": "curl https://{domain}/api/integrations/salesforce/accounts/{id}/configurations -v -u {name}:{password} -X GET",
21254         "type": "json"
21255       }
21256     ],
21257     "name": "getConfigurations",
21258     "group": "Salesforce_Accounts",
21259     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21260     "version": "0.0.0",
21261     "filename": "server/api/intSalesforceAccount/index.js",
21262     "groupTitle": "Salesforce_Accounts"
21263   },
21264   {
21265     "type": "get",
21266     "url": "/api/integrations/salesforce/accounts/{id}/fields",
21267     "title": "Gets account fields",
21268     "examples": [
21269       {
21270         "title": "Example usage:",
21271         "content": "curl https://{domain}/api/integrations/salesforce/accounts/{id}/fields -v -u {name}:{password} -X GET",
21272         "type": "json"
21273       }
21274     ],
21275     "name": "getFields",
21276     "group": "Salesforce_Accounts",
21277     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21278     "version": "0.0.0",
21279     "filename": "server/api/intSalesforceAccount/index.js",
21280     "groupTitle": "Salesforce_Accounts"
21281   },
21282   {
21283     "type": "put",
21284     "url": "/api/integrations/salesforce/accounts/{id}",
21285     "title": "Update an existing Salesforce Account",
21286     "examples": [
21287       {
21288         "title": "Example usage:",
21289         "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",
21290         "type": "json"
21291       }
21292     ],
21293     "name": "updateSalesforce_Accounts",
21294     "group": "Salesforce_Accounts",
21295     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21296     "version": "0.0.0",
21297     "filename": "server/api/intSalesforceAccount/index.js",
21298     "groupTitle": "Salesforce_Accounts"
21299   },
21300   {
21301     "type": "post",
21302     "url": "/api/integrations/salesforce/configurations",
21303     "title": "Creates a new Salesforce Configuration",
21304     "examples": [
21305       {
21306         "title": "Example usage:",
21307         "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",
21308         "type": "json"
21309       }
21310     ],
21311     "name": "CreateSalesforce_Configurations",
21312     "group": "Salesforce_Configurations",
21313     "parameter": {
21314       "fields": {
21315         "Body": [
21316           {
21317             "group": "Body",
21318             "type": "String",
21319             "optional": true,
21320             "field": "name",
21321             "description": ""
21322           },
21323           {
21324             "group": "Body",
21325             "type": "String",
21326             "optional": true,
21327             "field": "description",
21328             "description": ""
21329           },
21330           {
21331             "group": "Body",
21332             "type": "String",
21333             "allowedValues": [
21334               "\"Task\"",
21335               "\"Case\""
21336             ],
21337             "optional": true,
21338             "field": "ticketType",
21339             "description": ""
21340           },
21341           {
21342             "group": "Body",
21343             "type": "String",
21344             "allowedValues": [
21345               "\"contact_lead\"",
21346               "\"contact\"",
21347               "\"lead\"",
21348               "\"account_contact_lead\"",
21349               "\"account\""
21350             ],
21351             "optional": true,
21352             "field": "moduleSearch",
21353             "description": ""
21354           },
21355           {
21356             "group": "Body",
21357             "type": "String",
21358             "allowedValues": [
21359               "\"nothing\"",
21360               "\"contact\"",
21361               "\"lead\"",
21362               "\"account\""
21363             ],
21364             "optional": true,
21365             "field": "moduleCreate",
21366             "description": ""
21367           },
21368           {
21369             "group": "Body",
21370             "type": "String",
21371             "optional": true,
21372             "field": "leadId",
21373             "description": ""
21374           },
21375           {
21376             "group": "Body",
21377             "type": "String",
21378             "optional": true,
21379             "field": "additionalSearchAccount",
21380             "description": ""
21381           },
21382           {
21383             "group": "Body",
21384             "type": "String",
21385             "optional": true,
21386             "field": "additionalSearchContact",
21387             "description": ""
21388           },
21389           {
21390             "group": "Body",
21391             "type": "String",
21392             "optional": true,
21393             "field": "additionalSearchLead",
21394             "description": ""
21395           }
21396         ]
21397       }
21398     },
21399     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21400     "version": "0.0.0",
21401     "filename": "server/api/intSalesforceConfiguration/index.js",
21402     "groupTitle": "Salesforce_Configurations"
21403   },
21404   {
21405     "type": "delete",
21406     "url": "/api/integrations/salesforce/configurations/{id}",
21407     "title": "Deletes a Salesforce Configuration",
21408     "examples": [
21409       {
21410         "title": "Example usage:",
21411         "content": "curl https://{domain}/api/integrations/salesforce/configurations/{id} -v -u {name}:{password} -X DELETE",
21412         "type": "json"
21413       }
21414     ],
21415     "name": "DeleteSalesforce_Configurations",
21416     "group": "Salesforce_Configurations",
21417     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21418     "version": "0.0.0",
21419     "filename": "server/api/intSalesforceConfiguration/index.js",
21420     "groupTitle": "Salesforce_Configurations"
21421   },
21422   {
21423     "type": "get",
21424     "url": "/api/integrations/salesforce/configurations",
21425     "title": "Gets a list of Salesforce Configurations",
21426     "examples": [
21427       {
21428         "title": "Example usage:",
21429         "content": "curl https://{domain}/api/integrations/salesforce/configurations -v -u {name}:{password}",
21430         "type": "json"
21431       }
21432     ],
21433     "name": "GetSalesforce_Configurations",
21434     "group": "Salesforce_Configurations",
21435     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
21436     "version": "0.0.0",
21437     "filename": "server/api/intSalesforceConfiguration/index.js",
21438     "groupTitle": "Salesforce_Configurations"
21439   },
21440   {
21441     "type": "get",
21442     "url": "/api/integrations/salesforce/configurations/{id}",
21443     "title": "Gets a single Salesforce Configuration",
21444     "examples": [
21445       {
21446         "title": "Example usage:",
21447         "content": "curl https://{domain}/api/integrations/salesforce/configurations/{id} -v -u {name}:{password}",
21448         "type": "json"
21449       }
21450     ],
21451     "name": "ShowSalesforce_Configurations",
21452     "group": "Salesforce_Configurations",
21453     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21454     "version": "0.0.0",
21455     "filename": "server/api/intSalesforceConfiguration/index.js",
21456     "groupTitle": "Salesforce_Configurations"
21457   },
21458   {
21459     "type": "get",
21460     "url": "/api/integrations/salesforce/configurations/{id}/descriptions",
21461     "title": "Gets configurations descriptions",
21462     "examples": [
21463       {
21464         "title": "Example usage:",
21465         "content": "curl https://{domain}/api/integrations/salesforce/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
21466         "type": "json"
21467       }
21468     ],
21469     "name": "getDescriptions",
21470     "group": "Salesforce_Configurations",
21471     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21472     "version": "0.0.0",
21473     "filename": "server/api/intSalesforceConfiguration/index.js",
21474     "groupTitle": "Salesforce_Configurations"
21475   },
21476   {
21477     "type": "get",
21478     "url": "/api/integrations/salesforce/configurations/{id}/fields",
21479     "title": "Gets configurations fields",
21480     "examples": [
21481       {
21482         "title": "Example usage:",
21483         "content": "curl https://{domain}/api/integrations/salesforce/configurations/{id}/fields -v -u {name}:{password} -X GET",
21484         "type": "json"
21485       }
21486     ],
21487     "name": "getFields",
21488     "group": "Salesforce_Configurations",
21489     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21490     "version": "0.0.0",
21491     "filename": "server/api/intSalesforceConfiguration/index.js",
21492     "groupTitle": "Salesforce_Configurations"
21493   },
21494   {
21495     "type": "get",
21496     "url": "/api/integrations/salesforce/configurations/{id}/subjects",
21497     "title": "Gets configurations subjects",
21498     "examples": [
21499       {
21500         "title": "Example usage:",
21501         "content": "curl https://{domain}/api/integrations/salesforce/configurations/{id}/subjects -v -u {name}:{password} -X GET",
21502         "type": "json"
21503       }
21504     ],
21505     "name": "getSubjects",
21506     "group": "Salesforce_Configurations",
21507     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21508     "version": "0.0.0",
21509     "filename": "server/api/intSalesforceConfiguration/index.js",
21510     "groupTitle": "Salesforce_Configurations"
21511   },
21512   {
21513     "type": "put",
21514     "url": "/api/integrations/salesforce/configurations/{id}",
21515     "title": "Update an existing Salesforce Configuration",
21516     "examples": [
21517       {
21518         "title": "Example usage:",
21519         "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",
21520         "type": "json"
21521       }
21522     ],
21523     "name": "updateSalesforce_Configurations",
21524     "group": "Salesforce_Configurations",
21525     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21526     "version": "0.0.0",
21527     "filename": "server/api/intSalesforceConfiguration/index.js",
21528     "groupTitle": "Salesforce_Configurations"
21529   },
21530   {
21531     "type": "post",
21532     "url": "/api/integrations/salesforce/fields",
21533     "title": "Creates a new Salesforce Field",
21534     "examples": [
21535       {
21536         "title": "Example usage:",
21537         "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",
21538         "type": "json"
21539       }
21540     ],
21541     "name": "CreateSalesforce_Fields",
21542     "group": "Salesforce_Fields",
21543     "parameter": {
21544       "fields": {
21545         "Body": [
21546           {
21547             "group": "Body",
21548             "type": "String",
21549             "allowedValues": [
21550               "\"string\"",
21551               "\"variable\"",
21552               "\"customVariable\"",
21553               "\"keyValue\"",
21554               "\"picklist\""
21555             ],
21556             "optional": true,
21557             "field": "type",
21558             "description": ""
21559           },
21560           {
21561             "group": "Body",
21562             "type": "String",
21563             "optional": true,
21564             "field": "content",
21565             "description": ""
21566           },
21567           {
21568             "group": "Body",
21569             "type": "String",
21570             "optional": true,
21571             "field": "key",
21572             "description": ""
21573           },
21574           {
21575             "group": "Body",
21576             "type": "String",
21577             "allowedValues": [
21578               "\"string\"",
21579               "\"variable\"",
21580               "\"customVariable\""
21581             ],
21582             "optional": true,
21583             "field": "keyType",
21584             "description": ""
21585           },
21586           {
21587             "group": "Body",
21588             "type": "String",
21589             "optional": true,
21590             "field": "keyContent",
21591             "description": ""
21592           },
21593           {
21594             "group": "Body",
21595             "type": "String",
21596             "optional": true,
21597             "field": "idField",
21598             "description": ""
21599           },
21600           {
21601             "group": "Body",
21602             "type": "String",
21603             "optional": true,
21604             "field": "variableName",
21605             "description": ""
21606           }
21607         ]
21608       }
21609     },
21610     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21611     "version": "0.0.0",
21612     "filename": "server/api/intSalesforceField/index.js",
21613     "groupTitle": "Salesforce_Fields"
21614   },
21615   {
21616     "type": "delete",
21617     "url": "/api/integrations/salesforce/fields/{id}",
21618     "title": "Deletes a Salesforce Field",
21619     "examples": [
21620       {
21621         "title": "Example usage:",
21622         "content": "curl https://{domain}/api/integrations/salesforce/fields/{id} -v -u {name}:{password} -X DELETE",
21623         "type": "json"
21624       }
21625     ],
21626     "name": "DeleteSalesforce_Fields",
21627     "group": "Salesforce_Fields",
21628     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21629     "version": "0.0.0",
21630     "filename": "server/api/intSalesforceField/index.js",
21631     "groupTitle": "Salesforce_Fields"
21632   },
21633   {
21634     "type": "get",
21635     "url": "/api/integrations/salesforce/fields",
21636     "title": "Gets a list of Salesforce Fields",
21637     "examples": [
21638       {
21639         "title": "Example usage:",
21640         "content": "curl https://{domain}/api/integrations/salesforce/fields -v -u {name}:{password}",
21641         "type": "json"
21642       }
21643     ],
21644     "name": "GetSalesforce_Fields",
21645     "group": "Salesforce_Fields",
21646     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
21647     "version": "0.0.0",
21648     "filename": "server/api/intSalesforceField/index.js",
21649     "groupTitle": "Salesforce_Fields"
21650   },
21651   {
21652     "type": "get",
21653     "url": "/api/integrations/salesforce/fields/{id}",
21654     "title": "Gets a single Salesforce Field",
21655     "examples": [
21656       {
21657         "title": "Example usage:",
21658         "content": "curl https://{domain}/api/integrations/salesforce/fields/{id} -v -u {name}:{password}",
21659         "type": "json"
21660       }
21661     ],
21662     "name": "ShowSalesforce_Fields",
21663     "group": "Salesforce_Fields",
21664     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21665     "version": "0.0.0",
21666     "filename": "server/api/intSalesforceField/index.js",
21667     "groupTitle": "Salesforce_Fields"
21668   },
21669   {
21670     "type": "put",
21671     "url": "/api/integrations/salesforce/fields/{id}",
21672     "title": "Update an existing Salesforce Field",
21673     "examples": [
21674       {
21675         "title": "Example usage:",
21676         "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",
21677         "type": "json"
21678       }
21679     ],
21680     "name": "updateSalesforce_Fields",
21681     "group": "Salesforce_Fields",
21682     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21683     "version": "0.0.0",
21684     "filename": "server/api/intSalesforceField/index.js",
21685     "groupTitle": "Salesforce_Fields"
21686   },
21687   {
21688     "type": "post",
21689     "url": "/api/schedules",
21690     "title": "Creates a new Schedule",
21691     "examples": [
21692       {
21693         "title": "Example usage:",
21694         "content": "curl https://{domain}/api/schedules -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
21695         "type": "json"
21696       }
21697     ],
21698     "name": "CreateSchedules",
21699     "group": "Schedules",
21700     "parameter": {
21701       "fields": {
21702         "Body": [
21703           {
21704             "group": "Body",
21705             "type": "String",
21706             "optional": false,
21707             "field": "name",
21708             "description": ""
21709           },
21710           {
21711             "group": "Body",
21712             "type": "String",
21713             "optional": true,
21714             "field": "description",
21715             "description": ""
21716           },
21717           {
21718             "group": "Body",
21719             "type": "Boolean",
21720             "optional": false,
21721             "field": "active",
21722             "description": ""
21723           },
21724           {
21725             "group": "Body",
21726             "type": "String",
21727             "optional": false,
21728             "field": "cron",
21729             "description": ""
21730           },
21731           {
21732             "group": "Body",
21733             "type": "String",
21734             "optional": false,
21735             "field": "startAt",
21736             "description": ""
21737           },
21738           {
21739             "group": "Body",
21740             "type": "String",
21741             "optional": false,
21742             "field": "endAt",
21743             "description": ""
21744           },
21745           {
21746             "group": "Body",
21747             "type": "Integer",
21748             "optional": false,
21749             "field": "subtractNumber",
21750             "description": ""
21751           },
21752           {
21753             "group": "Body",
21754             "type": "String",
21755             "allowedValues": [
21756               "\"years\"",
21757               "\"quarters\"",
21758               "\"months\"",
21759               "\"weeks\"",
21760               "\"days\"",
21761               "\"hours\"",
21762               "\"minutes\""
21763             ],
21764             "optional": false,
21765             "field": "subtractUnit",
21766             "description": ""
21767           },
21768           {
21769             "group": "Body",
21770             "type": "String",
21771             "allowedValues": [
21772               "\"csv\"",
21773               "\"pdf\"",
21774               "\"xlsx\""
21775             ],
21776             "optional": false,
21777             "field": "output",
21778             "description": ""
21779           },
21780           {
21781             "group": "Body",
21782             "type": "String",
21783             "allowedValues": [
21784               "\"custom\"",
21785               "\"default\""
21786             ],
21787             "optional": false,
21788             "field": "type",
21789             "description": ""
21790           },
21791           {
21792             "group": "Body",
21793             "type": "Boolean",
21794             "optional": true,
21795             "field": "sendMail",
21796             "description": ""
21797           },
21798           {
21799             "group": "Body",
21800             "type": "String",
21801             "optional": true,
21802             "field": "email",
21803             "description": ""
21804           },
21805           {
21806             "group": "Body",
21807             "type": "Text",
21808             "optional": true,
21809             "field": "cc",
21810             "description": ""
21811           },
21812           {
21813             "group": "Body",
21814             "type": "Text",
21815             "optional": true,
21816             "field": "bcc",
21817             "description": ""
21818           },
21819           {
21820             "group": "Body",
21821             "type": "Boolean",
21822             "optional": true,
21823             "field": "sendIfEmpty",
21824             "description": ""
21825           }
21826         ]
21827       }
21828     },
21829     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21830     "version": "0.0.0",
21831     "filename": "server/api/schedule/index.js",
21832     "groupTitle": "Schedules"
21833   },
21834   {
21835     "type": "delete",
21836     "url": "/api/schedules/{id}",
21837     "title": "Deletes a Schedule",
21838     "examples": [
21839       {
21840         "title": "Example usage:",
21841         "content": "curl https://{domain}/api/schedules/{id} -v -u {name}:{password} -X DELETE",
21842         "type": "json"
21843       }
21844     ],
21845     "name": "DeleteSchedules",
21846     "group": "Schedules",
21847     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21848     "version": "0.0.0",
21849     "filename": "server/api/schedule/index.js",
21850     "groupTitle": "Schedules"
21851   },
21852   {
21853     "type": "get",
21854     "url": "/api/schedules",
21855     "title": "Gets a list of Schedules",
21856     "examples": [
21857       {
21858         "title": "Example usage:",
21859         "content": "curl https://{domain}/api/schedules -v -u {name}:{password}",
21860         "type": "json"
21861       }
21862     ],
21863     "name": "GetSchedules",
21864     "group": "Schedules",
21865     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
21866     "version": "0.0.0",
21867     "filename": "server/api/schedule/index.js",
21868     "groupTitle": "Schedules"
21869   },
21870   {
21871     "type": "get",
21872     "url": "/api/schedules/{id}",
21873     "title": "Gets a single Schedule",
21874     "examples": [
21875       {
21876         "title": "Example usage:",
21877         "content": "curl https://{domain}/api/schedules/{id} -v -u {name}:{password}",
21878         "type": "json"
21879       }
21880     ],
21881     "name": "ShowSchedules",
21882     "group": "Schedules",
21883     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21884     "version": "0.0.0",
21885     "filename": "server/api/schedule/index.js",
21886     "groupTitle": "Schedules"
21887   },
21888   {
21889     "type": "get",
21890     "url": "/api/schedules/{id}/run",
21891     "title": "Run Scheduler",
21892     "examples": [
21893       {
21894         "title": "Example usage:",
21895         "content": "curl https://{domain}/api/schedules/{id}/run -v -u {name}:{password} -X GET",
21896         "type": "json"
21897       }
21898     ],
21899     "name": "run",
21900     "group": "Schedules",
21901     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21902     "version": "0.0.0",
21903     "filename": "server/api/schedule/index.js",
21904     "groupTitle": "Schedules"
21905   },
21906   {
21907     "type": "put",
21908     "url": "/api/schedules/{id}",
21909     "title": "Update an existing Schedule",
21910     "examples": [
21911       {
21912         "title": "Example usage:",
21913         "content": "curl https://{domain}/api/schedules/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
21914         "type": "json"
21915       }
21916     ],
21917     "name": "updateSchedules",
21918     "group": "Schedules",
21919     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21920     "version": "0.0.0",
21921     "filename": "server/api/schedule/index.js",
21922     "groupTitle": "Schedules"
21923   },
21924   {
21925     "type": "post",
21926     "url": "/api/screen/recordings",
21927     "title": "Creates a new Recording",
21928     "examples": [
21929       {
21930         "title": "Example usage:",
21931         "content": "curl https://{domain}/api/screen/recordings -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
21932         "type": "json"
21933       }
21934     ],
21935     "name": "CreateRecordings",
21936     "group": "Screen_Recordings",
21937     "parameter": {
21938       "fields": {
21939         "Body": [
21940           {
21941             "group": "Body",
21942             "type": "Virtual",
21943             "optional": true,
21944             "field": "format",
21945             "description": ""
21946           },
21947           {
21948             "group": "Body",
21949             "type": "String",
21950             "optional": true,
21951             "field": "interactionid",
21952             "description": ""
21953           },
21954           {
21955             "group": "Body",
21956             "type": "String",
21957             "optional": true,
21958             "field": "channel",
21959             "description": ""
21960           },
21961           {
21962             "group": "Body",
21963             "type": "String",
21964             "optional": true,
21965             "field": "value",
21966             "description": ""
21967           },
21968           {
21969             "group": "Body",
21970             "type": "Integer",
21971             "optional": true,
21972             "field": "rating",
21973             "description": ""
21974           },
21975           {
21976             "group": "Body",
21977             "type": "Integer",
21978             "optional": true,
21979             "field": "duration",
21980             "description": ""
21981           },
21982           {
21983             "group": "Body",
21984             "type": "String",
21985             "optional": true,
21986             "field": "startedAt",
21987             "description": ""
21988           },
21989           {
21990             "group": "Body",
21991             "type": "String",
21992             "optional": true,
21993             "field": "closedAt",
21994             "description": ""
21995           },
21996           {
21997             "group": "Body",
21998             "type": "String",
21999             "optional": true,
22000             "field": "createdAt",
22001             "description": ""
22002           },
22003           {
22004             "group": "Body",
22005             "type": "String",
22006             "optional": true,
22007             "field": "updatedAt",
22008             "description": ""
22009           }
22010         ]
22011       }
22012     },
22013     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22014     "version": "0.0.0",
22015     "filename": "server/api/screenRecording/index.js",
22016     "groupTitle": "Screen_Recordings"
22017   },
22018   {
22019     "type": "get",
22020     "url": "/api/screen/recordings/describe",
22021     "title": "Gets table info about Recordings",
22022     "examples": [
22023       {
22024         "title": "Example usage:",
22025         "content": "curl https://{domain}/api/screen/recordings/describe -v -u {name}:{password}",
22026         "type": "json"
22027       }
22028     ],
22029     "name": "DescribeRecordings",
22030     "group": "Screen_Recordings",
22031     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22032     "version": "0.0.0",
22033     "filename": "server/api/screenRecording/index.js",
22034     "groupTitle": "Screen_Recordings"
22035   },
22036   {
22037     "type": "get",
22038     "url": "/api/screen/recordings",
22039     "title": "Gets a list of Recordings",
22040     "examples": [
22041       {
22042         "title": "Example usage:",
22043         "content": "curl https://{domain}/api/screen/recordings -v -u {name}:{password}",
22044         "type": "json"
22045       }
22046     ],
22047     "name": "GetRecordings",
22048     "group": "Screen_Recordings",
22049     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
22050     "version": "0.0.0",
22051     "filename": "server/api/screenRecording/index.js",
22052     "groupTitle": "Screen_Recordings"
22053   },
22054   {
22055     "type": "get",
22056     "url": "/api/screen/recordings/{id}",
22057     "title": "Gets a single Recording",
22058     "examples": [
22059       {
22060         "title": "Example usage:",
22061         "content": "curl https://{domain}/api/screen/recordings/{id} -v -u {name}:{password}",
22062         "type": "json"
22063       }
22064     ],
22065     "name": "ShowRecordings",
22066     "group": "Screen_Recordings",
22067     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22068     "version": "0.0.0",
22069     "filename": "server/api/screenRecording/index.js",
22070     "groupTitle": "Screen_Recordings"
22071   },
22072   {
22073     "type": "delete",
22074     "url": "/api/screen/recordings/{id}",
22075     "title": "Delete screen recording",
22076     "examples": [
22077       {
22078         "title": "Example usage:",
22079         "content": "curl https://{domain}/api/screen/recordings/{id} -v -u {name}:{password} -X DELETE",
22080         "type": "json"
22081       }
22082     ],
22083     "name": "destroy",
22084     "group": "Screen_Recordings",
22085     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22086     "version": "0.0.0",
22087     "filename": "server/api/screenRecording/index.js",
22088     "groupTitle": "Screen_Recordings"
22089   },
22090   {
22091     "type": "get",
22092     "url": "/api/screen/recordings/{id}/download",
22093     "title": "Download Recording",
22094     "examples": [
22095       {
22096         "title": "Example usage:",
22097         "content": "curl https://{domain}/api/screen/recordings/{id}/download -v -u {name}:{password} -X GET",
22098         "type": "json"
22099       }
22100     ],
22101     "name": "download",
22102     "group": "Screen_Recordings",
22103     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22104     "version": "0.0.0",
22105     "filename": "server/api/screenRecording/index.js",
22106     "groupTitle": "Screen_Recordings"
22107   },
22108   {
22109     "type": "put",
22110     "url": "/api/screen/recordings/{id}",
22111     "title": "Update an existing Recording",
22112     "examples": [
22113       {
22114         "title": "Example usage:",
22115         "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",
22116         "type": "json"
22117       }
22118     ],
22119     "name": "updateRecordings",
22120     "group": "Screen_Recordings",
22121     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22122     "version": "0.0.0",
22123     "filename": "server/api/screenRecording/index.js",
22124     "groupTitle": "Screen_Recordings"
22125   },
22126   {
22127     "type": "post",
22128     "url": "/api/integrations/servicenow/accounts",
22129     "title": "Creates a new Servicenow Account",
22130     "examples": [
22131       {
22132         "title": "Example usage:",
22133         "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",
22134         "type": "json"
22135       }
22136     ],
22137     "name": "CreateServicenow_Accounts",
22138     "group": "Servicenow_Accounts",
22139     "parameter": {
22140       "fields": {
22141         "Body": [
22142           {
22143             "group": "Body",
22144             "type": "String",
22145             "optional": true,
22146             "field": "name",
22147             "description": ""
22148           },
22149           {
22150             "group": "Body",
22151             "type": "String",
22152             "optional": true,
22153             "field": "description",
22154             "description": ""
22155           },
22156           {
22157             "group": "Body",
22158             "type": "String",
22159             "optional": true,
22160             "field": "username",
22161             "description": ""
22162           },
22163           {
22164             "group": "Body",
22165             "type": "String",
22166             "optional": true,
22167             "field": "password",
22168             "description": ""
22169           },
22170           {
22171             "group": "Body",
22172             "type": "String",
22173             "optional": true,
22174             "field": "email",
22175             "description": ""
22176           },
22177           {
22178             "group": "Body",
22179             "type": "String",
22180             "optional": true,
22181             "field": "remoteUri",
22182             "description": ""
22183           },
22184           {
22185             "group": "Body",
22186             "type": "String",
22187             "optional": false,
22188             "field": "serverUrl",
22189             "description": ""
22190           }
22191         ]
22192       }
22193     },
22194     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22195     "version": "0.0.0",
22196     "filename": "server/api/intServicenowAccount/index.js",
22197     "groupTitle": "Servicenow_Accounts"
22198   },
22199   {
22200     "type": "delete",
22201     "url": "/api/integrations/servicenow/accounts/{id}",
22202     "title": "Deletes a Servicenow Account",
22203     "examples": [
22204       {
22205         "title": "Example usage:",
22206         "content": "curl https://{domain}/api/integrations/servicenow/accounts/{id} -v -u {name}:{password} -X DELETE",
22207         "type": "json"
22208       }
22209     ],
22210     "name": "DeleteServicenow_Accounts",
22211     "group": "Servicenow_Accounts",
22212     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22213     "version": "0.0.0",
22214     "filename": "server/api/intServicenowAccount/index.js",
22215     "groupTitle": "Servicenow_Accounts"
22216   },
22217   {
22218     "type": "get",
22219     "url": "/api/integrations/servicenow/accounts",
22220     "title": "Gets a list of Servicenow Accounts",
22221     "examples": [
22222       {
22223         "title": "Example usage:",
22224         "content": "curl https://{domain}/api/integrations/servicenow/accounts -v -u {name}:{password}",
22225         "type": "json"
22226       }
22227     ],
22228     "name": "GetServicenow_Accounts",
22229     "group": "Servicenow_Accounts",
22230     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
22231     "version": "0.0.0",
22232     "filename": "server/api/intServicenowAccount/index.js",
22233     "groupTitle": "Servicenow_Accounts"
22234   },
22235   {
22236     "type": "get",
22237     "url": "/api/integrations/servicenow/accounts/{id}",
22238     "title": "Gets a single Servicenow Account",
22239     "examples": [
22240       {
22241         "title": "Example usage:",
22242         "content": "curl https://{domain}/api/integrations/servicenow/accounts/{id} -v -u {name}:{password}",
22243         "type": "json"
22244       }
22245     ],
22246     "name": "ShowServicenow_Accounts",
22247     "group": "Servicenow_Accounts",
22248     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22249     "version": "0.0.0",
22250     "filename": "server/api/intServicenowAccount/index.js",
22251     "groupTitle": "Servicenow_Accounts"
22252   },
22253   {
22254     "type": "post",
22255     "url": "/api/integrations/servicenow/accounts/{id}/configurations",
22256     "title": "Creates new configuration",
22257     "examples": [
22258       {
22259         "title": "Example usage:",
22260         "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",
22261         "type": "json"
22262       }
22263     ],
22264     "name": "addConfiguration",
22265     "group": "Servicenow_Accounts",
22266     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22267     "version": "0.0.0",
22268     "filename": "server/api/intServicenowAccount/index.js",
22269     "groupTitle": "Servicenow_Accounts"
22270   },
22271   {
22272     "type": "get",
22273     "url": "/api/integrations/servicenow/accounts/{id}/configurations",
22274     "title": "Gets account configurations",
22275     "examples": [
22276       {
22277         "title": "Example usage:",
22278         "content": "curl https://{domain}/api/integrations/servicenow/accounts/{id}/configurations -v -u {name}:{password} -X GET",
22279         "type": "json"
22280       }
22281     ],
22282     "name": "getConfigurations",
22283     "group": "Servicenow_Accounts",
22284     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22285     "version": "0.0.0",
22286     "filename": "server/api/intServicenowAccount/index.js",
22287     "groupTitle": "Servicenow_Accounts"
22288   },
22289   {
22290     "type": "get",
22291     "url": "/api/integrations/servicenow/accounts/{id}/fields",
22292     "title": "Gets account fields",
22293     "examples": [
22294       {
22295         "title": "Example usage:",
22296         "content": "curl https://{domain}/api/integrations/servicenow/accounts/{id}/fields -v -u {name}:{password} -X GET",
22297         "type": "json"
22298       }
22299     ],
22300     "name": "getFields",
22301     "group": "Servicenow_Accounts",
22302     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22303     "version": "0.0.0",
22304     "filename": "server/api/intServicenowAccount/index.js",
22305     "groupTitle": "Servicenow_Accounts"
22306   },
22307   {
22308     "type": "put",
22309     "url": "/api/integrations/servicenow/accounts/{id}",
22310     "title": "Update an existing Servicenow Account",
22311     "examples": [
22312       {
22313         "title": "Example usage:",
22314         "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",
22315         "type": "json"
22316       }
22317     ],
22318     "name": "updateServicenow_Accounts",
22319     "group": "Servicenow_Accounts",
22320     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22321     "version": "0.0.0",
22322     "filename": "server/api/intServicenowAccount/index.js",
22323     "groupTitle": "Servicenow_Accounts"
22324   },
22325   {
22326     "type": "post",
22327     "url": "/api/integrations/servicenow/configurations",
22328     "title": "Creates a new Servicenow Configuration",
22329     "examples": [
22330       {
22331         "title": "Example usage:",
22332         "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",
22333         "type": "json"
22334       }
22335     ],
22336     "name": "CreateServicenow_Configurations",
22337     "group": "Servicenow_Configurations",
22338     "parameter": {
22339       "fields": {
22340         "Body": [
22341           {
22342             "group": "Body",
22343             "type": "String",
22344             "optional": true,
22345             "field": "name",
22346             "description": ""
22347           },
22348           {
22349             "group": "Body",
22350             "type": "String",
22351             "optional": true,
22352             "field": "description",
22353             "description": ""
22354           }
22355         ]
22356       }
22357     },
22358     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22359     "version": "0.0.0",
22360     "filename": "server/api/intServicenowConfiguration/index.js",
22361     "groupTitle": "Servicenow_Configurations"
22362   },
22363   {
22364     "type": "delete",
22365     "url": "/api/integrations/servicenow/configurations/{id}",
22366     "title": "Deletes a Servicenow Configuration",
22367     "examples": [
22368       {
22369         "title": "Example usage:",
22370         "content": "curl https://{domain}/api/integrations/servicenow/configurations/{id} -v -u {name}:{password} -X DELETE",
22371         "type": "json"
22372       }
22373     ],
22374     "name": "DeleteServicenow_Configurations",
22375     "group": "Servicenow_Configurations",
22376     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22377     "version": "0.0.0",
22378     "filename": "server/api/intServicenowConfiguration/index.js",
22379     "groupTitle": "Servicenow_Configurations"
22380   },
22381   {
22382     "type": "get",
22383     "url": "/api/integrations/servicenow/configurations",
22384     "title": "Gets a list of Servicenow Configurations",
22385     "examples": [
22386       {
22387         "title": "Example usage:",
22388         "content": "curl https://{domain}/api/integrations/servicenow/configurations -v -u {name}:{password}",
22389         "type": "json"
22390       }
22391     ],
22392     "name": "GetServicenow_Configurations",
22393     "group": "Servicenow_Configurations",
22394     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
22395     "version": "0.0.0",
22396     "filename": "server/api/intServicenowConfiguration/index.js",
22397     "groupTitle": "Servicenow_Configurations"
22398   },
22399   {
22400     "type": "get",
22401     "url": "/api/integrations/servicenow/configurations/{id}",
22402     "title": "Gets a single Servicenow Configuration",
22403     "examples": [
22404       {
22405         "title": "Example usage:",
22406         "content": "curl https://{domain}/api/integrations/servicenow/configurations/{id} -v -u {name}:{password}",
22407         "type": "json"
22408       }
22409     ],
22410     "name": "ShowServicenow_Configurations",
22411     "group": "Servicenow_Configurations",
22412     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22413     "version": "0.0.0",
22414     "filename": "server/api/intServicenowConfiguration/index.js",
22415     "groupTitle": "Servicenow_Configurations"
22416   },
22417   {
22418     "type": "get",
22419     "url": "/api/integrations/servicenow/configurations/{id}/descriptions",
22420     "title": "Gets configurations descriptions",
22421     "examples": [
22422       {
22423         "title": "Example usage:",
22424         "content": "curl https://{domain}/api/integrations/servicenow/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
22425         "type": "json"
22426       }
22427     ],
22428     "name": "getDescriptions",
22429     "group": "Servicenow_Configurations",
22430     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22431     "version": "0.0.0",
22432     "filename": "server/api/intServicenowConfiguration/index.js",
22433     "groupTitle": "Servicenow_Configurations"
22434   },
22435   {
22436     "type": "get",
22437     "url": "/api/integrations/servicenow/configurations/{id}/fields",
22438     "title": "Gets configurations fields",
22439     "examples": [
22440       {
22441         "title": "Example usage:",
22442         "content": "curl https://{domain}/api/integrations/servicenow/configurations/{id}/fields -v -u {name}:{password} -X GET",
22443         "type": "json"
22444       }
22445     ],
22446     "name": "getFields",
22447     "group": "Servicenow_Configurations",
22448     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22449     "version": "0.0.0",
22450     "filename": "server/api/intServicenowConfiguration/index.js",
22451     "groupTitle": "Servicenow_Configurations"
22452   },
22453   {
22454     "type": "get",
22455     "url": "/api/integrations/servicenow/configurations/{id}/subjects",
22456     "title": "Gets configurations subjects",
22457     "examples": [
22458       {
22459         "title": "Example usage:",
22460         "content": "curl https://{domain}/api/integrations/servicenow/configurations/{id}/subjects -v -u {name}:{password} -X GET",
22461         "type": "json"
22462       }
22463     ],
22464     "name": "getSubjects",
22465     "group": "Servicenow_Configurations",
22466     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22467     "version": "0.0.0",
22468     "filename": "server/api/intServicenowConfiguration/index.js",
22469     "groupTitle": "Servicenow_Configurations"
22470   },
22471   {
22472     "type": "put",
22473     "url": "/api/integrations/servicenow/configurations/{id}",
22474     "title": "Update an existing Servicenow Configuration",
22475     "examples": [
22476       {
22477         "title": "Example usage:",
22478         "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",
22479         "type": "json"
22480       }
22481     ],
22482     "name": "updateServicenow_Configurations",
22483     "group": "Servicenow_Configurations",
22484     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22485     "version": "0.0.0",
22486     "filename": "server/api/intServicenowConfiguration/index.js",
22487     "groupTitle": "Servicenow_Configurations"
22488   },
22489   {
22490     "type": "post",
22491     "url": "/api/integrations/servicenow/fields",
22492     "title": "Creates a new Servicenow Field",
22493     "examples": [
22494       {
22495         "title": "Example usage:",
22496         "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",
22497         "type": "json"
22498       }
22499     ],
22500     "name": "CreateServicenow_Fields",
22501     "group": "Servicenow_Fields",
22502     "parameter": {
22503       "fields": {
22504         "Body": [
22505           {
22506             "group": "Body",
22507             "type": "String",
22508             "allowedValues": [
22509               "\"string\"",
22510               "\"variable\"",
22511               "\"customVariable\"",
22512               "\"keyValue\"",
22513               "\"picklist\""
22514             ],
22515             "optional": true,
22516             "field": "type",
22517             "description": ""
22518           },
22519           {
22520             "group": "Body",
22521             "type": "String",
22522             "optional": true,
22523             "field": "content",
22524             "description": ""
22525           },
22526           {
22527             "group": "Body",
22528             "type": "String",
22529             "optional": true,
22530             "field": "key",
22531             "description": ""
22532           },
22533           {
22534             "group": "Body",
22535             "type": "String",
22536             "allowedValues": [
22537               "\"string\"",
22538               "\"variable\"",
22539               "\"customVariable\""
22540             ],
22541             "optional": true,
22542             "field": "keyType",
22543             "description": ""
22544           },
22545           {
22546             "group": "Body",
22547             "type": "String",
22548             "optional": true,
22549             "field": "keyContent",
22550             "description": ""
22551           },
22552           {
22553             "group": "Body",
22554             "type": "String",
22555             "optional": true,
22556             "field": "idField",
22557             "description": ""
22558           },
22559           {
22560             "group": "Body",
22561             "type": "String",
22562             "optional": true,
22563             "field": "nameField",
22564             "description": ""
22565           },
22566           {
22567             "group": "Body",
22568             "type": "Boolean",
22569             "optional": true,
22570             "field": "customField",
22571             "description": ""
22572           },
22573           {
22574             "group": "Body",
22575             "type": "String",
22576             "optional": true,
22577             "field": "variableName",
22578             "description": ""
22579           }
22580         ]
22581       }
22582     },
22583     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22584     "version": "0.0.0",
22585     "filename": "server/api/intServicenowField/index.js",
22586     "groupTitle": "Servicenow_Fields"
22587   },
22588   {
22589     "type": "delete",
22590     "url": "/api/integrations/servicenow/fields/{id}",
22591     "title": "Deletes a Servicenow Field",
22592     "examples": [
22593       {
22594         "title": "Example usage:",
22595         "content": "curl https://{domain}/api/integrations/servicenow/fields/{id} -v -u {name}:{password} -X DELETE",
22596         "type": "json"
22597       }
22598     ],
22599     "name": "DeleteServicenow_Fields",
22600     "group": "Servicenow_Fields",
22601     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22602     "version": "0.0.0",
22603     "filename": "server/api/intServicenowField/index.js",
22604     "groupTitle": "Servicenow_Fields"
22605   },
22606   {
22607     "type": "get",
22608     "url": "/api/integrations/servicenow/fields",
22609     "title": "Gets a list of Servicenow Fields",
22610     "examples": [
22611       {
22612         "title": "Example usage:",
22613         "content": "curl https://{domain}/api/integrations/servicenow/fields -v -u {name}:{password}",
22614         "type": "json"
22615       }
22616     ],
22617     "name": "GetServicenow_Fields",
22618     "group": "Servicenow_Fields",
22619     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
22620     "version": "0.0.0",
22621     "filename": "server/api/intServicenowField/index.js",
22622     "groupTitle": "Servicenow_Fields"
22623   },
22624   {
22625     "type": "get",
22626     "url": "/api/integrations/servicenow/fields/{id}",
22627     "title": "Gets a single Servicenow Field",
22628     "examples": [
22629       {
22630         "title": "Example usage:",
22631         "content": "curl https://{domain}/api/integrations/servicenow/fields/{id} -v -u {name}:{password}",
22632         "type": "json"
22633       }
22634     ],
22635     "name": "ShowServicenow_Fields",
22636     "group": "Servicenow_Fields",
22637     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22638     "version": "0.0.0",
22639     "filename": "server/api/intServicenowField/index.js",
22640     "groupTitle": "Servicenow_Fields"
22641   },
22642   {
22643     "type": "put",
22644     "url": "/api/integrations/servicenow/fields/{id}",
22645     "title": "Update an existing Servicenow Field",
22646     "examples": [
22647       {
22648         "title": "Example usage:",
22649         "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",
22650         "type": "json"
22651       }
22652     ],
22653     "name": "updateServicenow_Fields",
22654     "group": "Servicenow_Fields",
22655     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22656     "version": "0.0.0",
22657     "filename": "server/api/intServicenowField/index.js",
22658     "groupTitle": "Servicenow_Fields"
22659   },
22660   {
22661     "type": "get",
22662     "url": "/api/settings",
22663     "title": "Gets a list of Settings",
22664     "examples": [
22665       {
22666         "title": "Example usage:",
22667         "content": "curl https://{domain}/api/settings -v -u {name}:{password}",
22668         "type": "json"
22669       }
22670     ],
22671     "name": "GetSettings",
22672     "group": "Settings",
22673     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
22674     "version": "0.0.0",
22675     "filename": "server/api/setting/index.js",
22676     "groupTitle": "Settings"
22677   },
22678   {
22679     "type": "get",
22680     "url": "/api/settings/{id}",
22681     "title": "Gets a single Setting",
22682     "examples": [
22683       {
22684         "title": "Example usage:",
22685         "content": "curl https://{domain}/api/settings/{id} -v -u {name}:{password}",
22686         "type": "json"
22687       }
22688     ],
22689     "name": "ShowSettings",
22690     "group": "Settings",
22691     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22692     "version": "0.0.0",
22693     "filename": "server/api/setting/index.js",
22694     "groupTitle": "Settings"
22695   },
22696   {
22697     "type": "post",
22698     "url": "/api/settings/{id}/favicon",
22699     "title": "Add Favicon",
22700     "examples": [
22701       {
22702         "title": "Example usage:",
22703         "content": "curl https://{domain}/api/settings/{id}/favicon -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
22704         "type": "json"
22705       }
22706     ],
22707     "name": "addFavicon",
22708     "group": "Settings",
22709     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22710     "version": "0.0.0",
22711     "filename": "server/api/setting/index.js",
22712     "groupTitle": "Settings"
22713   },
22714   {
22715     "type": "post",
22716     "url": "/api/settings/{id}/logo",
22717     "title": "Add logo",
22718     "examples": [
22719       {
22720         "title": "Example usage:",
22721         "content": "curl https://{domain}/api/settings/{id}/logo -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
22722         "type": "json"
22723       }
22724     ],
22725     "name": "addLogo",
22726     "group": "Settings",
22727     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22728     "version": "0.0.0",
22729     "filename": "server/api/setting/index.js",
22730     "groupTitle": "Settings"
22731   },
22732   {
22733     "type": "post",
22734     "url": "/api/settings/{id}/logo_login",
22735     "title": "Add logo login",
22736     "examples": [
22737       {
22738         "title": "Example usage:",
22739         "content": "curl https://{domain}/api/settings/{id}/logo_login -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
22740         "type": "json"
22741       }
22742     ],
22743     "name": "addLogoLogin",
22744     "group": "Settings",
22745     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22746     "version": "0.0.0",
22747     "filename": "server/api/setting/index.js",
22748     "groupTitle": "Settings"
22749   },
22750   {
22751     "type": "post",
22752     "url": "/api/settings/{id}/preferred",
22753     "title": "Add Preferred",
22754     "examples": [
22755       {
22756         "title": "Example usage:",
22757         "content": "curl https://{domain}/api/settings/{id}/preferred -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
22758         "type": "json"
22759       }
22760     ],
22761     "name": "addPreferred",
22762     "group": "Settings",
22763     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22764     "version": "0.0.0",
22765     "filename": "server/api/setting/index.js",
22766     "groupTitle": "Settings"
22767   },
22768   {
22769     "type": "get",
22770     "url": "/api/settings/now",
22771     "title": "Get Server Current Date",
22772     "examples": [
22773       {
22774         "title": "Example usage:",
22775         "content": "curl https://{domain}/api/settings/now -v -X GET",
22776         "type": "json"
22777       }
22778     ],
22779     "name": "getDate",
22780     "group": "Settings",
22781     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22782     "version": "0.0.0",
22783     "filename": "server/api/setting/index.js",
22784     "groupTitle": "Settings"
22785   },
22786   {
22787     "type": "get",
22788     "url": "/api/settings/{id}/favicon",
22789     "title": "Get Favicon",
22790     "examples": [
22791       {
22792         "title": "Example usage:",
22793         "content": "curl https://{domain}/api/settings/{id}/favicon -v -X GET",
22794         "type": "json"
22795       }
22796     ],
22797     "name": "getFavicon",
22798     "group": "Settings",
22799     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22800     "version": "0.0.0",
22801     "filename": "server/api/setting/index.js",
22802     "groupTitle": "Settings"
22803   },
22804   {
22805     "type": "get",
22806     "url": "/api/settings/{id}/gdpr",
22807     "title": "Get gdpr settings",
22808     "examples": [
22809       {
22810         "title": "Example usage:",
22811         "content": "curl https://{domain}/api/settings/{id}/gdpr -v -u {name}:{password} -X GET",
22812         "type": "json"
22813       }
22814     ],
22815     "name": "getGdpr",
22816     "group": "Settings",
22817     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22818     "version": "0.0.0",
22819     "filename": "server/api/setting/index.js",
22820     "groupTitle": "Settings"
22821   },
22822   {
22823     "type": "get",
22824     "url": "/api/settings/{id}/logo",
22825     "title": "Get logo",
22826     "examples": [
22827       {
22828         "title": "Example usage:",
22829         "content": "curl https://{domain}/api/settings/{id}/logo -v -X GET",
22830         "type": "json"
22831       }
22832     ],
22833     "name": "getLogo",
22834     "group": "Settings",
22835     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22836     "version": "0.0.0",
22837     "filename": "server/api/setting/index.js",
22838     "groupTitle": "Settings"
22839   },
22840   {
22841     "type": "get",
22842     "url": "/api/settings/{id}/logo_login",
22843     "title": "Get logo login",
22844     "examples": [
22845       {
22846         "title": "Example usage:",
22847         "content": "curl https://{domain}/api/settings/{id}/logo_login -v -X GET",
22848         "type": "json"
22849       }
22850     ],
22851     "name": "getLogoLogin",
22852     "group": "Settings",
22853     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22854     "version": "0.0.0",
22855     "filename": "server/api/setting/index.js",
22856     "groupTitle": "Settings"
22857   },
22858   {
22859     "type": "get",
22860     "url": "/api/settings/{id}/preferred",
22861     "title": "Get Preferred",
22862     "examples": [
22863       {
22864         "title": "Example usage:",
22865         "content": "curl https://{domain}/api/settings/{id}/preferred -v -X GET",
22866         "type": "json"
22867       }
22868     ],
22869     "name": "getPreferred",
22870     "group": "Settings",
22871     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22872     "version": "0.0.0",
22873     "filename": "server/api/setting/index.js",
22874     "groupTitle": "Settings"
22875   },
22876   {
22877     "type": "put",
22878     "url": "/api/settings/{id}",
22879     "title": "Update an existing Setting",
22880     "examples": [
22881       {
22882         "title": "Example usage:",
22883         "content": "curl https://{domain}/api/settings/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
22884         "type": "json"
22885       }
22886     ],
22887     "name": "updateSettings",
22888     "group": "Settings",
22889     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22890     "version": "0.0.0",
22891     "filename": "server/api/setting/index.js",
22892     "groupTitle": "Settings"
22893   },
22894   {
22895     "type": "post",
22896     "url": "/api/sms/accounts/{id}/users",
22897     "title": "Add agents to a sms account",
22898     "examples": [
22899       {
22900         "title": "Example usage:",
22901         "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",
22902         "type": "json"
22903       }
22904     ],
22905     "name": "AddAgents",
22906     "group": "Sms_Accounts",
22907     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22908     "version": "0.0.0",
22909     "filename": "server/api/smsAccount/index.js",
22910     "groupTitle": "Sms_Accounts"
22911   },
22912   {
22913     "type": "post",
22914     "url": "/api/sms/accounts",
22915     "title": "Creates a new Account",
22916     "examples": [
22917       {
22918         "title": "Example usage:",
22919         "content": "curl https://{domain}/api/sms/accounts -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
22920         "type": "json"
22921       }
22922     ],
22923     "name": "CreateAccounts",
22924     "group": "Sms_Accounts",
22925     "parameter": {
22926       "fields": {
22927         "Body": [
22928           {
22929             "group": "Body",
22930             "type": "String",
22931             "optional": false,
22932             "field": "name",
22933             "description": ""
22934           },
22935           {
22936             "group": "Body",
22937             "type": "String",
22938             "optional": false,
22939             "field": "key",
22940             "description": ""
22941           },
22942           {
22943             "group": "Body",
22944             "type": "String",
22945             "optional": false,
22946             "field": "remote",
22947             "description": ""
22948           },
22949           {
22950             "group": "Body",
22951             "type": "String",
22952             "optional": true,
22953             "field": "token",
22954             "description": ""
22955           },
22956           {
22957             "group": "Body",
22958             "type": "String",
22959             "optional": true,
22960             "field": "phone",
22961             "description": ""
22962           },
22963           {
22964             "group": "Body",
22965             "type": "String",
22966             "allowedValues": [
22967               "\"twilio\"",
22968               "\"skebby\"",
22969               "\"connectel\"",
22970               "\"clicksend\"",
22971               "\"plivo\"",
22972               "\"clickatell\"",
22973               "\"bandwidth\"",
22974               "\"csc\"",
22975               "\"infobip\"",
22976               "\"intelepeer\""
22977             ],
22978             "optional": true,
22979             "field": "type",
22980             "description": ""
22981           },
22982           {
22983             "group": "Body",
22984             "type": "String",
22985             "optional": true,
22986             "field": "accountSid",
22987             "description": ""
22988           },
22989           {
22990             "group": "Body",
22991             "type": "String",
22992             "optional": true,
22993             "field": "authId",
22994             "description": ""
22995           },
22996           {
22997             "group": "Body",
22998             "type": "String",
22999             "optional": true,
23000             "field": "authToken",
23001             "description": ""
23002           },
23003           {
23004             "group": "Body",
23005             "type": "String",
23006             "allowedValues": [
23007               "\"SI\"",
23008               "\"TI\"",
23009               "\"GP\""
23010             ],
23011             "optional": true,
23012             "field": "smsMethod",
23013             "description": ""
23014           },
23015           {
23016             "group": "Body",
23017             "type": "String",
23018             "optional": true,
23019             "field": "username",
23020             "description": ""
23021           },
23022           {
23023             "group": "Body",
23024             "type": "String",
23025             "optional": true,
23026             "field": "password",
23027             "description": ""
23028           },
23029           {
23030             "group": "Body",
23031             "type": "String",
23032             "optional": true,
23033             "field": "apiKey",
23034             "description": ""
23035           },
23036           {
23037             "group": "Body",
23038             "type": "String",
23039             "optional": true,
23040             "field": "applicationId",
23041             "description": ""
23042           },
23043           {
23044             "group": "Body",
23045             "type": "String",
23046             "optional": true,
23047             "field": "accountId",
23048             "description": ""
23049           },
23050           {
23051             "group": "Body",
23052             "type": "String",
23053             "optional": true,
23054             "field": "senderString",
23055             "description": ""
23056           },
23057           {
23058             "group": "Body",
23059             "type": "Boolean",
23060             "optional": true,
23061             "field": "deliveryReport",
23062             "description": ""
23063           },
23064           {
23065             "group": "Body",
23066             "type": "String",
23067             "optional": true,
23068             "field": "description",
23069             "description": ""
23070           },
23071           {
23072             "group": "Body",
23073             "type": "Text",
23074             "optional": true,
23075             "field": "notificationTemplate",
23076             "description": ""
23077           },
23078           {
23079             "group": "Body",
23080             "type": "Boolean",
23081             "optional": true,
23082             "field": "notificationSound",
23083             "description": ""
23084           },
23085           {
23086             "group": "Body",
23087             "type": "Boolean",
23088             "optional": true,
23089             "field": "notificationShake",
23090             "description": ""
23091           },
23092           {
23093             "group": "Body",
23094             "type": "Integer",
23095             "optional": true,
23096             "field": "waitForTheAssignedAgent",
23097             "description": ""
23098           },
23099           {
23100             "group": "Body",
23101             "type": "Boolean",
23102             "optional": true,
23103             "field": "queueTransfer",
23104             "description": ""
23105           },
23106           {
23107             "group": "Body",
23108             "type": "Integer",
23109             "optional": true,
23110             "field": "queueTransferTimeout",
23111             "description": ""
23112           },
23113           {
23114             "group": "Body",
23115             "type": "Boolean",
23116             "optional": true,
23117             "field": "agentTransfer",
23118             "description": ""
23119           },
23120           {
23121             "group": "Body",
23122             "type": "Integer",
23123             "optional": true,
23124             "field": "agentTransferTimeout",
23125             "description": ""
23126           },
23127           {
23128             "group": "Body",
23129             "type": "String",
23130             "optional": true,
23131             "field": "baseUrl",
23132             "description": ""
23133           },
23134           {
23135             "group": "Body",
23136             "type": "Integer",
23137             "optional": true,
23138             "field": "mandatoryDispositionPauseId",
23139             "description": "<p>Status to put when mandatory disposition is enabled</p>"
23140           },
23141           {
23142             "group": "Body",
23143             "type": "Boolean",
23144             "optional": true,
23145             "field": "mandatoryDisposition",
23146             "description": "<p>Enabled/disables mandatory dispo on a queue</p>"
23147           }
23148         ]
23149       }
23150     },
23151     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23152     "version": "0.0.0",
23153     "filename": "server/api/smsAccount/index.js",
23154     "groupTitle": "Sms_Accounts"
23155   },
23156   {
23157     "type": "delete",
23158     "url": "/api/sms/accounts/{id}",
23159     "title": "Deletes a Account",
23160     "examples": [
23161       {
23162         "title": "Example usage:",
23163         "content": "curl https://{domain}/api/sms/accounts/{id} -v -u {name}:{password} -X DELETE",
23164         "type": "json"
23165       }
23166     ],
23167     "name": "DeleteAccounts",
23168     "group": "Sms_Accounts",
23169     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23170     "version": "0.0.0",
23171     "filename": "server/api/smsAccount/index.js",
23172     "groupTitle": "Sms_Accounts"
23173   },
23174   {
23175     "type": "get",
23176     "url": "/api/sms/accounts/describe",
23177     "title": "Gets table info about Accounts",
23178     "examples": [
23179       {
23180         "title": "Example usage:",
23181         "content": "curl https://{domain}/api/sms/accounts/describe -v -u {name}:{password}",
23182         "type": "json"
23183       }
23184     ],
23185     "name": "DescribeAccounts",
23186     "group": "Sms_Accounts",
23187     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23188     "version": "0.0.0",
23189     "filename": "server/api/smsAccount/index.js",
23190     "groupTitle": "Sms_Accounts"
23191   },
23192   {
23193     "type": "get",
23194     "url": "/api/sms/accounts",
23195     "title": "Gets a list of Accounts",
23196     "examples": [
23197       {
23198         "title": "Example usage:",
23199         "content": "curl https://{domain}/api/sms/accounts -v -u {name}:{password}",
23200         "type": "json"
23201       }
23202     ],
23203     "name": "GetAccounts",
23204     "group": "Sms_Accounts",
23205     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
23206     "version": "0.0.0",
23207     "filename": "server/api/smsAccount/index.js",
23208     "groupTitle": "Sms_Accounts"
23209   },
23210   {
23211     "type": "get",
23212     "url": "/api/sms/accounts/{id}/users",
23213     "title": "Gets agents from sms account",
23214     "examples": [
23215       {
23216         "title": "Example usage:",
23217         "content": "curl https://{domain}/api/sms/accounts/{id}/users -v -u {name}:{password} -X GET",
23218         "type": "json"
23219       }
23220     ],
23221     "name": "GetAgents",
23222     "group": "Sms_Accounts",
23223     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23224     "version": "0.0.0",
23225     "filename": "server/api/smsAccount/index.js",
23226     "groupTitle": "Sms_Accounts"
23227   },
23228   {
23229     "type": "delete",
23230     "url": "/api/sms/accounts/{id}/users",
23231     "title": "Removes agents from a sms account",
23232     "examples": [
23233       {
23234         "title": "Example usage:",
23235         "content": "curl https://{domain}/api/sms/accounts/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
23236         "type": "json"
23237       }
23238     ],
23239     "name": "RemoveAgents",
23240     "group": "Sms_Accounts",
23241     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23242     "version": "0.0.0",
23243     "filename": "server/api/smsAccount/index.js",
23244     "groupTitle": "Sms_Accounts"
23245   },
23246   {
23247     "type": "delete",
23248     "url": "/api/sms/accounts/{id}/canned_answers",
23249     "title": "Removes canned answers from account",
23250     "examples": [
23251       {
23252         "title": "Example usage:",
23253         "content": "curl https://{domain}/api/sms/accounts/{id}/canned_answers?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
23254         "type": "json"
23255       }
23256     ],
23257     "name": "RemoveAnswers",
23258     "group": "Sms_Accounts",
23259     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23260     "version": "0.0.0",
23261     "filename": "server/api/smsAccount/index.js",
23262     "groupTitle": "Sms_Accounts"
23263   },
23264   {
23265     "type": "delete",
23266     "url": "/api/sms/accounts/{id}/dispositions",
23267     "title": "Removes dispositions from account",
23268     "examples": [
23269       {
23270         "title": "Example usage:",
23271         "content": "curl https://{domain}/api/sms/accounts/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
23272         "type": "json"
23273       }
23274     ],
23275     "name": "RemoveDispositions",
23276     "group": "Sms_Accounts",
23277     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23278     "version": "0.0.0",
23279     "filename": "server/api/smsAccount/index.js",
23280     "groupTitle": "Sms_Accounts"
23281   },
23282   {
23283     "type": "get",
23284     "url": "/api/sms/accounts/{id}",
23285     "title": "Gets a single Account",
23286     "examples": [
23287       {
23288         "title": "Example usage:",
23289         "content": "curl https://{domain}/api/sms/accounts/{id} -v -u {name}:{password}",
23290         "type": "json"
23291       }
23292     ],
23293     "name": "ShowAccounts",
23294     "group": "Sms_Accounts",
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/smsAccount/index.js",
23298     "groupTitle": "Sms_Accounts"
23299   },
23300   {
23301     "type": "put",
23302     "url": "/api/sms/messages/{id}/accept",
23303     "title": "Accepts message",
23304     "examples": [
23305       {
23306         "title": "Example usage:",
23307         "content": "curl https://{domain}/api/sms/messages/{id}/accept \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
23308         "type": "json"
23309       }
23310     ],
23311     "name": "acceptMessage",
23312     "group": "Sms_Accounts",
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/smsMessage/index.js",
23316     "groupTitle": "Sms_Accounts"
23317   },
23318   {
23319     "type": "post",
23320     "url": "/api/sms/accounts/{id}/canned_answers",
23321     "title": "Creates new canned answer",
23322     "examples": [
23323       {
23324         "title": "Example usage:",
23325         "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",
23326         "type": "json"
23327       }
23328     ],
23329     "name": "addAnswer",
23330     "group": "Sms_Accounts",
23331     "parameter": {
23332       "fields": {
23333         "Body": [
23334           {
23335             "group": "Body",
23336             "type": "String",
23337             "optional": false,
23338             "field": "key",
23339             "description": ""
23340           },
23341           {
23342             "group": "Body",
23343             "type": "Text",
23344             "optional": false,
23345             "field": "value",
23346             "description": ""
23347           },
23348           {
23349             "group": "Body",
23350             "type": "String",
23351             "optional": true,
23352             "field": "description",
23353             "description": ""
23354           },
23355           {
23356             "group": "Body",
23357             "type": "Virtual",
23358             "optional": true,
23359             "field": "name",
23360             "description": ""
23361           }
23362         ]
23363       }
23364     },
23365     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23366     "version": "0.0.0",
23367     "filename": "server/api/smsAccount/index.js",
23368     "groupTitle": "Sms_Accounts"
23369   },
23370   {
23371     "type": "post",
23372     "url": "/api/sms/accounts/{id}/applications",
23373     "title": "Creates new applications",
23374     "examples": [
23375       {
23376         "title": "Example usage:",
23377         "content": "curl https://{domain}/api/sms/accounts/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
23378         "type": "json"
23379       }
23380     ],
23381     "name": "addApplications",
23382     "group": "Sms_Accounts",
23383     "parameter": {
23384       "fields": {
23385         "Body": [
23386           {
23387             "group": "Body",
23388             "type": "Integer",
23389             "optional": false,
23390             "field": "priority",
23391             "description": ""
23392           },
23393           {
23394             "group": "Body",
23395             "type": "String",
23396             "optional": false,
23397             "field": "app",
23398             "description": ""
23399           },
23400           {
23401             "group": "Body",
23402             "type": "Text",
23403             "optional": true,
23404             "field": "appdata",
23405             "description": ""
23406           },
23407           {
23408             "group": "Body",
23409             "type": "String",
23410             "optional": true,
23411             "field": "description",
23412             "description": ""
23413           },
23414           {
23415             "group": "Body",
23416             "type": "String",
23417             "optional": true,
23418             "field": "interval",
23419             "description": ""
23420           }
23421         ]
23422       }
23423     },
23424     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23425     "version": "0.0.0",
23426     "filename": "server/api/smsAccount/index.js",
23427     "groupTitle": "Sms_Accounts"
23428   },
23429   {
23430     "type": "post",
23431     "url": "/api/sms/accounts/{id}/dispositions",
23432     "title": "Creates new disposition",
23433     "examples": [
23434       {
23435         "title": "Example usage:",
23436         "content": "curl https://{domain}/api/sms/accounts/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
23437         "type": "json"
23438       }
23439     ],
23440     "name": "addDisposition",
23441     "group": "Sms_Accounts",
23442     "parameter": {
23443       "fields": {
23444         "Body": [
23445           {
23446             "group": "Body",
23447             "type": "String",
23448             "optional": false,
23449             "field": "name",
23450             "description": ""
23451           },
23452           {
23453             "group": "Body",
23454             "type": "String",
23455             "allowedValues": [
23456               "\"first\"",
23457               "\"second\"",
23458               "\"third\""
23459             ],
23460             "optional": false,
23461             "field": "level",
23462             "description": ""
23463           },
23464           {
23465             "group": "Body",
23466             "type": "String",
23467             "optional": true,
23468             "field": "description",
23469             "description": ""
23470           }
23471         ]
23472       }
23473     },
23474     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23475     "version": "0.0.0",
23476     "filename": "server/api/smsAccount/index.js",
23477     "groupTitle": "Sms_Accounts"
23478   },
23479   {
23480     "type": "get",
23481     "url": "/api/sms/accounts/{id}/canned_answers",
23482     "title": "Gets account canned answers",
23483     "examples": [
23484       {
23485         "title": "Example usage:",
23486         "content": "curl https://{domain}/api/sms/accounts/{id}/canned_answers -v -u {name}:{password} -X GET",
23487         "type": "json"
23488       }
23489     ],
23490     "name": "getAnswers",
23491     "group": "Sms_Accounts",
23492     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23493     "version": "0.0.0",
23494     "filename": "server/api/smsAccount/index.js",
23495     "groupTitle": "Sms_Accounts"
23496   },
23497   {
23498     "type": "get",
23499     "url": "/api/sms/accounts/{id}/applications",
23500     "title": "Gets account applications",
23501     "examples": [
23502       {
23503         "title": "Example usage:",
23504         "content": "curl https://{domain}/api/sms/accounts/{id}/applications -v -u {name}:{password} -X GET",
23505         "type": "json"
23506       }
23507     ],
23508     "name": "getApplications",
23509     "group": "Sms_Accounts",
23510     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23511     "version": "0.0.0",
23512     "filename": "server/api/smsAccount/index.js",
23513     "groupTitle": "Sms_Accounts"
23514   },
23515   {
23516     "type": "get",
23517     "url": "/api/sms/accounts/{id}/dispositions",
23518     "title": "Gets account dispositions",
23519     "examples": [
23520       {
23521         "title": "Example usage:",
23522         "content": "curl https://{domain}/api/sms/accounts/{id}/dispositions -v -u {name}:{password} -X GET",
23523         "type": "json"
23524       }
23525     ],
23526     "name": "getDispositions",
23527     "group": "Sms_Accounts",
23528     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23529     "version": "0.0.0",
23530     "filename": "server/api/smsAccount/index.js",
23531     "groupTitle": "Sms_Accounts"
23532   },
23533   {
23534     "type": "get",
23535     "url": "/api/sms/accounts/{id}/interactions",
23536     "title": "Gets Sms Account interactions",
23537     "examples": [
23538       {
23539         "title": "Example usage:",
23540         "content": "curl https://{domain}/api/sms/accounts/{id}/interactions -v -u {name}:{password} -X GET",
23541         "type": "json"
23542       }
23543     ],
23544     "name": "getInteractions",
23545     "group": "Sms_Accounts",
23546     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23547     "version": "0.0.0",
23548     "filename": "server/api/smsAccount/index.js",
23549     "groupTitle": "Sms_Accounts"
23550   },
23551   {
23552     "type": "post",
23553     "url": "/api/sms/accounts/{id}/notify",
23554     "title": "Notify new message",
23555     "examples": [
23556       {
23557         "title": "Example usage:",
23558         "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",
23559         "type": "json"
23560       }
23561     ],
23562     "name": "notify",
23563     "group": "Sms_Accounts",
23564     "description": "<p>Motion 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>",
23565     "version": "0.0.0",
23566     "filename": "server/api/smsAccount/index.js",
23567     "groupTitle": "Sms_Accounts"
23568   },
23569   {
23570     "type": "put",
23571     "url": "/api/sms/messages/{id}/reject",
23572     "title": "Rejects message",
23573     "examples": [
23574       {
23575         "title": "Example usage:",
23576         "content": "curl https://{domain}/api/sms/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
23577         "type": "json"
23578       }
23579     ],
23580     "name": "rejectMessage",
23581     "group": "Sms_Accounts",
23582     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23583     "version": "0.0.0",
23584     "filename": "server/api/smsMessage/index.js",
23585     "groupTitle": "Sms_Accounts"
23586   },
23587   {
23588     "type": "post",
23589     "url": "/api/sms/accounts/{id}/send",
23590     "title": "Send new sms message",
23591     "examples": [
23592       {
23593         "title": "Example usage:",
23594         "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",
23595         "type": "json"
23596       }
23597     ],
23598     "name": "sendSms",
23599     "group": "Sms_Accounts",
23600     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23601     "version": "0.0.0",
23602     "filename": "server/api/smsAccount/index.js",
23603     "groupTitle": "Sms_Accounts"
23604   },
23605   {
23606     "type": "post",
23607     "url": "/api/sms/messages/{id}/status",
23608     "title": "Receive message status",
23609     "examples": [
23610       {
23611         "title": "Example usage:",
23612         "content": "curl https://{domain}/api/sms/messages/{id}/status \\ \n -H 'Content-Type: application/json' -v -X POST",
23613         "type": "json"
23614       }
23615     ],
23616     "name": "statusMessage",
23617     "group": "Sms_Accounts",
23618     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23619     "version": "0.0.0",
23620     "filename": "server/api/smsMessage/index.js",
23621     "groupTitle": "Sms_Accounts"
23622   },
23623   {
23624     "type": "get",
23625     "url": "/api/sms/accounts/{id}/status",
23626     "title": "Receive message status as get request",
23627     "examples": [
23628       {
23629         "title": "Example usage:",
23630         "content": "curl https://{domain}/api/sms/accounts/{id}/status -H 'Content-Type: application/json' -v -X GET",
23631         "type": "json"
23632       }
23633     ],
23634     "name": "statusMessage",
23635     "group": "Sms_Accounts",
23636     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23637     "version": "0.0.0",
23638     "filename": "server/api/smsAccount/index.js",
23639     "groupTitle": "Sms_Accounts"
23640   },
23641   {
23642     "type": "post",
23643     "url": "/api/sms/accounts/{id}/status",
23644     "title": "Receive message status",
23645     "examples": [
23646       {
23647         "title": "Example usage:",
23648         "content": "curl https://{domain}/api/sms/accounts/{id}/status -H 'Content-Type: application/json' -v -X POST",
23649         "type": "json"
23650       }
23651     ],
23652     "name": "statusMessage",
23653     "group": "Sms_Accounts",
23654     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23655     "version": "0.0.0",
23656     "filename": "server/api/smsAccount/index.js",
23657     "groupTitle": "Sms_Accounts"
23658   },
23659   {
23660     "type": "put",
23661     "url": "/api/sms/accounts/{id}",
23662     "title": "Update an existing Account",
23663     "examples": [
23664       {
23665         "title": "Example usage:",
23666         "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",
23667         "type": "json"
23668       }
23669     ],
23670     "name": "updateAccounts",
23671     "group": "Sms_Accounts",
23672     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23673     "version": "0.0.0",
23674     "filename": "server/api/smsAccount/index.js",
23675     "groupTitle": "Sms_Accounts"
23676   },
23677   {
23678     "type": "post",
23679     "url": "/api/sms/applications",
23680     "title": "Creates a new Application",
23681     "examples": [
23682       {
23683         "title": "Example usage:",
23684         "content": "curl https://{domain}/api/sms/applications -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
23685         "type": "json"
23686       }
23687     ],
23688     "name": "CreateApplications",
23689     "group": "Sms_Applications",
23690     "parameter": {
23691       "fields": {
23692         "Body": [
23693           {
23694             "group": "Body",
23695             "type": "Integer",
23696             "optional": false,
23697             "field": "priority",
23698             "description": ""
23699           },
23700           {
23701             "group": "Body",
23702             "type": "String",
23703             "optional": false,
23704             "field": "app",
23705             "description": ""
23706           },
23707           {
23708             "group": "Body",
23709             "type": "Text",
23710             "optional": true,
23711             "field": "appdata",
23712             "description": ""
23713           },
23714           {
23715             "group": "Body",
23716             "type": "String",
23717             "optional": true,
23718             "field": "description",
23719             "description": ""
23720           },
23721           {
23722             "group": "Body",
23723             "type": "String",
23724             "optional": true,
23725             "field": "interval",
23726             "description": ""
23727           }
23728         ]
23729       }
23730     },
23731     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23732     "version": "0.0.0",
23733     "filename": "server/api/smsApplication/index.js",
23734     "groupTitle": "Sms_Applications"
23735   },
23736   {
23737     "type": "delete",
23738     "url": "/api/sms/applications/{id}",
23739     "title": "Deletes a Application",
23740     "examples": [
23741       {
23742         "title": "Example usage:",
23743         "content": "curl https://{domain}/api/sms/applications/{id} -v -u {name}:{password} -X DELETE",
23744         "type": "json"
23745       }
23746     ],
23747     "name": "DeleteApplications",
23748     "group": "Sms_Applications",
23749     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23750     "version": "0.0.0",
23751     "filename": "server/api/smsApplication/index.js",
23752     "groupTitle": "Sms_Applications"
23753   },
23754   {
23755     "type": "get",
23756     "url": "/api/sms/applications",
23757     "title": "Gets a list of Applications",
23758     "examples": [
23759       {
23760         "title": "Example usage:",
23761         "content": "curl https://{domain}/api/sms/applications -v -u {name}:{password}",
23762         "type": "json"
23763       }
23764     ],
23765     "name": "GetApplications",
23766     "group": "Sms_Applications",
23767     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
23768     "version": "0.0.0",
23769     "filename": "server/api/smsApplication/index.js",
23770     "groupTitle": "Sms_Applications"
23771   },
23772   {
23773     "type": "get",
23774     "url": "/api/sms/applications/{id}",
23775     "title": "Gets a single Application",
23776     "examples": [
23777       {
23778         "title": "Example usage:",
23779         "content": "curl https://{domain}/api/sms/applications/{id} -v -u {name}:{password}",
23780         "type": "json"
23781       }
23782     ],
23783     "name": "ShowApplications",
23784     "group": "Sms_Applications",
23785     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23786     "version": "0.0.0",
23787     "filename": "server/api/smsApplication/index.js",
23788     "groupTitle": "Sms_Applications"
23789   },
23790   {
23791     "type": "put",
23792     "url": "/api/sms/applications/{id}",
23793     "title": "Update an existing Application",
23794     "examples": [
23795       {
23796         "title": "Example usage:",
23797         "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",
23798         "type": "json"
23799       }
23800     ],
23801     "name": "updateApplications",
23802     "group": "Sms_Applications",
23803     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23804     "version": "0.0.0",
23805     "filename": "server/api/smsApplication/index.js",
23806     "groupTitle": "Sms_Applications"
23807   },
23808   {
23809     "type": "post",
23810     "url": "/api/sms/interactions/{id}/tags",
23811     "title": "Add tags to the interaction",
23812     "examples": [
23813       {
23814         "title": "Example usage:",
23815         "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",
23816         "type": "json"
23817       }
23818     ],
23819     "name": "AddTags",
23820     "group": "Sms_Interactions",
23821     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23822     "version": "0.0.0",
23823     "filename": "server/api/smsInteraction/index.js",
23824     "groupTitle": "Sms_Interactions"
23825   },
23826   {
23827     "type": "post",
23828     "url": "/api/sms/interactions",
23829     "title": "Creates a new Interaction",
23830     "examples": [
23831       {
23832         "title": "Example usage:",
23833         "content": "curl https://{domain}/api/sms/interactions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
23834         "type": "json"
23835       }
23836     ],
23837     "name": "CreateInteractions",
23838     "group": "Sms_Interactions",
23839     "parameter": {
23840       "fields": {
23841         "Body": [
23842           {
23843             "group": "Body",
23844             "type": "Boolean",
23845             "optional": true,
23846             "field": "closed",
23847             "description": ""
23848           },
23849           {
23850             "group": "Body",
23851             "type": "String",
23852             "optional": true,
23853             "field": "closedAt",
23854             "description": ""
23855           },
23856           {
23857             "group": "Body",
23858             "type": "String",
23859             "optional": true,
23860             "field": "disposition",
23861             "description": ""
23862           },
23863           {
23864             "group": "Body",
23865             "type": "String",
23866             "optional": true,
23867             "field": "secondDisposition",
23868             "description": ""
23869           },
23870           {
23871             "group": "Body",
23872             "type": "String",
23873             "optional": true,
23874             "field": "thirdDisposition",
23875             "description": ""
23876           },
23877           {
23878             "group": "Body",
23879             "type": "String",
23880             "optional": true,
23881             "field": "note",
23882             "description": ""
23883           },
23884           {
23885             "group": "Body",
23886             "type": "String",
23887             "optional": true,
23888             "field": "phone",
23889             "description": ""
23890           },
23891           {
23892             "group": "Body",
23893             "type": "String",
23894             "optional": true,
23895             "field": "read1stAt",
23896             "description": ""
23897           },
23898           {
23899             "group": "Body",
23900             "type": "String",
23901             "allowedValues": [
23902               "\"in\"",
23903               "\"out\""
23904             ],
23905             "optional": false,
23906             "field": "firstMsgDirection",
23907             "description": ""
23908           },
23909           {
23910             "group": "Body",
23911             "type": "String",
23912             "optional": true,
23913             "field": "lastMsgAt",
23914             "description": ""
23915           },
23916           {
23917             "group": "Body",
23918             "type": "String",
23919             "allowedValues": [
23920               "\"in\"",
23921               "\"out\""
23922             ],
23923             "optional": false,
23924             "field": "lastMsgDirection",
23925             "description": ""
23926           },
23927           {
23928             "group": "Body",
23929             "type": "Boolean",
23930             "optional": true,
23931             "field": "autoreplyExecuted",
23932             "description": ""
23933           }
23934         ]
23935       }
23936     },
23937     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23938     "version": "0.0.0",
23939     "filename": "server/api/smsInteraction/index.js",
23940     "groupTitle": "Sms_Interactions"
23941   },
23942   {
23943     "type": "delete",
23944     "url": "/api/sms/interactions/{id}",
23945     "title": "Deletes a Interaction",
23946     "examples": [
23947       {
23948         "title": "Example usage:",
23949         "content": "curl https://{domain}/api/sms/interactions/{id} -v -u {name}:{password} -X DELETE",
23950         "type": "json"
23951       }
23952     ],
23953     "name": "DeleteInteractions",
23954     "group": "Sms_Interactions",
23955     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23956     "version": "0.0.0",
23957     "filename": "server/api/smsInteraction/index.js",
23958     "groupTitle": "Sms_Interactions"
23959   },
23960   {
23961     "type": "get",
23962     "url": "/api/sms/interactions/describe",
23963     "title": "Gets table info about Interactions",
23964     "examples": [
23965       {
23966         "title": "Example usage:",
23967         "content": "curl https://{domain}/api/sms/interactions/describe -v -u {name}:{password}",
23968         "type": "json"
23969       }
23970     ],
23971     "name": "DescribeInteractions",
23972     "group": "Sms_Interactions",
23973     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23974     "version": "0.0.0",
23975     "filename": "server/api/smsInteraction/index.js",
23976     "groupTitle": "Sms_Interactions"
23977   },
23978   {
23979     "type": "get",
23980     "url": "/api/sms/interactions",
23981     "title": "Gets a list of Interactions",
23982     "examples": [
23983       {
23984         "title": "Example usage:",
23985         "content": "curl https://{domain}/api/sms/interactions -v -u {name}:{password}",
23986         "type": "json"
23987       }
23988     ],
23989     "name": "GetInteractions",
23990     "group": "Sms_Interactions",
23991     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
23992     "version": "0.0.0",
23993     "filename": "server/api/smsInteraction/index.js",
23994     "groupTitle": "Sms_Interactions"
23995   },
23996   {
23997     "type": "delete",
23998     "url": "/api/sms/interactions/{id}/tags",
23999     "title": "Removes tags from interaction",
24000     "examples": [
24001       {
24002         "title": "Example usage:",
24003         "content": "curl https://{domain}/api/sms/interactions/{id}/tags?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
24004         "type": "json"
24005       }
24006     ],
24007     "name": "RemoveTags",
24008     "group": "Sms_Interactions",
24009     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24010     "version": "0.0.0",
24011     "filename": "server/api/smsInteraction/index.js",
24012     "groupTitle": "Sms_Interactions"
24013   },
24014   {
24015     "type": "get",
24016     "url": "/api/sms/interactions/{id}",
24017     "title": "Gets a single Interaction",
24018     "examples": [
24019       {
24020         "title": "Example usage:",
24021         "content": "curl https://{domain}/api/sms/interactions/{id} -v -u {name}:{password}",
24022         "type": "json"
24023       }
24024     ],
24025     "name": "ShowInteractions",
24026     "group": "Sms_Interactions",
24027     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24028     "version": "0.0.0",
24029     "filename": "server/api/smsInteraction/index.js",
24030     "groupTitle": "Sms_Interactions"
24031   },
24032   {
24033     "type": "post",
24034     "url": "/api/sms/interactions/{id}/messages",
24035     "title": "Creates new messages",
24036     "examples": [
24037       {
24038         "title": "Example usage:",
24039         "content": "curl https://{domain}/api/sms/interactions/{id}/messages -d '[{\"to\": \"+3901119886500\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
24040         "type": "json"
24041       }
24042     ],
24043     "name": "addMessage",
24044     "group": "Sms_Interactions",
24045     "parameter": {
24046       "fields": {
24047         "Body": [
24048           {
24049             "group": "Body",
24050             "type": "Text",
24051             "optional": false,
24052             "field": "body",
24053             "description": ""
24054           },
24055           {
24056             "group": "Body",
24057             "type": "Boolean",
24058             "optional": true,
24059             "field": "read",
24060             "description": ""
24061           },
24062           {
24063             "group": "Body",
24064             "type": "String",
24065             "allowedValues": [
24066               "\"in\"",
24067               "\"out\""
24068             ],
24069             "optional": false,
24070             "field": "direction",
24071             "description": ""
24072           },
24073           {
24074             "group": "Body",
24075             "type": "String",
24076             "optional": true,
24077             "field": "messageId",
24078             "description": ""
24079           },
24080           {
24081             "group": "Body",
24082             "type": "String",
24083             "optional": true,
24084             "field": "phone",
24085             "description": ""
24086           },
24087           {
24088             "group": "Body",
24089             "type": "String",
24090             "optional": true,
24091             "field": "readAt",
24092             "description": ""
24093           },
24094           {
24095             "group": "Body",
24096             "type": "Boolean",
24097             "optional": true,
24098             "field": "secret",
24099             "description": ""
24100           },
24101           {
24102             "group": "Body",
24103             "type": "String",
24104             "optional": true,
24105             "field": "providerName",
24106             "description": ""
24107           },
24108           {
24109             "group": "Body",
24110             "type": "Text",
24111             "optional": true,
24112             "field": "providerResponse",
24113             "description": ""
24114           }
24115         ]
24116       }
24117     },
24118     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24119     "version": "0.0.0",
24120     "filename": "server/api/smsInteraction/index.js",
24121     "groupTitle": "Sms_Interactions"
24122   },
24123   {
24124     "type": "get",
24125     "url": "/api/sms/interactions/{id}/download",
24126     "title": "Gets interaction",
24127     "examples": [
24128       {
24129         "title": "Example usage:",
24130         "content": "curl https://{domain}/api/sms/interactions/{id}/download -v -u {name}:{password} -X GET",
24131         "type": "json"
24132       }
24133     ],
24134     "name": "download",
24135     "group": "Sms_Interactions",
24136     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24137     "version": "0.0.0",
24138     "filename": "server/api/smsInteraction/index.js",
24139     "groupTitle": "Sms_Interactions"
24140   },
24141   {
24142     "type": "get",
24143     "url": "/api/sms/interactions/{id}/messages",
24144     "title": "Gets interaction messages",
24145     "examples": [
24146       {
24147         "title": "Example usage:",
24148         "content": "curl https://{domain}/api/sms/interactions/{id}/messages -v -u {name}:{password} -X GET",
24149         "type": "json"
24150       }
24151     ],
24152     "name": "getMessages",
24153     "group": "Sms_Interactions",
24154     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24155     "version": "0.0.0",
24156     "filename": "server/api/smsInteraction/index.js",
24157     "groupTitle": "Sms_Interactions"
24158   },
24159   {
24160     "type": "put",
24161     "url": "/api/sms/interactions/{id}",
24162     "title": "Update an existing Interaction",
24163     "examples": [
24164       {
24165         "title": "Example usage:",
24166         "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",
24167         "type": "json"
24168       }
24169     ],
24170     "name": "updateInteractions",
24171     "group": "Sms_Interactions",
24172     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24173     "version": "0.0.0",
24174     "filename": "server/api/smsInteraction/index.js",
24175     "groupTitle": "Sms_Interactions"
24176   },
24177   {
24178     "type": "post",
24179     "url": "/api/sms/messages",
24180     "title": "Creates a new Message",
24181     "examples": [
24182       {
24183         "title": "Example usage:",
24184         "content": "curl https://{domain}/api/sms/messages -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
24185         "type": "json"
24186       }
24187     ],
24188     "name": "CreateMessages",
24189     "group": "Sms_Messages",
24190     "parameter": {
24191       "fields": {
24192         "Body": [
24193           {
24194             "group": "Body",
24195             "type": "Text",
24196             "optional": false,
24197             "field": "body",
24198             "description": ""
24199           },
24200           {
24201             "group": "Body",
24202             "type": "Boolean",
24203             "optional": true,
24204             "field": "read",
24205             "description": ""
24206           },
24207           {
24208             "group": "Body",
24209             "type": "String",
24210             "allowedValues": [
24211               "\"in\"",
24212               "\"out\""
24213             ],
24214             "optional": false,
24215             "field": "direction",
24216             "description": ""
24217           },
24218           {
24219             "group": "Body",
24220             "type": "String",
24221             "optional": true,
24222             "field": "messageId",
24223             "description": ""
24224           },
24225           {
24226             "group": "Body",
24227             "type": "String",
24228             "optional": true,
24229             "field": "phone",
24230             "description": ""
24231           },
24232           {
24233             "group": "Body",
24234             "type": "String",
24235             "optional": true,
24236             "field": "readAt",
24237             "description": ""
24238           },
24239           {
24240             "group": "Body",
24241             "type": "Boolean",
24242             "optional": true,
24243             "field": "secret",
24244             "description": ""
24245           },
24246           {
24247             "group": "Body",
24248             "type": "String",
24249             "optional": true,
24250             "field": "providerName",
24251             "description": ""
24252           },
24253           {
24254             "group": "Body",
24255             "type": "Text",
24256             "optional": true,
24257             "field": "providerResponse",
24258             "description": ""
24259           }
24260         ]
24261       }
24262     },
24263     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24264     "version": "0.0.0",
24265     "filename": "server/api/smsMessage/index.js",
24266     "groupTitle": "Sms_Messages"
24267   },
24268   {
24269     "type": "delete",
24270     "url": "/api/sms/messages/{id}",
24271     "title": "Deletes a Message",
24272     "examples": [
24273       {
24274         "title": "Example usage:",
24275         "content": "curl https://{domain}/api/sms/messages/{id} -v -u {name}:{password} -X DELETE",
24276         "type": "json"
24277       }
24278     ],
24279     "name": "DeleteMessages",
24280     "group": "Sms_Messages",
24281     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24282     "version": "0.0.0",
24283     "filename": "server/api/smsMessage/index.js",
24284     "groupTitle": "Sms_Messages"
24285   },
24286   {
24287     "type": "get",
24288     "url": "/api/sms/messages/describe",
24289     "title": "Gets table info about Messages",
24290     "examples": [
24291       {
24292         "title": "Example usage:",
24293         "content": "curl https://{domain}/api/sms/messages/describe -v -u {name}:{password}",
24294         "type": "json"
24295       }
24296     ],
24297     "name": "DescribeMessages",
24298     "group": "Sms_Messages",
24299     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24300     "version": "0.0.0",
24301     "filename": "server/api/smsMessage/index.js",
24302     "groupTitle": "Sms_Messages"
24303   },
24304   {
24305     "type": "get",
24306     "url": "/api/sms/messages",
24307     "title": "Gets a list of Messages",
24308     "examples": [
24309       {
24310         "title": "Example usage:",
24311         "content": "curl https://{domain}/api/sms/messages -v -u {name}:{password}",
24312         "type": "json"
24313       }
24314     ],
24315     "name": "GetMessages",
24316     "group": "Sms_Messages",
24317     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
24318     "version": "0.0.0",
24319     "filename": "server/api/smsMessage/index.js",
24320     "groupTitle": "Sms_Messages"
24321   },
24322   {
24323     "type": "get",
24324     "url": "/api/sms/messages/{id}",
24325     "title": "Gets a single Message",
24326     "examples": [
24327       {
24328         "title": "Example usage:",
24329         "content": "curl https://{domain}/api/sms/messages/{id} -v -u {name}:{password}",
24330         "type": "json"
24331       }
24332     ],
24333     "name": "ShowMessages",
24334     "group": "Sms_Messages",
24335     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24336     "version": "0.0.0",
24337     "filename": "server/api/smsMessage/index.js",
24338     "groupTitle": "Sms_Messages"
24339   },
24340   {
24341     "type": "put",
24342     "url": "/api/sms/messages/{id}",
24343     "title": "Update an existing Message",
24344     "examples": [
24345       {
24346         "title": "Example usage:",
24347         "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",
24348         "type": "json"
24349       }
24350     ],
24351     "name": "updateMessages",
24352     "group": "Sms_Messages",
24353     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24354     "version": "0.0.0",
24355     "filename": "server/api/smsMessage/index.js",
24356     "groupTitle": "Sms_Messages"
24357   },
24358   {
24359     "type": "post",
24360     "url": "/api/sms/reports/queue",
24361     "title": "Creates a new Sms Queue Report",
24362     "examples": [
24363       {
24364         "title": "Example usage:",
24365         "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",
24366         "type": "json"
24367       }
24368     ],
24369     "name": "CreateSms_Queue_Reports",
24370     "group": "Sms_Queue_Reports",
24371     "parameter": {
24372       "fields": {
24373         "Body": [
24374           {
24375             "group": "Body",
24376             "type": "String",
24377             "optional": false,
24378             "field": "uniqueid",
24379             "description": ""
24380           },
24381           {
24382             "group": "Body",
24383             "type": "String",
24384             "optional": true,
24385             "field": "from",
24386             "description": ""
24387           },
24388           {
24389             "group": "Body",
24390             "type": "String",
24391             "optional": true,
24392             "field": "joinAt",
24393             "description": ""
24394           },
24395           {
24396             "group": "Body",
24397             "type": "String",
24398             "optional": true,
24399             "field": "leaveAt",
24400             "description": ""
24401           },
24402           {
24403             "group": "Body",
24404             "type": "String",
24405             "optional": true,
24406             "field": "acceptAt",
24407             "description": ""
24408           },
24409           {
24410             "group": "Body",
24411             "type": "String",
24412             "optional": true,
24413             "field": "exitAt",
24414             "description": ""
24415           },
24416           {
24417             "group": "Body",
24418             "type": "String",
24419             "optional": true,
24420             "field": "reason",
24421             "description": ""
24422           }
24423         ]
24424       }
24425     },
24426     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24427     "version": "0.0.0",
24428     "filename": "server/api/smsQueueReport/index.js",
24429     "groupTitle": "Sms_Queue_Reports"
24430   },
24431   {
24432     "type": "delete",
24433     "url": "/api/sms/reports/queue/{id}",
24434     "title": "Deletes a Sms Queue Report",
24435     "examples": [
24436       {
24437         "title": "Example usage:",
24438         "content": "curl https://{domain}/api/sms/reports/queue/{id} -v -u {name}:{password} -X DELETE",
24439         "type": "json"
24440       }
24441     ],
24442     "name": "DeleteSms_Queue_Reports",
24443     "group": "Sms_Queue_Reports",
24444     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24445     "version": "0.0.0",
24446     "filename": "server/api/smsQueueReport/index.js",
24447     "groupTitle": "Sms_Queue_Reports"
24448   },
24449   {
24450     "type": "get",
24451     "url": "/api/sms/reports/queue/describe",
24452     "title": "Gets table info about Sms Queue Reports",
24453     "examples": [
24454       {
24455         "title": "Example usage:",
24456         "content": "curl https://{domain}/api/sms/reports/queue/describe -v -u {name}:{password}",
24457         "type": "json"
24458       }
24459     ],
24460     "name": "DescribeSms_Queue_Reports",
24461     "group": "Sms_Queue_Reports",
24462     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24463     "version": "0.0.0",
24464     "filename": "server/api/smsQueueReport/index.js",
24465     "groupTitle": "Sms_Queue_Reports"
24466   },
24467   {
24468     "type": "get",
24469     "url": "/api/sms/reports/queue",
24470     "title": "Gets a list of Sms Queue Reports",
24471     "examples": [
24472       {
24473         "title": "Example usage:",
24474         "content": "curl https://{domain}/api/sms/reports/queue -v -u {name}:{password}",
24475         "type": "json"
24476       }
24477     ],
24478     "name": "GetSms_Queue_Reports",
24479     "group": "Sms_Queue_Reports",
24480     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
24481     "version": "0.0.0",
24482     "filename": "server/api/smsQueueReport/index.js",
24483     "groupTitle": "Sms_Queue_Reports"
24484   },
24485   {
24486     "type": "get",
24487     "url": "/api/sms/reports/queue/{id}",
24488     "title": "Gets a single Sms Queue Report",
24489     "examples": [
24490       {
24491         "title": "Example usage:",
24492         "content": "curl https://{domain}/api/sms/reports/queue/{id} -v -u {name}:{password}",
24493         "type": "json"
24494       }
24495     ],
24496     "name": "ShowSms_Queue_Reports",
24497     "group": "Sms_Queue_Reports",
24498     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24499     "version": "0.0.0",
24500     "filename": "server/api/smsQueueReport/index.js",
24501     "groupTitle": "Sms_Queue_Reports"
24502   },
24503   {
24504     "type": "put",
24505     "url": "/api/sms/reports/queue/{id}",
24506     "title": "Update an existing Sms Queue Report",
24507     "examples": [
24508       {
24509         "title": "Example usage:",
24510         "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",
24511         "type": "json"
24512       }
24513     ],
24514     "name": "updateSms_Queue_Reports",
24515     "group": "Sms_Queue_Reports",
24516     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24517     "version": "0.0.0",
24518     "filename": "server/api/smsQueueReport/index.js",
24519     "groupTitle": "Sms_Queue_Reports"
24520   },
24521   {
24522     "type": "post",
24523     "url": "/api/sms/queues/{id}/users",
24524     "title": "Add agents to a queue",
24525     "examples": [
24526       {
24527         "title": "Example usage:",
24528         "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",
24529         "type": "json"
24530       }
24531     ],
24532     "name": "AddAgents",
24533     "group": "Sms_Queues",
24534     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24535     "version": "0.0.0",
24536     "filename": "server/api/smsQueue/index.js",
24537     "groupTitle": "Sms_Queues"
24538   },
24539   {
24540     "type": "post",
24541     "url": "/api/sms/queues/{id}/teams",
24542     "title": "Add teams to a queue",
24543     "examples": [
24544       {
24545         "title": "Example usage:",
24546         "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",
24547         "type": "json"
24548       }
24549     ],
24550     "name": "AddTeams",
24551     "group": "Sms_Queues",
24552     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24553     "version": "0.0.0",
24554     "filename": "server/api/smsQueue/index.js",
24555     "groupTitle": "Sms_Queues"
24556   },
24557   {
24558     "type": "post",
24559     "url": "/api/sms/queues",
24560     "title": "Creates a new Queue",
24561     "examples": [
24562       {
24563         "title": "Example usage:",
24564         "content": "curl https://{domain}/api/sms/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
24565         "type": "json"
24566       }
24567     ],
24568     "name": "CreateQueues",
24569     "group": "Sms_Queues",
24570     "parameter": {
24571       "fields": {
24572         "Body": [
24573           {
24574             "group": "Body",
24575             "type": "String",
24576             "optional": true,
24577             "field": "name",
24578             "description": ""
24579           },
24580           {
24581             "group": "Body",
24582             "type": "String",
24583             "optional": true,
24584             "field": "description",
24585             "description": ""
24586           },
24587           {
24588             "group": "Body",
24589             "type": "Integer",
24590             "optional": true,
24591             "field": "timeout",
24592             "description": ""
24593           },
24594           {
24595             "group": "Body",
24596             "type": "String",
24597             "allowedValues": [
24598               "\"rrmemory\"",
24599               "\"beepall\"",
24600               "\"roundrobin\""
24601             ],
24602             "optional": true,
24603             "field": "strategy",
24604             "description": ""
24605           }
24606         ]
24607       }
24608     },
24609     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24610     "version": "0.0.0",
24611     "filename": "server/api/smsQueue/index.js",
24612     "groupTitle": "Sms_Queues"
24613   },
24614   {
24615     "type": "delete",
24616     "url": "/api/sms/queues/{id}",
24617     "title": "Deletes a Queue",
24618     "examples": [
24619       {
24620         "title": "Example usage:",
24621         "content": "curl https://{domain}/api/sms/queues/{id} -v -u {name}:{password} -X DELETE",
24622         "type": "json"
24623       }
24624     ],
24625     "name": "DeleteQueues",
24626     "group": "Sms_Queues",
24627     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24628     "version": "0.0.0",
24629     "filename": "server/api/smsQueue/index.js",
24630     "groupTitle": "Sms_Queues"
24631   },
24632   {
24633     "type": "get",
24634     "url": "/api/sms/queues/describe",
24635     "title": "Gets table info about Queues",
24636     "examples": [
24637       {
24638         "title": "Example usage:",
24639         "content": "curl https://{domain}/api/sms/queues/describe -v -u {name}:{password}",
24640         "type": "json"
24641       }
24642     ],
24643     "name": "DescribeQueues",
24644     "group": "Sms_Queues",
24645     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24646     "version": "0.0.0",
24647     "filename": "server/api/smsQueue/index.js",
24648     "groupTitle": "Sms_Queues"
24649   },
24650   {
24651     "type": "get",
24652     "url": "/api/sms/queues/{id}/users",
24653     "title": "Gets queue agents",
24654     "examples": [
24655       {
24656         "title": "Example usage:",
24657         "content": "curl https://{domain}/api/sms/queues/{id}/users -v -u {name}:{password} -X POST",
24658         "type": "json"
24659       }
24660     ],
24661     "name": "GetAgents",
24662     "group": "Sms_Queues",
24663     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24664     "version": "0.0.0",
24665     "filename": "server/api/smsQueue/index.js",
24666     "groupTitle": "Sms_Queues"
24667   },
24668   {
24669     "type": "get",
24670     "url": "/api/sms/queues/{id}/members",
24671     "title": "GetMembers",
24672     "examples": [
24673       {
24674         "title": "Example usage:",
24675         "content": "curl https://{domain}/api/sms/queues/{id}/members  -v -u {name}:{password}",
24676         "type": "json"
24677       }
24678     ],
24679     "name": "GetMembers",
24680     "group": "Sms_Queues",
24681     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24682     "version": "0.0.0",
24683     "filename": "server/api/smsQueue/index.js",
24684     "groupTitle": "Sms_Queues"
24685   },
24686   {
24687     "type": "get",
24688     "url": "/api/sms/queues",
24689     "title": "Gets a list of Queues",
24690     "examples": [
24691       {
24692         "title": "Example usage:",
24693         "content": "curl https://{domain}/api/sms/queues -v -u {name}:{password}",
24694         "type": "json"
24695       }
24696     ],
24697     "name": "GetQueues",
24698     "group": "Sms_Queues",
24699     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
24700     "version": "0.0.0",
24701     "filename": "server/api/smsQueue/index.js",
24702     "groupTitle": "Sms_Queues"
24703   },
24704   {
24705     "type": "get",
24706     "url": "/api/sms/queues/{id}/teams",
24707     "title": "Gets queues list",
24708     "examples": [
24709       {
24710         "title": "Example usage:",
24711         "content": "curl https://{domain}/api/sms/queues/{id}/teams -v -u {name}:{password}",
24712         "type": "json"
24713       }
24714     ],
24715     "name": "GetTeams",
24716     "group": "Sms_Queues",
24717     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24718     "version": "0.0.0",
24719     "filename": "server/api/smsQueue/index.js",
24720     "groupTitle": "Sms_Queues"
24721   },
24722   {
24723     "type": "delete",
24724     "url": "/api/sms/queues/{id}/users",
24725     "title": "Removes agents from a queue",
24726     "examples": [
24727       {
24728         "title": "Example usage:",
24729         "content": "curl https://{domain}/api/sms/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
24730         "type": "json"
24731       }
24732     ],
24733     "name": "RemoveAgents",
24734     "group": "Sms_Queues",
24735     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24736     "version": "0.0.0",
24737     "filename": "server/api/smsQueue/index.js",
24738     "groupTitle": "Sms_Queues"
24739   },
24740   {
24741     "type": "get",
24742     "url": "/api/sms/queues/{id}",
24743     "title": "Gets a single Queue",
24744     "examples": [
24745       {
24746         "title": "Example usage:",
24747         "content": "curl https://{domain}/api/sms/queues/{id} -v -u {name}:{password}",
24748         "type": "json"
24749       }
24750     ],
24751     "name": "ShowQueues",
24752     "group": "Sms_Queues",
24753     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24754     "version": "0.0.0",
24755     "filename": "server/api/smsQueue/index.js",
24756     "groupTitle": "Sms_Queues"
24757   },
24758   {
24759     "type": "put",
24760     "url": "/api/sms/queues/{id}",
24761     "title": "Update an existing Queue",
24762     "examples": [
24763       {
24764         "title": "Example usage:",
24765         "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",
24766         "type": "json"
24767       }
24768     ],
24769     "name": "updateQueues",
24770     "group": "Sms_Queues",
24771     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24772     "version": "0.0.0",
24773     "filename": "server/api/smsQueue/index.js",
24774     "groupTitle": "Sms_Queues"
24775   },
24776   {
24777     "type": "post",
24778     "url": "/api/sms/reports/transfer",
24779     "title": "Creates a new Sms Transfer Report",
24780     "examples": [
24781       {
24782         "title": "Example usage:",
24783         "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",
24784         "type": "json"
24785       }
24786     ],
24787     "name": "CreateSms_Transfer_Reports",
24788     "group": "Sms_Transfer_Reports",
24789     "parameter": {
24790       "fields": {
24791         "Body": [
24792           {
24793             "group": "Body",
24794             "type": "String",
24795             "optional": false,
24796             "field": "uniqueid",
24797             "description": ""
24798           },
24799           {
24800             "group": "Body",
24801             "type": "String",
24802             "allowedValues": [
24803               "\"account\"",
24804               "\"agent\"",
24805               "\"queue\""
24806             ],
24807             "optional": false,
24808             "field": "type",
24809             "description": ""
24810           },
24811           {
24812             "group": "Body",
24813             "type": "String",
24814             "optional": false,
24815             "field": "transferredAt",
24816             "description": ""
24817           }
24818         ]
24819       }
24820     },
24821     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24822     "version": "0.0.0",
24823     "filename": "server/api/smsTransferReport/index.js",
24824     "groupTitle": "Sms_Transfer_Reports"
24825   },
24826   {
24827     "type": "delete",
24828     "url": "/api/sms/reports/transfer/{id}",
24829     "title": "Deletes a Sms Transfer Report",
24830     "examples": [
24831       {
24832         "title": "Example usage:",
24833         "content": "curl https://{domain}/api/sms/reports/transfer/{id} -v -u {name}:{password} -X DELETE",
24834         "type": "json"
24835       }
24836     ],
24837     "name": "DeleteSms_Transfer_Reports",
24838     "group": "Sms_Transfer_Reports",
24839     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24840     "version": "0.0.0",
24841     "filename": "server/api/smsTransferReport/index.js",
24842     "groupTitle": "Sms_Transfer_Reports"
24843   },
24844   {
24845     "type": "get",
24846     "url": "/api/sms/reports/transfer/describe",
24847     "title": "Gets table info about Sms Transfer Reports",
24848     "examples": [
24849       {
24850         "title": "Example usage:",
24851         "content": "curl https://{domain}/api/sms/reports/transfer/describe -v -u {name}:{password}",
24852         "type": "json"
24853       }
24854     ],
24855     "name": "DescribeSms_Transfer_Reports",
24856     "group": "Sms_Transfer_Reports",
24857     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24858     "version": "0.0.0",
24859     "filename": "server/api/smsTransferReport/index.js",
24860     "groupTitle": "Sms_Transfer_Reports"
24861   },
24862   {
24863     "type": "get",
24864     "url": "/api/sms/reports/transfer",
24865     "title": "Gets a list of Sms Transfer Reports",
24866     "examples": [
24867       {
24868         "title": "Example usage:",
24869         "content": "curl https://{domain}/api/sms/reports/transfer -v -u {name}:{password}",
24870         "type": "json"
24871       }
24872     ],
24873     "name": "GetSms_Transfer_Reports",
24874     "group": "Sms_Transfer_Reports",
24875     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
24876     "version": "0.0.0",
24877     "filename": "server/api/smsTransferReport/index.js",
24878     "groupTitle": "Sms_Transfer_Reports"
24879   },
24880   {
24881     "type": "get",
24882     "url": "/api/sms/reports/transfer/{id}",
24883     "title": "Gets a single Sms Transfer Report",
24884     "examples": [
24885       {
24886         "title": "Example usage:",
24887         "content": "curl https://{domain}/api/sms/reports/transfer/{id} -v -u {name}:{password}",
24888         "type": "json"
24889       }
24890     ],
24891     "name": "ShowSms_Transfer_Reports",
24892     "group": "Sms_Transfer_Reports",
24893     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24894     "version": "0.0.0",
24895     "filename": "server/api/smsTransferReport/index.js",
24896     "groupTitle": "Sms_Transfer_Reports"
24897   },
24898   {
24899     "type": "put",
24900     "url": "/api/sms/reports/transfer/{id}",
24901     "title": "Update an existing Sms Transfer Report",
24902     "examples": [
24903       {
24904         "title": "Example usage:",
24905         "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",
24906         "type": "json"
24907       }
24908     ],
24909     "name": "updateSms_Transfer_Reports",
24910     "group": "Sms_Transfer_Reports",
24911     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24912     "version": "0.0.0",
24913     "filename": "server/api/smsTransferReport/index.js",
24914     "groupTitle": "Sms_Transfer_Reports"
24915   },
24916   {
24917     "type": "get",
24918     "url": "/api/sounds",
24919     "title": "Gets a list of Sounds",
24920     "examples": [
24921       {
24922         "title": "Example usage:",
24923         "content": "curl https://{domain}/api/sounds -v -u {name}:{password}",
24924         "type": "json"
24925       }
24926     ],
24927     "name": "GetSounds",
24928     "group": "Sounds",
24929     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
24930     "version": "0.0.0",
24931     "filename": "server/api/sound/index.js",
24932     "groupTitle": "Sounds"
24933   },
24934   {
24935     "type": "get",
24936     "url": "/api/sounds/{id}",
24937     "title": "Gets a single Sound",
24938     "examples": [
24939       {
24940         "title": "Example usage:",
24941         "content": "curl https://{domain}/api/sounds/{id} -v -u {name}:{password}",
24942         "type": "json"
24943       }
24944     ],
24945     "name": "ShowSounds",
24946     "group": "Sounds",
24947     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24948     "version": "0.0.0",
24949     "filename": "server/api/sound/index.js",
24950     "groupTitle": "Sounds"
24951   },
24952   {
24953     "type": "post",
24954     "url": "/api/sounds",
24955     "title": "Create a new sound",
24956     "examples": [
24957       {
24958         "title": "Example usage:",
24959         "content": "curl https://{domain}/api/sounds -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
24960         "type": "json"
24961       }
24962     ],
24963     "name": "addSound",
24964     "group": "Sounds",
24965     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24966     "version": "0.0.0",
24967     "filename": "server/api/sound/index.js",
24968     "groupTitle": "Sounds"
24969   },
24970   {
24971     "type": "delete",
24972     "url": "/api/sounds/{id}",
24973     "title": "Deletes a sound",
24974     "examples": [
24975       {
24976         "title": "Example usage:",
24977         "content": "curl https://{domain}/api/sounds/{id} -v -u {name}:{password} -X DELETE",
24978         "type": "json"
24979       }
24980     ],
24981     "name": "destroySound",
24982     "group": "Sounds",
24983     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24984     "version": "0.0.0",
24985     "filename": "server/api/sound/index.js",
24986     "groupTitle": "Sounds"
24987   },
24988   {
24989     "type": "get",
24990     "url": "/api/sounds/{id}/download",
24991     "title": "Download Sound",
24992     "examples": [
24993       {
24994         "title": "Example usage:",
24995         "content": "curl https://{domain}/api/sounds/{id}/download -v -u {name}:{password} -X GET",
24996         "type": "json"
24997       }
24998     ],
24999     "name": "download",
25000     "group": "Sounds",
25001     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25002     "version": "0.0.0",
25003     "filename": "server/api/sound/index.js",
25004     "groupTitle": "Sounds"
25005   },
25006   {
25007     "type": "put",
25008     "url": "/api/sounds",
25009     "title": "Update an existing new sound",
25010     "examples": [
25011       {
25012         "title": "Example usage:",
25013         "content": "curl https://{domain}/api/sounds -d '[\"name\": \"sound_name\", \"description\": \"sound_desc\"]' -v -u {name}:{password} -X PUT",
25014         "type": "json"
25015       }
25016     ],
25017     "name": "updateSound",
25018     "group": "Sounds",
25019     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25020     "version": "0.0.0",
25021     "filename": "server/api/sound/index.js",
25022     "groupTitle": "Sounds"
25023   },
25024   {
25025     "type": "post",
25026     "url": "/api/square/details/reports",
25027     "title": "Creates a new Square Detail Report",
25028     "examples": [
25029       {
25030         "title": "Example usage:",
25031         "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",
25032         "type": "json"
25033       }
25034     ],
25035     "name": "CreateSquare_Detail_Reports",
25036     "group": "Square_Details_Reports",
25037     "parameter": {
25038       "fields": {
25039         "Body": [
25040           {
25041             "group": "Body",
25042             "type": "String",
25043             "optional": true,
25044             "field": "uniqueid",
25045             "description": ""
25046           },
25047           {
25048             "group": "Body",
25049             "type": "String",
25050             "optional": true,
25051             "field": "node",
25052             "description": ""
25053           },
25054           {
25055             "group": "Body",
25056             "type": "String",
25057             "optional": true,
25058             "field": "application",
25059             "description": ""
25060           },
25061           {
25062             "group": "Body",
25063             "type": "Text",
25064             "optional": true,
25065             "field": "data",
25066             "description": ""
25067           },
25068           {
25069             "group": "Body",
25070             "type": "String",
25071             "optional": true,
25072             "field": "project_name",
25073             "description": ""
25074           },
25075           {
25076             "group": "Body",
25077             "type": "String",
25078             "optional": true,
25079             "field": "callerid",
25080             "description": ""
25081           }
25082         ]
25083       }
25084     },
25085     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25086     "version": "0.0.0",
25087     "filename": "server/api/squareReportDetail/index.js",
25088     "groupTitle": "Square_Details_Reports"
25089   },
25090   {
25091     "type": "delete",
25092     "url": "/api/square/details/reports/{id}",
25093     "title": "Deletes a Square Detail Report",
25094     "examples": [
25095       {
25096         "title": "Example usage:",
25097         "content": "curl https://{domain}/api/square/details/reports/{id} -v -u {name}:{password} -X DELETE",
25098         "type": "json"
25099       }
25100     ],
25101     "name": "DeleteSquare_Detail_Reports",
25102     "group": "Square_Details_Reports",
25103     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25104     "version": "0.0.0",
25105     "filename": "server/api/squareReportDetail/index.js",
25106     "groupTitle": "Square_Details_Reports"
25107   },
25108   {
25109     "type": "get",
25110     "url": "/api/square/details/reports/describe",
25111     "title": "Gets table info about Square Detail Reports",
25112     "examples": [
25113       {
25114         "title": "Example usage:",
25115         "content": "curl https://{domain}/api/square/details/reports/describe -v -u {name}:{password}",
25116         "type": "json"
25117       }
25118     ],
25119     "name": "DescribeSquare_Detail_Reports",
25120     "group": "Square_Details_Reports",
25121     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25122     "version": "0.0.0",
25123     "filename": "server/api/squareReportDetail/index.js",
25124     "groupTitle": "Square_Details_Reports"
25125   },
25126   {
25127     "type": "get",
25128     "url": "/api/square/details/reports",
25129     "title": "Gets a list of Square Detail Reports",
25130     "examples": [
25131       {
25132         "title": "Example usage:",
25133         "content": "curl https://{domain}/api/square/details/reports -v -u {name}:{password}",
25134         "type": "json"
25135       }
25136     ],
25137     "name": "GetSquare_Detail_Reports",
25138     "group": "Square_Details_Reports",
25139     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
25140     "version": "0.0.0",
25141     "filename": "server/api/squareReportDetail/index.js",
25142     "groupTitle": "Square_Details_Reports"
25143   },
25144   {
25145     "type": "get",
25146     "url": "/api/square/details/reports/{id}",
25147     "title": "Gets a single Square Detail Report",
25148     "examples": [
25149       {
25150         "title": "Example usage:",
25151         "content": "curl https://{domain}/api/square/details/reports/{id} -v -u {name}:{password}",
25152         "type": "json"
25153       }
25154     ],
25155     "name": "ShowSquare_Detail_Reports",
25156     "group": "Square_Details_Reports",
25157     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25158     "version": "0.0.0",
25159     "filename": "server/api/squareReportDetail/index.js",
25160     "groupTitle": "Square_Details_Reports"
25161   },
25162   {
25163     "type": "put",
25164     "url": "/api/square/details/reports/{id}",
25165     "title": "Update an existing Square Detail Report",
25166     "examples": [
25167       {
25168         "title": "Example usage:",
25169         "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",
25170         "type": "json"
25171       }
25172     ],
25173     "name": "updateSquare_Detail_Reports",
25174     "group": "Square_Details_Reports",
25175     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25176     "version": "0.0.0",
25177     "filename": "server/api/squareReportDetail/index.js",
25178     "groupTitle": "Square_Details_Reports"
25179   },
25180   {
25181     "type": "post",
25182     "url": "/api/square/messages",
25183     "title": "Creates a new Message",
25184     "examples": [
25185       {
25186         "title": "Example usage:",
25187         "content": "curl https://{domain}/api/square/messages -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
25188         "type": "json"
25189       }
25190     ],
25191     "name": "CreateMessages",
25192     "group": "Square_Messages",
25193     "parameter": {
25194       "fields": {
25195         "Body": [
25196           {
25197             "group": "Body",
25198             "type": "String",
25199             "optional": true,
25200             "field": "uniqueid",
25201             "description": ""
25202           },
25203           {
25204             "group": "Body",
25205             "type": "Text",
25206             "optional": false,
25207             "field": "body",
25208             "description": ""
25209           },
25210           {
25211             "group": "Body",
25212             "type": "String",
25213             "allowedValues": [
25214               "\"in\"",
25215               "\"out\""
25216             ],
25217             "optional": false,
25218             "field": "direction",
25219             "description": ""
25220           },
25221           {
25222             "group": "Body",
25223             "type": "String",
25224             "optional": true,
25225             "field": "providerName",
25226             "description": ""
25227           },
25228           {
25229             "group": "Body",
25230             "type": "Text",
25231             "optional": true,
25232             "field": "providerResponse",
25233             "description": ""
25234           }
25235         ]
25236       }
25237     },
25238     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25239     "version": "0.0.0",
25240     "filename": "server/api/squareMessage/index.js",
25241     "groupTitle": "Square_Messages"
25242   },
25243   {
25244     "type": "delete",
25245     "url": "/api/square/messages/{id}",
25246     "title": "Deletes a Message",
25247     "examples": [
25248       {
25249         "title": "Example usage:",
25250         "content": "curl https://{domain}/api/square/messages/{id} -v -u {name}:{password} -X DELETE",
25251         "type": "json"
25252       }
25253     ],
25254     "name": "DeleteMessages",
25255     "group": "Square_Messages",
25256     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25257     "version": "0.0.0",
25258     "filename": "server/api/squareMessage/index.js",
25259     "groupTitle": "Square_Messages"
25260   },
25261   {
25262     "type": "get",
25263     "url": "/api/square/messages",
25264     "title": "Gets a list of Messages",
25265     "examples": [
25266       {
25267         "title": "Example usage:",
25268         "content": "curl https://{domain}/api/square/messages -v -u {name}:{password}",
25269         "type": "json"
25270       }
25271     ],
25272     "name": "GetMessages",
25273     "group": "Square_Messages",
25274     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
25275     "version": "0.0.0",
25276     "filename": "server/api/squareMessage/index.js",
25277     "groupTitle": "Square_Messages"
25278   },
25279   {
25280     "type": "get",
25281     "url": "/api/square/messages/{id}",
25282     "title": "Gets a single Message",
25283     "examples": [
25284       {
25285         "title": "Example usage:",
25286         "content": "curl https://{domain}/api/square/messages/{id} -v -u {name}:{password}",
25287         "type": "json"
25288       }
25289     ],
25290     "name": "ShowMessages",
25291     "group": "Square_Messages",
25292     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25293     "version": "0.0.0",
25294     "filename": "server/api/squareMessage/index.js",
25295     "groupTitle": "Square_Messages"
25296   },
25297   {
25298     "type": "put",
25299     "url": "/api/square/messages/{id}",
25300     "title": "Update an existing Message",
25301     "examples": [
25302       {
25303         "title": "Example usage:",
25304         "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",
25305         "type": "json"
25306       }
25307     ],
25308     "name": "updateMessages",
25309     "group": "Square_Messages",
25310     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25311     "version": "0.0.0",
25312     "filename": "server/api/squareMessage/index.js",
25313     "groupTitle": "Square_Messages"
25314   },
25315   {
25316     "type": "post",
25317     "url": "/api/square/odbc",
25318     "title": "Creates a new ODBC",
25319     "examples": [
25320       {
25321         "title": "Example usage:",
25322         "content": "curl https://{domain}/api/square/odbc -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
25323         "type": "json"
25324       }
25325     ],
25326     "name": "CreateODBCs",
25327     "group": "Square_ODBC",
25328     "parameter": {
25329       "fields": {
25330         "Body": [
25331           {
25332             "group": "Body",
25333             "type": "String",
25334             "optional": false,
25335             "field": "name",
25336             "description": ""
25337           },
25338           {
25339             "group": "Body",
25340             "type": "String",
25341             "optional": true,
25342             "field": "dsn",
25343             "description": ""
25344           },
25345           {
25346             "group": "Body",
25347             "type": "String",
25348             "optional": true,
25349             "field": "description",
25350             "description": ""
25351           }
25352         ]
25353       }
25354     },
25355     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25356     "version": "0.0.0",
25357     "filename": "server/api/squareOdbc/index.js",
25358     "groupTitle": "Square_ODBC"
25359   },
25360   {
25361     "type": "delete",
25362     "url": "/api/square/odbc/{id}",
25363     "title": "Deletes a ODBC",
25364     "examples": [
25365       {
25366         "title": "Example usage:",
25367         "content": "curl https://{domain}/api/square/odbc/{id} -v -u {name}:{password} -X DELETE",
25368         "type": "json"
25369       }
25370     ],
25371     "name": "DeleteODBCs",
25372     "group": "Square_ODBC",
25373     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25374     "version": "0.0.0",
25375     "filename": "server/api/squareOdbc/index.js",
25376     "groupTitle": "Square_ODBC"
25377   },
25378   {
25379     "type": "get",
25380     "url": "/api/square/odbc",
25381     "title": "Gets a list of ODBCs",
25382     "examples": [
25383       {
25384         "title": "Example usage:",
25385         "content": "curl https://{domain}/api/square/odbc -v -u {name}:{password}",
25386         "type": "json"
25387       }
25388     ],
25389     "name": "GetODBCs",
25390     "group": "Square_ODBC",
25391     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
25392     "version": "0.0.0",
25393     "filename": "server/api/squareOdbc/index.js",
25394     "groupTitle": "Square_ODBC"
25395   },
25396   {
25397     "type": "get",
25398     "url": "/api/square/odbc/{id}",
25399     "title": "Gets a single ODBC",
25400     "examples": [
25401       {
25402         "title": "Example usage:",
25403         "content": "curl https://{domain}/api/square/odbc/{id} -v -u {name}:{password}",
25404         "type": "json"
25405       }
25406     ],
25407     "name": "ShowODBCs",
25408     "group": "Square_ODBC",
25409     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25410     "version": "0.0.0",
25411     "filename": "server/api/squareOdbc/index.js",
25412     "groupTitle": "Square_ODBC"
25413   },
25414   {
25415     "type": "get",
25416     "url": "/api/square/odbc/{id}/test",
25417     "title": "Test Odbc",
25418     "examples": [
25419       {
25420         "title": "Example usage:",
25421         "content": "curl https://{domain}/api/square/odbc/{id}/test -v -u {name}:{password} -X GET",
25422         "type": "json"
25423       }
25424     ],
25425     "name": "test",
25426     "group": "Square_ODBC",
25427     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25428     "version": "0.0.0",
25429     "filename": "server/api/squareOdbc/index.js",
25430     "groupTitle": "Square_ODBC"
25431   },
25432   {
25433     "type": "put",
25434     "url": "/api/square/odbc/{id}",
25435     "title": "Update an existing ODBC",
25436     "examples": [
25437       {
25438         "title": "Example usage:",
25439         "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",
25440         "type": "json"
25441       }
25442     ],
25443     "name": "updateODBCs",
25444     "group": "Square_ODBC",
25445     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25446     "version": "0.0.0",
25447     "filename": "server/api/squareOdbc/index.js",
25448     "groupTitle": "Square_ODBC"
25449   },
25450   {
25451     "type": "post",
25452     "url": "/api/square/projects",
25453     "title": "Creates a new Project",
25454     "examples": [
25455       {
25456         "title": "Example usage:",
25457         "content": "curl https://{domain}/api/square/projects -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
25458         "type": "json"
25459       }
25460     ],
25461     "name": "CreateProjects",
25462     "group": "Square_Projects",
25463     "parameter": {
25464       "fields": {
25465         "Body": [
25466           {
25467             "group": "Body",
25468             "type": "String",
25469             "optional": false,
25470             "field": "name",
25471             "description": ""
25472           },
25473           {
25474             "group": "Body",
25475             "type": "String",
25476             "optional": true,
25477             "field": "description",
25478             "description": ""
25479           },
25480           {
25481             "group": "Body",
25482             "type": "Text",
25483             "optional": true,
25484             "field": "notes",
25485             "description": ""
25486           },
25487           {
25488             "group": "Body",
25489             "type": "Blob",
25490             "optional": true,
25491             "field": "preproduction",
25492             "description": ""
25493           },
25494           {
25495             "group": "Body",
25496             "type": "Blob",
25497             "optional": true,
25498             "field": "production",
25499             "description": ""
25500           },
25501           {
25502             "group": "Body",
25503             "type": "String",
25504             "optional": true,
25505             "field": "savedAt",
25506             "description": ""
25507           },
25508           {
25509             "group": "Body",
25510             "type": "String",
25511             "optional": true,
25512             "field": "publishedAt",
25513             "description": ""
25514           }
25515         ]
25516       }
25517     },
25518     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25519     "version": "0.0.0",
25520     "filename": "server/api/squareProject/index.js",
25521     "groupTitle": "Square_Projects"
25522   },
25523   {
25524     "type": "delete",
25525     "url": "/api/square/projects/{id}",
25526     "title": "Deletes a Project",
25527     "examples": [
25528       {
25529         "title": "Example usage:",
25530         "content": "curl https://{domain}/api/square/projects/{id} -v -u {name}:{password} -X DELETE",
25531         "type": "json"
25532       }
25533     ],
25534     "name": "DeleteProjects",
25535     "group": "Square_Projects",
25536     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25537     "version": "0.0.0",
25538     "filename": "server/api/squareProject/index.js",
25539     "groupTitle": "Square_Projects"
25540   },
25541   {
25542     "type": "get",
25543     "url": "/api/square/projects",
25544     "title": "Gets a list of Projects",
25545     "examples": [
25546       {
25547         "title": "Example usage:",
25548         "content": "curl https://{domain}/api/square/projects -v -u {name}:{password}",
25549         "type": "json"
25550       }
25551     ],
25552     "name": "GetProjects",
25553     "group": "Square_Projects",
25554     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
25555     "version": "0.0.0",
25556     "filename": "server/api/squareProject/index.js",
25557     "groupTitle": "Square_Projects"
25558   },
25559   {
25560     "type": "get",
25561     "url": "/api/square/projects/{id}",
25562     "title": "Gets a single Project",
25563     "examples": [
25564       {
25565         "title": "Example usage:",
25566         "content": "curl https://{domain}/api/square/projects/{id} -v -u {name}:{password}",
25567         "type": "json"
25568       }
25569     ],
25570     "name": "ShowProjects",
25571     "group": "Square_Projects",
25572     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25573     "version": "0.0.0",
25574     "filename": "server/api/squareProject/index.js",
25575     "groupTitle": "Square_Projects"
25576   },
25577   {
25578     "type": "put",
25579     "url": "/api/square/projects/{id}",
25580     "title": "Update an existing Project",
25581     "examples": [
25582       {
25583         "title": "Example usage:",
25584         "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",
25585         "type": "json"
25586       }
25587     ],
25588     "name": "updateProjects",
25589     "group": "Square_Projects",
25590     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25591     "version": "0.0.0",
25592     "filename": "server/api/squareProject/index.js",
25593     "groupTitle": "Square_Projects"
25594   },
25595   {
25596     "type": "post",
25597     "url": "/api/square/recordings",
25598     "title": "Creates a new Recording",
25599     "examples": [
25600       {
25601         "title": "Example usage:",
25602         "content": "curl https://{domain}/api/square/recordings -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
25603         "type": "json"
25604       }
25605     ],
25606     "name": "CreateRecordings",
25607     "group": "Square_Recordings",
25608     "parameter": {
25609       "fields": {
25610         "Body": [
25611           {
25612             "group": "Body",
25613             "type": "String",
25614             "optional": true,
25615             "field": "uniqueid",
25616             "description": ""
25617           },
25618           {
25619             "group": "Body",
25620             "type": "String",
25621             "optional": true,
25622             "field": "callerid",
25623             "description": ""
25624           },
25625           {
25626             "group": "Body",
25627             "type": "String",
25628             "optional": true,
25629             "field": "calleridname",
25630             "description": ""
25631           },
25632           {
25633             "group": "Body",
25634             "type": "String",
25635             "optional": true,
25636             "field": "context",
25637             "description": ""
25638           },
25639           {
25640             "group": "Body",
25641             "type": "String",
25642             "optional": true,
25643             "field": "extension",
25644             "description": ""
25645           },
25646           {
25647             "group": "Body",
25648             "type": "String",
25649             "optional": true,
25650             "field": "priority",
25651             "description": ""
25652           },
25653           {
25654             "group": "Body",
25655             "type": "String",
25656             "optional": true,
25657             "field": "accountcode",
25658             "description": ""
25659           },
25660           {
25661             "group": "Body",
25662             "type": "String",
25663             "optional": true,
25664             "field": "dnid",
25665             "description": ""
25666           },
25667           {
25668             "group": "Body",
25669             "type": "String",
25670             "optional": true,
25671             "field": "projectName",
25672             "description": ""
25673           },
25674           {
25675             "group": "Body",
25676             "type": "String",
25677             "optional": true,
25678             "field": "saveName",
25679             "description": ""
25680           },
25681           {
25682             "group": "Body",
25683             "type": "String",
25684             "optional": true,
25685             "field": "filename",
25686             "description": ""
25687           },
25688           {
25689             "group": "Body",
25690             "type": "String",
25691             "optional": true,
25692             "field": "savePath",
25693             "description": ""
25694           },
25695           {
25696             "group": "Body",
25697             "type": "Virtual",
25698             "optional": true,
25699             "field": "format",
25700             "description": ""
25701           }
25702         ]
25703       }
25704     },
25705     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25706     "version": "0.0.0",
25707     "filename": "server/api/squareRecording/index.js",
25708     "groupTitle": "Square_Recordings"
25709   },
25710   {
25711     "type": "get",
25712     "url": "/api/square/recordings",
25713     "title": "Gets a list of Recordings",
25714     "examples": [
25715       {
25716         "title": "Example usage:",
25717         "content": "curl https://{domain}/api/square/recordings -v -u {name}:{password}",
25718         "type": "json"
25719       }
25720     ],
25721     "name": "GetRecordings",
25722     "group": "Square_Recordings",
25723     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
25724     "version": "0.0.0",
25725     "filename": "server/api/squareRecording/index.js",
25726     "groupTitle": "Square_Recordings"
25727   },
25728   {
25729     "type": "get",
25730     "url": "/api/square/recordings/{id}",
25731     "title": "Gets a single Recording",
25732     "examples": [
25733       {
25734         "title": "Example usage:",
25735         "content": "curl https://{domain}/api/square/recordings/{id} -v -u {name}:{password}",
25736         "type": "json"
25737       }
25738     ],
25739     "name": "ShowRecordings",
25740     "group": "Square_Recordings",
25741     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25742     "version": "0.0.0",
25743     "filename": "server/api/squareRecording/index.js",
25744     "groupTitle": "Square_Recordings"
25745   },
25746   {
25747     "type": "delete",
25748     "url": "/api/square/recordings/{id}",
25749     "title": "Delete recording",
25750     "examples": [
25751       {
25752         "title": "Example usage:",
25753         "content": "curl https://{domain}/api/square/recordings/{id} -v -u {name}:{password} -X DELETE",
25754         "type": "json"
25755       }
25756     ],
25757     "name": "destroy",
25758     "group": "Square_Recordings",
25759     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25760     "version": "0.0.0",
25761     "filename": "server/api/squareRecording/index.js",
25762     "groupTitle": "Square_Recordings"
25763   },
25764   {
25765     "type": "get",
25766     "url": "/api/square/recordings/{id}/download",
25767     "title": "Download Recording",
25768     "examples": [
25769       {
25770         "title": "Example usage:",
25771         "content": "curl https://{domain}/api/square/recordings/{id}/download -v -u {name}:{password} -X GET",
25772         "type": "json"
25773       }
25774     ],
25775     "name": "download",
25776     "group": "Square_Recordings",
25777     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <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/squareRecording/index.js",
25780     "groupTitle": "Square_Recordings"
25781   },
25782   {
25783     "type": "put",
25784     "url": "/api/square/recordings/{id}",
25785     "title": "Update an existing Recording",
25786     "examples": [
25787       {
25788         "title": "Example usage:",
25789         "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",
25790         "type": "json"
25791       }
25792     ],
25793     "name": "updateRecordings",
25794     "group": "Square_Recordings",
25795     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25796     "version": "0.0.0",
25797     "filename": "server/api/squareRecording/index.js",
25798     "groupTitle": "Square_Recordings"
25799   },
25800   {
25801     "type": "post",
25802     "url": "/api/square/reports",
25803     "title": "Creates a new Square Report",
25804     "examples": [
25805       {
25806         "title": "Example usage:",
25807         "content": "curl https://{domain}/api/square/reports -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
25808         "type": "json"
25809       }
25810     ],
25811     "name": "CreateSquare_Reports",
25812     "group": "Square_Reports",
25813     "parameter": {
25814       "fields": {
25815         "Body": [
25816           {
25817             "group": "Body",
25818             "type": "String",
25819             "optional": true,
25820             "field": "network",
25821             "description": ""
25822           },
25823           {
25824             "group": "Body",
25825             "type": "String",
25826             "optional": true,
25827             "field": "network_script",
25828             "description": ""
25829           },
25830           {
25831             "group": "Body",
25832             "type": "String",
25833             "optional": true,
25834             "field": "request",
25835             "description": ""
25836           },
25837           {
25838             "group": "Body",
25839             "type": "String",
25840             "optional": true,
25841             "field": "channel",
25842             "description": ""
25843           },
25844           {
25845             "group": "Body",
25846             "type": "String",
25847             "optional": true,
25848             "field": "language",
25849             "description": ""
25850           },
25851           {
25852             "group": "Body",
25853             "type": "String",
25854             "optional": true,
25855             "field": "type",
25856             "description": ""
25857           },
25858           {
25859             "group": "Body",
25860             "type": "String",
25861             "optional": true,
25862             "field": "uniqueid",
25863             "description": ""
25864           },
25865           {
25866             "group": "Body",
25867             "type": "String",
25868             "optional": true,
25869             "field": "version",
25870             "description": ""
25871           },
25872           {
25873             "group": "Body",
25874             "type": "String",
25875             "optional": true,
25876             "field": "callerid",
25877             "description": ""
25878           },
25879           {
25880             "group": "Body",
25881             "type": "String",
25882             "optional": true,
25883             "field": "calleridname",
25884             "description": ""
25885           },
25886           {
25887             "group": "Body",
25888             "type": "String",
25889             "optional": true,
25890             "field": "callingpres",
25891             "description": ""
25892           },
25893           {
25894             "group": "Body",
25895             "type": "String",
25896             "optional": true,
25897             "field": "callingani2",
25898             "description": ""
25899           },
25900           {
25901             "group": "Body",
25902             "type": "String",
25903             "optional": true,
25904             "field": "callington",
25905             "description": ""
25906           },
25907           {
25908             "group": "Body",
25909             "type": "String",
25910             "optional": true,
25911             "field": "callingtns",
25912             "description": ""
25913           },
25914           {
25915             "group": "Body",
25916             "type": "String",
25917             "optional": true,
25918             "field": "dnid",
25919             "description": ""
25920           },
25921           {
25922             "group": "Body",
25923             "type": "String",
25924             "optional": true,
25925             "field": "rdnis",
25926             "description": ""
25927           },
25928           {
25929             "group": "Body",
25930             "type": "String",
25931             "optional": true,
25932             "field": "context",
25933             "description": ""
25934           },
25935           {
25936             "group": "Body",
25937             "type": "String",
25938             "optional": true,
25939             "field": "extension",
25940             "description": ""
25941           },
25942           {
25943             "group": "Body",
25944             "type": "String",
25945             "optional": true,
25946             "field": "priority",
25947             "description": ""
25948           },
25949           {
25950             "group": "Body",
25951             "type": "String",
25952             "optional": true,
25953             "field": "enhanced",
25954             "description": ""
25955           },
25956           {
25957             "group": "Body",
25958             "type": "String",
25959             "optional": true,
25960             "field": "accountcode",
25961             "description": ""
25962           },
25963           {
25964             "group": "Body",
25965             "type": "String",
25966             "optional": true,
25967             "field": "threadid",
25968             "description": ""
25969           },
25970           {
25971             "group": "Body",
25972             "type": "String",
25973             "optional": true,
25974             "field": "project_name",
25975             "description": ""
25976           },
25977           {
25978             "group": "Body",
25979             "type": "String",
25980             "optional": true,
25981             "field": "joinAt",
25982             "description": ""
25983           },
25984           {
25985             "group": "Body",
25986             "type": "String",
25987             "optional": true,
25988             "field": "leaveAt",
25989             "description": ""
25990           },
25991           {
25992             "group": "Body",
25993             "type": "Boolean",
25994             "optional": true,
25995             "field": "bot",
25996             "description": ""
25997           }
25998         ]
25999       }
26000     },
26001     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26002     "version": "0.0.0",
26003     "filename": "server/api/squareReport/index.js",
26004     "groupTitle": "Square_Reports"
26005   },
26006   {
26007     "type": "delete",
26008     "url": "/api/square/reports/{id}",
26009     "title": "Deletes a Square Report",
26010     "examples": [
26011       {
26012         "title": "Example usage:",
26013         "content": "curl https://{domain}/api/square/reports/{id} -v -u {name}:{password} -X DELETE",
26014         "type": "json"
26015       }
26016     ],
26017     "name": "DeleteSquare_Reports",
26018     "group": "Square_Reports",
26019     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26020     "version": "0.0.0",
26021     "filename": "server/api/squareReport/index.js",
26022     "groupTitle": "Square_Reports"
26023   },
26024   {
26025     "type": "get",
26026     "url": "/api/square/reports/describe",
26027     "title": "Gets table info about Square Reports",
26028     "examples": [
26029       {
26030         "title": "Example usage:",
26031         "content": "curl https://{domain}/api/square/reports/describe -v -u {name}:{password}",
26032         "type": "json"
26033       }
26034     ],
26035     "name": "DescribeSquare_Reports",
26036     "group": "Square_Reports",
26037     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26038     "version": "0.0.0",
26039     "filename": "server/api/squareReport/index.js",
26040     "groupTitle": "Square_Reports"
26041   },
26042   {
26043     "type": "get",
26044     "url": "/api/square/reports",
26045     "title": "Gets a list of Square Reports",
26046     "examples": [
26047       {
26048         "title": "Example usage:",
26049         "content": "curl https://{domain}/api/square/reports -v -u {name}:{password}",
26050         "type": "json"
26051       }
26052     ],
26053     "name": "GetSquare_Reports",
26054     "group": "Square_Reports",
26055     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
26056     "version": "0.0.0",
26057     "filename": "server/api/squareReport/index.js",
26058     "groupTitle": "Square_Reports"
26059   },
26060   {
26061     "type": "get",
26062     "url": "/api/square/reports/{id}",
26063     "title": "Gets a single Square Report",
26064     "examples": [
26065       {
26066         "title": "Example usage:",
26067         "content": "curl https://{domain}/api/square/reports/{id} -v -u {name}:{password}",
26068         "type": "json"
26069       }
26070     ],
26071     "name": "ShowSquare_Reports",
26072     "group": "Square_Reports",
26073     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26074     "version": "0.0.0",
26075     "filename": "server/api/squareReport/index.js",
26076     "groupTitle": "Square_Reports"
26077   },
26078   {
26079     "type": "put",
26080     "url": "/api/square/reports/{id}",
26081     "title": "Update an existing Square Report",
26082     "examples": [
26083       {
26084         "title": "Example usage:",
26085         "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",
26086         "type": "json"
26087       }
26088     ],
26089     "name": "updateSquare_Reports",
26090     "group": "Square_Reports",
26091     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26092     "version": "0.0.0",
26093     "filename": "server/api/squareReport/index.js",
26094     "groupTitle": "Square_Reports"
26095   },
26096   {
26097     "type": "post",
26098     "url": "/api/integrations/sugarcrm/configurations",
26099     "title": "Creates a new SugarCRM Configuration",
26100     "examples": [
26101       {
26102         "title": "Example usage:",
26103         "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",
26104         "type": "json"
26105       }
26106     ],
26107     "name": "CreateSugarCRM_Configurations",
26108     "group": "SugarCRM_Configurations",
26109     "parameter": {
26110       "fields": {
26111         "Body": [
26112           {
26113             "group": "Body",
26114             "type": "String",
26115             "optional": true,
26116             "field": "name",
26117             "description": ""
26118           },
26119           {
26120             "group": "Body",
26121             "type": "String",
26122             "optional": true,
26123             "field": "description",
26124             "description": ""
26125           }
26126         ]
26127       }
26128     },
26129     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26130     "version": "0.0.0",
26131     "filename": "server/api/intSugarcrmConfiguration/index.js",
26132     "groupTitle": "SugarCRM_Configurations"
26133   },
26134   {
26135     "type": "delete",
26136     "url": "/api/integrations/sugarcrm/configurations/{id}",
26137     "title": "Deletes a SugarCRM Configuration",
26138     "examples": [
26139       {
26140         "title": "Example usage:",
26141         "content": "curl https://{domain}/api/integrations/sugarcrm/configurations/{id} -v -u {name}:{password} -X DELETE",
26142         "type": "json"
26143       }
26144     ],
26145     "name": "DeleteSugarCRM_Configurations",
26146     "group": "SugarCRM_Configurations",
26147     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26148     "version": "0.0.0",
26149     "filename": "server/api/intSugarcrmConfiguration/index.js",
26150     "groupTitle": "SugarCRM_Configurations"
26151   },
26152   {
26153     "type": "get",
26154     "url": "/api/integrations/sugarcrm/configurations",
26155     "title": "Gets a list of SugarCRM Configurations",
26156     "examples": [
26157       {
26158         "title": "Example usage:",
26159         "content": "curl https://{domain}/api/integrations/sugarcrm/configurations -v -u {name}:{password}",
26160         "type": "json"
26161       }
26162     ],
26163     "name": "GetSugarCRM_Configurations",
26164     "group": "SugarCRM_Configurations",
26165     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
26166     "version": "0.0.0",
26167     "filename": "server/api/intSugarcrmConfiguration/index.js",
26168     "groupTitle": "SugarCRM_Configurations"
26169   },
26170   {
26171     "type": "get",
26172     "url": "/api/integrations/sugarcrm/configurations/{id}",
26173     "title": "Gets a single SugarCRM Configuration",
26174     "examples": [
26175       {
26176         "title": "Example usage:",
26177         "content": "curl https://{domain}/api/integrations/sugarcrm/configurations/{id} -v -u {name}:{password}",
26178         "type": "json"
26179       }
26180     ],
26181     "name": "ShowSugarCRM_Configurations",
26182     "group": "SugarCRM_Configurations",
26183     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26184     "version": "0.0.0",
26185     "filename": "server/api/intSugarcrmConfiguration/index.js",
26186     "groupTitle": "SugarCRM_Configurations"
26187   },
26188   {
26189     "type": "put",
26190     "url": "/api/integrations/sugarcrm/configurations/{id}",
26191     "title": "Update an existing SugarCRM Configuration",
26192     "examples": [
26193       {
26194         "title": "Example usage:",
26195         "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",
26196         "type": "json"
26197       }
26198     ],
26199     "name": "updateSugarCRM_Configurations",
26200     "group": "SugarCRM_Configurations",
26201     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26202     "version": "0.0.0",
26203     "filename": "server/api/intSugarcrmConfiguration/index.js",
26204     "groupTitle": "SugarCRM_Configurations"
26205   },
26206   {
26207     "type": "post",
26208     "url": "/api/integrations/sugarcrm/accounts",
26209     "title": "Creates a new Sugarcrm Account",
26210     "examples": [
26211       {
26212         "title": "Example usage:",
26213         "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",
26214         "type": "json"
26215       }
26216     ],
26217     "name": "CreateSugarcrm_Accounts",
26218     "group": "Sugarcrm_Accounts",
26219     "parameter": {
26220       "fields": {
26221         "Body": [
26222           {
26223             "group": "Body",
26224             "type": "String",
26225             "optional": true,
26226             "field": "name",
26227             "description": ""
26228           },
26229           {
26230             "group": "Body",
26231             "type": "String",
26232             "optional": true,
26233             "field": "description",
26234             "description": ""
26235           },
26236           {
26237             "group": "Body",
26238             "type": "String",
26239             "optional": true,
26240             "field": "username",
26241             "description": ""
26242           },
26243           {
26244             "group": "Body",
26245             "type": "String",
26246             "optional": true,
26247             "field": "password",
26248             "description": ""
26249           },
26250           {
26251             "group": "Body",
26252             "type": "String",
26253             "optional": true,
26254             "field": "remoteUri",
26255             "description": ""
26256           },
26257           {
26258             "group": "Body",
26259             "type": "String",
26260             "optional": false,
26261             "field": "serverUrl",
26262             "description": ""
26263           }
26264         ]
26265       }
26266     },
26267     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26268     "version": "0.0.0",
26269     "filename": "server/api/intSugarcrmAccount/index.js",
26270     "groupTitle": "Sugarcrm_Accounts"
26271   },
26272   {
26273     "type": "delete",
26274     "url": "/api/integrations/sugarcrm/accounts/{id}",
26275     "title": "Deletes a Sugarcrm Account",
26276     "examples": [
26277       {
26278         "title": "Example usage:",
26279         "content": "curl https://{domain}/api/integrations/sugarcrm/accounts/{id} -v -u {name}:{password} -X DELETE",
26280         "type": "json"
26281       }
26282     ],
26283     "name": "DeleteSugarcrm_Accounts",
26284     "group": "Sugarcrm_Accounts",
26285     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26286     "version": "0.0.0",
26287     "filename": "server/api/intSugarcrmAccount/index.js",
26288     "groupTitle": "Sugarcrm_Accounts"
26289   },
26290   {
26291     "type": "get",
26292     "url": "/api/integrations/sugarcrm/accounts",
26293     "title": "Gets a list of Sugarcrm Accounts",
26294     "examples": [
26295       {
26296         "title": "Example usage:",
26297         "content": "curl https://{domain}/api/integrations/sugarcrm/accounts -v -u {name}:{password}",
26298         "type": "json"
26299       }
26300     ],
26301     "name": "GetSugarcrm_Accounts",
26302     "group": "Sugarcrm_Accounts",
26303     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
26304     "version": "0.0.0",
26305     "filename": "server/api/intSugarcrmAccount/index.js",
26306     "groupTitle": "Sugarcrm_Accounts"
26307   },
26308   {
26309     "type": "get",
26310     "url": "/api/integrations/sugarcrm/accounts/{id}",
26311     "title": "Gets a single Sugarcrm Account",
26312     "examples": [
26313       {
26314         "title": "Example usage:",
26315         "content": "curl https://{domain}/api/integrations/sugarcrm/accounts/{id} -v -u {name}:{password}",
26316         "type": "json"
26317       }
26318     ],
26319     "name": "ShowSugarcrm_Accounts",
26320     "group": "Sugarcrm_Accounts",
26321     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26322     "version": "0.0.0",
26323     "filename": "server/api/intSugarcrmAccount/index.js",
26324     "groupTitle": "Sugarcrm_Accounts"
26325   },
26326   {
26327     "type": "post",
26328     "url": "/api/integrations/sugarcrm/accounts/{id}/configurations",
26329     "title": "Creates new configuration",
26330     "examples": [
26331       {
26332         "title": "Example usage:",
26333         "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",
26334         "type": "json"
26335       }
26336     ],
26337     "name": "addConfiguration",
26338     "group": "Sugarcrm_Accounts",
26339     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26340     "version": "0.0.0",
26341     "filename": "server/api/intSugarcrmAccount/index.js",
26342     "groupTitle": "Sugarcrm_Accounts"
26343   },
26344   {
26345     "type": "get",
26346     "url": "/api/integrations/sugarcrm/accounts/{id}/configurations",
26347     "title": "Gets account configurations",
26348     "examples": [
26349       {
26350         "title": "Example usage:",
26351         "content": "curl https://{domain}/api/integrations/sugarcrm/accounts/{id}/configurations -v -u {name}:{password} -X GET",
26352         "type": "json"
26353       }
26354     ],
26355     "name": "getConfigurations",
26356     "group": "Sugarcrm_Accounts",
26357     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26358     "version": "0.0.0",
26359     "filename": "server/api/intSugarcrmAccount/index.js",
26360     "groupTitle": "Sugarcrm_Accounts"
26361   },
26362   {
26363     "type": "get",
26364     "url": "/api/integrations/sugarcrm/accounts/{id}/fields",
26365     "title": "Gets account fields",
26366     "examples": [
26367       {
26368         "title": "Example usage:",
26369         "content": "curl https://{domain}/api/integrations/sugarcrm/accounts/{id}/fields -v -u {name}:{password} -X GET",
26370         "type": "json"
26371       }
26372     ],
26373     "name": "getFields",
26374     "group": "Sugarcrm_Accounts",
26375     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26376     "version": "0.0.0",
26377     "filename": "server/api/intSugarcrmAccount/index.js",
26378     "groupTitle": "Sugarcrm_Accounts"
26379   },
26380   {
26381     "type": "put",
26382     "url": "/api/integrations/sugarcrm/accounts/{id}",
26383     "title": "Update an existing Sugarcrm Account",
26384     "examples": [
26385       {
26386         "title": "Example usage:",
26387         "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",
26388         "type": "json"
26389       }
26390     ],
26391     "name": "updateSugarcrm_Accounts",
26392     "group": "Sugarcrm_Accounts",
26393     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26394     "version": "0.0.0",
26395     "filename": "server/api/intSugarcrmAccount/index.js",
26396     "groupTitle": "Sugarcrm_Accounts"
26397   },
26398   {
26399     "type": "get",
26400     "url": "/api/integrations/sugarcrm/configurations/{id}/descriptions",
26401     "title": "Gets configurations descriptions",
26402     "examples": [
26403       {
26404         "title": "Example usage:",
26405         "content": "curl https://{domain}/api/integrations/sugarcrm/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
26406         "type": "json"
26407       }
26408     ],
26409     "name": "getDescriptions",
26410     "group": "Sugarcrm_Configurations",
26411     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26412     "version": "0.0.0",
26413     "filename": "server/api/intSugarcrmConfiguration/index.js",
26414     "groupTitle": "Sugarcrm_Configurations"
26415   },
26416   {
26417     "type": "get",
26418     "url": "/api/integrations/sugarcrm/configurations/{id}/fields",
26419     "title": "Gets configurations fields",
26420     "examples": [
26421       {
26422         "title": "Example usage:",
26423         "content": "curl https://{domain}/api/integrations/sugarcrm/configurations/{id}/fields -v -u {name}:{password} -X GET",
26424         "type": "json"
26425       }
26426     ],
26427     "name": "getFields",
26428     "group": "Sugarcrm_Configurations",
26429     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26430     "version": "0.0.0",
26431     "filename": "server/api/intSugarcrmConfiguration/index.js",
26432     "groupTitle": "Sugarcrm_Configurations"
26433   },
26434   {
26435     "type": "get",
26436     "url": "/api/integrations/sugarcrm/configurations/{id}/subjects",
26437     "title": "Gets configurations subjects",
26438     "examples": [
26439       {
26440         "title": "Example usage:",
26441         "content": "curl https://{domain}/api/integrations/sugarcrm/configurations/{id}/subjects -v -u {name}:{password} -X GET",
26442         "type": "json"
26443       }
26444     ],
26445     "name": "getSubjects",
26446     "group": "Sugarcrm_Configurations",
26447     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26448     "version": "0.0.0",
26449     "filename": "server/api/intSugarcrmConfiguration/index.js",
26450     "groupTitle": "Sugarcrm_Configurations"
26451   },
26452   {
26453     "type": "post",
26454     "url": "/api/integrations/sugarcrm/fields",
26455     "title": "Creates a new Sugarcrm Field",
26456     "examples": [
26457       {
26458         "title": "Example usage:",
26459         "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",
26460         "type": "json"
26461       }
26462     ],
26463     "name": "CreateSugarcrm_Fields",
26464     "group": "Sugarcrm_Fields",
26465     "parameter": {
26466       "fields": {
26467         "Body": [
26468           {
26469             "group": "Body",
26470             "type": "String",
26471             "allowedValues": [
26472               "\"string\"",
26473               "\"variable\"",
26474               "\"customVariable\"",
26475               "\"keyValue\"",
26476               "\"picklist\""
26477             ],
26478             "optional": true,
26479             "field": "type",
26480             "description": ""
26481           },
26482           {
26483             "group": "Body",
26484             "type": "String",
26485             "optional": true,
26486             "field": "content",
26487             "description": ""
26488           },
26489           {
26490             "group": "Body",
26491             "type": "String",
26492             "optional": true,
26493             "field": "key",
26494             "description": ""
26495           },
26496           {
26497             "group": "Body",
26498             "type": "String",
26499             "allowedValues": [
26500               "\"string\"",
26501               "\"variable\"",
26502               "\"customVariable\""
26503             ],
26504             "optional": true,
26505             "field": "keyType",
26506             "description": ""
26507           },
26508           {
26509             "group": "Body",
26510             "type": "String",
26511             "optional": true,
26512             "field": "keyContent",
26513             "description": ""
26514           },
26515           {
26516             "group": "Body",
26517             "type": "String",
26518             "optional": true,
26519             "field": "idField",
26520             "description": ""
26521           },
26522           {
26523             "group": "Body",
26524             "type": "String",
26525             "optional": true,
26526             "field": "nameField",
26527             "description": ""
26528           },
26529           {
26530             "group": "Body",
26531             "type": "Boolean",
26532             "optional": true,
26533             "field": "customField",
26534             "description": ""
26535           },
26536           {
26537             "group": "Body",
26538             "type": "String",
26539             "optional": true,
26540             "field": "variableName",
26541             "description": ""
26542           }
26543         ]
26544       }
26545     },
26546     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26547     "version": "0.0.0",
26548     "filename": "server/api/intSugarcrmField/index.js",
26549     "groupTitle": "Sugarcrm_Fields"
26550   },
26551   {
26552     "type": "delete",
26553     "url": "/api/integrations/sugarcrm/fields/{id}",
26554     "title": "Deletes a Sugarcrm Field",
26555     "examples": [
26556       {
26557         "title": "Example usage:",
26558         "content": "curl https://{domain}/api/integrations/sugarcrm/fields/{id} -v -u {name}:{password} -X DELETE",
26559         "type": "json"
26560       }
26561     ],
26562     "name": "DeleteSugarcrm_Fields",
26563     "group": "Sugarcrm_Fields",
26564     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26565     "version": "0.0.0",
26566     "filename": "server/api/intSugarcrmField/index.js",
26567     "groupTitle": "Sugarcrm_Fields"
26568   },
26569   {
26570     "type": "get",
26571     "url": "/api/integrations/sugarcrm/fields",
26572     "title": "Gets a list of Sugarcrm Fields",
26573     "examples": [
26574       {
26575         "title": "Example usage:",
26576         "content": "curl https://{domain}/api/integrations/sugarcrm/fields -v -u {name}:{password}",
26577         "type": "json"
26578       }
26579     ],
26580     "name": "GetSugarcrm_Fields",
26581     "group": "Sugarcrm_Fields",
26582     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
26583     "version": "0.0.0",
26584     "filename": "server/api/intSugarcrmField/index.js",
26585     "groupTitle": "Sugarcrm_Fields"
26586   },
26587   {
26588     "type": "get",
26589     "url": "/api/integrations/sugarcrm/fields/{id}",
26590     "title": "Gets a single Sugarcrm Field",
26591     "examples": [
26592       {
26593         "title": "Example usage:",
26594         "content": "curl https://{domain}/api/integrations/sugarcrm/fields/{id} -v -u {name}:{password}",
26595         "type": "json"
26596       }
26597     ],
26598     "name": "ShowSugarcrm_Fields",
26599     "group": "Sugarcrm_Fields",
26600     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26601     "version": "0.0.0",
26602     "filename": "server/api/intSugarcrmField/index.js",
26603     "groupTitle": "Sugarcrm_Fields"
26604   },
26605   {
26606     "type": "put",
26607     "url": "/api/integrations/sugarcrm/fields/{id}",
26608     "title": "Update an existing Sugarcrm Field",
26609     "examples": [
26610       {
26611         "title": "Example usage:",
26612         "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",
26613         "type": "json"
26614       }
26615     ],
26616     "name": "updateSugarcrm_Fields",
26617     "group": "Sugarcrm_Fields",
26618     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26619     "version": "0.0.0",
26620     "filename": "server/api/intSugarcrmField/index.js",
26621     "groupTitle": "Sugarcrm_Fields"
26622   },
26623   {
26624     "type": "get",
26625     "url": "/api/system",
26626     "title": "Gets system information",
26627     "examples": [
26628       {
26629         "title": "Example usage:",
26630         "content": "curl https://{domain}/api/system -v -u {name}:{password}",
26631         "type": "json"
26632       }
26633     ],
26634     "name": "GetSystemInformation",
26635     "group": "System_Information",
26636     "description": "<p>Motion returns the system information.</p>",
26637     "version": "0.0.0",
26638     "filename": "server/api/system/index.js",
26639     "groupTitle": "System_Information"
26640   },
26641   {
26642     "type": "get",
26643     "url": "/api/system/process",
26644     "title": "Gets system information",
26645     "examples": [
26646       {
26647         "title": "Example usage:",
26648         "content": "curl https://{domain}/api/system -v -u {name}:{password}",
26649         "type": "json"
26650       }
26651     ],
26652     "name": "GetSystemInformation",
26653     "group": "System_Information",
26654     "description": "<p>Motion returns the system information.</p>",
26655     "version": "0.0.0",
26656     "filename": "server/api/system/index.js",
26657     "groupTitle": "System_Information"
26658   },
26659   {
26660     "type": "post",
26661     "url": "/api/tags",
26662     "title": "Creates a new Tag",
26663     "examples": [
26664       {
26665         "title": "Example usage:",
26666         "content": "curl https://{domain}/api/tags -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
26667         "type": "json"
26668       }
26669     ],
26670     "name": "CreateTags",
26671     "group": "Tags",
26672     "parameter": {
26673       "fields": {
26674         "Body": [
26675           {
26676             "group": "Body",
26677             "type": "String",
26678             "optional": false,
26679             "field": "name",
26680             "description": ""
26681           },
26682           {
26683             "group": "Body",
26684             "type": "String",
26685             "optional": true,
26686             "field": "color",
26687             "description": ""
26688           },
26689           {
26690             "group": "Body",
26691             "type": "String",
26692             "optional": true,
26693             "field": "description",
26694             "description": ""
26695           }
26696         ]
26697       }
26698     },
26699     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26700     "version": "0.0.0",
26701     "filename": "server/api/tag/index.js",
26702     "groupTitle": "Tags"
26703   },
26704   {
26705     "type": "delete",
26706     "url": "/api/tags/{id}",
26707     "title": "Deletes a Tag",
26708     "examples": [
26709       {
26710         "title": "Example usage:",
26711         "content": "curl https://{domain}/api/tags/{id} -v -u {name}:{password} -X DELETE",
26712         "type": "json"
26713       }
26714     ],
26715     "name": "DeleteTags",
26716     "group": "Tags",
26717     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26718     "version": "0.0.0",
26719     "filename": "server/api/tag/index.js",
26720     "groupTitle": "Tags"
26721   },
26722   {
26723     "type": "get",
26724     "url": "/api/tags",
26725     "title": "Gets a list of Tags",
26726     "examples": [
26727       {
26728         "title": "Example usage:",
26729         "content": "curl https://{domain}/api/tags -v -u {name}:{password}",
26730         "type": "json"
26731       }
26732     ],
26733     "name": "GetTags",
26734     "group": "Tags",
26735     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
26736     "version": "0.0.0",
26737     "filename": "server/api/tag/index.js",
26738     "groupTitle": "Tags"
26739   },
26740   {
26741     "type": "get",
26742     "url": "/api/tags/{id}",
26743     "title": "Gets a single Tag",
26744     "examples": [
26745       {
26746         "title": "Example usage:",
26747         "content": "curl https://{domain}/api/tags/{id} -v -u {name}:{password}",
26748         "type": "json"
26749       }
26750     ],
26751     "name": "ShowTags",
26752     "group": "Tags",
26753     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26754     "version": "0.0.0",
26755     "filename": "server/api/tag/index.js",
26756     "groupTitle": "Tags"
26757   },
26758   {
26759     "type": "put",
26760     "url": "/api/tags/{id}",
26761     "title": "Update an existing Tag",
26762     "examples": [
26763       {
26764         "title": "Example usage:",
26765         "content": "curl https://{domain}/api/tags/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
26766         "type": "json"
26767       }
26768     ],
26769     "name": "updateTags",
26770     "group": "Tags",
26771     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26772     "version": "0.0.0",
26773     "filename": "server/api/tag/index.js",
26774     "groupTitle": "Tags"
26775   },
26776   {
26777     "type": "post",
26778     "url": "/api/teams/{id}/queues",
26779     "title": "Add queues to a team",
26780     "examples": [
26781       {
26782         "title": "Example usage:",
26783         "content": "curl https://{domain}/api/teams/{id}/queues -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
26784         "type": "json"
26785       }
26786     ],
26787     "name": "AddQueues",
26788     "group": "Teams",
26789     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26790     "version": "0.0.0",
26791     "filename": "server/api/team/index.js",
26792     "groupTitle": "Teams"
26793   },
26794   {
26795     "type": "post",
26796     "url": "/api/teams",
26797     "title": "Creates a new Team",
26798     "examples": [
26799       {
26800         "title": "Example usage:",
26801         "content": "curl https://{domain}/api/teams -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
26802         "type": "json"
26803       }
26804     ],
26805     "name": "CreateTeams",
26806     "group": "Teams",
26807     "parameter": {
26808       "fields": {
26809         "Body": [
26810           {
26811             "group": "Body",
26812             "type": "String",
26813             "optional": false,
26814             "field": "name",
26815             "description": ""
26816           },
26817           {
26818             "group": "Body",
26819             "type": "String",
26820             "optional": true,
26821             "field": "description",
26822             "description": ""
26823           }
26824         ]
26825       }
26826     },
26827     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26828     "version": "0.0.0",
26829     "filename": "server/api/team/index.js",
26830     "groupTitle": "Teams"
26831   },
26832   {
26833     "type": "delete",
26834     "url": "/api/teams/{id}",
26835     "title": "Deletes a Team",
26836     "examples": [
26837       {
26838         "title": "Example usage:",
26839         "content": "curl https://{domain}/api/teams/{id} -v -u {name}:{password} -X DELETE",
26840         "type": "json"
26841       }
26842     ],
26843     "name": "DeleteTeams",
26844     "group": "Teams",
26845     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26846     "version": "0.0.0",
26847     "filename": "server/api/team/index.js",
26848     "groupTitle": "Teams"
26849   },
26850   {
26851     "type": "get",
26852     "url": "/api/teams/{id}/users",
26853     "title": "Gets agents from team",
26854     "examples": [
26855       {
26856         "title": "Example usage:",
26857         "content": "curl https://{domain}/api/teams/{id}/users -v -u {name}:{password} -X GET",
26858         "type": "json"
26859       }
26860     ],
26861     "name": "GetAgents",
26862     "group": "Teams",
26863     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26864     "version": "0.0.0",
26865     "filename": "server/api/team/index.js",
26866     "groupTitle": "Teams"
26867   },
26868   {
26869     "type": "get",
26870     "url": "/api/teams/{id}/queues?channel={channel}",
26871     "title": "Gets Queues list",
26872     "examples": [
26873       {
26874         "title": "Example usage:",
26875         "content": "curl https://{domain}/api/teams/{id}/queues?channel={channel} -v -u {name}:{password}",
26876         "type": "json"
26877       }
26878     ],
26879     "name": "GetQueues",
26880     "group": "Teams",
26881     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26882     "version": "0.0.0",
26883     "filename": "server/api/team/index.js",
26884     "groupTitle": "Teams"
26885   },
26886   {
26887     "type": "get",
26888     "url": "/api/teams",
26889     "title": "Gets a list of Teams",
26890     "examples": [
26891       {
26892         "title": "Example usage:",
26893         "content": "curl https://{domain}/api/teams -v -u {name}:{password}",
26894         "type": "json"
26895       }
26896     ],
26897     "name": "GetTeams",
26898     "group": "Teams",
26899     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
26900     "version": "0.0.0",
26901     "filename": "server/api/team/index.js",
26902     "groupTitle": "Teams"
26903   },
26904   {
26905     "type": "delete",
26906     "url": "/api/teams/{id}/users",
26907     "title": "Removes agents from a team",
26908     "examples": [
26909       {
26910         "title": "Example usage:",
26911         "content": "curl https://{domain}/api/teams/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
26912         "type": "json"
26913       }
26914     ],
26915     "name": "RemoveAgents",
26916     "group": "Teams",
26917     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26918     "version": "0.0.0",
26919     "filename": "server/api/team/index.js",
26920     "groupTitle": "Teams"
26921   },
26922   {
26923     "type": "delete",
26924     "url": "/api/teams/{id}/queues",
26925     "title": "Remove queues to a team",
26926     "examples": [
26927       {
26928         "title": "Example usage:",
26929         "content": "curl https://{domain}/api/teams/{id}/queues?channel=voice&ids=1&ids=2 -v -u {name}:{password} -X DELETE",
26930         "type": "json"
26931       }
26932     ],
26933     "name": "RemoveQueues",
26934     "group": "Teams",
26935     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26936     "version": "0.0.0",
26937     "filename": "server/api/team/index.js",
26938     "groupTitle": "Teams"
26939   },
26940   {
26941     "type": "delete",
26942     "url": "/api/whatsapp/queues/{id}/teams",
26943     "title": "Remove teams from a queue",
26944     "examples": [
26945       {
26946         "title": "Example usage:",
26947         "content": "curl https://{domain}/api/whatsapp/queues/{id}/teams -v -u {name}:{password} -X DELETE",
26948         "type": "json"
26949       }
26950     ],
26951     "name": "RemoveTeams",
26952     "group": "Teams",
26953     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26954     "version": "0.0.0",
26955     "filename": "server/api/whatsappQueue/index.js",
26956     "groupTitle": "Teams"
26957   },
26958   {
26959     "type": "delete",
26960     "url": "/api/voice/Prefixes/{id}/teams",
26961     "title": "Remove teams from a voice prefix",
26962     "examples": [
26963       {
26964         "title": "Example usage:",
26965         "content": "curl https://{domain}/api/voice/prefixes/{id}/teams -v -u {name}:{password} -X DELETE",
26966         "type": "json"
26967       }
26968     ],
26969     "name": "RemoveTeams",
26970     "group": "Teams",
26971     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26972     "version": "0.0.0",
26973     "filename": "server/api/voicePrefix/index.js",
26974     "groupTitle": "Teams"
26975   },
26976   {
26977     "type": "delete",
26978     "url": "/api/fax/queues/{id}/teams",
26979     "title": "Remove teams from a queue",
26980     "examples": [
26981       {
26982         "title": "Example usage:",
26983         "content": "curl https://{domain}/api/fax/queues/{id}/teams -v -u {name}:{password} -X DELETE",
26984         "type": "json"
26985       }
26986     ],
26987     "name": "RemoveTeams",
26988     "group": "Teams",
26989     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26990     "version": "0.0.0",
26991     "filename": "server/api/faxQueue/index.js",
26992     "groupTitle": "Teams"
26993   },
26994   {
26995     "type": "delete",
26996     "url": "/api/mail/queues/{id}/teams",
26997     "title": "Remove teams from a queue",
26998     "examples": [
26999       {
27000         "title": "Example usage:",
27001         "content": "curl https://{domain}/api/mail/queues/{id}/teams -v -u {name}:{password} -X DELETE",
27002         "type": "json"
27003       }
27004     ],
27005     "name": "RemoveTeams",
27006     "group": "Teams",
27007     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27008     "version": "0.0.0",
27009     "filename": "server/api/mailQueue/index.js",
27010     "groupTitle": "Teams"
27011   },
27012   {
27013     "type": "delete",
27014     "url": "/api/voice/queues/{id}/teams",
27015     "title": "Remove teams from a queue",
27016     "examples": [
27017       {
27018         "title": "Example usage:",
27019         "content": "curl https://{domain}/api/voice/queues/{id}/teams -v -u {name}:{password} -X DELETE",
27020         "type": "json"
27021       }
27022     ],
27023     "name": "RemoveTeams",
27024     "group": "Teams",
27025     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27026     "version": "0.0.0",
27027     "filename": "server/api/voiceQueue/index.js",
27028     "groupTitle": "Teams"
27029   },
27030   {
27031     "type": "delete",
27032     "url": "/api/openchannel/queues/{id}/teams",
27033     "title": "Remove teams from a queue",
27034     "examples": [
27035       {
27036         "title": "Example usage:",
27037         "content": "curl https://{domain}/api/openchannel/queues/{id}/teams -v -u {name}:{password} -X DELETE",
27038         "type": "json"
27039       }
27040     ],
27041     "name": "RemoveTeams",
27042     "group": "Teams",
27043     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27044     "version": "0.0.0",
27045     "filename": "server/api/openchannelQueue/index.js",
27046     "groupTitle": "Teams"
27047   },
27048   {
27049     "type": "delete",
27050     "url": "/api/sms/queues/{id}/teams",
27051     "title": "Remove teams from a queue",
27052     "examples": [
27053       {
27054         "title": "Example usage:",
27055         "content": "curl https://{domain}/api/sms/queues/{id}/teams -v -u {name}:{password} -X DELETE",
27056         "type": "json"
27057       }
27058     ],
27059     "name": "RemoveTeams",
27060     "group": "Teams",
27061     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27062     "version": "0.0.0",
27063     "filename": "server/api/smsQueue/index.js",
27064     "groupTitle": "Teams"
27065   },
27066   {
27067     "type": "delete",
27068     "url": "/api/chat/queues/{id}/teams",
27069     "title": "Remove teams from a queue",
27070     "examples": [
27071       {
27072         "title": "Example usage:",
27073         "content": "curl https://{domain}/api/chat/queues/{id}/teams -v -u {name}:{password} -X DELETE",
27074         "type": "json"
27075       }
27076     ],
27077     "name": "RemoveTeams",
27078     "group": "Teams",
27079     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27080     "version": "0.0.0",
27081     "filename": "server/api/chatQueue/index.js",
27082     "groupTitle": "Teams"
27083   },
27084   {
27085     "type": "get",
27086     "url": "/api/teams/{id}",
27087     "title": "Gets a single Team",
27088     "examples": [
27089       {
27090         "title": "Example usage:",
27091         "content": "curl https://{domain}/api/teams/{id} -v -u {name}:{password}",
27092         "type": "json"
27093       }
27094     ],
27095     "name": "ShowTeams",
27096     "group": "Teams",
27097     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27098     "version": "0.0.0",
27099     "filename": "server/api/team/index.js",
27100     "groupTitle": "Teams"
27101   },
27102   {
27103     "type": "post",
27104     "url": "/api/teams/{id}/users",
27105     "title": "Adds agents to a team",
27106     "examples": [
27107       {
27108         "title": "Example usage:",
27109         "content": "curl https://{domain}/api/teams/{id}/users -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
27110         "type": "json"
27111       }
27112     ],
27113     "name": "addAgents",
27114     "group": "Teams",
27115     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27116     "version": "0.0.0",
27117     "filename": "server/api/team/index.js",
27118     "groupTitle": "Teams"
27119   },
27120   {
27121     "type": "put",
27122     "url": "/api/teams/{id}",
27123     "title": "Update an existing Team",
27124     "examples": [
27125       {
27126         "title": "Example usage:",
27127         "content": "curl https://{domain}/api/teams/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
27128         "type": "json"
27129       }
27130     ],
27131     "name": "updateTeams",
27132     "group": "Teams",
27133     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27134     "version": "0.0.0",
27135     "filename": "server/api/team/index.js",
27136     "groupTitle": "Teams"
27137   },
27138   {
27139     "type": "post",
27140     "url": "/api/templates",
27141     "title": "Creates a new Template",
27142     "examples": [
27143       {
27144         "title": "Example usage:",
27145         "content": "curl https://{domain}/api/templates -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
27146         "type": "json"
27147       }
27148     ],
27149     "name": "CreateTemplates",
27150     "group": "Templates",
27151     "parameter": {
27152       "fields": {
27153         "Body": [
27154           {
27155             "group": "Body",
27156             "type": "String",
27157             "optional": true,
27158             "field": "name",
27159             "description": ""
27160           },
27161           {
27162             "group": "Body",
27163             "type": "String",
27164             "optional": true,
27165             "field": "description",
27166             "description": ""
27167           },
27168           {
27169             "group": "Body",
27170             "type": "Text",
27171             "optional": true,
27172             "field": "html",
27173             "description": ""
27174           }
27175         ]
27176       }
27177     },
27178     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27179     "version": "0.0.0",
27180     "filename": "server/api/template/index.js",
27181     "groupTitle": "Templates"
27182   },
27183   {
27184     "type": "delete",
27185     "url": "/api/templates/{id}",
27186     "title": "Deletes a Template",
27187     "examples": [
27188       {
27189         "title": "Example usage:",
27190         "content": "curl https://{domain}/api/templates/{id} -v -u {name}:{password} -X DELETE",
27191         "type": "json"
27192       }
27193     ],
27194     "name": "DeleteTemplates",
27195     "group": "Templates",
27196     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27197     "version": "0.0.0",
27198     "filename": "server/api/template/index.js",
27199     "groupTitle": "Templates"
27200   },
27201   {
27202     "type": "get",
27203     "url": "/api/templates",
27204     "title": "Gets a list of Templates",
27205     "examples": [
27206       {
27207         "title": "Example usage:",
27208         "content": "curl https://{domain}/api/templates -v -u {name}:{password}",
27209         "type": "json"
27210       }
27211     ],
27212     "name": "GetTemplates",
27213     "group": "Templates",
27214     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
27215     "version": "0.0.0",
27216     "filename": "server/api/template/index.js",
27217     "groupTitle": "Templates"
27218   },
27219   {
27220     "type": "get",
27221     "url": "/api/templates/{id}",
27222     "title": "Gets a single Template",
27223     "examples": [
27224       {
27225         "title": "Example usage:",
27226         "content": "curl https://{domain}/api/templates/{id} -v -u {name}:{password}",
27227         "type": "json"
27228       }
27229     ],
27230     "name": "ShowTemplates",
27231     "group": "Templates",
27232     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27233     "version": "0.0.0",
27234     "filename": "server/api/template/index.js",
27235     "groupTitle": "Templates"
27236   },
27237   {
27238     "type": "put",
27239     "url": "/api/templates/{id}",
27240     "title": "Update an existing Template",
27241     "examples": [
27242       {
27243         "title": "Example usage:",
27244         "content": "curl https://{domain}/api/templates/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
27245         "type": "json"
27246       }
27247     ],
27248     "name": "updateTemplates",
27249     "group": "Templates",
27250     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27251     "version": "0.0.0",
27252     "filename": "server/api/template/index.js",
27253     "groupTitle": "Templates"
27254   },
27255   {
27256     "type": "post",
27257     "url": "/api/triggers",
27258     "title": "Creates a new Trigger",
27259     "examples": [
27260       {
27261         "title": "Example usage:",
27262         "content": "curl https://{domain}/api/triggers -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
27263         "type": "json"
27264       }
27265     ],
27266     "name": "CreateTriggers",
27267     "group": "Triggers",
27268     "parameter": {
27269       "fields": {
27270         "Body": [
27271           {
27272             "group": "Body",
27273             "type": "String",
27274             "optional": true,
27275             "field": "name",
27276             "description": ""
27277           },
27278           {
27279             "group": "Body",
27280             "type": "String",
27281             "optional": true,
27282             "field": "channel",
27283             "description": ""
27284           },
27285           {
27286             "group": "Body",
27287             "type": "String",
27288             "optional": true,
27289             "field": "description",
27290             "description": ""
27291           },
27292           {
27293             "group": "Body",
27294             "type": "Boolean",
27295             "optional": true,
27296             "field": "status",
27297             "description": ""
27298           }
27299         ]
27300       }
27301     },
27302     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27303     "version": "0.0.0",
27304     "filename": "server/api/trigger/index.js",
27305     "groupTitle": "Triggers"
27306   },
27307   {
27308     "type": "delete",
27309     "url": "/api/triggers/{id}",
27310     "title": "Deletes a Trigger",
27311     "examples": [
27312       {
27313         "title": "Example usage:",
27314         "content": "curl https://{domain}/api/triggers/{id} -v -u {name}:{password} -X DELETE",
27315         "type": "json"
27316       }
27317     ],
27318     "name": "DeleteTriggers",
27319     "group": "Triggers",
27320     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27321     "version": "0.0.0",
27322     "filename": "server/api/trigger/index.js",
27323     "groupTitle": "Triggers"
27324   },
27325   {
27326     "type": "get",
27327     "url": "/api/triggers",
27328     "title": "Gets a list of Triggers",
27329     "examples": [
27330       {
27331         "title": "Example usage:",
27332         "content": "curl https://{domain}/api/triggers -v -u {name}:{password}",
27333         "type": "json"
27334       }
27335     ],
27336     "name": "GetTriggers",
27337     "group": "Triggers",
27338     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
27339     "version": "0.0.0",
27340     "filename": "server/api/trigger/index.js",
27341     "groupTitle": "Triggers"
27342   },
27343   {
27344     "type": "get",
27345     "url": "/api/triggers/{id}",
27346     "title": "Gets a single Trigger",
27347     "examples": [
27348       {
27349         "title": "Example usage:",
27350         "content": "curl https://{domain}/api/triggers/{id} -v -u {name}:{password}",
27351         "type": "json"
27352       }
27353     ],
27354     "name": "ShowTriggers",
27355     "group": "Triggers",
27356     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27357     "version": "0.0.0",
27358     "filename": "server/api/trigger/index.js",
27359     "groupTitle": "Triggers"
27360   },
27361   {
27362     "type": "post",
27363     "url": "/api/triggers/{id}/actions",
27364     "title": "Creates new actions",
27365     "examples": [
27366       {
27367         "title": "Example usage:",
27368         "content": "curl https://{domain}/api/triggers/{id}/actions -d '{\"action\": \"contactManager\",\"data1\": \"1\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
27369         "type": "json"
27370       }
27371     ],
27372     "name": "addAction",
27373     "group": "Triggers",
27374     "parameter": {
27375       "fields": {
27376         "Body": [
27377           {
27378             "group": "Body",
27379             "type": "Virtual",
27380             "optional": true,
27381             "field": "name",
27382             "description": ""
27383           },
27384           {
27385             "group": "Body",
27386             "type": "String",
27387             "optional": false,
27388             "field": "action",
27389             "description": "<p>Allowed values: contactManager, integration, motionbar, jscripty, urlForward, browser, bot, script</p>"
27390           },
27391           {
27392             "group": "Body",
27393             "type": "String",
27394             "optional": true,
27395             "field": "data1",
27396             "description": "<p>contactManager[ListId], integration[intName(zendesk)], motionbar[Popup(0),URL(1),WinApp(2)], urlForward[GET,POST], browser[TemplateId(0),URL(1)]</p>"
27397           },
27398           {
27399             "group": "Body",
27400             "type": "String",
27401             "optional": true,
27402             "field": "data2",
27403             "description": "<p>integration[AccountId], motionbar[TemplateId,URL,WinAppPath], urlForward[URL]</p>"
27404           },
27405           {
27406             "group": "Body",
27407             "type": "String",
27408             "optional": true,
27409             "field": "data3",
27410             "description": "<p>motionbar[NULL,NULL,WinAppArguments]</p>"
27411           },
27412           {
27413             "group": "Body",
27414             "type": "String",
27415             "optional": true,
27416             "field": "data4",
27417             "description": ""
27418           },
27419           {
27420             "group": "Body",
27421             "type": "String",
27422             "optional": true,
27423             "field": "data5",
27424             "description": ""
27425           },
27426           {
27427             "group": "Body",
27428             "type": "String",
27429             "optional": true,
27430             "field": "data6",
27431             "description": ""
27432           },
27433           {
27434             "group": "Body",
27435             "type": "Text",
27436             "optional": true,
27437             "field": "data7",
27438             "description": ""
27439           }
27440         ]
27441       }
27442     },
27443     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27444     "version": "0.0.0",
27445     "filename": "server/api/trigger/index.js",
27446     "groupTitle": "Triggers"
27447   },
27448   {
27449     "type": "post",
27450     "url": "/api/triggers/{id}/all_conditions",
27451     "title": "Creates a new \"AND\"condition",
27452     "examples": [
27453       {
27454         "title": "Example usage:",
27455         "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",
27456         "type": "json"
27457       }
27458     ],
27459     "name": "addAllCondition",
27460     "group": "Triggers",
27461     "parameter": {
27462       "fields": {
27463         "Body": [
27464           {
27465             "group": "Body",
27466             "type": "Virtual",
27467             "optional": true,
27468             "field": "name",
27469             "description": ""
27470           },
27471           {
27472             "group": "Body",
27473             "type": "String",
27474             "optional": false,
27475             "field": "field",
27476             "description": ""
27477           },
27478           {
27479             "group": "Body",
27480             "type": "String",
27481             "optional": false,
27482             "field": "operator",
27483             "description": ""
27484           },
27485           {
27486             "group": "Body",
27487             "type": "String",
27488             "optional": false,
27489             "field": "value",
27490             "description": ""
27491           }
27492         ]
27493       }
27494     },
27495     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27496     "version": "0.0.0",
27497     "filename": "server/api/trigger/index.js",
27498     "groupTitle": "Triggers"
27499   },
27500   {
27501     "type": "post",
27502     "url": "/api/triggers/{id}/any_conditions",
27503     "title": "Creates a new \"OR\"condition",
27504     "examples": [
27505       {
27506         "title": "Example usage:",
27507         "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",
27508         "type": "json"
27509       }
27510     ],
27511     "name": "addAnyCondition",
27512     "group": "Triggers",
27513     "parameter": {
27514       "fields": {
27515         "Body": [
27516           {
27517             "group": "Body",
27518             "type": "Virtual",
27519             "optional": true,
27520             "field": "name",
27521             "description": ""
27522           },
27523           {
27524             "group": "Body",
27525             "type": "String",
27526             "optional": false,
27527             "field": "field",
27528             "description": ""
27529           },
27530           {
27531             "group": "Body",
27532             "type": "String",
27533             "optional": false,
27534             "field": "operator",
27535             "description": ""
27536           },
27537           {
27538             "group": "Body",
27539             "type": "String",
27540             "optional": false,
27541             "field": "value",
27542             "description": ""
27543           }
27544         ]
27545       }
27546     },
27547     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27548     "version": "0.0.0",
27549     "filename": "server/api/trigger/index.js",
27550     "groupTitle": "Triggers"
27551   },
27552   {
27553     "type": "get",
27554     "url": "/api/triggers/{id}/actions",
27555     "title": "Gets Trigger Actions",
27556     "examples": [
27557       {
27558         "title": "Example usage:",
27559         "content": "curl https://{domain}/api/triggers/{id}/actions -v -u {name}:{password} -X GET",
27560         "type": "json"
27561       }
27562     ],
27563     "name": "getActions",
27564     "group": "Triggers",
27565     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27566     "version": "0.0.0",
27567     "filename": "server/api/trigger/index.js",
27568     "groupTitle": "Triggers"
27569   },
27570   {
27571     "type": "get",
27572     "url": "/api/triggers/{id}/all_conditions",
27573     "title": "Gets \"AND\" Trigger Conditions",
27574     "examples": [
27575       {
27576         "title": "Example usage:",
27577         "content": "curl https://{domain}/api/triggers/{id}/all_conditions -v -u {name}:{password} -X GET",
27578         "type": "json"
27579       }
27580     ],
27581     "name": "getAllConditions",
27582     "group": "Triggers",
27583     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27584     "version": "0.0.0",
27585     "filename": "server/api/trigger/index.js",
27586     "groupTitle": "Triggers"
27587   },
27588   {
27589     "type": "get",
27590     "url": "/api/triggers/{id}/any_conditions",
27591     "title": "Gets \"OR\" Trigger Conditions",
27592     "examples": [
27593       {
27594         "title": "Example usage:",
27595         "content": "curl https://{domain}/api/triggers/{id}/any_conditions -v -u {name}:{password} -X GET",
27596         "type": "json"
27597       }
27598     ],
27599     "name": "getAnyConditions",
27600     "group": "Triggers",
27601     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27602     "version": "0.0.0",
27603     "filename": "server/api/trigger/index.js",
27604     "groupTitle": "Triggers"
27605   },
27606   {
27607     "type": "put",
27608     "url": "/api/triggers/{id}",
27609     "title": "Update an existing Trigger",
27610     "examples": [
27611       {
27612         "title": "Example usage:",
27613         "content": "curl https://{domain}/api/triggers/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
27614         "type": "json"
27615       }
27616     ],
27617     "name": "updateTriggers",
27618     "group": "Triggers",
27619     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27620     "version": "0.0.0",
27621     "filename": "server/api/trigger/index.js",
27622     "groupTitle": "Triggers"
27623   },
27624   {
27625     "type": "post",
27626     "url": "/api/trunks/clone",
27627     "title": "Clone an existing Trunk",
27628     "examples": [
27629       {
27630         "title": "Example usage:",
27631         "content": "curl https://{domain}/api/trunks/clone -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
27632         "type": "json"
27633       }
27634     ],
27635     "name": "CloneTrunks",
27636     "group": "Trunks",
27637     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27638     "version": "0.0.0",
27639     "filename": "server/api/trunk/index.js",
27640     "groupTitle": "Trunks"
27641   },
27642   {
27643     "type": "post",
27644     "url": "/api/trunks",
27645     "title": "Create a new trunk",
27646     "examples": [
27647       {
27648         "title": "Example usage:",
27649         "content": "curl https://{domain}/api/trunks -v -u {name}:{password} -X POST",
27650         "type": "json"
27651       }
27652     ],
27653     "name": "Create",
27654     "group": "Trunks",
27655     "parameter": {
27656       "fields": {
27657         "Body": [
27658           {
27659             "group": "Body",
27660             "type": "String",
27661             "optional": false,
27662             "field": "name",
27663             "description": ""
27664           },
27665           {
27666             "group": "Body",
27667             "type": "String",
27668             "allowedValues": [
27669               "\"friend\"",
27670               "\"user\"",
27671               "\"peer\""
27672             ],
27673             "optional": false,
27674             "field": "type",
27675             "description": ""
27676           },
27677           {
27678             "group": "Body",
27679             "type": "String",
27680             "optional": false,
27681             "field": "context",
27682             "description": ""
27683           },
27684           {
27685             "group": "Body",
27686             "type": "String",
27687             "allowedValues": [
27688               "\"ALLOWED_NOT_SCREENED\"",
27689               "\"ALLOWED_PASSED_SCREEN\"",
27690               "\"ALLOWED_FAILED_SCREEN\"",
27691               "\"ALLOWED\"",
27692               "\"PROHIB_NOT_SCREENED\"",
27693               "\"PROHIB_PASSED_SCREEN\"",
27694               "\"PROHIB_FAILED_SCREEN\"",
27695               "\"PROHIB\""
27696             ],
27697             "optional": true,
27698             "field": "callingpres",
27699             "description": ""
27700           },
27701           {
27702             "group": "Body",
27703             "type": "String",
27704             "optional": true,
27705             "field": "deny",
27706             "description": ""
27707           },
27708           {
27709             "group": "Body",
27710             "type": "String",
27711             "optional": true,
27712             "field": "permit",
27713             "description": ""
27714           },
27715           {
27716             "group": "Body",
27717             "type": "String",
27718             "optional": true,
27719             "field": "secret",
27720             "description": ""
27721           },
27722           {
27723             "group": "Body",
27724             "type": "String",
27725             "optional": true,
27726             "field": "md5secret",
27727             "description": ""
27728           },
27729           {
27730             "group": "Body",
27731             "type": "String",
27732             "optional": true,
27733             "field": "remotesecret",
27734             "description": ""
27735           },
27736           {
27737             "group": "Body",
27738             "type": "String",
27739             "optional": true,
27740             "field": "transport",
27741             "description": "<p>String is deprecated. Please use an Array as [&quot;udp&quot;, &quot;tcp&quot;]</p>"
27742           },
27743           {
27744             "group": "Body",
27745             "type": "String",
27746             "allowedValues": [
27747               "\"rfc2833\"",
27748               "\"info\"",
27749               "\"shortinfo\"",
27750               "\"inband\"",
27751               "\"auto\""
27752             ],
27753             "optional": true,
27754             "field": "dtmfmode",
27755             "description": ""
27756           },
27757           {
27758             "group": "Body",
27759             "type": "String",
27760             "allowedValues": [
27761               "\"yes\"",
27762               "\"no\"",
27763               "\"nonat\"",
27764               "\"update\"",
27765               "\"outgoing\""
27766             ],
27767             "optional": true,
27768             "field": "directmedia",
27769             "description": ""
27770           },
27771           {
27772             "group": "Body",
27773             "type": "String",
27774             "allowedValues": [
27775               "\"yes\"",
27776               "\"no\""
27777             ],
27778             "optional": true,
27779             "field": "directrtpsetup",
27780             "description": ""
27781           },
27782           {
27783             "group": "Body",
27784             "type": "String",
27785             "optional": true,
27786             "field": "directmediapermit",
27787             "description": ""
27788           },
27789           {
27790             "group": "Body",
27791             "type": "String",
27792             "optional": true,
27793             "field": "directmediadeny",
27794             "description": ""
27795           },
27796           {
27797             "group": "Body",
27798             "type": "String",
27799             "optional": true,
27800             "field": "nat",
27801             "description": "<p>String is deprecated. Please use an Array as [&quot;force_rport&quot;, &quot;comedia&quot;]</p>"
27802           },
27803           {
27804             "group": "Body",
27805             "type": "String",
27806             "optional": true,
27807             "field": "callgroup",
27808             "description": ""
27809           },
27810           {
27811             "group": "Body",
27812             "type": "String",
27813             "optional": true,
27814             "field": "namedcallgroup",
27815             "description": ""
27816           },
27817           {
27818             "group": "Body",
27819             "type": "String",
27820             "optional": true,
27821             "field": "pickupgroup",
27822             "description": ""
27823           },
27824           {
27825             "group": "Body",
27826             "type": "String",
27827             "optional": true,
27828             "field": "namedpickupgroup",
27829             "description": ""
27830           },
27831           {
27832             "group": "Body",
27833             "type": "String",
27834             "optional": true,
27835             "field": "language",
27836             "description": ""
27837           },
27838           {
27839             "group": "Body",
27840             "type": "String",
27841             "optional": true,
27842             "field": "tonezone",
27843             "description": ""
27844           },
27845           {
27846             "group": "Body",
27847             "type": "String",
27848             "optional": true,
27849             "field": "disallow",
27850             "description": ""
27851           },
27852           {
27853             "group": "Body",
27854             "type": "String",
27855             "optional": false,
27856             "field": "allow",
27857             "description": "<p>String is deprecated. Please use an Array as [&quot;ulaw&quot;, &quot;alaw&quot;, &quot;alaw&quot;]</p>"
27858           },
27859           {
27860             "group": "Body",
27861             "type": "String",
27862             "allowedValues": [
27863               "\"yes\"",
27864               "\"no\""
27865             ],
27866             "optional": true,
27867             "field": "autoframing",
27868             "description": ""
27869           },
27870           {
27871             "group": "Body",
27872             "type": "String",
27873             "optional": true,
27874             "field": "insecure",
27875             "description": "<p>String is deprecated. Please use an Array as [&quot;port&quot;, &quot;invite&quot;]</p>"
27876           },
27877           {
27878             "group": "Body",
27879             "type": "String",
27880             "allowedValues": [
27881               "\"yes\"",
27882               "\"no\""
27883             ],
27884             "optional": true,
27885             "field": "trustrpid",
27886             "description": ""
27887           },
27888           {
27889             "group": "Body",
27890             "type": "String",
27891             "allowedValues": [
27892               "\"yes\"",
27893               "\"no\""
27894             ],
27895             "optional": true,
27896             "field": "trust_id_outbound",
27897             "description": ""
27898           },
27899           {
27900             "group": "Body",
27901             "type": "String",
27902             "allowedValues": [
27903               "\"yes\"",
27904               "\"no\"",
27905               "\"never\""
27906             ],
27907             "optional": true,
27908             "field": "progressinband",
27909             "description": ""
27910           },
27911           {
27912             "group": "Body",
27913             "type": "String",
27914             "allowedValues": [
27915               "\"yes\"",
27916               "\"no\""
27917             ],
27918             "optional": true,
27919             "field": "promiscredir",
27920             "description": ""
27921           },
27922           {
27923             "group": "Body",
27924             "type": "String",
27925             "allowedValues": [
27926               "\"yes\"",
27927               "\"no\""
27928             ],
27929             "optional": true,
27930             "field": "useclientcode",
27931             "description": ""
27932           },
27933           {
27934             "group": "Body",
27935             "type": "Integer",
27936             "optional": true,
27937             "field": "accountcode",
27938             "description": ""
27939           },
27940           {
27941             "group": "Body",
27942             "type": "String",
27943             "optional": true,
27944             "field": "setvar",
27945             "description": ""
27946           },
27947           {
27948             "group": "Body",
27949             "type": "String",
27950             "optional": true,
27951             "field": "callerid",
27952             "description": ""
27953           },
27954           {
27955             "group": "Body",
27956             "type": "String",
27957             "optional": true,
27958             "field": "amaflags",
27959             "description": ""
27960           },
27961           {
27962             "group": "Body",
27963             "type": "String",
27964             "allowedValues": [
27965               "\"yes\"",
27966               "\"no\""
27967             ],
27968             "optional": true,
27969             "field": "callcounter",
27970             "description": ""
27971           },
27972           {
27973             "group": "Body",
27974             "type": "Integer",
27975             "optional": true,
27976             "field": "busylevel",
27977             "description": ""
27978           },
27979           {
27980             "group": "Body",
27981             "type": "String",
27982             "allowedValues": [
27983               "\"yes\"",
27984               "\"no\""
27985             ],
27986             "optional": true,
27987             "field": "allowoverlap",
27988             "description": ""
27989           },
27990           {
27991             "group": "Body",
27992             "type": "String",
27993             "allowedValues": [
27994               "\"yes\"",
27995               "\"no\""
27996             ],
27997             "optional": true,
27998             "field": "allowsubscribe",
27999             "description": ""
28000           },
28001           {
28002             "group": "Body",
28003             "type": "String",
28004             "allowedValues": [
28005               "\"yes\"",
28006               "\"no\""
28007             ],
28008             "optional": true,
28009             "field": "allowtransfer",
28010             "description": ""
28011           },
28012           {
28013             "group": "Body",
28014             "type": "String",
28015             "allowedValues": [
28016               "\"yes\"",
28017               "\"no\""
28018             ],
28019             "optional": true,
28020             "field": "ignoresdpversion",
28021             "description": ""
28022           },
28023           {
28024             "group": "Body",
28025             "type": "String",
28026             "optional": true,
28027             "field": "subscribecontext",
28028             "description": ""
28029           },
28030           {
28031             "group": "Body",
28032             "type": "String",
28033             "optional": true,
28034             "field": "template",
28035             "description": ""
28036           },
28037           {
28038             "group": "Body",
28039             "type": "String",
28040             "allowedValues": [
28041               "\"yes\"",
28042               "\"no\"",
28043               "\"always\""
28044             ],
28045             "optional": true,
28046             "field": "videosupport",
28047             "description": ""
28048           },
28049           {
28050             "group": "Body",
28051             "type": "Integer",
28052             "optional": true,
28053             "field": "maxcallbitrate",
28054             "description": ""
28055           },
28056           {
28057             "group": "Body",
28058             "type": "String",
28059             "allowedValues": [
28060               "\"yes\"",
28061               "\"no\""
28062             ],
28063             "optional": true,
28064             "field": "rfc2833compensate",
28065             "description": ""
28066           },
28067           {
28068             "group": "Body",
28069             "type": "String",
28070             "optional": true,
28071             "field": "mailbox",
28072             "description": ""
28073           },
28074           {
28075             "group": "Body",
28076             "type": "String",
28077             "allowedValues": [
28078               "\"accept\"",
28079               "\"refuse\"",
28080               "\"originate\""
28081             ],
28082             "optional": true,
28083             "field": "session_timers",
28084             "description": ""
28085           },
28086           {
28087             "group": "Body",
28088             "type": "Integer",
28089             "optional": true,
28090             "field": "session_expires",
28091             "description": ""
28092           },
28093           {
28094             "group": "Body",
28095             "type": "Integer",
28096             "optional": true,
28097             "field": "session_minse",
28098             "description": ""
28099           },
28100           {
28101             "group": "Body",
28102             "type": "String",
28103             "allowedValues": [
28104               "\"uac\"",
28105               "\"uas\""
28106             ],
28107             "optional": true,
28108             "field": "session_refresher",
28109             "description": ""
28110           },
28111           {
28112             "group": "Body",
28113             "type": "String",
28114             "optional": true,
28115             "field": "t38pt_usertpsource",
28116             "description": ""
28117           },
28118           {
28119             "group": "Body",
28120             "type": "String",
28121             "optional": true,
28122             "field": "regexten",
28123             "description": ""
28124           },
28125           {
28126             "group": "Body",
28127             "type": "String",
28128             "optional": true,
28129             "field": "fromdomain",
28130             "description": ""
28131           },
28132           {
28133             "group": "Body",
28134             "type": "String",
28135             "optional": true,
28136             "field": "fromuser",
28137             "description": ""
28138           },
28139           {
28140             "group": "Body",
28141             "type": "Integer",
28142             "optional": true,
28143             "field": "port",
28144             "description": ""
28145           },
28146           {
28147             "group": "Body",
28148             "type": "String",
28149             "allowedValues": [
28150               "\"yes\"",
28151               "\"no\""
28152             ],
28153             "optional": true,
28154             "field": "qualify",
28155             "description": ""
28156           },
28157           {
28158             "group": "Body",
28159             "type": "Integer",
28160             "optional": true,
28161             "field": "keepalive",
28162             "description": ""
28163           },
28164           {
28165             "group": "Body",
28166             "type": "String",
28167             "optional": true,
28168             "field": "defaultip",
28169             "description": ""
28170           },
28171           {
28172             "group": "Body",
28173             "type": "String",
28174             "optional": true,
28175             "field": "defaultuser",
28176             "description": ""
28177           },
28178           {
28179             "group": "Body",
28180             "type": "Integer",
28181             "optional": true,
28182             "field": "rtptimeout",
28183             "description": ""
28184           },
28185           {
28186             "group": "Body",
28187             "type": "Integer",
28188             "optional": true,
28189             "field": "rtpholdtimeout",
28190             "description": ""
28191           },
28192           {
28193             "group": "Body",
28194             "type": "Integer",
28195             "optional": true,
28196             "field": "rtpkeepalive",
28197             "description": ""
28198           },
28199           {
28200             "group": "Body",
28201             "type": "String",
28202             "allowedValues": [
28203               "\"yes\"",
28204               "\"no\"",
28205               "\"pai\""
28206             ],
28207             "optional": true,
28208             "field": "sendrpid",
28209             "description": ""
28210           },
28211           {
28212             "group": "Body",
28213             "type": "String",
28214             "optional": true,
28215             "field": "outboundproxy",
28216             "description": ""
28217           },
28218           {
28219             "group": "Body",
28220             "type": "String",
28221             "optional": true,
28222             "field": "callbackextension",
28223             "description": ""
28224           },
28225           {
28226             "group": "Body",
28227             "type": "Integer",
28228             "optional": true,
28229             "field": "timert1",
28230             "description": ""
28231           },
28232           {
28233             "group": "Body",
28234             "type": "Integer",
28235             "optional": true,
28236             "field": "timerb",
28237             "description": ""
28238           },
28239           {
28240             "group": "Body",
28241             "type": "Integer",
28242             "optional": true,
28243             "field": "qualifyfreq",
28244             "description": ""
28245           },
28246           {
28247             "group": "Body",
28248             "type": "String",
28249             "optional": true,
28250             "field": "contactpermit",
28251             "description": ""
28252           },
28253           {
28254             "group": "Body",
28255             "type": "String",
28256             "optional": true,
28257             "field": "contactdeny",
28258             "description": ""
28259           },
28260           {
28261             "group": "Body",
28262             "type": "String",
28263             "optional": true,
28264             "field": "contactacl",
28265             "description": ""
28266           },
28267           {
28268             "group": "Body",
28269             "type": "String",
28270             "optional": true,
28271             "field": "unsolicited_mailbox",
28272             "description": ""
28273           },
28274           {
28275             "group": "Body",
28276             "type": "String",
28277             "optional": true,
28278             "field": "use_q850_reason",
28279             "description": ""
28280           },
28281           {
28282             "group": "Body",
28283             "type": "Integer",
28284             "optional": true,
28285             "field": "maxforwards",
28286             "description": ""
28287           },
28288           {
28289             "group": "Body",
28290             "type": "String",
28291             "allowedValues": [
28292               "\"yes\"",
28293               "\"no\""
28294             ],
28295             "optional": true,
28296             "field": "encryption",
28297             "description": ""
28298           },
28299           {
28300             "group": "Body",
28301             "type": "String",
28302             "allowedValues": [
28303               "\"yes\"",
28304               "\"no\""
28305             ],
28306             "optional": true,
28307             "field": "avpf",
28308             "description": ""
28309           },
28310           {
28311             "group": "Body",
28312             "type": "String",
28313             "allowedValues": [
28314               "\"yes\"",
28315               "\"no\""
28316             ],
28317             "optional": true,
28318             "field": "force_avp",
28319             "description": ""
28320           },
28321           {
28322             "group": "Body",
28323             "type": "String",
28324             "allowedValues": [
28325               "\"yes\"",
28326               "\"no\""
28327             ],
28328             "optional": true,
28329             "field": "icesupport",
28330             "description": ""
28331           },
28332           {
28333             "group": "Body",
28334             "type": "String",
28335             "allowedValues": [
28336               "\"yes\"",
28337               "\"no\""
28338             ],
28339             "optional": true,
28340             "field": "dtlsenable",
28341             "description": ""
28342           },
28343           {
28344             "group": "Body",
28345             "type": "String",
28346             "allowedValues": [
28347               "\"yes\"",
28348               "\"no\"",
28349               "\"fingerprint\"",
28350               "\"certificate\""
28351             ],
28352             "optional": true,
28353             "field": "dtlsverify",
28354             "description": ""
28355           },
28356           {
28357             "group": "Body",
28358             "type": "Integer",
28359             "optional": true,
28360             "field": "dtlsrekey",
28361             "description": ""
28362           },
28363           {
28364             "group": "Body",
28365             "type": "String",
28366             "optional": true,
28367             "field": "dtlscertfile",
28368             "description": ""
28369           },
28370           {
28371             "group": "Body",
28372             "type": "String",
28373             "optional": true,
28374             "field": "dtlsprivatekey",
28375             "description": ""
28376           },
28377           {
28378             "group": "Body",
28379             "type": "String",
28380             "optional": true,
28381             "field": "dtlscipher",
28382             "description": ""
28383           },
28384           {
28385             "group": "Body",
28386             "type": "String",
28387             "optional": true,
28388             "field": "dtlscafile",
28389             "description": ""
28390           },
28391           {
28392             "group": "Body",
28393             "type": "String",
28394             "optional": true,
28395             "field": "dtlscapath",
28396             "description": ""
28397           },
28398           {
28399             "group": "Body",
28400             "type": "String",
28401             "allowedValues": [
28402               "\"active\"",
28403               "\"passive\"",
28404               "\"actpass\""
28405             ],
28406             "optional": true,
28407             "field": "dtlssetup",
28408             "description": ""
28409           },
28410           {
28411             "group": "Body",
28412             "type": "String",
28413             "optional": true,
28414             "field": "dtlsfingerprint",
28415             "description": ""
28416           },
28417           {
28418             "group": "Body",
28419             "type": "String",
28420             "allowedValues": [
28421               "\"yes\"",
28422               "\"no\""
28423             ],
28424             "optional": true,
28425             "field": "usereqphone",
28426             "description": ""
28427           },
28428           {
28429             "group": "Body",
28430             "type": "String",
28431             "optional": true,
28432             "field": "recordonfeature",
28433             "description": ""
28434           },
28435           {
28436             "group": "Body",
28437             "type": "String",
28438             "optional": true,
28439             "field": "recordofffeature",
28440             "description": ""
28441           },
28442           {
28443             "group": "Body",
28444             "type": "Integer",
28445             "optional": true,
28446             "field": "call_limit",
28447             "description": ""
28448           },
28449           {
28450             "group": "Body",
28451             "type": "String",
28452             "allowedValues": [
28453               "\"yes\"",
28454               "\"no\""
28455             ],
28456             "optional": true,
28457             "field": "registertrying",
28458             "description": ""
28459           },
28460           {
28461             "group": "Body",
28462             "type": "String",
28463             "allowedValues": [
28464               "\"yes\"",
28465               "\"no\""
28466             ],
28467             "optional": true,
28468             "field": "subscribemwi",
28469             "description": ""
28470           },
28471           {
28472             "group": "Body",
28473             "type": "String",
28474             "optional": true,
28475             "field": "vmexten",
28476             "description": ""
28477           },
28478           {
28479             "group": "Body",
28480             "type": "String",
28481             "optional": true,
28482             "field": "mohinterpret",
28483             "description": ""
28484           },
28485           {
28486             "group": "Body",
28487             "type": "String",
28488             "optional": true,
28489             "field": "mohsuggest",
28490             "description": ""
28491           },
28492           {
28493             "group": "Body",
28494             "type": "String",
28495             "optional": true,
28496             "field": "parkinglot",
28497             "description": ""
28498           },
28499           {
28500             "group": "Body",
28501             "type": "String",
28502             "optional": true,
28503             "field": "description",
28504             "description": ""
28505           },
28506           {
28507             "group": "Body",
28508             "type": "String",
28509             "optional": true,
28510             "field": "host",
28511             "description": ""
28512           },
28513           {
28514             "group": "Body",
28515             "type": "String",
28516             "allowedValues": [
28517               "\"yes\"",
28518               "\"no\"",
28519               "\"nonat\"",
28520               "\"update\"",
28521               "\"update,nonat\""
28522             ],
28523             "optional": true,
28524             "field": "canreinvite",
28525             "description": ""
28526           },
28527           {
28528             "group": "Body",
28529             "type": "String",
28530             "optional": true,
28531             "field": "registry",
28532             "description": ""
28533           },
28534           {
28535             "group": "Body",
28536             "type": "String",
28537             "optional": true,
28538             "field": "otherFields",
28539             "description": ""
28540           },
28541           {
28542             "group": "Body",
28543             "type": "Boolean",
28544             "optional": false,
28545             "field": "active",
28546             "description": ""
28547           },
28548           {
28549             "group": "Body",
28550             "type": "String",
28551             "optional": true,
28552             "field": "t38pt_udptl",
28553             "description": ""
28554           }
28555         ]
28556       }
28557     },
28558     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28559     "version": "0.0.0",
28560     "filename": "server/api/trunk/index.js",
28561     "groupTitle": "Trunks"
28562   },
28563   {
28564     "type": "delete",
28565     "url": "/api/trunks/{id}",
28566     "title": "Deletes a trunk",
28567     "examples": [
28568       {
28569         "title": "Example usage:",
28570         "content": "curl https://{domain}/api/trunks/{id} -v -u {name}:{password} -X DELETE",
28571         "type": "json"
28572       }
28573     ],
28574     "name": "Delete",
28575     "group": "Trunks",
28576     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28577     "version": "0.0.0",
28578     "filename": "server/api/trunk/index.js",
28579     "groupTitle": "Trunks"
28580   },
28581   {
28582     "type": "get",
28583     "url": "/api/trunks",
28584     "title": "Gets a list of Trunks",
28585     "examples": [
28586       {
28587         "title": "Example usage:",
28588         "content": "curl https://{domain}/api/trunks -v -u {name}:{password}",
28589         "type": "json"
28590       }
28591     ],
28592     "name": "GetTrunks",
28593     "group": "Trunks",
28594     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
28595     "version": "0.0.0",
28596     "filename": "server/api/trunk/index.js",
28597     "groupTitle": "Trunks"
28598   },
28599   {
28600     "type": "get",
28601     "url": "/api/trunks/{id}",
28602     "title": "Gets a single Trunk",
28603     "examples": [
28604       {
28605         "title": "Example usage:",
28606         "content": "curl https://{domain}/api/trunks/{id} -v -u {name}:{password}",
28607         "type": "json"
28608       }
28609     ],
28610     "name": "ShowTrunks",
28611     "group": "Trunks",
28612     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28613     "version": "0.0.0",
28614     "filename": "server/api/trunk/index.js",
28615     "groupTitle": "Trunks"
28616   },
28617   {
28618     "type": "put",
28619     "url": "/api/trunks/{id}",
28620     "title": "Update an existing trunk",
28621     "examples": [
28622       {
28623         "title": "Example usage:",
28624         "content": "curl https://{domain}/api/trunks/{id} -v -u {name}:{password} -X PUT",
28625         "type": "json"
28626       }
28627     ],
28628     "name": "Update",
28629     "group": "Trunks",
28630     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28631     "version": "0.0.0",
28632     "filename": "server/api/trunk/index.js",
28633     "groupTitle": "Trunks"
28634   },
28635   {
28636     "type": "post",
28637     "url": "/api/userNotifications",
28638     "title": "Send notification to user",
28639     "examples": [
28640       {
28641         "title": "Example usage:",
28642         "content": "curl https://{domain}/api/userNotifications -d '{\"text\": \"Hello!\", \"TemplateId\": 1}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
28643         "type": "json"
28644       }
28645     ],
28646     "name": "Send",
28647     "group": "UserNotifications",
28648     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28649     "version": "0.0.0",
28650     "filename": "server/api/userNotification/index.js",
28651     "groupTitle": "UserNotifications"
28652   },
28653   {
28654     "type": "post",
28655     "url": "/api/userProfile/resources",
28656     "title": "Creates a new User Profile Resource",
28657     "examples": [
28658       {
28659         "title": "Example usage:",
28660         "content": "curl https://{domain}/api/userProfile/resources -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
28661         "type": "json"
28662       }
28663     ],
28664     "name": "CreateUser_Profile_Resources",
28665     "group": "User_Profile_Resources",
28666     "parameter": {
28667       "fields": {
28668         "Body": [
28669           {
28670             "group": "Body",
28671             "type": "String",
28672             "optional": false,
28673             "field": "name",
28674             "description": ""
28675           },
28676           {
28677             "group": "Body",
28678             "type": "Integer",
28679             "optional": false,
28680             "field": "resourceId",
28681             "description": ""
28682           },
28683           {
28684             "group": "Body",
28685             "type": "String",
28686             "optional": false,
28687             "field": "type",
28688             "description": ""
28689           }
28690         ]
28691       }
28692     },
28693     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28694     "version": "0.0.0",
28695     "filename": "server/api/userProfileResource/index.js",
28696     "groupTitle": "User_Profile_Resources"
28697   },
28698   {
28699     "type": "delete",
28700     "url": "/api/userProfile/resources/{id}",
28701     "title": "Deletes a User Profile Resource",
28702     "examples": [
28703       {
28704         "title": "Example usage:",
28705         "content": "curl https://{domain}/api/userProfile/resources/{id} -v -u {name}:{password} -X DELETE",
28706         "type": "json"
28707       }
28708     ],
28709     "name": "DeleteUser_Profile_Resources",
28710     "group": "User_Profile_Resources",
28711     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28712     "version": "0.0.0",
28713     "filename": "server/api/userProfileResource/index.js",
28714     "groupTitle": "User_Profile_Resources"
28715   },
28716   {
28717     "type": "get",
28718     "url": "/api/userProfile/resources/describe",
28719     "title": "Gets table info about User Profile Resources",
28720     "examples": [
28721       {
28722         "title": "Example usage:",
28723         "content": "curl https://{domain}/api/userProfile/resources/describe -v -u {name}:{password}",
28724         "type": "json"
28725       }
28726     ],
28727     "name": "DescribeUser_Profile_Resources",
28728     "group": "User_Profile_Resources",
28729     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28730     "version": "0.0.0",
28731     "filename": "server/api/userProfileResource/index.js",
28732     "groupTitle": "User_Profile_Resources"
28733   },
28734   {
28735     "type": "get",
28736     "url": "/api/userProfile/resources",
28737     "title": "Gets a list of User Profile Resources",
28738     "examples": [
28739       {
28740         "title": "Example usage:",
28741         "content": "curl https://{domain}/api/userProfile/resources -v -u {name}:{password}",
28742         "type": "json"
28743       }
28744     ],
28745     "name": "GetUser_Profile_Resources",
28746     "group": "User_Profile_Resources",
28747     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
28748     "version": "0.0.0",
28749     "filename": "server/api/userProfileResource/index.js",
28750     "groupTitle": "User_Profile_Resources"
28751   },
28752   {
28753     "type": "get",
28754     "url": "/api/userProfile/resources/{id}",
28755     "title": "Gets a single User Profile Resource",
28756     "examples": [
28757       {
28758         "title": "Example usage:",
28759         "content": "curl https://{domain}/api/userProfile/resources/{id} -v -u {name}:{password}",
28760         "type": "json"
28761       }
28762     ],
28763     "name": "ShowUser_Profile_Resources",
28764     "group": "User_Profile_Resources",
28765     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28766     "version": "0.0.0",
28767     "filename": "server/api/userProfileResource/index.js",
28768     "groupTitle": "User_Profile_Resources"
28769   },
28770   {
28771     "type": "put",
28772     "url": "/api/userProfile/resources/{id}",
28773     "title": "Update an existing User Profile Resource",
28774     "examples": [
28775       {
28776         "title": "Example usage:",
28777         "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",
28778         "type": "json"
28779       }
28780     ],
28781     "name": "updateUser_Profile_Resources",
28782     "group": "User_Profile_Resources",
28783     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28784     "version": "0.0.0",
28785     "filename": "server/api/userProfileResource/index.js",
28786     "groupTitle": "User_Profile_Resources"
28787   },
28788   {
28789     "type": "post",
28790     "url": "/api/userProfile/sections",
28791     "title": "Creates a new User Profile Section",
28792     "examples": [
28793       {
28794         "title": "Example usage:",
28795         "content": "curl https://{domain}/api/userProfile/sections -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
28796         "type": "json"
28797       }
28798     ],
28799     "name": "CreateUser_Profile_Sections",
28800     "group": "User_Profile_Sections",
28801     "parameter": {
28802       "fields": {
28803         "Body": [
28804           {
28805             "group": "Body",
28806             "type": "String",
28807             "optional": false,
28808             "field": "name",
28809             "description": ""
28810           },
28811           {
28812             "group": "Body",
28813             "type": "String",
28814             "optional": false,
28815             "field": "category",
28816             "description": ""
28817           },
28818           {
28819             "group": "Body",
28820             "type": "Integer",
28821             "optional": false,
28822             "field": "sectionId",
28823             "description": ""
28824           },
28825           {
28826             "group": "Body",
28827             "type": "Boolean",
28828             "optional": true,
28829             "field": "enabled",
28830             "description": ""
28831           },
28832           {
28833             "group": "Body",
28834             "type": "Boolean",
28835             "optional": true,
28836             "field": "autoAssociation",
28837             "description": ""
28838           },
28839           {
28840             "group": "Body",
28841             "type": "String",
28842             "optional": true,
28843             "field": "crudPermissions",
28844             "description": ""
28845           }
28846         ]
28847       }
28848     },
28849     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28850     "version": "0.0.0",
28851     "filename": "server/api/userProfileSection/index.js",
28852     "groupTitle": "User_Profile_Sections"
28853   },
28854   {
28855     "type": "delete",
28856     "url": "/api/userProfile/sections/{id}",
28857     "title": "Deletes a User Profile Section",
28858     "examples": [
28859       {
28860         "title": "Example usage:",
28861         "content": "curl https://{domain}/api/userProfile/sections/{id} -v -u {name}:{password} -X DELETE",
28862         "type": "json"
28863       }
28864     ],
28865     "name": "DeleteUser_Profile_Sections",
28866     "group": "User_Profile_Sections",
28867     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28868     "version": "0.0.0",
28869     "filename": "server/api/userProfileSection/index.js",
28870     "groupTitle": "User_Profile_Sections"
28871   },
28872   {
28873     "type": "get",
28874     "url": "/api/userProfile/sections/describe",
28875     "title": "Gets table info about User Profile Sections",
28876     "examples": [
28877       {
28878         "title": "Example usage:",
28879         "content": "curl https://{domain}/api/userProfile/sections/describe -v -u {name}:{password}",
28880         "type": "json"
28881       }
28882     ],
28883     "name": "DescribeUser_Profile_Sections",
28884     "group": "User_Profile_Sections",
28885     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28886     "version": "0.0.0",
28887     "filename": "server/api/userProfileSection/index.js",
28888     "groupTitle": "User_Profile_Sections"
28889   },
28890   {
28891     "type": "get",
28892     "url": "/api/userProfile/sections",
28893     "title": "Gets a list of User Profile Sections",
28894     "examples": [
28895       {
28896         "title": "Example usage:",
28897         "content": "curl https://{domain}/api/userProfile/sections -v -u {name}:{password}",
28898         "type": "json"
28899       }
28900     ],
28901     "name": "GetUser_Profile_Sections",
28902     "group": "User_Profile_Sections",
28903     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
28904     "version": "0.0.0",
28905     "filename": "server/api/userProfileSection/index.js",
28906     "groupTitle": "User_Profile_Sections"
28907   },
28908   {
28909     "type": "get",
28910     "url": "/api/userProfile/sections/{id}",
28911     "title": "Gets a single User Profile Section",
28912     "examples": [
28913       {
28914         "title": "Example usage:",
28915         "content": "curl https://{domain}/api/userProfile/sections/{id} -v -u {name}:{password}",
28916         "type": "json"
28917       }
28918     ],
28919     "name": "ShowUser_Profile_Sections",
28920     "group": "User_Profile_Sections",
28921     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28922     "version": "0.0.0",
28923     "filename": "server/api/userProfileSection/index.js",
28924     "groupTitle": "User_Profile_Sections"
28925   },
28926   {
28927     "type": "put",
28928     "url": "/api/userProfile/sections/{id}",
28929     "title": "Update an existing User Profile Section",
28930     "examples": [
28931       {
28932         "title": "Example usage:",
28933         "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",
28934         "type": "json"
28935       }
28936     ],
28937     "name": "updateUser_Profile_Sections",
28938     "group": "User_Profile_Sections",
28939     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28940     "version": "0.0.0",
28941     "filename": "server/api/userProfileSection/index.js",
28942     "groupTitle": "User_Profile_Sections"
28943   },
28944   {
28945     "type": "post",
28946     "url": "/api/userProfiles/{id}/resources",
28947     "title": "Add resources' permissions to User Profile",
28948     "examples": [
28949       {
28950         "title": "Example usage:",
28951         "content": "curl https://{domain}/api/userProfiles/{id}/resources -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
28952         "type": "json"
28953       }
28954     ],
28955     "name": "AddResources",
28956     "group": "User_Profiles",
28957     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28958     "version": "0.0.0",
28959     "filename": "server/api/userProfile/index.js",
28960     "groupTitle": "User_Profiles"
28961   },
28962   {
28963     "type": "post",
28964     "url": "/api/userProfiles/{id}/sections",
28965     "title": "Add sections' permissions to User Profile",
28966     "examples": [
28967       {
28968         "title": "Example usage:",
28969         "content": "curl https://{domain}/api/userProfiles/{id}/sections -d '[{\"sectionId\": \"name\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
28970         "type": "json"
28971       }
28972     ],
28973     "name": "AddSections",
28974     "group": "User_Profiles",
28975     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28976     "version": "0.0.0",
28977     "filename": "server/api/userProfile/index.js",
28978     "groupTitle": "User_Profiles"
28979   },
28980   {
28981     "type": "post",
28982     "url": "/api/userProfiles/clone",
28983     "title": "Clone an existing User Profile",
28984     "examples": [
28985       {
28986         "title": "Example usage:",
28987         "content": "curl https://{domain}/api/userProfiles/clone -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
28988         "type": "json"
28989       }
28990     ],
28991     "name": "CloneUser_Profiles",
28992     "group": "User_Profiles",
28993     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28994     "version": "0.0.0",
28995     "filename": "server/api/userProfile/index.js",
28996     "groupTitle": "User_Profiles"
28997   },
28998   {
28999     "type": "post",
29000     "url": "/api/userProfiles",
29001     "title": "Creates a new User Profile",
29002     "examples": [
29003       {
29004         "title": "Example usage:",
29005         "content": "curl https://{domain}/api/userProfiles -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
29006         "type": "json"
29007       }
29008     ],
29009     "name": "CreateUser_Profiles",
29010     "group": "User_Profiles",
29011     "parameter": {
29012       "fields": {
29013         "Body": [
29014           {
29015             "group": "Body",
29016             "type": "String",
29017             "optional": false,
29018             "field": "name",
29019             "description": ""
29020           },
29021           {
29022             "group": "Body",
29023             "type": "String",
29024             "optional": false,
29025             "field": "crudPermissions",
29026             "description": ""
29027           },
29028           {
29029             "group": "Body",
29030             "type": "String",
29031             "optional": true,
29032             "field": "description",
29033             "description": ""
29034           },
29035           {
29036             "group": "Body",
29037             "type": "Boolean",
29038             "optional": true,
29039             "field": "privacyEnabled",
29040             "description": ""
29041           },
29042           {
29043             "group": "Body",
29044             "type": "Boolean",
29045             "optional": true,
29046             "field": "downloadAttachments",
29047             "description": ""
29048           },
29049           {
29050             "group": "Body",
29051             "type": "Boolean",
29052             "optional": true,
29053             "field": "downloadCallySquareRecordings",
29054             "description": ""
29055           },
29056           {
29057             "group": "Body",
29058             "type": "Boolean",
29059             "optional": true,
29060             "field": "downloadContactManagerLists",
29061             "description": ""
29062           },
29063           {
29064             "group": "Body",
29065             "type": "Boolean",
29066             "optional": true,
29067             "field": "downloadJscriptySessions",
29068             "description": ""
29069           },
29070           {
29071             "group": "Body",
29072             "type": "Boolean",
29073             "optional": true,
29074             "field": "downloadOmnichannelInteractions",
29075             "description": ""
29076           },
29077           {
29078             "group": "Body",
29079             "type": "Boolean",
29080             "optional": true,
29081             "field": "downloadScreenRecordings",
29082             "description": ""
29083           },
29084           {
29085             "group": "Body",
29086             "type": "Boolean",
29087             "optional": true,
29088             "field": "downloadVoiceRecordings",
29089             "description": ""
29090           }
29091         ]
29092       }
29093     },
29094     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29095     "version": "0.0.0",
29096     "filename": "server/api/userProfile/index.js",
29097     "groupTitle": "User_Profiles"
29098   },
29099   {
29100     "type": "delete",
29101     "url": "/api/userProfiles/{id}",
29102     "title": "Deletes a User Profile",
29103     "examples": [
29104       {
29105         "title": "Example usage:",
29106         "content": "curl https://{domain}/api/userProfiles/{id} -v -u {name}:{password} -X DELETE",
29107         "type": "json"
29108       }
29109     ],
29110     "name": "DeleteUser_Profiles",
29111     "group": "User_Profiles",
29112     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29113     "version": "0.0.0",
29114     "filename": "server/api/userProfile/index.js",
29115     "groupTitle": "User_Profiles"
29116   },
29117   {
29118     "type": "get",
29119     "url": "/api/userProfiles/describe",
29120     "title": "Gets table info about User Profiles",
29121     "examples": [
29122       {
29123         "title": "Example usage:",
29124         "content": "curl https://{domain}/api/userProfiles/describe -v -u {name}:{password}",
29125         "type": "json"
29126       }
29127     ],
29128     "name": "DescribeUser_Profiles",
29129     "group": "User_Profiles",
29130     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29131     "version": "0.0.0",
29132     "filename": "server/api/userProfile/index.js",
29133     "groupTitle": "User_Profiles"
29134   },
29135   {
29136     "type": "get",
29137     "url": "/api/userProfiles/{id}/resources?section={section}",
29138     "title": "Get Resources assigned to a Section",
29139     "examples": [
29140       {
29141         "title": "Example usage:",
29142         "content": "curl https://{domain}/api/userProfiles/{id}/resources?section={section} -v -u {name}:{password} -X GET",
29143         "type": "json"
29144       }
29145     ],
29146     "name": "GetResources",
29147     "group": "User_Profiles",
29148     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29149     "version": "0.0.0",
29150     "filename": "server/api/userProfile/index.js",
29151     "groupTitle": "User_Profiles"
29152   },
29153   {
29154     "type": "get",
29155     "url": "/api/userProfiles/{id}/sections",
29156     "title": "Get sections associated to a User Profile",
29157     "examples": [
29158       {
29159         "title": "Example usage:",
29160         "content": "curl https://{domain}/api/userProfiles/{id}/sections -v -u {name}:{password} -X GET",
29161         "type": "json"
29162       }
29163     ],
29164     "name": "GetSections",
29165     "group": "User_Profiles",
29166     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29167     "version": "0.0.0",
29168     "filename": "server/api/userProfile/index.js",
29169     "groupTitle": "User_Profiles"
29170   },
29171   {
29172     "type": "get",
29173     "url": "/api/userProfiles",
29174     "title": "Gets a list of User Profiles",
29175     "examples": [
29176       {
29177         "title": "Example usage:",
29178         "content": "curl https://{domain}/api/userProfiles -v -u {name}:{password}",
29179         "type": "json"
29180       }
29181     ],
29182     "name": "GetUser_Profiles",
29183     "group": "User_Profiles",
29184     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
29185     "version": "0.0.0",
29186     "filename": "server/api/userProfile/index.js",
29187     "groupTitle": "User_Profiles"
29188   },
29189   {
29190     "type": "delete",
29191     "url": "/api/userProfiles/{id}/resources",
29192     "title": "Removes resources' permissions from User Profile",
29193     "examples": [
29194       {
29195         "title": "Example usage:",
29196         "content": "curl https://{domain}/api/userProfiles/{id}/resources?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29197         "type": "json"
29198       }
29199     ],
29200     "name": "RemoveResources",
29201     "group": "User_Profiles",
29202     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29203     "version": "0.0.0",
29204     "filename": "server/api/userProfile/index.js",
29205     "groupTitle": "User_Profiles"
29206   },
29207   {
29208     "type": "delete",
29209     "url": "/api/userProfiles/{id}/sections",
29210     "title": "Removes sections' permissions from User Profile",
29211     "examples": [
29212       {
29213         "title": "Example usage:",
29214         "content": "curl https://{domain}/api/userProfiles/{id}/sections?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29215         "type": "json"
29216       }
29217     ],
29218     "name": "RemoveSections",
29219     "group": "User_Profiles",
29220     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29221     "version": "0.0.0",
29222     "filename": "server/api/userProfile/index.js",
29223     "groupTitle": "User_Profiles"
29224   },
29225   {
29226     "type": "get",
29227     "url": "/api/userProfiles/{id}",
29228     "title": "Gets a single User Profile",
29229     "examples": [
29230       {
29231         "title": "Example usage:",
29232         "content": "curl https://{domain}/api/userProfiles/{id} -v -u {name}:{password}",
29233         "type": "json"
29234       }
29235     ],
29236     "name": "ShowUser_Profiles",
29237     "group": "User_Profiles",
29238     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29239     "version": "0.0.0",
29240     "filename": "server/api/userProfile/index.js",
29241     "groupTitle": "User_Profiles"
29242   },
29243   {
29244     "type": "put",
29245     "url": "/api/userProfiles/{id}",
29246     "title": "Update an existing User Profile",
29247     "examples": [
29248       {
29249         "title": "Example usage:",
29250         "content": "curl https://{domain}/api/userProfiles/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
29251         "type": "json"
29252       }
29253     ],
29254     "name": "updateUser_Profiles",
29255     "group": "User_Profiles",
29256     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29257     "version": "0.0.0",
29258     "filename": "server/api/userProfile/index.js",
29259     "groupTitle": "User_Profiles"
29260   },
29261   {
29262     "type": "put",
29263     "url": "/api/user-settings/{id}",
29264     "title": "Update an existing User Setting",
29265     "examples": [
29266       {
29267         "title": "Example usage:",
29268         "content": "curl https://{domain}/api/user-settings/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
29269         "type": "json"
29270       }
29271     ],
29272     "name": "updateUserSettings",
29273     "group": "User_Settings",
29274     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29275     "version": "0.0.0",
29276     "filename": "server/api/user-setting/index.js",
29277     "groupTitle": "User_Settings"
29278   },
29279   {
29280     "type": "post",
29281     "url": "/api/users/{id}/chat_interactions",
29282     "title": "Add chat interaction tabs to an agent",
29283     "examples": [
29284       {
29285         "title": "Example usage:",
29286         "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",
29287         "type": "json"
29288       }
29289     ],
29290     "name": "AddChatInteractions",
29291     "group": "Users",
29292     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29293     "version": "0.0.0",
29294     "filename": "server/api/user/index.js",
29295     "groupTitle": "Users"
29296   },
29297   {
29298     "type": "post",
29299     "url": "/api/users/{id}/chat_websites",
29300     "title": "Add a Chat Website to a user",
29301     "examples": [
29302       {
29303         "title": "Example usage:",
29304         "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",
29305         "type": "json"
29306       }
29307     ],
29308     "name": "AddChatWebsites",
29309     "group": "Users",
29310     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29311     "version": "0.0.0",
29312     "filename": "server/api/user/index.js",
29313     "groupTitle": "Users"
29314   },
29315   {
29316     "type": "post",
29317     "url": "/api/users/{id}/contacts",
29318     "title": "Add contacts to a user",
29319     "examples": [
29320       {
29321         "title": "Example usage:",
29322         "content": "curl https://{domain}/api/users/{id}/contacts -d '{\"ids\": [1,2]}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
29323         "type": "json"
29324       }
29325     ],
29326     "name": "AddContacts",
29327     "group": "Users",
29328     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29329     "version": "0.0.0",
29330     "filename": "server/api/user/index.js",
29331     "groupTitle": "Users"
29332   },
29333   {
29334     "type": "post",
29335     "url": "/api/users/{id}/fax_accounts",
29336     "title": "Add a Fax Account to a user",
29337     "examples": [
29338       {
29339         "title": "Example usage:",
29340         "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",
29341         "type": "json"
29342       }
29343     ],
29344     "name": "AddFaxAccounts",
29345     "group": "Users",
29346     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29347     "version": "0.0.0",
29348     "filename": "server/api/user/index.js",
29349     "groupTitle": "Users"
29350   },
29351   {
29352     "type": "post",
29353     "url": "/api/users/{id}/fax_interactions",
29354     "title": "Add fax interaction tabs to an agent",
29355     "examples": [
29356       {
29357         "title": "Example usage:",
29358         "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",
29359         "type": "json"
29360       }
29361     ],
29362     "name": "AddFaxInteractions",
29363     "group": "Users",
29364     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29365     "version": "0.0.0",
29366     "filename": "server/api/user/index.js",
29367     "groupTitle": "Users"
29368   },
29369   {
29370     "type": "post",
29371     "url": "/api/users/{id}/mail_accounts",
29372     "title": "Add a Mail Account to a user",
29373     "examples": [
29374       {
29375         "title": "Example usage:",
29376         "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",
29377         "type": "json"
29378       }
29379     ],
29380     "name": "AddMailAccounts",
29381     "group": "Users",
29382     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29383     "version": "0.0.0",
29384     "filename": "server/api/user/index.js",
29385     "groupTitle": "Users"
29386   },
29387   {
29388     "type": "post",
29389     "url": "/api/users/{id}/mail_interactions",
29390     "title": "Add mail interaction tabs to an agent",
29391     "examples": [
29392       {
29393         "title": "Example usage:",
29394         "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",
29395         "type": "json"
29396       }
29397     ],
29398     "name": "AddMailInteractions",
29399     "group": "Users",
29400     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29401     "version": "0.0.0",
29402     "filename": "server/api/user/index.js",
29403     "groupTitle": "Users"
29404   },
29405   {
29406     "type": "post",
29407     "url": "/api/users/{id}/openchannel_accounts",
29408     "title": "Add a Open Channel Account to a user",
29409     "examples": [
29410       {
29411         "title": "Example usage:",
29412         "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",
29413         "type": "json"
29414       }
29415     ],
29416     "name": "AddOpenchannelAccounts",
29417     "group": "Users",
29418     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29419     "version": "0.0.0",
29420     "filename": "server/api/user/index.js",
29421     "groupTitle": "Users"
29422   },
29423   {
29424     "type": "post",
29425     "url": "/api/users/{id}/openchannel_interactions",
29426     "title": "Add openchannel interaction tabs to an agent",
29427     "examples": [
29428       {
29429         "title": "Example usage:",
29430         "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",
29431         "type": "json"
29432       }
29433     ],
29434     "name": "AddOpenchannelInteractions",
29435     "group": "Users",
29436     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29437     "version": "0.0.0",
29438     "filename": "server/api/user/index.js",
29439     "groupTitle": "Users"
29440   },
29441   {
29442     "type": "post",
29443     "url": "/api/users/{id}/queues",
29444     "title": "Add queues to an agent",
29445     "examples": [
29446       {
29447         "title": "Example usage:",
29448         "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",
29449         "type": "json"
29450       }
29451     ],
29452     "name": "AddQueues",
29453     "group": "Users",
29454     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29455     "version": "0.0.0",
29456     "filename": "server/api/user/index.js",
29457     "groupTitle": "Users"
29458   },
29459   {
29460     "type": "post",
29461     "url": "/api/users/{id}/sms_accounts",
29462     "title": "Add a Sms Account to a user",
29463     "examples": [
29464       {
29465         "title": "Example usage:",
29466         "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",
29467         "type": "json"
29468       }
29469     ],
29470     "name": "AddSmsAccounts",
29471     "group": "Users",
29472     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29473     "version": "0.0.0",
29474     "filename": "server/api/user/index.js",
29475     "groupTitle": "Users"
29476   },
29477   {
29478     "type": "post",
29479     "url": "/api/users/{id}/sms_interactions",
29480     "title": "Add sms interaction tabs to an agent",
29481     "examples": [
29482       {
29483         "title": "Example usage:",
29484         "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",
29485         "type": "json"
29486       }
29487     ],
29488     "name": "AddSmsInteractions",
29489     "group": "Users",
29490     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29491     "version": "0.0.0",
29492     "filename": "server/api/user/index.js",
29493     "groupTitle": "Users"
29494   },
29495   {
29496     "type": "post",
29497     "url": "/api/users/{id}/teams",
29498     "title": "Add teams to an agent",
29499     "examples": [
29500       {
29501         "title": "Example usage:",
29502         "content": "curl https://{domain}/api/users/{id}/teams -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
29503         "type": "json"
29504       }
29505     ],
29506     "name": "AddTeams",
29507     "group": "Users",
29508     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29509     "version": "0.0.0",
29510     "filename": "server/api/user/index.js",
29511     "groupTitle": "Users"
29512   },
29513   {
29514     "type": "post",
29515     "url": "/api/users/{id}/whatsapp_accounts",
29516     "title": "Add a Whatsapp Account to a user",
29517     "examples": [
29518       {
29519         "title": "Example usage:",
29520         "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",
29521         "type": "json"
29522       }
29523     ],
29524     "name": "AddWhatsappAccounts",
29525     "group": "Users",
29526     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29527     "version": "0.0.0",
29528     "filename": "server/api/user/index.js",
29529     "groupTitle": "Users"
29530   },
29531   {
29532     "type": "post",
29533     "url": "/api/users/{id}/whatsapp_interactions",
29534     "title": "Add Whatsapp interaction tabs to an agent",
29535     "examples": [
29536       {
29537         "title": "Example usage:",
29538         "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",
29539         "type": "json"
29540       }
29541     ],
29542     "name": "AddWhatsappInteractions",
29543     "group": "Users",
29544     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29545     "version": "0.0.0",
29546     "filename": "server/api/user/index.js",
29547     "groupTitle": "Users"
29548   },
29549   {
29550     "type": "put",
29551     "url": "/api/users/{id}/password",
29552     "title": "Change user password",
29553     "examples": [
29554       {
29555         "title": "Example usage:",
29556         "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",
29557         "type": "json"
29558       }
29559     ],
29560     "name": "ChangePwd",
29561     "group": "Users",
29562     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29563     "version": "0.0.0",
29564     "filename": "server/api/user/index.js",
29565     "groupTitle": "Users"
29566   },
29567   {
29568     "type": "post",
29569     "url": "/api/users",
29570     "title": "Create a new user",
29571     "examples": [
29572       {
29573         "title": "Example usage:",
29574         "content": "curl https://{domain}/api/users -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
29575         "type": "json"
29576       }
29577     ],
29578     "name": "Create",
29579     "group": "Users",
29580     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29581     "version": "0.0.0",
29582     "filename": "server/api/user/index.js",
29583     "groupTitle": "Users"
29584   },
29585   {
29586     "type": "post",
29587     "url": "/api/users/{id}/api_key",
29588     "title": "Create a new API access key for the user",
29589     "examples": [
29590       {
29591         "title": "Example usage:",
29592         "content": "curl https://{domain}/api/users/:id/api_key -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
29593         "type": "json"
29594       }
29595     ],
29596     "name": "CreateApiKey",
29597     "group": "Users",
29598     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29599     "version": "0.0.0",
29600     "filename": "server/api/user/index.js",
29601     "groupTitle": "Users"
29602   },
29603   {
29604     "type": "delete",
29605     "url": "/api/users/{id}",
29606     "title": "Deletes a user",
29607     "examples": [
29608       {
29609         "title": "Example usage:",
29610         "content": "curl https://{domain}/api/users/{id} -v -u {name}:{password} -X DELETE",
29611         "type": "json"
29612       }
29613     ],
29614     "name": "Delete",
29615     "group": "Users",
29616     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29617     "version": "0.0.0",
29618     "filename": "server/api/user/index.js",
29619     "groupTitle": "Users"
29620   },
29621   {
29622     "type": "get",
29623     "url": "/api/users/describe",
29624     "title": "Gets table info about Users",
29625     "examples": [
29626       {
29627         "title": "Example usage:",
29628         "content": "curl https://{domain}/api/users/describe -v -u {name}:{password}",
29629         "type": "json"
29630       }
29631     ],
29632     "name": "DescribeUsers",
29633     "group": "Users",
29634     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29635     "version": "0.0.0",
29636     "filename": "server/api/user/index.js",
29637     "groupTitle": "Users"
29638   },
29639   {
29640     "type": "get",
29641     "url": "/api/users/{id}/agents",
29642     "title": "GetAgents",
29643     "examples": [
29644       {
29645         "title": "Example usage:",
29646         "content": "curl https://{domain}/api/users/{id}/agents -v -u {name}:{password} -X GET",
29647         "type": "json"
29648       }
29649     ],
29650     "name": "GetAgents",
29651     "group": "Users",
29652     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29653     "version": "0.0.0",
29654     "filename": "server/api/user/index.js",
29655     "groupTitle": "Users"
29656   },
29657   {
29658     "type": "get",
29659     "url": "/api/users/{id}/api_key",
29660     "title": "Get the API access key for the user",
29661     "examples": [
29662       {
29663         "title": "Example usage:",
29664         "content": "curl https://{domain}/api/users/:id/api_key -v -u {name}:{password} -X GET",
29665         "type": "json"
29666       }
29667     ],
29668     "name": "GetApiKey",
29669     "group": "Users",
29670     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29671     "version": "0.0.0",
29672     "filename": "server/api/user/index.js",
29673     "groupTitle": "Users"
29674   },
29675   {
29676     "type": "get",
29677     "url": "/api/users/{id}/groups",
29678     "title": "GetChatGroups",
29679     "examples": [
29680       {
29681         "title": "Example usage:",
29682         "content": "curl https://{domain}/api/users/{id}/groups -v -u {name}:{password} -X GET",
29683         "type": "json"
29684       }
29685     ],
29686     "name": "GetChatGroups",
29687     "group": "Users",
29688     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29689     "version": "0.0.0",
29690     "filename": "server/api/user/index.js",
29691     "groupTitle": "Users"
29692   },
29693   {
29694     "type": "get",
29695     "url": "/api/users/{id}/chat/interactions",
29696     "title": "GetChatInteractions",
29697     "examples": [
29698       {
29699         "title": "Example usage:",
29700         "content": "curl https://{domain}/api/users/{id}/chat/interactions -v -u {name}:{password} -X GET",
29701         "type": "json"
29702       }
29703     ],
29704     "name": "GetChatInteractions",
29705     "group": "Users",
29706     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29707     "version": "0.0.0",
29708     "filename": "server/api/user/index.js",
29709     "groupTitle": "Users"
29710   },
29711   {
29712     "type": "get",
29713     "url": "/api/users/{id}/chat_websites",
29714     "title": "GetChatWebsites",
29715     "examples": [
29716       {
29717         "title": "Example usage:",
29718         "content": "curl https://{domain}/api/users/{id}/chat_websites -v -u {name}:{password} -X GET",
29719         "type": "json"
29720       }
29721     ],
29722     "name": "GetChatWebsites",
29723     "group": "Users",
29724     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29725     "version": "0.0.0",
29726     "filename": "server/api/user/index.js",
29727     "groupTitle": "Users"
29728   },
29729   {
29730     "type": "get",
29731     "url": "/api/users/{id}/contacts",
29732     "title": "GetContacts",
29733     "examples": [
29734       {
29735         "title": "Example usage:",
29736         "content": "curl https://{domain}/api/users/{id}/contacts -v -u {name}:{password} -X GET",
29737         "type": "json"
29738       }
29739     ],
29740     "name": "GetContacts",
29741     "group": "Users",
29742     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29743     "version": "0.0.0",
29744     "filename": "server/api/user/index.js",
29745     "groupTitle": "Users"
29746   },
29747   {
29748     "type": "get",
29749     "url": "/api/users/{id}/fax_accounts",
29750     "title": "GetFaxAccounts",
29751     "examples": [
29752       {
29753         "title": "Example usage:",
29754         "content": "curl https://{domain}/api/users/{id}/fax_accounts -v -u {name}:{password} -X GET",
29755         "type": "json"
29756       }
29757     ],
29758     "name": "GetFaxAccounts",
29759     "group": "Users",
29760     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29761     "version": "0.0.0",
29762     "filename": "server/api/user/index.js",
29763     "groupTitle": "Users"
29764   },
29765   {
29766     "type": "get",
29767     "url": "/api/users/{id}/fax/interactions",
29768     "title": "GetFaxInteractions",
29769     "examples": [
29770       {
29771         "title": "Example usage:",
29772         "content": "curl https://{domain}/api/users/{id}/fax/interactions -v -u {name}:{password} -X GET",
29773         "type": "json"
29774       }
29775     ],
29776     "name": "GetFaxInteractions",
29777     "group": "Users",
29778     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29779     "version": "0.0.0",
29780     "filename": "server/api/user/index.js",
29781     "groupTitle": "Users"
29782   },
29783   {
29784     "type": "get",
29785     "url": "/api/users/{id}/lists",
29786     "title": "GetLists",
29787     "examples": [
29788       {
29789         "title": "Example usage:",
29790         "content": "curl https://{domain}/api/users/{id}/lists -v -u {name}:{password} -X GET",
29791         "type": "json"
29792       }
29793     ],
29794     "name": "GetLists",
29795     "group": "Users",
29796     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29797     "version": "0.0.0",
29798     "filename": "server/api/user/index.js",
29799     "groupTitle": "Users"
29800   },
29801   {
29802     "type": "get",
29803     "url": "/api/users/{id}/mail_accounts",
29804     "title": "GetMailAccounts",
29805     "examples": [
29806       {
29807         "title": "Example usage:",
29808         "content": "curl https://{domain}/api/users/{id}/mail_accounts -v -u {name}:{password} -X GET",
29809         "type": "json"
29810       }
29811     ],
29812     "name": "GetMailAccounts",
29813     "group": "Users",
29814     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29815     "version": "0.0.0",
29816     "filename": "server/api/user/index.js",
29817     "groupTitle": "Users"
29818   },
29819   {
29820     "type": "get",
29821     "url": "/api/users/{id}/mail/interactions",
29822     "title": "GetMailInteractions",
29823     "examples": [
29824       {
29825         "title": "Example usage:",
29826         "content": "curl https://{domain}/api/users/{id}/mail/interactions -v -u {name}:{password} -X GET",
29827         "type": "json"
29828       }
29829     ],
29830     "name": "GetMailInteractions",
29831     "group": "Users",
29832     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29833     "version": "0.0.0",
29834     "filename": "server/api/user/index.js",
29835     "groupTitle": "Users"
29836   },
29837   {
29838     "type": "get",
29839     "url": "/api/users/{id}/openchannel_accounts",
29840     "title": "GetOpenchannelAccounts",
29841     "examples": [
29842       {
29843         "title": "Example usage:",
29844         "content": "curl https://{domain}/api/users/{id}/openchannel_accounts -v -u {name}:{password} -X GET",
29845         "type": "json"
29846       }
29847     ],
29848     "name": "GetOpenchannelAccounts",
29849     "group": "Users",
29850     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29851     "version": "0.0.0",
29852     "filename": "server/api/user/index.js",
29853     "groupTitle": "Users"
29854   },
29855   {
29856     "type": "get",
29857     "url": "/api/users/{id}/openchannel/interactions",
29858     "title": "GetOpenchannelInteractions",
29859     "examples": [
29860       {
29861         "title": "Example usage:",
29862         "content": "curl https://{domain}/api/users/{id}/openchannel/interactions -v -u {name}:{password}",
29863         "type": "json"
29864       }
29865     ],
29866     "name": "GetOpenchannelInteractions",
29867     "group": "Users",
29868     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29869     "version": "0.0.0",
29870     "filename": "server/api/user/index.js",
29871     "groupTitle": "Users"
29872   },
29873   {
29874     "type": "get",
29875     "url": "/api/users/{id}/prefixes",
29876     "title": "GetPrefixes",
29877     "examples": [
29878       {
29879         "title": "Example usage:",
29880         "content": "curl https://{domain}/api/users/{id}/prefixes -v -u {name}:{password} -X GET",
29881         "type": "json"
29882       }
29883     ],
29884     "name": "GetPrefixes",
29885     "group": "Users",
29886     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29887     "version": "0.0.0",
29888     "filename": "server/api/user/index.js",
29889     "groupTitle": "Users"
29890   },
29891   {
29892     "type": "get",
29893     "url": "/api/users/{id}/queues?channel={channel}",
29894     "title": "Gets Queues list",
29895     "examples": [
29896       {
29897         "title": "Example usage:",
29898         "content": "curl https://{domain}/api/users/{id}/queues/?channel={channel} -v -u {name}:{password} -X GET",
29899         "type": "json"
29900       }
29901     ],
29902     "name": "GetQueues",
29903     "group": "Users",
29904     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29905     "version": "0.0.0",
29906     "filename": "server/api/user/index.js",
29907     "groupTitle": "Users"
29908   },
29909   {
29910     "type": "get",
29911     "url": "/api/users/{id}/recordings",
29912     "title": "GetRecordings",
29913     "examples": [
29914       {
29915         "title": "Example usage:",
29916         "content": "curl https://{domain}/api/users/{id}/recordings -v -u {name}:{password} -X GET",
29917         "type": "json"
29918       }
29919     ],
29920     "name": "GetRecordings",
29921     "group": "Users",
29922     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29923     "version": "0.0.0",
29924     "filename": "server/api/user/index.js",
29925     "groupTitle": "Users"
29926   },
29927   {
29928     "type": "get",
29929     "url": "/api/users/{id}/scheduled_calls",
29930     "title": "GetScheduledCalls",
29931     "examples": [
29932       {
29933         "title": "Example usage:",
29934         "content": "curl https://{domain}/api/users/{id}/scheduled_calls -v -u {name}:{password} -X GET",
29935         "type": "json"
29936       }
29937     ],
29938     "name": "GetScheduledCalls",
29939     "group": "Users",
29940     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29941     "version": "0.0.0",
29942     "filename": "server/api/user/index.js",
29943     "groupTitle": "Users"
29944   },
29945   {
29946     "type": "get",
29947     "url": "/api/users/{id}/screen_recordings",
29948     "title": "GetScreenRecordings",
29949     "examples": [
29950       {
29951         "title": "Example usage:",
29952         "content": "curl https://{domain}/api/users/{id}/screen_recordings -v -u {name}:{password} -X GET",
29953         "type": "json"
29954       }
29955     ],
29956     "name": "GetScreenRecordings",
29957     "group": "Users",
29958     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29959     "version": "0.0.0",
29960     "filename": "server/api/user/index.js",
29961     "groupTitle": "Users"
29962   },
29963   {
29964     "type": "get",
29965     "url": "/api/users/{id}/sms_accounts",
29966     "title": "GetSmsAccounts",
29967     "examples": [
29968       {
29969         "title": "Example usage:",
29970         "content": "curl https://{domain}/api/users/{id}/sms_accounts -v -u {name}:{password} -X GET",
29971         "type": "json"
29972       }
29973     ],
29974     "name": "GetSmsAccounts",
29975     "group": "Users",
29976     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29977     "version": "0.0.0",
29978     "filename": "server/api/user/index.js",
29979     "groupTitle": "Users"
29980   },
29981   {
29982     "type": "get",
29983     "url": "/api/users/{id}/sms/interactions",
29984     "title": "GetSmsInteractions",
29985     "examples": [
29986       {
29987         "title": "Example usage:",
29988         "content": "curl https://{domain}/api/users/{id}/sms/interactions -v -u {name}:{password} -X GET",
29989         "type": "json"
29990       }
29991     ],
29992     "name": "GetSmsInteractions",
29993     "group": "Users",
29994     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29995     "version": "0.0.0",
29996     "filename": "server/api/user/index.js",
29997     "groupTitle": "Users"
29998   },
29999   {
30000     "type": "get",
30001     "url": "/api/users/{id}/teams",
30002     "title": "GetTeams",
30003     "examples": [
30004       {
30005         "title": "Example usage:",
30006         "content": "curl https://{domain}/api/users/{id}/teams -v -u {name}:{password} -X GET",
30007         "type": "json"
30008       }
30009     ],
30010     "name": "GetTeams",
30011     "group": "Users",
30012     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30013     "version": "0.0.0",
30014     "filename": "server/api/user/index.js",
30015     "groupTitle": "Users"
30016   },
30017   {
30018     "type": "get",
30019     "url": "/api/users",
30020     "title": "Gets a list of Users",
30021     "examples": [
30022       {
30023         "title": "Example usage:",
30024         "content": "curl https://{domain}/api/users -v -u {name}:{password}",
30025         "type": "json"
30026       }
30027     ],
30028     "name": "GetUsers",
30029     "group": "Users",
30030     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
30031     "version": "0.0.0",
30032     "filename": "server/api/user/index.js",
30033     "groupTitle": "Users"
30034   },
30035   {
30036     "type": "get",
30037     "url": "/api/users/{id}/queues_rt",
30038     "title": "GetVoiceQueuesRt",
30039     "examples": [
30040       {
30041         "title": "Example usage:",
30042         "content": "curl https://{domain}/api/users/{id}/queues_rt -v -u {name}:{password} -X GET",
30043         "type": "json"
30044       }
30045     ],
30046     "name": "GetVoiceQueuesRt",
30047     "group": "Users",
30048     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30049     "version": "0.0.0",
30050     "filename": "server/api/user/index.js",
30051     "groupTitle": "Users"
30052   },
30053   {
30054     "type": "get",
30055     "url": "/api/users/{id}/whatsapp_accounts",
30056     "title": "GetWhatsappAccounts",
30057     "examples": [
30058       {
30059         "title": "Example usage:",
30060         "content": "curl https://{domain}/api/users/{id}/whatsapp_accounts -v -u {name}:{password} -X GET",
30061         "type": "json"
30062       }
30063     ],
30064     "name": "GetWhatsappAccounts",
30065     "group": "Users",
30066     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30067     "version": "0.0.0",
30068     "filename": "server/api/user/index.js",
30069     "groupTitle": "Users"
30070   },
30071   {
30072     "type": "get",
30073     "url": "/api/users/{id}/whatsapp/interactions",
30074     "title": "GetWhatsappInteractions",
30075     "examples": [
30076       {
30077         "title": "Example usage:",
30078         "content": "curl https://{domain}/api/users/{id}/whatsapp/interactions -v -u {name}:{password} -X GET",
30079         "type": "json"
30080       }
30081     ],
30082     "name": "GetWhatsappInteractions",
30083     "group": "Users",
30084     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30085     "version": "0.0.0",
30086     "filename": "server/api/user/index.js",
30087     "groupTitle": "Users"
30088   },
30089   {
30090     "type": "post",
30091     "url": "/api/users/{id}/login",
30092     "title": "Login",
30093     "examples": [
30094       {
30095         "title": "Example usage:",
30096         "content": "curl https://{domain}/api/users/{id}/login  -v -u {name}:{password} -X POST",
30097         "type": "json"
30098       }
30099     ],
30100     "name": "Login",
30101     "group": "Users",
30102     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30103     "version": "0.0.0",
30104     "filename": "server/api/user/index.js",
30105     "groupTitle": "Users"
30106   },
30107   {
30108     "type": "post",
30109     "url": "/api/users/{id}/logout",
30110     "title": "Logout",
30111     "examples": [
30112       {
30113         "title": "Example usage:",
30114         "content": "curl https://{domain}/api/users/{id}/logout -v -u {name}:{password} -X POST",
30115         "type": "json"
30116       }
30117     ],
30118     "name": "Logout",
30119     "group": "Users",
30120     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30121     "version": "0.0.0",
30122     "filename": "server/api/user/index.js",
30123     "groupTitle": "Users"
30124   },
30125   {
30126     "type": "post",
30127     "url": "/api/users/{id}/pause",
30128     "title": "Pause",
30129     "examples": [
30130       {
30131         "title": "Example usage:",
30132         "content": "curl https://{domain}/api/users/{id}/pause -v -u {name}:{password} -X POST",
30133         "type": "json"
30134       }
30135     ],
30136     "name": "Pause",
30137     "group": "Users",
30138     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30139     "version": "0.0.0",
30140     "filename": "server/api/user/index.js",
30141     "groupTitle": "Users"
30142   },
30143   {
30144     "type": "delete",
30145     "url": "/api/users/{id}/api_key",
30146     "title": "Remove API access key for the user",
30147     "examples": [
30148       {
30149         "title": "Example usage:",
30150         "content": "curl https://{domain}/api/users/:id/api_key -v -u {name}:{password} -X DELETE",
30151         "type": "json"
30152       }
30153     ],
30154     "name": "RemoveApiKey",
30155     "group": "Users",
30156     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30157     "version": "0.0.0",
30158     "filename": "server/api/user/index.js",
30159     "groupTitle": "Users"
30160   },
30161   {
30162     "type": "delete",
30163     "url": "/api/users/{id}/chat_interactions",
30164     "title": "Removes interactions from an agent",
30165     "examples": [
30166       {
30167         "title": "Example usage:",
30168         "content": "curl https://{domain}/api/users/{id}/chat_interactions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
30169         "type": "json"
30170       }
30171     ],
30172     "name": "RemoveChatInteractions",
30173     "group": "Users",
30174     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30175     "version": "0.0.0",
30176     "filename": "server/api/user/index.js",
30177     "groupTitle": "Users"
30178   },
30179   {
30180     "type": "delete",
30181     "url": "/api/users/{id}/chat_websites",
30182     "title": "Removes a Chat Website from a user",
30183     "examples": [
30184       {
30185         "title": "Example usage:",
30186         "content": "curl https://{domain}/api/users/{id}/chat_websites?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
30187         "type": "json"
30188       }
30189     ],
30190     "name": "RemoveChatWebsites",
30191     "group": "Users",
30192     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30193     "version": "0.0.0",
30194     "filename": "server/api/user/index.js",
30195     "groupTitle": "Users"
30196   },
30197   {
30198     "type": "delete",
30199     "url": "/api/users/{id}/fax_accounts",
30200     "title": "Removes a Fax Account from a user",
30201     "examples": [
30202       {
30203         "title": "Example usage:",
30204         "content": "curl https://{domain}/api/users/{id}/fax_accounts?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
30205         "type": "json"
30206       }
30207     ],
30208     "name": "RemoveFaxAccounts",
30209     "group": "Users",
30210     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30211     "version": "0.0.0",
30212     "filename": "server/api/user/index.js",
30213     "groupTitle": "Users"
30214   },
30215   {
30216     "type": "delete",
30217     "url": "/api/users/{id}/fax_interactions",
30218     "title": "Removes interactions from an agent",
30219     "examples": [
30220       {
30221         "title": "Example usage:",
30222         "content": "curl https://{domain}/api/users/{id}/fax_interactions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
30223         "type": "json"
30224       }
30225     ],
30226     "name": "RemoveFaxInteractions",
30227     "group": "Users",
30228     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30229     "version": "0.0.0",
30230     "filename": "server/api/user/index.js",
30231     "groupTitle": "Users"
30232   },
30233   {
30234     "type": "delete",
30235     "url": "/api/users/{id}/mail_accounts",
30236     "title": "Removes a Mail Account from a user",
30237     "examples": [
30238       {
30239         "title": "Example usage:",
30240         "content": "curl https://{domain}/api/users/{id}/mail_accounts?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
30241         "type": "json"
30242       }
30243     ],
30244     "name": "RemoveMailAccounts",
30245     "group": "Users",
30246     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30247     "version": "0.0.0",
30248     "filename": "server/api/user/index.js",
30249     "groupTitle": "Users"
30250   },
30251   {
30252     "type": "delete",
30253     "url": "/api/users/{id}/mail_interactions",
30254     "title": "Removes interactions from an agent",
30255     "examples": [
30256       {
30257         "title": "Example usage:",
30258         "content": "curl https://{domain}/api/users/{id}/mail_interactions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
30259         "type": "json"
30260       }
30261     ],
30262     "name": "RemoveMailInteractions",
30263     "group": "Users",
30264     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30265     "version": "0.0.0",
30266     "filename": "server/api/user/index.js",
30267     "groupTitle": "Users"
30268   },
30269   {
30270     "type": "delete",
30271     "url": "/api/users/{id}/openchannel_accounts",
30272     "title": "Removes a Open Channel Account from a user",
30273     "examples": [
30274       {
30275         "title": "Example usage:",
30276         "content": "curl https://{domain}/api/users/{id}/openchannel_accounts?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
30277         "type": "json"
30278       }
30279     ],
30280     "name": "RemoveOpenchannelAccounts",
30281     "group": "Users",
30282     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30283     "version": "0.0.0",
30284     "filename": "server/api/user/index.js",
30285     "groupTitle": "Users"
30286   },
30287   {
30288     "type": "delete",
30289     "url": "/api/users/{id}/openchannel_interactions",
30290     "title": "Removes openchannel interactions from an agent",
30291     "examples": [
30292       {
30293         "title": "Example usage:",
30294         "content": "curl https://{domain}/api/users/{id}/openchannel_interactions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
30295         "type": "json"
30296       }
30297     ],
30298     "name": "RemoveOpenchannelInteractions",
30299     "group": "Users",
30300     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30301     "version": "0.0.0",
30302     "filename": "server/api/user/index.js",
30303     "groupTitle": "Users"
30304   },
30305   {
30306     "type": "delete",
30307     "url": "/api/users/{id}/queues",
30308     "title": "Remove queues to an agent",
30309     "examples": [
30310       {
30311         "title": "Example usage:",
30312         "content": "curl https://{domain}/api/users/{id}/queues?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
30313         "type": "json"
30314       }
30315     ],
30316     "name": "RemoveQueues",
30317     "group": "Users",
30318     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30319     "version": "0.0.0",
30320     "filename": "server/api/user/index.js",
30321     "groupTitle": "Users"
30322   },
30323   {
30324     "type": "delete",
30325     "url": "/api/users/{id}/sms_accounts",
30326     "title": "Removes a Sms Account from a user",
30327     "examples": [
30328       {
30329         "title": "Example usage:",
30330         "content": "curl https://{domain}/api/users/{id}/sms_accounts?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
30331         "type": "json"
30332       }
30333     ],
30334     "name": "RemoveSmsAccounts",
30335     "group": "Users",
30336     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30337     "version": "0.0.0",
30338     "filename": "server/api/user/index.js",
30339     "groupTitle": "Users"
30340   },
30341   {
30342     "type": "delete",
30343     "url": "/api/users/{id}/sms_interactions",
30344     "title": "Removes interactions from an agent",
30345     "examples": [
30346       {
30347         "title": "Example usage:",
30348         "content": "curl https://{domain}/api/users/{id}/sms_interactions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
30349         "type": "json"
30350       }
30351     ],
30352     "name": "RemoveSmsInteractions",
30353     "group": "Users",
30354     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30355     "version": "0.0.0",
30356     "filename": "server/api/user/index.js",
30357     "groupTitle": "Users"
30358   },
30359   {
30360     "type": "delete",
30361     "url": "/api/users/{id}/teams",
30362     "title": "Removes teams from an agent",
30363     "examples": [
30364       {
30365         "title": "Example usage:",
30366         "content": "curl https://{domain}/api/users/{id}/teams?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
30367         "type": "json"
30368       }
30369     ],
30370     "name": "RemoveTeams",
30371     "group": "Users",
30372     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30373     "version": "0.0.0",
30374     "filename": "server/api/user/index.js",
30375     "groupTitle": "Users"
30376   },
30377   {
30378     "type": "delete",
30379     "url": "/api/users/{id}/whatsapp_accounts",
30380     "title": "Removes a Whatsapp Account from a user",
30381     "examples": [
30382       {
30383         "title": "Example usage:",
30384         "content": "curl https://{domain}/api/users/{id}/whatsapp_accounts?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
30385         "type": "json"
30386       }
30387     ],
30388     "name": "RemoveWhatsappAccounts",
30389     "group": "Users",
30390     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30391     "version": "0.0.0",
30392     "filename": "server/api/user/index.js",
30393     "groupTitle": "Users"
30394   },
30395   {
30396     "type": "delete",
30397     "url": "/api/users/{id}/whatsapp_interactions",
30398     "title": "Removes Whatsapp interactions from an agent",
30399     "examples": [
30400       {
30401         "title": "Example usage:",
30402         "content": "curl https://{domain}/api/users/{id}/whatsapp_interactions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
30403         "type": "json"
30404       }
30405     ],
30406     "name": "RemoveWhatsappInteractions",
30407     "group": "Users",
30408     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30409     "version": "0.0.0",
30410     "filename": "server/api/user/index.js",
30411     "groupTitle": "Users"
30412   },
30413   {
30414     "type": "get",
30415     "url": "/api/users/{id}",
30416     "title": "Gets a single User",
30417     "examples": [
30418       {
30419         "title": "Example usage:",
30420         "content": "curl https://{domain}/api/users/{id} -v -u {name}:{password}",
30421         "type": "json"
30422       }
30423     ],
30424     "name": "ShowUsers",
30425     "group": "Users",
30426     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30427     "version": "0.0.0",
30428     "filename": "server/api/user/index.js",
30429     "groupTitle": "Users"
30430   },
30431   {
30432     "type": "post",
30433     "url": "/api/users/{id}/unpause",
30434     "title": "Unpause",
30435     "examples": [
30436       {
30437         "title": "Example usage:",
30438         "content": "curl https://{domain}/api/users/{id}/unpause -v -u {name}:{password} -X POST",
30439         "type": "json"
30440       }
30441     ],
30442     "name": "Unpause",
30443     "group": "Users",
30444     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30445     "version": "0.0.0",
30446     "filename": "server/api/user/index.js",
30447     "groupTitle": "Users"
30448   },
30449   {
30450     "type": "get",
30451     "url": "/api/users/whoami",
30452     "title": "WhoAmI",
30453     "examples": [
30454       {
30455         "title": "Example usage:",
30456         "content": "curl https://{domain}/api/users/whoami -v -u {name}:{password} -X GET",
30457         "type": "json"
30458       }
30459     ],
30460     "name": "WhoAmI",
30461     "group": "Users",
30462     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30463     "version": "0.0.0",
30464     "filename": "server/api/user/index.js",
30465     "groupTitle": "Users"
30466   },
30467   {
30468     "type": "post",
30469     "url": "/api/users/{id}/avatar",
30470     "title": "Add avatar",
30471     "examples": [
30472       {
30473         "title": "Example usage:",
30474         "content": "curl https://{domain}/api/users/{id}/avatar -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
30475         "type": "json"
30476       }
30477     ],
30478     "name": "addAvatar",
30479     "group": "Users",
30480     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30481     "version": "0.0.0",
30482     "filename": "server/api/user/index.js",
30483     "groupTitle": "Users"
30484   },
30485   {
30486     "type": "post",
30487     "url": "/api/users/create_many",
30488     "title": "Create Users",
30489     "examples": [
30490       {
30491         "title": "Example usage:",
30492         "content": "curl https://{domain}/api/users/create_many -d '[{\"name\": \"john.doe\", \"role\": \"user\", \"...\": \"...\"}]' -v -u {name}:{password} -X POST",
30493         "type": "json"
30494       }
30495     ],
30496     "name": "bulkCreate",
30497     "group": "Users",
30498     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30499     "version": "0.0.0",
30500     "filename": "server/api/user/index.js",
30501     "groupTitle": "Users"
30502   },
30503   {
30504     "type": "get",
30505     "url": "/api/users/{id}/avatar",
30506     "title": "Get avatar",
30507     "examples": [
30508       {
30509         "title": "Example usage:",
30510         "content": "curl https://{domain}/api/users/{id}/avatar -v -u {name}:{password} -X GET",
30511         "type": "json"
30512       }
30513     ],
30514     "name": "getAvatar",
30515     "group": "Users",
30516     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30517     "version": "0.0.0",
30518     "filename": "server/api/user/index.js",
30519     "groupTitle": "Users"
30520   },
30521   {
30522     "type": "get",
30523     "url": "/api/users/{id}/open_tabs",
30524     "title": "Get interactions opened tabs",
30525     "examples": [
30526       {
30527         "title": "Example usage:",
30528         "content": "curl https://{domain}/api/users/{id}/open_tabs -v -u {name}:{password} -X GET",
30529         "type": "json"
30530       }
30531     ],
30532     "name": "getOpenTabs",
30533     "group": "Users",
30534     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30535     "version": "0.0.0",
30536     "filename": "server/api/user/index.js",
30537     "groupTitle": "Users"
30538   },
30539   {
30540     "type": "get",
30541     "url": "/api/users/presence",
30542     "title": "Gets agent presence",
30543     "examples": [
30544       {
30545         "title": "Example usage:",
30546         "content": "curl https://{domain}/api/users/presence -v -u {name}:{password}  -X GET",
30547         "type": "json"
30548       }
30549     ],
30550     "name": "getPresence",
30551     "group": "Users",
30552     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30553     "version": "0.0.0",
30554     "filename": "server/api/user/index.js",
30555     "groupTitle": "Users"
30556   },
30557   {
30558     "type": "put",
30559     "url": "/api/users/{id}",
30560     "title": "Update an existing User",
30561     "examples": [
30562       {
30563         "title": "Example usage:",
30564         "content": "curl https://{domain}/api/users/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
30565         "type": "json"
30566       }
30567     ],
30568     "name": "updateUsers",
30569     "group": "Users",
30570     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30571     "version": "0.0.0",
30572     "filename": "server/api/user/index.js",
30573     "groupTitle": "Users"
30574   },
30575   {
30576     "type": "post",
30577     "url": "/api/variables",
30578     "title": "Creates a new Variable",
30579     "examples": [
30580       {
30581         "title": "Example usage:",
30582         "content": "curl https://{domain}/api/variables -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
30583         "type": "json"
30584       }
30585     ],
30586     "name": "CreateVariables",
30587     "group": "Variables",
30588     "parameter": {
30589       "fields": {
30590         "Body": [
30591           {
30592             "group": "Body",
30593             "type": "String",
30594             "optional": false,
30595             "field": "name",
30596             "description": ""
30597           },
30598           {
30599             "group": "Body",
30600             "type": "String",
30601             "optional": true,
30602             "field": "description",
30603             "description": ""
30604           }
30605         ]
30606       }
30607     },
30608     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30609     "version": "0.0.0",
30610     "filename": "server/api/variable/index.js",
30611     "groupTitle": "Variables"
30612   },
30613   {
30614     "type": "delete",
30615     "url": "/api/variables/{id}",
30616     "title": "Deletes a Variable",
30617     "examples": [
30618       {
30619         "title": "Example usage:",
30620         "content": "curl https://{domain}/api/variables/{id} -v -u {name}:{password} -X DELETE",
30621         "type": "json"
30622       }
30623     ],
30624     "name": "DeleteVariables",
30625     "group": "Variables",
30626     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30627     "version": "0.0.0",
30628     "filename": "server/api/variable/index.js",
30629     "groupTitle": "Variables"
30630   },
30631   {
30632     "type": "get",
30633     "url": "/api/variables",
30634     "title": "Gets a list of Variables",
30635     "examples": [
30636       {
30637         "title": "Example usage:",
30638         "content": "curl https://{domain}/api/variables -v -u {name}:{password}",
30639         "type": "json"
30640       }
30641     ],
30642     "name": "GetVariables",
30643     "group": "Variables",
30644     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
30645     "version": "0.0.0",
30646     "filename": "server/api/variable/index.js",
30647     "groupTitle": "Variables"
30648   },
30649   {
30650     "type": "get",
30651     "url": "/api/variables/{id}",
30652     "title": "Gets a single Variable",
30653     "examples": [
30654       {
30655         "title": "Example usage:",
30656         "content": "curl https://{domain}/api/variables/{id} -v -u {name}:{password}",
30657         "type": "json"
30658       }
30659     ],
30660     "name": "ShowVariables",
30661     "group": "Variables",
30662     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30663     "version": "0.0.0",
30664     "filename": "server/api/variable/index.js",
30665     "groupTitle": "Variables"
30666   },
30667   {
30668     "type": "put",
30669     "url": "/api/variables/{id}",
30670     "title": "Update an existing Variable",
30671     "examples": [
30672       {
30673         "title": "Example usage:",
30674         "content": "curl https://{domain}/api/variables/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
30675         "type": "json"
30676       }
30677     ],
30678     "name": "updateVariables",
30679     "group": "Variables",
30680     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30681     "version": "0.0.0",
30682     "filename": "server/api/variable/index.js",
30683     "groupTitle": "Variables"
30684   },
30685   {
30686     "type": "get",
30687     "url": "/api/version/fetch",
30688     "title": "Fetch git version",
30689     "examples": [
30690       {
30691         "title": "Example usage:",
30692         "content": "curl https://{domain}/api/version/fetch -v -u {name}:{password}",
30693         "type": "json"
30694       }
30695     ],
30696     "name": "FetchVersion",
30697     "group": "Version",
30698     "description": "<p>Motion run the following command: git fetch origin master</p>",
30699     "version": "0.0.0",
30700     "filename": "server/api/version/index.js",
30701     "groupTitle": "Version"
30702   },
30703   {
30704     "type": "get",
30705     "url": "/api/version",
30706     "title": "Gets version",
30707     "examples": [
30708       {
30709         "title": "Example usage:",
30710         "content": "curl https://{domain}/api/version -v -u {name}:{password}",
30711         "type": "json"
30712       }
30713     ],
30714     "name": "GetVersion",
30715     "group": "Version",
30716     "description": "<p>Motion returns the current and latest motion version.</p>",
30717     "version": "0.0.0",
30718     "filename": "server/api/version/index.js",
30719     "groupTitle": "Version"
30720   },
30721   {
30722     "type": "get",
30723     "url": "/api/version/migrations",
30724     "title": "Launch database migrations",
30725     "examples": [
30726       {
30727         "title": "Example usage:",
30728         "content": "curl https://{domain}/api/version/migrations -v -u {name}:{password}",
30729         "type": "json"
30730       }
30731     ],
30732     "name": "MigrateVersion",
30733     "group": "Version",
30734     "description": "<p>Motion launch the database migrations, according to the application version</p>",
30735     "version": "0.0.0",
30736     "filename": "server/api/version/index.js",
30737     "groupTitle": "Version"
30738   },
30739   {
30740     "type": "get",
30741     "url": "/api/version/pull",
30742     "title": "Pull git version",
30743     "examples": [
30744       {
30745         "title": "Example usage:",
30746         "content": "curl https://{domain}/api/version/pull -v -u {name}:{password}",
30747         "type": "json"
30748       }
30749     ],
30750     "name": "PullVersion",
30751     "group": "Version",
30752     "description": "<p>Motion run the following command: git pull</p>",
30753     "version": "0.0.0",
30754     "filename": "server/api/version/index.js",
30755     "groupTitle": "Version"
30756   },
30757   {
30758     "type": "get",
30759     "url": "/api/version/reset",
30760     "title": "Reset git version",
30761     "examples": [
30762       {
30763         "title": "Example usage:",
30764         "content": "curl https://{domain}/api/version/reset -v -u {name}:{password}",
30765         "type": "json"
30766       }
30767     ],
30768     "name": "ResetVersion",
30769     "group": "Version",
30770     "description": "<p>Motion run the following command: git reset --hard FETCH_HEAD</p>",
30771     "version": "0.0.0",
30772     "filename": "server/api/version/index.js",
30773     "groupTitle": "Version"
30774   },
30775   {
30776     "type": "get",
30777     "url": "/api/version/restart",
30778     "title": "Restart motion2 after update",
30779     "examples": [
30780       {
30781         "title": "Example usage:",
30782         "content": "curl https://{domain}/api/version/restart -v -u {name}:{password}",
30783         "type": "json"
30784       }
30785     ],
30786     "name": "RestartVersion",
30787     "group": "Version",
30788     "description": "<p>Motion run the following command: pm2 restart motion</p>",
30789     "version": "0.0.0",
30790     "filename": "server/api/version/index.js",
30791     "groupTitle": "Version"
30792   },
30793   {
30794     "type": "get",
30795     "url": "/api/voice/agents/reports/describe",
30796     "title": "Gets table info about Agent Reports",
30797     "examples": [
30798       {
30799         "title": "Example usage:",
30800         "content": "curl https://{domain}/api/voice/agents/reports/describe -v -u {name}:{password}",
30801         "type": "json"
30802       }
30803     ],
30804     "name": "DescribeAgent_Reports",
30805     "group": "Voice_Agent_Reports",
30806     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30807     "version": "0.0.0",
30808     "filename": "server/api/voiceAgentReport/index.js",
30809     "groupTitle": "Voice_Agent_Reports"
30810   },
30811   {
30812     "type": "get",
30813     "url": "/api/voice/agents/reports",
30814     "title": "Gets a list of Agent Reports",
30815     "examples": [
30816       {
30817         "title": "Example usage:",
30818         "content": "curl https://{domain}/api/voice/agents/reports -v -u {name}:{password}",
30819         "type": "json"
30820       }
30821     ],
30822     "name": "GetAgent_Reports",
30823     "group": "Voice_Agent_Reports",
30824     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
30825     "version": "0.0.0",
30826     "filename": "server/api/voiceAgentReport/index.js",
30827     "groupTitle": "Voice_Agent_Reports"
30828   },
30829   {
30830     "type": "get",
30831     "url": "/api/voice/agents/reports/{id}",
30832     "title": "Gets a single Agent Report",
30833     "examples": [
30834       {
30835         "title": "Example usage:",
30836         "content": "curl https://{domain}/api/voice/agents/reports/{id} -v -u {name}:{password}",
30837         "type": "json"
30838       }
30839     ],
30840     "name": "ShowAgent_Reports",
30841     "group": "Voice_Agent_Reports",
30842     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30843     "version": "0.0.0",
30844     "filename": "server/api/voiceAgentReport/index.js",
30845     "groupTitle": "Voice_Agent_Reports"
30846   },
30847   {
30848     "type": "get",
30849     "url": "/api/voice/calls/reports/describe",
30850     "title": "Gets table info about Call Reports",
30851     "examples": [
30852       {
30853         "title": "Example usage:",
30854         "content": "curl https://{domain}/api/voice/calls/reports/describe -v -u {name}:{password}",
30855         "type": "json"
30856       }
30857     ],
30858     "name": "DescribeCall_Reports",
30859     "group": "Voice_Call_Reports",
30860     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30861     "version": "0.0.0",
30862     "filename": "server/api/voiceCallReport/index.js",
30863     "groupTitle": "Voice_Call_Reports"
30864   },
30865   {
30866     "type": "get",
30867     "url": "/api/voice/calls/reports",
30868     "title": "Gets a list of Call Reports",
30869     "examples": [
30870       {
30871         "title": "Example usage:",
30872         "content": "curl https://{domain}/api/voice/calls/reports -v -u {name}:{password}",
30873         "type": "json"
30874       }
30875     ],
30876     "name": "GetCall_Reports",
30877     "group": "Voice_Call_Reports",
30878     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
30879     "version": "0.0.0",
30880     "filename": "server/api/voiceCallReport/index.js",
30881     "groupTitle": "Voice_Call_Reports"
30882   },
30883   {
30884     "type": "get",
30885     "url": "/api/voice/calls/reports/{id}",
30886     "title": "Gets a single Call Report",
30887     "examples": [
30888       {
30889         "title": "Example usage:",
30890         "content": "curl https://{domain}/api/voice/calls/reports/{id} -v -u {name}:{password}",
30891         "type": "json"
30892       }
30893     ],
30894     "name": "ShowCall_Reports",
30895     "group": "Voice_Call_Reports",
30896     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30897     "version": "0.0.0",
30898     "filename": "server/api/voiceCallReport/index.js",
30899     "groupTitle": "Voice_Call_Reports"
30900   },
30901   {
30902     "type": "put",
30903     "url": "/api/voice/calls/reports/{id}",
30904     "title": "Update a single cdr",
30905     "examples": [
30906       {
30907         "title": "Example usage:",
30908         "content": "curl https://{domain}/api/voice/calls/reports/{id} -d '{\"userDispositio\": \"OK\"}' -v -u {name}:{password} -X PUT",
30909         "type": "json"
30910       }
30911     ],
30912     "name": "update",
30913     "group": "Voice_Call_Reports",
30914     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30915     "version": "0.0.0",
30916     "filename": "server/api/voiceCallReport/index.js",
30917     "groupTitle": "Voice_Call_Reports"
30918   },
30919   {
30920     "type": "post",
30921     "url": "/api/voice/chanspy",
30922     "title": "Creates a new ChanSpy",
30923     "examples": [
30924       {
30925         "title": "Example usage:",
30926         "content": "curl https://{domain}/api/voice/chanspy -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
30927         "type": "json"
30928       }
30929     ],
30930     "name": "CreateChanSpy",
30931     "group": "Voice_ChanSpy",
30932     "parameter": {
30933       "fields": {
30934         "Body": [
30935           {
30936             "group": "Body",
30937             "type": "String",
30938             "optional": true,
30939             "field": "name",
30940             "description": ""
30941           },
30942           {
30943             "group": "Body",
30944             "type": "String",
30945             "optional": false,
30946             "field": "prefix",
30947             "description": ""
30948           },
30949           {
30950             "group": "Body",
30951             "type": "String",
30952             "optional": true,
30953             "field": "options",
30954             "description": ""
30955           },
30956           {
30957             "group": "Body",
30958             "type": "Boolean",
30959             "optional": true,
30960             "field": "auth",
30961             "description": ""
30962           },
30963           {
30964             "group": "Body",
30965             "type": "String",
30966             "optional": true,
30967             "field": "password",
30968             "description": ""
30969           },
30970           {
30971             "group": "Body",
30972             "type": "Boolean",
30973             "optional": true,
30974             "field": "record",
30975             "description": ""
30976           },
30977           {
30978             "group": "Body",
30979             "type": "String",
30980             "optional": true,
30981             "field": "recordingFormat",
30982             "description": ""
30983           },
30984           {
30985             "group": "Body",
30986             "type": "String",
30987             "optional": true,
30988             "field": "description",
30989             "description": ""
30990           }
30991         ]
30992       }
30993     },
30994     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30995     "version": "0.0.0",
30996     "filename": "server/api/voiceChanSpy/index.js",
30997     "groupTitle": "Voice_ChanSpy"
30998   },
30999   {
31000     "type": "delete",
31001     "url": "/api/voice/chanspy/{id}",
31002     "title": "Deletes a ChanSpy",
31003     "examples": [
31004       {
31005         "title": "Example usage:",
31006         "content": "curl https://{domain}/api/voice/chanspy/{id} -v -u {name}:{password} -X DELETE",
31007         "type": "json"
31008       }
31009     ],
31010     "name": "DeleteChanSpy",
31011     "group": "Voice_ChanSpy",
31012     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31013     "version": "0.0.0",
31014     "filename": "server/api/voiceChanSpy/index.js",
31015     "groupTitle": "Voice_ChanSpy"
31016   },
31017   {
31018     "type": "get",
31019     "url": "/api/voice/chanspy",
31020     "title": "Gets a list of ChanSpy",
31021     "examples": [
31022       {
31023         "title": "Example usage:",
31024         "content": "curl https://{domain}/api/voice/chanspy -v -u {name}:{password}",
31025         "type": "json"
31026       }
31027     ],
31028     "name": "GetChanSpy",
31029     "group": "Voice_ChanSpy",
31030     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
31031     "version": "0.0.0",
31032     "filename": "server/api/voiceChanSpy/index.js",
31033     "groupTitle": "Voice_ChanSpy"
31034   },
31035   {
31036     "type": "get",
31037     "url": "/api/voice/chanspy/{id}",
31038     "title": "Gets a single ChanSpy",
31039     "examples": [
31040       {
31041         "title": "Example usage:",
31042         "content": "curl https://{domain}/api/voice/chanspy/{id} -v -u {name}:{password}",
31043         "type": "json"
31044       }
31045     ],
31046     "name": "ShowChanSpy",
31047     "group": "Voice_ChanSpy",
31048     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31049     "version": "0.0.0",
31050     "filename": "server/api/voiceChanSpy/index.js",
31051     "groupTitle": "Voice_ChanSpy"
31052   },
31053   {
31054     "type": "put",
31055     "url": "/api/voice/chanspy/{id}",
31056     "title": "Update an existing ChanSpy",
31057     "examples": [
31058       {
31059         "title": "Example usage:",
31060         "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",
31061         "type": "json"
31062       }
31063     ],
31064     "name": "updateChanSpy",
31065     "group": "Voice_ChanSpy",
31066     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31067     "version": "0.0.0",
31068     "filename": "server/api/voiceChanSpy/index.js",
31069     "groupTitle": "Voice_ChanSpy"
31070   },
31071   {
31072     "type": "post",
31073     "url": "/api/voice/contexts",
31074     "title": "Create a new context",
31075     "examples": [
31076       {
31077         "title": "Example usage:",
31078         "content": "curl https://{domain}/api/voice/contexts -v -u {name}:{password} -X POST",
31079         "type": "json"
31080       }
31081     ],
31082     "name": "Create",
31083     "group": "Voice_Contexts",
31084     "parameter": {
31085       "fields": {
31086         "Body": [
31087           {
31088             "group": "Body",
31089             "type": "String",
31090             "optional": true,
31091             "field": "name",
31092             "description": ""
31093           },
31094           {
31095             "group": "Body",
31096             "type": "String",
31097             "optional": true,
31098             "field": "description",
31099             "description": ""
31100           },
31101           {
31102             "group": "Body",
31103             "type": "Boolean",
31104             "optional": true,
31105             "field": "defaultEntry",
31106             "description": ""
31107           }
31108         ]
31109       }
31110     },
31111     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31112     "version": "0.0.0",
31113     "filename": "server/api/voiceContext/index.js",
31114     "groupTitle": "Voice_Contexts"
31115   },
31116   {
31117     "type": "delete",
31118     "url": "/api/voice/contexts/{id}",
31119     "title": "Deletes a context",
31120     "examples": [
31121       {
31122         "title": "Example usage:",
31123         "content": "curl https://{domain}/api/voice/contexts/{id} -v -u {name}:{password} -X DELETE",
31124         "type": "json"
31125       }
31126     ],
31127     "name": "Delete",
31128     "group": "Voice_Contexts",
31129     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31130     "version": "0.0.0",
31131     "filename": "server/api/voiceContext/index.js",
31132     "groupTitle": "Voice_Contexts"
31133   },
31134   {
31135     "type": "get",
31136     "url": "/api/voice/contexts",
31137     "title": "Gets a list of Contexts",
31138     "examples": [
31139       {
31140         "title": "Example usage:",
31141         "content": "curl https://{domain}/api/voice/contexts -v -u {name}:{password}",
31142         "type": "json"
31143       }
31144     ],
31145     "name": "GetContexts",
31146     "group": "Voice_Contexts",
31147     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
31148     "version": "0.0.0",
31149     "filename": "server/api/voiceContext/index.js",
31150     "groupTitle": "Voice_Contexts"
31151   },
31152   {
31153     "type": "get",
31154     "url": "/api/voice/contexts/{id}",
31155     "title": "Gets a single Context",
31156     "examples": [
31157       {
31158         "title": "Example usage:",
31159         "content": "curl https://{domain}/api/voice/contexts/{id} -v -u {name}:{password}",
31160         "type": "json"
31161       }
31162     ],
31163     "name": "ShowContexts",
31164     "group": "Voice_Contexts",
31165     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31166     "version": "0.0.0",
31167     "filename": "server/api/voiceContext/index.js",
31168     "groupTitle": "Voice_Contexts"
31169   },
31170   {
31171     "type": "put",
31172     "url": "/api/voice/contexts/{id}",
31173     "title": "Update an existing context",
31174     "examples": [
31175       {
31176         "title": "Example usage:",
31177         "content": "curl https://{domain}/api/voice/contexts/{id} -v -u {name}:{password} -X PUT",
31178         "type": "json"
31179       }
31180     ],
31181     "name": "Update",
31182     "group": "Voice_Contexts",
31183     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31184     "version": "0.0.0",
31185     "filename": "server/api/voiceContext/index.js",
31186     "groupTitle": "Voice_Contexts"
31187   },
31188   {
31189     "type": "get",
31190     "url": "/api/voice/dials/reports/describe",
31191     "title": "Gets table info about Dial Reports",
31192     "examples": [
31193       {
31194         "title": "Example usage:",
31195         "content": "curl https://{domain}/api/voice/dials/reports/describe -v -u {name}:{password}",
31196         "type": "json"
31197       }
31198     ],
31199     "name": "DescribeDial_Reports",
31200     "group": "Voice_Dial_Reports",
31201     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31202     "version": "0.0.0",
31203     "filename": "server/api/voiceDialReport/index.js",
31204     "groupTitle": "Voice_Dial_Reports"
31205   },
31206   {
31207     "type": "get",
31208     "url": "/api/voice/dials/reports",
31209     "title": "Gets a list of Dial Reports",
31210     "examples": [
31211       {
31212         "title": "Example usage:",
31213         "content": "curl https://{domain}/api/voice/dials/reports -v -u {name}:{password}",
31214         "type": "json"
31215       }
31216     ],
31217     "name": "GetDial_Reports",
31218     "group": "Voice_Dial_Reports",
31219     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
31220     "version": "0.0.0",
31221     "filename": "server/api/voiceDialReport/index.js",
31222     "groupTitle": "Voice_Dial_Reports"
31223   },
31224   {
31225     "type": "get",
31226     "url": "/api/voice/dials/reports/{id}",
31227     "title": "Gets a single Dial Report",
31228     "examples": [
31229       {
31230         "title": "Example usage:",
31231         "content": "curl https://{domain}/api/voice/dials/reports/{id} -v -u {name}:{password}",
31232         "type": "json"
31233       }
31234     ],
31235     "name": "ShowDial_Reports",
31236     "group": "Voice_Dial_Reports",
31237     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31238     "version": "0.0.0",
31239     "filename": "server/api/voiceDialReport/index.js",
31240     "groupTitle": "Voice_Dial_Reports"
31241   },
31242   {
31243     "type": "delete",
31244     "url": "/api/voice/extensions/{id}",
31245     "title": "Deletes a Extension",
31246     "examples": [
31247       {
31248         "title": "Example usage:",
31249         "content": "curl https://{domain}/api/voice/extensions/{id} -v -u {name}:{password} -X DELETE",
31250         "type": "json"
31251       }
31252     ],
31253     "name": "DeleteExtensions",
31254     "group": "Voice_Extensions",
31255     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31256     "version": "0.0.0",
31257     "filename": "server/api/voiceExtension/index.js",
31258     "groupTitle": "Voice_Extensions"
31259   },
31260   {
31261     "type": "get",
31262     "url": "/api/voice/extensions",
31263     "title": "Gets a list of Extensions",
31264     "examples": [
31265       {
31266         "title": "Example usage:",
31267         "content": "curl https://{domain}/api/voice/extensions -v -u {name}:{password}",
31268         "type": "json"
31269       }
31270     ],
31271     "name": "GetExtensions",
31272     "group": "Voice_Extensions",
31273     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
31274     "version": "0.0.0",
31275     "filename": "server/api/voiceExtension/index.js",
31276     "groupTitle": "Voice_Extensions"
31277   },
31278   {
31279     "type": "get",
31280     "url": "/api/voice/extensions/{id}",
31281     "title": "Gets a single Extension",
31282     "examples": [
31283       {
31284         "title": "Example usage:",
31285         "content": "curl https://{domain}/api/voice/extensions/{id} -v -u {name}:{password}",
31286         "type": "json"
31287       }
31288     ],
31289     "name": "ShowExtensions",
31290     "group": "Voice_Extensions",
31291     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31292     "version": "0.0.0",
31293     "filename": "server/api/voiceExtension/index.js",
31294     "groupTitle": "Voice_Extensions"
31295   },
31296   {
31297     "type": "post",
31298     "url": "/api/voice/extensions",
31299     "title": "Create new applications",
31300     "examples": [
31301       {
31302         "title": "Example usage:",
31303         "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",
31304         "type": "json"
31305       }
31306     ],
31307     "name": "addApplications",
31308     "group": "Voice_Extensions",
31309     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31310     "version": "0.0.0",
31311     "filename": "server/api/voiceExtension/index.js",
31312     "groupTitle": "Voice_Extensions"
31313   },
31314   {
31315     "type": "post",
31316     "url": "/api/voice/extensions",
31317     "title": "Create an extension",
31318     "examples": [
31319       {
31320         "title": "Example usage:",
31321         "content": "curl https://{domain}/api/voice/extensions -d '{\"exten\": \"12345\", \"context\": \"from-custom\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
31322         "type": "json"
31323       }
31324     ],
31325     "name": "create",
31326     "group": "Voice_Extensions",
31327     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31328     "version": "0.0.0",
31329     "filename": "server/api/voiceExtension/index.js",
31330     "groupTitle": "Voice_Extensions"
31331   },
31332   {
31333     "type": "put",
31334     "url": "/api/voice/extensions/{id}",
31335     "title": "Update an extension",
31336     "examples": [
31337       {
31338         "title": "Example usage:",
31339         "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",
31340         "type": "json"
31341       }
31342     ],
31343     "name": "update",
31344     "group": "Voice_Extensions",
31345     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31346     "version": "0.0.0",
31347     "filename": "server/api/voiceExtension/index.js",
31348     "groupTitle": "Voice_Extensions"
31349   },
31350   {
31351     "type": "post",
31352     "url": "/api/voice/mohs",
31353     "title": "Create a new a new MOH",
31354     "examples": [
31355       {
31356         "title": "Example usage:",
31357         "content": "curl https://{domain}/api/voice/mohs -d '{\"name\": \"xmas_musics\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
31358         "type": "json"
31359       }
31360     ],
31361     "name": "AddMoh",
31362     "group": "Voice_MOHs",
31363     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31364     "version": "0.0.0",
31365     "filename": "server/api/voiceMusicOnHold/index.js",
31366     "groupTitle": "Voice_MOHs"
31367   },
31368   {
31369     "type": "post",
31370     "url": "/api/voice/mohs/{id}/sounds",
31371     "title": "Add sound to MOH",
31372     "examples": [
31373       {
31374         "title": "Example usage:",
31375         "content": "curl https://{domain}/api/voice/mohs/{id}/sounds -d '{\"id\": 1}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
31376         "type": "json"
31377       }
31378     ],
31379     "name": "AddSound",
31380     "group": "Voice_MOHs",
31381     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31382     "version": "0.0.0",
31383     "filename": "server/api/voiceMusicOnHold/index.js",
31384     "groupTitle": "Voice_MOHs"
31385   },
31386   {
31387     "type": "delete",
31388     "url": "/api/voice/mohs/{id}",
31389     "title": "Deletes an MOH",
31390     "examples": [
31391       {
31392         "title": "Example usage:",
31393         "content": "curl https://{domain}/api/voice/mohs/{id} -v -u {name}:{password} -X DELETE",
31394         "type": "json"
31395       }
31396     ],
31397     "name": "DestroyMoh",
31398     "group": "Voice_MOHs",
31399     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31400     "version": "0.0.0",
31401     "filename": "server/api/voiceMusicOnHold/index.js",
31402     "groupTitle": "Voice_MOHs"
31403   },
31404   {
31405     "type": "get",
31406     "url": "/api/voice/mohs",
31407     "title": "Gets a list of Music On Holds",
31408     "examples": [
31409       {
31410         "title": "Example usage:",
31411         "content": "curl https://{domain}/api/voice/mohs -v -u {name}:{password}",
31412         "type": "json"
31413       }
31414     ],
31415     "name": "GetMusic_On_Holds",
31416     "group": "Voice_MOHs",
31417     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
31418     "version": "0.0.0",
31419     "filename": "server/api/voiceMusicOnHold/index.js",
31420     "groupTitle": "Voice_MOHs"
31421   },
31422   {
31423     "type": "get",
31424     "url": "/api/voice/mohs/{id}/sounds",
31425     "title": "Gets sounds from MOH",
31426     "examples": [
31427       {
31428         "title": "Example usage:",
31429         "content": "curl https://{domain}/api/voice/mohs/{id}/sounds -v -u {name}:{password} -X DELETE",
31430         "type": "json"
31431       }
31432     ],
31433     "name": "GetSounds",
31434     "group": "Voice_MOHs",
31435     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31436     "version": "0.0.0",
31437     "filename": "server/api/voiceMusicOnHold/index.js",
31438     "groupTitle": "Voice_MOHs"
31439   },
31440   {
31441     "type": "delete",
31442     "url": "/api/voice/mohs/{id}/sounds/{id2}",
31443     "title": "Remove sound from MOH",
31444     "examples": [
31445       {
31446         "title": "Example usage:",
31447         "content": "curl https://{domain}/api/voice/mohs/{id}/sounds/{id2} -v -u {name}:{password} -X DELETE",
31448         "type": "json"
31449       }
31450     ],
31451     "name": "RemoveSound",
31452     "group": "Voice_MOHs",
31453     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31454     "version": "0.0.0",
31455     "filename": "server/api/voiceMusicOnHold/index.js",
31456     "groupTitle": "Voice_MOHs"
31457   },
31458   {
31459     "type": "get",
31460     "url": "/api/voice/mohs/{id}",
31461     "title": "Gets a single Music On Hold",
31462     "examples": [
31463       {
31464         "title": "Example usage:",
31465         "content": "curl https://{domain}/api/voice/mohs/{id} -v -u {name}:{password}",
31466         "type": "json"
31467       }
31468     ],
31469     "name": "ShowMusic_On_Holds",
31470     "group": "Voice_MOHs",
31471     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31472     "version": "0.0.0",
31473     "filename": "server/api/voiceMusicOnHold/index.js",
31474     "groupTitle": "Voice_MOHs"
31475   },
31476   {
31477     "type": "put",
31478     "url": "/api/voice/mohs/{id}",
31479     "title": "Update an existing Music On Hold",
31480     "examples": [
31481       {
31482         "title": "Example usage:",
31483         "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",
31484         "type": "json"
31485       }
31486     ],
31487     "name": "updateMusic_On_Holds",
31488     "group": "Voice_MOHs",
31489     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31490     "version": "0.0.0",
31491     "filename": "server/api/voiceMusicOnHold/index.js",
31492     "groupTitle": "Voice_MOHs"
31493   },
31494   {
31495     "type": "post",
31496     "url": "/api/voice/mails",
31497     "title": "Creates a new Mail",
31498     "examples": [
31499       {
31500         "title": "Example usage:",
31501         "content": "curl https://{domain}/api/voice/mails -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
31502         "type": "json"
31503       }
31504     ],
31505     "name": "CreateMails",
31506     "group": "Voice_Mails",
31507     "parameter": {
31508       "fields": {
31509         "Body": [
31510           {
31511             "group": "Body",
31512             "type": "String",
31513             "optional": true,
31514             "field": "customer_id",
31515             "description": ""
31516           },
31517           {
31518             "group": "Body",
31519             "type": "String",
31520             "optional": true,
31521             "field": "context",
31522             "description": ""
31523           },
31524           {
31525             "group": "Body",
31526             "type": "String",
31527             "optional": false,
31528             "field": "mailbox",
31529             "description": ""
31530           },
31531           {
31532             "group": "Body",
31533             "type": "String",
31534             "optional": true,
31535             "field": "password",
31536             "description": ""
31537           },
31538           {
31539             "group": "Body",
31540             "type": "String",
31541             "optional": true,
31542             "field": "fullname",
31543             "description": ""
31544           },
31545           {
31546             "group": "Body",
31547             "type": "String",
31548             "optional": true,
31549             "field": "email",
31550             "description": ""
31551           },
31552           {
31553             "group": "Body",
31554             "type": "String",
31555             "optional": true,
31556             "field": "pager",
31557             "description": ""
31558           },
31559           {
31560             "group": "Body",
31561             "type": "String",
31562             "optional": true,
31563             "field": "tz",
31564             "description": ""
31565           },
31566           {
31567             "group": "Body",
31568             "type": "String",
31569             "allowedValues": [
31570               "\"yes\"",
31571               "\"no\""
31572             ],
31573             "optional": false,
31574             "field": "attach",
31575             "description": ""
31576           },
31577           {
31578             "group": "Body",
31579             "type": "String",
31580             "allowedValues": [
31581               "\"yes\"",
31582               "\"no\""
31583             ],
31584             "optional": false,
31585             "field": "saycid",
31586             "description": ""
31587           },
31588           {
31589             "group": "Body",
31590             "type": "String",
31591             "optional": true,
31592             "field": "dialout",
31593             "description": ""
31594           },
31595           {
31596             "group": "Body",
31597             "type": "String",
31598             "optional": true,
31599             "field": "callback",
31600             "description": ""
31601           },
31602           {
31603             "group": "Body",
31604             "type": "String",
31605             "allowedValues": [
31606               "\"yes\"",
31607               "\"no\""
31608             ],
31609             "optional": false,
31610             "field": "review",
31611             "description": ""
31612           },
31613           {
31614             "group": "Body",
31615             "type": "String",
31616             "allowedValues": [
31617               "\"yes\"",
31618               "\"no\""
31619             ],
31620             "optional": false,
31621             "field": "operator",
31622             "description": ""
31623           },
31624           {
31625             "group": "Body",
31626             "type": "String",
31627             "allowedValues": [
31628               "\"yes\"",
31629               "\"no\""
31630             ],
31631             "optional": false,
31632             "field": "envelope",
31633             "description": ""
31634           },
31635           {
31636             "group": "Body",
31637             "type": "String",
31638             "allowedValues": [
31639               "\"yes\"",
31640               "\"no\""
31641             ],
31642             "optional": false,
31643             "field": "sayduration",
31644             "description": ""
31645           },
31646           {
31647             "group": "Body",
31648             "type": "String",
31649             "optional": false,
31650             "field": "saydurationm",
31651             "description": ""
31652           },
31653           {
31654             "group": "Body",
31655             "type": "String",
31656             "allowedValues": [
31657               "\"yes\"",
31658               "\"no\""
31659             ],
31660             "optional": false,
31661             "field": "sendvoicemail",
31662             "description": ""
31663           },
31664           {
31665             "group": "Body",
31666             "type": "String",
31667             "allowedValues": [
31668               "\"yes\"",
31669               "\"no\""
31670             ],
31671             "optional": false,
31672             "field": "delete",
31673             "description": ""
31674           },
31675           {
31676             "group": "Body",
31677             "type": "String",
31678             "allowedValues": [
31679               "\"yes\"",
31680               "\"no\""
31681             ],
31682             "optional": false,
31683             "field": "nextaftercmd",
31684             "description": ""
31685           },
31686           {
31687             "group": "Body",
31688             "type": "String",
31689             "allowedValues": [
31690               "\"yes\"",
31691               "\"no\""
31692             ],
31693             "optional": false,
31694             "field": "forcename",
31695             "description": ""
31696           },
31697           {
31698             "group": "Body",
31699             "type": "String",
31700             "allowedValues": [
31701               "\"yes\"",
31702               "\"no\""
31703             ],
31704             "optional": false,
31705             "field": "forcegreetings",
31706             "description": ""
31707           },
31708           {
31709             "group": "Body",
31710             "type": "String",
31711             "allowedValues": [
31712               "\"yes\"",
31713               "\"no\""
31714             ],
31715             "optional": false,
31716             "field": "hidefromdir",
31717             "description": ""
31718           },
31719           {
31720             "group": "Body",
31721             "type": "String",
31722             "optional": true,
31723             "field": "stamp",
31724             "description": ""
31725           },
31726           {
31727             "group": "Body",
31728             "type": "String",
31729             "optional": true,
31730             "field": "emailsubject",
31731             "description": ""
31732           },
31733           {
31734             "group": "Body",
31735             "type": "String",
31736             "optional": true,
31737             "field": "emailbody",
31738             "description": ""
31739           },
31740           {
31741             "group": "Body",
31742             "type": "Integer",
31743             "optional": false,
31744             "field": "maxsecs",
31745             "description": ""
31746           },
31747           {
31748             "group": "Body",
31749             "type": "Integer",
31750             "optional": false,
31751             "field": "maxmsg",
31752             "description": ""
31753           },
31754           {
31755             "group": "Body",
31756             "type": "Virtual",
31757             "optional": true,
31758             "field": "name",
31759             "description": ""
31760           }
31761         ]
31762       }
31763     },
31764     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31765     "version": "0.0.0",
31766     "filename": "server/api/voiceMail/index.js",
31767     "groupTitle": "Voice_Mails"
31768   },
31769   {
31770     "type": "delete",
31771     "url": "/api/voice/mails/{id}",
31772     "title": "Deletes a Mail",
31773     "examples": [
31774       {
31775         "title": "Example usage:",
31776         "content": "curl https://{domain}/api/voice/mails/{id} -v -u {name}:{password} -X DELETE",
31777         "type": "json"
31778       }
31779     ],
31780     "name": "DeleteMails",
31781     "group": "Voice_Mails",
31782     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31783     "version": "0.0.0",
31784     "filename": "server/api/voiceMail/index.js",
31785     "groupTitle": "Voice_Mails"
31786   },
31787   {
31788     "type": "get",
31789     "url": "/api/voice/mails",
31790     "title": "Gets a list of Mails",
31791     "examples": [
31792       {
31793         "title": "Example usage:",
31794         "content": "curl https://{domain}/api/voice/mails -v -u {name}:{password}",
31795         "type": "json"
31796       }
31797     ],
31798     "name": "GetMails",
31799     "group": "Voice_Mails",
31800     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
31801     "version": "0.0.0",
31802     "filename": "server/api/voiceMail/index.js",
31803     "groupTitle": "Voice_Mails"
31804   },
31805   {
31806     "type": "get",
31807     "url": "/api/voice/mails/{id}",
31808     "title": "Gets a single Mail",
31809     "examples": [
31810       {
31811         "title": "Example usage:",
31812         "content": "curl https://{domain}/api/voice/mails/{id} -v -u {name}:{password}",
31813         "type": "json"
31814       }
31815     ],
31816     "name": "ShowMails",
31817     "group": "Voice_Mails",
31818     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31819     "version": "0.0.0",
31820     "filename": "server/api/voiceMail/index.js",
31821     "groupTitle": "Voice_Mails"
31822   },
31823   {
31824     "type": "get",
31825     "url": "/api/voice/mails/{id}/messages",
31826     "title": "Gets voice mail messages",
31827     "examples": [
31828       {
31829         "title": "Example usage:",
31830         "content": "curl https://{domain}/api/voice/mails/{id}/messages -v -u {name}:{password} -X GET",
31831         "type": "json"
31832       }
31833     ],
31834     "name": "getMessages",
31835     "group": "Voice_Mails",
31836     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31837     "version": "0.0.0",
31838     "filename": "server/api/voiceMail/index.js",
31839     "groupTitle": "Voice_Mails"
31840   },
31841   {
31842     "type": "put",
31843     "url": "/api/voice/mails/{id}",
31844     "title": "Update an existing Mail",
31845     "examples": [
31846       {
31847         "title": "Example usage:",
31848         "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",
31849         "type": "json"
31850       }
31851     ],
31852     "name": "updateMails",
31853     "group": "Voice_Mails",
31854     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31855     "version": "0.0.0",
31856     "filename": "server/api/voiceMail/index.js",
31857     "groupTitle": "Voice_Mails"
31858   },
31859   {
31860     "type": "post",
31861     "url": "/api/voice/mails/messages",
31862     "title": "Creates a new Message",
31863     "examples": [
31864       {
31865         "title": "Example usage:",
31866         "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",
31867         "type": "json"
31868       }
31869     ],
31870     "name": "CreateMessages",
31871     "group": "Voice_Messages",
31872     "parameter": {
31873       "fields": {
31874         "Body": [
31875           {
31876             "group": "Body",
31877             "type": "Virtual",
31878             "optional": true,
31879             "field": "name",
31880             "description": ""
31881           },
31882           {
31883             "group": "Body",
31884             "type": "Integer",
31885             "optional": false,
31886             "field": "msgnum",
31887             "description": ""
31888           },
31889           {
31890             "group": "Body",
31891             "type": "String",
31892             "optional": true,
31893             "field": "dir",
31894             "description": ""
31895           },
31896           {
31897             "group": "Body",
31898             "type": "String",
31899             "optional": true,
31900             "field": "context",
31901             "description": ""
31902           },
31903           {
31904             "group": "Body",
31905             "type": "String",
31906             "optional": true,
31907             "field": "macrocontext",
31908             "description": ""
31909           },
31910           {
31911             "group": "Body",
31912             "type": "String",
31913             "optional": true,
31914             "field": "callerid",
31915             "description": ""
31916           },
31917           {
31918             "group": "Body",
31919             "type": "String",
31920             "optional": true,
31921             "field": "origtime",
31922             "description": ""
31923           },
31924           {
31925             "group": "Body",
31926             "type": "String",
31927             "optional": true,
31928             "field": "duration",
31929             "description": ""
31930           },
31931           {
31932             "group": "Body",
31933             "type": "String",
31934             "optional": true,
31935             "field": "mailboxuser",
31936             "description": ""
31937           },
31938           {
31939             "group": "Body",
31940             "type": "String",
31941             "optional": true,
31942             "field": "mailboxcontext",
31943             "description": ""
31944           },
31945           {
31946             "group": "Body",
31947             "type": "Blob",
31948             "optional": true,
31949             "field": "recording",
31950             "description": ""
31951           },
31952           {
31953             "group": "Body",
31954             "type": "String",
31955             "optional": true,
31956             "field": "flag",
31957             "description": ""
31958           },
31959           {
31960             "group": "Body",
31961             "type": "String",
31962             "optional": true,
31963             "field": "msg_id",
31964             "description": ""
31965           },
31966           {
31967             "group": "Body",
31968             "type": "String",
31969             "optional": true,
31970             "field": "stamp",
31971             "description": ""
31972           }
31973         ]
31974       }
31975     },
31976     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31977     "version": "0.0.0",
31978     "filename": "server/api/voiceMailMessage/index.js",
31979     "groupTitle": "Voice_Messages"
31980   },
31981   {
31982     "type": "delete",
31983     "url": "/api/voice/mails/messages/{id}",
31984     "title": "Deletes a Message",
31985     "examples": [
31986       {
31987         "title": "Example usage:",
31988         "content": "curl https://{domain}/api/voice/mails/messages/{id} -v -u {name}:{password} -X DELETE",
31989         "type": "json"
31990       }
31991     ],
31992     "name": "DeleteMessages",
31993     "group": "Voice_Messages",
31994     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31995     "version": "0.0.0",
31996     "filename": "server/api/voiceMailMessage/index.js",
31997     "groupTitle": "Voice_Messages"
31998   },
31999   {
32000     "type": "get",
32001     "url": "/api/voice/mails/messages",
32002     "title": "Gets a list of Messages",
32003     "examples": [
32004       {
32005         "title": "Example usage:",
32006         "content": "curl https://{domain}/api/voice/mails/messages -v -u {name}:{password}",
32007         "type": "json"
32008       }
32009     ],
32010     "name": "GetMessages",
32011     "group": "Voice_Messages",
32012     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
32013     "version": "0.0.0",
32014     "filename": "server/api/voiceMailMessage/index.js",
32015     "groupTitle": "Voice_Messages"
32016   },
32017   {
32018     "type": "get",
32019     "url": "/api/voice/mails/messages/{id}",
32020     "title": "Gets a single Message",
32021     "examples": [
32022       {
32023         "title": "Example usage:",
32024         "content": "curl https://{domain}/api/voice/mails/messages/{id} -v -u {name}:{password}",
32025         "type": "json"
32026       }
32027     ],
32028     "name": "ShowMessages",
32029     "group": "Voice_Messages",
32030     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32031     "version": "0.0.0",
32032     "filename": "server/api/voiceMailMessage/index.js",
32033     "groupTitle": "Voice_Messages"
32034   },
32035   {
32036     "type": "get",
32037     "url": "voice/mails/messages/{id}/download",
32038     "title": "Download Voice Message",
32039     "examples": [
32040       {
32041         "title": "Example usage:",
32042         "content": "curl https://{domain}voice/mails/messages/{id}/download -v -u {name}:{password} -X GET",
32043         "type": "json"
32044       }
32045     ],
32046     "name": "download",
32047     "group": "Voice_Messages",
32048     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32049     "version": "0.0.0",
32050     "filename": "server/api/voiceMailMessage/index.js",
32051     "groupTitle": "Voice_Messages"
32052   },
32053   {
32054     "type": "put",
32055     "url": "/api/voice/mails/messages/{id}",
32056     "title": "Update an existing Message",
32057     "examples": [
32058       {
32059         "title": "Example usage:",
32060         "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",
32061         "type": "json"
32062       }
32063     ],
32064     "name": "updateMessages",
32065     "group": "Voice_Messages",
32066     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32067     "version": "0.0.0",
32068     "filename": "server/api/voiceMailMessage/index.js",
32069     "groupTitle": "Voice_Messages"
32070   },
32071   {
32072     "type": "post",
32073     "url": "/api/voice/prefixes/{id}/teams",
32074     "title": "Add teams to voice prefix",
32075     "examples": [
32076       {
32077         "title": "Example usage:",
32078         "content": "curl https://{domain}/api/voice/prefixes/{id}/teams -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
32079         "type": "json"
32080       }
32081     ],
32082     "name": "AddTeams",
32083     "group": "Voice_Prefix",
32084     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32085     "version": "0.0.0",
32086     "filename": "server/api/voicePrefix/index.js",
32087     "groupTitle": "Voice_Prefix"
32088   },
32089   {
32090     "type": "get",
32091     "url": "/api/voice/prefixes/{id}/teams",
32092     "title": "Gets voice prefix team",
32093     "examples": [
32094       {
32095         "title": "Example usage:",
32096         "content": "curl https://{domain}/api/voice/prefixes/{id}/teams -v -u {name}:{password}  -X GET",
32097         "type": "json"
32098       }
32099     ],
32100     "name": "GetTeams",
32101     "group": "Voice_Prefix",
32102     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32103     "version": "0.0.0",
32104     "filename": "server/api/voicePrefix/index.js",
32105     "groupTitle": "Voice_Prefix"
32106   },
32107   {
32108     "type": "post",
32109     "url": "/api/voice/prefixes/{id}/users",
32110     "title": "Add agents to a prefix",
32111     "examples": [
32112       {
32113         "title": "Example usage:",
32114         "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",
32115         "type": "json"
32116       }
32117     ],
32118     "name": "AddAgents",
32119     "group": "Voice_Prefixes",
32120     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32121     "version": "0.0.0",
32122     "filename": "server/api/voicePrefix/index.js",
32123     "groupTitle": "Voice_Prefixes"
32124   },
32125   {
32126     "type": "delete",
32127     "url": "/api/voice/prefixes/{id}",
32128     "title": "Deletes a Prefix",
32129     "examples": [
32130       {
32131         "title": "Example usage:",
32132         "content": "curl https://{domain}/api/voice/prefixes/{id} -v -u {name}:{password} -X DELETE",
32133         "type": "json"
32134       }
32135     ],
32136     "name": "DeletePrefixes",
32137     "group": "Voice_Prefixes",
32138     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32139     "version": "0.0.0",
32140     "filename": "server/api/voicePrefix/index.js",
32141     "groupTitle": "Voice_Prefixes"
32142   },
32143   {
32144     "type": "get",
32145     "url": "/api/voice/prefixes/describe",
32146     "title": "Gets table info about Prefixes",
32147     "examples": [
32148       {
32149         "title": "Example usage:",
32150         "content": "curl https://{domain}/api/voice/prefixes/describe -v -u {name}:{password}",
32151         "type": "json"
32152       }
32153     ],
32154     "name": "DescribePrefixes",
32155     "group": "Voice_Prefixes",
32156     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32157     "version": "0.0.0",
32158     "filename": "server/api/voicePrefix/index.js",
32159     "groupTitle": "Voice_Prefixes"
32160   },
32161   {
32162     "type": "get",
32163     "url": "/api/voice/prefixes/{id}/users",
32164     "title": "Gets agents from prefix",
32165     "examples": [
32166       {
32167         "title": "Example usage:",
32168         "content": "curl https://{domain}/api/voice/prefixes/{id}/users -v -u {name}:{password} -X GET",
32169         "type": "json"
32170       }
32171     ],
32172     "name": "GetAgents",
32173     "group": "Voice_Prefixes",
32174     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32175     "version": "0.0.0",
32176     "filename": "server/api/voicePrefix/index.js",
32177     "groupTitle": "Voice_Prefixes"
32178   },
32179   {
32180     "type": "get",
32181     "url": "/api/voice/prefixes",
32182     "title": "Gets a list of Prefixes",
32183     "examples": [
32184       {
32185         "title": "Example usage:",
32186         "content": "curl https://{domain}/api/voice/prefixes -v -u {name}:{password}",
32187         "type": "json"
32188       }
32189     ],
32190     "name": "GetPrefixes",
32191     "group": "Voice_Prefixes",
32192     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
32193     "version": "0.0.0",
32194     "filename": "server/api/voicePrefix/index.js",
32195     "groupTitle": "Voice_Prefixes"
32196   },
32197   {
32198     "type": "delete",
32199     "url": "/api/voice/prefixes/{id}/users",
32200     "title": "Removes agents from a prefix",
32201     "examples": [
32202       {
32203         "title": "Example usage:",
32204         "content": "curl https://{domain}/api/voice/prefixes/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
32205         "type": "json"
32206       }
32207     ],
32208     "name": "RemoveAgents",
32209     "group": "Voice_Prefixes",
32210     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32211     "version": "0.0.0",
32212     "filename": "server/api/voicePrefix/index.js",
32213     "groupTitle": "Voice_Prefixes"
32214   },
32215   {
32216     "type": "get",
32217     "url": "/api/voice/prefixes/{id}",
32218     "title": "Gets a single Prefix",
32219     "examples": [
32220       {
32221         "title": "Example usage:",
32222         "content": "curl https://{domain}/api/voice/prefixes/{id} -v -u {name}:{password}",
32223         "type": "json"
32224       }
32225     ],
32226     "name": "ShowPrefixes",
32227     "group": "Voice_Prefixes",
32228     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32229     "version": "0.0.0",
32230     "filename": "server/api/voicePrefix/index.js",
32231     "groupTitle": "Voice_Prefixes"
32232   },
32233   {
32234     "type": "put",
32235     "url": "/api/voice/prefixes/{id}",
32236     "title": "Update an existing prefix",
32237     "examples": [
32238       {
32239         "title": "Example usage:",
32240         "content": "curl https://{domain}/api/voice/prefixes/{id} -v -u {name}:{password} -X PUT",
32241         "type": "json"
32242       }
32243     ],
32244     "name": "Update",
32245     "group": "Voice_Prefixes",
32246     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32247     "version": "0.0.0",
32248     "filename": "server/api/voicePrefix/index.js",
32249     "groupTitle": "Voice_Prefixes"
32250   },
32251   {
32252     "type": "post",
32253     "url": "/api/voice/prefixes",
32254     "title": "Create a prefix",
32255     "examples": [
32256       {
32257         "title": "Example usage:",
32258         "content": "curl https://{domain}/api/voice/prefixes -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
32259         "type": "json"
32260       }
32261     ],
32262     "name": "create",
32263     "group": "Voice_Prefixes",
32264     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32265     "version": "0.0.0",
32266     "filename": "server/api/voicePrefix/index.js",
32267     "groupTitle": "Voice_Prefixes"
32268   },
32269   {
32270     "type": "get",
32271     "url": "/api/voice/queues/reports/describe",
32272     "title": "Gets table info about Queue Reports",
32273     "examples": [
32274       {
32275         "title": "Example usage:",
32276         "content": "curl https://{domain}/api/voice/queues/reports/describe -v -u {name}:{password}",
32277         "type": "json"
32278       }
32279     ],
32280     "name": "DescribeQueue_Reports",
32281     "group": "Voice_Queue_Reports",
32282     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32283     "version": "0.0.0",
32284     "filename": "server/api/voiceQueueReport/index.js",
32285     "groupTitle": "Voice_Queue_Reports"
32286   },
32287   {
32288     "type": "get",
32289     "url": "/api/voice/queues/reports",
32290     "title": "Gets a list of Queue Reports",
32291     "examples": [
32292       {
32293         "title": "Example usage:",
32294         "content": "curl https://{domain}/api/voice/queues/reports -v -u {name}:{password}",
32295         "type": "json"
32296       }
32297     ],
32298     "name": "GetQueue_Reports",
32299     "group": "Voice_Queue_Reports",
32300     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
32301     "version": "0.0.0",
32302     "filename": "server/api/voiceQueueReport/index.js",
32303     "groupTitle": "Voice_Queue_Reports"
32304   },
32305   {
32306     "type": "get",
32307     "url": "/api/voice/queues/reports/{id}",
32308     "title": "Gets a single Queue Report",
32309     "examples": [
32310       {
32311         "title": "Example usage:",
32312         "content": "curl https://{domain}/api/voice/queues/reports/{id} -v -u {name}:{password}",
32313         "type": "json"
32314       }
32315     ],
32316     "name": "ShowQueue_Reports",
32317     "group": "Voice_Queue_Reports",
32318     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32319     "version": "0.0.0",
32320     "filename": "server/api/voiceQueueReport/index.js",
32321     "groupTitle": "Voice_Queue_Reports"
32322   },
32323   {
32324     "type": "get",
32325     "url": "/api/voice/queues/reports/index",
32326     "title": "Get Voice Queues Report",
32327     "examples": [
32328       {
32329         "title": "Example usage:",
32330         "content": "curl https://{domain}/api/voice/queues/reports/index -v -u {name}:{password} -X GET",
32331         "type": "json"
32332       }
32333     ],
32334     "name": "getVoiceQueuesReport",
32335     "group": "Voice_Queue_Reports",
32336     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32337     "version": "0.0.0",
32338     "filename": "server/api/voiceQueueReport/index.js",
32339     "groupTitle": "Voice_Queue_Reports"
32340   },
32341   {
32342     "type": "post",
32343     "url": "/api/voice/queues/{id}/users",
32344     "title": "Add agents to queue",
32345     "examples": [
32346       {
32347         "title": "Example usage:",
32348         "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",
32349         "type": "json"
32350       }
32351     ],
32352     "name": "AddAgents",
32353     "group": "Voice_Queues",
32354     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32355     "version": "0.0.0",
32356     "filename": "server/api/voiceQueue/index.js",
32357     "groupTitle": "Voice_Queues"
32358   },
32359   {
32360     "type": "post",
32361     "url": "/api/voice/queues/{id}/blacklists",
32362     "title": "Add blacklists to a queue",
32363     "examples": [
32364       {
32365         "title": "Example usage:",
32366         "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",
32367         "type": "json"
32368       }
32369     ],
32370     "name": "AddBlackLists",
32371     "group": "Voice_Queues",
32372     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32373     "version": "0.0.0",
32374     "filename": "server/api/voiceQueue/index.js",
32375     "groupTitle": "Voice_Queues"
32376   },
32377   {
32378     "type": "post",
32379     "url": "/api/voice/queues/{id}/lists",
32380     "title": "Add lists to a queue",
32381     "examples": [
32382       {
32383         "title": "Example usage:",
32384         "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",
32385         "type": "json"
32386       }
32387     ],
32388     "name": "AddLists",
32389     "group": "Voice_Queues",
32390     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32391     "version": "0.0.0",
32392     "filename": "server/api/voiceQueue/index.js",
32393     "groupTitle": "Voice_Queues"
32394   },
32395   {
32396     "type": "post",
32397     "url": "/api/voice/queues/{id}/teams",
32398     "title": "Add teams to queue",
32399     "examples": [
32400       {
32401         "title": "Example usage:",
32402         "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",
32403         "type": "json"
32404       }
32405     ],
32406     "name": "AddTeams",
32407     "group": "Voice_Queues",
32408     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32409     "version": "0.0.0",
32410     "filename": "server/api/voiceQueue/index.js",
32411     "groupTitle": "Voice_Queues"
32412   },
32413   {
32414     "type": "post",
32415     "url": "/api/voice/queues/clone",
32416     "title": "Clone an existing Queue",
32417     "examples": [
32418       {
32419         "title": "Example usage:",
32420         "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",
32421         "type": "json"
32422       }
32423     ],
32424     "name": "CloneQueues",
32425     "group": "Voice_Queues",
32426     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32427     "version": "0.0.0",
32428     "filename": "server/api/voiceQueue/index.js",
32429     "groupTitle": "Voice_Queues"
32430   },
32431   {
32432     "type": "post",
32433     "url": "/api/voice/queues",
32434     "title": "Creates a new Queue",
32435     "examples": [
32436       {
32437         "title": "Example usage:",
32438         "content": "curl https://{domain}/api/voice/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
32439         "type": "json"
32440       }
32441     ],
32442     "name": "CreateQueues",
32443     "group": "Voice_Queues",
32444     "parameter": {
32445       "fields": {
32446         "Body": [
32447           {
32448             "group": "Body",
32449             "type": "String",
32450             "optional": false,
32451             "field": "name",
32452             "description": ""
32453           },
32454           {
32455             "group": "Body",
32456             "type": "String",
32457             "allowedValues": [
32458               "\"inbound\"",
32459               "\"outbound\""
32460             ],
32461             "optional": false,
32462             "field": "type",
32463             "description": ""
32464           },
32465           {
32466             "group": "Body",
32467             "type": "String",
32468             "optional": true,
32469             "field": "musiconhold",
32470             "description": ""
32471           },
32472           {
32473             "group": "Body",
32474             "type": "String",
32475             "optional": true,
32476             "field": "announce",
32477             "description": ""
32478           },
32479           {
32480             "group": "Body",
32481             "type": "String",
32482             "allowedValues": [
32483               "\"rr\"",
32484               "\"ringall\"",
32485               "\"leastrecent\"",
32486               "\"fewestcalls\"",
32487               "\"random\"",
32488               "\"rrmemory\"",
32489               "\"linear\"",
32490               "\"wrandom\"",
32491               "\"rrordered\""
32492             ],
32493             "optional": false,
32494             "field": "strategy",
32495             "description": ""
32496           },
32497           {
32498             "group": "Body",
32499             "type": "Integer",
32500             "optional": true,
32501             "field": "servicelevel",
32502             "description": ""
32503           },
32504           {
32505             "group": "Body",
32506             "type": "String",
32507             "optional": true,
32508             "field": "context",
32509             "description": ""
32510           },
32511           {
32512             "group": "Body",
32513             "type": "Integer",
32514             "optional": true,
32515             "field": "penaltymemberslimit",
32516             "description": ""
32517           },
32518           {
32519             "group": "Body",
32520             "type": "Integer",
32521             "optional": true,
32522             "field": "timeout",
32523             "description": ""
32524           },
32525           {
32526             "group": "Body",
32527             "type": "Integer",
32528             "optional": true,
32529             "field": "retry",
32530             "description": ""
32531           },
32532           {
32533             "group": "Body",
32534             "type": "String",
32535             "optional": true,
32536             "field": "timeoutpriority",
32537             "description": ""
32538           },
32539           {
32540             "group": "Body",
32541             "type": "Integer",
32542             "optional": true,
32543             "field": "weight",
32544             "description": ""
32545           },
32546           {
32547             "group": "Body",
32548             "type": "Integer",
32549             "optional": true,
32550             "field": "wrapuptime",
32551             "description": ""
32552           },
32553           {
32554             "group": "Body",
32555             "type": "String",
32556             "allowedValues": [
32557               "\"yes\"",
32558               "\"no\""
32559             ],
32560             "optional": true,
32561             "field": "autofill",
32562             "description": ""
32563           },
32564           {
32565             "group": "Body",
32566             "type": "String",
32567             "allowedValues": [
32568               "\"yes\"",
32569               "\"no\"",
32570               "\"all\""
32571             ],
32572             "optional": true,
32573             "field": "autopause",
32574             "description": ""
32575           },
32576           {
32577             "group": "Body",
32578             "type": "Integer",
32579             "optional": true,
32580             "field": "autopausedelay",
32581             "description": ""
32582           },
32583           {
32584             "group": "Body",
32585             "type": "String",
32586             "allowedValues": [
32587               "\"yes\"",
32588               "\"no\""
32589             ],
32590             "optional": true,
32591             "field": "autopausebusy",
32592             "description": ""
32593           },
32594           {
32595             "group": "Body",
32596             "type": "String",
32597             "allowedValues": [
32598               "\"yes\"",
32599               "\"no\""
32600             ],
32601             "optional": true,
32602             "field": "autopauseunavail",
32603             "description": ""
32604           },
32605           {
32606             "group": "Body",
32607             "type": "Integer",
32608             "optional": true,
32609             "field": "maxlen",
32610             "description": ""
32611           },
32612           {
32613             "group": "Body",
32614             "type": "String",
32615             "allowedValues": [
32616               "\"yes\"",
32617               "\"no\""
32618             ],
32619             "optional": true,
32620             "field": "setinterfacevar",
32621             "description": ""
32622           },
32623           {
32624             "group": "Body",
32625             "type": "String",
32626             "allowedValues": [
32627               "\"yes\"",
32628               "\"no\""
32629             ],
32630             "optional": true,
32631             "field": "setqueueentryvar",
32632             "description": ""
32633           },
32634           {
32635             "group": "Body",
32636             "type": "String",
32637             "allowedValues": [
32638               "\"yes\"",
32639               "\"no\""
32640             ],
32641             "optional": true,
32642             "field": "setqueuevar",
32643             "description": ""
32644           },
32645           {
32646             "group": "Body",
32647             "type": "String",
32648             "allowedValues": [
32649               "\"yes\"",
32650               "\"no\""
32651             ],
32652             "optional": true,
32653             "field": "eventmemberstatus",
32654             "description": ""
32655           },
32656           {
32657             "group": "Body",
32658             "type": "String",
32659             "optional": true,
32660             "field": "membermacro",
32661             "description": ""
32662           },
32663           {
32664             "group": "Body",
32665             "type": "String",
32666             "optional": true,
32667             "field": "membergosub",
32668             "description": ""
32669           },
32670           {
32671             "group": "Body",
32672             "type": "Integer",
32673             "optional": true,
32674             "field": "announce_frequency",
32675             "description": ""
32676           },
32677           {
32678             "group": "Body",
32679             "type": "Integer",
32680             "optional": true,
32681             "field": "min_announce_frequency",
32682             "description": ""
32683           },
32684           {
32685             "group": "Body",
32686             "type": "Integer",
32687             "optional": true,
32688             "field": "periodic_announce_frequency",
32689             "description": ""
32690           },
32691           {
32692             "group": "Body",
32693             "type": "String",
32694             "allowedValues": [
32695               "\"yes\"",
32696               "\"no\""
32697             ],
32698             "optional": true,
32699             "field": "random_periodic_announce",
32700             "description": ""
32701           },
32702           {
32703             "group": "Body",
32704             "type": "String",
32705             "allowedValues": [
32706               "\"yes\"",
32707               "\"no\""
32708             ],
32709             "optional": true,
32710             "field": "relative_periodic_announce",
32711             "description": ""
32712           },
32713           {
32714             "group": "Body",
32715             "type": "String",
32716             "allowedValues": [
32717               "\"yes\"",
32718               "\"no\"",
32719               "\"once\""
32720             ],
32721             "optional": true,
32722             "field": "announce_holdtime",
32723             "description": ""
32724           },
32725           {
32726             "group": "Body",
32727             "type": "String",
32728             "optional": true,
32729             "field": "announce_position",
32730             "description": ""
32731           },
32732           {
32733             "group": "Body",
32734             "type": "String",
32735             "allowedValues": [
32736               "\"yes\"",
32737               "\"no\""
32738             ],
32739             "optional": true,
32740             "field": "announce_to_first_user",
32741             "description": ""
32742           },
32743           {
32744             "group": "Body",
32745             "type": "Integer",
32746             "optional": true,
32747             "field": "announce_position_limit",
32748             "description": ""
32749           },
32750           {
32751             "group": "Body",
32752             "type": "String",
32753             "allowedValues": [
32754               "\"0\"",
32755               "\"5\"",
32756               "\"10\"",
32757               "\"15\"",
32758               "\"20\"",
32759               "\"30\""
32760             ],
32761             "optional": true,
32762             "field": "announce_round_seconds",
32763             "description": ""
32764           },
32765           {
32766             "group": "Body",
32767             "type": "String",
32768             "optional": true,
32769             "field": "monitor_format",
32770             "description": ""
32771           },
32772           {
32773             "group": "Body",
32774             "type": "String",
32775             "optional": true,
32776             "field": "monitor_type",
32777             "description": ""
32778           },
32779           {
32780             "group": "Body",
32781             "type": "String",
32782             "optional": true,
32783             "field": "queue_youarenext",
32784             "description": ""
32785           },
32786           {
32787             "group": "Body",
32788             "type": "String",
32789             "optional": true,
32790             "field": "queue_thereare",
32791             "description": ""
32792           },
32793           {
32794             "group": "Body",
32795             "type": "String",
32796             "optional": true,
32797             "field": "queue_callswaiting",
32798             "description": ""
32799           },
32800           {
32801             "group": "Body",
32802             "type": "String",
32803             "optional": true,
32804             "field": "queue_holdtime",
32805             "description": ""
32806           },
32807           {
32808             "group": "Body",
32809             "type": "String",
32810             "optional": true,
32811             "field": "queue_minute",
32812             "description": ""
32813           },
32814           {
32815             "group": "Body",
32816             "type": "String",
32817             "optional": true,
32818             "field": "queue_minutes",
32819             "description": ""
32820           },
32821           {
32822             "group": "Body",
32823             "type": "String",
32824             "optional": true,
32825             "field": "queue_seconds",
32826             "description": ""
32827           },
32828           {
32829             "group": "Body",
32830             "type": "String",
32831             "optional": true,
32832             "field": "queue_thankyou",
32833             "description": ""
32834           },
32835           {
32836             "group": "Body",
32837             "type": "String",
32838             "optional": true,
32839             "field": "queue_reporthold",
32840             "description": ""
32841           },
32842           {
32843             "group": "Body",
32844             "type": "String",
32845             "optional": true,
32846             "field": "queue_quantity1",
32847             "description": ""
32848           },
32849           {
32850             "group": "Body",
32851             "type": "String",
32852             "optional": true,
32853             "field": "queue_quantity2",
32854             "description": ""
32855           },
32856           {
32857             "group": "Body",
32858             "type": "String",
32859             "optional": true,
32860             "field": "queue_periodic_announce",
32861             "description": ""
32862           },
32863           {
32864             "group": "Body",
32865             "type": "String",
32866             "optional": true,
32867             "field": "queue_less_than",
32868             "description": ""
32869           },
32870           {
32871             "group": "Body",
32872             "type": "Text",
32873             "optional": true,
32874             "field": "periodic_announce",
32875             "description": ""
32876           },
32877           {
32878             "group": "Body",
32879             "type": "String",
32880             "optional": true,
32881             "field": "joinempty",
32882             "description": ""
32883           },
32884           {
32885             "group": "Body",
32886             "type": "String",
32887             "optional": true,
32888             "field": "leavewhenempty",
32889             "description": ""
32890           },
32891           {
32892             "group": "Body",
32893             "type": "String",
32894             "allowedValues": [
32895               "\"yes\"",
32896               "\"no\""
32897             ],
32898             "optional": true,
32899             "field": "reportholdtime",
32900             "description": ""
32901           },
32902           {
32903             "group": "Body",
32904             "type": "String",
32905             "allowedValues": [
32906               "\"yes\"",
32907               "\"no\""
32908             ],
32909             "optional": true,
32910             "field": "ringinuse",
32911             "description": ""
32912           },
32913           {
32914             "group": "Body",
32915             "type": "Integer",
32916             "optional": true,
32917             "field": "memberdelay",
32918             "description": ""
32919           },
32920           {
32921             "group": "Body",
32922             "type": "String",
32923             "allowedValues": [
32924               "\"yes\"",
32925               "\"no\""
32926             ],
32927             "optional": true,
32928             "field": "timeoutrestart",
32929             "description": ""
32930           },
32931           {
32932             "group": "Body",
32933             "type": "String",
32934             "optional": true,
32935             "field": "defaultrule",
32936             "description": ""
32937           },
32938           {
32939             "group": "Body",
32940             "type": "String",
32941             "optional": true,
32942             "field": "description",
32943             "description": ""
32944           },
32945           {
32946             "group": "Body",
32947             "type": "Boolean",
32948             "optional": true,
32949             "field": "acw",
32950             "description": ""
32951           },
32952           {
32953             "group": "Body",
32954             "type": "Integer",
32955             "optional": true,
32956             "field": "acwTimeout",
32957             "description": ""
32958           },
32959           {
32960             "group": "Body",
32961             "type": "Boolean",
32962             "optional": true,
32963             "field": "dialActive",
32964             "description": "<p>Active/Disactive Campaign</p>"
32965           },
32966           {
32967             "group": "Body",
32968             "type": "String",
32969             "allowedValues": [
32970               "\"preview\"",
32971               "\"progressive\"",
32972               "\"power\"",
32973               "\"predictive\"",
32974               "\"booked\""
32975             ],
32976             "optional": true,
32977             "field": "dialMethod",
32978             "description": "<p>Dial Method.</p>"
32979           },
32980           {
32981             "group": "Body",
32982             "type": "Integer",
32983             "optional": true,
32984             "field": "dialLimitChannel",
32985             "description": "<p>Max 9999 channels, 0 means unlimited.</p>"
32986           },
32987           {
32988             "group": "Body",
32989             "type": "Integer",
32990             "optional": true,
32991             "field": "dialLimitQueue",
32992             "description": "<p>Max 9999 member in queue(min:1, max:9999), 0 means unlimited.</p>"
32993           },
32994           {
32995             "group": "Body",
32996             "type": "Float",
32997             "optional": true,
32998             "field": "dialPowerLevel",
32999             "description": "<p>Power Level: Calls for agents (min:1, max:10).</p>"
33000           },
33001           {
33002             "group": "Body",
33003             "type": "String",
33004             "allowedValues": [
33005               "\"agentBusyFactor\"",
33006               "\"dropRate\""
33007             ],
33008             "optional": true,
33009             "field": "dialPredictiveOptimization",
33010             "description": "<p>Only for predictive method.</p>"
33011           },
33012           {
33013             "group": "Body",
33014             "type": "Float",
33015             "optional": true,
33016             "field": "dialPredictiveOptimizationPercentage",
33017             "description": "<p>Predictive Optimization Percentage (min: 1, max: 95)</p>"
33018           },
33019           {
33020             "group": "Body",
33021             "type": "Integer",
33022             "optional": true,
33023             "field": "dialPredictiveInterval",
33024             "description": "<p>Interval Predictive Minutes (min:5 max:30)</p>"
33025           },
33026           {
33027             "group": "Body",
33028             "type": "String",
33029             "optional": true,
33030             "field": "dialOriginateCallerIdName",
33031             "description": ""
33032           },
33033           {
33034             "group": "Body",
33035             "type": "String",
33036             "optional": true,
33037             "field": "dialOriginateCallerIdNumber",
33038             "description": ""
33039           },
33040           {
33041             "group": "Body",
33042             "type": "Integer",
33043             "optional": true,
33044             "field": "dialOriginateTimeout",
33045             "description": "<p>Originate Timeout Seconds (min:1, max:999)</p>"
33046           },
33047           {
33048             "group": "Body",
33049             "type": "String",
33050             "optional": true,
33051             "field": "dialQueueOptions",
33052             "description": "<p>https://wiki.asterisk.org/wiki/display/AST/Asterisk+13+Application_Queue</p>"
33053           },
33054           {
33055             "group": "Body",
33056             "type": "Integer",
33057             "optional": true,
33058             "field": "dialQueueTimeout",
33059             "description": "<p>Queue Timeout Seconds (min:1, max:999)</p>"
33060           },
33061           {
33062             "group": "Body",
33063             "type": "String",
33064             "optional": true,
33065             "field": "dialQueueProject",
33066             "description": "<p>AGI queue option (use: agi://127.0.0.1/square,&lt;project_name&gt;)</p>"
33067           },
33068           {
33069             "group": "Body",
33070             "type": "Integer",
33071             "optional": true,
33072             "field": "dialCongestionMaxRetry",
33073             "description": "<p>#Congestion Retry (min:1, max:999)</p>"
33074           },
33075           {
33076             "group": "Body",
33077             "type": "Integer",
33078             "optional": true,
33079             "field": "dialCongestionRetryFrequency",
33080             "description": "<p>Congestion Retry Frequency Minutes (min:1, max:99999)</p>"
33081           },
33082           {
33083             "group": "Body",
33084             "type": "Integer",
33085             "optional": true,
33086             "field": "dialBusyMaxRetry",
33087             "description": "<p>#Busy Retry (min:1, max:999)</p>"
33088           },
33089           {
33090             "group": "Body",
33091             "type": "Integer",
33092             "optional": true,
33093             "field": "dialBusyRetryFrequency",
33094             "description": "<p>Busy Retry Frequency Minutes (min:1, max:99999)</p>"
33095           },
33096           {
33097             "group": "Body",
33098             "type": "Integer",
33099             "optional": true,
33100             "field": "dialNoAnswerMaxRetry",
33101             "description": "<p>#NoAnswer Retry (min:1, max:999)</p>"
33102           },
33103           {
33104             "group": "Body",
33105             "type": "Integer",
33106             "optional": true,
33107             "field": "dialNoAnswerRetryFrequency",
33108             "description": "<p>NoAnswer Retry Frequency Minutes (min:1, max:99999)</p>"
33109           },
33110           {
33111             "group": "Body",
33112             "type": "Integer",
33113             "optional": true,
33114             "field": "dialGlobalMaxRetry",
33115             "description": "<p>#Global Max Retry (min:1, max:999)</p>"
33116           },
33117           {
33118             "group": "Body",
33119             "type": "String",
33120             "optional": true,
33121             "field": "dialTimezone",
33122             "description": ""
33123           },
33124           {
33125             "group": "Body",
33126             "type": "String",
33127             "optional": true,
33128             "field": "dialGlobalInterval",
33129             "description": ""
33130           },
33131           {
33132             "group": "Body",
33133             "type": "String",
33134             "optional": true,
33135             "field": "dialPrefix",
33136             "description": ""
33137           },
33138           {
33139             "group": "Body",
33140             "type": "String",
33141             "allowedValues": [
33142               "\"always\"",
33143               "\"never\"",
33144               "\"onlyIfOpen\""
33145             ],
33146             "optional": true,
33147             "field": "dialCheckDuplicateType",
33148             "description": ""
33149           },
33150           {
33151             "group": "Body",
33152             "type": "Boolean",
33153             "optional": true,
33154             "field": "dialAMDActive",
33155             "description": "<p>Active/Disactive AMD</p>"
33156           },
33157           {
33158             "group": "Body",
33159             "type": "Integer",
33160             "optional": true,
33161             "field": "dialAMDInitialSilence",
33162             "description": "<p>#AMD Initial Silence</p>"
33163           },
33164           {
33165             "group": "Body",
33166             "type": "Integer",
33167             "optional": true,
33168             "field": "dialAMDGreeting",
33169             "description": "<p>#AMD Greeting</p>"
33170           },
33171           {
33172             "group": "Body",
33173             "type": "Integer",
33174             "optional": true,
33175             "field": "dialAMDAfterGreetingSilence",
33176             "description": "<p>#AMD After Greeting Silence</p>"
33177           },
33178           {
33179             "group": "Body",
33180             "type": "Integer",
33181             "optional": true,
33182             "field": "dialAMDTotalAnalysisTime",
33183             "description": "<p>#AMD Total Analysis Time</p>"
33184           },
33185           {
33186             "group": "Body",
33187             "type": "Integer",
33188             "optional": true,
33189             "field": "dialAMDMinWordLength",
33190             "description": "<p>#AMD Min Word Length</p>"
33191           },
33192           {
33193             "group": "Body",
33194             "type": "Integer",
33195             "optional": true,
33196             "field": "dialAMDBetweenWordsSilence",
33197             "description": "<p>#AMD Between Words Silence</p>"
33198           },
33199           {
33200             "group": "Body",
33201             "type": "Integer",
33202             "optional": true,
33203             "field": "dialAMDMaximumNumberOfWords",
33204             "description": "<p>#AMD Maximum Number Of Words</p>"
33205           },
33206           {
33207             "group": "Body",
33208             "type": "Integer",
33209             "optional": true,
33210             "field": "dialAMDSilenceThreshold",
33211             "description": "<p>#AMD Silence Threshold (min:0, max:32767)</p>"
33212           },
33213           {
33214             "group": "Body",
33215             "type": "Integer",
33216             "optional": true,
33217             "field": "dialAMDMaximumWordLength",
33218             "description": "<p>#AMD Maximum Word Length</p>"
33219           },
33220           {
33221             "group": "Body",
33222             "type": "Integer",
33223             "optional": true,
33224             "field": "dialRecallMeTimeout",
33225             "description": "<p>#RecallMe Timeout (min:1)</p>"
33226           },
33227           {
33228             "group": "Body",
33229             "type": "Boolean",
33230             "optional": true,
33231             "field": "dialRecallInQueue",
33232             "description": "<p>Active/Disactive Recall In Queue</p>"
33233           },
33234           {
33235             "group": "Body",
33236             "type": "String",
33237             "allowedValues": [
33238               "\"DESC\"",
33239               "\"ASC\""
33240             ],
33241             "optional": true,
33242             "field": "dialOrderByScheduledAt",
33243             "description": ""
33244           },
33245           {
33246             "group": "Body",
33247             "type": "String",
33248             "optional": true,
33249             "field": "dialQueueProject2",
33250             "description": "<p>AGI queue option (use: agi://127.0.0.1/square,&lt;project_name&gt;)</p>"
33251           },
33252           {
33253             "group": "Body",
33254             "type": "Boolean",
33255             "optional": true,
33256             "field": "dialAgiAfterHangupClient",
33257             "description": ""
33258           },
33259           {
33260             "group": "Body",
33261             "type": "Boolean",
33262             "optional": true,
33263             "field": "dialAgiAfterHangupAgent",
33264             "description": ""
33265           },
33266           {
33267             "group": "Body",
33268             "type": "Integer",
33269             "optional": true,
33270             "field": "dialRandomLastDigitCallerIdNumber",
33271             "description": "<p>Random Last Digit (min:1, max:15)</p>"
33272           },
33273           {
33274             "group": "Body",
33275             "type": "Integer",
33276             "optional": true,
33277             "field": "dialCutDigit",
33278             "description": "<p>Cut Digit (min:1, max:15)</p>"
33279           },
33280           {
33281             "group": "Body",
33282             "type": "Integer",
33283             "optional": true,
33284             "field": "dialNoSuchNumberMaxRetry",
33285             "description": "<p>#NoSuchNumber Retry (min:1, max:999)</p>"
33286           },
33287           {
33288             "group": "Body",
33289             "type": "Integer",
33290             "optional": true,
33291             "field": "dialNoSuchNumberRetryFrequency",
33292             "description": "<p>NoSuchNumber Retry Frequency Minutes (min:1, max:99999)</p>"
33293           },
33294           {
33295             "group": "Body",
33296             "type": "Integer",
33297             "optional": true,
33298             "field": "dialDropMaxRetry",
33299             "description": "<p>#Drop Retry (min:1, max:999)</p>"
33300           },
33301           {
33302             "group": "Body",
33303             "type": "Integer",
33304             "optional": true,
33305             "field": "dialDropRetryFrequency",
33306             "description": "<p>Drop Retry Frequency Minutes (min:1, max:99999)</p>"
33307           },
33308           {
33309             "group": "Body",
33310             "type": "Integer",
33311             "optional": true,
33312             "field": "dialAbandonedMaxRetry",
33313             "description": "<p>#Abandoned Retry (min:1, max:999)</p>"
33314           },
33315           {
33316             "group": "Body",
33317             "type": "Integer",
33318             "optional": true,
33319             "field": "dialAbandonedRetryFrequency",
33320             "description": "<p>Abandoned Retry Frequency Minutes (min:1, max:99999)</p>"
33321           },
33322           {
33323             "group": "Body",
33324             "type": "Integer",
33325             "optional": true,
33326             "field": "dialMachineMaxRetry",
33327             "description": "<p>#Machine Retry (min:1, max:999)</p>"
33328           },
33329           {
33330             "group": "Body",
33331             "type": "Integer",
33332             "optional": true,
33333             "field": "dialMachineRetryFrequency",
33334             "description": "<p>Machine Retry Frequency Minutes (min:1, max:99999)</p>"
33335           },
33336           {
33337             "group": "Body",
33338             "type": "Integer",
33339             "optional": true,
33340             "field": "dialAgentRejectMaxRetry",
33341             "description": "<p>#AgentReject Retry (min:1, max:999)</p>"
33342           },
33343           {
33344             "group": "Body",
33345             "type": "Integer",
33346             "optional": true,
33347             "field": "dialAgentRejectRetryFrequency",
33348             "description": "<p>AgentReject Retry Frequency Minutes (min:1, max:99999)</p>"
33349           },
33350           {
33351             "group": "Body",
33352             "type": "Integer",
33353             "optional": true,
33354             "field": "mandatoryDispositionPauseId",
33355             "description": "<p>Status to put when mandatory disposition is enabled</p>"
33356           },
33357           {
33358             "group": "Body",
33359             "type": "Boolean",
33360             "optional": true,
33361             "field": "mandatoryDisposition",
33362             "description": "<p>Enabled/disables mandatory dispo on a queue</p>"
33363           },
33364           {
33365             "group": "Body",
33366             "type": "Integer",
33367             "optional": true,
33368             "field": "dialPredictiveIntervalMaxThreshold",
33369             "description": ""
33370           },
33371           {
33372             "group": "Body",
33373             "type": "Integer",
33374             "optional": true,
33375             "field": "dialPredictiveIntervalMinThreshold",
33376             "description": ""
33377           },
33378           {
33379             "group": "Body",
33380             "type": "Boolean",
33381             "optional": true,
33382             "field": "dialPreviewAutoRecallMe",
33383             "description": ""
33384           }
33385         ]
33386       }
33387     },
33388     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33389     "version": "0.0.0",
33390     "filename": "server/api/voiceQueue/index.js",
33391     "groupTitle": "Voice_Queues"
33392   },
33393   {
33394     "type": "delete",
33395     "url": "/api/voice/queues/{id}",
33396     "title": "Deletes a Queue",
33397     "examples": [
33398       {
33399         "title": "Example usage:",
33400         "content": "curl https://{domain}/api/voice/queues/{id} -v -u {name}:{password} -X DELETE",
33401         "type": "json"
33402       }
33403     ],
33404     "name": "DeleteQueues",
33405     "group": "Voice_Queues",
33406     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33407     "version": "0.0.0",
33408     "filename": "server/api/voiceQueue/index.js",
33409     "groupTitle": "Voice_Queues"
33410   },
33411   {
33412     "type": "get",
33413     "url": "/api/voice/queues/{id}/users",
33414     "title": "Gets queue agents",
33415     "examples": [
33416       {
33417         "title": "Example usage:",
33418         "content": "curl https://{domain}/api/voice/queues/{id}/users -v -u {name}:{password} -X GET",
33419         "type": "json"
33420       }
33421     ],
33422     "name": "GetAgents",
33423     "group": "Voice_Queues",
33424     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33425     "version": "0.0.0",
33426     "filename": "server/api/voiceQueue/index.js",
33427     "groupTitle": "Voice_Queues"
33428   },
33429   {
33430     "type": "get",
33431     "url": "/api/voice/queues/{id}/blacklists",
33432     "title": "Get queue blacklists",
33433     "examples": [
33434       {
33435         "title": "Example usage:",
33436         "content": "curl https://{domain}/api/voice/queues/{id}/blacklists -v -u {name}:{password} -X GET",
33437         "type": "json"
33438       }
33439     ],
33440     "name": "GetBlackLists",
33441     "group": "Voice_Queues",
33442     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33443     "version": "0.0.0",
33444     "filename": "server/api/voiceQueue/index.js",
33445     "groupTitle": "Voice_Queues"
33446   },
33447   {
33448     "type": "get",
33449     "url": "/api/voice/queues/{id}/finals",
33450     "title": "Gets queue hopper finals",
33451     "examples": [
33452       {
33453         "title": "Example usage:",
33454         "content": "curl https://{domain}/api/voice/queues/{id}/hopper_finals -v -u {name}:{password}  -X GET",
33455         "type": "json"
33456       }
33457     ],
33458     "name": "GetHopperFinals",
33459     "group": "Voice_Queues",
33460     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33461     "version": "0.0.0",
33462     "filename": "server/api/voiceQueue/index.js",
33463     "groupTitle": "Voice_Queues"
33464   },
33465   {
33466     "type": "get",
33467     "url": "/api/voice/queues/{id}/hopper_histories",
33468     "title": "Gets queue hopper histories",
33469     "examples": [
33470       {
33471         "title": "Example usage:",
33472         "content": "curl https://{domain}/api/voice/queues/{id}/hopper_histories -v -u {name}:{password} -X GET",
33473         "type": "json"
33474       }
33475     ],
33476     "name": "GetHopperHistories",
33477     "group": "Voice_Queues",
33478     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33479     "version": "0.0.0",
33480     "filename": "server/api/voiceQueue/index.js",
33481     "groupTitle": "Voice_Queues"
33482   },
33483   {
33484     "type": "get",
33485     "url": "/api/voice/queues/{id}/hoppers",
33486     "title": "Gets queue hoppers",
33487     "examples": [
33488       {
33489         "title": "Example usage:",
33490         "content": "curl https://{domain}/api/voice/queues/{id}/hoppers -v -u {name}:{password} -X GET",
33491         "type": "json"
33492       }
33493     ],
33494     "name": "GetHoppers",
33495     "group": "Voice_Queues",
33496     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33497     "version": "0.0.0",
33498     "filename": "server/api/voiceQueue/index.js",
33499     "groupTitle": "Voice_Queues"
33500   },
33501   {
33502     "type": "get",
33503     "url": "/api/voice/queues/{id}/lists",
33504     "title": "Get queue lists",
33505     "examples": [
33506       {
33507         "title": "Example usage:",
33508         "content": "curl https://{domain}/api/voice/queues/{id}/lists -v -u {name}:{password} -X GET",
33509         "type": "json"
33510       }
33511     ],
33512     "name": "GetLists",
33513     "group": "Voice_Queues",
33514     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33515     "version": "0.0.0",
33516     "filename": "server/api/voiceQueue/index.js",
33517     "groupTitle": "Voice_Queues"
33518   },
33519   {
33520     "type": "get",
33521     "url": "/api/voice/queues/{id}/members",
33522     "title": "Gets queue members",
33523     "examples": [
33524       {
33525         "title": "Example usage:",
33526         "content": "curl https://{domain}/api/voice/queues/{id}/members -v -u {name}:{password} -X GET",
33527         "type": "json"
33528       }
33529     ],
33530     "name": "GetMembers",
33531     "group": "Voice_Queues",
33532     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33533     "version": "0.0.0",
33534     "filename": "server/api/voiceQueue/index.js",
33535     "groupTitle": "Voice_Queues"
33536   },
33537   {
33538     "type": "get",
33539     "url": "/api/voice/queues",
33540     "title": "Gets a list of Queues",
33541     "examples": [
33542       {
33543         "title": "Example usage:",
33544         "content": "curl https://{domain}/api/voice/queues -v -u {name}:{password}",
33545         "type": "json"
33546       }
33547     ],
33548     "name": "GetQueues",
33549     "group": "Voice_Queues",
33550     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
33551     "version": "0.0.0",
33552     "filename": "server/api/voiceQueue/index.js",
33553     "groupTitle": "Voice_Queues"
33554   },
33555   {
33556     "type": "get",
33557     "url": "/api/voice/queues/{id}/teams",
33558     "title": "Gets queue team",
33559     "examples": [
33560       {
33561         "title": "Example usage:",
33562         "content": "curl https://{domain}/api/voice/queues/{id}/teams -v -u {name}:{password}  -X GET",
33563         "type": "json"
33564       }
33565     ],
33566     "name": "GetTeams",
33567     "group": "Voice_Queues",
33568     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33569     "version": "0.0.0",
33570     "filename": "server/api/voiceQueue/index.js",
33571     "groupTitle": "Voice_Queues"
33572   },
33573   {
33574     "type": "delete",
33575     "url": "/api/voice/queues/{id}/users",
33576     "title": "Removes agents from a queue",
33577     "examples": [
33578       {
33579         "title": "Example usage:",
33580         "content": "curl https://{domain}/api/voice/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
33581         "type": "json"
33582       }
33583     ],
33584     "name": "RemoveAgents",
33585     "group": "Voice_Queues",
33586     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33587     "version": "0.0.0",
33588     "filename": "server/api/voiceQueue/index.js",
33589     "groupTitle": "Voice_Queues"
33590   },
33591   {
33592     "type": "delete",
33593     "url": "/api/voice/queues/{id}/blacklists",
33594     "title": "Remove blacklists from a queue",
33595     "examples": [
33596       {
33597         "title": "Example usage:",
33598         "content": "curl https://{domain}/api/voice/queues/{id}/blacklists?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
33599         "type": "json"
33600       }
33601     ],
33602     "name": "RemoveBlackLists",
33603     "group": "Voice_Queues",
33604     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33605     "version": "0.0.0",
33606     "filename": "server/api/voiceQueue/index.js",
33607     "groupTitle": "Voice_Queues"
33608   },
33609   {
33610     "type": "delete",
33611     "url": "/api/voice/queues/{id}/lists",
33612     "title": "Remove lists from a queue",
33613     "examples": [
33614       {
33615         "title": "Example usage:",
33616         "content": "curl https://{domain}/api/voice/queues/{id}/lists?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
33617         "type": "json"
33618       }
33619     ],
33620     "name": "RemoveLists",
33621     "group": "Voice_Queues",
33622     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33623     "version": "0.0.0",
33624     "filename": "server/api/voiceQueue/index.js",
33625     "groupTitle": "Voice_Queues"
33626   },
33627   {
33628     "type": "get",
33629     "url": "/api/voice/queues/{id}",
33630     "title": "Gets a single Queue",
33631     "examples": [
33632       {
33633         "title": "Example usage:",
33634         "content": "curl https://{domain}/api/voice/queues/{id} -v -u {name}:{password}",
33635         "type": "json"
33636       }
33637     ],
33638     "name": "ShowQueues",
33639     "group": "Voice_Queues",
33640     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33641     "version": "0.0.0",
33642     "filename": "server/api/voiceQueue/index.js",
33643     "groupTitle": "Voice_Queues"
33644   },
33645   {
33646     "type": "get",
33647     "url": "/api/voice/queues/{id}/blacks",
33648     "title": "Gets queue hopper blacks",
33649     "examples": [
33650       {
33651         "title": "Example usage:",
33652         "content": "curl https://{domain}/api/voice/queues/{id}/hopper_black -v -u {name}:{password}  -X GET",
33653         "type": "json"
33654       }
33655     ],
33656     "name": "getHopperBlacks",
33657     "group": "Voice_Queues",
33658     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33659     "version": "0.0.0",
33660     "filename": "server/api/voiceQueue/index.js",
33661     "groupTitle": "Voice_Queues"
33662   },
33663   {
33664     "type": "put",
33665     "url": "/api/voice/queues/{id}",
33666     "title": "Update an existing Queue",
33667     "examples": [
33668       {
33669         "title": "Example usage:",
33670         "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",
33671         "type": "json"
33672       }
33673     ],
33674     "name": "updateQueues",
33675     "group": "Voice_Queues",
33676     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33677     "version": "0.0.0",
33678     "filename": "server/api/voiceQueue/index.js",
33679     "groupTitle": "Voice_Queues"
33680   },
33681   {
33682     "type": "post",
33683     "url": "/api/voice/recordings",
33684     "title": "Creates a new Recording",
33685     "examples": [
33686       {
33687         "title": "Example usage:",
33688         "content": "curl https://{domain}/api/voice/recordings -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
33689         "type": "json"
33690       }
33691     ],
33692     "name": "CreateRecordings",
33693     "group": "Voice_Recordings",
33694     "parameter": {
33695       "fields": {
33696         "Body": [
33697           {
33698             "group": "Body",
33699             "type": "Virtual",
33700             "optional": true,
33701             "field": "format",
33702             "description": ""
33703           },
33704           {
33705             "group": "Body",
33706             "type": "String",
33707             "optional": true,
33708             "field": "uniqueid",
33709             "description": ""
33710           },
33711           {
33712             "group": "Body",
33713             "type": "String",
33714             "optional": true,
33715             "field": "channel",
33716             "description": ""
33717           },
33718           {
33719             "group": "Body",
33720             "type": "String",
33721             "optional": true,
33722             "field": "membername",
33723             "description": ""
33724           },
33725           {
33726             "group": "Body",
33727             "type": "String",
33728             "optional": true,
33729             "field": "calleridnum",
33730             "description": ""
33731           },
33732           {
33733             "group": "Body",
33734             "type": "String",
33735             "optional": true,
33736             "field": "calleridname",
33737             "description": ""
33738           },
33739           {
33740             "group": "Body",
33741             "type": "String",
33742             "optional": true,
33743             "field": "connectedlinenum",
33744             "description": ""
33745           },
33746           {
33747             "group": "Body",
33748             "type": "String",
33749             "optional": true,
33750             "field": "connectedlinename",
33751             "description": ""
33752           },
33753           {
33754             "group": "Body",
33755             "type": "String",
33756             "optional": true,
33757             "field": "accountcode",
33758             "description": ""
33759           },
33760           {
33761             "group": "Body",
33762             "type": "String",
33763             "optional": true,
33764             "field": "context",
33765             "description": ""
33766           },
33767           {
33768             "group": "Body",
33769             "type": "String",
33770             "optional": true,
33771             "field": "exten",
33772             "description": ""
33773           },
33774           {
33775             "group": "Body",
33776             "type": "String",
33777             "optional": true,
33778             "field": "value",
33779             "description": ""
33780           },
33781           {
33782             "group": "Body",
33783             "type": "String",
33784             "optional": true,
33785             "field": "type",
33786             "description": ""
33787           },
33788           {
33789             "group": "Body",
33790             "type": "Integer",
33791             "optional": true,
33792             "field": "rating",
33793             "description": ""
33794           },
33795           {
33796             "group": "Body",
33797             "type": "String",
33798             "optional": true,
33799             "field": "queue",
33800             "description": ""
33801           },
33802           {
33803             "group": "Body",
33804             "type": "String",
33805             "optional": true,
33806             "field": "userDisposition",
33807             "description": ""
33808           },
33809           {
33810             "group": "Body",
33811             "type": "String",
33812             "optional": true,
33813             "field": "userSecondDisposition",
33814             "description": ""
33815           },
33816           {
33817             "group": "Body",
33818             "type": "String",
33819             "optional": true,
33820             "field": "userThirdDisposition",
33821             "description": ""
33822           },
33823           {
33824             "group": "Body",
33825             "type": "Text",
33826             "optional": true,
33827             "field": "location",
33828             "description": ""
33829           },
33830           {
33831             "group": "Body",
33832             "type": "String",
33833             "optional": true,
33834             "field": "transcribeName",
33835             "description": ""
33836           },
33837           {
33838             "group": "Body",
33839             "type": "String",
33840             "optional": true,
33841             "field": "transcribeStatus",
33842             "description": ""
33843           },
33844           {
33845             "group": "Body",
33846             "type": "Text",
33847             "optional": true,
33848             "field": "fileUri",
33849             "description": ""
33850           },
33851           {
33852             "group": "Body",
33853             "type": "Text",
33854             "optional": true,
33855             "field": "fileText",
33856             "description": ""
33857           },
33858           {
33859             "group": "Body",
33860             "type": "Text",
33861             "optional": true,
33862             "field": "failureReason",
33863             "description": ""
33864           },
33865           {
33866             "group": "Body",
33867             "type": "String",
33868             "optional": true,
33869             "field": "sentiment",
33870             "description": ""
33871           },
33872           {
33873             "group": "Body",
33874             "type": "Float",
33875             "optional": true,
33876             "field": "sPositive",
33877             "description": ""
33878           },
33879           {
33880             "group": "Body",
33881             "type": "Float",
33882             "optional": true,
33883             "field": "sNegative",
33884             "description": ""
33885           },
33886           {
33887             "group": "Body",
33888             "type": "Float",
33889             "optional": true,
33890             "field": "sNeutral",
33891             "description": ""
33892           },
33893           {
33894             "group": "Body",
33895             "type": "Float",
33896             "optional": true,
33897             "field": "sMixed",
33898             "description": ""
33899           },
33900           {
33901             "group": "Body",
33902             "type": "Boolean",
33903             "optional": true,
33904             "field": "tempSentiment",
33905             "description": ""
33906           },
33907           {
33908             "group": "Body",
33909             "type": "String",
33910             "optional": true,
33911             "field": "createdAt",
33912             "description": ""
33913           },
33914           {
33915             "group": "Body",
33916             "type": "String",
33917             "optional": true,
33918             "field": "updatedAt",
33919             "description": ""
33920           }
33921         ]
33922       }
33923     },
33924     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33925     "version": "0.0.0",
33926     "filename": "server/api/voiceRecording/index.js",
33927     "groupTitle": "Voice_Recordings"
33928   },
33929   {
33930     "type": "get",
33931     "url": "/api/voice/recordings/describe",
33932     "title": "Gets table info about Recordings",
33933     "examples": [
33934       {
33935         "title": "Example usage:",
33936         "content": "curl https://{domain}/api/voice/recordings/describe -v -u {name}:{password}",
33937         "type": "json"
33938       }
33939     ],
33940     "name": "DescribeRecordings",
33941     "group": "Voice_Recordings",
33942     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33943     "version": "0.0.0",
33944     "filename": "server/api/voiceRecording/index.js",
33945     "groupTitle": "Voice_Recordings"
33946   },
33947   {
33948     "type": "get",
33949     "url": "/api/voice/recordings",
33950     "title": "Gets a list of Recordings",
33951     "examples": [
33952       {
33953         "title": "Example usage:",
33954         "content": "curl https://{domain}/api/voice/recordings -v -u {name}:{password}",
33955         "type": "json"
33956       }
33957     ],
33958     "name": "GetRecordings",
33959     "group": "Voice_Recordings",
33960     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
33961     "version": "0.0.0",
33962     "filename": "server/api/voiceRecording/index.js",
33963     "groupTitle": "Voice_Recordings"
33964   },
33965   {
33966     "type": "get",
33967     "url": "/api/voice/recordings/{id}",
33968     "title": "Gets a single Recording",
33969     "examples": [
33970       {
33971         "title": "Example usage:",
33972         "content": "curl https://{domain}/api/voice/recordings/{id} -v -u {name}:{password}",
33973         "type": "json"
33974       }
33975     ],
33976     "name": "ShowRecordings",
33977     "group": "Voice_Recordings",
33978     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33979     "version": "0.0.0",
33980     "filename": "server/api/voiceRecording/index.js",
33981     "groupTitle": "Voice_Recordings"
33982   },
33983   {
33984     "type": "delete",
33985     "url": "/api/voice/recordings/{id}",
33986     "title": "Delete voice recording",
33987     "examples": [
33988       {
33989         "title": "Example usage:",
33990         "content": "curl https://{domain}/api/voice/recordings/{id} -v -u {name}:{password} -X DELETE",
33991         "type": "json"
33992       }
33993     ],
33994     "name": "destroy",
33995     "group": "Voice_Recordings",
33996     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33997     "version": "0.0.0",
33998     "filename": "server/api/voiceRecording/index.js",
33999     "groupTitle": "Voice_Recordings"
34000   },
34001   {
34002     "type": "get",
34003     "url": "/api/voice/recordings/{id}/download",
34004     "title": "Download Recording",
34005     "examples": [
34006       {
34007         "title": "Example usage:",
34008         "content": "curl https://{domain}/api/voice/recordings/{id}/download -v -u {name}:{password} -X GET",
34009         "type": "json"
34010       }
34011     ],
34012     "name": "download",
34013     "group": "Voice_Recordings",
34014     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34015     "version": "0.0.0",
34016     "filename": "server/api/voiceRecording/index.js",
34017     "groupTitle": "Voice_Recordings"
34018   },
34019   {
34020     "type": "get",
34021     "url": "/api/voice/recordings/{id}/downloads",
34022     "title": "Download Recording",
34023     "examples": [
34024       {
34025         "title": "Example usage:",
34026         "content": "curl https://{domain}/api/voice/recordings/{id}/downloads -v -u {name}:{password} -X GET",
34027         "type": "json"
34028       }
34029     ],
34030     "name": "downloads",
34031     "group": "Voice_Recordings",
34032     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34033     "version": "0.0.0",
34034     "filename": "server/api/voiceRecording/index.js",
34035     "groupTitle": "Voice_Recordings"
34036   },
34037   {
34038     "type": "get",
34039     "url": "/api/voice/recordings/{id}/transcribe",
34040     "title": "Run Transcribe Recording",
34041     "examples": [
34042       {
34043         "title": "Example usage:",
34044         "content": "curl https://{domain}/api/voice/recordings/{id}/transcribe -v -u {name}:{password} -X GET",
34045         "type": "json"
34046       }
34047     ],
34048     "name": "transcribe",
34049     "group": "Voice_Recordings",
34050     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34051     "version": "0.0.0",
34052     "filename": "server/api/voiceRecording/index.js",
34053     "groupTitle": "Voice_Recordings"
34054   },
34055   {
34056     "type": "post",
34057     "url": "/api/voice/recordings/{id}/transcribe",
34058     "title": "Run Transcribe Recording",
34059     "examples": [
34060       {
34061         "title": "Example usage:",
34062         "content": "curl https://{domain}/api/voice/recordings/{id}/transcribe -d '{\"runSentiment\": \"true\"}' -v -u {name}:{password} -X POST",
34063         "type": "json"
34064       }
34065     ],
34066     "name": "transcribe",
34067     "group": "Voice_Recordings",
34068     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34069     "version": "0.0.0",
34070     "filename": "server/api/voiceRecording/index.js",
34071     "groupTitle": "Voice_Recordings"
34072   },
34073   {
34074     "type": "put",
34075     "url": "/api/voice/recordings/{id}",
34076     "title": "Update an existing Recording",
34077     "examples": [
34078       {
34079         "title": "Example usage:",
34080         "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",
34081         "type": "json"
34082       }
34083     ],
34084     "name": "updateRecordings",
34085     "group": "Voice_Recordings",
34086     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34087     "version": "0.0.0",
34088     "filename": "server/api/voiceRecording/index.js",
34089     "groupTitle": "Voice_Recordings"
34090   },
34091   {
34092     "type": "post",
34093     "url": "/api/voice/transfers/reports",
34094     "title": "Creates a new Transfer Report",
34095     "examples": [
34096       {
34097         "title": "Example usage:",
34098         "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",
34099         "type": "json"
34100       }
34101     ],
34102     "name": "CreateTransfer_Reports",
34103     "group": "Voice_Transfer_Reports",
34104     "parameter": {
34105       "fields": {
34106         "Body": [
34107           {
34108             "group": "Body",
34109             "type": "String",
34110             "allowedValues": [
34111               "\"blind\"",
34112               "\"attended\""
34113             ],
34114             "optional": true,
34115             "field": "type",
34116             "description": ""
34117           },
34118           {
34119             "group": "Body",
34120             "type": "String",
34121             "optional": true,
34122             "field": "result",
34123             "description": ""
34124           },
34125           {
34126             "group": "Body",
34127             "type": "String",
34128             "optional": true,
34129             "field": "transfererchannel",
34130             "description": ""
34131           },
34132           {
34133             "group": "Body",
34134             "type": "String",
34135             "optional": true,
34136             "field": "transferercalleridnum",
34137             "description": ""
34138           },
34139           {
34140             "group": "Body",
34141             "type": "String",
34142             "optional": true,
34143             "field": "transferercalleridname",
34144             "description": ""
34145           },
34146           {
34147             "group": "Body",
34148             "type": "String",
34149             "optional": true,
34150             "field": "transfererconnectedlinenum",
34151             "description": ""
34152           },
34153           {
34154             "group": "Body",
34155             "type": "String",
34156             "optional": true,
34157             "field": "transfererconnectedlinename",
34158             "description": ""
34159           },
34160           {
34161             "group": "Body",
34162             "type": "String",
34163             "optional": true,
34164             "field": "transfereraccountcode",
34165             "description": ""
34166           },
34167           {
34168             "group": "Body",
34169             "type": "String",
34170             "optional": true,
34171             "field": "transferercontext",
34172             "description": ""
34173           },
34174           {
34175             "group": "Body",
34176             "type": "String",
34177             "optional": true,
34178             "field": "transfererexten",
34179             "description": ""
34180           },
34181           {
34182             "group": "Body",
34183             "type": "String",
34184             "optional": true,
34185             "field": "transfererlinkedid",
34186             "description": ""
34187           },
34188           {
34189             "group": "Body",
34190             "type": "String",
34191             "optional": true,
34192             "field": "transfereechannel",
34193             "description": ""
34194           },
34195           {
34196             "group": "Body",
34197             "type": "String",
34198             "optional": true,
34199             "field": "transfereecalleridnum",
34200             "description": ""
34201           },
34202           {
34203             "group": "Body",
34204             "type": "String",
34205             "optional": true,
34206             "field": "transfereecalleridname",
34207             "description": ""
34208           },
34209           {
34210             "group": "Body",
34211             "type": "String",
34212             "optional": true,
34213             "field": "transfereeconnectedlinenum",
34214             "description": ""
34215           },
34216           {
34217             "group": "Body",
34218             "type": "String",
34219             "optional": true,
34220             "field": "transfereeconnectedlinename",
34221             "description": ""
34222           },
34223           {
34224             "group": "Body",
34225             "type": "String",
34226             "optional": true,
34227             "field": "transfereeaccountcode",
34228             "description": ""
34229           },
34230           {
34231             "group": "Body",
34232             "type": "String",
34233             "optional": true,
34234             "field": "transfereecontext",
34235             "description": ""
34236           },
34237           {
34238             "group": "Body",
34239             "type": "String",
34240             "optional": true,
34241             "field": "transfereeexten",
34242             "description": ""
34243           },
34244           {
34245             "group": "Body",
34246             "type": "String",
34247             "optional": true,
34248             "field": "transfereelinkedid",
34249             "description": ""
34250           },
34251           {
34252             "group": "Body",
34253             "type": "String",
34254             "allowedValues": [
34255               "\"Yes\"",
34256               "\"No\""
34257             ],
34258             "optional": true,
34259             "field": "isexternal",
34260             "description": ""
34261           },
34262           {
34263             "group": "Body",
34264             "type": "String",
34265             "optional": true,
34266             "field": "context",
34267             "description": ""
34268           },
34269           {
34270             "group": "Body",
34271             "type": "String",
34272             "optional": true,
34273             "field": "extension",
34274             "description": ""
34275           }
34276         ]
34277       }
34278     },
34279     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34280     "version": "0.0.0",
34281     "filename": "server/api/voiceTransferReport/index.js",
34282     "groupTitle": "Voice_Transfer_Reports"
34283   },
34284   {
34285     "type": "delete",
34286     "url": "/api/voice/transfers/reports/{id}",
34287     "title": "Deletes a Transfer Report",
34288     "examples": [
34289       {
34290         "title": "Example usage:",
34291         "content": "curl https://{domain}/api/voice/transfers/reports/{id} -v -u {name}:{password} -X DELETE",
34292         "type": "json"
34293       }
34294     ],
34295     "name": "DeleteTransfer_Reports",
34296     "group": "Voice_Transfer_Reports",
34297     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34298     "version": "0.0.0",
34299     "filename": "server/api/voiceTransferReport/index.js",
34300     "groupTitle": "Voice_Transfer_Reports"
34301   },
34302   {
34303     "type": "get",
34304     "url": "/api/voice/transfers/reports/describe",
34305     "title": "Gets table info about Transfer Reports",
34306     "examples": [
34307       {
34308         "title": "Example usage:",
34309         "content": "curl https://{domain}/api/voice/transfers/reports/describe -v -u {name}:{password}",
34310         "type": "json"
34311       }
34312     ],
34313     "name": "DescribeTransfer_Reports",
34314     "group": "Voice_Transfer_Reports",
34315     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34316     "version": "0.0.0",
34317     "filename": "server/api/voiceTransferReport/index.js",
34318     "groupTitle": "Voice_Transfer_Reports"
34319   },
34320   {
34321     "type": "get",
34322     "url": "/api/voice/transfers/reports",
34323     "title": "Gets a list of Transfer Reports",
34324     "examples": [
34325       {
34326         "title": "Example usage:",
34327         "content": "curl https://{domain}/api/voice/transfers/reports -v -u {name}:{password}",
34328         "type": "json"
34329       }
34330     ],
34331     "name": "GetTransfer_Reports",
34332     "group": "Voice_Transfer_Reports",
34333     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
34334     "version": "0.0.0",
34335     "filename": "server/api/voiceTransferReport/index.js",
34336     "groupTitle": "Voice_Transfer_Reports"
34337   },
34338   {
34339     "type": "get",
34340     "url": "/api/voice/transfers/reports/{id}",
34341     "title": "Gets a single Transfer Report",
34342     "examples": [
34343       {
34344         "title": "Example usage:",
34345         "content": "curl https://{domain}/api/voice/transfers/reports/{id} -v -u {name}:{password}",
34346         "type": "json"
34347       }
34348     ],
34349     "name": "ShowTransfer_Reports",
34350     "group": "Voice_Transfer_Reports",
34351     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34352     "version": "0.0.0",
34353     "filename": "server/api/voiceTransferReport/index.js",
34354     "groupTitle": "Voice_Transfer_Reports"
34355   },
34356   {
34357     "type": "put",
34358     "url": "/api/voice/transfers/reports/{id}",
34359     "title": "Update an existing Transfer Report",
34360     "examples": [
34361       {
34362         "title": "Example usage:",
34363         "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",
34364         "type": "json"
34365       }
34366     ],
34367     "name": "updateTransfer_Reports",
34368     "group": "Voice_Transfer_Reports",
34369     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34370     "version": "0.0.0",
34371     "filename": "server/api/voiceTransferReport/index.js",
34372     "groupTitle": "Voice_Transfer_Reports"
34373   },
34374   {
34375     "type": "post",
34376     "url": "/api/integrations/vtiger/accounts",
34377     "title": "Creates a new Vtiger Account",
34378     "examples": [
34379       {
34380         "title": "Example usage:",
34381         "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",
34382         "type": "json"
34383       }
34384     ],
34385     "name": "CreateVtiger_Accounts",
34386     "group": "Vtiger_Accounts",
34387     "parameter": {
34388       "fields": {
34389         "Body": [
34390           {
34391             "group": "Body",
34392             "type": "String",
34393             "optional": false,
34394             "field": "name",
34395             "description": ""
34396           },
34397           {
34398             "group": "Body",
34399             "type": "String",
34400             "optional": true,
34401             "field": "description",
34402             "description": ""
34403           },
34404           {
34405             "group": "Body",
34406             "type": "String",
34407             "optional": false,
34408             "field": "username",
34409             "description": ""
34410           },
34411           {
34412             "group": "Body",
34413             "type": "String",
34414             "optional": false,
34415             "field": "moduleName",
34416             "description": ""
34417           },
34418           {
34419             "group": "Body",
34420             "type": "String",
34421             "optional": false,
34422             "field": "remoteUri",
34423             "description": ""
34424           },
34425           {
34426             "group": "Body",
34427             "type": "String",
34428             "optional": false,
34429             "field": "serverUrl",
34430             "description": ""
34431           },
34432           {
34433             "group": "Body",
34434             "type": "String",
34435             "optional": false,
34436             "field": "accessKey",
34437             "description": ""
34438           }
34439         ]
34440       }
34441     },
34442     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34443     "version": "0.0.0",
34444     "filename": "server/api/intVtigerAccount/index.js",
34445     "groupTitle": "Vtiger_Accounts"
34446   },
34447   {
34448     "type": "delete",
34449     "url": "/api/integrations/vtiger/accounts/{id}",
34450     "title": "Deletes a Vtiger Account",
34451     "examples": [
34452       {
34453         "title": "Example usage:",
34454         "content": "curl https://{domain}/api/integrations/vtiger/accounts/{id} -v -u {name}:{password} -X DELETE",
34455         "type": "json"
34456       }
34457     ],
34458     "name": "DeleteVtiger_Accounts",
34459     "group": "Vtiger_Accounts",
34460     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34461     "version": "0.0.0",
34462     "filename": "server/api/intVtigerAccount/index.js",
34463     "groupTitle": "Vtiger_Accounts"
34464   },
34465   {
34466     "type": "get",
34467     "url": "/api/integrations/vtiger/accounts",
34468     "title": "Gets a list of Vtiger Accounts",
34469     "examples": [
34470       {
34471         "title": "Example usage:",
34472         "content": "curl https://{domain}/api/integrations/vtiger/accounts -v -u {name}:{password}",
34473         "type": "json"
34474       }
34475     ],
34476     "name": "GetVtiger_Accounts",
34477     "group": "Vtiger_Accounts",
34478     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
34479     "version": "0.0.0",
34480     "filename": "server/api/intVtigerAccount/index.js",
34481     "groupTitle": "Vtiger_Accounts"
34482   },
34483   {
34484     "type": "get",
34485     "url": "/api/integrations/vtiger/accounts/{id}",
34486     "title": "Gets a single Vtiger Account",
34487     "examples": [
34488       {
34489         "title": "Example usage:",
34490         "content": "curl https://{domain}/api/integrations/vtiger/accounts/{id} -v -u {name}:{password}",
34491         "type": "json"
34492       }
34493     ],
34494     "name": "ShowVtiger_Accounts",
34495     "group": "Vtiger_Accounts",
34496     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34497     "version": "0.0.0",
34498     "filename": "server/api/intVtigerAccount/index.js",
34499     "groupTitle": "Vtiger_Accounts"
34500   },
34501   {
34502     "type": "post",
34503     "url": "/api/integrations/vtiger/accounts/{id}/configurations",
34504     "title": "Creates new configuration",
34505     "examples": [
34506       {
34507         "title": "Example usage:",
34508         "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",
34509         "type": "json"
34510       }
34511     ],
34512     "name": "addConfiguration",
34513     "group": "Vtiger_Accounts",
34514     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34515     "version": "0.0.0",
34516     "filename": "server/api/intVtigerAccount/index.js",
34517     "groupTitle": "Vtiger_Accounts"
34518   },
34519   {
34520     "type": "get",
34521     "url": "/api/integrations/vtiger/accounts/{id}/configurations",
34522     "title": "Gets account configurations",
34523     "examples": [
34524       {
34525         "title": "Example usage:",
34526         "content": "curl https://{domain}/api/integrations/vtiger/accounts/{id}/configurations -v -u {name}:{password} -X GET",
34527         "type": "json"
34528       }
34529     ],
34530     "name": "getConfigurations",
34531     "group": "Vtiger_Accounts",
34532     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34533     "version": "0.0.0",
34534     "filename": "server/api/intVtigerAccount/index.js",
34535     "groupTitle": "Vtiger_Accounts"
34536   },
34537   {
34538     "type": "get",
34539     "url": "/api/integrations/vtiger/accounts/{id}/fields",
34540     "title": "Gets account fields",
34541     "examples": [
34542       {
34543         "title": "Example usage:",
34544         "content": "curl https://{domain}/api/integrations/vtiger/accounts/{id}/fields -v -u {name}:{password} -X GET",
34545         "type": "json"
34546       }
34547     ],
34548     "name": "getFields",
34549     "group": "Vtiger_Accounts",
34550     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34551     "version": "0.0.0",
34552     "filename": "server/api/intVtigerAccount/index.js",
34553     "groupTitle": "Vtiger_Accounts"
34554   },
34555   {
34556     "type": "put",
34557     "url": "/api/integrations/vtiger/accounts/{id}",
34558     "title": "Update an existing Vtiger Account",
34559     "examples": [
34560       {
34561         "title": "Example usage:",
34562         "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",
34563         "type": "json"
34564       }
34565     ],
34566     "name": "updateVtiger_Accounts",
34567     "group": "Vtiger_Accounts",
34568     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34569     "version": "0.0.0",
34570     "filename": "server/api/intVtigerAccount/index.js",
34571     "groupTitle": "Vtiger_Accounts"
34572   },
34573   {
34574     "type": "post",
34575     "url": "/api/integrations/vtiger/configurations",
34576     "title": "Creates a new Vtiger Configuration",
34577     "examples": [
34578       {
34579         "title": "Example usage:",
34580         "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",
34581         "type": "json"
34582       }
34583     ],
34584     "name": "CreateVtiger_Configurations",
34585     "group": "Vtiger_Configurations",
34586     "parameter": {
34587       "fields": {
34588         "Body": [
34589           {
34590             "group": "Body",
34591             "type": "String",
34592             "optional": true,
34593             "field": "name",
34594             "description": ""
34595           },
34596           {
34597             "group": "Body",
34598             "type": "String",
34599             "optional": true,
34600             "field": "description",
34601             "description": ""
34602           }
34603         ]
34604       }
34605     },
34606     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34607     "version": "0.0.0",
34608     "filename": "server/api/intVtigerConfiguration/index.js",
34609     "groupTitle": "Vtiger_Configurations"
34610   },
34611   {
34612     "type": "delete",
34613     "url": "/api/integrations/vtiger/configurations/{id}",
34614     "title": "Deletes a Vtiger Configuration",
34615     "examples": [
34616       {
34617         "title": "Example usage:",
34618         "content": "curl https://{domain}/api/integrations/vtiger/configurations/{id} -v -u {name}:{password} -X DELETE",
34619         "type": "json"
34620       }
34621     ],
34622     "name": "DeleteVtiger_Configurations",
34623     "group": "Vtiger_Configurations",
34624     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34625     "version": "0.0.0",
34626     "filename": "server/api/intVtigerConfiguration/index.js",
34627     "groupTitle": "Vtiger_Configurations"
34628   },
34629   {
34630     "type": "get",
34631     "url": "/api/integrations/vtiger/configurations",
34632     "title": "Gets a list of Vtiger Configurations",
34633     "examples": [
34634       {
34635         "title": "Example usage:",
34636         "content": "curl https://{domain}/api/integrations/vtiger/configurations -v -u {name}:{password}",
34637         "type": "json"
34638       }
34639     ],
34640     "name": "GetVtiger_Configurations",
34641     "group": "Vtiger_Configurations",
34642     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
34643     "version": "0.0.0",
34644     "filename": "server/api/intVtigerConfiguration/index.js",
34645     "groupTitle": "Vtiger_Configurations"
34646   },
34647   {
34648     "type": "get",
34649     "url": "/api/integrations/vtiger/configurations/{id}",
34650     "title": "Gets a single Vtiger Configuration",
34651     "examples": [
34652       {
34653         "title": "Example usage:",
34654         "content": "curl https://{domain}/api/integrations/vtiger/configurations/{id} -v -u {name}:{password}",
34655         "type": "json"
34656       }
34657     ],
34658     "name": "ShowVtiger_Configurations",
34659     "group": "Vtiger_Configurations",
34660     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34661     "version": "0.0.0",
34662     "filename": "server/api/intVtigerConfiguration/index.js",
34663     "groupTitle": "Vtiger_Configurations"
34664   },
34665   {
34666     "type": "get",
34667     "url": "/api/integrations/vtiger/configurations/{id}/descriptions",
34668     "title": "Gets configurations descriptions",
34669     "examples": [
34670       {
34671         "title": "Example usage:",
34672         "content": "curl https://{domain}/api/integrations/vtiger/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
34673         "type": "json"
34674       }
34675     ],
34676     "name": "getDescriptions",
34677     "group": "Vtiger_Configurations",
34678     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34679     "version": "0.0.0",
34680     "filename": "server/api/intVtigerConfiguration/index.js",
34681     "groupTitle": "Vtiger_Configurations"
34682   },
34683   {
34684     "type": "get",
34685     "url": "/api/integrations/vtiger/configurations/{id}/fields",
34686     "title": "Gets configurations fields",
34687     "examples": [
34688       {
34689         "title": "Example usage:",
34690         "content": "curl https://{domain}/api/integrations/vtiger/configurations/{id}/fields -v -u {name}:{password} -X GET",
34691         "type": "json"
34692       }
34693     ],
34694     "name": "getFields",
34695     "group": "Vtiger_Configurations",
34696     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34697     "version": "0.0.0",
34698     "filename": "server/api/intVtigerConfiguration/index.js",
34699     "groupTitle": "Vtiger_Configurations"
34700   },
34701   {
34702     "type": "get",
34703     "url": "/api/integrations/vtiger/configurations/{id}/subjects",
34704     "title": "Gets configurations subjects",
34705     "examples": [
34706       {
34707         "title": "Example usage:",
34708         "content": "curl https://{domain}/api/integrations/vtiger/configurations/{id}/subjects -v -u {name}:{password} -X GET",
34709         "type": "json"
34710       }
34711     ],
34712     "name": "getSubjects",
34713     "group": "Vtiger_Configurations",
34714     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34715     "version": "0.0.0",
34716     "filename": "server/api/intVtigerConfiguration/index.js",
34717     "groupTitle": "Vtiger_Configurations"
34718   },
34719   {
34720     "type": "put",
34721     "url": "/api/integrations/vtiger/configurations/{id}",
34722     "title": "Update an existing Vtiger Configuration",
34723     "examples": [
34724       {
34725         "title": "Example usage:",
34726         "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",
34727         "type": "json"
34728       }
34729     ],
34730     "name": "updateVtiger_Configurations",
34731     "group": "Vtiger_Configurations",
34732     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34733     "version": "0.0.0",
34734     "filename": "server/api/intVtigerConfiguration/index.js",
34735     "groupTitle": "Vtiger_Configurations"
34736   },
34737   {
34738     "type": "post",
34739     "url": "/api/integrations/vtiger/fields",
34740     "title": "Creates a new Vtiger Field",
34741     "examples": [
34742       {
34743         "title": "Example usage:",
34744         "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",
34745         "type": "json"
34746       }
34747     ],
34748     "name": "CreateVtiger_Fields",
34749     "group": "Vtiger_Fields",
34750     "parameter": {
34751       "fields": {
34752         "Body": [
34753           {
34754             "group": "Body",
34755             "type": "String",
34756             "allowedValues": [
34757               "\"string\"",
34758               "\"variable\"",
34759               "\"customVariable\"",
34760               "\"keyValue\"",
34761               "\"picklist\""
34762             ],
34763             "optional": true,
34764             "field": "type",
34765             "description": ""
34766           },
34767           {
34768             "group": "Body",
34769             "type": "String",
34770             "optional": true,
34771             "field": "content",
34772             "description": ""
34773           },
34774           {
34775             "group": "Body",
34776             "type": "String",
34777             "optional": true,
34778             "field": "key",
34779             "description": ""
34780           },
34781           {
34782             "group": "Body",
34783             "type": "String",
34784             "allowedValues": [
34785               "\"string\"",
34786               "\"variable\"",
34787               "\"customVariable\""
34788             ],
34789             "optional": true,
34790             "field": "keyType",
34791             "description": ""
34792           },
34793           {
34794             "group": "Body",
34795             "type": "String",
34796             "optional": true,
34797             "field": "keyContent",
34798             "description": ""
34799           },
34800           {
34801             "group": "Body",
34802             "type": "String",
34803             "optional": true,
34804             "field": "idField",
34805             "description": ""
34806           },
34807           {
34808             "group": "Body",
34809             "type": "String",
34810             "optional": true,
34811             "field": "nameField",
34812             "description": ""
34813           },
34814           {
34815             "group": "Body",
34816             "type": "Boolean",
34817             "optional": true,
34818             "field": "customField",
34819             "description": ""
34820           },
34821           {
34822             "group": "Body",
34823             "type": "String",
34824             "optional": true,
34825             "field": "variableName",
34826             "description": ""
34827           }
34828         ]
34829       }
34830     },
34831     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34832     "version": "0.0.0",
34833     "filename": "server/api/intVtigerField/index.js",
34834     "groupTitle": "Vtiger_Fields"
34835   },
34836   {
34837     "type": "delete",
34838     "url": "/api/integrations/vtiger/fields/{id}",
34839     "title": "Deletes a Vtiger Field",
34840     "examples": [
34841       {
34842         "title": "Example usage:",
34843         "content": "curl https://{domain}/api/integrations/vtiger/fields/{id} -v -u {name}:{password} -X DELETE",
34844         "type": "json"
34845       }
34846     ],
34847     "name": "DeleteVtiger_Fields",
34848     "group": "Vtiger_Fields",
34849     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34850     "version": "0.0.0",
34851     "filename": "server/api/intVtigerField/index.js",
34852     "groupTitle": "Vtiger_Fields"
34853   },
34854   {
34855     "type": "get",
34856     "url": "/api/integrations/vtiger/fields",
34857     "title": "Gets a list of Vtiger Fields",
34858     "examples": [
34859       {
34860         "title": "Example usage:",
34861         "content": "curl https://{domain}/api/integrations/vtiger/fields -v -u {name}:{password}",
34862         "type": "json"
34863       }
34864     ],
34865     "name": "GetVtiger_Fields",
34866     "group": "Vtiger_Fields",
34867     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
34868     "version": "0.0.0",
34869     "filename": "server/api/intVtigerField/index.js",
34870     "groupTitle": "Vtiger_Fields"
34871   },
34872   {
34873     "type": "get",
34874     "url": "/api/integrations/vtiger/fields/{id}",
34875     "title": "Gets a single Vtiger Field",
34876     "examples": [
34877       {
34878         "title": "Example usage:",
34879         "content": "curl https://{domain}/api/integrations/vtiger/fields/{id} -v -u {name}:{password}",
34880         "type": "json"
34881       }
34882     ],
34883     "name": "ShowVtiger_Fields",
34884     "group": "Vtiger_Fields",
34885     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34886     "version": "0.0.0",
34887     "filename": "server/api/intVtigerField/index.js",
34888     "groupTitle": "Vtiger_Fields"
34889   },
34890   {
34891     "type": "put",
34892     "url": "/api/integrations/vtiger/fields/{id}",
34893     "title": "Update an existing Vtiger Field",
34894     "examples": [
34895       {
34896         "title": "Example usage:",
34897         "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",
34898         "type": "json"
34899       }
34900     ],
34901     "name": "updateVtiger_Fields",
34902     "group": "Vtiger_Fields",
34903     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34904     "version": "0.0.0",
34905     "filename": "server/api/intVtigerField/index.js",
34906     "groupTitle": "Vtiger_Fields"
34907   },
34908   {
34909     "type": "post",
34910     "url": "/api/webbar/answer",
34911     "title": "answer webrtc call",
34912     "examples": [
34913       {
34914         "title": "Example usage:",
34915         "content": "curl https://{domain}/api/webbar/answer -d '{\"sessionId\": \"<sessionId>\", \"userId\": 54}' \\\n -H \"Content-Type: application/json\" -X POST",
34916         "type": "json"
34917       }
34918     ],
34919     "name": "Web_Bar_answer",
34920     "group": "WebBar",
34921     "parameter": {
34922       "fields": {
34923         "Body": [
34924           {
34925             "group": "Body",
34926             "type": "String",
34927             "optional": false,
34928             "field": "sessionId",
34929             "description": ""
34930           },
34931           {
34932             "group": "Body",
34933             "type": "number",
34934             "optional": false,
34935             "field": "userId",
34936             "description": ""
34937           }
34938         ]
34939       }
34940     },
34941     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34942     "version": "0.0.0",
34943     "filename": "server/api/webbar/index.js",
34944     "groupTitle": "WebBar"
34945   },
34946   {
34947     "type": "post",
34948     "url": "/api/webbar/calls",
34949     "title": "webrtc call list",
34950     "examples": [
34951       {
34952         "title": "Example usage:",
34953         "content": "curl https://{domain}/api/webbar/calls -d '{\"userId\": 54}' \\\n -H \"Content-Type: application/json\" -X POST",
34954         "type": "json"
34955       }
34956     ],
34957     "name": "Web_Bar_calls",
34958     "group": "WebBar",
34959     "parameter": {
34960       "fields": {
34961         "Body": [
34962           {
34963             "group": "Body",
34964             "type": "number",
34965             "optional": false,
34966             "field": "userId",
34967             "description": ""
34968           }
34969         ]
34970       }
34971     },
34972     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34973     "version": "0.0.0",
34974     "filename": "server/api/webbar/index.js",
34975     "groupTitle": "WebBar"
34976   },
34977   {
34978     "type": "post",
34979     "url": "/api/webbar/hangup",
34980     "title": "hangup webrtc call",
34981     "examples": [
34982       {
34983         "title": "Example usage:",
34984         "content": "curl https://{domain}/api/webbar/hangup -d '{\"sessionId\": \"<sessionId>\", \"userId\": 54}' \\\n -H \"Content-Type: application/json\" -X POST",
34985         "type": "json"
34986       }
34987     ],
34988     "name": "Web_Bar_hangup",
34989     "group": "WebBar",
34990     "parameter": {
34991       "fields": {
34992         "Body": [
34993           {
34994             "group": "Body",
34995             "type": "String",
34996             "optional": false,
34997             "field": "sessionId",
34998             "description": ""
34999           },
35000           {
35001             "group": "Body",
35002             "type": "number",
35003             "optional": false,
35004             "field": "userId",
35005             "description": ""
35006           }
35007         ]
35008       }
35009     },
35010     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35011     "version": "0.0.0",
35012     "filename": "server/api/webbar/index.js",
35013     "groupTitle": "WebBar"
35014   },
35015   {
35016     "type": "post",
35017     "url": "/api/webbar/hold",
35018     "title": "hold webrtc call",
35019     "examples": [
35020       {
35021         "title": "Example usage:",
35022         "content": "curl https://{domain}/api/webbar/hold -d '{\"sessionId\": \"<sessionId>\", \"userId\": 54}' \\\n -H \"Content-Type: application/json\" -X POST",
35023         "type": "json"
35024       }
35025     ],
35026     "name": "Web_Bar_hold",
35027     "group": "WebBar",
35028     "parameter": {
35029       "fields": {
35030         "Body": [
35031           {
35032             "group": "Body",
35033             "type": "String",
35034             "optional": true,
35035             "field": "sessionId",
35036             "description": ""
35037           },
35038           {
35039             "group": "Body",
35040             "type": "number",
35041             "optional": false,
35042             "field": "userId",
35043             "description": ""
35044           }
35045         ]
35046       }
35047     },
35048     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35049     "version": "0.0.0",
35050     "filename": "server/api/webbar/index.js",
35051     "groupTitle": "WebBar"
35052   },
35053   {
35054     "type": "post",
35055     "url": "/api/webbar/unhold",
35056     "title": "unhold webrtc call",
35057     "examples": [
35058       {
35059         "title": "Example usage:",
35060         "content": "curl https://{domain}/api/webbar/unhold -d '{\"sessionId\": \"<sessionId>\", \"userId\": 54}' \\\n -H \"Content-Type: application/json\" -X POST",
35061         "type": "json"
35062       }
35063     ],
35064     "name": "Web_Bar_hold",
35065     "group": "WebBar",
35066     "parameter": {
35067       "fields": {
35068         "Body": [
35069           {
35070             "group": "Body",
35071             "type": "String",
35072             "optional": false,
35073             "field": "sessionId",
35074             "description": ""
35075           },
35076           {
35077             "group": "Body",
35078             "type": "number",
35079             "optional": false,
35080             "field": "userId",
35081             "description": ""
35082           }
35083         ]
35084       }
35085     },
35086     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35087     "version": "0.0.0",
35088     "filename": "server/api/webbar/index.js",
35089     "groupTitle": "WebBar"
35090   },
35091   {
35092     "type": "post",
35093     "url": "/api/webbar/originate",
35094     "title": "Originate new webrtc call",
35095     "examples": [
35096       {
35097         "title": "Example usage:",
35098         "content": "curl https://{domain}/api/webbar/originate -d '{\"callNumber\": \"0119692844\", \"userId\": 54}' \\\n -H \"Content-Type: application/json\" -X POST",
35099         "type": "json"
35100       }
35101     ],
35102     "name": "Web_Bar_originate",
35103     "group": "WebBar",
35104     "parameter": {
35105       "fields": {
35106         "Body": [
35107           {
35108             "group": "Body",
35109             "type": "String",
35110             "optional": false,
35111             "field": "callNumber",
35112             "description": ""
35113           },
35114           {
35115             "group": "Body",
35116             "type": "number",
35117             "optional": false,
35118             "field": "userId",
35119             "description": ""
35120           },
35121           {
35122             "group": "Body",
35123             "type": "String",
35124             "optional": false,
35125             "field": "callerId",
35126             "description": ""
35127           },
35128           {
35129             "group": "Body",
35130             "type": "String",
35131             "optional": false,
35132             "field": "callbackUrl",
35133             "description": ""
35134           }
35135         ]
35136       }
35137     },
35138     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35139     "version": "0.0.0",
35140     "filename": "server/api/webbar/index.js",
35141     "groupTitle": "WebBar"
35142   },
35143   {
35144     "type": "post",
35145     "url": "/api/webbar/transfer",
35146     "title": "blind transfer webrtc call",
35147     "examples": [
35148       {
35149         "title": "Example usage:",
35150         "content": "curl https://{domain}/api/webbar/transfer -d '{\"userId\": 54, \"sessionId\":\"<sessionId>\", \"transferNumber\":\"<transferNumber>\"}' \\\n -H \"Content-Type: application/json\" -X POST",
35151         "type": "json"
35152       }
35153     ],
35154     "name": "Web_Bar_transfer",
35155     "group": "WebBar",
35156     "parameter": {
35157       "fields": {
35158         "Body": [
35159           {
35160             "group": "Body",
35161             "type": "number",
35162             "optional": false,
35163             "field": "userId",
35164             "description": ""
35165           },
35166           {
35167             "group": "Body",
35168             "type": "string",
35169             "optional": false,
35170             "field": "sessionId",
35171             "description": ""
35172           },
35173           {
35174             "group": "Body",
35175             "type": "string",
35176             "optional": false,
35177             "field": "transferNumber",
35178             "description": ""
35179           }
35180         ]
35181       }
35182     },
35183     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35184     "version": "0.0.0",
35185     "filename": "server/api/webbar/index.js",
35186     "groupTitle": "WebBar"
35187   },
35188   {
35189     "type": "post",
35190     "url": "/api/whatsapp/accounts/{id}/users",
35191     "title": "Add agents to a whatsapp account",
35192     "examples": [
35193       {
35194         "title": "Example usage:",
35195         "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",
35196         "type": "json"
35197       }
35198     ],
35199     "name": "AddAgents",
35200     "group": "Whatsapp_Accounts",
35201     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35202     "version": "0.0.0",
35203     "filename": "server/api/whatsappAccount/index.js",
35204     "groupTitle": "Whatsapp_Accounts"
35205   },
35206   {
35207     "type": "post",
35208     "url": "/api/whatsapp/accounts",
35209     "title": "Creates a new Account",
35210     "examples": [
35211       {
35212         "title": "Example usage:",
35213         "content": "curl https://{domain}/api/whatsapp/accounts -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
35214         "type": "json"
35215       }
35216     ],
35217     "name": "CreateAccounts",
35218     "group": "Whatsapp_Accounts",
35219     "parameter": {
35220       "fields": {
35221         "Body": [
35222           {
35223             "group": "Body",
35224             "type": "String",
35225             "optional": false,
35226             "field": "name",
35227             "description": ""
35228           },
35229           {
35230             "group": "Body",
35231             "type": "String",
35232             "optional": false,
35233             "field": "key",
35234             "description": ""
35235           },
35236           {
35237             "group": "Body",
35238             "type": "String",
35239             "optional": false,
35240             "field": "remote",
35241             "description": ""
35242           },
35243           {
35244             "group": "Body",
35245             "type": "String",
35246             "optional": true,
35247             "field": "token",
35248             "description": ""
35249           },
35250           {
35251             "group": "Body",
35252             "type": "String",
35253             "optional": true,
35254             "field": "phone",
35255             "description": ""
35256           },
35257           {
35258             "group": "Body",
35259             "type": "String",
35260             "allowedValues": [
35261               "\"twilio\""
35262             ],
35263             "optional": true,
35264             "field": "type",
35265             "description": ""
35266           },
35267           {
35268             "group": "Body",
35269             "type": "String",
35270             "optional": true,
35271             "field": "accountSid",
35272             "description": ""
35273           },
35274           {
35275             "group": "Body",
35276             "type": "String",
35277             "optional": true,
35278             "field": "authToken",
35279             "description": ""
35280           },
35281           {
35282             "group": "Body",
35283             "type": "Text",
35284             "optional": true,
35285             "field": "notificationTemplate",
35286             "description": ""
35287           },
35288           {
35289             "group": "Body",
35290             "type": "Boolean",
35291             "optional": true,
35292             "field": "notificationSound",
35293             "description": ""
35294           },
35295           {
35296             "group": "Body",
35297             "type": "Boolean",
35298             "optional": true,
35299             "field": "notificationShake",
35300             "description": ""
35301           },
35302           {
35303             "group": "Body",
35304             "type": "Integer",
35305             "optional": true,
35306             "field": "waitForTheAssignedAgent",
35307             "description": ""
35308           },
35309           {
35310             "group": "Body",
35311             "type": "Boolean",
35312             "optional": true,
35313             "field": "queueTransfer",
35314             "description": ""
35315           },
35316           {
35317             "group": "Body",
35318             "type": "Integer",
35319             "optional": true,
35320             "field": "queueTransferTimeout",
35321             "description": ""
35322           },
35323           {
35324             "group": "Body",
35325             "type": "Boolean",
35326             "optional": true,
35327             "field": "agentTransfer",
35328             "description": ""
35329           },
35330           {
35331             "group": "Body",
35332             "type": "Integer",
35333             "optional": true,
35334             "field": "agentTransferTimeout",
35335             "description": ""
35336           },
35337           {
35338             "group": "Body",
35339             "type": "Integer",
35340             "optional": true,
35341             "field": "mandatoryDispositionPauseId",
35342             "description": "<p>Status to put when mandatory disposition is enabled</p>"
35343           },
35344           {
35345             "group": "Body",
35346             "type": "Boolean",
35347             "optional": true,
35348             "field": "mandatoryDisposition",
35349             "description": "<p>Enabled/disables mandatory dispo on a queue</p>"
35350           },
35351           {
35352             "group": "Body",
35353             "type": "String",
35354             "optional": true,
35355             "field": "description",
35356             "description": ""
35357           }
35358         ]
35359       }
35360     },
35361     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35362     "version": "0.0.0",
35363     "filename": "server/api/whatsappAccount/index.js",
35364     "groupTitle": "Whatsapp_Accounts"
35365   },
35366   {
35367     "type": "delete",
35368     "url": "/api/whatsapp/accounts/{id}",
35369     "title": "Deletes a Account",
35370     "examples": [
35371       {
35372         "title": "Example usage:",
35373         "content": "curl https://{domain}/api/whatsapp/accounts/{id} -v -u {name}:{password} -X DELETE",
35374         "type": "json"
35375       }
35376     ],
35377     "name": "DeleteAccounts",
35378     "group": "Whatsapp_Accounts",
35379     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35380     "version": "0.0.0",
35381     "filename": "server/api/whatsappAccount/index.js",
35382     "groupTitle": "Whatsapp_Accounts"
35383   },
35384   {
35385     "type": "get",
35386     "url": "/api/whatsapp/accounts/describe",
35387     "title": "Gets table info about Accounts",
35388     "examples": [
35389       {
35390         "title": "Example usage:",
35391         "content": "curl https://{domain}/api/whatsapp/accounts/describe -v -u {name}:{password}",
35392         "type": "json"
35393       }
35394     ],
35395     "name": "DescribeAccounts",
35396     "group": "Whatsapp_Accounts",
35397     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35398     "version": "0.0.0",
35399     "filename": "server/api/whatsappAccount/index.js",
35400     "groupTitle": "Whatsapp_Accounts"
35401   },
35402   {
35403     "type": "get",
35404     "url": "/api/whatsapp/accounts",
35405     "title": "Gets a list of Accounts",
35406     "examples": [
35407       {
35408         "title": "Example usage:",
35409         "content": "curl https://{domain}/api/whatsapp/accounts -v -u {name}:{password}",
35410         "type": "json"
35411       }
35412     ],
35413     "name": "GetAccounts",
35414     "group": "Whatsapp_Accounts",
35415     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
35416     "version": "0.0.0",
35417     "filename": "server/api/whatsappAccount/index.js",
35418     "groupTitle": "Whatsapp_Accounts"
35419   },
35420   {
35421     "type": "get",
35422     "url": "/api/whatsapp/accounts/{id}/users",
35423     "title": "Gets agents from whatsapp account",
35424     "examples": [
35425       {
35426         "title": "Example usage:",
35427         "content": "curl https://{domain}/api/whatsapp/accounts/{id}/users -v -u {name}:{password} -X GET",
35428         "type": "json"
35429       }
35430     ],
35431     "name": "GetAgents",
35432     "group": "Whatsapp_Accounts",
35433     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35434     "version": "0.0.0",
35435     "filename": "server/api/whatsappAccount/index.js",
35436     "groupTitle": "Whatsapp_Accounts"
35437   },
35438   {
35439     "type": "delete",
35440     "url": "/api/whatsapp/accounts/{id}/users",
35441     "title": "Removes agents from a whatsapp account",
35442     "examples": [
35443       {
35444         "title": "Example usage:",
35445         "content": "curl https://{domain}/api/whatsapp/accounts/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
35446         "type": "json"
35447       }
35448     ],
35449     "name": "RemoveAgents",
35450     "group": "Whatsapp_Accounts",
35451     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35452     "version": "0.0.0",
35453     "filename": "server/api/whatsappAccount/index.js",
35454     "groupTitle": "Whatsapp_Accounts"
35455   },
35456   {
35457     "type": "delete",
35458     "url": "/api/whatsapp/accounts/{id}/canned_answers",
35459     "title": "Removes canned answers from account",
35460     "examples": [
35461       {
35462         "title": "Example usage:",
35463         "content": "curl https://{domain}/api/whatsapp/accounts/{id}/canned_answers?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
35464         "type": "json"
35465       }
35466     ],
35467     "name": "RemoveAnswers",
35468     "group": "Whatsapp_Accounts",
35469     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35470     "version": "0.0.0",
35471     "filename": "server/api/whatsappAccount/index.js",
35472     "groupTitle": "Whatsapp_Accounts"
35473   },
35474   {
35475     "type": "delete",
35476     "url": "/api/whatsapp/accounts/{id}/dispositions",
35477     "title": "Removes dispositions from account",
35478     "examples": [
35479       {
35480         "title": "Example usage:",
35481         "content": "curl https://{domain}/api/whatsapp/accounts/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
35482         "type": "json"
35483       }
35484     ],
35485     "name": "RemoveDispositions",
35486     "group": "Whatsapp_Accounts",
35487     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35488     "version": "0.0.0",
35489     "filename": "server/api/whatsappAccount/index.js",
35490     "groupTitle": "Whatsapp_Accounts"
35491   },
35492   {
35493     "type": "get",
35494     "url": "/api/whatsapp/accounts/{id}",
35495     "title": "Gets a single Account",
35496     "examples": [
35497       {
35498         "title": "Example usage:",
35499         "content": "curl https://{domain}/api/whatsapp/accounts/{id} -v -u {name}:{password}",
35500         "type": "json"
35501       }
35502     ],
35503     "name": "ShowAccounts",
35504     "group": "Whatsapp_Accounts",
35505     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35506     "version": "0.0.0",
35507     "filename": "server/api/whatsappAccount/index.js",
35508     "groupTitle": "Whatsapp_Accounts"
35509   },
35510   {
35511     "type": "put",
35512     "url": "/api/whatsapp/messages/{id}/accept",
35513     "title": "Accepts message",
35514     "examples": [
35515       {
35516         "title": "Example usage:",
35517         "content": "curl https://{domain}/api/whatsapp/messages/{id}/accept \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
35518         "type": "json"
35519       }
35520     ],
35521     "name": "acceptMessage",
35522     "group": "Whatsapp_Accounts",
35523     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35524     "version": "0.0.0",
35525     "filename": "server/api/whatsappMessage/index.js",
35526     "groupTitle": "Whatsapp_Accounts"
35527   },
35528   {
35529     "type": "post",
35530     "url": "/api/whatsapp/accounts/{id}/canned_answers",
35531     "title": "Creates new canned answer",
35532     "examples": [
35533       {
35534         "title": "Example usage:",
35535         "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",
35536         "type": "json"
35537       }
35538     ],
35539     "name": "addAnswer",
35540     "group": "Whatsapp_Accounts",
35541     "parameter": {
35542       "fields": {
35543         "Body": [
35544           {
35545             "group": "Body",
35546             "type": "String",
35547             "optional": false,
35548             "field": "key",
35549             "description": ""
35550           },
35551           {
35552             "group": "Body",
35553             "type": "Text",
35554             "optional": false,
35555             "field": "value",
35556             "description": ""
35557           },
35558           {
35559             "group": "Body",
35560             "type": "String",
35561             "optional": true,
35562             "field": "description",
35563             "description": ""
35564           },
35565           {
35566             "group": "Body",
35567             "type": "Virtual",
35568             "optional": true,
35569             "field": "name",
35570             "description": ""
35571           }
35572         ]
35573       }
35574     },
35575     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35576     "version": "0.0.0",
35577     "filename": "server/api/whatsappAccount/index.js",
35578     "groupTitle": "Whatsapp_Accounts"
35579   },
35580   {
35581     "type": "post",
35582     "url": "/api/whatsapp/accounts/{id}/applications",
35583     "title": "Creates new applications",
35584     "examples": [
35585       {
35586         "title": "Example usage:",
35587         "content": "curl https://{domain}/api/whatsapp/accounts/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
35588         "type": "json"
35589       }
35590     ],
35591     "name": "addApplications",
35592     "group": "Whatsapp_Accounts",
35593     "parameter": {
35594       "fields": {
35595         "Body": [
35596           {
35597             "group": "Body",
35598             "type": "Integer",
35599             "optional": false,
35600             "field": "priority",
35601             "description": ""
35602           },
35603           {
35604             "group": "Body",
35605             "type": "String",
35606             "optional": false,
35607             "field": "app",
35608             "description": ""
35609           },
35610           {
35611             "group": "Body",
35612             "type": "Text",
35613             "optional": true,
35614             "field": "appdata",
35615             "description": ""
35616           },
35617           {
35618             "group": "Body",
35619             "type": "String",
35620             "optional": true,
35621             "field": "description",
35622             "description": ""
35623           },
35624           {
35625             "group": "Body",
35626             "type": "String",
35627             "optional": true,
35628             "field": "interval",
35629             "description": ""
35630           }
35631         ]
35632       }
35633     },
35634     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35635     "version": "0.0.0",
35636     "filename": "server/api/whatsappAccount/index.js",
35637     "groupTitle": "Whatsapp_Accounts"
35638   },
35639   {
35640     "type": "post",
35641     "url": "/api/whatsapp/accounts/{id}/dispositions",
35642     "title": "Creates new disposition",
35643     "examples": [
35644       {
35645         "title": "Example usage:",
35646         "content": "curl https://{domain}/api/whatsapp/accounts/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
35647         "type": "json"
35648       }
35649     ],
35650     "name": "addDisposition",
35651     "group": "Whatsapp_Accounts",
35652     "parameter": {
35653       "fields": {
35654         "Body": [
35655           {
35656             "group": "Body",
35657             "type": "String",
35658             "optional": false,
35659             "field": "name",
35660             "description": ""
35661           },
35662           {
35663             "group": "Body",
35664             "type": "String",
35665             "allowedValues": [
35666               "\"first\"",
35667               "\"second\"",
35668               "\"third\""
35669             ],
35670             "optional": false,
35671             "field": "level",
35672             "description": ""
35673           },
35674           {
35675             "group": "Body",
35676             "type": "String",
35677             "optional": true,
35678             "field": "description",
35679             "description": ""
35680           }
35681         ]
35682       }
35683     },
35684     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35685     "version": "0.0.0",
35686     "filename": "server/api/whatsappAccount/index.js",
35687     "groupTitle": "Whatsapp_Accounts"
35688   },
35689   {
35690     "type": "get",
35691     "url": "/api/whatsapp/accounts/{id}/canned_answers",
35692     "title": "Gets account canned answers",
35693     "examples": [
35694       {
35695         "title": "Example usage:",
35696         "content": "curl https://{domain}/api/whatsapp/accounts/{id}/canned_answers -v -u {name}:{password} -X GET",
35697         "type": "json"
35698       }
35699     ],
35700     "name": "getAnswers",
35701     "group": "Whatsapp_Accounts",
35702     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35703     "version": "0.0.0",
35704     "filename": "server/api/whatsappAccount/index.js",
35705     "groupTitle": "Whatsapp_Accounts"
35706   },
35707   {
35708     "type": "get",
35709     "url": "/api/whatsapp/accounts/{id}/applications",
35710     "title": "Gets account applications",
35711     "examples": [
35712       {
35713         "title": "Example usage:",
35714         "content": "curl https://{domain}/api/whatsapp/accounts/{id}/applications -v -u {name}:{password} -X GET",
35715         "type": "json"
35716       }
35717     ],
35718     "name": "getApplications",
35719     "group": "Whatsapp_Accounts",
35720     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35721     "version": "0.0.0",
35722     "filename": "server/api/whatsappAccount/index.js",
35723     "groupTitle": "Whatsapp_Accounts"
35724   },
35725   {
35726     "type": "get",
35727     "url": "/api/whatsapp/accounts/{id}/dispositions",
35728     "title": "Gets account dispositions",
35729     "examples": [
35730       {
35731         "title": "Example usage:",
35732         "content": "curl https://{domain}/api/whatsapp/accounts/{id}/dispositions -v -u {name}:{password} -X GET",
35733         "type": "json"
35734       }
35735     ],
35736     "name": "getDispositions",
35737     "group": "Whatsapp_Accounts",
35738     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35739     "version": "0.0.0",
35740     "filename": "server/api/whatsappAccount/index.js",
35741     "groupTitle": "Whatsapp_Accounts"
35742   },
35743   {
35744     "type": "post",
35745     "url": "/api/whatsapp/accounts/{id}/notify",
35746     "title": "Notify new message",
35747     "examples": [
35748       {
35749         "title": "Example usage:",
35750         "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",
35751         "type": "json"
35752       }
35753     ],
35754     "name": "notify",
35755     "group": "Whatsapp_Accounts",
35756     "description": "<p>Motion 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>",
35757     "version": "0.0.0",
35758     "filename": "server/api/whatsappAccount/index.js",
35759     "groupTitle": "Whatsapp_Accounts"
35760   },
35761   {
35762     "type": "put",
35763     "url": "/api/whatsapp/messages/{id}/reject",
35764     "title": "Rejects message",
35765     "examples": [
35766       {
35767         "title": "Example usage:",
35768         "content": "curl https://{domain}/api/whatsapp/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
35769         "type": "json"
35770       }
35771     ],
35772     "name": "rejectMessage",
35773     "group": "Whatsapp_Accounts",
35774     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35775     "version": "0.0.0",
35776     "filename": "server/api/whatsappMessage/index.js",
35777     "groupTitle": "Whatsapp_Accounts"
35778   },
35779   {
35780     "type": "post",
35781     "url": "/api/whatsapp/accounts/{id}/send",
35782     "title": "Send new whatsapp message",
35783     "examples": [
35784       {
35785         "title": "Example usage:",
35786         "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",
35787         "type": "json"
35788       }
35789     ],
35790     "name": "sendWhatsapp",
35791     "group": "Whatsapp_Accounts",
35792     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35793     "version": "0.0.0",
35794     "filename": "server/api/whatsappAccount/index.js",
35795     "groupTitle": "Whatsapp_Accounts"
35796   },
35797   {
35798     "type": "post",
35799     "url": "/api/whatsapp/messages/{id}/status",
35800     "title": "Receive message status",
35801     "examples": [
35802       {
35803         "title": "Example usage:",
35804         "content": "curl https://{domain}/api/whatsapp/messages/{id}/status \\ \n -H 'Content-Type: application/json' -v -X POST",
35805         "type": "json"
35806       }
35807     ],
35808     "name": "statusMessage",
35809     "group": "Whatsapp_Accounts",
35810     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35811     "version": "0.0.0",
35812     "filename": "server/api/whatsappMessage/index.js",
35813     "groupTitle": "Whatsapp_Accounts"
35814   },
35815   {
35816     "type": "put",
35817     "url": "/api/whatsapp/accounts/{id}",
35818     "title": "Update an existing Account",
35819     "examples": [
35820       {
35821         "title": "Example usage:",
35822         "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",
35823         "type": "json"
35824       }
35825     ],
35826     "name": "updateAccounts",
35827     "group": "Whatsapp_Accounts",
35828     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35829     "version": "0.0.0",
35830     "filename": "server/api/whatsappAccount/index.js",
35831     "groupTitle": "Whatsapp_Accounts"
35832   },
35833   {
35834     "type": "post",
35835     "url": "/api/whatsapp/applications",
35836     "title": "Creates a new Application",
35837     "examples": [
35838       {
35839         "title": "Example usage:",
35840         "content": "curl https://{domain}/api/whatsapp/applications -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
35841         "type": "json"
35842       }
35843     ],
35844     "name": "CreateApplications",
35845     "group": "Whatsapp_Applications",
35846     "parameter": {
35847       "fields": {
35848         "Body": [
35849           {
35850             "group": "Body",
35851             "type": "Integer",
35852             "optional": false,
35853             "field": "priority",
35854             "description": ""
35855           },
35856           {
35857             "group": "Body",
35858             "type": "String",
35859             "optional": false,
35860             "field": "app",
35861             "description": ""
35862           },
35863           {
35864             "group": "Body",
35865             "type": "Text",
35866             "optional": true,
35867             "field": "appdata",
35868             "description": ""
35869           },
35870           {
35871             "group": "Body",
35872             "type": "String",
35873             "optional": true,
35874             "field": "description",
35875             "description": ""
35876           },
35877           {
35878             "group": "Body",
35879             "type": "String",
35880             "optional": true,
35881             "field": "interval",
35882             "description": ""
35883           }
35884         ]
35885       }
35886     },
35887     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35888     "version": "0.0.0",
35889     "filename": "server/api/whatsappApplication/index.js",
35890     "groupTitle": "Whatsapp_Applications"
35891   },
35892   {
35893     "type": "delete",
35894     "url": "/api/whatsapp/applications/{id}",
35895     "title": "Deletes a Application",
35896     "examples": [
35897       {
35898         "title": "Example usage:",
35899         "content": "curl https://{domain}/api/whatsapp/applications/{id} -v -u {name}:{password} -X DELETE",
35900         "type": "json"
35901       }
35902     ],
35903     "name": "DeleteApplications",
35904     "group": "Whatsapp_Applications",
35905     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35906     "version": "0.0.0",
35907     "filename": "server/api/whatsappApplication/index.js",
35908     "groupTitle": "Whatsapp_Applications"
35909   },
35910   {
35911     "type": "get",
35912     "url": "/api/whatsapp/applications",
35913     "title": "Gets a list of Applications",
35914     "examples": [
35915       {
35916         "title": "Example usage:",
35917         "content": "curl https://{domain}/api/whatsapp/applications -v -u {name}:{password}",
35918         "type": "json"
35919       }
35920     ],
35921     "name": "GetApplications",
35922     "group": "Whatsapp_Applications",
35923     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
35924     "version": "0.0.0",
35925     "filename": "server/api/whatsappApplication/index.js",
35926     "groupTitle": "Whatsapp_Applications"
35927   },
35928   {
35929     "type": "get",
35930     "url": "/api/whatsapp/applications/{id}",
35931     "title": "Gets a single Application",
35932     "examples": [
35933       {
35934         "title": "Example usage:",
35935         "content": "curl https://{domain}/api/whatsapp/applications/{id} -v -u {name}:{password}",
35936         "type": "json"
35937       }
35938     ],
35939     "name": "ShowApplications",
35940     "group": "Whatsapp_Applications",
35941     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35942     "version": "0.0.0",
35943     "filename": "server/api/whatsappApplication/index.js",
35944     "groupTitle": "Whatsapp_Applications"
35945   },
35946   {
35947     "type": "put",
35948     "url": "/api/whatsapp/applications/{id}",
35949     "title": "Update an existing Application",
35950     "examples": [
35951       {
35952         "title": "Example usage:",
35953         "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",
35954         "type": "json"
35955       }
35956     ],
35957     "name": "updateApplications",
35958     "group": "Whatsapp_Applications",
35959     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35960     "version": "0.0.0",
35961     "filename": "server/api/whatsappApplication/index.js",
35962     "groupTitle": "Whatsapp_Applications"
35963   },
35964   {
35965     "type": "post",
35966     "url": "/api/whatsapp/interactions/{id}/tags",
35967     "title": "Add tags to the interaction",
35968     "examples": [
35969       {
35970         "title": "Example usage:",
35971         "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",
35972         "type": "json"
35973       }
35974     ],
35975     "name": "AddTags",
35976     "group": "Whatsapp_Interactions",
35977     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35978     "version": "0.0.0",
35979     "filename": "server/api/whatsappInteraction/index.js",
35980     "groupTitle": "Whatsapp_Interactions"
35981   },
35982   {
35983     "type": "post",
35984     "url": "/api/whatsapp/interactions",
35985     "title": "Creates a new Interaction",
35986     "examples": [
35987       {
35988         "title": "Example usage:",
35989         "content": "curl https://{domain}/api/whatsapp/interactions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
35990         "type": "json"
35991       }
35992     ],
35993     "name": "CreateInteractions",
35994     "group": "Whatsapp_Interactions",
35995     "parameter": {
35996       "fields": {
35997         "Body": [
35998           {
35999             "group": "Body",
36000             "type": "Boolean",
36001             "optional": true,
36002             "field": "closed",
36003             "description": ""
36004           },
36005           {
36006             "group": "Body",
36007             "type": "String",
36008             "optional": true,
36009             "field": "closedAt",
36010             "description": ""
36011           },
36012           {
36013             "group": "Body",
36014             "type": "String",
36015             "optional": true,
36016             "field": "disposition",
36017             "description": ""
36018           },
36019           {
36020             "group": "Body",
36021             "type": "String",
36022             "optional": true,
36023             "field": "secondDisposition",
36024             "description": ""
36025           },
36026           {
36027             "group": "Body",
36028             "type": "String",
36029             "optional": true,
36030             "field": "thirdDisposition",
36031             "description": ""
36032           },
36033           {
36034             "group": "Body",
36035             "type": "String",
36036             "optional": true,
36037             "field": "note",
36038             "description": ""
36039           },
36040           {
36041             "group": "Body",
36042             "type": "String",
36043             "optional": true,
36044             "field": "phone",
36045             "description": ""
36046           },
36047           {
36048             "group": "Body",
36049             "type": "String",
36050             "optional": true,
36051             "field": "read1stAt",
36052             "description": ""
36053           },
36054           {
36055             "group": "Body",
36056             "type": "String",
36057             "allowedValues": [
36058               "\"in\"",
36059               "\"out\""
36060             ],
36061             "optional": false,
36062             "field": "firstMsgDirection",
36063             "description": ""
36064           },
36065           {
36066             "group": "Body",
36067             "type": "String",
36068             "optional": true,
36069             "field": "lastMsgAt",
36070             "description": ""
36071           },
36072           {
36073             "group": "Body",
36074             "type": "String",
36075             "allowedValues": [
36076               "\"in\"",
36077               "\"out\""
36078             ],
36079             "optional": false,
36080             "field": "lastMsgDirection",
36081             "description": ""
36082           },
36083           {
36084             "group": "Body",
36085             "type": "Boolean",
36086             "optional": true,
36087             "field": "autoreplyExecuted",
36088             "description": ""
36089           }
36090         ]
36091       }
36092     },
36093     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36094     "version": "0.0.0",
36095     "filename": "server/api/whatsappInteraction/index.js",
36096     "groupTitle": "Whatsapp_Interactions"
36097   },
36098   {
36099     "type": "delete",
36100     "url": "/api/whatsapp/interactions/{id}",
36101     "title": "Deletes a Interaction",
36102     "examples": [
36103       {
36104         "title": "Example usage:",
36105         "content": "curl https://{domain}/api/whatsapp/interactions/{id} -v -u {name}:{password} -X DELETE",
36106         "type": "json"
36107       }
36108     ],
36109     "name": "DeleteInteractions",
36110     "group": "Whatsapp_Interactions",
36111     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36112     "version": "0.0.0",
36113     "filename": "server/api/whatsappInteraction/index.js",
36114     "groupTitle": "Whatsapp_Interactions"
36115   },
36116   {
36117     "type": "get",
36118     "url": "/api/whatsapp/interactions/describe",
36119     "title": "Gets table info about Interactions",
36120     "examples": [
36121       {
36122         "title": "Example usage:",
36123         "content": "curl https://{domain}/api/whatsapp/interactions/describe -v -u {name}:{password}",
36124         "type": "json"
36125       }
36126     ],
36127     "name": "DescribeInteractions",
36128     "group": "Whatsapp_Interactions",
36129     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36130     "version": "0.0.0",
36131     "filename": "server/api/whatsappInteraction/index.js",
36132     "groupTitle": "Whatsapp_Interactions"
36133   },
36134   {
36135     "type": "get",
36136     "url": "/api/whatsapp/interactions",
36137     "title": "Gets a list of Interactions",
36138     "examples": [
36139       {
36140         "title": "Example usage:",
36141         "content": "curl https://{domain}/api/whatsapp/interactions -v -u {name}:{password}",
36142         "type": "json"
36143       }
36144     ],
36145     "name": "GetInteractions",
36146     "group": "Whatsapp_Interactions",
36147     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
36148     "version": "0.0.0",
36149     "filename": "server/api/whatsappInteraction/index.js",
36150     "groupTitle": "Whatsapp_Interactions"
36151   },
36152   {
36153     "type": "delete",
36154     "url": "/api/whatsapp/interactions/{id}/tags",
36155     "title": "Removes tags from interaction",
36156     "examples": [
36157       {
36158         "title": "Example usage:",
36159         "content": "curl https://{domain}/api/whatsapp/interactions/{id}/tags?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
36160         "type": "json"
36161       }
36162     ],
36163     "name": "RemoveTags",
36164     "group": "Whatsapp_Interactions",
36165     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36166     "version": "0.0.0",
36167     "filename": "server/api/whatsappInteraction/index.js",
36168     "groupTitle": "Whatsapp_Interactions"
36169   },
36170   {
36171     "type": "get",
36172     "url": "/api/whatsapp/interactions/{id}",
36173     "title": "Gets a single Interaction",
36174     "examples": [
36175       {
36176         "title": "Example usage:",
36177         "content": "curl https://{domain}/api/whatsapp/interactions/{id} -v -u {name}:{password}",
36178         "type": "json"
36179       }
36180     ],
36181     "name": "ShowInteractions",
36182     "group": "Whatsapp_Interactions",
36183     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36184     "version": "0.0.0",
36185     "filename": "server/api/whatsappInteraction/index.js",
36186     "groupTitle": "Whatsapp_Interactions"
36187   },
36188   {
36189     "type": "post",
36190     "url": "/api/whatsapp/interactions/{id}/messages",
36191     "title": "Creates new messages",
36192     "examples": [
36193       {
36194         "title": "Example usage:",
36195         "content": "curl https://{domain}/api/whatsapp/interactions/{id}/messages -d '[{\"to\": \"+3901119886500\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
36196         "type": "json"
36197       }
36198     ],
36199     "name": "addMessage",
36200     "group": "Whatsapp_Interactions",
36201     "parameter": {
36202       "fields": {
36203         "Body": [
36204           {
36205             "group": "Body",
36206             "type": "Text",
36207             "optional": false,
36208             "field": "body",
36209             "description": ""
36210           },
36211           {
36212             "group": "Body",
36213             "type": "Boolean",
36214             "optional": true,
36215             "field": "read",
36216             "description": ""
36217           },
36218           {
36219             "group": "Body",
36220             "type": "String",
36221             "allowedValues": [
36222               "\"in\"",
36223               "\"out\""
36224             ],
36225             "optional": false,
36226             "field": "direction",
36227             "description": ""
36228           },
36229           {
36230             "group": "Body",
36231             "type": "String",
36232             "optional": true,
36233             "field": "messageId",
36234             "description": ""
36235           },
36236           {
36237             "group": "Body",
36238             "type": "String",
36239             "optional": true,
36240             "field": "phone",
36241             "description": ""
36242           },
36243           {
36244             "group": "Body",
36245             "type": "String",
36246             "optional": true,
36247             "field": "readAt",
36248             "description": ""
36249           },
36250           {
36251             "group": "Body",
36252             "type": "Boolean",
36253             "optional": true,
36254             "field": "secret",
36255             "description": ""
36256           },
36257           {
36258             "group": "Body",
36259             "type": "String",
36260             "optional": true,
36261             "field": "providerName",
36262             "description": ""
36263           },
36264           {
36265             "group": "Body",
36266             "type": "Text",
36267             "optional": true,
36268             "field": "providerResponse",
36269             "description": ""
36270           }
36271         ]
36272       }
36273     },
36274     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36275     "version": "0.0.0",
36276     "filename": "server/api/whatsappInteraction/index.js",
36277     "groupTitle": "Whatsapp_Interactions"
36278   },
36279   {
36280     "type": "get",
36281     "url": "/api/whatsapp/interactions/{id}/download",
36282     "title": "Gets interaction",
36283     "examples": [
36284       {
36285         "title": "Example usage:",
36286         "content": "curl https://{domain}/api/whatsapp/interactions/{id}/download -v -u {name}:{password} -X GET",
36287         "type": "json"
36288       }
36289     ],
36290     "name": "download",
36291     "group": "Whatsapp_Interactions",
36292     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36293     "version": "0.0.0",
36294     "filename": "server/api/whatsappInteraction/index.js",
36295     "groupTitle": "Whatsapp_Interactions"
36296   },
36297   {
36298     "type": "get",
36299     "url": "/api/whatsapp/interactions/{id}/messages",
36300     "title": "Gets interaction messages",
36301     "examples": [
36302       {
36303         "title": "Example usage:",
36304         "content": "curl https://{domain}/api/whatsapp/interactions/{id}/messages -v -u {name}:{password} -X GET",
36305         "type": "json"
36306       }
36307     ],
36308     "name": "getMessages",
36309     "group": "Whatsapp_Interactions",
36310     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36311     "version": "0.0.0",
36312     "filename": "server/api/whatsappInteraction/index.js",
36313     "groupTitle": "Whatsapp_Interactions"
36314   },
36315   {
36316     "type": "put",
36317     "url": "/api/whatsapp/interactions/{id}",
36318     "title": "Update an existing Interaction",
36319     "examples": [
36320       {
36321         "title": "Example usage:",
36322         "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",
36323         "type": "json"
36324       }
36325     ],
36326     "name": "updateInteractions",
36327     "group": "Whatsapp_Interactions",
36328     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36329     "version": "0.0.0",
36330     "filename": "server/api/whatsappInteraction/index.js",
36331     "groupTitle": "Whatsapp_Interactions"
36332   },
36333   {
36334     "type": "post",
36335     "url": "/api/whatsapp/messages",
36336     "title": "Creates a new Message",
36337     "examples": [
36338       {
36339         "title": "Example usage:",
36340         "content": "curl https://{domain}/api/whatsapp/messages -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
36341         "type": "json"
36342       }
36343     ],
36344     "name": "CreateMessages",
36345     "group": "Whatsapp_Messages",
36346     "parameter": {
36347       "fields": {
36348         "Body": [
36349           {
36350             "group": "Body",
36351             "type": "Text",
36352             "optional": false,
36353             "field": "body",
36354             "description": ""
36355           },
36356           {
36357             "group": "Body",
36358             "type": "Boolean",
36359             "optional": true,
36360             "field": "read",
36361             "description": ""
36362           },
36363           {
36364             "group": "Body",
36365             "type": "String",
36366             "allowedValues": [
36367               "\"in\"",
36368               "\"out\""
36369             ],
36370             "optional": false,
36371             "field": "direction",
36372             "description": ""
36373           },
36374           {
36375             "group": "Body",
36376             "type": "String",
36377             "optional": true,
36378             "field": "messageId",
36379             "description": ""
36380           },
36381           {
36382             "group": "Body",
36383             "type": "String",
36384             "optional": true,
36385             "field": "phone",
36386             "description": ""
36387           },
36388           {
36389             "group": "Body",
36390             "type": "String",
36391             "optional": true,
36392             "field": "readAt",
36393             "description": ""
36394           },
36395           {
36396             "group": "Body",
36397             "type": "Boolean",
36398             "optional": true,
36399             "field": "secret",
36400             "description": ""
36401           },
36402           {
36403             "group": "Body",
36404             "type": "String",
36405             "optional": true,
36406             "field": "providerName",
36407             "description": ""
36408           },
36409           {
36410             "group": "Body",
36411             "type": "Text",
36412             "optional": true,
36413             "field": "providerResponse",
36414             "description": ""
36415           }
36416         ]
36417       }
36418     },
36419     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36420     "version": "0.0.0",
36421     "filename": "server/api/whatsappMessage/index.js",
36422     "groupTitle": "Whatsapp_Messages"
36423   },
36424   {
36425     "type": "delete",
36426     "url": "/api/whatsapp/messages/{id}",
36427     "title": "Deletes a Message",
36428     "examples": [
36429       {
36430         "title": "Example usage:",
36431         "content": "curl https://{domain}/api/whatsapp/messages/{id} -v -u {name}:{password} -X DELETE",
36432         "type": "json"
36433       }
36434     ],
36435     "name": "DeleteMessages",
36436     "group": "Whatsapp_Messages",
36437     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36438     "version": "0.0.0",
36439     "filename": "server/api/whatsappMessage/index.js",
36440     "groupTitle": "Whatsapp_Messages"
36441   },
36442   {
36443     "type": "get",
36444     "url": "/api/whatsapp/messages/describe",
36445     "title": "Gets table info about Messages",
36446     "examples": [
36447       {
36448         "title": "Example usage:",
36449         "content": "curl https://{domain}/api/whatsapp/messages/describe -v -u {name}:{password}",
36450         "type": "json"
36451       }
36452     ],
36453     "name": "DescribeMessages",
36454     "group": "Whatsapp_Messages",
36455     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36456     "version": "0.0.0",
36457     "filename": "server/api/whatsappMessage/index.js",
36458     "groupTitle": "Whatsapp_Messages"
36459   },
36460   {
36461     "type": "get",
36462     "url": "/api/whatsapp/messages",
36463     "title": "Gets a list of Messages",
36464     "examples": [
36465       {
36466         "title": "Example usage:",
36467         "content": "curl https://{domain}/api/whatsapp/messages -v -u {name}:{password}",
36468         "type": "json"
36469       }
36470     ],
36471     "name": "GetMessages",
36472     "group": "Whatsapp_Messages",
36473     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
36474     "version": "0.0.0",
36475     "filename": "server/api/whatsappMessage/index.js",
36476     "groupTitle": "Whatsapp_Messages"
36477   },
36478   {
36479     "type": "get",
36480     "url": "/api/whatsapp/messages/{id}",
36481     "title": "Gets a single Message",
36482     "examples": [
36483       {
36484         "title": "Example usage:",
36485         "content": "curl https://{domain}/api/whatsapp/messages/{id} -v -u {name}:{password}",
36486         "type": "json"
36487       }
36488     ],
36489     "name": "ShowMessages",
36490     "group": "Whatsapp_Messages",
36491     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36492     "version": "0.0.0",
36493     "filename": "server/api/whatsappMessage/index.js",
36494     "groupTitle": "Whatsapp_Messages"
36495   },
36496   {
36497     "type": "put",
36498     "url": "/api/whatsapp/messages/{id}",
36499     "title": "Update an existing Message",
36500     "examples": [
36501       {
36502         "title": "Example usage:",
36503         "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",
36504         "type": "json"
36505       }
36506     ],
36507     "name": "updateMessages",
36508     "group": "Whatsapp_Messages",
36509     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36510     "version": "0.0.0",
36511     "filename": "server/api/whatsappMessage/index.js",
36512     "groupTitle": "Whatsapp_Messages"
36513   },
36514   {
36515     "type": "post",
36516     "url": "/api/whatsapp/reports/queue",
36517     "title": "Creates a new Whatsapp Queue Report",
36518     "examples": [
36519       {
36520         "title": "Example usage:",
36521         "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",
36522         "type": "json"
36523       }
36524     ],
36525     "name": "CreateWhatsapp_Queue_Reports",
36526     "group": "Whatsapp_Queue_Reports",
36527     "parameter": {
36528       "fields": {
36529         "Body": [
36530           {
36531             "group": "Body",
36532             "type": "String",
36533             "optional": false,
36534             "field": "uniqueid",
36535             "description": ""
36536           },
36537           {
36538             "group": "Body",
36539             "type": "String",
36540             "optional": true,
36541             "field": "from",
36542             "description": ""
36543           },
36544           {
36545             "group": "Body",
36546             "type": "String",
36547             "optional": true,
36548             "field": "joinAt",
36549             "description": ""
36550           },
36551           {
36552             "group": "Body",
36553             "type": "String",
36554             "optional": true,
36555             "field": "leaveAt",
36556             "description": ""
36557           },
36558           {
36559             "group": "Body",
36560             "type": "String",
36561             "optional": true,
36562             "field": "acceptAt",
36563             "description": ""
36564           },
36565           {
36566             "group": "Body",
36567             "type": "String",
36568             "optional": true,
36569             "field": "exitAt",
36570             "description": ""
36571           },
36572           {
36573             "group": "Body",
36574             "type": "String",
36575             "optional": true,
36576             "field": "reason",
36577             "description": ""
36578           }
36579         ]
36580       }
36581     },
36582     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36583     "version": "0.0.0",
36584     "filename": "server/api/whatsappQueueReport/index.js",
36585     "groupTitle": "Whatsapp_Queue_Reports"
36586   },
36587   {
36588     "type": "delete",
36589     "url": "/api/whatsapp/reports/queue/{id}",
36590     "title": "Deletes a Whatsapp Queue Report",
36591     "examples": [
36592       {
36593         "title": "Example usage:",
36594         "content": "curl https://{domain}/api/whatsapp/reports/queue/{id} -v -u {name}:{password} -X DELETE",
36595         "type": "json"
36596       }
36597     ],
36598     "name": "DeleteWhatsapp_Queue_Reports",
36599     "group": "Whatsapp_Queue_Reports",
36600     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36601     "version": "0.0.0",
36602     "filename": "server/api/whatsappQueueReport/index.js",
36603     "groupTitle": "Whatsapp_Queue_Reports"
36604   },
36605   {
36606     "type": "get",
36607     "url": "/api/whatsapp/reports/queue/describe",
36608     "title": "Gets table info about Whatsapp Queue Reports",
36609     "examples": [
36610       {
36611         "title": "Example usage:",
36612         "content": "curl https://{domain}/api/whatsapp/reports/queue/describe -v -u {name}:{password}",
36613         "type": "json"
36614       }
36615     ],
36616     "name": "DescribeWhatsapp_Queue_Reports",
36617     "group": "Whatsapp_Queue_Reports",
36618     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36619     "version": "0.0.0",
36620     "filename": "server/api/whatsappQueueReport/index.js",
36621     "groupTitle": "Whatsapp_Queue_Reports"
36622   },
36623   {
36624     "type": "get",
36625     "url": "/api/whatsapp/reports/queue",
36626     "title": "Gets a list of Whatsapp Queue Reports",
36627     "examples": [
36628       {
36629         "title": "Example usage:",
36630         "content": "curl https://{domain}/api/whatsapp/reports/queue -v -u {name}:{password}",
36631         "type": "json"
36632       }
36633     ],
36634     "name": "GetWhatsapp_Queue_Reports",
36635     "group": "Whatsapp_Queue_Reports",
36636     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
36637     "version": "0.0.0",
36638     "filename": "server/api/whatsappQueueReport/index.js",
36639     "groupTitle": "Whatsapp_Queue_Reports"
36640   },
36641   {
36642     "type": "get",
36643     "url": "/api/whatsapp/reports/queue/{id}",
36644     "title": "Gets a single Whatsapp Queue Report",
36645     "examples": [
36646       {
36647         "title": "Example usage:",
36648         "content": "curl https://{domain}/api/whatsapp/reports/queue/{id} -v -u {name}:{password}",
36649         "type": "json"
36650       }
36651     ],
36652     "name": "ShowWhatsapp_Queue_Reports",
36653     "group": "Whatsapp_Queue_Reports",
36654     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36655     "version": "0.0.0",
36656     "filename": "server/api/whatsappQueueReport/index.js",
36657     "groupTitle": "Whatsapp_Queue_Reports"
36658   },
36659   {
36660     "type": "put",
36661     "url": "/api/whatsapp/reports/queue/{id}",
36662     "title": "Update an existing Whatsapp Queue Report",
36663     "examples": [
36664       {
36665         "title": "Example usage:",
36666         "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",
36667         "type": "json"
36668       }
36669     ],
36670     "name": "updateWhatsapp_Queue_Reports",
36671     "group": "Whatsapp_Queue_Reports",
36672     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36673     "version": "0.0.0",
36674     "filename": "server/api/whatsappQueueReport/index.js",
36675     "groupTitle": "Whatsapp_Queue_Reports"
36676   },
36677   {
36678     "type": "post",
36679     "url": "/api/whatsapp/queues/{id}/users",
36680     "title": "Add agents to a queue",
36681     "examples": [
36682       {
36683         "title": "Example usage:",
36684         "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",
36685         "type": "json"
36686       }
36687     ],
36688     "name": "AddAgents",
36689     "group": "Whatsapp_Queues",
36690     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36691     "version": "0.0.0",
36692     "filename": "server/api/whatsappQueue/index.js",
36693     "groupTitle": "Whatsapp_Queues"
36694   },
36695   {
36696     "type": "post",
36697     "url": "/api/whatsapp/queues/{id}/teams",
36698     "title": "Add teams to a queue",
36699     "examples": [
36700       {
36701         "title": "Example usage:",
36702         "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",
36703         "type": "json"
36704       }
36705     ],
36706     "name": "AddTeams",
36707     "group": "Whatsapp_Queues",
36708     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36709     "version": "0.0.0",
36710     "filename": "server/api/whatsappQueue/index.js",
36711     "groupTitle": "Whatsapp_Queues"
36712   },
36713   {
36714     "type": "post",
36715     "url": "/api/whatsapp/queues",
36716     "title": "Creates a new Queue",
36717     "examples": [
36718       {
36719         "title": "Example usage:",
36720         "content": "curl https://{domain}/api/whatsapp/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
36721         "type": "json"
36722       }
36723     ],
36724     "name": "CreateQueues",
36725     "group": "Whatsapp_Queues",
36726     "parameter": {
36727       "fields": {
36728         "Body": [
36729           {
36730             "group": "Body",
36731             "type": "String",
36732             "optional": true,
36733             "field": "name",
36734             "description": ""
36735           },
36736           {
36737             "group": "Body",
36738             "type": "Integer",
36739             "optional": true,
36740             "field": "timeout",
36741             "description": ""
36742           },
36743           {
36744             "group": "Body",
36745             "type": "String",
36746             "allowedValues": [
36747               "\"rrmemory\"",
36748               "\"beepall\"",
36749               "\"roundrobin\""
36750             ],
36751             "optional": true,
36752             "field": "strategy",
36753             "description": ""
36754           },
36755           {
36756             "group": "Body",
36757             "type": "String",
36758             "optional": true,
36759             "field": "description",
36760             "description": ""
36761           }
36762         ]
36763       }
36764     },
36765     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36766     "version": "0.0.0",
36767     "filename": "server/api/whatsappQueue/index.js",
36768     "groupTitle": "Whatsapp_Queues"
36769   },
36770   {
36771     "type": "delete",
36772     "url": "/api/whatsapp/queues/{id}",
36773     "title": "Deletes a Queue",
36774     "examples": [
36775       {
36776         "title": "Example usage:",
36777         "content": "curl https://{domain}/api/whatsapp/queues/{id} -v -u {name}:{password} -X DELETE",
36778         "type": "json"
36779       }
36780     ],
36781     "name": "DeleteQueues",
36782     "group": "Whatsapp_Queues",
36783     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36784     "version": "0.0.0",
36785     "filename": "server/api/whatsappQueue/index.js",
36786     "groupTitle": "Whatsapp_Queues"
36787   },
36788   {
36789     "type": "get",
36790     "url": "/api/whatsapp/queues/describe",
36791     "title": "Gets table info about Queues",
36792     "examples": [
36793       {
36794         "title": "Example usage:",
36795         "content": "curl https://{domain}/api/whatsapp/queues/describe -v -u {name}:{password}",
36796         "type": "json"
36797       }
36798     ],
36799     "name": "DescribeQueues",
36800     "group": "Whatsapp_Queues",
36801     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36802     "version": "0.0.0",
36803     "filename": "server/api/whatsappQueue/index.js",
36804     "groupTitle": "Whatsapp_Queues"
36805   },
36806   {
36807     "type": "get",
36808     "url": "/api/whatsapp/queues/{id}/users",
36809     "title": "Gets queue agents",
36810     "examples": [
36811       {
36812         "title": "Example usage:",
36813         "content": "curl https://{domain}/api/whatsapp/queues/{id}/users -v -u {name}:{password} -X POST",
36814         "type": "json"
36815       }
36816     ],
36817     "name": "GetAgents",
36818     "group": "Whatsapp_Queues",
36819     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36820     "version": "0.0.0",
36821     "filename": "server/api/whatsappQueue/index.js",
36822     "groupTitle": "Whatsapp_Queues"
36823   },
36824   {
36825     "type": "get",
36826     "url": "/api/whatsapp/queues/{id}/members",
36827     "title": "GetMembers",
36828     "examples": [
36829       {
36830         "title": "Example usage:",
36831         "content": "curl https://{domain}/api/whatsapp/queues/{id}/members  -v -u {name}:{password}",
36832         "type": "json"
36833       }
36834     ],
36835     "name": "GetMembers",
36836     "group": "Whatsapp_Queues",
36837     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36838     "version": "0.0.0",
36839     "filename": "server/api/whatsappQueue/index.js",
36840     "groupTitle": "Whatsapp_Queues"
36841   },
36842   {
36843     "type": "get",
36844     "url": "/api/whatsapp/queues",
36845     "title": "Gets a list of Queues",
36846     "examples": [
36847       {
36848         "title": "Example usage:",
36849         "content": "curl https://{domain}/api/whatsapp/queues -v -u {name}:{password}",
36850         "type": "json"
36851       }
36852     ],
36853     "name": "GetQueues",
36854     "group": "Whatsapp_Queues",
36855     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
36856     "version": "0.0.0",
36857     "filename": "server/api/whatsappQueue/index.js",
36858     "groupTitle": "Whatsapp_Queues"
36859   },
36860   {
36861     "type": "get",
36862     "url": "/api/whatsapp/queues/{id}/teams",
36863     "title": "Gets queues list",
36864     "examples": [
36865       {
36866         "title": "Example usage:",
36867         "content": "curl https://{domain}/api/whatsapp/queues/{id}/teams -v -u {name}:{password}",
36868         "type": "json"
36869       }
36870     ],
36871     "name": "GetTeams",
36872     "group": "Whatsapp_Queues",
36873     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36874     "version": "0.0.0",
36875     "filename": "server/api/whatsappQueue/index.js",
36876     "groupTitle": "Whatsapp_Queues"
36877   },
36878   {
36879     "type": "delete",
36880     "url": "/api/whatsapp/queues/{id}/users",
36881     "title": "Removes agents from a queue",
36882     "examples": [
36883       {
36884         "title": "Example usage:",
36885         "content": "curl https://{domain}/api/whatsapp/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
36886         "type": "json"
36887       }
36888     ],
36889     "name": "RemoveAgents",
36890     "group": "Whatsapp_Queues",
36891     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36892     "version": "0.0.0",
36893     "filename": "server/api/whatsappQueue/index.js",
36894     "groupTitle": "Whatsapp_Queues"
36895   },
36896   {
36897     "type": "get",
36898     "url": "/api/whatsapp/queues/{id}",
36899     "title": "Gets a single Queue",
36900     "examples": [
36901       {
36902         "title": "Example usage:",
36903         "content": "curl https://{domain}/api/whatsapp/queues/{id} -v -u {name}:{password}",
36904         "type": "json"
36905       }
36906     ],
36907     "name": "ShowQueues",
36908     "group": "Whatsapp_Queues",
36909     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36910     "version": "0.0.0",
36911     "filename": "server/api/whatsappQueue/index.js",
36912     "groupTitle": "Whatsapp_Queues"
36913   },
36914   {
36915     "type": "put",
36916     "url": "/api/whatsapp/queues/{id}",
36917     "title": "Update an existing Queue",
36918     "examples": [
36919       {
36920         "title": "Example usage:",
36921         "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",
36922         "type": "json"
36923       }
36924     ],
36925     "name": "updateQueues",
36926     "group": "Whatsapp_Queues",
36927     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36928     "version": "0.0.0",
36929     "filename": "server/api/whatsappQueue/index.js",
36930     "groupTitle": "Whatsapp_Queues"
36931   },
36932   {
36933     "type": "post",
36934     "url": "/api/whatsapp/reports/transfer",
36935     "title": "Creates a new Whatsapp Transfer Report",
36936     "examples": [
36937       {
36938         "title": "Example usage:",
36939         "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",
36940         "type": "json"
36941       }
36942     ],
36943     "name": "CreateWhatsapp_Transfer_Reports",
36944     "group": "Whatsapp_Transfer_Reports",
36945     "parameter": {
36946       "fields": {
36947         "Body": [
36948           {
36949             "group": "Body",
36950             "type": "String",
36951             "optional": false,
36952             "field": "uniqueid",
36953             "description": ""
36954           },
36955           {
36956             "group": "Body",
36957             "type": "String",
36958             "allowedValues": [
36959               "\"account\"",
36960               "\"agent\"",
36961               "\"queue\""
36962             ],
36963             "optional": false,
36964             "field": "type",
36965             "description": ""
36966           },
36967           {
36968             "group": "Body",
36969             "type": "String",
36970             "optional": true,
36971             "field": "transferredAt",
36972             "description": ""
36973           }
36974         ]
36975       }
36976     },
36977     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36978     "version": "0.0.0",
36979     "filename": "server/api/whatsappTransferReport/index.js",
36980     "groupTitle": "Whatsapp_Transfer_Reports"
36981   },
36982   {
36983     "type": "delete",
36984     "url": "/api/whatsapp/reports/transfer/{id}",
36985     "title": "Deletes a Whatsapp Transfer Report",
36986     "examples": [
36987       {
36988         "title": "Example usage:",
36989         "content": "curl https://{domain}/api/whatsapp/reports/transfer/{id} -v -u {name}:{password} -X DELETE",
36990         "type": "json"
36991       }
36992     ],
36993     "name": "DeleteWhatsapp_Transfer_Reports",
36994     "group": "Whatsapp_Transfer_Reports",
36995     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36996     "version": "0.0.0",
36997     "filename": "server/api/whatsappTransferReport/index.js",
36998     "groupTitle": "Whatsapp_Transfer_Reports"
36999   },
37000   {
37001     "type": "get",
37002     "url": "/api/whatsapp/reports/transfer/describe",
37003     "title": "Gets table info about Whatsapp Transfer Reports",
37004     "examples": [
37005       {
37006         "title": "Example usage:",
37007         "content": "curl https://{domain}/api/whatsapp/reports/transfer/describe -v -u {name}:{password}",
37008         "type": "json"
37009       }
37010     ],
37011     "name": "DescribeWhatsapp_Transfer_Reports",
37012     "group": "Whatsapp_Transfer_Reports",
37013     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37014     "version": "0.0.0",
37015     "filename": "server/api/whatsappTransferReport/index.js",
37016     "groupTitle": "Whatsapp_Transfer_Reports"
37017   },
37018   {
37019     "type": "get",
37020     "url": "/api/whatsapp/reports/transfer",
37021     "title": "Gets a list of Whatsapp Transfer Reports",
37022     "examples": [
37023       {
37024         "title": "Example usage:",
37025         "content": "curl https://{domain}/api/whatsapp/reports/transfer -v -u {name}:{password}",
37026         "type": "json"
37027       }
37028     ],
37029     "name": "GetWhatsapp_Transfer_Reports",
37030     "group": "Whatsapp_Transfer_Reports",
37031     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
37032     "version": "0.0.0",
37033     "filename": "server/api/whatsappTransferReport/index.js",
37034     "groupTitle": "Whatsapp_Transfer_Reports"
37035   },
37036   {
37037     "type": "get",
37038     "url": "/api/whatsapp/reports/transfer/{id}",
37039     "title": "Gets a single Whatsapp Transfer Report",
37040     "examples": [
37041       {
37042         "title": "Example usage:",
37043         "content": "curl https://{domain}/api/whatsapp/reports/transfer/{id} -v -u {name}:{password}",
37044         "type": "json"
37045       }
37046     ],
37047     "name": "ShowWhatsapp_Transfer_Reports",
37048     "group": "Whatsapp_Transfer_Reports",
37049     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37050     "version": "0.0.0",
37051     "filename": "server/api/whatsappTransferReport/index.js",
37052     "groupTitle": "Whatsapp_Transfer_Reports"
37053   },
37054   {
37055     "type": "put",
37056     "url": "/api/whatsapp/reports/transfer/{id}",
37057     "title": "Update an existing Whatsapp Transfer Report",
37058     "examples": [
37059       {
37060         "title": "Example usage:",
37061         "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",
37062         "type": "json"
37063       }
37064     ],
37065     "name": "updateWhatsapp_Transfer_Reports",
37066     "group": "Whatsapp_Transfer_Reports",
37067     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37068     "version": "0.0.0",
37069     "filename": "server/api/whatsappTransferReport/index.js",
37070     "groupTitle": "Whatsapp_Transfer_Reports"
37071   },
37072   {
37073     "type": "post",
37074     "url": "/api/integrations/zendesk/accounts",
37075     "title": "Creates a new Zendesk Account",
37076     "examples": [
37077       {
37078         "title": "Example usage:",
37079         "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",
37080         "type": "json"
37081       }
37082     ],
37083     "name": "CreateZendesk_Accounts",
37084     "group": "Zendesk_Accounts",
37085     "parameter": {
37086       "fields": {
37087         "Body": [
37088           {
37089             "group": "Body",
37090             "type": "String",
37091             "optional": true,
37092             "field": "name",
37093             "description": ""
37094           },
37095           {
37096             "group": "Body",
37097             "type": "String",
37098             "optional": true,
37099             "field": "description",
37100             "description": ""
37101           },
37102           {
37103             "group": "Body",
37104             "type": "String",
37105             "optional": true,
37106             "field": "username",
37107             "description": ""
37108           },
37109           {
37110             "group": "Body",
37111             "type": "String",
37112             "optional": true,
37113             "field": "password",
37114             "description": ""
37115           },
37116           {
37117             "group": "Body",
37118             "type": "String",
37119             "optional": true,
37120             "field": "token",
37121             "description": ""
37122           },
37123           {
37124             "group": "Body",
37125             "type": "String",
37126             "optional": true,
37127             "field": "remoteUri",
37128             "description": ""
37129           },
37130           {
37131             "group": "Body",
37132             "type": "String",
37133             "allowedValues": [
37134               "\"password\"",
37135               "\"token\""
37136             ],
37137             "optional": true,
37138             "field": "authType",
37139             "description": ""
37140           },
37141           {
37142             "group": "Body",
37143             "type": "String",
37144             "optional": false,
37145             "field": "serverUrl",
37146             "description": ""
37147           },
37148           {
37149             "group": "Body",
37150             "type": "String",
37151             "allowedValues": [
37152               "\"integrationTab\"",
37153               "\"newTab\""
37154             ],
37155             "optional": true,
37156             "field": "type",
37157             "description": ""
37158           }
37159         ]
37160       }
37161     },
37162     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37163     "version": "0.0.0",
37164     "filename": "server/api/intZendeskAccount/index.js",
37165     "groupTitle": "Zendesk_Accounts"
37166   },
37167   {
37168     "type": "delete",
37169     "url": "/api/integrations/zendesk/accounts/{id}",
37170     "title": "Deletes a Zendesk Account",
37171     "examples": [
37172       {
37173         "title": "Example usage:",
37174         "content": "curl https://{domain}/api/integrations/zendesk/accounts/{id} -v -u {name}:{password} -X DELETE",
37175         "type": "json"
37176       }
37177     ],
37178     "name": "DeleteZendesk_Accounts",
37179     "group": "Zendesk_Accounts",
37180     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37181     "version": "0.0.0",
37182     "filename": "server/api/intZendeskAccount/index.js",
37183     "groupTitle": "Zendesk_Accounts"
37184   },
37185   {
37186     "type": "get",
37187     "url": "/api/integrations/zendesk/accounts",
37188     "title": "Gets a list of Zendesk Accounts",
37189     "examples": [
37190       {
37191         "title": "Example usage:",
37192         "content": "curl https://{domain}/api/integrations/zendesk/accounts -v -u {name}:{password}",
37193         "type": "json"
37194       }
37195     ],
37196     "name": "GetZendesk_Accounts",
37197     "group": "Zendesk_Accounts",
37198     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
37199     "version": "0.0.0",
37200     "filename": "server/api/intZendeskAccount/index.js",
37201     "groupTitle": "Zendesk_Accounts"
37202   },
37203   {
37204     "type": "get",
37205     "url": "/api/integrations/zendesk/accounts/{id}",
37206     "title": "Gets a single Zendesk Account",
37207     "examples": [
37208       {
37209         "title": "Example usage:",
37210         "content": "curl https://{domain}/api/integrations/zendesk/accounts/{id} -v -u {name}:{password}",
37211         "type": "json"
37212       }
37213     ],
37214     "name": "ShowZendesk_Accounts",
37215     "group": "Zendesk_Accounts",
37216     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37217     "version": "0.0.0",
37218     "filename": "server/api/intZendeskAccount/index.js",
37219     "groupTitle": "Zendesk_Accounts"
37220   },
37221   {
37222     "type": "post",
37223     "url": "/api/integrations/zendesk/accounts/{id}/configurations",
37224     "title": "Creates new configuration",
37225     "examples": [
37226       {
37227         "title": "Example usage:",
37228         "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",
37229         "type": "json"
37230       }
37231     ],
37232     "name": "addConfiguration",
37233     "group": "Zendesk_Accounts",
37234     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37235     "version": "0.0.0",
37236     "filename": "server/api/intZendeskAccount/index.js",
37237     "groupTitle": "Zendesk_Accounts"
37238   },
37239   {
37240     "type": "get",
37241     "url": "/api/integrations/zendesk/accounts/{id}/configurations",
37242     "title": "Gets account configurations",
37243     "examples": [
37244       {
37245         "title": "Example usage:",
37246         "content": "curl https://{domain}/api/integrations/zendesk/accounts/{id}/configurations -v -u {name}:{password} -X GET",
37247         "type": "json"
37248       }
37249     ],
37250     "name": "getConfigurations",
37251     "group": "Zendesk_Accounts",
37252     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37253     "version": "0.0.0",
37254     "filename": "server/api/intZendeskAccount/index.js",
37255     "groupTitle": "Zendesk_Accounts"
37256   },
37257   {
37258     "type": "get",
37259     "url": "/api/integrations/zendesk/accounts/{id}/fields",
37260     "title": "Gets account fields",
37261     "examples": [
37262       {
37263         "title": "Example usage:",
37264         "content": "curl https://{domain}/api/integrations/zendesk/accounts/{id}/fields -v -u {name}:{password} -X GET",
37265         "type": "json"
37266       }
37267     ],
37268     "name": "getFields",
37269     "group": "Zendesk_Accounts",
37270     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37271     "version": "0.0.0",
37272     "filename": "server/api/intZendeskAccount/index.js",
37273     "groupTitle": "Zendesk_Accounts"
37274   },
37275   {
37276     "type": "put",
37277     "url": "/api/integrations/zendesk/accounts/{id}",
37278     "title": "Update an existing Zendesk Account",
37279     "examples": [
37280       {
37281         "title": "Example usage:",
37282         "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",
37283         "type": "json"
37284       }
37285     ],
37286     "name": "updateZendesk_Accounts",
37287     "group": "Zendesk_Accounts",
37288     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37289     "version": "0.0.0",
37290     "filename": "server/api/intZendeskAccount/index.js",
37291     "groupTitle": "Zendesk_Accounts"
37292   },
37293   {
37294     "type": "post",
37295     "url": "/api/integrations/zendesk/configurations",
37296     "title": "Creates a new Zendesk Configuration",
37297     "examples": [
37298       {
37299         "title": "Example usage:",
37300         "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",
37301         "type": "json"
37302       }
37303     ],
37304     "name": "CreateZendesk_Configurations",
37305     "group": "Zendesk_Configurations",
37306     "parameter": {
37307       "fields": {
37308         "Body": [
37309           {
37310             "group": "Body",
37311             "type": "String",
37312             "optional": true,
37313             "field": "name",
37314             "description": ""
37315           },
37316           {
37317             "group": "Body",
37318             "type": "String",
37319             "optional": true,
37320             "field": "description",
37321             "description": ""
37322           }
37323         ]
37324       }
37325     },
37326     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37327     "version": "0.0.0",
37328     "filename": "server/api/intZendeskConfiguration/index.js",
37329     "groupTitle": "Zendesk_Configurations"
37330   },
37331   {
37332     "type": "delete",
37333     "url": "/api/integrations/zendesk/configurations/{id}",
37334     "title": "Deletes a Zendesk Configuration",
37335     "examples": [
37336       {
37337         "title": "Example usage:",
37338         "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id} -v -u {name}:{password} -X DELETE",
37339         "type": "json"
37340       }
37341     ],
37342     "name": "DeleteZendesk_Configurations",
37343     "group": "Zendesk_Configurations",
37344     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37345     "version": "0.0.0",
37346     "filename": "server/api/intZendeskConfiguration/index.js",
37347     "groupTitle": "Zendesk_Configurations"
37348   },
37349   {
37350     "type": "get",
37351     "url": "/api/integrations/zendesk/configurations",
37352     "title": "Gets a list of Zendesk Configurations",
37353     "examples": [
37354       {
37355         "title": "Example usage:",
37356         "content": "curl https://{domain}/api/integrations/zendesk/configurations -v -u {name}:{password}",
37357         "type": "json"
37358       }
37359     ],
37360     "name": "GetZendesk_Configurations",
37361     "group": "Zendesk_Configurations",
37362     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
37363     "version": "0.0.0",
37364     "filename": "server/api/intZendeskConfiguration/index.js",
37365     "groupTitle": "Zendesk_Configurations"
37366   },
37367   {
37368     "type": "get",
37369     "url": "/api/integrations/zendesk/configurations/{id}",
37370     "title": "Gets a single Zendesk Configuration",
37371     "examples": [
37372       {
37373         "title": "Example usage:",
37374         "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id} -v -u {name}:{password}",
37375         "type": "json"
37376       }
37377     ],
37378     "name": "ShowZendesk_Configurations",
37379     "group": "Zendesk_Configurations",
37380     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37381     "version": "0.0.0",
37382     "filename": "server/api/intZendeskConfiguration/index.js",
37383     "groupTitle": "Zendesk_Configurations"
37384   },
37385   {
37386     "type": "get",
37387     "url": "/api/integrations/zendesk/configurations/{id}/descriptions",
37388     "title": "Gets configurations descriptions",
37389     "examples": [
37390       {
37391         "title": "Example usage:",
37392         "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
37393         "type": "json"
37394       }
37395     ],
37396     "name": "getDescriptions",
37397     "group": "Zendesk_Configurations",
37398     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37399     "version": "0.0.0",
37400     "filename": "server/api/intZendeskConfiguration/index.js",
37401     "groupTitle": "Zendesk_Configurations"
37402   },
37403   {
37404     "type": "get",
37405     "url": "/api/integrations/zendesk/configurations/{id}/fields",
37406     "title": "Gets configurations fields",
37407     "examples": [
37408       {
37409         "title": "Example usage:",
37410         "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id}/fields -v -u {name}:{password} -X GET",
37411         "type": "json"
37412       }
37413     ],
37414     "name": "getFields",
37415     "group": "Zendesk_Configurations",
37416     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37417     "version": "0.0.0",
37418     "filename": "server/api/intZendeskConfiguration/index.js",
37419     "groupTitle": "Zendesk_Configurations"
37420   },
37421   {
37422     "type": "get",
37423     "url": "/api/integrations/zendesk/configurations/{id}/subjects",
37424     "title": "Gets configurations subjects",
37425     "examples": [
37426       {
37427         "title": "Example usage:",
37428         "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id}/subjects -v -u {name}:{password} -X GET",
37429         "type": "json"
37430       }
37431     ],
37432     "name": "getSubjects",
37433     "group": "Zendesk_Configurations",
37434     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37435     "version": "0.0.0",
37436     "filename": "server/api/intZendeskConfiguration/index.js",
37437     "groupTitle": "Zendesk_Configurations"
37438   },
37439   {
37440     "type": "get",
37441     "url": "/api/integrations/zendesk/configurations/{id}/tags",
37442     "title": "Gets configurations tags",
37443     "examples": [
37444       {
37445         "title": "Example usage:",
37446         "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id}/tags -v -u {name}:{password} -X GET",
37447         "type": "json"
37448       }
37449     ],
37450     "name": "getTags",
37451     "group": "Zendesk_Configurations",
37452     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37453     "version": "0.0.0",
37454     "filename": "server/api/intZendeskConfiguration/index.js",
37455     "groupTitle": "Zendesk_Configurations"
37456   },
37457   {
37458     "type": "post",
37459     "url": "/api/integrations/zendesk/configurations/{id}/tags",
37460     "title": "Sets new tags",
37461     "examples": [
37462       {
37463         "title": "Example usage:",
37464         "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",
37465         "type": "json"
37466       }
37467     ],
37468     "name": "setTags",
37469     "group": "Zendesk_Configurations",
37470     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37471     "version": "0.0.0",
37472     "filename": "server/api/intZendeskConfiguration/index.js",
37473     "groupTitle": "Zendesk_Configurations"
37474   },
37475   {
37476     "type": "put",
37477     "url": "/api/integrations/zendesk/configurations/{id}",
37478     "title": "Update an existing Zendesk Configuration",
37479     "examples": [
37480       {
37481         "title": "Example usage:",
37482         "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",
37483         "type": "json"
37484       }
37485     ],
37486     "name": "updateZendesk_Configurations",
37487     "group": "Zendesk_Configurations",
37488     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37489     "version": "0.0.0",
37490     "filename": "server/api/intZendeskConfiguration/index.js",
37491     "groupTitle": "Zendesk_Configurations"
37492   },
37493   {
37494     "type": "post",
37495     "url": "/api/integrations/zendesk/fields",
37496     "title": "Creates a new Zendesk Field",
37497     "examples": [
37498       {
37499         "title": "Example usage:",
37500         "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",
37501         "type": "json"
37502       }
37503     ],
37504     "name": "CreateZendesk_Fields",
37505     "group": "Zendesk_Fields",
37506     "parameter": {
37507       "fields": {
37508         "Body": [
37509           {
37510             "group": "Body",
37511             "type": "String",
37512             "allowedValues": [
37513               "\"string\"",
37514               "\"variable\"",
37515               "\"customVariable\"",
37516               "\"keyValue\"",
37517               "\"picklist\""
37518             ],
37519             "optional": true,
37520             "field": "type",
37521             "description": ""
37522           },
37523           {
37524             "group": "Body",
37525             "type": "String",
37526             "optional": true,
37527             "field": "content",
37528             "description": ""
37529           },
37530           {
37531             "group": "Body",
37532             "type": "String",
37533             "optional": true,
37534             "field": "key",
37535             "description": ""
37536           },
37537           {
37538             "group": "Body",
37539             "type": "String",
37540             "allowedValues": [
37541               "\"string\"",
37542               "\"variable\"",
37543               "\"customVariable\""
37544             ],
37545             "optional": true,
37546             "field": "keyType",
37547             "description": ""
37548           },
37549           {
37550             "group": "Body",
37551             "type": "String",
37552             "optional": true,
37553             "field": "keyContent",
37554             "description": ""
37555           },
37556           {
37557             "group": "Body",
37558             "type": "String",
37559             "optional": true,
37560             "field": "idField",
37561             "description": ""
37562           },
37563           {
37564             "group": "Body",
37565             "type": "String",
37566             "optional": true,
37567             "field": "nameField",
37568             "description": ""
37569           },
37570           {
37571             "group": "Body",
37572             "type": "Boolean",
37573             "optional": true,
37574             "field": "customField",
37575             "description": ""
37576           },
37577           {
37578             "group": "Body",
37579             "type": "String",
37580             "optional": true,
37581             "field": "variableName",
37582             "description": ""
37583           }
37584         ]
37585       }
37586     },
37587     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37588     "version": "0.0.0",
37589     "filename": "server/api/intZendeskField/index.js",
37590     "groupTitle": "Zendesk_Fields"
37591   },
37592   {
37593     "type": "delete",
37594     "url": "/api/integrations/zendesk/fields/{id}",
37595     "title": "Deletes a Zendesk Field",
37596     "examples": [
37597       {
37598         "title": "Example usage:",
37599         "content": "curl https://{domain}/api/integrations/zendesk/fields/{id} -v -u {name}:{password} -X DELETE",
37600         "type": "json"
37601       }
37602     ],
37603     "name": "DeleteZendesk_Fields",
37604     "group": "Zendesk_Fields",
37605     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37606     "version": "0.0.0",
37607     "filename": "server/api/intZendeskField/index.js",
37608     "groupTitle": "Zendesk_Fields"
37609   },
37610   {
37611     "type": "get",
37612     "url": "/api/integrations/zendesk/fields",
37613     "title": "Gets a list of Zendesk Fields",
37614     "examples": [
37615       {
37616         "title": "Example usage:",
37617         "content": "curl https://{domain}/api/integrations/zendesk/fields -v -u {name}:{password}",
37618         "type": "json"
37619       }
37620     ],
37621     "name": "GetZendesk_Fields",
37622     "group": "Zendesk_Fields",
37623     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
37624     "version": "0.0.0",
37625     "filename": "server/api/intZendeskField/index.js",
37626     "groupTitle": "Zendesk_Fields"
37627   },
37628   {
37629     "type": "get",
37630     "url": "/api/integrations/zendesk/fields/{id}",
37631     "title": "Gets a single Zendesk Field",
37632     "examples": [
37633       {
37634         "title": "Example usage:",
37635         "content": "curl https://{domain}/api/integrations/zendesk/fields/{id} -v -u {name}:{password}",
37636         "type": "json"
37637       }
37638     ],
37639     "name": "ShowZendesk_Fields",
37640     "group": "Zendesk_Fields",
37641     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37642     "version": "0.0.0",
37643     "filename": "server/api/intZendeskField/index.js",
37644     "groupTitle": "Zendesk_Fields"
37645   },
37646   {
37647     "type": "put",
37648     "url": "/api/integrations/zendesk/fields/{id}",
37649     "title": "Update an existing Zendesk Field",
37650     "examples": [
37651       {
37652         "title": "Example usage:",
37653         "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",
37654         "type": "json"
37655       }
37656     ],
37657     "name": "updateZendesk_Fields",
37658     "group": "Zendesk_Fields",
37659     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37660     "version": "0.0.0",
37661     "filename": "server/api/intZendeskField/index.js",
37662     "groupTitle": "Zendesk_Fields"
37663   },
37664   {
37665     "type": "post",
37666     "url": "/api/integrations/zoho/accounts",
37667     "title": "Creates a new Zoho Account",
37668     "examples": [
37669       {
37670         "title": "Example usage:",
37671         "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",
37672         "type": "json"
37673       }
37674     ],
37675     "name": "CreateZoho_Accounts",
37676     "group": "Zoho_Accounts",
37677     "parameter": {
37678       "fields": {
37679         "Body": [
37680           {
37681             "group": "Body",
37682             "type": "String",
37683             "optional": true,
37684             "field": "name",
37685             "description": ""
37686           },
37687           {
37688             "group": "Body",
37689             "type": "String",
37690             "optional": true,
37691             "field": "description",
37692             "description": ""
37693           },
37694           {
37695             "group": "Body",
37696             "type": "String",
37697             "optional": true,
37698             "field": "host",
37699             "description": ""
37700           },
37701           {
37702             "group": "Body",
37703             "type": "String",
37704             "optional": true,
37705             "field": "zone",
37706             "description": ""
37707           },
37708           {
37709             "group": "Body",
37710             "type": "String",
37711             "optional": true,
37712             "field": "clientId",
37713             "description": ""
37714           },
37715           {
37716             "group": "Body",
37717             "type": "String",
37718             "optional": true,
37719             "field": "clientSecret",
37720             "description": ""
37721           },
37722           {
37723             "group": "Body",
37724             "type": "String",
37725             "optional": false,
37726             "field": "serverUrl",
37727             "description": ""
37728           },
37729           {
37730             "group": "Body",
37731             "type": "String",
37732             "optional": true,
37733             "field": "code",
37734             "description": ""
37735           },
37736           {
37737             "group": "Body",
37738             "type": "String",
37739             "optional": true,
37740             "field": "refreshToken",
37741             "description": ""
37742           }
37743         ]
37744       }
37745     },
37746     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37747     "version": "0.0.0",
37748     "filename": "server/api/intZohoAccount/index.js",
37749     "groupTitle": "Zoho_Accounts"
37750   },
37751   {
37752     "type": "delete",
37753     "url": "/api/integrations/zoho/accounts/{id}",
37754     "title": "Deletes a Zoho Account",
37755     "examples": [
37756       {
37757         "title": "Example usage:",
37758         "content": "curl https://{domain}/api/integrations/zoho/accounts/{id} -v -u {name}:{password} -X DELETE",
37759         "type": "json"
37760       }
37761     ],
37762     "name": "DeleteZoho_Accounts",
37763     "group": "Zoho_Accounts",
37764     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37765     "version": "0.0.0",
37766     "filename": "server/api/intZohoAccount/index.js",
37767     "groupTitle": "Zoho_Accounts"
37768   },
37769   {
37770     "type": "get",
37771     "url": "/api/integrations/zoho/accounts",
37772     "title": "Gets a list of Zoho Accounts",
37773     "examples": [
37774       {
37775         "title": "Example usage:",
37776         "content": "curl https://{domain}/api/integrations/zoho/accounts -v -u {name}:{password}",
37777         "type": "json"
37778       }
37779     ],
37780     "name": "GetZoho_Accounts",
37781     "group": "Zoho_Accounts",
37782     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
37783     "version": "0.0.0",
37784     "filename": "server/api/intZohoAccount/index.js",
37785     "groupTitle": "Zoho_Accounts"
37786   },
37787   {
37788     "type": "get",
37789     "url": "/api/integrations/zoho/accounts/{id}",
37790     "title": "Gets a single Zoho Account",
37791     "examples": [
37792       {
37793         "title": "Example usage:",
37794         "content": "curl https://{domain}/api/integrations/zoho/accounts/{id} -v -u {name}:{password}",
37795         "type": "json"
37796       }
37797     ],
37798     "name": "ShowZoho_Accounts",
37799     "group": "Zoho_Accounts",
37800     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37801     "version": "0.0.0",
37802     "filename": "server/api/intZohoAccount/index.js",
37803     "groupTitle": "Zoho_Accounts"
37804   },
37805   {
37806     "type": "post",
37807     "url": "/api/integrations/zoho/accounts/{id}/configurations",
37808     "title": "Creates new configuration",
37809     "examples": [
37810       {
37811         "title": "Example usage:",
37812         "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",
37813         "type": "json"
37814       }
37815     ],
37816     "name": "addConfiguration",
37817     "group": "Zoho_Accounts",
37818     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37819     "version": "0.0.0",
37820     "filename": "server/api/intZohoAccount/index.js",
37821     "groupTitle": "Zoho_Accounts"
37822   },
37823   {
37824     "type": "get",
37825     "url": "/api/integrations/zoho/accounts/{id}/configurations",
37826     "title": "Gets account configurations",
37827     "examples": [
37828       {
37829         "title": "Example usage:",
37830         "content": "curl https://{domain}/api/integrations/zoho/accounts/{id}/configurations -v -u {name}:{password} -X GET",
37831         "type": "json"
37832       }
37833     ],
37834     "name": "getConfigurations",
37835     "group": "Zoho_Accounts",
37836     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37837     "version": "0.0.0",
37838     "filename": "server/api/intZohoAccount/index.js",
37839     "groupTitle": "Zoho_Accounts"
37840   },
37841   {
37842     "type": "get",
37843     "url": "/api/integrations/zoho/accounts/{id}/fields",
37844     "title": "Gets account fields",
37845     "examples": [
37846       {
37847         "title": "Example usage:",
37848         "content": "curl https://{domain}/api/integrations/zoho/accounts/{id}/fields -v -u {name}:{password} -X GET",
37849         "type": "json"
37850       }
37851     ],
37852     "name": "getFields",
37853     "group": "Zoho_Accounts",
37854     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37855     "version": "0.0.0",
37856     "filename": "server/api/intZohoAccount/index.js",
37857     "groupTitle": "Zoho_Accounts"
37858   },
37859   {
37860     "type": "put",
37861     "url": "/api/integrations/zoho/accounts/{id}",
37862     "title": "Update an existing Zoho Account",
37863     "examples": [
37864       {
37865         "title": "Example usage:",
37866         "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",
37867         "type": "json"
37868       }
37869     ],
37870     "name": "updateZoho_Accounts",
37871     "group": "Zoho_Accounts",
37872     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37873     "version": "0.0.0",
37874     "filename": "server/api/intZohoAccount/index.js",
37875     "groupTitle": "Zoho_Accounts"
37876   },
37877   {
37878     "type": "post",
37879     "url": "/api/integrations/zoho/configurations",
37880     "title": "Creates a new Zoho Configuration",
37881     "examples": [
37882       {
37883         "title": "Example usage:",
37884         "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",
37885         "type": "json"
37886       }
37887     ],
37888     "name": "CreateZoho_Configurations",
37889     "group": "Zoho_Configurations",
37890     "parameter": {
37891       "fields": {
37892         "Body": [
37893           {
37894             "group": "Body",
37895             "type": "String",
37896             "optional": true,
37897             "field": "name",
37898             "description": ""
37899           },
37900           {
37901             "group": "Body",
37902             "type": "String",
37903             "allowedValues": [
37904               "\"lead\"",
37905               "\"contact\"",
37906               "\"nothing\""
37907             ],
37908             "optional": true,
37909             "field": "moduleCreate",
37910             "description": ""
37911           },
37912           {
37913             "group": "Body",
37914             "type": "String",
37915             "allowedValues": [
37916               "\"contact_lead\"",
37917               "\"contact\"",
37918               "\"lead\""
37919             ],
37920             "optional": true,
37921             "field": "moduleSearch",
37922             "description": ""
37923           },
37924           {
37925             "group": "Body",
37926             "type": "String",
37927             "optional": true,
37928             "field": "description",
37929             "description": ""
37930           }
37931         ]
37932       }
37933     },
37934     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37935     "version": "0.0.0",
37936     "filename": "server/api/intZohoConfiguration/index.js",
37937     "groupTitle": "Zoho_Configurations"
37938   },
37939   {
37940     "type": "delete",
37941     "url": "/api/integrations/zoho/configurations/{id}",
37942     "title": "Deletes a Zoho Configuration",
37943     "examples": [
37944       {
37945         "title": "Example usage:",
37946         "content": "curl https://{domain}/api/integrations/zoho/configurations/{id} -v -u {name}:{password} -X DELETE",
37947         "type": "json"
37948       }
37949     ],
37950     "name": "DeleteZoho_Configurations",
37951     "group": "Zoho_Configurations",
37952     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37953     "version": "0.0.0",
37954     "filename": "server/api/intZohoConfiguration/index.js",
37955     "groupTitle": "Zoho_Configurations"
37956   },
37957   {
37958     "type": "get",
37959     "url": "/api/integrations/zoho/configurations",
37960     "title": "Gets a list of Zoho Configurations",
37961     "examples": [
37962       {
37963         "title": "Example usage:",
37964         "content": "curl https://{domain}/api/integrations/zoho/configurations -v -u {name}:{password}",
37965         "type": "json"
37966       }
37967     ],
37968     "name": "GetZoho_Configurations",
37969     "group": "Zoho_Configurations",
37970     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
37971     "version": "0.0.0",
37972     "filename": "server/api/intZohoConfiguration/index.js",
37973     "groupTitle": "Zoho_Configurations"
37974   },
37975   {
37976     "type": "get",
37977     "url": "/api/integrations/zoho/configurations/{id}",
37978     "title": "Gets a single Zoho Configuration",
37979     "examples": [
37980       {
37981         "title": "Example usage:",
37982         "content": "curl https://{domain}/api/integrations/zoho/configurations/{id} -v -u {name}:{password}",
37983         "type": "json"
37984       }
37985     ],
37986     "name": "ShowZoho_Configurations",
37987     "group": "Zoho_Configurations",
37988     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37989     "version": "0.0.0",
37990     "filename": "server/api/intZohoConfiguration/index.js",
37991     "groupTitle": "Zoho_Configurations"
37992   },
37993   {
37994     "type": "get",
37995     "url": "/api/integrations/zoho/configurations/{id}/descriptions",
37996     "title": "Gets configurations descriptions",
37997     "examples": [
37998       {
37999         "title": "Example usage:",
38000         "content": "curl https://{domain}/api/integrations/zoho/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
38001         "type": "json"
38002       }
38003     ],
38004     "name": "getDescriptions",
38005     "group": "Zoho_Configurations",
38006     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
38007     "version": "0.0.0",
38008     "filename": "server/api/intZohoConfiguration/index.js",
38009     "groupTitle": "Zoho_Configurations"
38010   },
38011   {
38012     "type": "get",
38013     "url": "/api/integrations/zoho/configurations/{id}/fields",
38014     "title": "Gets configurations fields",
38015     "examples": [
38016       {
38017         "title": "Example usage:",
38018         "content": "curl https://{domain}/api/integrations/zoho/configurations/{id}/fields -v -u {name}:{password} -X GET",
38019         "type": "json"
38020       }
38021     ],
38022     "name": "getFields",
38023     "group": "Zoho_Configurations",
38024     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
38025     "version": "0.0.0",
38026     "filename": "server/api/intZohoConfiguration/index.js",
38027     "groupTitle": "Zoho_Configurations"
38028   },
38029   {
38030     "type": "get",
38031     "url": "/api/integrations/zoho/configurations/{id}/subjects",
38032     "title": "Gets configurations subjects",
38033     "examples": [
38034       {
38035         "title": "Example usage:",
38036         "content": "curl https://{domain}/api/integrations/zoho/configurations/{id}/subjects -v -u {name}:{password} -X GET",
38037         "type": "json"
38038       }
38039     ],
38040     "name": "getSubjects",
38041     "group": "Zoho_Configurations",
38042     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
38043     "version": "0.0.0",
38044     "filename": "server/api/intZohoConfiguration/index.js",
38045     "groupTitle": "Zoho_Configurations"
38046   },
38047   {
38048     "type": "put",
38049     "url": "/api/integrations/zoho/configurations/{id}",
38050     "title": "Update an existing Zoho Configuration",
38051     "examples": [
38052       {
38053         "title": "Example usage:",
38054         "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",
38055         "type": "json"
38056       }
38057     ],
38058     "name": "updateZoho_Configurations",
38059     "group": "Zoho_Configurations",
38060     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
38061     "version": "0.0.0",
38062     "filename": "server/api/intZohoConfiguration/index.js",
38063     "groupTitle": "Zoho_Configurations"
38064   },
38065   {
38066     "type": "post",
38067     "url": "/api/integrations/zoho/fields",
38068     "title": "Creates a new Zoho Field",
38069     "examples": [
38070       {
38071         "title": "Example usage:",
38072         "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",
38073         "type": "json"
38074       }
38075     ],
38076     "name": "CreateZoho_Fields",
38077     "group": "Zoho_Fields",
38078     "parameter": {
38079       "fields": {
38080         "Body": [
38081           {
38082             "group": "Body",
38083             "type": "String",
38084             "allowedValues": [
38085               "\"string\"",
38086               "\"variable\"",
38087               "\"customVariable\"",
38088               "\"keyValue\"",
38089               "\"picklist\""
38090             ],
38091             "optional": true,
38092             "field": "type",
38093             "description": ""
38094           },
38095           {
38096             "group": "Body",
38097             "type": "String",
38098             "optional": true,
38099             "field": "content",
38100             "description": ""
38101           },
38102           {
38103             "group": "Body",
38104             "type": "String",
38105             "optional": true,
38106             "field": "key",
38107             "description": ""
38108           },
38109           {
38110             "group": "Body",
38111             "type": "String",
38112             "allowedValues": [
38113               "\"string\"",
38114               "\"variable\"",
38115               "\"customVariable\""
38116             ],
38117             "optional": true,
38118             "field": "keyType",
38119             "description": ""
38120           },
38121           {
38122             "group": "Body",
38123             "type": "String",
38124             "optional": true,
38125             "field": "keyContent",
38126             "description": ""
38127           },
38128           {
38129             "group": "Body",
38130             "type": "String",
38131             "optional": true,
38132             "field": "idField",
38133             "description": ""
38134           },
38135           {
38136             "group": "Body",
38137             "type": "String",
38138             "optional": true,
38139             "field": "nameField",
38140             "description": ""
38141           },
38142           {
38143             "group": "Body",
38144             "type": "Boolean",
38145             "optional": true,
38146             "field": "customField",
38147             "description": ""
38148           },
38149           {
38150             "group": "Body",
38151             "type": "String",
38152             "optional": true,
38153             "field": "variableName",
38154             "description": ""
38155           }
38156         ]
38157       }
38158     },
38159     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
38160     "version": "0.0.0",
38161     "filename": "server/api/intZohoField/index.js",
38162     "groupTitle": "Zoho_Fields"
38163   },
38164   {
38165     "type": "delete",
38166     "url": "/api/integrations/zoho/fields/{id}",
38167     "title": "Deletes a Zoho Field",
38168     "examples": [
38169       {
38170         "title": "Example usage:",
38171         "content": "curl https://{domain}/api/integrations/zoho/fields/{id} -v -u {name}:{password} -X DELETE",
38172         "type": "json"
38173       }
38174     ],
38175     "name": "DeleteZoho_Fields",
38176     "group": "Zoho_Fields",
38177     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
38178     "version": "0.0.0",
38179     "filename": "server/api/intZohoField/index.js",
38180     "groupTitle": "Zoho_Fields"
38181   },
38182   {
38183     "type": "get",
38184     "url": "/api/integrations/zoho/fields",
38185     "title": "Gets a list of Zoho Fields",
38186     "examples": [
38187       {
38188         "title": "Example usage:",
38189         "content": "curl https://{domain}/api/integrations/zoho/fields -v -u {name}:{password}",
38190         "type": "json"
38191       }
38192     ],
38193     "name": "GetZoho_Fields",
38194     "group": "Zoho_Fields",
38195     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
38196     "version": "0.0.0",
38197     "filename": "server/api/intZohoField/index.js",
38198     "groupTitle": "Zoho_Fields"
38199   },
38200   {
38201     "type": "get",
38202     "url": "/api/integrations/zoho/fields/{id}",
38203     "title": "Gets a single Zoho Field",
38204     "examples": [
38205       {
38206         "title": "Example usage:",
38207         "content": "curl https://{domain}/api/integrations/zoho/fields/{id} -v -u {name}:{password}",
38208         "type": "json"
38209       }
38210     ],
38211     "name": "ShowZoho_Fields",
38212     "group": "Zoho_Fields",
38213     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
38214     "version": "0.0.0",
38215     "filename": "server/api/intZohoField/index.js",
38216     "groupTitle": "Zoho_Fields"
38217   },
38218   {
38219     "type": "put",
38220     "url": "/api/integrations/zoho/fields/{id}",
38221     "title": "Update an existing Zoho Field",
38222     "examples": [
38223       {
38224         "title": "Example usage:",
38225         "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",
38226         "type": "json"
38227       }
38228     ],
38229     "name": "updateZoho_Fields",
38230     "group": "Zoho_Fields",
38231     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
38232     "version": "0.0.0",
38233     "filename": "server/api/intZohoField/index.js",
38234     "groupTitle": "Zoho_Fields"
38235   },
38236   {
38237     "type": "post",
38238     "url": "/api/cdr",
38239     "title": "Creates a new Cdr",
38240     "examples": [
38241       {
38242         "title": "Example usage:",
38243         "content": "curl https://{domain}/api/cdr -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
38244         "type": "json"
38245       }
38246     ],
38247     "name": "CreateCdrs",
38248     "group": "cdr",
38249     "parameter": {
38250       "fields": {
38251         "Body": [
38252           {
38253             "group": "Body",
38254             "type": "String",
38255             "optional": false,
38256             "field": "calldate",
38257             "description": ""
38258           },
38259           {
38260             "group": "Body",
38261             "type": "String",
38262             "optional": true,
38263             "field": "clid",
38264             "description": ""
38265           },
38266           {
38267             "group": "Body",
38268             "type": "String",
38269             "optional": true,
38270             "field": "src",
38271             "description": ""
38272           },
38273           {
38274             "group": "Body",
38275             "type": "String",
38276             "optional": true,
38277             "field": "dst",
38278             "description": ""
38279           },
38280           {
38281             "group": "Body",
38282             "type": "String",
38283             "optional": true,
38284             "field": "dcontext",
38285             "description": ""
38286           },
38287           {
38288             "group": "Body",
38289             "type": "String",
38290             "optional": true,
38291             "field": "channel",
38292             "description": ""
38293           },
38294           {
38295             "group": "Body",
38296             "type": "String",
38297             "optional": true,
38298             "field": "dstchannel",
38299             "description": ""
38300           },
38301           {
38302             "group": "Body",
38303             "type": "String",
38304             "optional": true,
38305             "field": "lastapp",
38306             "description": ""
38307           },
38308           {
38309             "group": "Body",
38310             "type": "String",
38311             "optional": true,
38312             "field": "lastdata",
38313             "description": ""
38314           },
38315           {
38316             "group": "Body",
38317             "type": "Integer",
38318             "optional": false,
38319             "field": "duration",
38320             "description": ""
38321           },
38322           {
38323             "group": "Body",
38324             "type": "Integer",
38325             "optional": false,
38326             "field": "billsec",
38327             "description": ""
38328           },
38329           {
38330             "group": "Body",
38331             "type": "String",
38332             "optional": true,
38333             "field": "disposition",
38334             "description": ""
38335           },
38336           {
38337             "group": "Body",
38338             "type": "Integer",
38339             "optional": false,
38340             "field": "amaflags",
38341             "description": ""
38342           },
38343           {
38344             "group": "Body",
38345             "type": "String",
38346             "optional": true,
38347             "field": "accountcode",
38348             "description": ""
38349           },
38350           {
38351             "group": "Body",
38352             "type": "String",
38353             "optional": true,
38354             "field": "userfield",
38355             "description": ""
38356           },
38357           {
38358             "group": "Body",
38359             "type": "String",
38360             "optional": true,
38361             "field": "uniqueid",
38362             "description": ""
38363           },
38364           {
38365             "group": "Body",
38366             "type": "String",
38367             "optional": true,
38368             "field": "linkedid",
38369             "description": ""
38370           },
38371           {
38372             "group": "Body",
38373             "type": "String",
38374             "optional": true,
38375             "field": "sequence",
38376             "description": ""
38377           },
38378           {
38379             "group": "Body",
38380             "type": "String",
38381             "optional": true,
38382             "field": "peeraccount",
38383             "description": ""
38384           },
38385           {
38386             "group": "Body",
38387             "type": "String",
38388             "optional": true,
38389             "field": "type",
38390             "description": ""
38391           },
38392           {
38393             "group": "Body",
38394             "type": "String",
38395             "optional": true,
38396             "field": "tag",
38397             "description": ""
38398           }
38399         ]
38400       }
38401     },
38402     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
38403     "version": "0.0.0",
38404     "filename": "server/api/cdr/index.js",
38405     "groupTitle": "cdr"
38406   },
38407   {
38408     "type": "delete",
38409     "url": "/api/cdr/{id}",
38410     "title": "Deletes a Cdr",
38411     "examples": [
38412       {
38413         "title": "Example usage:",
38414         "content": "curl https://{domain}/api/cdr/{id} -v -u {name}:{password} -X DELETE",
38415         "type": "json"
38416       }
38417     ],
38418     "name": "DeleteCdrs",
38419     "group": "cdr",
38420     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
38421     "version": "0.0.0",
38422     "filename": "server/api/cdr/index.js",
38423     "groupTitle": "cdr"
38424   },
38425   {
38426     "type": "get",
38427     "url": "/api/cdr/describe",
38428     "title": "Gets table info about Cdrs",
38429     "examples": [
38430       {
38431         "title": "Example usage:",
38432         "content": "curl https://{domain}/api/cdr/describe -v -u {name}:{password}",
38433         "type": "json"
38434       }
38435     ],
38436     "name": "DescribeCdrs",
38437     "group": "cdr",
38438     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
38439     "version": "0.0.0",
38440     "filename": "server/api/cdr/index.js",
38441     "groupTitle": "cdr"
38442   },
38443   {
38444     "type": "get",
38445     "url": "/api/cdr",
38446     "title": "Gets a list of Cdrs",
38447     "examples": [
38448       {
38449         "title": "Example usage:",
38450         "content": "curl https://{domain}/api/cdr -v -u {name}:{password}",
38451         "type": "json"
38452       }
38453     ],
38454     "name": "GetCdrs",
38455     "group": "cdr",
38456     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
38457     "version": "0.0.0",
38458     "filename": "server/api/cdr/index.js",
38459     "groupTitle": "cdr"
38460   },
38461   {
38462     "type": "get",
38463     "url": "/api/cdr/{id}",
38464     "title": "Gets a single Cdr",
38465     "examples": [
38466       {
38467         "title": "Example usage:",
38468         "content": "curl https://{domain}/api/cdr/{id} -v -u {name}:{password}",
38469         "type": "json"
38470       }
38471     ],
38472     "name": "ShowCdrs",
38473     "group": "cdr",
38474     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
38475     "version": "0.0.0",
38476     "filename": "server/api/cdr/index.js",
38477     "groupTitle": "cdr"
38478   },
38479   {
38480     "type": "put",
38481     "url": "/api/cdr/{id}",
38482     "title": "Update an existing Cdr",
38483     "examples": [
38484       {
38485         "title": "Example usage:",
38486         "content": "curl https://{domain}/api/cdr/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
38487         "type": "json"
38488       }
38489     ],
38490     "name": "updateCdrs",
38491     "group": "cdr",
38492     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
38493     "version": "0.0.0",
38494     "filename": "server/api/cdr/index.js",
38495     "groupTitle": "cdr"
38496   },
38497   {
38498     "type": "post",
38499     "url": "/api/voiceQueuesLog",
38500     "title": "Creates a new VoiceQueuesLog",
38501     "examples": [
38502       {
38503         "title": "Example usage:",
38504         "content": "curl https://{domain}/api/voiceQueuesLog -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
38505         "type": "json"
38506       }
38507     ],
38508     "name": "CreateVoiceQueuesLogs",
38509     "group": "voiceQueuesLog",
38510     "parameter": {
38511       "fields": {
38512         "Body": [
38513           {
38514             "group": "Body",
38515             "type": "String",
38516             "optional": true,
38517             "field": "time",
38518             "description": ""
38519           },
38520           {
38521             "group": "Body",
38522             "type": "String",
38523             "optional": false,
38524             "field": "callid",
38525             "description": ""
38526           },
38527           {
38528             "group": "Body",
38529             "type": "String",
38530             "optional": false,
38531             "field": "queuename",
38532             "description": ""
38533           },
38534           {
38535             "group": "Body",
38536             "type": "String",
38537             "optional": false,
38538             "field": "agent",
38539             "description": ""
38540           },
38541           {
38542             "group": "Body",
38543             "type": "String",
38544             "optional": false,
38545             "field": "event",
38546             "description": ""
38547           },
38548           {
38549             "group": "Body",
38550             "type": "String",
38551             "optional": false,
38552             "field": "data",
38553             "description": ""
38554           },
38555           {
38556             "group": "Body",
38557             "type": "String",
38558             "optional": false,
38559             "field": "data1",
38560             "description": ""
38561           },
38562           {
38563             "group": "Body",
38564             "type": "String",
38565             "optional": false,
38566             "field": "data2",
38567             "description": ""
38568           },
38569           {
38570             "group": "Body",
38571             "type": "String",
38572             "optional": false,
38573             "field": "data3",
38574             "description": ""
38575           },
38576           {
38577             "group": "Body",
38578             "type": "String",
38579             "optional": false,
38580             "field": "data4",
38581             "description": ""
38582           },
38583           {
38584             "group": "Body",
38585             "type": "String",
38586             "optional": false,
38587             "field": "data5",
38588             "description": ""
38589           },
38590           {
38591             "group": "Body",
38592             "type": "String",
38593             "optional": false,
38594             "field": "dtm",
38595             "description": ""
38596           }
38597         ]
38598       }
38599     },
38600     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
38601     "version": "0.0.0",
38602     "filename": "server/api/voiceQueuesLog/index.js",
38603     "groupTitle": "voiceQueuesLog"
38604   },
38605   {
38606     "type": "delete",
38607     "url": "/api/voiceQueuesLog/{id}",
38608     "title": "Deletes a VoiceQueuesLog",
38609     "examples": [
38610       {
38611         "title": "Example usage:",
38612         "content": "curl https://{domain}/api/voiceQueuesLog/{id} -v -u {name}:{password} -X DELETE",
38613         "type": "json"
38614       }
38615     ],
38616     "name": "DeleteVoiceQueuesLogs",
38617     "group": "voiceQueuesLog",
38618     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
38619     "version": "0.0.0",
38620     "filename": "server/api/voiceQueuesLog/index.js",
38621     "groupTitle": "voiceQueuesLog"
38622   },
38623   {
38624     "type": "get",
38625     "url": "/api/voiceQueuesLog",
38626     "title": "Gets a list of VoiceQueuesLogs",
38627     "examples": [
38628       {
38629         "title": "Example usage:",
38630         "content": "curl https://{domain}/api/voiceQueuesLog -v -u {name}:{password}",
38631         "type": "json"
38632       }
38633     ],
38634     "name": "GetVoiceQueuesLogs",
38635     "group": "voiceQueuesLog",
38636     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
38637     "version": "0.0.0",
38638     "filename": "server/api/voiceQueuesLog/index.js",
38639     "groupTitle": "voiceQueuesLog"
38640   },
38641   {
38642     "type": "get",
38643     "url": "/api/voiceQueuesLog/{id}",
38644     "title": "Gets a single VoiceQueuesLog",
38645     "examples": [
38646       {
38647         "title": "Example usage:",
38648         "content": "curl https://{domain}/api/voiceQueuesLog/{id} -v -u {name}:{password}",
38649         "type": "json"
38650       }
38651     ],
38652     "name": "ShowVoiceQueuesLogs",
38653     "group": "voiceQueuesLog",
38654     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
38655     "version": "0.0.0",
38656     "filename": "server/api/voiceQueuesLog/index.js",
38657     "groupTitle": "voiceQueuesLog"
38658   },
38659   {
38660     "type": "put",
38661     "url": "/api/voiceQueuesLog/{id}",
38662     "title": "Update an existing VoiceQueuesLog",
38663     "examples": [
38664       {
38665         "title": "Example usage:",
38666         "content": "curl https://{domain}/api/voiceQueuesLog/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
38667         "type": "json"
38668       }
38669     ],
38670     "name": "updateVoiceQueuesLogs",
38671     "group": "voiceQueuesLog",
38672     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
38673     "version": "0.0.0",
38674     "filename": "server/api/voiceQueuesLog/index.js",
38675     "groupTitle": "voiceQueuesLog"
38676   }
38677 ] });