apidoc/api_data.json

   1 [
   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": "/Users/andreabianco/Documents/Developments/motion-v2/server/api/cmHopper/index.js",
  17     "groupTitle": "/Users/andreabianco/Documents/Developments/motion-v2/server/api/cmHopper/index.js"
  18   },
  19   {
  20     "type": "delete",
  21     "url": "/api/actions/{id}",
  22     "title": "Deletes a Action",
  23     "examples": [
  24       {
  25         "title": "Example usage:",
  26         "content": "curl https://{domain}/api/actions/{id} -v -u {name}:{password} -X DELETE",
  27         "type": "json"
  28       }
  29     ],
  30     "name": "DeleteActions",
  31     "group": "Actions",
  32     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
  33     "version": "0.0.0",
  34     "filename": "server/api/action/index.js",
  35     "groupTitle": "Actions"
  36   },
  37   {
  38     "type": "put",
  39     "url": "/api/actions/{id}",
  40     "title": "Update an existing Action",
  41     "examples": [
  42       {
  43         "title": "Example usage:",
  44         "content": "curl https://{domain}/api/actions/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
  45         "type": "json"
  46       }
  47     ],
  48     "name": "updateActions",
  49     "group": "Actions",
  50     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
  51     "version": "0.0.0",
  52     "filename": "server/api/action/index.js",
  53     "groupTitle": "Actions"
  54   },
  55   {
  56     "type": "post",
  57     "url": "/api/analytics/custom_reports",
  58     "title": "Creates a new Analytic Custom Report",
  59     "examples": [
  60       {
  61         "title": "Example usage:",
  62         "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",
  63         "type": "json"
  64       }
  65     ],
  66     "name": "CreateAnalytic_Custom_Reports",
  67     "group": "Analytic_Custom_Reports",
  68     "parameter": {
  69       "fields": {
  70         "Body": [
  71           {
  72             "group": "Body",
  73             "type": "String",
  74             "optional": false,
  75             "field": "name",
  76             "description": ""
  77           },
  78           {
  79             "group": "Body",
  80             "type": "String",
  81             "optional": true,
  82             "field": "description",
  83             "description": ""
  84           },
  85           {
  86             "group": "Body",
  87             "type": "String",
  88             "optional": true,
  89             "field": "parent",
  90             "description": ""
  91           },
  92           {
  93             "group": "Body",
  94             "type": "String",
  95             "optional": true,
  96             "field": "table",
  97             "description": ""
  98           },
  99           {
 100             "group": "Body",
 101             "type": "Text",
 102             "optional": true,
 103             "field": "conditions",
 104             "description": ""
 105           },
 106           {
 107             "group": "Body",
 108             "type": "Text",
 109             "optional": true,
 110             "field": "joins",
 111             "description": ""
 112           }
 113         ]
 114       }
 115     },
 116     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 117     "version": "0.0.0",
 118     "filename": "server/api/analyticCustomReport/index.js",
 119     "groupTitle": "Analytic_Custom_Reports"
 120   },
 121   {
 122     "type": "delete",
 123     "url": "/api/analytics/custom_reports/{id}",
 124     "title": "Deletes a Analytic Custom Report",
 125     "examples": [
 126       {
 127         "title": "Example usage:",
 128         "content": "curl https://{domain}/api/analytics/custom_reports/{id} -v -u {name}:{password} -X DELETE",
 129         "type": "json"
 130       }
 131     ],
 132     "name": "DeleteAnalytic_Custom_Reports",
 133     "group": "Analytic_Custom_Reports",
 134     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 135     "version": "0.0.0",
 136     "filename": "server/api/analyticCustomReport/index.js",
 137     "groupTitle": "Analytic_Custom_Reports"
 138   },
 139   {
 140     "type": "get",
 141     "url": "/api/analytics/custom_reports",
 142     "title": "Gets a list of Analytic Custom Reports",
 143     "examples": [
 144       {
 145         "title": "Example usage:",
 146         "content": "curl https://{domain}/api/analytics/custom_reports -v -u {name}:{password}",
 147         "type": "json"
 148       }
 149     ],
 150     "name": "GetAnalytic_Custom_Reports",
 151     "group": "Analytic_Custom_Reports",
 152     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
 153     "version": "0.0.0",
 154     "filename": "server/api/analyticCustomReport/index.js",
 155     "groupTitle": "Analytic_Custom_Reports"
 156   },
 157   {
 158     "type": "get",
 159     "url": "/api/analytics/custom_reports/{id}",
 160     "title": "Gets a single Analytic Custom Report",
 161     "examples": [
 162       {
 163         "title": "Example usage:",
 164         "content": "curl https://{domain}/api/analytics/custom_reports/{id} -v -u {name}:{password}",
 165         "type": "json"
 166       }
 167     ],
 168     "name": "ShowAnalytic_Custom_Reports",
 169     "group": "Analytic_Custom_Reports",
 170     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 171     "version": "0.0.0",
 172     "filename": "server/api/analyticCustomReport/index.js",
 173     "groupTitle": "Analytic_Custom_Reports"
 174   },
 175   {
 176     "type": "get",
 177     "url": "/api/analytics/custom_reports/{id}/preview",
 178     "title": "Report Preview",
 179     "examples": [
 180       {
 181         "title": "Example usage:",
 182         "content": "curl https://{domain}/api/analytics/custom_reports/{id}/preview -v -u {name}:{password} -X GET",
 183         "type": "json"
 184       }
 185     ],
 186     "name": "preview",
 187     "group": "Analytic_Custom_Reports",
 188     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 189     "version": "0.0.0",
 190     "filename": "server/api/analyticCustomReport/index.js",
 191     "groupTitle": "Analytic_Custom_Reports"
 192   },
 193   {
 194     "type": "get",
 195     "url": "/api/analytics/custom_reports/{id}/query",
 196     "title": "Report Query SQL",
 197     "examples": [
 198       {
 199         "title": "Example usage:",
 200         "content": "curl https://{domain}/api/analytics/custom_reports/{id}/query -v -u {name}:{password} -X GET",
 201         "type": "json"
 202       }
 203     ],
 204     "name": "query",
 205     "group": "Analytic_Custom_Reports",
 206     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 207     "version": "0.0.0",
 208     "filename": "server/api/analyticCustomReport/index.js",
 209     "groupTitle": "Analytic_Custom_Reports"
 210   },
 211   {
 212     "type": "get",
 213     "url": "/api/analytics/custom_reports/{id}/run",
 214     "title": "Report Run",
 215     "examples": [
 216       {
 217         "title": "Example usage:",
 218         "content": "curl https://{domain}/api/analytics/custom_reports/{id}/run -v -u {name}:{password} -X GET",
 219         "type": "json"
 220       }
 221     ],
 222     "name": "run",
 223     "group": "Analytic_Custom_Reports",
 224     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 225     "version": "0.0.0",
 226     "filename": "server/api/analyticCustomReport/index.js",
 227     "groupTitle": "Analytic_Custom_Reports"
 228   },
 229   {
 230     "type": "put",
 231     "url": "/api/analytics/custom_reports/{id}",
 232     "title": "Update an existing Analytic Custom Report",
 233     "examples": [
 234       {
 235         "title": "Example usage:",
 236         "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",
 237         "type": "json"
 238       }
 239     ],
 240     "name": "updateAnalytic_Custom_Reports",
 241     "group": "Analytic_Custom_Reports",
 242     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 243     "version": "0.0.0",
 244     "filename": "server/api/analyticCustomReport/index.js",
 245     "groupTitle": "Analytic_Custom_Reports"
 246   },
 247   {
 248     "type": "post",
 249     "url": "/api/analytics/default_reports",
 250     "title": "Creates a new Analytic Default Report",
 251     "examples": [
 252       {
 253         "title": "Example usage:",
 254         "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",
 255         "type": "json"
 256       }
 257     ],
 258     "name": "CreateAnalytic_Default_Reports",
 259     "group": "Analytic_Default_Reports",
 260     "parameter": {
 261       "fields": {
 262         "Body": [
 263           {
 264             "group": "Body",
 265             "type": "String",
 266             "optional": false,
 267             "field": "name",
 268             "description": ""
 269           },
 270           {
 271             "group": "Body",
 272             "type": "String",
 273             "optional": true,
 274             "field": "description",
 275             "description": ""
 276           },
 277           {
 278             "group": "Body",
 279             "type": "String",
 280             "optional": true,
 281             "field": "parent",
 282             "description": ""
 283           },
 284           {
 285             "group": "Body",
 286             "type": "String",
 287             "optional": true,
 288             "field": "table",
 289             "description": ""
 290           },
 291           {
 292             "group": "Body",
 293             "type": "Text",
 294             "optional": true,
 295             "field": "conditions",
 296             "description": ""
 297           },
 298           {
 299             "group": "Body",
 300             "type": "Text",
 301             "optional": true,
 302             "field": "joins",
 303             "description": ""
 304           }
 305         ]
 306       }
 307     },
 308     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 309     "version": "0.0.0",
 310     "filename": "server/api/analyticDefaultReport/index.js",
 311     "groupTitle": "Analytic_Default_Reports"
 312   },
 313   {
 314     "type": "delete",
 315     "url": "/api/analytics/default_reports/{id}",
 316     "title": "Deletes a Analytic Default Report",
 317     "examples": [
 318       {
 319         "title": "Example usage:",
 320         "content": "curl https://{domain}/api/analytics/default_reports/{id} -v -u {name}:{password} -X DELETE",
 321         "type": "json"
 322       }
 323     ],
 324     "name": "DeleteAnalytic_Default_Reports",
 325     "group": "Analytic_Default_Reports",
 326     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 327     "version": "0.0.0",
 328     "filename": "server/api/analyticDefaultReport/index.js",
 329     "groupTitle": "Analytic_Default_Reports"
 330   },
 331   {
 332     "type": "get",
 333     "url": "/api/analytics/default_reports",
 334     "title": "Gets a list of Analytic Default Reports",
 335     "examples": [
 336       {
 337         "title": "Example usage:",
 338         "content": "curl https://{domain}/api/analytics/default_reports -v -u {name}:{password}",
 339         "type": "json"
 340       }
 341     ],
 342     "name": "GetAnalytic_Default_Reports",
 343     "group": "Analytic_Default_Reports",
 344     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
 345     "version": "0.0.0",
 346     "filename": "server/api/analyticDefaultReport/index.js",
 347     "groupTitle": "Analytic_Default_Reports"
 348   },
 349   {
 350     "type": "get",
 351     "url": "/api/analytics/default_reports/{id}",
 352     "title": "Gets a single Analytic Default Report",
 353     "examples": [
 354       {
 355         "title": "Example usage:",
 356         "content": "curl https://{domain}/api/analytics/default_reports/{id} -v -u {name}:{password}",
 357         "type": "json"
 358       }
 359     ],
 360     "name": "ShowAnalytic_Default_Reports",
 361     "group": "Analytic_Default_Reports",
 362     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 363     "version": "0.0.0",
 364     "filename": "server/api/analyticDefaultReport/index.js",
 365     "groupTitle": "Analytic_Default_Reports"
 366   },
 367   {
 368     "type": "get",
 369     "url": "/api/analytics/default_reports/{id}/preview",
 370     "title": "Report Preview",
 371     "examples": [
 372       {
 373         "title": "Example usage:",
 374         "content": "curl https://{domain}/api/analytics/default_reports/{id}/preview -v -u {name}:{password} -X GET",
 375         "type": "json"
 376       }
 377     ],
 378     "name": "preview",
 379     "group": "Analytic_Default_Reports",
 380     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 381     "version": "0.0.0",
 382     "filename": "server/api/analyticDefaultReport/index.js",
 383     "groupTitle": "Analytic_Default_Reports"
 384   },
 385   {
 386     "type": "get",
 387     "url": "/api/analytics/default_reports/{id}/query",
 388     "title": "Report Query SQL",
 389     "examples": [
 390       {
 391         "title": "Example usage:",
 392         "content": "curl https://{domain}/api/analytics/default_reports/{id}/query -v -u {name}:{password} -X GET",
 393         "type": "json"
 394       }
 395     ],
 396     "name": "query",
 397     "group": "Analytic_Default_Reports",
 398     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 399     "version": "0.0.0",
 400     "filename": "server/api/analyticDefaultReport/index.js",
 401     "groupTitle": "Analytic_Default_Reports"
 402   },
 403   {
 404     "type": "get",
 405     "url": "/api/analytics/default_reports/{id}/run",
 406     "title": "Report Run",
 407     "examples": [
 408       {
 409         "title": "Example usage:",
 410         "content": "curl https://{domain}/api/analytics/default_reports/{id}/run -v -u {name}:{password} -X GET",
 411         "type": "json"
 412       }
 413     ],
 414     "name": "run",
 415     "group": "Analytic_Default_Reports",
 416     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 417     "version": "0.0.0",
 418     "filename": "server/api/analyticDefaultReport/index.js",
 419     "groupTitle": "Analytic_Default_Reports"
 420   },
 421   {
 422     "type": "put",
 423     "url": "/api/analytics/default_reports/{id}",
 424     "title": "Update an existing Analytic Default Report",
 425     "examples": [
 426       {
 427         "title": "Example usage:",
 428         "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",
 429         "type": "json"
 430       }
 431     ],
 432     "name": "updateAnalytic_Default_Reports",
 433     "group": "Analytic_Default_Reports",
 434     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 435     "version": "0.0.0",
 436     "filename": "server/api/analyticDefaultReport/index.js",
 437     "groupTitle": "Analytic_Default_Reports"
 438   },
 439   {
 440     "type": "post",
 441     "url": "/api/analytics/extracted_reports",
 442     "title": "Creates a new Analytic Extracted Report",
 443     "examples": [
 444       {
 445         "title": "Example usage:",
 446         "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",
 447         "type": "json"
 448       }
 449     ],
 450     "name": "CreateAnalytic_Extacted_Reports",
 451     "group": "Analytic_Extracted_Reports",
 452     "parameter": {
 453       "fields": {
 454         "Body": [
 455           {
 456             "group": "Body",
 457             "type": "String",
 458             "optional": false,
 459             "field": "name",
 460             "description": ""
 461           },
 462           {
 463             "group": "Body",
 464             "type": "String",
 465             "optional": false,
 466             "field": "basename",
 467             "description": ""
 468           },
 469           {
 470             "group": "Body",
 471             "type": "String",
 472             "allowedValues": [
 473               "\"csv\"",
 474               "\"pdf\"",
 475               "\"xlsx\""
 476             ],
 477             "optional": false,
 478             "field": "output",
 479             "description": ""
 480           },
 481           {
 482             "group": "Body",
 483             "type": "String",
 484             "optional": false,
 485             "field": "savename",
 486             "description": ""
 487           },
 488           {
 489             "group": "Body",
 490             "type": "String",
 491             "optional": true,
 492             "field": "startDate",
 493             "description": ""
 494           },
 495           {
 496             "group": "Body",
 497             "type": "String",
 498             "optional": true,
 499             "field": "endDate",
 500             "description": ""
 501           },
 502           {
 503             "group": "Body",
 504             "type": "String",
 505             "optional": true,
 506             "field": "status",
 507             "description": ""
 508           },
 509           {
 510             "group": "Body",
 511             "type": "String",
 512             "allowedValues": [
 513               "\"manual\"",
 514               "\"scheduled\""
 515             ],
 516             "optional": false,
 517             "field": "type",
 518             "description": ""
 519           },
 520           {
 521             "group": "Body",
 522             "type": "Integer",
 523             "optional": true,
 524             "field": "reportId",
 525             "description": ""
 526           },
 527           {
 528             "group": "Body",
 529             "type": "String",
 530             "optional": true,
 531             "field": "reportType",
 532             "description": ""
 533           }
 534         ]
 535       }
 536     },
 537     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 538     "version": "0.0.0",
 539     "filename": "server/api/analyticExtractedReport/index.js",
 540     "groupTitle": "Analytic_Extracted_Reports"
 541   },
 542   {
 543     "type": "delete",
 544     "url": "/api/analytics/extracted_reports/{id}",
 545     "title": "Deletes a Analytic Extracted Report",
 546     "examples": [
 547       {
 548         "title": "Example usage:",
 549         "content": "curl https://{domain}/api/analytics/extracted_reports/{id} -v -u {name}:{password} -X DELETE",
 550         "type": "json"
 551       }
 552     ],
 553     "name": "DeleteAnalytic_Extacted_Reports",
 554     "group": "Analytic_Extracted_Reports",
 555     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 556     "version": "0.0.0",
 557     "filename": "server/api/analyticExtractedReport/index.js",
 558     "groupTitle": "Analytic_Extracted_Reports"
 559   },
 560   {
 561     "type": "get",
 562     "url": "/api/analytics/extracted_reports",
 563     "title": "Gets a list of Analytic Extacted Reports",
 564     "examples": [
 565       {
 566         "title": "Example usage:",
 567         "content": "curl https://{domain}/api/analytics/extracted_reports -v -u {name}:{password}",
 568         "type": "json"
 569       }
 570     ],
 571     "name": "GetAnalytic_Extacted_Reports",
 572     "group": "Analytic_Extracted_Reports",
 573     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
 574     "version": "0.0.0",
 575     "filename": "server/api/analyticExtractedReport/index.js",
 576     "groupTitle": "Analytic_Extracted_Reports"
 577   },
 578   {
 579     "type": "get",
 580     "url": "/api/analytics/extracted_reports/{id}",
 581     "title": "Gets a single Analytic Extracted Report",
 582     "examples": [
 583       {
 584         "title": "Example usage:",
 585         "content": "curl https://{domain}/api/analytics/extracted_reports/{id} -v -u {name}:{password}",
 586         "type": "json"
 587       }
 588     ],
 589     "name": "ShowAnalytic_Extacted_Reports",
 590     "group": "Analytic_Extracted_Reports",
 591     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 592     "version": "0.0.0",
 593     "filename": "server/api/analyticExtractedReport/index.js",
 594     "groupTitle": "Analytic_Extracted_Reports"
 595   },
 596   {
 597     "type": "get",
 598     "url": "/api/analytics/extracted_reports/{id}/download",
 599     "title": "Download Extracted Report",
 600     "examples": [
 601       {
 602         "title": "Example usage:",
 603         "content": "curl https://{domain}/api/analytics/extracted_reports/{id}/download -v -u {name}:{password} -X GET",
 604         "type": "json"
 605       }
 606     ],
 607     "name": "download",
 608     "group": "Analytic_Extracted_Reports",
 609     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 610     "version": "0.0.0",
 611     "filename": "server/api/analyticExtractedReport/index.js",
 612     "groupTitle": "Analytic_Extracted_Reports"
 613   },
 614   {
 615     "type": "put",
 616     "url": "/api/analytics/extracted_reports/{id}",
 617     "title": "Update an existing Analytic Extracted Report",
 618     "examples": [
 619       {
 620         "title": "Example usage:",
 621         "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",
 622         "type": "json"
 623       }
 624     ],
 625     "name": "updateAnalytic_Extacted_Reports",
 626     "group": "Analytic_Extracted_Reports",
 627     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 628     "version": "0.0.0",
 629     "filename": "server/api/analyticExtractedReport/index.js",
 630     "groupTitle": "Analytic_Extracted_Reports"
 631   },
 632   {
 633     "type": "post",
 634     "url": "/api/analytics/field_reports/create_many",
 635     "title": "Creates many Analytic Field Reports",
 636     "examples": [
 637       {
 638         "title": "Example usage:",
 639         "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",
 640         "type": "json"
 641       }
 642     ],
 643     "name": "BulkCreateAnalytic_Field_Reports",
 644     "group": "Analytic_Field_Reports",
 645     "parameter": {
 646       "fields": {
 647         "Body": [
 648           {
 649             "group": "Body",
 650             "type": "Text",
 651             "optional": true,
 652             "field": "field",
 653             "description": ""
 654           },
 655           {
 656             "group": "Body",
 657             "type": "String",
 658             "optional": true,
 659             "field": "alias",
 660             "description": ""
 661           },
 662           {
 663             "group": "Body",
 664             "type": "String",
 665             "optional": true,
 666             "field": "function",
 667             "description": ""
 668           },
 669           {
 670             "group": "Body",
 671             "type": "String",
 672             "optional": true,
 673             "field": "format",
 674             "description": ""
 675           },
 676           {
 677             "group": "Body",
 678             "type": "Boolean",
 679             "optional": true,
 680             "field": "groupBy",
 681             "description": ""
 682           },
 683           {
 684             "group": "Body",
 685             "type": "String",
 686             "optional": true,
 687             "field": "orderBy",
 688             "description": ""
 689           },
 690           {
 691             "group": "Body",
 692             "type": "Boolean",
 693             "optional": true,
 694             "field": "custom",
 695             "description": ""
 696           }
 697         ]
 698       }
 699     },
 700     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 701     "version": "0.0.0",
 702     "filename": "server/api/analyticFieldReport/index.js",
 703     "groupTitle": "Analytic_Field_Reports"
 704   },
 705   {
 706     "type": "delete",
 707     "url": "/api/analytics/field_reports/destroy_many?ids={ids}",
 708     "title": "Deletes many Analytic Field Reports",
 709     "examples": [
 710       {
 711         "title": "Example usage:",
 712         "content": "curl https://{domain}/api/analytics/field_reports/destroy_many?ids=1&ids=2&ids=3 -v -u {name}:{password} -X DELETE",
 713         "type": "json"
 714       }
 715     ],
 716     "name": "BulkDeleteAnalytic_Field_Reports",
 717     "group": "Analytic_Field_Reports",
 718     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 719     "version": "0.0.0",
 720     "filename": "server/api/analyticFieldReport/index.js",
 721     "groupTitle": "Analytic_Field_Reports"
 722   },
 723   {
 724     "type": "post",
 725     "url": "/api/analytics/field_reports",
 726     "title": "Creates a new Analytic Field Report",
 727     "examples": [
 728       {
 729         "title": "Example usage:",
 730         "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",
 731         "type": "json"
 732       }
 733     ],
 734     "name": "CreateAnalytic_Field_Reports",
 735     "group": "Analytic_Field_Reports",
 736     "parameter": {
 737       "fields": {
 738         "Body": [
 739           {
 740             "group": "Body",
 741             "type": "Text",
 742             "optional": true,
 743             "field": "field",
 744             "description": ""
 745           },
 746           {
 747             "group": "Body",
 748             "type": "String",
 749             "optional": true,
 750             "field": "alias",
 751             "description": ""
 752           },
 753           {
 754             "group": "Body",
 755             "type": "String",
 756             "optional": true,
 757             "field": "function",
 758             "description": ""
 759           },
 760           {
 761             "group": "Body",
 762             "type": "String",
 763             "optional": true,
 764             "field": "format",
 765             "description": ""
 766           },
 767           {
 768             "group": "Body",
 769             "type": "Boolean",
 770             "optional": true,
 771             "field": "groupBy",
 772             "description": ""
 773           },
 774           {
 775             "group": "Body",
 776             "type": "String",
 777             "optional": true,
 778             "field": "orderBy",
 779             "description": ""
 780           },
 781           {
 782             "group": "Body",
 783             "type": "Boolean",
 784             "optional": true,
 785             "field": "custom",
 786             "description": ""
 787           }
 788         ]
 789       }
 790     },
 791     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 792     "version": "0.0.0",
 793     "filename": "server/api/analyticFieldReport/index.js",
 794     "groupTitle": "Analytic_Field_Reports"
 795   },
 796   {
 797     "type": "delete",
 798     "url": "/api/analytics/field_reports/{id}",
 799     "title": "Deletes a Analytic Field Report",
 800     "examples": [
 801       {
 802         "title": "Example usage:",
 803         "content": "curl https://{domain}/api/analytics/field_reports/{id} -v -u {name}:{password} -X DELETE",
 804         "type": "json"
 805       }
 806     ],
 807     "name": "DeleteAnalytic_Field_Reports",
 808     "group": "Analytic_Field_Reports",
 809     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 810     "version": "0.0.0",
 811     "filename": "server/api/analyticFieldReport/index.js",
 812     "groupTitle": "Analytic_Field_Reports"
 813   },
 814   {
 815     "type": "get",
 816     "url": "/api/analytics/field_reports",
 817     "title": "Gets a list of Analytic Field Reports",
 818     "examples": [
 819       {
 820         "title": "Example usage:",
 821         "content": "curl https://{domain}/api/analytics/field_reports -v -u {name}:{password}",
 822         "type": "json"
 823       }
 824     ],
 825     "name": "GetAnalytic_Field_Reports",
 826     "group": "Analytic_Field_Reports",
 827     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
 828     "version": "0.0.0",
 829     "filename": "server/api/analyticFieldReport/index.js",
 830     "groupTitle": "Analytic_Field_Reports"
 831   },
 832   {
 833     "type": "get",
 834     "url": "/api/analytics/field_reports/{id}",
 835     "title": "Gets a single Analytic Field Report",
 836     "examples": [
 837       {
 838         "title": "Example usage:",
 839         "content": "curl https://{domain}/api/analytics/field_reports/{id} -v -u {name}:{password}",
 840         "type": "json"
 841       }
 842     ],
 843     "name": "ShowAnalytic_Field_Reports",
 844     "group": "Analytic_Field_Reports",
 845     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 846     "version": "0.0.0",
 847     "filename": "server/api/analyticFieldReport/index.js",
 848     "groupTitle": "Analytic_Field_Reports"
 849   },
 850   {
 851     "type": "post",
 852     "url": "/api/analytics/field_reports/{id}/create_many",
 853     "title": "Rewrite fields set",
 854     "examples": [
 855       {
 856         "title": "Example usage:",
 857         "content": "curl https://{domain}/api/analytics/field_reports/{id}/create_many -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
 858         "type": "json"
 859       }
 860     ],
 861     "name": "addFields",
 862     "group": "Analytic_Field_Reports",
 863     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 864     "version": "0.0.0",
 865     "filename": "server/api/analyticFieldReport/index.js",
 866     "groupTitle": "Analytic_Field_Reports"
 867   },
 868   {
 869     "type": "put",
 870     "url": "/api/analytics/field_reports/{id}",
 871     "title": "Update an existing Analytic Field Report",
 872     "examples": [
 873       {
 874         "title": "Example usage:",
 875         "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",
 876         "type": "json"
 877       }
 878     ],
 879     "name": "updateAnalytic_Field_Reports",
 880     "group": "Analytic_Field_Reports",
 881     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 882     "version": "0.0.0",
 883     "filename": "server/api/analyticFieldReport/index.js",
 884     "groupTitle": "Analytic_Field_Reports"
 885   },
 886   {
 887     "type": "post",
 888     "url": "/api/analytics/metrics",
 889     "title": "Creates a new Analytic Metrics",
 890     "examples": [
 891       {
 892         "title": "Example usage:",
 893         "content": "curl https://{domain}/api/analytics/metrics -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
 894         "type": "json"
 895       }
 896     ],
 897     "name": "CreateAnalytic_Metric",
 898     "group": "Analytic_Metrics",
 899     "parameter": {
 900       "fields": {
 901         "Body": [
 902           {
 903             "group": "Body",
 904             "type": "String",
 905             "optional": false,
 906             "field": "name",
 907             "description": ""
 908           },
 909           {
 910             "group": "Body",
 911             "type": "String",
 912             "optional": true,
 913             "field": "table",
 914             "description": ""
 915           },
 916           {
 917             "group": "Body",
 918             "type": "Text",
 919             "optional": true,
 920             "field": "metric",
 921             "description": ""
 922           },
 923           {
 924             "group": "Body",
 925             "type": "String",
 926             "optional": true,
 927             "field": "description",
 928             "description": ""
 929           }
 930         ]
 931       }
 932     },
 933     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 934     "version": "0.0.0",
 935     "filename": "server/api/analyticMetric/index.js",
 936     "groupTitle": "Analytic_Metrics"
 937   },
 938   {
 939     "type": "delete",
 940     "url": "/api/analytics/metrics/{id}",
 941     "title": "Deletes a Analytic Metrics",
 942     "examples": [
 943       {
 944         "title": "Example usage:",
 945         "content": "curl https://{domain}/api/analytics/metrics/{id} -v -u {name}:{password} -X DELETE",
 946         "type": "json"
 947       }
 948     ],
 949     "name": "DeleteAnalytic_Metric",
 950     "group": "Analytic_Metrics",
 951     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 952     "version": "0.0.0",
 953     "filename": "server/api/analyticMetric/index.js",
 954     "groupTitle": "Analytic_Metrics"
 955   },
 956   {
 957     "type": "get",
 958     "url": "/api/analytics/metrics",
 959     "title": "Gets a list of Analytic Metric",
 960     "examples": [
 961       {
 962         "title": "Example usage:",
 963         "content": "curl https://{domain}/api/analytics/metrics -v -u {name}:{password}",
 964         "type": "json"
 965       }
 966     ],
 967     "name": "GetAnalytic_Metric",
 968     "group": "Analytic_Metrics",
 969     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
 970     "version": "0.0.0",
 971     "filename": "server/api/analyticMetric/index.js",
 972     "groupTitle": "Analytic_Metrics"
 973   },
 974   {
 975     "type": "get",
 976     "url": "/api/analytics/metrics/{id}",
 977     "title": "Gets a single Analytic Metrics",
 978     "examples": [
 979       {
 980         "title": "Example usage:",
 981         "content": "curl https://{domain}/api/analytics/metrics/{id} -v -u {name}:{password}",
 982         "type": "json"
 983       }
 984     ],
 985     "name": "ShowAnalytic_Metric",
 986     "group": "Analytic_Metrics",
 987     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 988     "version": "0.0.0",
 989     "filename": "server/api/analyticMetric/index.js",
 990     "groupTitle": "Analytic_Metrics"
 991   },
 992   {
 993     "type": "put",
 994     "url": "/api/analytics/metrics/{id}",
 995     "title": "Update an existing Analytic Metrics",
 996     "examples": [
 997       {
 998         "title": "Example usage:",
 999         "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",
1000         "type": "json"
1001       }
1002     ],
1003     "name": "updateAnalytic_Metric",
1004     "group": "Analytic_Metrics",
1005     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1006     "version": "0.0.0",
1007     "filename": "server/api/analyticMetric/index.js",
1008     "groupTitle": "Analytic_Metrics"
1009   },
1010   {
1011     "type": "post",
1012     "url": "/api/analytics/tree_reports",
1013     "title": "Creates a new Analytic Tree Report",
1014     "examples": [
1015       {
1016         "title": "Example usage:",
1017         "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",
1018         "type": "json"
1019       }
1020     ],
1021     "name": "CreateAnalytic_Tree_Reports",
1022     "group": "Analytic_Tree_Reports",
1023     "parameter": {
1024       "fields": {
1025         "Body": [
1026           {
1027             "group": "Body",
1028             "type": "Text",
1029             "optional": false,
1030             "field": "tree",
1031             "description": ""
1032           }
1033         ]
1034       }
1035     },
1036     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1037     "version": "0.0.0",
1038     "filename": "server/api/analyticTreeReport/index.js",
1039     "groupTitle": "Analytic_Tree_Reports"
1040   },
1041   {
1042     "type": "delete",
1043     "url": "/api/analytics/tree_reports/{id}",
1044     "title": "Deletes a Analytic Tree Report",
1045     "examples": [
1046       {
1047         "title": "Example usage:",
1048         "content": "curl https://{domain}/api/analytics/tree_reports/{id} -v -u {name}:{password} -X DELETE",
1049         "type": "json"
1050       }
1051     ],
1052     "name": "DeleteAnalytic_Tree_Reports",
1053     "group": "Analytic_Tree_Reports",
1054     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1055     "version": "0.0.0",
1056     "filename": "server/api/analyticTreeReport/index.js",
1057     "groupTitle": "Analytic_Tree_Reports"
1058   },
1059   {
1060     "type": "get",
1061     "url": "/api/analytics/tree_reports",
1062     "title": "Gets a list of Analytic Tree Reports",
1063     "examples": [
1064       {
1065         "title": "Example usage:",
1066         "content": "curl https://{domain}/api/analytics/tree_reports -v -u {name}:{password}",
1067         "type": "json"
1068       }
1069     ],
1070     "name": "GetAnalytic_Tree_Reports",
1071     "group": "Analytic_Tree_Reports",
1072     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
1073     "version": "0.0.0",
1074     "filename": "server/api/analyticTreeReport/index.js",
1075     "groupTitle": "Analytic_Tree_Reports"
1076   },
1077   {
1078     "type": "get",
1079     "url": "/api/analytics/tree_reports/{id}",
1080     "title": "Gets a single Analytic Tree Report",
1081     "examples": [
1082       {
1083         "title": "Example usage:",
1084         "content": "curl https://{domain}/api/analytics/tree_reports/{id} -v -u {name}:{password}",
1085         "type": "json"
1086       }
1087     ],
1088     "name": "ShowAnalytic_Tree_Reports",
1089     "group": "Analytic_Tree_Reports",
1090     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1091     "version": "0.0.0",
1092     "filename": "server/api/analyticTreeReport/index.js",
1093     "groupTitle": "Analytic_Tree_Reports"
1094   },
1095   {
1096     "type": "put",
1097     "url": "/api/analytics/tree_reports/{id}",
1098     "title": "Update an existing Analytic Tree Report",
1099     "examples": [
1100       {
1101         "title": "Example usage:",
1102         "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",
1103         "type": "json"
1104       }
1105     ],
1106     "name": "updateAnalytic_Tree_Reports",
1107     "group": "Analytic_Tree_Reports",
1108     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1109     "version": "0.0.0",
1110     "filename": "server/api/analyticTreeReport/index.js",
1111     "groupTitle": "Analytic_Tree_Reports"
1112   },
1113   {
1114     "type": "post",
1115     "url": "/api/attachments/clone",
1116     "title": "Clone an existing Attachment",
1117     "examples": [
1118       {
1119         "title": "Example usage:",
1120         "content": "curl https://{domain}/api/attachments/clone -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
1121         "type": "json"
1122       }
1123     ],
1124     "name": "CloneAttachments",
1125     "group": "Attachments",
1126     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1127     "version": "0.0.0",
1128     "filename": "server/api/attachment/index.js",
1129     "groupTitle": "Attachments"
1130   },
1131   {
1132     "type": "delete",
1133     "url": "/api/attachments/{id}",
1134     "title": "Deletes a Attachment",
1135     "examples": [
1136       {
1137         "title": "Example usage:",
1138         "content": "curl https://{domain}/api/attachments/{id} -v -u {name}:{password} -X DELETE",
1139         "type": "json"
1140       }
1141     ],
1142     "name": "DeleteAttachments",
1143     "group": "Attachments",
1144     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1145     "version": "0.0.0",
1146     "filename": "server/api/attachment/index.js",
1147     "groupTitle": "Attachments"
1148   },
1149   {
1150     "type": "get",
1151     "url": "/api/attachments",
1152     "title": "Gets a list of Attachments",
1153     "examples": [
1154       {
1155         "title": "Example usage:",
1156         "content": "curl https://{domain}/api/attachments -v -u {name}:{password}",
1157         "type": "json"
1158       }
1159     ],
1160     "name": "GetAttachments",
1161     "group": "Attachments",
1162     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
1163     "version": "0.0.0",
1164     "filename": "server/api/attachment/index.js",
1165     "groupTitle": "Attachments"
1166   },
1167   {
1168     "type": "get",
1169     "url": "/api/attachments/{id}",
1170     "title": "Gets a single Attachment",
1171     "examples": [
1172       {
1173         "title": "Example usage:",
1174         "content": "curl https://{domain}/api/attachments/{id} -v -u {name}:{password}",
1175         "type": "json"
1176       }
1177     ],
1178     "name": "ShowAttachments",
1179     "group": "Attachments",
1180     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1181     "version": "0.0.0",
1182     "filename": "server/api/attachment/index.js",
1183     "groupTitle": "Attachments"
1184   },
1185   {
1186     "type": "post",
1187     "url": "/api/attachments",
1188     "title": "Add attachment",
1189     "examples": [
1190       {
1191         "title": "Example usage:",
1192         "content": "curl https://{domain}/api/attachments -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
1193         "type": "json"
1194       }
1195     ],
1196     "name": "create",
1197     "group": "Attachments",
1198     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1199     "version": "0.0.0",
1200     "filename": "server/api/attachment/index.js",
1201     "groupTitle": "Attachments"
1202   },
1203   {
1204     "type": "get",
1205     "url": "/api/attachments/:id/download",
1206     "title": "Download attachment",
1207     "examples": [
1208       {
1209         "title": "Example usage:",
1210         "content": "curl https://{domain}/api/attachments/:id/download -v -u {name}:{password} -X GET",
1211         "type": "json"
1212       }
1213     ],
1214     "name": "download",
1215     "group": "Attachments",
1216     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1217     "version": "0.0.0",
1218     "filename": "server/api/attachment/index.js",
1219     "groupTitle": "Attachments"
1220   },
1221   {
1222     "type": "get",
1223     "url": "/api/chat/interactions/{id}/attachment_download",
1224     "title": "Download attachment",
1225     "examples": [
1226       {
1227         "title": "Example usage:",
1228         "content": "curl https://{domain}/api/chat/interactions/{id}/attachment_download -v -u {name}:{password} -X GET",
1229         "type": "json"
1230       }
1231     ],
1232     "name": "show",
1233     "group": "Attachments",
1234     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1235     "version": "0.0.0",
1236     "filename": "server/api/chatInteraction/index.js",
1237     "groupTitle": "Attachments"
1238   },
1239   {
1240     "type": "put",
1241     "url": "/api/attachments/{id}",
1242     "title": "Update an existing Attachment",
1243     "examples": [
1244       {
1245         "title": "Example usage:",
1246         "content": "curl https://{domain}/api/attachments/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
1247         "type": "json"
1248       }
1249     ],
1250     "name": "updateAttachments",
1251     "group": "Attachments",
1252     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1253     "version": "0.0.0",
1254     "filename": "server/api/attachment/index.js",
1255     "groupTitle": "Attachments"
1256   },
1257   {
1258     "type": "post",
1259     "url": "/api/auth/local/forgot",
1260     "title": "Creates a new password reset token",
1261     "examples": [
1262       {
1263         "title": "Example usage:",
1264         "content": "curl https://{domain}/api/auth/local/forgot -d '{\"email\": \"john.doe@xcally.com\"}' \\\n -H \"Content-Type: application/json\" -X POST",
1265         "type": "json"
1266       }
1267     ],
1268     "name": "Local_Forgot_Password",
1269     "group": "Authentication",
1270     "parameter": {
1271       "fields": {
1272         "Body": [
1273           {
1274             "group": "Body",
1275             "type": "String",
1276             "optional": false,
1277             "field": "email",
1278             "description": ""
1279           }
1280         ]
1281       }
1282     },
1283     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1284     "version": "0.0.0",
1285     "filename": "server/api/authLocal/index.js",
1286     "groupTitle": "Authentication"
1287   },
1288   {
1289     "type": "post",
1290     "url": "/api/auth/local/reset/:token",
1291     "title": "Reset user password",
1292     "examples": [
1293       {
1294         "title": "Example usage:",
1295         "content": "curl https://{domain}/api/auth/local/reset/94b422c1fkdjhg766a198da6997yu6gcc963641d -d '{\"password\": \"My_newP@ssw0rd\"}' \\\n -H \"Content-Type: application/json\" -X POST",
1296         "type": "json"
1297       }
1298     ],
1299     "name": "Local_Reset_Password",
1300     "group": "Authentication",
1301     "parameter": {
1302       "fields": {
1303         "Body": [
1304           {
1305             "group": "Body",
1306             "type": "String",
1307             "optional": false,
1308             "field": "password",
1309             "description": ""
1310           }
1311         ]
1312       }
1313     },
1314     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1315     "version": "0.0.0",
1316     "filename": "server/api/authLocal/index.js",
1317     "groupTitle": "Authentication"
1318   },
1319   {
1320     "type": "post",
1321     "url": "/api/auth/local",
1322     "title": "Creates a new User token",
1323     "examples": [
1324       {
1325         "title": "Example usage:",
1326         "content": "curl https://{domain}/api/auth/local -d '{\"name\": \"john.doe\", \"password\": \"password\"}' \\\n -H \"Content-Type: application/json\" -X POST",
1327         "type": "json"
1328       }
1329     ],
1330     "name": "Local_login",
1331     "group": "Authentication",
1332     "parameter": {
1333       "fields": {
1334         "Body": [
1335           {
1336             "group": "Body",
1337             "type": "String",
1338             "optional": false,
1339             "field": "name",
1340             "description": ""
1341           },
1342           {
1343             "group": "Body",
1344             "type": "String",
1345             "optional": false,
1346             "field": "password",
1347             "description": ""
1348           }
1349         ]
1350       }
1351     },
1352     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1353     "version": "0.0.0",
1354     "filename": "server/api/authLocal/index.js",
1355     "groupTitle": "Authentication"
1356   },
1357   {
1358     "type": "post",
1359     "url": "/api/auth/google",
1360     "title": "Creates a new User token",
1361     "examples": [
1362       {
1363         "title": "Example usage:",
1364         "content": "curl https://{domain}/api/auth/google -d '{\"name\": \"john.doe\", \"password\": \"password\"}' \\\n -H \"Content-Type: application/json\" -X POST",
1365         "type": "json"
1366       }
1367     ],
1368     "name": "Local_login",
1369     "group": "Authentication",
1370     "parameter": {
1371       "fields": {
1372         "Body": [
1373           {
1374             "group": "Body",
1375             "type": "String",
1376             "optional": false,
1377             "field": "name",
1378             "description": ""
1379           },
1380           {
1381             "group": "Body",
1382             "type": "String",
1383             "optional": false,
1384             "field": "password",
1385             "description": ""
1386           }
1387         ]
1388       }
1389     },
1390     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1391     "version": "0.0.0",
1392     "filename": "server/api/authGoogle/index.js",
1393     "groupTitle": "Authentication"
1394   },
1395   {
1396     "type": "post",
1397     "url": "/api/auth/activedirectory",
1398     "title": "Creates a new User token",
1399     "examples": [
1400       {
1401         "title": "Example usage:",
1402         "content": "curl https://{domain}/api/auth/activedirectory -d '{\"name\": \"john.doe\", \"password\": \"password\"}' \\\n -H \"Content-Type: application/json\" -X POST",
1403         "type": "json"
1404       }
1405     ],
1406     "name": "Local_login",
1407     "group": "Authentication",
1408     "parameter": {
1409       "fields": {
1410         "Body": [
1411           {
1412             "group": "Body",
1413             "type": "String",
1414             "optional": false,
1415             "field": "name",
1416             "description": ""
1417           },
1418           {
1419             "group": "Body",
1420             "type": "String",
1421             "optional": false,
1422             "field": "password",
1423             "description": ""
1424           }
1425         ]
1426       }
1427     },
1428     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1429     "version": "0.0.0",
1430     "filename": "server/api/authActiveDirectory/index.js",
1431     "groupTitle": "Authentication"
1432   },
1433   {
1434     "type": "post",
1435     "url": "/api/automations",
1436     "title": "Creates a new Automation",
1437     "examples": [
1438       {
1439         "title": "Example usage:",
1440         "content": "curl https://{domain}/api/automations -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
1441         "type": "json"
1442       }
1443     ],
1444     "name": "CreateAutomations",
1445     "group": "Automations",
1446     "parameter": {
1447       "fields": {
1448         "Body": [
1449           {
1450             "group": "Body",
1451             "type": "String",
1452             "optional": false,
1453             "field": "name",
1454             "description": ""
1455           },
1456           {
1457             "group": "Body",
1458             "type": "String",
1459             "optional": true,
1460             "field": "channel",
1461             "description": ""
1462           },
1463           {
1464             "group": "Body",
1465             "type": "String",
1466             "optional": true,
1467             "field": "description",
1468             "description": ""
1469           },
1470           {
1471             "group": "Body",
1472             "type": "Boolean",
1473             "optional": true,
1474             "field": "status",
1475             "description": ""
1476           },
1477           {
1478             "group": "Body",
1479             "type": "Integer",
1480             "optional": true,
1481             "field": "timeout",
1482             "description": ""
1483           }
1484         ]
1485       }
1486     },
1487     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1488     "version": "0.0.0",
1489     "filename": "server/api/automation/index.js",
1490     "groupTitle": "Automations"
1491   },
1492   {
1493     "type": "delete",
1494     "url": "/api/automations/{id}",
1495     "title": "Deletes a Automation",
1496     "examples": [
1497       {
1498         "title": "Example usage:",
1499         "content": "curl https://{domain}/api/automations/{id} -v -u {name}:{password} -X DELETE",
1500         "type": "json"
1501       }
1502     ],
1503     "name": "DeleteAutomations",
1504     "group": "Automations",
1505     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1506     "version": "0.0.0",
1507     "filename": "server/api/automation/index.js",
1508     "groupTitle": "Automations"
1509   },
1510   {
1511     "type": "get",
1512     "url": "/api/automations",
1513     "title": "Gets a list of Automations",
1514     "examples": [
1515       {
1516         "title": "Example usage:",
1517         "content": "curl https://{domain}/api/automations -v -u {name}:{password}",
1518         "type": "json"
1519       }
1520     ],
1521     "name": "GetAutomations",
1522     "group": "Automations",
1523     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
1524     "version": "0.0.0",
1525     "filename": "server/api/automation/index.js",
1526     "groupTitle": "Automations"
1527   },
1528   {
1529     "type": "get",
1530     "url": "/api/automations/{id}",
1531     "title": "Gets a single Automation",
1532     "examples": [
1533       {
1534         "title": "Example usage:",
1535         "content": "curl https://{domain}/api/automations/{id} -v -u {name}:{password}",
1536         "type": "json"
1537       }
1538     ],
1539     "name": "ShowAutomations",
1540     "group": "Automations",
1541     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1542     "version": "0.0.0",
1543     "filename": "server/api/automation/index.js",
1544     "groupTitle": "Automations"
1545   },
1546   {
1547     "type": "post",
1548     "url": "/api/automations/{id}/actions",
1549     "title": "Creates new actions",
1550     "examples": [
1551       {
1552         "title": "Example usage:",
1553         "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",
1554         "type": "json"
1555       }
1556     ],
1557     "name": "addActions",
1558     "group": "Automations",
1559     "parameter": {
1560       "fields": {
1561         "Body": [
1562           {
1563             "group": "Body",
1564             "type": "Virtual",
1565             "optional": true,
1566             "field": "name",
1567             "description": ""
1568           },
1569           {
1570             "group": "Body",
1571             "type": "String",
1572             "optional": false,
1573             "field": "action",
1574             "description": "<p>Allowed values: contactManager, integration, motionbar, jscripty, urlForward, browser, bot, script</p>"
1575           },
1576           {
1577             "group": "Body",
1578             "type": "String",
1579             "optional": true,
1580             "field": "data1",
1581             "description": "<p>contactManager[ListId], integration[intName(zendesk)], motionbar[Popup(0),URL(1),WinApp(2)], urlForward[GET,POST], browser[TemplateId(0),URL(1)]</p>"
1582           },
1583           {
1584             "group": "Body",
1585             "type": "String",
1586             "optional": true,
1587             "field": "data2",
1588             "description": "<p>integration[AccountId], motionbar[TemplateId,URL,WinAppPath], urlForward[URL]</p>"
1589           },
1590           {
1591             "group": "Body",
1592             "type": "String",
1593             "optional": true,
1594             "field": "data3",
1595             "description": "<p>motionbar[NULL,NULL,WinAppArguments]</p>"
1596           },
1597           {
1598             "group": "Body",
1599             "type": "String",
1600             "optional": true,
1601             "field": "data4",
1602             "description": ""
1603           },
1604           {
1605             "group": "Body",
1606             "type": "String",
1607             "optional": true,
1608             "field": "data5",
1609             "description": ""
1610           },
1611           {
1612             "group": "Body",
1613             "type": "String",
1614             "optional": true,
1615             "field": "data6",
1616             "description": ""
1617           },
1618           {
1619             "group": "Body",
1620             "type": "Text",
1621             "optional": true,
1622             "field": "data7",
1623             "description": ""
1624           }
1625         ]
1626       }
1627     },
1628     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1629     "version": "0.0.0",
1630     "filename": "server/api/automation/index.js",
1631     "groupTitle": "Automations"
1632   },
1633   {
1634     "type": "post",
1635     "url": "/api/automations/{id}/conditions",
1636     "title": "Creates new conditions",
1637     "examples": [
1638       {
1639         "title": "Example usage:",
1640         "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",
1641         "type": "json"
1642       }
1643     ],
1644     "name": "addConditions",
1645     "group": "Automations",
1646     "parameter": {
1647       "fields": {
1648         "Body": [
1649           {
1650             "group": "Body",
1651             "type": "Virtual",
1652             "optional": true,
1653             "field": "name",
1654             "description": ""
1655           },
1656           {
1657             "group": "Body",
1658             "type": "String",
1659             "optional": false,
1660             "field": "field",
1661             "description": ""
1662           },
1663           {
1664             "group": "Body",
1665             "type": "String",
1666             "optional": false,
1667             "field": "operator",
1668             "description": ""
1669           },
1670           {
1671             "group": "Body",
1672             "type": "String",
1673             "optional": false,
1674             "field": "value",
1675             "description": ""
1676           }
1677         ]
1678       }
1679     },
1680     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1681     "version": "0.0.0",
1682     "filename": "server/api/automation/index.js",
1683     "groupTitle": "Automations"
1684   },
1685   {
1686     "type": "get",
1687     "url": "/api/automations/{id}/actions",
1688     "title": "Gets Automation Actions",
1689     "examples": [
1690       {
1691         "title": "Example usage:",
1692         "content": "curl https://{domain}/api/automations/{id}/actions -v -u {name}:{password} -X GET",
1693         "type": "json"
1694       }
1695     ],
1696     "name": "getActions",
1697     "group": "Automations",
1698     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1699     "version": "0.0.0",
1700     "filename": "server/api/automation/index.js",
1701     "groupTitle": "Automations"
1702   },
1703   {
1704     "type": "get",
1705     "url": "/api/automations/{id}/conditions",
1706     "title": "Gets Automation Conditions",
1707     "examples": [
1708       {
1709         "title": "Example usage:",
1710         "content": "curl https://{domain}/api/automations/{id}/conditions -v -u {name}:{password} -X GET",
1711         "type": "json"
1712       }
1713     ],
1714     "name": "getConditions",
1715     "group": "Automations",
1716     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1717     "version": "0.0.0",
1718     "filename": "server/api/automation/index.js",
1719     "groupTitle": "Automations"
1720   },
1721   {
1722     "type": "put",
1723     "url": "/api/automations/{id}",
1724     "title": "Update an existing Automation",
1725     "examples": [
1726       {
1727         "title": "Example usage:",
1728         "content": "curl https://{domain}/api/automations/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
1729         "type": "json"
1730       }
1731     ],
1732     "name": "updateAutomations",
1733     "group": "Automations",
1734     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1735     "version": "0.0.0",
1736     "filename": "server/api/automation/index.js",
1737     "groupTitle": "Automations"
1738   },
1739   {
1740     "type": "post",
1741     "url": "/api/canned_answers",
1742     "title": "Create a new canned answer",
1743     "examples": [
1744       {
1745         "title": "Example usage:",
1746         "content": "curl https://{domain}/api/canned_answers -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
1747         "type": "json"
1748       }
1749     ],
1750     "name": "Create",
1751     "group": "Canned_Answers",
1752     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1753     "version": "0.0.0",
1754     "filename": "server/api/cannedAnswer/index.js",
1755     "groupTitle": "Canned_Answers"
1756   },
1757   {
1758     "type": "delete",
1759     "url": "/api/canned_answers/{id}",
1760     "title": "Deletes a Canned Answer",
1761     "examples": [
1762       {
1763         "title": "Example usage:",
1764         "content": "curl https://{domain}/api/canned_answers/{id} -v -u {name}:{password} -X DELETE",
1765         "type": "json"
1766       }
1767     ],
1768     "name": "DeleteCanned_Answers",
1769     "group": "Canned_Answers",
1770     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1771     "version": "0.0.0",
1772     "filename": "server/api/cannedAnswer/index.js",
1773     "groupTitle": "Canned_Answers"
1774   },
1775   {
1776     "type": "get",
1777     "url": "/api/canned_answers",
1778     "title": "Gets a list of Canned Answers",
1779     "examples": [
1780       {
1781         "title": "Example usage:",
1782         "content": "curl https://{domain}/api/canned_answers -v -u {name}:{password}",
1783         "type": "json"
1784       }
1785     ],
1786     "name": "GetCanned_Answers",
1787     "group": "Canned_Answers",
1788     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
1789     "version": "0.0.0",
1790     "filename": "server/api/cannedAnswer/index.js",
1791     "groupTitle": "Canned_Answers"
1792   },
1793   {
1794     "type": "get",
1795     "url": "/api/canned_answers/{id}",
1796     "title": "Gets a single Canned Answer",
1797     "examples": [
1798       {
1799         "title": "Example usage:",
1800         "content": "curl https://{domain}/api/canned_answers/{id} -v -u {name}:{password}",
1801         "type": "json"
1802       }
1803     ],
1804     "name": "ShowCanned_Answers",
1805     "group": "Canned_Answers",
1806     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1807     "version": "0.0.0",
1808     "filename": "server/api/cannedAnswer/index.js",
1809     "groupTitle": "Canned_Answers"
1810   },
1811   {
1812     "type": "put",
1813     "url": "/api/canned_answers/{id}",
1814     "title": "Update an existing Canned Answer",
1815     "examples": [
1816       {
1817         "title": "Example usage:",
1818         "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",
1819         "type": "json"
1820       }
1821     ],
1822     "name": "updateCanned_Answers",
1823     "group": "Canned_Answers",
1824     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1825     "version": "0.0.0",
1826     "filename": "server/api/cannedAnswer/index.js",
1827     "groupTitle": "Canned_Answers"
1828   },
1829   {
1830     "type": "get",
1831     "url": "/chat/internal/users",
1832     "title": "Gets Users Last Messages",
1833     "examples": [
1834       {
1835         "title": "Example usage:",
1836         "content": "curl https://{domain}/chat/internal/users -v -u {name}:{password}  -X GET",
1837         "type": "json"
1838       }
1839     ],
1840     "name": "getLastUsersMessages",
1841     "group": "ChatInternalMessage",
1842     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1843     "version": "0.0.0",
1844     "filename": "server/api/chatInternalMessage/index.js",
1845     "groupTitle": "ChatInternalMessage"
1846   },
1847   {
1848     "type": "delete",
1849     "url": "/api/chat/applications/{id}",
1850     "title": "Deletes a Application",
1851     "examples": [
1852       {
1853         "title": "Example usage:",
1854         "content": "curl https://{domain}/api/chat/applications/{id} -v -u {name}:{password} -X DELETE",
1855         "type": "json"
1856       }
1857     ],
1858     "name": "DeleteApplications",
1859     "group": "Chat_Applications",
1860     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1861     "version": "0.0.0",
1862     "filename": "server/api/chatApplication/index.js",
1863     "groupTitle": "Chat_Applications"
1864   },
1865   {
1866     "type": "get",
1867     "url": "/api/chat/applications/{id}",
1868     "title": "Gets a single Application",
1869     "examples": [
1870       {
1871         "title": "Example usage:",
1872         "content": "curl https://{domain}/api/chat/applications/{id} -v -u {name}:{password}",
1873         "type": "json"
1874       }
1875     ],
1876     "name": "ShowApplications",
1877     "group": "Chat_Applications",
1878     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1879     "version": "0.0.0",
1880     "filename": "server/api/chatApplication/index.js",
1881     "groupTitle": "Chat_Applications"
1882   },
1883   {
1884     "type": "put",
1885     "url": "/api/chat/applications/{id}",
1886     "title": "Update an existing Application",
1887     "examples": [
1888       {
1889         "title": "Example usage:",
1890         "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",
1891         "type": "json"
1892       }
1893     ],
1894     "name": "updateApplications",
1895     "group": "Chat_Applications",
1896     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1897     "version": "0.0.0",
1898     "filename": "server/api/chatApplication/index.js",
1899     "groupTitle": "Chat_Applications"
1900   },
1901   {
1902     "type": "post",
1903     "url": "/api/chat/groups",
1904     "title": "Creates a new Group",
1905     "examples": [
1906       {
1907         "title": "Example usage:",
1908         "content": "curl https://{domain}/api/chat/groups -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
1909         "type": "json"
1910       }
1911     ],
1912     "name": "CreateGroups",
1913     "group": "Chat_Groups",
1914     "parameter": {
1915       "fields": {
1916         "Body": [
1917           {
1918             "group": "Body",
1919             "type": "String",
1920             "optional": false,
1921             "field": "name",
1922             "description": ""
1923           },
1924           {
1925             "group": "Body",
1926             "type": "String",
1927             "optional": true,
1928             "field": "description",
1929             "description": ""
1930           },
1931           {
1932             "group": "Body",
1933             "type": "Boolean",
1934             "optional": true,
1935             "field": "write",
1936             "description": ""
1937           }
1938         ]
1939       }
1940     },
1941     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1942     "version": "0.0.0",
1943     "filename": "server/api/chatGroup/index.js",
1944     "groupTitle": "Chat_Groups"
1945   },
1946   {
1947     "type": "delete",
1948     "url": "/api/chat/groups/{id}",
1949     "title": "Deletes a Group",
1950     "examples": [
1951       {
1952         "title": "Example usage:",
1953         "content": "curl https://{domain}/api/chat/groups/{id} -v -u {name}:{password} -X DELETE",
1954         "type": "json"
1955       }
1956     ],
1957     "name": "DeleteGroups",
1958     "group": "Chat_Groups",
1959     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1960     "version": "0.0.0",
1961     "filename": "server/api/chatGroup/index.js",
1962     "groupTitle": "Chat_Groups"
1963   },
1964   {
1965     "type": "get",
1966     "url": "/api/chat/groups/describe",
1967     "title": "Gets table info about Groups",
1968     "examples": [
1969       {
1970         "title": "Example usage:",
1971         "content": "curl https://{domain}/api/chat/groups/describe -v -u {name}:{password}",
1972         "type": "json"
1973       }
1974     ],
1975     "name": "DescribeGroups",
1976     "group": "Chat_Groups",
1977     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1978     "version": "0.0.0",
1979     "filename": "server/api/chatGroup/index.js",
1980     "groupTitle": "Chat_Groups"
1981   },
1982   {
1983     "type": "get",
1984     "url": "/api/chat/groups",
1985     "title": "Gets a list of Groups",
1986     "examples": [
1987       {
1988         "title": "Example usage:",
1989         "content": "curl https://{domain}/api/chat/groups -v -u {name}:{password}",
1990         "type": "json"
1991       }
1992     ],
1993     "name": "GetGroups",
1994     "group": "Chat_Groups",
1995     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
1996     "version": "0.0.0",
1997     "filename": "server/api/chatGroup/index.js",
1998     "groupTitle": "Chat_Groups"
1999   },
2000   {
2001     "type": "delete",
2002     "url": "/api/chat/groups/{id}/members",
2003     "title": "Removes members from a group",
2004     "examples": [
2005       {
2006         "title": "Example usage:",
2007         "content": "curl https://{domain}/api/chat/groups/{id}/members?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
2008         "type": "json"
2009       }
2010     ],
2011     "name": "RemoveMembers",
2012     "group": "Chat_Groups",
2013     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2014     "version": "0.0.0",
2015     "filename": "server/api/chatGroup/index.js",
2016     "groupTitle": "Chat_Groups"
2017   },
2018   {
2019     "type": "get",
2020     "url": "/api/chat/groups/{id}",
2021     "title": "Gets a single Group",
2022     "examples": [
2023       {
2024         "title": "Example usage:",
2025         "content": "curl https://{domain}/api/chat/groups/{id} -v -u {name}:{password}",
2026         "type": "json"
2027       }
2028     ],
2029     "name": "ShowGroups",
2030     "group": "Chat_Groups",
2031     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2032     "version": "0.0.0",
2033     "filename": "server/api/chatGroup/index.js",
2034     "groupTitle": "Chat_Groups"
2035   },
2036   {
2037     "type": "post",
2038     "url": "/api/chat/groups/{id}/members",
2039     "title": "Add members to chat group",
2040     "examples": [
2041       {
2042         "title": "Example usage:",
2043         "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",
2044         "type": "json"
2045       }
2046     ],
2047     "name": "addMembers",
2048     "group": "Chat_Groups",
2049     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2050     "version": "0.0.0",
2051     "filename": "server/api/chatGroup/index.js",
2052     "groupTitle": "Chat_Groups"
2053   },
2054   {
2055     "type": "post",
2056     "url": "/api/chat/groups/{id}/messages",
2057     "title": "Creates a new group message",
2058     "examples": [
2059       {
2060         "title": "Example usage:",
2061         "content": "curl https://{domain}/api/chat/groups/{id}/messages -d '{\"body\": \"Hi operator!\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
2062         "type": "json"
2063       }
2064     ],
2065     "name": "addMessage",
2066     "group": "Chat_Groups",
2067     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2068     "version": "0.0.0",
2069     "filename": "server/api/chatGroup/index.js",
2070     "groupTitle": "Chat_Groups"
2071   },
2072   {
2073     "type": "get",
2074     "url": "/api/chat/groups/{id}/members",
2075     "title": "Gets Members",
2076     "examples": [
2077       {
2078         "title": "Example usage:",
2079         "content": "curl https://{domain}/api/chat/groups/{id}/members -v -u {name}:{password} -X GET",
2080         "type": "json"
2081       }
2082     ],
2083     "name": "getMembers",
2084     "group": "Chat_Groups",
2085     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2086     "version": "0.0.0",
2087     "filename": "server/api/chatGroup/index.js",
2088     "groupTitle": "Chat_Groups"
2089   },
2090   {
2091     "type": "get",
2092     "url": "/api/chat/groups/{id}/messages",
2093     "title": "Gets Messages",
2094     "examples": [
2095       {
2096         "title": "Example usage:",
2097         "content": "curl https://{domain}/api/chat/groups/{id}/messages -v -u {name}:{password} -X GET",
2098         "type": "json"
2099       }
2100     ],
2101     "name": "getMessages",
2102     "group": "Chat_Groups",
2103     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2104     "version": "0.0.0",
2105     "filename": "server/api/chatGroup/index.js",
2106     "groupTitle": "Chat_Groups"
2107   },
2108   {
2109     "type": "get",
2110     "url": "/api/chat/groups/{id}/unread",
2111     "title": "Get unread chat group messages",
2112     "examples": [
2113       {
2114         "title": "Example usage:",
2115         "content": "curl https://{domain}/api/chat/groups/{id}/unread -H 'Content-Type: application/json' -v -u {name}:{password} -X GET",
2116         "type": "json"
2117       }
2118     ],
2119     "name": "getUread",
2120     "group": "Chat_Groups",
2121     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2122     "version": "0.0.0",
2123     "filename": "server/api/chatGroup/index.js",
2124     "groupTitle": "Chat_Groups"
2125   },
2126   {
2127     "type": "put",
2128     "url": "/api/chat/groups/{id}",
2129     "title": "Update an existing Group",
2130     "examples": [
2131       {
2132         "title": "Example usage:",
2133         "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",
2134         "type": "json"
2135       }
2136     ],
2137     "name": "updateGroups",
2138     "group": "Chat_Groups",
2139     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2140     "version": "0.0.0",
2141     "filename": "server/api/chatGroup/index.js",
2142     "groupTitle": "Chat_Groups"
2143   },
2144   {
2145     "type": "post",
2146     "url": "/api/chat/interactions/{id}/tags",
2147     "title": "Add tags to the interaction",
2148     "examples": [
2149       {
2150         "title": "Example usage:",
2151         "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",
2152         "type": "json"
2153       }
2154     ],
2155     "name": "AddTags",
2156     "group": "Chat_Interactions",
2157     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2158     "version": "0.0.0",
2159     "filename": "server/api/chatInteraction/index.js",
2160     "groupTitle": "Chat_Interactions"
2161   },
2162   {
2163     "type": "post",
2164     "url": "/api/chat/interactions",
2165     "title": "Creates a new Interaction",
2166     "examples": [
2167       {
2168         "title": "Example usage:",
2169         "content": "curl https://{domain}/api/chat/interactions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
2170         "type": "json"
2171       }
2172     ],
2173     "name": "CreateInteractions",
2174     "group": "Chat_Interactions",
2175     "parameter": {
2176       "fields": {
2177         "Body": [
2178           {
2179             "group": "Body",
2180             "type": "Boolean",
2181             "optional": true,
2182             "field": "closed",
2183             "description": ""
2184           },
2185           {
2186             "group": "Body",
2187             "type": "Integer",
2188             "optional": true,
2189             "field": "ratingValue",
2190             "description": ""
2191           },
2192           {
2193             "group": "Body",
2194             "type": "String",
2195             "allowedValues": [
2196               "\"star\"",
2197               "\"thumb\""
2198             ],
2199             "optional": true,
2200             "field": "ratingType",
2201             "description": ""
2202           },
2203           {
2204             "group": "Body",
2205             "type": "Text",
2206             "optional": true,
2207             "field": "ratingMessage",
2208             "description": ""
2209           },
2210           {
2211             "group": "Body",
2212             "type": "Text",
2213             "optional": true,
2214             "field": "pathTranscript",
2215             "description": ""
2216           },
2217           {
2218             "group": "Body",
2219             "type": "String",
2220             "optional": true,
2221             "field": "mailTranscript",
2222             "description": ""
2223           },
2224           {
2225             "group": "Body",
2226             "type": "String",
2227             "optional": true,
2228             "field": "closedAt",
2229             "description": ""
2230           },
2231           {
2232             "group": "Body",
2233             "type": "String",
2234             "optional": true,
2235             "field": "disposition",
2236             "description": ""
2237           },
2238           {
2239             "group": "Body",
2240             "type": "String",
2241             "optional": true,
2242             "field": "secondDisposition",
2243             "description": ""
2244           },
2245           {
2246             "group": "Body",
2247             "type": "String",
2248             "optional": true,
2249             "field": "thirdDisposition",
2250             "description": ""
2251           },
2252           {
2253             "group": "Body",
2254             "type": "String",
2255             "optional": true,
2256             "field": "note",
2257             "description": ""
2258           },
2259           {
2260             "group": "Body",
2261             "type": "String",
2262             "optional": true,
2263             "field": "browserName",
2264             "description": ""
2265           },
2266           {
2267             "group": "Body",
2268             "type": "String",
2269             "optional": true,
2270             "field": "browserVersion",
2271             "description": ""
2272           },
2273           {
2274             "group": "Body",
2275             "type": "String",
2276             "optional": true,
2277             "field": "osName",
2278             "description": ""
2279           },
2280           {
2281             "group": "Body",
2282             "type": "String",
2283             "optional": true,
2284             "field": "osVersion",
2285             "description": ""
2286           },
2287           {
2288             "group": "Body",
2289             "type": "String",
2290             "optional": true,
2291             "field": "deviceModel",
2292             "description": ""
2293           },
2294           {
2295             "group": "Body",
2296             "type": "String",
2297             "optional": true,
2298             "field": "deviceVendor",
2299             "description": ""
2300           },
2301           {
2302             "group": "Body",
2303             "type": "String",
2304             "optional": true,
2305             "field": "deviceType",
2306             "description": ""
2307           },
2308           {
2309             "group": "Body",
2310             "type": "Text",
2311             "optional": true,
2312             "field": "referer",
2313             "description": ""
2314           },
2315           {
2316             "group": "Body",
2317             "type": "String",
2318             "optional": true,
2319             "field": "customerIp",
2320             "description": ""
2321           },
2322           {
2323             "group": "Body",
2324             "type": "Text",
2325             "optional": true,
2326             "field": "formData",
2327             "description": ""
2328           },
2329           {
2330             "group": "Body",
2331             "type": "String",
2332             "optional": true,
2333             "field": "read1stAt",
2334             "description": ""
2335           },
2336           {
2337             "group": "Body",
2338             "type": "String",
2339             "optional": true,
2340             "field": "lastMsgAt",
2341             "description": ""
2342           },
2343           {
2344             "group": "Body",
2345             "type": "String",
2346             "allowedValues": [
2347               "\"in\"",
2348               "\"out\""
2349             ],
2350             "optional": false,
2351             "field": "lastMsgDirection",
2352             "description": ""
2353           },
2354           {
2355             "group": "Body",
2356             "type": "String",
2357             "optional": true,
2358             "field": "closeReason",
2359             "description": ""
2360           },
2361           {
2362             "group": "Body",
2363             "type": "String",
2364             "optional": true,
2365             "field": "customerPort",
2366             "description": ""
2367           },
2368           {
2369             "group": "Body",
2370             "type": "Text",
2371             "optional": true,
2372             "field": "vidaooSessionId",
2373             "description": ""
2374           },
2375           {
2376             "group": "Body",
2377             "type": "Boolean",
2378             "optional": true,
2379             "field": "autoreplyExecuted",
2380             "description": ""
2381           }
2382         ]
2383       }
2384     },
2385     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2386     "version": "0.0.0",
2387     "filename": "server/api/chatInteraction/index.js",
2388     "groupTitle": "Chat_Interactions"
2389   },
2390   {
2391     "type": "delete",
2392     "url": "/api/chat/interactions/{id}",
2393     "title": "Deletes a Interaction",
2394     "examples": [
2395       {
2396         "title": "Example usage:",
2397         "content": "curl https://{domain}/api/chat/interactions/{id} -v -u {name}:{password} -X DELETE",
2398         "type": "json"
2399       }
2400     ],
2401     "name": "DeleteInteractions",
2402     "group": "Chat_Interactions",
2403     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2404     "version": "0.0.0",
2405     "filename": "server/api/chatInteraction/index.js",
2406     "groupTitle": "Chat_Interactions"
2407   },
2408   {
2409     "type": "get",
2410     "url": "/api/chat/interactions/describe",
2411     "title": "Gets table info about Interactions",
2412     "examples": [
2413       {
2414         "title": "Example usage:",
2415         "content": "curl https://{domain}/api/chat/interactions/describe -v -u {name}:{password}",
2416         "type": "json"
2417       }
2418     ],
2419     "name": "DescribeInteractions",
2420     "group": "Chat_Interactions",
2421     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2422     "version": "0.0.0",
2423     "filename": "server/api/chatInteraction/index.js",
2424     "groupTitle": "Chat_Interactions"
2425   },
2426   {
2427     "type": "get",
2428     "url": "/api/chat/interactions",
2429     "title": "Gets a list of Interactions",
2430     "examples": [
2431       {
2432         "title": "Example usage:",
2433         "content": "curl https://{domain}/api/chat/interactions -v -u {name}:{password}",
2434         "type": "json"
2435       }
2436     ],
2437     "name": "GetInteractions",
2438     "group": "Chat_Interactions",
2439     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
2440     "version": "0.0.0",
2441     "filename": "server/api/chatInteraction/index.js",
2442     "groupTitle": "Chat_Interactions"
2443   },
2444   {
2445     "type": "delete",
2446     "url": "/api/chat/interactions/{id}/tags",
2447     "title": "Removes tags from interaction",
2448     "examples": [
2449       {
2450         "title": "Example usage:",
2451         "content": "curl https://{domain}/api/chat/interactions/{id}/tags?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
2452         "type": "json"
2453       }
2454     ],
2455     "name": "RemoveTags",
2456     "group": "Chat_Interactions",
2457     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2458     "version": "0.0.0",
2459     "filename": "server/api/chatInteraction/index.js",
2460     "groupTitle": "Chat_Interactions"
2461   },
2462   {
2463     "type": "get",
2464     "url": "/api/chat/interactions/{id}",
2465     "title": "Gets a single Interaction",
2466     "examples": [
2467       {
2468         "title": "Example usage:",
2469         "content": "curl https://{domain}/api/chat/interactions/{id} -v -u {name}:{password}",
2470         "type": "json"
2471       }
2472     ],
2473     "name": "ShowInteractions",
2474     "group": "Chat_Interactions",
2475     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2476     "version": "0.0.0",
2477     "filename": "server/api/chatInteraction/index.js",
2478     "groupTitle": "Chat_Interactions"
2479   },
2480   {
2481     "type": "put",
2482     "url": "/api/chat/interactions/{id}/abandon",
2483     "title": "Abandon interaction",
2484     "examples": [
2485       {
2486         "title": "Example usage:",
2487         "content": "curl https://{domain}/api/chat/interactions/{id}/abandon -d '{\"channel\": \"chat\", \"...\": \"...\"}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
2488         "type": "json"
2489       }
2490     ],
2491     "name": "abandon",
2492     "group": "Chat_Interactions",
2493     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <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>",
2494     "version": "0.0.0",
2495     "filename": "server/api/chatInteraction/index.js",
2496     "groupTitle": "Chat_Interactions"
2497   },
2498   {
2499     "type": "put",
2500     "url": "/api/chat/interactions/{id}/close",
2501     "title": "Close Interaction",
2502     "examples": [
2503       {
2504         "title": "Example usage:",
2505         "content": "curl https://{domain}/api/chat/interactions/{id}/close -d '[{\"to\": \"+3901119886500\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
2506         "type": "json"
2507       }
2508     ],
2509     "name": "addMessage",
2510     "group": "Chat_Interactions",
2511     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2512     "version": "0.0.0",
2513     "filename": "server/api/chatInteraction/index.js",
2514     "groupTitle": "Chat_Interactions"
2515   },
2516   {
2517     "type": "post",
2518     "url": "/api/chat/interactions/{id}/messages",
2519     "title": "Creates new messages",
2520     "examples": [
2521       {
2522         "title": "Example usage:",
2523         "content": "curl https://{domain}/api/chat/interactions/{id}/messages -d '[{\"to\": \"+3901119886500\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
2524         "type": "json"
2525       }
2526     ],
2527     "name": "addMessage",
2528     "group": "Chat_Interactions",
2529     "parameter": {
2530       "fields": {
2531         "Body": [
2532           {
2533             "group": "Body",
2534             "type": "Text",
2535             "optional": false,
2536             "field": "body",
2537             "description": ""
2538           },
2539           {
2540             "group": "Body",
2541             "type": "Boolean",
2542             "optional": true,
2543             "field": "read",
2544             "description": ""
2545           },
2546           {
2547             "group": "Body",
2548             "type": "Boolean",
2549             "optional": true,
2550             "field": "secret",
2551             "description": ""
2552           },
2553           {
2554             "group": "Body",
2555             "type": "String",
2556             "allowedValues": [
2557               "\"in\"",
2558               "\"out\""
2559             ],
2560             "optional": false,
2561             "field": "direction",
2562             "description": ""
2563           },
2564           {
2565             "group": "Body",
2566             "type": "String",
2567             "optional": true,
2568             "field": "readAt",
2569             "description": ""
2570           },
2571           {
2572             "group": "Body",
2573             "type": "String",
2574             "optional": true,
2575             "field": "providerName",
2576             "description": ""
2577           },
2578           {
2579             "group": "Body",
2580             "type": "Text",
2581             "optional": true,
2582             "field": "providerResponse",
2583             "description": ""
2584           }
2585         ]
2586       }
2587     },
2588     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2589     "version": "0.0.0",
2590     "filename": "server/api/chatInteraction/index.js",
2591     "groupTitle": "Chat_Interactions"
2592   },
2593   {
2594     "type": "post",
2595     "url": "/api/chat/interactions/{id}/attachment_upload",
2596     "title": "Add attachment",
2597     "examples": [
2598       {
2599         "title": "Example usage:",
2600         "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",
2601         "type": "json"
2602       }
2603     ],
2604     "name": "attachmentUpload",
2605     "group": "Chat_Interactions",
2606     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2607     "version": "0.0.0",
2608     "filename": "server/api/chatInteraction/index.js",
2609     "groupTitle": "Chat_Interactions"
2610   },
2611   {
2612     "type": "post",
2613     "url": "/api/chat/interactions/{id}/vidaoo",
2614     "title": "Create Vidaoo Session",
2615     "examples": [
2616       {
2617         "title": "Example usage:",
2618         "content": "curl https://{domain}/api/chat/interactions/{id}/vidaoo  -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
2619         "type": "json"
2620       }
2621     ],
2622     "name": "createVidaooSession",
2623     "group": "Chat_Interactions",
2624     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2625     "version": "0.0.0",
2626     "filename": "server/api/chatInteraction/index.js",
2627     "groupTitle": "Chat_Interactions"
2628   },
2629   {
2630     "type": "put",
2631     "url": "/api/chat/interactions/{id}/custom_update",
2632     "title": "Update interaction",
2633     "examples": [
2634       {
2635         "title": "Example usage:",
2636         "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",
2637         "type": "json"
2638       }
2639     ],
2640     "name": "customUpdate",
2641     "group": "Chat_Interactions",
2642     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <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>",
2643     "version": "0.0.0",
2644     "filename": "server/api/chatInteraction/index.js",
2645     "groupTitle": "Chat_Interactions"
2646   },
2647   {
2648     "type": "get",
2649     "url": "/api/chat/interactions/{id}/download",
2650     "title": "Gets interaction",
2651     "examples": [
2652       {
2653         "title": "Example usage:",
2654         "content": "curl https://{domain}/api/chat/interactions/{id}/download -v -u {name}:{password} -X GET",
2655         "type": "json"
2656       }
2657     ],
2658     "name": "download",
2659     "group": "Chat_Interactions",
2660     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2661     "version": "0.0.0",
2662     "filename": "server/api/chatInteraction/index.js",
2663     "groupTitle": "Chat_Interactions"
2664   },
2665   {
2666     "type": "get",
2667     "url": "/api/chat/interactions/{id}/messages",
2668     "title": "Gets interaction messages",
2669     "examples": [
2670       {
2671         "title": "Example usage:",
2672         "content": "curl https://{domain}/api/chat/interactions/{id}/messages -v -u {name}:{password} -X GET",
2673         "type": "json"
2674       }
2675     ],
2676     "name": "getMessages",
2677     "group": "Chat_Interactions",
2678     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2679     "version": "0.0.0",
2680     "filename": "server/api/chatInteraction/index.js",
2681     "groupTitle": "Chat_Interactions"
2682   },
2683   {
2684     "type": "get",
2685     "url": "/api/chat/interactions/{id}/my_messages",
2686     "title": "Gets interaction messages",
2687     "examples": [
2688       {
2689         "title": "Example usage:",
2690         "content": "curl https://{domain}/api/chat/interactions/{id}/my_messages -v -u {name}:{password} -X GET",
2691         "type": "json"
2692       }
2693     ],
2694     "name": "getMyMessages",
2695     "group": "Chat_Interactions",
2696     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2697     "version": "0.0.0",
2698     "filename": "server/api/chatInteraction/index.js",
2699     "groupTitle": "Chat_Interactions"
2700   },
2701   {
2702     "type": "put",
2703     "url": "/api/chat/interactions/{id}",
2704     "title": "Update an existing Interaction",
2705     "examples": [
2706       {
2707         "title": "Example usage:",
2708         "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",
2709         "type": "json"
2710       }
2711     ],
2712     "name": "updateInteractions",
2713     "group": "Chat_Interactions",
2714     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2715     "version": "0.0.0",
2716     "filename": "server/api/chatInteraction/index.js",
2717     "groupTitle": "Chat_Interactions"
2718   },
2719   {
2720     "type": "post",
2721     "url": "/api/chat/internal/messages",
2722     "title": "Creates a new Message",
2723     "examples": [
2724       {
2725         "title": "Example usage:",
2726         "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",
2727         "type": "json"
2728       }
2729     ],
2730     "name": "CreateMessages",
2731     "group": "Chat_Internal_Messages",
2732     "parameter": {
2733       "fields": {
2734         "Body": [
2735           {
2736             "group": "Body",
2737             "type": "Text",
2738             "optional": false,
2739             "field": "body",
2740             "description": ""
2741           },
2742           {
2743             "group": "Body",
2744             "type": "Boolean",
2745             "optional": true,
2746             "field": "read",
2747             "description": ""
2748           },
2749           {
2750             "group": "Body",
2751             "type": "Integer",
2752             "optional": true,
2753             "field": "ChatInternalMessageId",
2754             "description": ""
2755           }
2756         ]
2757       }
2758     },
2759     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2760     "version": "0.0.0",
2761     "filename": "server/api/chatInternalMessage/index.js",
2762     "groupTitle": "Chat_Internal_Messages"
2763   },
2764   {
2765     "type": "delete",
2766     "url": "/api/chat/internal/messages/{id}",
2767     "title": "Deletes a Message",
2768     "examples": [
2769       {
2770         "title": "Example usage:",
2771         "content": "curl https://{domain}/api/chat/internal/messages/{id} -v -u {name}:{password} -X DELETE",
2772         "type": "json"
2773       }
2774     ],
2775     "name": "DeleteMessages",
2776     "group": "Chat_Internal_Messages",
2777     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2778     "version": "0.0.0",
2779     "filename": "server/api/chatInternalMessage/index.js",
2780     "groupTitle": "Chat_Internal_Messages"
2781   },
2782   {
2783     "type": "get",
2784     "url": "/api/chat/internal/messages/describe",
2785     "title": "Gets table info about Messages",
2786     "examples": [
2787       {
2788         "title": "Example usage:",
2789         "content": "curl https://{domain}/api/chat/internal/messages/describe -v -u {name}:{password}",
2790         "type": "json"
2791       }
2792     ],
2793     "name": "DescribeMessages",
2794     "group": "Chat_Internal_Messages",
2795     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2796     "version": "0.0.0",
2797     "filename": "server/api/chatInternalMessage/index.js",
2798     "groupTitle": "Chat_Internal_Messages"
2799   },
2800   {
2801     "type": "get",
2802     "url": "/api/chat/internal/messages",
2803     "title": "Gets a list of Messages",
2804     "examples": [
2805       {
2806         "title": "Example usage:",
2807         "content": "curl https://{domain}/api/chat/internal/messages -v -u {name}:{password}",
2808         "type": "json"
2809       }
2810     ],
2811     "name": "GetMessages",
2812     "group": "Chat_Internal_Messages",
2813     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
2814     "version": "0.0.0",
2815     "filename": "server/api/chatInternalMessage/index.js",
2816     "groupTitle": "Chat_Internal_Messages"
2817   },
2818   {
2819     "type": "get",
2820     "url": "/api/chat/internal/messages/{id}",
2821     "title": "Gets a single Message",
2822     "examples": [
2823       {
2824         "title": "Example usage:",
2825         "content": "curl https://{domain}/api/chat/internal/messages/{id} -v -u {name}:{password}",
2826         "type": "json"
2827       }
2828     ],
2829     "name": "ShowMessages",
2830     "group": "Chat_Internal_Messages",
2831     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2832     "version": "0.0.0",
2833     "filename": "server/api/chatInternalMessage/index.js",
2834     "groupTitle": "Chat_Internal_Messages"
2835   },
2836   {
2837     "type": "put",
2838     "url": "/api/chat/internal/messages/{id}",
2839     "title": "Update an existing Message",
2840     "examples": [
2841       {
2842         "title": "Example usage:",
2843         "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",
2844         "type": "json"
2845       }
2846     ],
2847     "name": "updateMessages",
2848     "group": "Chat_Internal_Messages",
2849     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2850     "version": "0.0.0",
2851     "filename": "server/api/chatInternalMessage/index.js",
2852     "groupTitle": "Chat_Internal_Messages"
2853   },
2854   {
2855     "type": "post",
2856     "url": "/api/chat/messages",
2857     "title": "Creates a new Message",
2858     "examples": [
2859       {
2860         "title": "Example usage:",
2861         "content": "curl https://{domain}/api/chat/messages -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
2862         "type": "json"
2863       }
2864     ],
2865     "name": "CreateMessages",
2866     "group": "Chat_Messages",
2867     "parameter": {
2868       "fields": {
2869         "Body": [
2870           {
2871             "group": "Body",
2872             "type": "Text",
2873             "optional": false,
2874             "field": "body",
2875             "description": ""
2876           },
2877           {
2878             "group": "Body",
2879             "type": "Boolean",
2880             "optional": true,
2881             "field": "read",
2882             "description": ""
2883           },
2884           {
2885             "group": "Body",
2886             "type": "Boolean",
2887             "optional": true,
2888             "field": "secret",
2889             "description": ""
2890           },
2891           {
2892             "group": "Body",
2893             "type": "String",
2894             "allowedValues": [
2895               "\"in\"",
2896               "\"out\""
2897             ],
2898             "optional": false,
2899             "field": "direction",
2900             "description": ""
2901           },
2902           {
2903             "group": "Body",
2904             "type": "String",
2905             "optional": true,
2906             "field": "readAt",
2907             "description": ""
2908           },
2909           {
2910             "group": "Body",
2911             "type": "String",
2912             "optional": true,
2913             "field": "providerName",
2914             "description": ""
2915           },
2916           {
2917             "group": "Body",
2918             "type": "Text",
2919             "optional": true,
2920             "field": "providerResponse",
2921             "description": ""
2922           }
2923         ]
2924       }
2925     },
2926     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2927     "version": "0.0.0",
2928     "filename": "server/api/chatMessage/index.js",
2929     "groupTitle": "Chat_Messages"
2930   },
2931   {
2932     "type": "delete",
2933     "url": "/api/chat/messages/{id}",
2934     "title": "Deletes a Message",
2935     "examples": [
2936       {
2937         "title": "Example usage:",
2938         "content": "curl https://{domain}/api/chat/messages/{id} -v -u {name}:{password} -X DELETE",
2939         "type": "json"
2940       }
2941     ],
2942     "name": "DeleteMessages",
2943     "group": "Chat_Messages",
2944     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2945     "version": "0.0.0",
2946     "filename": "server/api/chatMessage/index.js",
2947     "groupTitle": "Chat_Messages"
2948   },
2949   {
2950     "type": "get",
2951     "url": "/api/chat/messages/describe",
2952     "title": "Gets table info about Messages",
2953     "examples": [
2954       {
2955         "title": "Example usage:",
2956         "content": "curl https://{domain}/api/chat/messages/describe -v -u {name}:{password}",
2957         "type": "json"
2958       }
2959     ],
2960     "name": "DescribeMessages",
2961     "group": "Chat_Messages",
2962     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2963     "version": "0.0.0",
2964     "filename": "server/api/chatMessage/index.js",
2965     "groupTitle": "Chat_Messages"
2966   },
2967   {
2968     "type": "get",
2969     "url": "/api/chat/messages",
2970     "title": "Gets a list of Messages",
2971     "examples": [
2972       {
2973         "title": "Example usage:",
2974         "content": "curl https://{domain}/api/chat/messages -v -u {name}:{password}",
2975         "type": "json"
2976       }
2977     ],
2978     "name": "GetMessages",
2979     "group": "Chat_Messages",
2980     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
2981     "version": "0.0.0",
2982     "filename": "server/api/chatMessage/index.js",
2983     "groupTitle": "Chat_Messages"
2984   },
2985   {
2986     "type": "get",
2987     "url": "/api/chat/messages/{id}",
2988     "title": "Gets a single Message",
2989     "examples": [
2990       {
2991         "title": "Example usage:",
2992         "content": "curl https://{domain}/api/chat/messages/{id} -v -u {name}:{password}",
2993         "type": "json"
2994       }
2995     ],
2996     "name": "ShowMessages",
2997     "group": "Chat_Messages",
2998     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2999     "version": "0.0.0",
3000     "filename": "server/api/chatMessage/index.js",
3001     "groupTitle": "Chat_Messages"
3002   },
3003   {
3004     "type": "put",
3005     "url": "/api/chat/messages/{id}",
3006     "title": "Update an existing Message",
3007     "examples": [
3008       {
3009         "title": "Example usage:",
3010         "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",
3011         "type": "json"
3012       }
3013     ],
3014     "name": "updateMessages",
3015     "group": "Chat_Messages",
3016     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3017     "version": "0.0.0",
3018     "filename": "server/api/chatMessage/index.js",
3019     "groupTitle": "Chat_Messages"
3020   },
3021   {
3022     "type": "post",
3023     "url": "/api/chat/offline_messages",
3024     "title": "Creates a new OfflineMessage",
3025     "examples": [
3026       {
3027         "title": "Example usage:",
3028         "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",
3029         "type": "json"
3030       }
3031     ],
3032     "name": "CreateOfflineMessages",
3033     "group": "Chat_Offline_Messages",
3034     "parameter": {
3035       "fields": {
3036         "Body": [
3037           {
3038             "group": "Body",
3039             "type": "Text",
3040             "optional": false,
3041             "field": "body",
3042             "description": ""
3043           }
3044         ]
3045       }
3046     },
3047     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3048     "version": "0.0.0",
3049     "filename": "server/api/chatOfflineMessage/index.js",
3050     "groupTitle": "Chat_Offline_Messages"
3051   },
3052   {
3053     "type": "delete",
3054     "url": "/api/chat/offline_messages/{id}",
3055     "title": "Deletes a OfflineMessage",
3056     "examples": [
3057       {
3058         "title": "Example usage:",
3059         "content": "curl https://{domain}/api/chat/offline_messages/{id} -v -u {name}:{password} -X DELETE",
3060         "type": "json"
3061       }
3062     ],
3063     "name": "DeleteOfflineMessages",
3064     "group": "Chat_Offline_Messages",
3065     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3066     "version": "0.0.0",
3067     "filename": "server/api/chatOfflineMessage/index.js",
3068     "groupTitle": "Chat_Offline_Messages"
3069   },
3070   {
3071     "type": "get",
3072     "url": "/api/chat/offline_messages/describe",
3073     "title": "Gets table info about OfflineMessages",
3074     "examples": [
3075       {
3076         "title": "Example usage:",
3077         "content": "curl https://{domain}/api/chat/offline_messages/describe -v -u {name}:{password}",
3078         "type": "json"
3079       }
3080     ],
3081     "name": "DescribeOfflineMessages",
3082     "group": "Chat_Offline_Messages",
3083     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3084     "version": "0.0.0",
3085     "filename": "server/api/chatOfflineMessage/index.js",
3086     "groupTitle": "Chat_Offline_Messages"
3087   },
3088   {
3089     "type": "get",
3090     "url": "/api/chat/offline_messages",
3091     "title": "Gets a list of OfflineMessages",
3092     "examples": [
3093       {
3094         "title": "Example usage:",
3095         "content": "curl https://{domain}/api/chat/offline_messages -v -u {name}:{password}",
3096         "type": "json"
3097       }
3098     ],
3099     "name": "GetOfflineMessages",
3100     "group": "Chat_Offline_Messages",
3101     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
3102     "version": "0.0.0",
3103     "filename": "server/api/chatOfflineMessage/index.js",
3104     "groupTitle": "Chat_Offline_Messages"
3105   },
3106   {
3107     "type": "get",
3108     "url": "/api/chat/offline_messages/{id}",
3109     "title": "Gets a single OfflineMessage",
3110     "examples": [
3111       {
3112         "title": "Example usage:",
3113         "content": "curl https://{domain}/api/chat/offline_messages/{id} -v -u {name}:{password}",
3114         "type": "json"
3115       }
3116     ],
3117     "name": "ShowOfflineMessages",
3118     "group": "Chat_Offline_Messages",
3119     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3120     "version": "0.0.0",
3121     "filename": "server/api/chatOfflineMessage/index.js",
3122     "groupTitle": "Chat_Offline_Messages"
3123   },
3124   {
3125     "type": "put",
3126     "url": "/api/chat/offline_messages/{id}",
3127     "title": "Update an existing OfflineMessage",
3128     "examples": [
3129       {
3130         "title": "Example usage:",
3131         "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",
3132         "type": "json"
3133       }
3134     ],
3135     "name": "updateOfflineMessages",
3136     "group": "Chat_Offline_Messages",
3137     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3138     "version": "0.0.0",
3139     "filename": "server/api/chatOfflineMessage/index.js",
3140     "groupTitle": "Chat_Offline_Messages"
3141   },
3142   {
3143     "type": "post",
3144     "url": "/api/chat/proactive_actions",
3145     "title": "Creates a new Proactive Action",
3146     "examples": [
3147       {
3148         "title": "Example usage:",
3149         "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",
3150         "type": "json"
3151       }
3152     ],
3153     "name": "CreateProactive_Actions",
3154     "group": "Chat_Proactive_Actions",
3155     "parameter": {
3156       "fields": {
3157         "Body": [
3158           {
3159             "group": "Body",
3160             "type": "String",
3161             "optional": false,
3162             "field": "name",
3163             "description": ""
3164           },
3165           {
3166             "group": "Body",
3167             "type": "String",
3168             "allowedValues": [
3169               "\"mouseOver\"",
3170               "\"timeout\""
3171             ],
3172             "optional": true,
3173             "field": "type",
3174             "description": ""
3175           },
3176           {
3177             "group": "Body",
3178             "type": "String",
3179             "optional": true,
3180             "field": "selector",
3181             "description": ""
3182           },
3183           {
3184             "group": "Body",
3185             "type": "Integer",
3186             "optional": true,
3187             "field": "timeout",
3188             "description": ""
3189           }
3190         ]
3191       }
3192     },
3193     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3194     "version": "0.0.0",
3195     "filename": "server/api/chatProactiveAction/index.js",
3196     "groupTitle": "Chat_Proactive_Actions"
3197   },
3198   {
3199     "type": "delete",
3200     "url": "/api/chat/proactive_actions/{id}",
3201     "title": "Deletes a Proactive Action",
3202     "examples": [
3203       {
3204         "title": "Example usage:",
3205         "content": "curl https://{domain}/api/chat/proactive_actions/{id} -v -u {name}:{password} -X DELETE",
3206         "type": "json"
3207       }
3208     ],
3209     "name": "DeleteProactive_Actions",
3210     "group": "Chat_Proactive_Actions",
3211     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3212     "version": "0.0.0",
3213     "filename": "server/api/chatProactiveAction/index.js",
3214     "groupTitle": "Chat_Proactive_Actions"
3215   },
3216   {
3217     "type": "get",
3218     "url": "/api/chat/proactive_actions/{id}",
3219     "title": "Gets a single Proactive Action",
3220     "examples": [
3221       {
3222         "title": "Example usage:",
3223         "content": "curl https://{domain}/api/chat/proactive_actions/{id} -v -u {name}:{password}",
3224         "type": "json"
3225       }
3226     ],
3227     "name": "ShowProactive_Actions",
3228     "group": "Chat_Proactive_Actions",
3229     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3230     "version": "0.0.0",
3231     "filename": "server/api/chatProactiveAction/index.js",
3232     "groupTitle": "Chat_Proactive_Actions"
3233   },
3234   {
3235     "type": "put",
3236     "url": "/api/chat/proactive_actions/{id}",
3237     "title": "Update an existing Proactive Action",
3238     "examples": [
3239       {
3240         "title": "Example usage:",
3241         "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",
3242         "type": "json"
3243       }
3244     ],
3245     "name": "updateProactive_Actions",
3246     "group": "Chat_Proactive_Actions",
3247     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3248     "version": "0.0.0",
3249     "filename": "server/api/chatProactiveAction/index.js",
3250     "groupTitle": "Chat_Proactive_Actions"
3251   },
3252   {
3253     "type": "post",
3254     "url": "/api/chat/reports/queue",
3255     "title": "Creates a new Chat Queue Report",
3256     "examples": [
3257       {
3258         "title": "Example usage:",
3259         "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",
3260         "type": "json"
3261       }
3262     ],
3263     "name": "CreateChat_Queue_Reports",
3264     "group": "Chat_Queue_Reports",
3265     "parameter": {
3266       "fields": {
3267         "Body": [
3268           {
3269             "group": "Body",
3270             "type": "String",
3271             "optional": false,
3272             "field": "uniqueid",
3273             "description": ""
3274           },
3275           {
3276             "group": "Body",
3277             "type": "String",
3278             "optional": true,
3279             "field": "from",
3280             "description": ""
3281           },
3282           {
3283             "group": "Body",
3284             "type": "String",
3285             "optional": true,
3286             "field": "joinAt",
3287             "description": ""
3288           },
3289           {
3290             "group": "Body",
3291             "type": "String",
3292             "optional": true,
3293             "field": "leaveAt",
3294             "description": ""
3295           },
3296           {
3297             "group": "Body",
3298             "type": "String",
3299             "optional": true,
3300             "field": "acceptAt",
3301             "description": ""
3302           },
3303           {
3304             "group": "Body",
3305             "type": "String",
3306             "optional": true,
3307             "field": "exitAt",
3308             "description": ""
3309           },
3310           {
3311             "group": "Body",
3312             "type": "String",
3313             "optional": true,
3314             "field": "reason",
3315             "description": ""
3316           }
3317         ]
3318       }
3319     },
3320     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3321     "version": "0.0.0",
3322     "filename": "server/api/chatQueueReport/index.js",
3323     "groupTitle": "Chat_Queue_Reports"
3324   },
3325   {
3326     "type": "delete",
3327     "url": "/api/chat/reports/queue/{id}",
3328     "title": "Deletes a Chat Queue Report",
3329     "examples": [
3330       {
3331         "title": "Example usage:",
3332         "content": "curl https://{domain}/api/chat/reports/queue/{id} -v -u {name}:{password} -X DELETE",
3333         "type": "json"
3334       }
3335     ],
3336     "name": "DeleteChat_Queue_Reports",
3337     "group": "Chat_Queue_Reports",
3338     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3339     "version": "0.0.0",
3340     "filename": "server/api/chatQueueReport/index.js",
3341     "groupTitle": "Chat_Queue_Reports"
3342   },
3343   {
3344     "type": "get",
3345     "url": "/api/chat/reports/queue/describe",
3346     "title": "Gets table info about Chat Queue Reports",
3347     "examples": [
3348       {
3349         "title": "Example usage:",
3350         "content": "curl https://{domain}/api/chat/reports/queue/describe -v -u {name}:{password}",
3351         "type": "json"
3352       }
3353     ],
3354     "name": "DescribeChat_Queue_Reports",
3355     "group": "Chat_Queue_Reports",
3356     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3357     "version": "0.0.0",
3358     "filename": "server/api/chatQueueReport/index.js",
3359     "groupTitle": "Chat_Queue_Reports"
3360   },
3361   {
3362     "type": "get",
3363     "url": "/api/chat/reports/queue",
3364     "title": "Gets a list of Chat Queue Reports",
3365     "examples": [
3366       {
3367         "title": "Example usage:",
3368         "content": "curl https://{domain}/api/chat/reports/queue -v -u {name}:{password}",
3369         "type": "json"
3370       }
3371     ],
3372     "name": "GetChat_Queue_Reports",
3373     "group": "Chat_Queue_Reports",
3374     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
3375     "version": "0.0.0",
3376     "filename": "server/api/chatQueueReport/index.js",
3377     "groupTitle": "Chat_Queue_Reports"
3378   },
3379   {
3380     "type": "get",
3381     "url": "/api/chat/reports/queue/{id}",
3382     "title": "Gets a single Chat Queue Report",
3383     "examples": [
3384       {
3385         "title": "Example usage:",
3386         "content": "curl https://{domain}/api/chat/reports/queue/{id} -v -u {name}:{password}",
3387         "type": "json"
3388       }
3389     ],
3390     "name": "ShowChat_Queue_Reports",
3391     "group": "Chat_Queue_Reports",
3392     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3393     "version": "0.0.0",
3394     "filename": "server/api/chatQueueReport/index.js",
3395     "groupTitle": "Chat_Queue_Reports"
3396   },
3397   {
3398     "type": "put",
3399     "url": "/api/chat/reports/queue/{id}",
3400     "title": "Update an existing Chat Queue Report",
3401     "examples": [
3402       {
3403         "title": "Example usage:",
3404         "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",
3405         "type": "json"
3406       }
3407     ],
3408     "name": "updateChat_Queue_Reports",
3409     "group": "Chat_Queue_Reports",
3410     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3411     "version": "0.0.0",
3412     "filename": "server/api/chatQueueReport/index.js",
3413     "groupTitle": "Chat_Queue_Reports"
3414   },
3415   {
3416     "type": "post",
3417     "url": "/api/chat/queues/{id}/users",
3418     "title": "Add agents to a queue",
3419     "examples": [
3420       {
3421         "title": "Example usage:",
3422         "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",
3423         "type": "json"
3424       }
3425     ],
3426     "name": "AddAgents",
3427     "group": "Chat_Queues",
3428     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3429     "version": "0.0.0",
3430     "filename": "server/api/chatQueue/index.js",
3431     "groupTitle": "Chat_Queues"
3432   },
3433   {
3434     "type": "post",
3435     "url": "/api/chat/queues/{id}/teams",
3436     "title": "Add teams to a queue",
3437     "examples": [
3438       {
3439         "title": "Example usage:",
3440         "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",
3441         "type": "json"
3442       }
3443     ],
3444     "name": "AddTeams",
3445     "group": "Chat_Queues",
3446     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3447     "version": "0.0.0",
3448     "filename": "server/api/chatQueue/index.js",
3449     "groupTitle": "Chat_Queues"
3450   },
3451   {
3452     "type": "post",
3453     "url": "/api/chat/queues",
3454     "title": "Creates a new Queue",
3455     "examples": [
3456       {
3457         "title": "Example usage:",
3458         "content": "curl https://{domain}/api/chat/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
3459         "type": "json"
3460       }
3461     ],
3462     "name": "CreateQueues",
3463     "group": "Chat_Queues",
3464     "parameter": {
3465       "fields": {
3466         "Body": [
3467           {
3468             "group": "Body",
3469             "type": "String",
3470             "optional": false,
3471             "field": "name",
3472             "description": ""
3473           },
3474           {
3475             "group": "Body",
3476             "type": "String",
3477             "optional": true,
3478             "field": "description",
3479             "description": ""
3480           },
3481           {
3482             "group": "Body",
3483             "type": "Integer",
3484             "optional": true,
3485             "field": "timeout",
3486             "description": ""
3487           },
3488           {
3489             "group": "Body",
3490             "type": "String",
3491             "allowedValues": [
3492               "\"rrmemory\"",
3493               "\"beepall\"",
3494               "\"roundrobin\""
3495             ],
3496             "optional": true,
3497             "field": "strategy",
3498             "description": ""
3499           }
3500         ]
3501       }
3502     },
3503     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3504     "version": "0.0.0",
3505     "filename": "server/api/chatQueue/index.js",
3506     "groupTitle": "Chat_Queues"
3507   },
3508   {
3509     "type": "delete",
3510     "url": "/api/chat/queues/{id}",
3511     "title": "Deletes a Queue",
3512     "examples": [
3513       {
3514         "title": "Example usage:",
3515         "content": "curl https://{domain}/api/chat/queues/{id} -v -u {name}:{password} -X DELETE",
3516         "type": "json"
3517       }
3518     ],
3519     "name": "DeleteQueues",
3520     "group": "Chat_Queues",
3521     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3522     "version": "0.0.0",
3523     "filename": "server/api/chatQueue/index.js",
3524     "groupTitle": "Chat_Queues"
3525   },
3526   {
3527     "type": "get",
3528     "url": "/api/chat/queues/describe",
3529     "title": "Gets table info about Queues",
3530     "examples": [
3531       {
3532         "title": "Example usage:",
3533         "content": "curl https://{domain}/api/chat/queues/describe -v -u {name}:{password}",
3534         "type": "json"
3535       }
3536     ],
3537     "name": "DescribeQueues",
3538     "group": "Chat_Queues",
3539     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3540     "version": "0.0.0",
3541     "filename": "server/api/chatQueue/index.js",
3542     "groupTitle": "Chat_Queues"
3543   },
3544   {
3545     "type": "get",
3546     "url": "/api/chat/queues/{id}/users",
3547     "title": "Gets queue agents",
3548     "examples": [
3549       {
3550         "title": "Example usage:",
3551         "content": "curl https://{domain}/api/chat/queues/{id}/users -v -u {name}:{password} -X POST",
3552         "type": "json"
3553       }
3554     ],
3555     "name": "GetAgents",
3556     "group": "Chat_Queues",
3557     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3558     "version": "0.0.0",
3559     "filename": "server/api/chatQueue/index.js",
3560     "groupTitle": "Chat_Queues"
3561   },
3562   {
3563     "type": "get",
3564     "url": "/api/chat/queues/{id}/members",
3565     "title": "GetMembers",
3566     "examples": [
3567       {
3568         "title": "Example usage:",
3569         "content": "curl https://{domain}/api/chat/queues/{id}/members  -v -u {name}:{password}",
3570         "type": "json"
3571       }
3572     ],
3573     "name": "GetMembers",
3574     "group": "Chat_Queues",
3575     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3576     "version": "0.0.0",
3577     "filename": "server/api/chatQueue/index.js",
3578     "groupTitle": "Chat_Queues"
3579   },
3580   {
3581     "type": "get",
3582     "url": "/api/chat/queues",
3583     "title": "Gets a list of Queues",
3584     "examples": [
3585       {
3586         "title": "Example usage:",
3587         "content": "curl https://{domain}/api/chat/queues -v -u {name}:{password}",
3588         "type": "json"
3589       }
3590     ],
3591     "name": "GetQueues",
3592     "group": "Chat_Queues",
3593     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
3594     "version": "0.0.0",
3595     "filename": "server/api/chatQueue/index.js",
3596     "groupTitle": "Chat_Queues"
3597   },
3598   {
3599     "type": "get",
3600     "url": "/api/chat/queues/{id}/teams",
3601     "title": "Gets queues list",
3602     "examples": [
3603       {
3604         "title": "Example usage:",
3605         "content": "curl https://{domain}/api/chat/queues/{id}/teams -v -u {name}:{password}",
3606         "type": "json"
3607       }
3608     ],
3609     "name": "GetTeams",
3610     "group": "Chat_Queues",
3611     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3612     "version": "0.0.0",
3613     "filename": "server/api/chatQueue/index.js",
3614     "groupTitle": "Chat_Queues"
3615   },
3616   {
3617     "type": "delete",
3618     "url": "/api/chat/queues/{id}/users",
3619     "title": "Removes agents from a queue",
3620     "examples": [
3621       {
3622         "title": "Example usage:",
3623         "content": "curl https://{domain}/api/chat/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
3624         "type": "json"
3625       }
3626     ],
3627     "name": "RemoveAgents",
3628     "group": "Chat_Queues",
3629     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3630     "version": "0.0.0",
3631     "filename": "server/api/chatQueue/index.js",
3632     "groupTitle": "Chat_Queues"
3633   },
3634   {
3635     "type": "get",
3636     "url": "/api/chat/queues/{id}",
3637     "title": "Gets a single Queue",
3638     "examples": [
3639       {
3640         "title": "Example usage:",
3641         "content": "curl https://{domain}/api/chat/queues/{id} -v -u {name}:{password}",
3642         "type": "json"
3643       }
3644     ],
3645     "name": "ShowQueues",
3646     "group": "Chat_Queues",
3647     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3648     "version": "0.0.0",
3649     "filename": "server/api/chatQueue/index.js",
3650     "groupTitle": "Chat_Queues"
3651   },
3652   {
3653     "type": "put",
3654     "url": "/api/chat/queues/{id}",
3655     "title": "Update an existing Queue",
3656     "examples": [
3657       {
3658         "title": "Example usage:",
3659         "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",
3660         "type": "json"
3661       }
3662     ],
3663     "name": "updateQueues",
3664     "group": "Chat_Queues",
3665     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3666     "version": "0.0.0",
3667     "filename": "server/api/chatQueue/index.js",
3668     "groupTitle": "Chat_Queues"
3669   },
3670   {
3671     "type": "post",
3672     "url": "/api/chat/reports/transfer",
3673     "title": "Creates a new Chat Transfer Report",
3674     "examples": [
3675       {
3676         "title": "Example usage:",
3677         "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",
3678         "type": "json"
3679       }
3680     ],
3681     "name": "CreateChat_Transfer_Reports",
3682     "group": "Chat_Transfer_Reports",
3683     "parameter": {
3684       "fields": {
3685         "Body": [
3686           {
3687             "group": "Body",
3688             "type": "String",
3689             "optional": false,
3690             "field": "uniqueid",
3691             "description": ""
3692           },
3693           {
3694             "group": "Body",
3695             "type": "String",
3696             "allowedValues": [
3697               "\"account\"",
3698               "\"agent\"",
3699               "\"queue\""
3700             ],
3701             "optional": false,
3702             "field": "type",
3703             "description": ""
3704           },
3705           {
3706             "group": "Body",
3707             "type": "String",
3708             "optional": false,
3709             "field": "transferredAt",
3710             "description": ""
3711           }
3712         ]
3713       }
3714     },
3715     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3716     "version": "0.0.0",
3717     "filename": "server/api/chatTransferReport/index.js",
3718     "groupTitle": "Chat_Transfer_Reports"
3719   },
3720   {
3721     "type": "delete",
3722     "url": "/api/chat/reports/transfer/{id}",
3723     "title": "Deletes a Chat Transfer Report",
3724     "examples": [
3725       {
3726         "title": "Example usage:",
3727         "content": "curl https://{domain}/api/chat/reports/transfer/{id} -v -u {name}:{password} -X DELETE",
3728         "type": "json"
3729       }
3730     ],
3731     "name": "DeleteChat_Transfer_Reports",
3732     "group": "Chat_Transfer_Reports",
3733     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3734     "version": "0.0.0",
3735     "filename": "server/api/chatTransferReport/index.js",
3736     "groupTitle": "Chat_Transfer_Reports"
3737   },
3738   {
3739     "type": "get",
3740     "url": "/api/chat/reports/transfer/describe",
3741     "title": "Gets table info about Chat Transfer Reports",
3742     "examples": [
3743       {
3744         "title": "Example usage:",
3745         "content": "curl https://{domain}/api/chat/reports/transfer/describe -v -u {name}:{password}",
3746         "type": "json"
3747       }
3748     ],
3749     "name": "DescribeChat_Transfer_Reports",
3750     "group": "Chat_Transfer_Reports",
3751     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3752     "version": "0.0.0",
3753     "filename": "server/api/chatTransferReport/index.js",
3754     "groupTitle": "Chat_Transfer_Reports"
3755   },
3756   {
3757     "type": "get",
3758     "url": "/api/chat/reports/transfer",
3759     "title": "Gets a list of Chat Transfer Reports",
3760     "examples": [
3761       {
3762         "title": "Example usage:",
3763         "content": "curl https://{domain}/api/chat/reports/transfer -v -u {name}:{password}",
3764         "type": "json"
3765       }
3766     ],
3767     "name": "GetChat_Transfer_Reports",
3768     "group": "Chat_Transfer_Reports",
3769     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
3770     "version": "0.0.0",
3771     "filename": "server/api/chatTransferReport/index.js",
3772     "groupTitle": "Chat_Transfer_Reports"
3773   },
3774   {
3775     "type": "get",
3776     "url": "/api/chat/reports/transfer/{id}",
3777     "title": "Gets a single Chat Transfer Report",
3778     "examples": [
3779       {
3780         "title": "Example usage:",
3781         "content": "curl https://{domain}/api/chat/reports/transfer/{id} -v -u {name}:{password}",
3782         "type": "json"
3783       }
3784     ],
3785     "name": "ShowChat_Transfer_Reports",
3786     "group": "Chat_Transfer_Reports",
3787     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3788     "version": "0.0.0",
3789     "filename": "server/api/chatTransferReport/index.js",
3790     "groupTitle": "Chat_Transfer_Reports"
3791   },
3792   {
3793     "type": "put",
3794     "url": "/api/chat/reports/transfer/{id}",
3795     "title": "Update an existing Chat Transfer Report",
3796     "examples": [
3797       {
3798         "title": "Example usage:",
3799         "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",
3800         "type": "json"
3801       }
3802     ],
3803     "name": "updateChat_Transfer_Reports",
3804     "group": "Chat_Transfer_Reports",
3805     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3806     "version": "0.0.0",
3807     "filename": "server/api/chatTransferReport/index.js",
3808     "groupTitle": "Chat_Transfer_Reports"
3809   },
3810   {
3811     "type": "post",
3812     "url": "/api/chat/websites/{id}/users",
3813     "title": "Add agents to a website",
3814     "examples": [
3815       {
3816         "title": "Example usage:",
3817         "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",
3818         "type": "json"
3819       }
3820     ],
3821     "name": "AddAgents",
3822     "group": "Chat_Websites",
3823     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3824     "version": "0.0.0",
3825     "filename": "server/api/chatWebsite/index.js",
3826     "groupTitle": "Chat_Websites"
3827   },
3828   {
3829     "type": "post",
3830     "url": "/api/chat/websites",
3831     "title": "Creates a new Website",
3832     "examples": [
3833       {
3834         "title": "Example usage:",
3835         "content": "curl https://{domain}/api/chat/websites -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
3836         "type": "json"
3837       }
3838     ],
3839     "name": "CreateWebsites",
3840     "group": "Chat_Websites",
3841     "parameter": {
3842       "fields": {
3843         "Body": [
3844           {
3845             "group": "Body",
3846             "type": "String",
3847             "optional": false,
3848             "field": "name",
3849             "description": ""
3850           },
3851           {
3852             "group": "Body",
3853             "type": "String",
3854             "optional": false,
3855             "field": "address",
3856             "description": ""
3857           },
3858           {
3859             "group": "Body",
3860             "type": "String",
3861             "optional": true,
3862             "field": "description",
3863             "description": ""
3864           },
3865           {
3866             "group": "Body",
3867             "type": "String",
3868             "optional": true,
3869             "field": "mapKey",
3870             "description": ""
3871           },
3872           {
3873             "group": "Body",
3874             "type": "String",
3875             "optional": true,
3876             "field": "mapKeyOffline",
3877             "description": ""
3878           },
3879           {
3880             "group": "Body",
3881             "type": "String",
3882             "optional": false,
3883             "field": "key",
3884             "description": ""
3885           },
3886           {
3887             "group": "Body",
3888             "type": "String",
3889             "optional": true,
3890             "field": "agentAlias",
3891             "description": ""
3892           },
3893           {
3894             "group": "Body",
3895             "type": "String",
3896             "optional": true,
3897             "field": "customerAlias",
3898             "description": ""
3899           },
3900           {
3901             "group": "Body",
3902             "type": "String",
3903             "optional": false,
3904             "field": "color",
3905             "description": ""
3906           },
3907           {
3908             "group": "Body",
3909             "type": "String",
3910             "optional": false,
3911             "field": "color_button",
3912             "description": ""
3913           },
3914           {
3915             "group": "Body",
3916             "type": "String",
3917             "optional": false,
3918             "field": "textColor",
3919             "description": ""
3920           },
3921           {
3922             "group": "Body",
3923             "type": "Integer",
3924             "optional": true,
3925             "field": "fontSize",
3926             "description": ""
3927           },
3928           {
3929             "group": "Body",
3930             "type": "String",
3931             "optional": true,
3932             "field": "remote",
3933             "description": ""
3934           },
3935           {
3936             "group": "Body",
3937             "type": "Boolean",
3938             "optional": true,
3939             "field": "animation",
3940             "description": ""
3941           },
3942           {
3943             "group": "Body",
3944             "type": "String",
3945             "allowedValues": [
3946               "\"rounded\"",
3947               "\"squared\""
3948             ],
3949             "optional": true,
3950             "field": "header_shape",
3951             "description": ""
3952           },
3953           {
3954             "group": "Body",
3955             "type": "String",
3956             "optional": true,
3957             "field": "header_online",
3958             "description": ""
3959           },
3960           {
3961             "group": "Body",
3962             "type": "String",
3963             "optional": true,
3964             "field": "start_chat_button",
3965             "description": ""
3966           },
3967           {
3968             "group": "Body",
3969             "type": "String",
3970             "optional": true,
3971             "field": "offline_chat_button",
3972             "description": ""
3973           },
3974           {
3975             "group": "Body",
3976             "type": "String",
3977             "optional": true,
3978             "field": "header_offline",
3979             "description": ""
3980           },
3981           {
3982             "group": "Body",
3983             "type": "Boolean",
3984             "optional": true,
3985             "field": "download_transcript",
3986             "description": ""
3987           },
3988           {
3989             "group": "Body",
3990             "type": "Integer",
3991             "optional": true,
3992             "field": "timeout",
3993             "description": ""
3994           },
3995           {
3996             "group": "Body",
3997             "type": "String",
3998             "optional": true,
3999             "field": "whiteLabel",
4000             "description": ""
4001           },
4002           {
4003             "group": "Body",
4004             "type": "Boolean",
4005             "optional": true,
4006             "field": "defaultWhiteLabel",
4007             "description": ""
4008           },
4009           {
4010             "group": "Body",
4011             "type": "Text",
4012             "optional": true,
4013             "field": "sitepic",
4014             "description": ""
4015           },
4016           {
4017             "group": "Body",
4018             "type": "String",
4019             "optional": true,
4020             "field": "closingQuestion",
4021             "description": ""
4022           },
4023           {
4024             "group": "Body",
4025             "type": "String",
4026             "optional": true,
4027             "field": "formSubmitSuccessMessage",
4028             "description": ""
4029           },
4030           {
4031             "group": "Body",
4032             "type": "String",
4033             "optional": true,
4034             "field": "formSubmitFailureMessage",
4035             "description": ""
4036           },
4037           {
4038             "group": "Body",
4039             "type": "String",
4040             "optional": true,
4041             "field": "noteTitle",
4042             "description": ""
4043           },
4044           {
4045             "group": "Body",
4046             "type": "String",
4047             "optional": true,
4048             "field": "placeholderMessage",
4049             "description": ""
4050           },
4051           {
4052             "group": "Body",
4053             "type": "String",
4054             "optional": true,
4055             "field": "closingMessage",
4056             "description": ""
4057           },
4058           {
4059             "group": "Body",
4060             "type": "String",
4061             "optional": true,
4062             "field": "closingMessageButton",
4063             "description": ""
4064           },
4065           {
4066             "group": "Body",
4067             "type": "String",
4068             "optional": true,
4069             "field": "skipMessageButton",
4070             "description": ""
4071           },
4072           {
4073             "group": "Body",
4074             "type": "Boolean",
4075             "optional": true,
4076             "field": "conditionAgreement",
4077             "description": ""
4078           },
4079           {
4080             "group": "Body",
4081             "type": "Boolean",
4082             "optional": true,
4083             "field": "enableRating",
4084             "description": ""
4085           },
4086           {
4087             "group": "Body",
4088             "type": "Boolean",
4089             "optional": true,
4090             "field": "enableFeedback",
4091             "description": ""
4092           },
4093           {
4094             "group": "Body",
4095             "type": "Boolean",
4096             "optional": true,
4097             "field": "enableSendButton",
4098             "description": ""
4099           },
4100           {
4101             "group": "Body",
4102             "type": "String",
4103             "optional": true,
4104             "field": "feedbackTitle",
4105             "description": ""
4106           },
4107           {
4108             "group": "Body",
4109             "type": "String",
4110             "allowedValues": [
4111               "\"star\"",
4112               "\"thumb\""
4113             ],
4114             "optional": true,
4115             "field": "ratingType",
4116             "description": ""
4117           },
4118           {
4119             "group": "Body",
4120             "type": "Integer",
4121             "optional": true,
4122             "field": "ratingStarsNumber",
4123             "description": ""
4124           },
4125           {
4126             "group": "Body",
4127             "type": "Text",
4128             "optional": true,
4129             "field": "onlineForm",
4130             "description": ""
4131           },
4132           {
4133             "group": "Body",
4134             "type": "Text",
4135             "optional": true,
4136             "field": "offlineForm",
4137             "description": ""
4138           },
4139           {
4140             "group": "Body",
4141             "type": "String",
4142             "optional": true,
4143             "field": "token",
4144             "description": ""
4145           },
4146           {
4147             "group": "Body",
4148             "type": "Boolean",
4149             "optional": true,
4150             "field": "autoclose",
4151             "description": ""
4152           },
4153           {
4154             "group": "Body",
4155             "type": "Boolean",
4156             "optional": true,
4157             "field": "enableCustomerWriting",
4158             "description": ""
4159           },
4160           {
4161             "group": "Body",
4162             "type": "Boolean",
4163             "optional": true,
4164             "field": "forwardTranscript",
4165             "description": ""
4166           },
4167           {
4168             "group": "Body",
4169             "type": "String",
4170             "optional": true,
4171             "field": "forwardTranscriptMessage",
4172             "description": ""
4173           },
4174           {
4175             "group": "Body",
4176             "type": "Boolean",
4177             "optional": true,
4178             "field": "forwardOffline",
4179             "description": ""
4180           },
4181           {
4182             "group": "Body",
4183             "type": "String",
4184             "optional": true,
4185             "field": "forwardOfflineAddress",
4186             "description": ""
4187           },
4188           {
4189             "group": "Body",
4190             "type": "String",
4191             "optional": true,
4192             "field": "waitingTitle",
4193             "description": ""
4194           },
4195           {
4196             "group": "Body",
4197             "type": "String",
4198             "optional": true,
4199             "field": "waitingMessage",
4200             "description": ""
4201           },
4202           {
4203             "group": "Body",
4204             "type": "String",
4205             "optional": true,
4206             "field": "offlineMessageSubject",
4207             "description": ""
4208           },
4209           {
4210             "group": "Body",
4211             "type": "String",
4212             "optional": true,
4213             "field": "offlineMessageBody",
4214             "description": ""
4215           },
4216           {
4217             "group": "Body",
4218             "type": "Boolean",
4219             "optional": true,
4220             "field": "enableUnmanagedNote",
4221             "description": ""
4222           },
4223           {
4224             "group": "Body",
4225             "type": "String",
4226             "optional": true,
4227             "field": "unmanagedMessage",
4228             "description": ""
4229           },
4230           {
4231             "group": "Body",
4232             "type": "String",
4233             "optional": true,
4234             "field": "skipUnmanaged",
4235             "description": ""
4236           },
4237           {
4238             "group": "Body",
4239             "type": "String",
4240             "optional": true,
4241             "field": "sendUnmanaged",
4242             "description": ""
4243           },
4244           {
4245             "group": "Body",
4246             "type": "Boolean",
4247             "optional": true,
4248             "field": "enableCustomerAttachment",
4249             "description": ""
4250           },
4251           {
4252             "group": "Body",
4253             "type": "Boolean",
4254             "optional": true,
4255             "field": "enableCustomerCheckmarks",
4256             "description": ""
4257           },
4258           {
4259             "group": "Body",
4260             "type": "Text",
4261             "optional": true,
4262             "field": "agentAvatar",
4263             "description": ""
4264           },
4265           {
4266             "group": "Body",
4267             "type": "Boolean",
4268             "optional": true,
4269             "field": "showAgentAvatar",
4270             "description": ""
4271           },
4272           {
4273             "group": "Body",
4274             "type": "String",
4275             "optional": true,
4276             "field": "timezone",
4277             "description": ""
4278           },
4279           {
4280             "group": "Body",
4281             "type": "Text",
4282             "optional": true,
4283             "field": "notificationTemplate",
4284             "description": ""
4285           },
4286           {
4287             "group": "Body",
4288             "type": "Boolean",
4289             "optional": true,
4290             "field": "notificationSound",
4291             "description": ""
4292           },
4293           {
4294             "group": "Body",
4295             "type": "Boolean",
4296             "optional": true,
4297             "field": "notificationShake",
4298             "description": ""
4299           },
4300           {
4301             "group": "Body",
4302             "type": "Boolean",
4303             "optional": true,
4304             "field": "hideWhenOffline",
4305             "description": ""
4306           },
4307           {
4308             "group": "Body",
4309             "type": "String",
4310             "optional": true,
4311             "field": "agentIdentifier",
4312             "description": ""
4313           },
4314           {
4315             "group": "Body",
4316             "type": "Integer",
4317             "optional": true,
4318             "field": "waitForTheAssignedAgent",
4319             "description": ""
4320           },
4321           {
4322             "group": "Body",
4323             "type": "String",
4324             "optional": true,
4325             "field": "alignment",
4326             "description": ""
4327           },
4328           {
4329             "group": "Body",
4330             "type": "Integer",
4331             "optional": true,
4332             "field": "verticalAlignment",
4333             "description": ""
4334           },
4335           {
4336             "group": "Body",
4337             "type": "String",
4338             "optional": true,
4339             "field": "labelText",
4340             "description": ""
4341           },
4342           {
4343             "group": "Body",
4344             "type": "String",
4345             "optional": true,
4346             "field": "messagesAlignment",
4347             "description": ""
4348           },
4349           {
4350             "group": "Body",
4351             "type": "String",
4352             "optional": true,
4353             "field": "defaultTitle",
4354             "description": ""
4355           },
4356           {
4357             "group": "Body",
4358             "type": "Text",
4359             "optional": true,
4360             "field": "customerAvatar",
4361             "description": ""
4362           },
4363           {
4364             "group": "Body",
4365             "type": "Boolean",
4366             "optional": true,
4367             "field": "showCustomerAvatar",
4368             "description": ""
4369           },
4370           {
4371             "group": "Body",
4372             "type": "Integer",
4373             "optional": true,
4374             "field": "messageFontSize",
4375             "description": ""
4376           },
4377           {
4378             "group": "Body",
4379             "type": "String",
4380             "optional": false,
4381             "field": "backgroundColor",
4382             "description": ""
4383           },
4384           {
4385             "group": "Body",
4386             "type": "Boolean",
4387             "optional": true,
4388             "field": "queueTransfer",
4389             "description": ""
4390           },
4391           {
4392             "group": "Body",
4393             "type": "Integer",
4394             "optional": true,
4395             "field": "queueTransferTimeout",
4396             "description": ""
4397           },
4398           {
4399             "group": "Body",
4400             "type": "Boolean",
4401             "optional": true,
4402             "field": "agentTransfer",
4403             "description": ""
4404           },
4405           {
4406             "group": "Body",
4407             "type": "Integer",
4408             "optional": true,
4409             "field": "agentTransferTimeout",
4410             "description": ""
4411           },
4412           {
4413             "group": "Body",
4414             "type": "String",
4415             "optional": true,
4416             "field": "systemAlias",
4417             "description": ""
4418           },
4419           {
4420             "group": "Body",
4421             "type": "Text",
4422             "optional": true,
4423             "field": "systemAvatar",
4424             "description": ""
4425           },
4426           {
4427             "group": "Body",
4428             "type": "Integer",
4429             "optional": true,
4430             "field": "mandatoryDispositionPauseId",
4431             "description": "<p>Status to put when mandatory disposition is enabled</p>"
4432           },
4433           {
4434             "group": "Body",
4435             "type": "Boolean",
4436             "optional": true,
4437             "field": "mandatoryDisposition",
4438             "description": "<p>Enabled/disables mandatory dispo on a queue</p>"
4439           },
4440           {
4441             "group": "Body",
4442             "type": "Boolean",
4443             "optional": true,
4444             "field": "vidaooEscalation",
4445             "description": ""
4446           },
4447           {
4448             "group": "Body",
4449             "type": "String",
4450             "optional": true,
4451             "field": "vidaooApiKey",
4452             "description": ""
4453           },
4454           {
4455             "group": "Body",
4456             "type": "String",
4457             "optional": false,
4458             "field": "vidaooTopic",
4459             "description": ""
4460           },
4461           {
4462             "group": "Body",
4463             "type": "String",
4464             "optional": true,
4465             "field": "vidaooNote",
4466             "description": ""
4467           },
4468           {
4469             "group": "Body",
4470             "type": "Text",
4471             "optional": true,
4472             "field": "vidaooMetadata",
4473             "description": ""
4474           },
4475           {
4476             "group": "Body",
4477             "type": "Boolean",
4478             "optional": true,
4479             "field": "openNewInteraction",
4480             "description": ""
4481           },
4482           {
4483             "group": "Body",
4484             "type": "Text",
4485             "optional": true,
4486             "field": "subjectOffline",
4487             "description": ""
4488           }
4489         ]
4490       }
4491     },
4492     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4493     "version": "0.0.0",
4494     "filename": "server/api/chatWebsite/index.js",
4495     "groupTitle": "Chat_Websites"
4496   },
4497   {
4498     "type": "delete",
4499     "url": "/api/chat/websites/{id}",
4500     "title": "Deletes a Website",
4501     "examples": [
4502       {
4503         "title": "Example usage:",
4504         "content": "curl https://{domain}/api/chat/websites/{id} -v -u {name}:{password} -X DELETE",
4505         "type": "json"
4506       }
4507     ],
4508     "name": "DeleteWebsites",
4509     "group": "Chat_Websites",
4510     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4511     "version": "0.0.0",
4512     "filename": "server/api/chatWebsite/index.js",
4513     "groupTitle": "Chat_Websites"
4514   },
4515   {
4516     "type": "get",
4517     "url": "/api/chat/websites/describe",
4518     "title": "Gets table info about Websites",
4519     "examples": [
4520       {
4521         "title": "Example usage:",
4522         "content": "curl https://{domain}/api/chat/websites/describe -v -u {name}:{password}",
4523         "type": "json"
4524       }
4525     ],
4526     "name": "DescribeWebsites",
4527     "group": "Chat_Websites",
4528     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4529     "version": "0.0.0",
4530     "filename": "server/api/chatWebsite/index.js",
4531     "groupTitle": "Chat_Websites"
4532   },
4533   {
4534     "type": "get",
4535     "url": "/api/chat/websites/{id}/users",
4536     "title": "Gets agents from website",
4537     "examples": [
4538       {
4539         "title": "Example usage:",
4540         "content": "curl https://{domain}/api/chat/websites/{id}/users -v -u {name}:{password} -X GET",
4541         "type": "json"
4542       }
4543     ],
4544     "name": "GetAgents",
4545     "group": "Chat_Websites",
4546     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4547     "version": "0.0.0",
4548     "filename": "server/api/chatWebsite/index.js",
4549     "groupTitle": "Chat_Websites"
4550   },
4551   {
4552     "type": "get",
4553     "url": "/api/chat/websites",
4554     "title": "Gets a list of Websites",
4555     "examples": [
4556       {
4557         "title": "Example usage:",
4558         "content": "curl https://{domain}/api/chat/websites -v -u {name}:{password}",
4559         "type": "json"
4560       }
4561     ],
4562     "name": "GetWebsites",
4563     "group": "Chat_Websites",
4564     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
4565     "version": "0.0.0",
4566     "filename": "server/api/chatWebsite/index.js",
4567     "groupTitle": "Chat_Websites"
4568   },
4569   {
4570     "type": "delete",
4571     "url": "/api/chat/websites/{id}/users",
4572     "title": "Removes agents from a website",
4573     "examples": [
4574       {
4575         "title": "Example usage:",
4576         "content": "curl https://{domain}/api/chat/websites/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
4577         "type": "json"
4578       }
4579     ],
4580     "name": "RemoveAgents",
4581     "group": "Chat_Websites",
4582     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4583     "version": "0.0.0",
4584     "filename": "server/api/chatWebsite/index.js",
4585     "groupTitle": "Chat_Websites"
4586   },
4587   {
4588     "type": "delete",
4589     "url": "/api/chat/websites/{id}/canned_answers",
4590     "title": "Removes canned answers from account",
4591     "examples": [
4592       {
4593         "title": "Example usage:",
4594         "content": "curl https://{domain}/api/chat/websites/{id}/canned_answers?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
4595         "type": "json"
4596       }
4597     ],
4598     "name": "RemoveAnswers",
4599     "group": "Chat_Websites",
4600     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4601     "version": "0.0.0",
4602     "filename": "server/api/chatWebsite/index.js",
4603     "groupTitle": "Chat_Websites"
4604   },
4605   {
4606     "type": "delete",
4607     "url": "/api/chat/websites/{id}/dispositions",
4608     "title": "Removes canned answers from account",
4609     "examples": [
4610       {
4611         "title": "Example usage:",
4612         "content": "curl https://{domain}/api/chat/websites/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
4613         "type": "json"
4614       }
4615     ],
4616     "name": "RemoveDispositions",
4617     "group": "Chat_Websites",
4618     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4619     "version": "0.0.0",
4620     "filename": "server/api/chatWebsite/index.js",
4621     "groupTitle": "Chat_Websites"
4622   },
4623   {
4624     "type": "get",
4625     "url": "/api/chat/websites/{id}",
4626     "title": "Gets a single Website",
4627     "examples": [
4628       {
4629         "title": "Example usage:",
4630         "content": "curl https://{domain}/api/chat/websites/{id} -v -u {name}:{password}",
4631         "type": "json"
4632       }
4633     ],
4634     "name": "ShowWebsites",
4635     "group": "Chat_Websites",
4636     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4637     "version": "0.0.0",
4638     "filename": "server/api/chatWebsite/index.js",
4639     "groupTitle": "Chat_Websites"
4640   },
4641   {
4642     "type": "put",
4643     "url": "/api/chat/messages/{id}/accept",
4644     "title": "Accepts message",
4645     "examples": [
4646       {
4647         "title": "Example usage:",
4648         "content": "curl https://{domain}/api/chat/messages/{id}/accept \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
4649         "type": "json"
4650       }
4651     ],
4652     "name": "acceptMessage",
4653     "group": "Chat_Websites",
4654     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4655     "version": "0.0.0",
4656     "filename": "server/api/chatMessage/index.js",
4657     "groupTitle": "Chat_Websites"
4658   },
4659   {
4660     "type": "post",
4661     "url": "/api/chat/websites/{id}/canned_answers",
4662     "title": "Creates new canned answer",
4663     "examples": [
4664       {
4665         "title": "Example usage:",
4666         "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",
4667         "type": "json"
4668       }
4669     ],
4670     "name": "addAnswer",
4671     "group": "Chat_Websites",
4672     "parameter": {
4673       "fields": {
4674         "Body": [
4675           {
4676             "group": "Body",
4677             "type": "String",
4678             "optional": false,
4679             "field": "key",
4680             "description": ""
4681           },
4682           {
4683             "group": "Body",
4684             "type": "Text",
4685             "optional": false,
4686             "field": "value",
4687             "description": ""
4688           },
4689           {
4690             "group": "Body",
4691             "type": "String",
4692             "optional": true,
4693             "field": "description",
4694             "description": ""
4695           },
4696           {
4697             "group": "Body",
4698             "type": "Virtual",
4699             "optional": true,
4700             "field": "name",
4701             "description": ""
4702           }
4703         ]
4704       }
4705     },
4706     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4707     "version": "0.0.0",
4708     "filename": "server/api/chatWebsite/index.js",
4709     "groupTitle": "Chat_Websites"
4710   },
4711   {
4712     "type": "post",
4713     "url": "/api/chat/websites/{id}/applications",
4714     "title": "Creates new applications",
4715     "examples": [
4716       {
4717         "title": "Example usage:",
4718         "content": "curl https://{domain}/api/chat/websites/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
4719         "type": "json"
4720       }
4721     ],
4722     "name": "addApplications",
4723     "group": "Chat_Websites",
4724     "parameter": {
4725       "fields": {
4726         "Body": [
4727           {
4728             "group": "Body",
4729             "type": "Integer",
4730             "optional": false,
4731             "field": "priority",
4732             "description": ""
4733           },
4734           {
4735             "group": "Body",
4736             "type": "String",
4737             "optional": false,
4738             "field": "app",
4739             "description": ""
4740           },
4741           {
4742             "group": "Body",
4743             "type": "Text",
4744             "optional": true,
4745             "field": "appdata",
4746             "description": ""
4747           },
4748           {
4749             "group": "Body",
4750             "type": "String",
4751             "optional": true,
4752             "field": "description",
4753             "description": ""
4754           },
4755           {
4756             "group": "Body",
4757             "type": "String",
4758             "optional": true,
4759             "field": "interval",
4760             "description": ""
4761           }
4762         ]
4763       }
4764     },
4765     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4766     "version": "0.0.0",
4767     "filename": "server/api/chatWebsite/index.js",
4768     "groupTitle": "Chat_Websites"
4769   },
4770   {
4771     "type": "post",
4772     "url": "/api/chat/websites/{id}/avatar",
4773     "title": "Add avatar",
4774     "examples": [
4775       {
4776         "title": "Example usage:",
4777         "content": "curl https://{domain}/api/chat/websites/{id}/avatar -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
4778         "type": "json"
4779       }
4780     ],
4781     "name": "addAvatar",
4782     "group": "Chat_Websites",
4783     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4784     "version": "0.0.0",
4785     "filename": "server/api/chatWebsite/index.js",
4786     "groupTitle": "Chat_Websites"
4787   },
4788   {
4789     "type": "post",
4790     "url": "/api/chat/websites/{id}/customer_avatar",
4791     "title": "Add customer avatar",
4792     "examples": [
4793       {
4794         "title": "Example usage:",
4795         "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",
4796         "type": "json"
4797       }
4798     ],
4799     "name": "addCustomerAvatar",
4800     "group": "Chat_Websites",
4801     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4802     "version": "0.0.0",
4803     "filename": "server/api/chatWebsite/index.js",
4804     "groupTitle": "Chat_Websites"
4805   },
4806   {
4807     "type": "post",
4808     "url": "/api/chat/websites/{id}/dispositions",
4809     "title": "Creates new disposition",
4810     "examples": [
4811       {
4812         "title": "Example usage:",
4813         "content": "curl https://{domain}/api/chat/websites/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
4814         "type": "json"
4815       }
4816     ],
4817     "name": "addDisposition",
4818     "group": "Chat_Websites",
4819     "parameter": {
4820       "fields": {
4821         "Body": [
4822           {
4823             "group": "Body",
4824             "type": "String",
4825             "optional": false,
4826             "field": "name",
4827             "description": ""
4828           },
4829           {
4830             "group": "Body",
4831             "type": "String",
4832             "allowedValues": [
4833               "\"first\"",
4834               "\"second\"",
4835               "\"third\""
4836             ],
4837             "optional": false,
4838             "field": "level",
4839             "description": ""
4840           },
4841           {
4842             "group": "Body",
4843             "type": "String",
4844             "optional": true,
4845             "field": "description",
4846             "description": ""
4847           }
4848         ]
4849       }
4850     },
4851     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4852     "version": "0.0.0",
4853     "filename": "server/api/chatWebsite/index.js",
4854     "groupTitle": "Chat_Websites"
4855   },
4856   {
4857     "type": "post",
4858     "url": "/api/chat/accounts/{id}/interactions",
4859     "title": "Creates new interactions",
4860     "examples": [
4861       {
4862         "title": "Example usage:",
4863         "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",
4864         "type": "json"
4865       }
4866     ],
4867     "name": "addInteraction",
4868     "group": "Chat_Websites",
4869     "parameter": {
4870       "fields": {
4871         "Body": [
4872           {
4873             "group": "Body",
4874             "type": "Boolean",
4875             "optional": true,
4876             "field": "closed",
4877             "description": ""
4878           },
4879           {
4880             "group": "Body",
4881             "type": "Integer",
4882             "optional": true,
4883             "field": "ratingValue",
4884             "description": ""
4885           },
4886           {
4887             "group": "Body",
4888             "type": "String",
4889             "allowedValues": [
4890               "\"star\"",
4891               "\"thumb\""
4892             ],
4893             "optional": true,
4894             "field": "ratingType",
4895             "description": ""
4896           },
4897           {
4898             "group": "Body",
4899             "type": "Text",
4900             "optional": true,
4901             "field": "ratingMessage",
4902             "description": ""
4903           },
4904           {
4905             "group": "Body",
4906             "type": "Text",
4907             "optional": true,
4908             "field": "pathTranscript",
4909             "description": ""
4910           },
4911           {
4912             "group": "Body",
4913             "type": "String",
4914             "optional": true,
4915             "field": "mailTranscript",
4916             "description": ""
4917           },
4918           {
4919             "group": "Body",
4920             "type": "String",
4921             "optional": true,
4922             "field": "closedAt",
4923             "description": ""
4924           },
4925           {
4926             "group": "Body",
4927             "type": "String",
4928             "optional": true,
4929             "field": "disposition",
4930             "description": ""
4931           },
4932           {
4933             "group": "Body",
4934             "type": "String",
4935             "optional": true,
4936             "field": "secondDisposition",
4937             "description": ""
4938           },
4939           {
4940             "group": "Body",
4941             "type": "String",
4942             "optional": true,
4943             "field": "thirdDisposition",
4944             "description": ""
4945           },
4946           {
4947             "group": "Body",
4948             "type": "String",
4949             "optional": true,
4950             "field": "note",
4951             "description": ""
4952           },
4953           {
4954             "group": "Body",
4955             "type": "String",
4956             "optional": true,
4957             "field": "browserName",
4958             "description": ""
4959           },
4960           {
4961             "group": "Body",
4962             "type": "String",
4963             "optional": true,
4964             "field": "browserVersion",
4965             "description": ""
4966           },
4967           {
4968             "group": "Body",
4969             "type": "String",
4970             "optional": true,
4971             "field": "osName",
4972             "description": ""
4973           },
4974           {
4975             "group": "Body",
4976             "type": "String",
4977             "optional": true,
4978             "field": "osVersion",
4979             "description": ""
4980           },
4981           {
4982             "group": "Body",
4983             "type": "String",
4984             "optional": true,
4985             "field": "deviceModel",
4986             "description": ""
4987           },
4988           {
4989             "group": "Body",
4990             "type": "String",
4991             "optional": true,
4992             "field": "deviceVendor",
4993             "description": ""
4994           },
4995           {
4996             "group": "Body",
4997             "type": "String",
4998             "optional": true,
4999             "field": "deviceType",
5000             "description": ""
5001           },
5002           {
5003             "group": "Body",
5004             "type": "Text",
5005             "optional": true,
5006             "field": "referer",
5007             "description": ""
5008           },
5009           {
5010             "group": "Body",
5011             "type": "String",
5012             "optional": true,
5013             "field": "customerIp",
5014             "description": ""
5015           },
5016           {
5017             "group": "Body",
5018             "type": "Text",
5019             "optional": true,
5020             "field": "formData",
5021             "description": ""
5022           },
5023           {
5024             "group": "Body",
5025             "type": "String",
5026             "optional": true,
5027             "field": "read1stAt",
5028             "description": ""
5029           },
5030           {
5031             "group": "Body",
5032             "type": "String",
5033             "optional": true,
5034             "field": "lastMsgAt",
5035             "description": ""
5036           },
5037           {
5038             "group": "Body",
5039             "type": "String",
5040             "allowedValues": [
5041               "\"in\"",
5042               "\"out\""
5043             ],
5044             "optional": false,
5045             "field": "lastMsgDirection",
5046             "description": ""
5047           },
5048           {
5049             "group": "Body",
5050             "type": "String",
5051             "optional": true,
5052             "field": "closeReason",
5053             "description": ""
5054           },
5055           {
5056             "group": "Body",
5057             "type": "String",
5058             "optional": true,
5059             "field": "customerPort",
5060             "description": ""
5061           },
5062           {
5063             "group": "Body",
5064             "type": "Text",
5065             "optional": true,
5066             "field": "vidaooSessionId",
5067             "description": ""
5068           },
5069           {
5070             "group": "Body",
5071             "type": "Boolean",
5072             "optional": true,
5073             "field": "autoreplyExecuted",
5074             "description": ""
5075           }
5076         ]
5077       }
5078     },
5079     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5080     "version": "0.0.0",
5081     "filename": "server/api/chatWebsite/index.js",
5082     "groupTitle": "Chat_Websites"
5083   },
5084   {
5085     "type": "post",
5086     "url": "/api/chat/websites/{id}/logo",
5087     "title": "Add logo",
5088     "examples": [
5089       {
5090         "title": "Example usage:",
5091         "content": "curl https://{domain}/api/chat/websites/{id}/logo -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
5092         "type": "json"
5093       }
5094     ],
5095     "name": "addLogo",
5096     "group": "Chat_Websites",
5097     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5098     "version": "0.0.0",
5099     "filename": "server/api/chatWebsite/index.js",
5100     "groupTitle": "Chat_Websites"
5101   },
5102   {
5103     "type": "post",
5104     "url": "/api/chat/websites/{id}/proactive_actions",
5105     "title": "Creates new Proactive Actions",
5106     "examples": [
5107       {
5108         "title": "Example usage:",
5109         "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",
5110         "type": "json"
5111       }
5112     ],
5113     "name": "addProactiveActions",
5114     "group": "Chat_Websites",
5115     "parameter": {
5116       "fields": {
5117         "Body": [
5118           {
5119             "group": "Body",
5120             "type": "String",
5121             "optional": false,
5122             "field": "name",
5123             "description": ""
5124           },
5125           {
5126             "group": "Body",
5127             "type": "String",
5128             "allowedValues": [
5129               "\"mouseOver\"",
5130               "\"timeout\""
5131             ],
5132             "optional": true,
5133             "field": "type",
5134             "description": ""
5135           },
5136           {
5137             "group": "Body",
5138             "type": "String",
5139             "optional": true,
5140             "field": "selector",
5141             "description": ""
5142           },
5143           {
5144             "group": "Body",
5145             "type": "Integer",
5146             "optional": true,
5147             "field": "timeout",
5148             "description": ""
5149           }
5150         ]
5151       }
5152     },
5153     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5154     "version": "0.0.0",
5155     "filename": "server/api/chatWebsite/index.js",
5156     "groupTitle": "Chat_Websites"
5157   },
5158   {
5159     "type": "post",
5160     "url": "/api/chat/websites/{id}/system_avatar",
5161     "title": "Add system avatar",
5162     "examples": [
5163       {
5164         "title": "Example usage:",
5165         "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",
5166         "type": "json"
5167       }
5168     ],
5169     "name": "addSystemAvatar",
5170     "group": "Chat_Websites",
5171     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5172     "version": "0.0.0",
5173     "filename": "server/api/chatWebsite/index.js",
5174     "groupTitle": "Chat_Websites"
5175   },
5176   {
5177     "type": "get",
5178     "url": "/api/chat/websites/{id}/canned_answers",
5179     "title": "Gets account canned answers",
5180     "examples": [
5181       {
5182         "title": "Example usage:",
5183         "content": "curl https://{domain}/api/chat/websites/{id}/canned_answers -v -u {name}:{password} -X GET",
5184         "type": "json"
5185       }
5186     ],
5187     "name": "getAnswers",
5188     "group": "Chat_Websites",
5189     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5190     "version": "0.0.0",
5191     "filename": "server/api/chatWebsite/index.js",
5192     "groupTitle": "Chat_Websites"
5193   },
5194   {
5195     "type": "get",
5196     "url": "/api/chat/websites/{id}/applications",
5197     "title": "Gets Website Applications",
5198     "examples": [
5199       {
5200         "title": "Example usage:",
5201         "content": "curl https://{domain}/api/chat/websites/{id}/applications -v -u {name}:{password} -X GET",
5202         "type": "json"
5203       }
5204     ],
5205     "name": "getApplications",
5206     "group": "Chat_Websites",
5207     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5208     "version": "0.0.0",
5209     "filename": "server/api/chatWebsite/index.js",
5210     "groupTitle": "Chat_Websites"
5211   },
5212   {
5213     "type": "get",
5214     "url": "/api/chat/websites/{id}/avatar",
5215     "title": "Get avatar",
5216     "examples": [
5217       {
5218         "title": "Example usage:",
5219         "content": "curl https://{domain}/api/chat/websites/{id}/avatar -v -u {name}:{password} -X GET",
5220         "type": "json"
5221       }
5222     ],
5223     "name": "getAvatar",
5224     "group": "Chat_Websites",
5225     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5226     "version": "0.0.0",
5227     "filename": "server/api/chatWebsite/index.js",
5228     "groupTitle": "Chat_Websites"
5229   },
5230   {
5231     "type": "get",
5232     "url": "/api/chat/websites/{id}/customer_avatar",
5233     "title": "Get Customer Avatar",
5234     "examples": [
5235       {
5236         "title": "Example usage:",
5237         "content": "curl https://{domain}/api/chat/websites/{id}/customer_avatar -v -u {name}:{password} -X GET",
5238         "type": "json"
5239       }
5240     ],
5241     "name": "getCustomerAvatar",
5242     "group": "Chat_Websites",
5243     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5244     "version": "0.0.0",
5245     "filename": "server/api/chatWebsite/index.js",
5246     "groupTitle": "Chat_Websites"
5247   },
5248   {
5249     "type": "get",
5250     "url": "/api/chat/websites/{id}/dispositions",
5251     "title": "Gets account dispositions",
5252     "examples": [
5253       {
5254         "title": "Example usage:",
5255         "content": "curl https://{domain}/api/chat/websites/{id}/dispositions -v -u {name}:{password} -X GET",
5256         "type": "json"
5257       }
5258     ],
5259     "name": "getDispositions",
5260     "group": "Chat_Websites",
5261     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5262     "version": "0.0.0",
5263     "filename": "server/api/chatWebsite/index.js",
5264     "groupTitle": "Chat_Websites"
5265   },
5266   {
5267     "type": "get",
5268     "url": "/api/chat/websites/{id}/fields",
5269     "title": "Gets Website Fields",
5270     "examples": [
5271       {
5272         "title": "Example usage:",
5273         "content": "curl https://{domain}/api/chat/websites/{id}/fields -v -u {name}:{password} -X GET",
5274         "type": "json"
5275       }
5276     ],
5277     "name": "getFields",
5278     "group": "Chat_Websites",
5279     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5280     "version": "0.0.0",
5281     "filename": "server/api/chatWebsite/index.js",
5282     "groupTitle": "Chat_Websites"
5283   },
5284   {
5285     "type": "get",
5286     "url": "/api/chat/websites/{id}/interactions",
5287     "title": "Gets Website Interactions",
5288     "examples": [
5289       {
5290         "title": "Example usage:",
5291         "content": "curl https://{domain}/api/chat/websites/{id}/interactions -v -u {name}:{password} -X GET",
5292         "type": "json"
5293       }
5294     ],
5295     "name": "getInteraction",
5296     "group": "Chat_Websites",
5297     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5298     "version": "0.0.0",
5299     "filename": "server/api/chatWebsite/index.js",
5300     "groupTitle": "Chat_Websites"
5301   },
5302   {
5303     "type": "get",
5304     "url": "/api/chat/websites/{id}/logo",
5305     "title": "Get logo",
5306     "examples": [
5307       {
5308         "title": "Example usage:",
5309         "content": "curl https://{domain}/api/chat/websites/{id}/logo -v -u {name}:{password} -X GET",
5310         "type": "json"
5311       }
5312     ],
5313     "name": "getLogo",
5314     "group": "Chat_Websites",
5315     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5316     "version": "0.0.0",
5317     "filename": "server/api/chatWebsite/index.js",
5318     "groupTitle": "Chat_Websites"
5319   },
5320   {
5321     "type": "get",
5322     "url": "/api/chat/websites/{id}/offline_messages",
5323     "title": "Gets Website Offline Messages",
5324     "examples": [
5325       {
5326         "title": "Example usage:",
5327         "content": "curl https://{domain}/api/chat/websites/{id}/offline_messages -v -u {name}:{password} -X GET",
5328         "type": "json"
5329       }
5330     ],
5331     "name": "getOfflineMessages",
5332     "group": "Chat_Websites",
5333     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5334     "version": "0.0.0",
5335     "filename": "server/api/chatWebsite/index.js",
5336     "groupTitle": "Chat_Websites"
5337   },
5338   {
5339     "type": "get",
5340     "url": "/api/chat/websites/{id}/proactive_actions",
5341     "title": "Gets Website Proactive Actions",
5342     "examples": [
5343       {
5344         "title": "Example usage:",
5345         "content": "curl https://{domain}/api/chat/websites/{id}/proactive_actions -v -u {name}:{password} -X GET",
5346         "type": "json"
5347       }
5348     ],
5349     "name": "getProactiveActions",
5350     "group": "Chat_Websites",
5351     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5352     "version": "0.0.0",
5353     "filename": "server/api/chatWebsite/index.js",
5354     "groupTitle": "Chat_Websites"
5355   },
5356   {
5357     "type": "get",
5358     "url": "/api/chat/websites/{id}/snippet",
5359     "title": "Gets Website Snippet",
5360     "examples": [
5361       {
5362         "title": "Example usage:",
5363         "content": "curl https://{domain}/api/chat/websites/{id}/snippet -v -u {name}:{password} -X GET",
5364         "type": "json"
5365       }
5366     ],
5367     "name": "getSnippet",
5368     "group": "Chat_Websites",
5369     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5370     "version": "0.0.0",
5371     "filename": "server/api/chatWebsite/index.js",
5372     "groupTitle": "Chat_Websites"
5373   },
5374   {
5375     "type": "get",
5376     "url": "/api/chat/websites/{id}/system_avatar",
5377     "title": "Get System Avatar",
5378     "examples": [
5379       {
5380         "title": "Example usage:",
5381         "content": "curl https://{domain}/api/chat/websites/{id}/system_avatar -v -u {name}:{password} -X GET",
5382         "type": "json"
5383       }
5384     ],
5385     "name": "getSystemAvatar",
5386     "group": "Chat_Websites",
5387     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5388     "version": "0.0.0",
5389     "filename": "server/api/chatWebsite/index.js",
5390     "groupTitle": "Chat_Websites"
5391   },
5392   {
5393     "type": "post",
5394     "url": "/api/chat/websites/{id}/notify",
5395     "title": "Notify new message",
5396     "examples": [
5397       {
5398         "title": "Example usage:",
5399         "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",
5400         "type": "json"
5401       }
5402     ],
5403     "name": "notify",
5404     "group": "Chat_Websites",
5405     "description": "<p>Motion 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>",
5406     "version": "0.0.0",
5407     "filename": "server/api/chatWebsite/index.js",
5408     "groupTitle": "Chat_Websites"
5409   },
5410   {
5411     "type": "post",
5412     "url": "/api/chat/websites/{id}/offline",
5413     "title": "Offline message",
5414     "examples": [
5415       {
5416         "title": "Example usage:",
5417         "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",
5418         "type": "json"
5419       }
5420     ],
5421     "name": "offline",
5422     "group": "Chat_Websites",
5423     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5424     "version": "0.0.0",
5425     "filename": "server/api/chatWebsite/index.js",
5426     "groupTitle": "Chat_Websites"
5427   },
5428   {
5429     "type": "put",
5430     "url": "/api/chat/messages/{id}/reject",
5431     "title": "Rejects message",
5432     "examples": [
5433       {
5434         "title": "Example usage:",
5435         "content": "curl https://{domain}/api/chat/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
5436         "type": "json"
5437       }
5438     ],
5439     "name": "rejectMessage",
5440     "group": "Chat_Websites",
5441     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5442     "version": "0.0.0",
5443     "filename": "server/api/chatMessage/index.js",
5444     "groupTitle": "Chat_Websites"
5445   },
5446   {
5447     "type": "put",
5448     "url": "/api/chat/websites/{id}",
5449     "title": "Update an existing Website",
5450     "examples": [
5451       {
5452         "title": "Example usage:",
5453         "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",
5454         "type": "json"
5455       }
5456     ],
5457     "name": "updateWebsites",
5458     "group": "Chat_Websites",
5459     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5460     "version": "0.0.0",
5461     "filename": "server/api/chatWebsite/index.js",
5462     "groupTitle": "Chat_Websites"
5463   },
5464   {
5465     "type": "post",
5466     "url": "/api/cloudProviders",
5467     "title": "Creates a new CloudProvider",
5468     "examples": [
5469       {
5470         "title": "Example usage:",
5471         "content": "curl https://{domain}/api/cloudProviders -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
5472         "type": "json"
5473       }
5474     ],
5475     "name": "CreateCloudProviders",
5476     "group": "CloudProviders",
5477     "parameter": {
5478       "fields": {
5479         "Body": [
5480           {
5481             "group": "Body",
5482             "type": "String",
5483             "optional": false,
5484             "field": "name",
5485             "description": ""
5486           },
5487           {
5488             "group": "Body",
5489             "type": "String",
5490             "allowedValues": [
5491               "\"AmazonAWS\"",
5492               "\"Google\""
5493             ],
5494             "optional": false,
5495             "field": "service",
5496             "description": ""
5497           },
5498           {
5499             "group": "Body",
5500             "type": "String",
5501             "optional": true,
5502             "field": "data1",
5503             "description": ""
5504           },
5505           {
5506             "group": "Body",
5507             "type": "String",
5508             "optional": true,
5509             "field": "data2",
5510             "description": ""
5511           }
5512         ]
5513       }
5514     },
5515     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5516     "version": "0.0.0",
5517     "filename": "server/api/cloudProvider/index.js",
5518     "groupTitle": "CloudProviders"
5519   },
5520   {
5521     "type": "delete",
5522     "url": "/api/cloudProviders/{id}",
5523     "title": "Deletes a CloudProvider",
5524     "examples": [
5525       {
5526         "title": "Example usage:",
5527         "content": "curl https://{domain}/api/cloudProviders/{id} -v -u {name}:{password} -X DELETE",
5528         "type": "json"
5529       }
5530     ],
5531     "name": "DeleteCloudProviders",
5532     "group": "CloudProviders",
5533     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5534     "version": "0.0.0",
5535     "filename": "server/api/cloudProvider/index.js",
5536     "groupTitle": "CloudProviders"
5537   },
5538   {
5539     "type": "get",
5540     "url": "/api/cloudProviders",
5541     "title": "Gets a list of CloudProviders",
5542     "examples": [
5543       {
5544         "title": "Example usage:",
5545         "content": "curl https://{domain}/api/cloudProviders -v -u {name}:{password}",
5546         "type": "json"
5547       }
5548     ],
5549     "name": "GetCloudProviders",
5550     "group": "CloudProviders",
5551     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
5552     "version": "0.0.0",
5553     "filename": "server/api/cloudProvider/index.js",
5554     "groupTitle": "CloudProviders"
5555   },
5556   {
5557     "type": "get",
5558     "url": "/api/cloudProviders/oauth2/microsoft/authorize/{id}",
5559     "title": "Generates the Microsoft Identity platform authorization url",
5560     "examples": [
5561       {
5562         "title": "Example usage:",
5563         "content": "curl https://{domain}/api/cloudProviders/oauth2/microsoft/authorize/{id} -v -u {name}:{password}",
5564         "type": "json"
5565       }
5566     ],
5567     "name": "Oauth2MicrosoftAuthorize",
5568     "group": "CloudProviders",
5569     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5570     "version": "0.0.0",
5571     "filename": "server/api/cloudProvider/index.js",
5572     "groupTitle": "CloudProviders"
5573   },
5574   {
5575     "type": "post",
5576     "url": "/api/cloudProviders/oauth2/microsoft/callback",
5577     "title": "Receives an authorization code from Microsoft Identity platform",
5578     "name": "Oauth2MicrosoftCallback",
5579     "group": "CloudProviders",
5580     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5581     "version": "0.0.0",
5582     "filename": "server/api/cloudProvider/index.js",
5583     "groupTitle": "CloudProviders"
5584   },
5585   {
5586     "type": "get",
5587     "url": "/api/cloudProviders/{id}",
5588     "title": "Gets a single CloudProvider",
5589     "examples": [
5590       {
5591         "title": "Example usage:",
5592         "content": "curl https://{domain}/api/cloudProviders/{id} -v -u {name}:{password}",
5593         "type": "json"
5594       }
5595     ],
5596     "name": "ShowCloudProviders",
5597     "group": "CloudProviders",
5598     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5599     "version": "0.0.0",
5600     "filename": "server/api/cloudProvider/index.js",
5601     "groupTitle": "CloudProviders"
5602   },
5603   {
5604     "type": "put",
5605     "url": "/api/cloudProviders/{id}",
5606     "title": "Update an existing CloudProvider",
5607     "examples": [
5608       {
5609         "title": "Example usage:",
5610         "content": "curl https://{domain}/api/cloudProviders/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
5611         "type": "json"
5612       }
5613     ],
5614     "name": "updateCloudProviders",
5615     "group": "CloudProviders",
5616     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5617     "version": "0.0.0",
5618     "filename": "server/api/cloudProvider/index.js",
5619     "groupTitle": "CloudProviders"
5620   },
5621   {
5622     "type": "post",
5623     "url": "/api/cm/companies",
5624     "title": "Creates a new Company",
5625     "examples": [
5626       {
5627         "title": "Example usage:",
5628         "content": "curl https://{domain}/api/cm/companies -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
5629         "type": "json"
5630       }
5631     ],
5632     "name": "CreateCompanies",
5633     "group": "Cm_Companies",
5634     "parameter": {
5635       "fields": {
5636         "Body": [
5637           {
5638             "group": "Body",
5639             "type": "String",
5640             "optional": false,
5641             "field": "name",
5642             "description": ""
5643           },
5644           {
5645             "group": "Body",
5646             "type": "String",
5647             "optional": true,
5648             "field": "vat",
5649             "description": ""
5650           },
5651           {
5652             "group": "Body",
5653             "type": "String",
5654             "optional": true,
5655             "field": "companyId",
5656             "description": ""
5657           },
5658           {
5659             "group": "Body",
5660             "type": "String",
5661             "optional": true,
5662             "field": "website",
5663             "description": ""
5664           },
5665           {
5666             "group": "Body",
5667             "type": "String",
5668             "optional": true,
5669             "field": "phone",
5670             "description": ""
5671           },
5672           {
5673             "group": "Body",
5674             "type": "String",
5675             "optional": true,
5676             "field": "fax",
5677             "description": ""
5678           },
5679           {
5680             "group": "Body",
5681             "type": "String",
5682             "optional": true,
5683             "field": "type",
5684             "description": ""
5685           },
5686           {
5687             "group": "Body",
5688             "type": "String",
5689             "optional": true,
5690             "field": "street",
5691             "description": ""
5692           },
5693           {
5694             "group": "Body",
5695             "type": "String",
5696             "optional": true,
5697             "field": "postalCode",
5698             "description": ""
5699           },
5700           {
5701             "group": "Body",
5702             "type": "String",
5703             "optional": true,
5704             "field": "city",
5705             "description": ""
5706           },
5707           {
5708             "group": "Body",
5709             "type": "String",
5710             "optional": true,
5711             "field": "country",
5712             "description": ""
5713           },
5714           {
5715             "group": "Body",
5716             "type": "String",
5717             "optional": true,
5718             "field": "email",
5719             "description": ""
5720           },
5721           {
5722             "group": "Body",
5723             "type": "String",
5724             "optional": true,
5725             "field": "emailDomain",
5726             "description": ""
5727           },
5728           {
5729             "group": "Body",
5730             "type": "String",
5731             "optional": true,
5732             "field": "sStreet",
5733             "description": ""
5734           },
5735           {
5736             "group": "Body",
5737             "type": "String",
5738             "optional": true,
5739             "field": "sPostalCode",
5740             "description": ""
5741           },
5742           {
5743             "group": "Body",
5744             "type": "String",
5745             "optional": true,
5746             "field": "sCity",
5747             "description": ""
5748           },
5749           {
5750             "group": "Body",
5751             "type": "String",
5752             "optional": true,
5753             "field": "sCountry",
5754             "description": ""
5755           },
5756           {
5757             "group": "Body",
5758             "type": "String",
5759             "optional": true,
5760             "field": "description",
5761             "description": ""
5762           }
5763         ]
5764       }
5765     },
5766     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5767     "version": "0.0.0",
5768     "filename": "server/api/cmCompany/index.js",
5769     "groupTitle": "Cm_Companies"
5770   },
5771   {
5772     "type": "delete",
5773     "url": "/api/cm/companies/{id}",
5774     "title": "Deletes a Company",
5775     "examples": [
5776       {
5777         "title": "Example usage:",
5778         "content": "curl https://{domain}/api/cm/companies/{id} -v -u {name}:{password} -X DELETE",
5779         "type": "json"
5780       }
5781     ],
5782     "name": "DeleteCompanies",
5783     "group": "Cm_Companies",
5784     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5785     "version": "0.0.0",
5786     "filename": "server/api/cmCompany/index.js",
5787     "groupTitle": "Cm_Companies"
5788   },
5789   {
5790     "type": "get",
5791     "url": "/api/cm/companies/describe",
5792     "title": "Gets table info about Companies",
5793     "examples": [
5794       {
5795         "title": "Example usage:",
5796         "content": "curl https://{domain}/api/cm/companies/describe -v -u {name}:{password}",
5797         "type": "json"
5798       }
5799     ],
5800     "name": "DescribeCompanies",
5801     "group": "Cm_Companies",
5802     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5803     "version": "0.0.0",
5804     "filename": "server/api/cmCompany/index.js",
5805     "groupTitle": "Cm_Companies"
5806   },
5807   {
5808     "type": "get",
5809     "url": "/api/cm/companies",
5810     "title": "Gets a list of Companies",
5811     "examples": [
5812       {
5813         "title": "Example usage:",
5814         "content": "curl https://{domain}/api/cm/companies -v -u {name}:{password}",
5815         "type": "json"
5816       }
5817     ],
5818     "name": "GetCompanies",
5819     "group": "Cm_Companies",
5820     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
5821     "version": "0.0.0",
5822     "filename": "server/api/cmCompany/index.js",
5823     "groupTitle": "Cm_Companies"
5824   },
5825   {
5826     "type": "get",
5827     "url": "/api/cm/companies/{id}",
5828     "title": "Gets a single Company",
5829     "examples": [
5830       {
5831         "title": "Example usage:",
5832         "content": "curl https://{domain}/api/cm/companies/{id} -v -u {name}:{password}",
5833         "type": "json"
5834       }
5835     ],
5836     "name": "ShowCompanies",
5837     "group": "Cm_Companies",
5838     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5839     "version": "0.0.0",
5840     "filename": "server/api/cmCompany/index.js",
5841     "groupTitle": "Cm_Companies"
5842   },
5843   {
5844     "type": "post",
5845     "url": "/api/cm/companies/{id}/contacts",
5846     "title": "Creates new contacts",
5847     "examples": [
5848       {
5849         "title": "Example usage:",
5850         "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",
5851         "type": "json"
5852       }
5853     ],
5854     "name": "addContacts",
5855     "group": "Cm_Companies",
5856     "parameter": {
5857       "fields": {
5858         "Body": [
5859           {
5860             "group": "Body",
5861             "type": "String",
5862             "optional": false,
5863             "field": "firstName",
5864             "description": ""
5865           },
5866           {
5867             "group": "Body",
5868             "type": "String",
5869             "optional": true,
5870             "field": "lastName",
5871             "description": ""
5872           },
5873           {
5874             "group": "Body",
5875             "type": "String",
5876             "optional": true,
5877             "field": "street",
5878             "description": ""
5879           },
5880           {
5881             "group": "Body",
5882             "type": "String",
5883             "optional": true,
5884             "field": "postalCode",
5885             "description": ""
5886           },
5887           {
5888             "group": "Body",
5889             "type": "String",
5890             "optional": true,
5891             "field": "city",
5892             "description": ""
5893           },
5894           {
5895             "group": "Body",
5896             "type": "String",
5897             "optional": true,
5898             "field": "country",
5899             "description": ""
5900           },
5901           {
5902             "group": "Body",
5903             "type": "String",
5904             "optional": true,
5905             "field": "dateOfBirth",
5906             "description": ""
5907           },
5908           {
5909             "group": "Body",
5910             "type": "Text",
5911             "optional": true,
5912             "field": "description",
5913             "description": ""
5914           },
5915           {
5916             "group": "Body",
5917             "type": "String",
5918             "optional": true,
5919             "field": "phone",
5920             "description": ""
5921           },
5922           {
5923             "group": "Body",
5924             "type": "String",
5925             "optional": true,
5926             "field": "mobile",
5927             "description": ""
5928           },
5929           {
5930             "group": "Body",
5931             "type": "String",
5932             "optional": true,
5933             "field": "fax",
5934             "description": ""
5935           },
5936           {
5937             "group": "Body",
5938             "type": "String",
5939             "optional": true,
5940             "field": "email",
5941             "description": ""
5942           },
5943           {
5944             "group": "Body",
5945             "type": "String",
5946             "optional": true,
5947             "field": "url",
5948             "description": ""
5949           },
5950           {
5951             "group": "Body",
5952             "type": "String",
5953             "optional": true,
5954             "field": "facebook",
5955             "description": ""
5956           },
5957           {
5958             "group": "Body",
5959             "type": "String",
5960             "optional": true,
5961             "field": "fb_data",
5962             "description": ""
5963           },
5964           {
5965             "group": "Body",
5966             "type": "String",
5967             "optional": true,
5968             "field": "twitter",
5969             "description": ""
5970           },
5971           {
5972             "group": "Body",
5973             "type": "String",
5974             "optional": true,
5975             "field": "skype",
5976             "description": ""
5977           },
5978           {
5979             "group": "Body",
5980             "type": "String",
5981             "optional": true,
5982             "field": "teams",
5983             "description": ""
5984           },
5985           {
5986             "group": "Body",
5987             "type": "String",
5988             "optional": true,
5989             "field": "viber",
5990             "description": ""
5991           },
5992           {
5993             "group": "Body",
5994             "type": "String",
5995             "optional": true,
5996             "field": "line",
5997             "description": ""
5998           },
5999           {
6000             "group": "Body",
6001             "type": "String",
6002             "optional": true,
6003             "field": "wechat",
6004             "description": ""
6005           },
6006           {
6007             "group": "Body",
6008             "type": "String",
6009             "optional": true,
6010             "field": "telegram",
6011             "description": ""
6012           },
6013           {
6014             "group": "Body",
6015             "type": "Integer",
6016             "optional": true,
6017             "field": "UserId",
6018             "description": ""
6019           },
6020           {
6021             "group": "Body",
6022             "type": "Integer",
6023             "optional": true,
6024             "field": "priority",
6025             "description": ""
6026           },
6027           {
6028             "group": "Body",
6029             "type": "String",
6030             "optional": true,
6031             "field": "scheduledat",
6032             "description": ""
6033           }
6034         ]
6035       }
6036     },
6037     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6038     "version": "0.0.0",
6039     "filename": "server/api/cmCompany/index.js",
6040     "groupTitle": "Cm_Companies"
6041   },
6042   {
6043     "type": "get",
6044     "url": "/api/cm/companies/{id}/contacts",
6045     "title": "Gets List Contacts",
6046     "examples": [
6047       {
6048         "title": "Example usage:",
6049         "content": "curl https://{domain}/api/fax/companies/{id}/contacts -v -u {name}:{password} -X GET",
6050         "type": "json"
6051       }
6052     ],
6053     "name": "getContacts",
6054     "group": "Cm_Companies",
6055     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6056     "version": "0.0.0",
6057     "filename": "server/api/cmCompany/index.js",
6058     "groupTitle": "Cm_Companies"
6059   },
6060   {
6061     "type": "put",
6062     "url": "/api/cm/companies/{id}",
6063     "title": "Update an existing Company",
6064     "examples": [
6065       {
6066         "title": "Example usage:",
6067         "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",
6068         "type": "json"
6069       }
6070     ],
6071     "name": "updateCompanies",
6072     "group": "Cm_Companies",
6073     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6074     "version": "0.0.0",
6075     "filename": "server/api/cmCompany/index.js",
6076     "groupTitle": "Cm_Companies"
6077   },
6078   {
6079     "type": "delete",
6080     "url": "/api/cm/contacts/{id}",
6081     "title": "Deletes a Contact",
6082     "examples": [
6083       {
6084         "title": "Example usage:",
6085         "content": "curl https://{domain}/api/cm/contacts/{id} -v -u {name}:{password} -X DELETE",
6086         "type": "json"
6087       }
6088     ],
6089     "name": "DeleteContacts",
6090     "group": "Cm_Contacts",
6091     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6092     "version": "0.0.0",
6093     "filename": "server/api/cmContact/index.js",
6094     "groupTitle": "Cm_Contacts"
6095   },
6096   {
6097     "type": "get",
6098     "url": "/api/cm/contacts/describe",
6099     "title": "Gets table info about Contacts",
6100     "examples": [
6101       {
6102         "title": "Example usage:",
6103         "content": "curl https://{domain}/api/cm/contacts/describe -v -u {name}:{password}",
6104         "type": "json"
6105       }
6106     ],
6107     "name": "DescribeContacts",
6108     "group": "Cm_Contacts",
6109     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6110     "version": "0.0.0",
6111     "filename": "server/api/cmContact/index.js",
6112     "groupTitle": "Cm_Contacts"
6113   },
6114   {
6115     "type": "get",
6116     "url": "/api/cm/contacts",
6117     "title": "Gets a list of Contacts",
6118     "examples": [
6119       {
6120         "title": "Example usage:",
6121         "content": "curl https://{domain}/api/cm/contacts -v -u {name}:{password}",
6122         "type": "json"
6123       }
6124     ],
6125     "name": "GetContacts",
6126     "group": "Cm_Contacts",
6127     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
6128     "version": "0.0.0",
6129     "filename": "server/api/cmContact/index.js",
6130     "groupTitle": "Cm_Contacts"
6131   },
6132   {
6133     "type": "get",
6134     "url": "/api/cm/contacts/{id}/finals",
6135     "title": "Gets contact hopper finals",
6136     "examples": [
6137       {
6138         "title": "Example usage:",
6139         "content": "curl https://{domain}/api/cm/contacts/{id}/hopper_finals -v -u {name}:{password}  -X GET",
6140         "type": "json"
6141       }
6142     ],
6143     "name": "GetHopperFinals",
6144     "group": "Cm_Contacts",
6145     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6146     "version": "0.0.0",
6147     "filename": "server/api/cmContact/index.js",
6148     "groupTitle": "Cm_Contacts"
6149   },
6150   {
6151     "type": "get",
6152     "url": "/api/cm/contacts/{id}/hopper_histories",
6153     "title": "Gets contact hopper histories",
6154     "examples": [
6155       {
6156         "title": "Example usage:",
6157         "content": "curl https://{domain}/api/cm/contacts/{id}/hopper_histories -v -u {name}:{password} -X GET",
6158         "type": "json"
6159       }
6160     ],
6161     "name": "GetHopperHistories",
6162     "group": "Cm_Contacts",
6163     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6164     "version": "0.0.0",
6165     "filename": "server/api/cmContact/index.js",
6166     "groupTitle": "Cm_Contacts"
6167   },
6168   {
6169     "type": "get",
6170     "url": "/api/cm/contacts/{id}/hoppers",
6171     "title": "Gets contact hoppers",
6172     "examples": [
6173       {
6174         "title": "Example usage:",
6175         "content": "curl https://{domain}/api/cm/contacts/{id}/hoppers -v -u {name}:{password} -X GET",
6176         "type": "json"
6177       }
6178     ],
6179     "name": "GetHoppers",
6180     "group": "Cm_Contacts",
6181     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6182     "version": "0.0.0",
6183     "filename": "server/api/cmContact/index.js",
6184     "groupTitle": "Cm_Contacts"
6185   },
6186   {
6187     "type": "post",
6188     "url": "/api/cm/contacts/create_many",
6189     "title": "Create Contacts",
6190     "examples": [
6191       {
6192         "title": "Example usage:",
6193         "content": "curl https://{domain}/api/cm/contacts/create_many -d '[{\"firstName\": \"John\", \"lastName\": \"doe\", \"...\": \"...\"}]' -v -u {name}:{password} -X POST",
6194         "type": "json"
6195       }
6196     ],
6197     "name": "bulkCreate",
6198     "group": "Cm_Contacts",
6199     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6200     "version": "0.0.0",
6201     "filename": "server/api/cmContact/index.js",
6202     "groupTitle": "Cm_Contacts"
6203   },
6204   {
6205     "type": "post",
6206     "url": "/api/cm/contacts",
6207     "title": "Create Contact",
6208     "examples": [
6209       {
6210         "title": "Example usage:",
6211         "content": "curl https://{domain}/api/cm/contacts -d '{\"firstName\": \"John\", \"lastName\": \"doe\", \"...\": \"...\"}' -v -u {name}:{password} -X POST",
6212         "type": "json"
6213       }
6214     ],
6215     "name": "create",
6216     "group": "Cm_Contacts",
6217     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6218     "version": "0.0.0",
6219     "filename": "server/api/cmContact/index.js",
6220     "groupTitle": "Cm_Contacts"
6221   },
6222   {
6223     "type": "get",
6224     "url": "/api/cm/contacts/{id}/journey",
6225     "title": "Gets customer journey",
6226     "examples": [
6227       {
6228         "title": "Example usage:",
6229         "content": "curl https://{domain}/api/cm/contacts/{id}/journey -v -u {name}:{password}  -X GET",
6230         "type": "json"
6231       }
6232     ],
6233     "name": "getJourney",
6234     "group": "Cm_Contacts",
6235     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6236     "version": "0.0.0",
6237     "filename": "server/api/cmContact/index.js",
6238     "groupTitle": "Cm_Contacts"
6239   },
6240   {
6241     "type": "get",
6242     "url": "/api/cm/contacts/{id}/jscripty_sessions",
6243     "title": "Gets contact hopper blacks",
6244     "examples": [
6245       {
6246         "title": "Example usage:",
6247         "content": "curl https://{domain}/api/cm/contacts/{id}/hopper_black -v -u {name}:{password}  -X GET",
6248         "type": "json"
6249       }
6250     ],
6251     "name": "getJscriptySessions",
6252     "group": "Cm_Contacts",
6253     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6254     "version": "0.0.0",
6255     "filename": "server/api/cmContact/index.js",
6256     "groupTitle": "Cm_Contacts"
6257   },
6258   {
6259     "type": "get",
6260     "url": "/api/cm/contacts/{id}/tags",
6261     "title": "Gets configurations tags",
6262     "examples": [
6263       {
6264         "title": "Example usage:",
6265         "content": "curl https://{domain}/api/cm/contacts/{id}/tags -v -u {name}:{password} -X GET",
6266         "type": "json"
6267       }
6268     ],
6269     "name": "getTags",
6270     "group": "Cm_Contacts",
6271     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6272     "version": "0.0.0",
6273     "filename": "server/api/cmContact/index.js",
6274     "groupTitle": "Cm_Contacts"
6275   },
6276   {
6277     "type": "post",
6278     "url": "/api/cm/contacts/merge",
6279     "title": "Merge Contact",
6280     "examples": [
6281       {
6282         "title": "Example usage:",
6283         "content": "curl https://{domain}/api/cm/contacts/merge -d '{\"from\": 1, \"to\": 2}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
6284         "type": "json"
6285       }
6286     ],
6287     "name": "merge",
6288     "group": "Cm_Contacts",
6289     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6290     "version": "0.0.0",
6291     "filename": "server/api/cmContact/index.js",
6292     "groupTitle": "Cm_Contacts"
6293   },
6294   {
6295     "type": "post",
6296     "url": "/api/cm/contacts/{id}/tags",
6297     "title": "Sets new tags",
6298     "examples": [
6299       {
6300         "title": "Example usage:",
6301         "content": "curl https://{domain}/api/cm/contacts/{id}/tags -d '{\"ids\": [1,12]}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
6302         "type": "json"
6303       }
6304     ],
6305     "name": "setTags",
6306     "group": "Cm_Contacts",
6307     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6308     "version": "0.0.0",
6309     "filename": "server/api/cmContact/index.js",
6310     "groupTitle": "Cm_Contacts"
6311   },
6312   {
6313     "type": "get",
6314     "url": "/api/cm/contacts/{id}",
6315     "title": "Gets a single Contact",
6316     "examples": [
6317       {
6318         "title": "Example usage:",
6319         "content": "curl https://{domain}/api/cm/contacts/{id} -v -u {name}:{password} -X GET",
6320         "type": "json"
6321       }
6322     ],
6323     "name": "show",
6324     "group": "Cm_Contacts",
6325     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6326     "version": "0.0.0",
6327     "filename": "server/api/cmContact/index.js",
6328     "groupTitle": "Cm_Contacts"
6329   },
6330   {
6331     "type": "put",
6332     "url": "/api/cm/contacts/{id}",
6333     "title": "Update a single Contact",
6334     "examples": [
6335       {
6336         "title": "Example usage:",
6337         "content": "curl https://{domain}/api/cm/contacts/{id} -d '{\"firstName\": \"John\", \"lastName\": \"Doe\"}' -v -u {name}:{password} -X PUT",
6338         "type": "json"
6339       }
6340     ],
6341     "name": "update",
6342     "group": "Cm_Contacts",
6343     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6344     "version": "0.0.0",
6345     "filename": "server/api/cmContact/index.js",
6346     "groupTitle": "Cm_Contacts"
6347   },
6348   {
6349     "type": "delete",
6350     "url": "/api/cm/custom_fields/{id}",
6351     "title": "Deletes a Custom Field",
6352     "examples": [
6353       {
6354         "title": "Example usage:",
6355         "content": "curl https://{domain}/api/cm/custom_fields/{id} -v -u {name}:{password} -X DELETE",
6356         "type": "json"
6357       }
6358     ],
6359     "name": "DeleteCustom_Fields",
6360     "group": "Cm_Custom_Fields",
6361     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6362     "version": "0.0.0",
6363     "filename": "server/api/cmCustomField/index.js",
6364     "groupTitle": "Cm_Custom_Fields"
6365   },
6366   {
6367     "type": "get",
6368     "url": "/api/cm/custom_fields",
6369     "title": "Gets a list of Custom Fields",
6370     "examples": [
6371       {
6372         "title": "Example usage:",
6373         "content": "curl https://{domain}/api/cm/custom_fields -v -u {name}:{password}",
6374         "type": "json"
6375       }
6376     ],
6377     "name": "GetCustom_Fields",
6378     "group": "Cm_Custom_Fields",
6379     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
6380     "version": "0.0.0",
6381     "filename": "server/api/cmCustomField/index.js",
6382     "groupTitle": "Cm_Custom_Fields"
6383   },
6384   {
6385     "type": "get",
6386     "url": "/api/cm/custom_fields/{id}",
6387     "title": "Gets a single Custom Field",
6388     "examples": [
6389       {
6390         "title": "Example usage:",
6391         "content": "curl https://{domain}/api/cm/custom_fields/{id} -v -u {name}:{password}",
6392         "type": "json"
6393       }
6394     ],
6395     "name": "ShowCustom_Fields",
6396     "group": "Cm_Custom_Fields",
6397     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6398     "version": "0.0.0",
6399     "filename": "server/api/cmCustomField/index.js",
6400     "groupTitle": "Cm_Custom_Fields"
6401   },
6402   {
6403     "type": "put",
6404     "url": "/api/cm/custom_fields/{id}",
6405     "title": "Update an existing Custom Field",
6406     "examples": [
6407       {
6408         "title": "Example usage:",
6409         "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",
6410         "type": "json"
6411       }
6412     ],
6413     "name": "updateCustom_Fields",
6414     "group": "Cm_Custom_Fields",
6415     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6416     "version": "0.0.0",
6417     "filename": "server/api/cmCustomField/index.js",
6418     "groupTitle": "Cm_Custom_Fields"
6419   },
6420   {
6421     "type": "post",
6422     "url": "/api/cm/hopper",
6423     "title": "Creates a new Hopper",
6424     "examples": [
6425       {
6426         "title": "Example usage:",
6427         "content": "curl https://{domain}/api/cm/hopper -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
6428         "type": "json"
6429       }
6430     ],
6431     "name": "CreateHopper",
6432     "group": "Cm_Hopper",
6433     "parameter": {
6434       "fields": {
6435         "Body": [
6436           {
6437             "group": "Body",
6438             "type": "String",
6439             "optional": false,
6440             "field": "phone",
6441             "description": ""
6442           },
6443           {
6444             "group": "Body",
6445             "type": "Boolean",
6446             "optional": true,
6447             "field": "active",
6448             "description": ""
6449           },
6450           {
6451             "group": "Body",
6452             "type": "String",
6453             "optional": true,
6454             "field": "scheduledat",
6455             "description": ""
6456           },
6457           {
6458             "group": "Body",
6459             "type": "Integer",
6460             "optional": true,
6461             "field": "countbusyretry",
6462             "description": ""
6463           },
6464           {
6465             "group": "Body",
6466             "type": "Integer",
6467             "optional": true,
6468             "field": "countcongestionretry",
6469             "description": ""
6470           },
6471           {
6472             "group": "Body",
6473             "type": "Integer",
6474             "optional": true,
6475             "field": "countnoanswerretry",
6476             "description": ""
6477           },
6478           {
6479             "group": "Body",
6480             "type": "Boolean",
6481             "optional": true,
6482             "field": "callback",
6483             "description": ""
6484           },
6485           {
6486             "group": "Body",
6487             "type": "String",
6488             "optional": true,
6489             "field": "callbackuniqueid",
6490             "description": ""
6491           },
6492           {
6493             "group": "Body",
6494             "type": "String",
6495             "optional": true,
6496             "field": "callbackat",
6497             "description": ""
6498           },
6499           {
6500             "group": "Body",
6501             "type": "Integer",
6502             "optional": true,
6503             "field": "priority",
6504             "description": ""
6505           },
6506           {
6507             "group": "Body",
6508             "type": "Boolean",
6509             "optional": true,
6510             "field": "recallme",
6511             "description": ""
6512           },
6513           {
6514             "group": "Body",
6515             "type": "Integer",
6516             "optional": true,
6517             "field": "ContactId",
6518             "description": ""
6519           },
6520           {
6521             "group": "Body",
6522             "type": "Integer",
6523             "optional": true,
6524             "field": "ListId",
6525             "description": ""
6526           },
6527           {
6528             "group": "Body",
6529             "type": "Integer",
6530             "optional": true,
6531             "field": "UserId",
6532             "description": ""
6533           },
6534           {
6535             "group": "Body",
6536             "type": "Integer",
6537             "optional": true,
6538             "field": "VoiceQueueId",
6539             "description": ""
6540           },
6541           {
6542             "group": "Body",
6543             "type": "Integer",
6544             "optional": true,
6545             "field": "CampaignId",
6546             "description": ""
6547           },
6548           {
6549             "group": "Body",
6550             "type": "Integer",
6551             "optional": true,
6552             "field": "countnosuchnumberretry",
6553             "description": ""
6554           },
6555           {
6556             "group": "Body",
6557             "type": "Integer",
6558             "optional": true,
6559             "field": "countdropretry",
6560             "description": ""
6561           },
6562           {
6563             "group": "Body",
6564             "type": "Integer",
6565             "optional": true,
6566             "field": "countabandonedretry",
6567             "description": ""
6568           },
6569           {
6570             "group": "Body",
6571             "type": "Integer",
6572             "optional": true,
6573             "field": "countmachineretry",
6574             "description": ""
6575           },
6576           {
6577             "group": "Body",
6578             "type": "Integer",
6579             "optional": true,
6580             "field": "countagentrejectretry",
6581             "description": ""
6582           },
6583           {
6584             "group": "Body",
6585             "type": "String",
6586             "optional": true,
6587             "field": "dialTimezone",
6588             "description": ""
6589           }
6590         ]
6591       }
6592     },
6593     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6594     "version": "0.0.0",
6595     "filename": "server/api/cmHopper/index.js",
6596     "groupTitle": "Cm_Hopper"
6597   },
6598   {
6599     "type": "get",
6600     "url": "/api/cm/hopper/describe",
6601     "title": "Gets table info about Hopper",
6602     "examples": [
6603       {
6604         "title": "Example usage:",
6605         "content": "curl https://{domain}/api/cm/hopper/describe -v -u {name}:{password}",
6606         "type": "json"
6607       }
6608     ],
6609     "name": "DescribeHopper",
6610     "group": "Cm_Hopper",
6611     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6612     "version": "0.0.0",
6613     "filename": "server/api/cmHopper/index.js",
6614     "groupTitle": "Cm_Hopper"
6615   },
6616   {
6617     "type": "get",
6618     "url": "/api/cm/hopper",
6619     "title": "Gets a list of Hopper",
6620     "examples": [
6621       {
6622         "title": "Example usage:",
6623         "content": "curl https://{domain}/api/cm/hopper -v -u {name}:{password}",
6624         "type": "json"
6625       }
6626     ],
6627     "name": "GetHopper",
6628     "group": "Cm_Hopper",
6629     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
6630     "version": "0.0.0",
6631     "filename": "server/api/cmHopper/index.js",
6632     "groupTitle": "Cm_Hopper"
6633   },
6634   {
6635     "type": "get",
6636     "url": "/api/cm/hopper/{id}",
6637     "title": "Gets a single Hopper",
6638     "examples": [
6639       {
6640         "title": "Example usage:",
6641         "content": "curl https://{domain}/api/cm/hopper/{id} -v -u {name}:{password}",
6642         "type": "json"
6643       }
6644     ],
6645     "name": "ShowHopper",
6646     "group": "Cm_Hopper",
6647     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6648     "version": "0.0.0",
6649     "filename": "server/api/cmHopper/index.js",
6650     "groupTitle": "Cm_Hopper"
6651   },
6652   {
6653     "type": "delete",
6654     "url": "/api/cm/hopper_black/{id}",
6655     "title": "Deletes a Hopper Black",
6656     "examples": [
6657       {
6658         "title": "Example usage:",
6659         "content": "curl https://{domain}/api/cm/hopper_black/{id} -v -u {name}:{password} -X DELETE",
6660         "type": "json"
6661       }
6662     ],
6663     "name": "DeleteHopper_Black",
6664     "group": "Cm_Hopper_Black",
6665     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6666     "version": "0.0.0",
6667     "filename": "server/api/cmHopperBlack/index.js",
6668     "groupTitle": "Cm_Hopper_Black"
6669   },
6670   {
6671     "type": "get",
6672     "url": "/api/cm/hopper_black/describe",
6673     "title": "Gets table info about Hopper Black",
6674     "examples": [
6675       {
6676         "title": "Example usage:",
6677         "content": "curl https://{domain}/api/cm/hopper_black/describe -v -u {name}:{password}",
6678         "type": "json"
6679       }
6680     ],
6681     "name": "DescribeHopper_Black",
6682     "group": "Cm_Hopper_Black",
6683     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6684     "version": "0.0.0",
6685     "filename": "server/api/cmHopperBlack/index.js",
6686     "groupTitle": "Cm_Hopper_Black"
6687   },
6688   {
6689     "type": "get",
6690     "url": "/api/cm/hopper_black",
6691     "title": "Gets a list of Hopper Black",
6692     "examples": [
6693       {
6694         "title": "Example usage:",
6695         "content": "curl https://{domain}/api/cm/hopper_black -v -u {name}:{password}",
6696         "type": "json"
6697       }
6698     ],
6699     "name": "GetHopper_Black",
6700     "group": "Cm_Hopper_Black",
6701     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
6702     "version": "0.0.0",
6703     "filename": "server/api/cmHopperBlack/index.js",
6704     "groupTitle": "Cm_Hopper_Black"
6705   },
6706   {
6707     "type": "get",
6708     "url": "/api/cm/hopper_black/{id}",
6709     "title": "Gets a single Hopper Black",
6710     "examples": [
6711       {
6712         "title": "Example usage:",
6713         "content": "curl https://{domain}/api/cm/hopper_black/{id} -v -u {name}:{password}",
6714         "type": "json"
6715       }
6716     ],
6717     "name": "ShowHopper_Black",
6718     "group": "Cm_Hopper_Black",
6719     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6720     "version": "0.0.0",
6721     "filename": "server/api/cmHopperBlack/index.js",
6722     "groupTitle": "Cm_Hopper_Black"
6723   },
6724   {
6725     "type": "put",
6726     "url": "/api/cm/hopper_black/{id}",
6727     "title": "Update an existing Hopper Black",
6728     "examples": [
6729       {
6730         "title": "Example usage:",
6731         "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",
6732         "type": "json"
6733       }
6734     ],
6735     "name": "updateHopper_Black",
6736     "group": "Cm_Hopper_Black",
6737     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6738     "version": "0.0.0",
6739     "filename": "server/api/cmHopperBlack/index.js",
6740     "groupTitle": "Cm_Hopper_Black"
6741   },
6742   {
6743     "type": "post",
6744     "url": "/api/cm/hopper_final/checkContactHopper",
6745     "title": "Check if contact is in hopper",
6746     "examples": [
6747       {
6748         "title": "Example usage:",
6749         "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",
6750         "type": "json"
6751       }
6752     ],
6753     "name": "/checkContactHopper",
6754     "group": "Cm_Hopper_Final",
6755     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6756     "version": "0.0.0",
6757     "filename": "server/api/cmHopperFinal/index.js",
6758     "groupTitle": "Cm_Hopper_Final"
6759   },
6760   {
6761     "type": "get",
6762     "url": "/api/cm/hopper_final/describe",
6763     "title": "Gets table info about HopperFinal",
6764     "examples": [
6765       {
6766         "title": "Example usage:",
6767         "content": "curl https://{domain}/api/cm/hopper_final/describe -v -u {name}:{password}",
6768         "type": "json"
6769       }
6770     ],
6771     "name": "DescribeHopperFinal",
6772     "group": "Cm_Hopper_Final",
6773     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6774     "version": "0.0.0",
6775     "filename": "server/api/cmHopperFinal/index.js",
6776     "groupTitle": "Cm_Hopper_Final"
6777   },
6778   {
6779     "type": "get",
6780     "url": "/api/cm/hopper_final",
6781     "title": "Gets a list of HopperFinal",
6782     "examples": [
6783       {
6784         "title": "Example usage:",
6785         "content": "curl https://{domain}/api/cm/hopper_final -v -u {name}:{password}",
6786         "type": "json"
6787       }
6788     ],
6789     "name": "GetHopperFinal",
6790     "group": "Cm_Hopper_Final",
6791     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
6792     "version": "0.0.0",
6793     "filename": "server/api/cmHopperFinal/index.js",
6794     "groupTitle": "Cm_Hopper_Final"
6795   },
6796   {
6797     "type": "get",
6798     "url": "/api/cm/hopper_final/{id}",
6799     "title": "Gets a single HopperFinal",
6800     "examples": [
6801       {
6802         "title": "Example usage:",
6803         "content": "curl https://{domain}/api/cm/hopper_final/{id} -v -u {name}:{password}",
6804         "type": "json"
6805       }
6806     ],
6807     "name": "ShowHopperFinal",
6808     "group": "Cm_Hopper_Final",
6809     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6810     "version": "0.0.0",
6811     "filename": "server/api/cmHopperFinal/index.js",
6812     "groupTitle": "Cm_Hopper_Final"
6813   },
6814   {
6815     "type": "get",
6816     "url": "/api/cm/hopper_final/campaign/countAttributes/{id}",
6817     "title": "Return number contacts for attributes",
6818     "examples": [
6819       {
6820         "title": "Example usage:",
6821         "content": "curl https://{domain}/api/hopper_final/campaign/countAttributes/{id} -d '{\"disposition\": \"OK\"}' -v -u {name}:{password} -X GET",
6822         "type": "json"
6823       }
6824     ],
6825     "name": "countContactsIvrCampaignHopperFinal",
6826     "group": "Cm_Hopper_Final",
6827     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6828     "version": "0.0.0",
6829     "filename": "server/api/cmHopperFinal/index.js",
6830     "groupTitle": "Cm_Hopper_Final"
6831   },
6832   {
6833     "type": "get",
6834     "url": "/api/cm/hopper_final/voice/queue/countAttributes/{id}",
6835     "title": "Return number contacts for attributes",
6836     "examples": [
6837       {
6838         "title": "Example usage:",
6839         "content": "curl https://{domain}/api/hopper_final/voice/queue/countAttributes/{id} -d '{\"disposition\": \"OK\"}' -v -u {name}:{password} -X GET",
6840         "type": "json"
6841       }
6842     ],
6843     "name": "countContactsQueueCampaignHopperFinal",
6844     "group": "Cm_Hopper_Final",
6845     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6846     "version": "0.0.0",
6847     "filename": "server/api/cmHopperFinal/index.js",
6848     "groupTitle": "Cm_Hopper_Final"
6849   },
6850   {
6851     "type": "post",
6852     "url": "/api/cm/hopper_final/campaign/{id}",
6853     "title": "Move contacts in hopper",
6854     "examples": [
6855       {
6856         "title": "Example usage:",
6857         "content": "curl https://{domain}/api/hopper_final/campaign/moveContacts/{id} -d '{\"state\": \"state\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
6858         "type": "json"
6859       }
6860     ],
6861     "name": "moveContactsIvrCampaignHopperFinal",
6862     "group": "Cm_Hopper_Final",
6863     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6864     "version": "0.0.0",
6865     "filename": "server/api/cmHopperFinal/index.js",
6866     "groupTitle": "Cm_Hopper_Final"
6867   },
6868   {
6869     "type": "post",
6870     "url": "/api/cm/hopper_final/voice/queue/{id}",
6871     "title": "Move contacts in hopper",
6872     "examples": [
6873       {
6874         "title": "Example usage:",
6875         "content": "curl https://{domain}/api/hopper_final/voice/queue/moveContacts/{id} -d '{\"state\": \"state\"}' -H 'Content-Type: application/json' -v -u {name}:{password}",
6876         "type": "json"
6877       }
6878     ],
6879     "name": "moveContactsQueueCampaignHopperFinal",
6880     "group": "Cm_Hopper_Final",
6881     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6882     "version": "0.0.0",
6883     "filename": "server/api/cmHopperFinal/index.js",
6884     "groupTitle": "Cm_Hopper_Final"
6885   },
6886   {
6887     "type": "put",
6888     "url": "/api/cm/hopper_final/{id}",
6889     "title": "Update a single hopper final",
6890     "examples": [
6891       {
6892         "title": "Example usage:",
6893         "content": "curl https://{domain}/api/hopper_final/{id} -d '{\"disposition\": \"OK\"}' -v -u {name}:{password} -X PUT",
6894         "type": "json"
6895       }
6896     ],
6897     "name": "update",
6898     "group": "Cm_Hopper_Final",
6899     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6900     "version": "0.0.0",
6901     "filename": "server/api/cmHopperFinal/index.js",
6902     "groupTitle": "Cm_Hopper_Final"
6903   },
6904   {
6905     "type": "post",
6906     "url": "/api/cm/hopper_history",
6907     "title": "Creates a new HopperHistory",
6908     "examples": [
6909       {
6910         "title": "Example usage:",
6911         "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",
6912         "type": "json"
6913       }
6914     ],
6915     "name": "CreateHopperHistory",
6916     "group": "Cm_Hopper_History",
6917     "parameter": {
6918       "fields": {
6919         "Body": [
6920           {
6921             "group": "Body",
6922             "type": "Integer",
6923             "optional": true,
6924             "field": "state",
6925             "description": ""
6926           },
6927           {
6928             "group": "Body",
6929             "type": "String",
6930             "optional": true,
6931             "field": "statedesc",
6932             "description": ""
6933           },
6934           {
6935             "group": "Body",
6936             "type": "String",
6937             "optional": true,
6938             "field": "scheduledat",
6939             "description": ""
6940           },
6941           {
6942             "group": "Body",
6943             "type": "Integer",
6944             "optional": true,
6945             "field": "countbusyretry",
6946             "description": ""
6947           },
6948           {
6949             "group": "Body",
6950             "type": "Integer",
6951             "optional": true,
6952             "field": "countcongestionretry",
6953             "description": ""
6954           },
6955           {
6956             "group": "Body",
6957             "type": "Integer",
6958             "optional": true,
6959             "field": "countnoanswerretry",
6960             "description": ""
6961           },
6962           {
6963             "group": "Body",
6964             "type": "Integer",
6965             "optional": true,
6966             "field": "countglobal",
6967             "description": ""
6968           },
6969           {
6970             "group": "Body",
6971             "type": "String",
6972             "optional": true,
6973             "field": "uniqueid",
6974             "description": ""
6975           },
6976           {
6977             "group": "Body",
6978             "type": "String",
6979             "optional": true,
6980             "field": "originatecalleridnum",
6981             "description": ""
6982           },
6983           {
6984             "group": "Body",
6985             "type": "String",
6986             "optional": true,
6987             "field": "originatecalleridname",
6988             "description": ""
6989           },
6990           {
6991             "group": "Body",
6992             "type": "String",
6993             "optional": true,
6994             "field": "calleridnum",
6995             "description": ""
6996           },
6997           {
6998             "group": "Body",
6999             "type": "String",
7000             "optional": true,
7001             "field": "calleridname",
7002             "description": ""
7003           },
7004           {
7005             "group": "Body",
7006             "type": "String",
7007             "optional": true,
7008             "field": "starttime",
7009             "description": ""
7010           },
7011           {
7012             "group": "Body",
7013             "type": "String",
7014             "optional": true,
7015             "field": "responsetime",
7016             "description": ""
7017           },
7018           {
7019             "group": "Body",
7020             "type": "String",
7021             "optional": true,
7022             "field": "answertime",
7023             "description": ""
7024           },
7025           {
7026             "group": "Body",
7027             "type": "String",
7028             "optional": true,
7029             "field": "droptime",
7030             "description": ""
7031           },
7032           {
7033             "group": "Body",
7034             "type": "String",
7035             "optional": true,
7036             "field": "endtime",
7037             "description": ""
7038           },
7039           {
7040             "group": "Body",
7041             "type": "Integer",
7042             "optional": true,
7043             "field": "ringtime",
7044             "description": ""
7045           },
7046           {
7047             "group": "Body",
7048             "type": "Integer",
7049             "optional": true,
7050             "field": "holdtime",
7051             "description": ""
7052           },
7053           {
7054             "group": "Body",
7055             "type": "Integer",
7056             "optional": true,
7057             "field": "talktime",
7058             "description": ""
7059           },
7060           {
7061             "group": "Body",
7062             "type": "Integer",
7063             "optional": true,
7064             "field": "followuptime",
7065             "description": ""
7066           },
7067           {
7068             "group": "Body",
7069             "type": "String",
7070             "optional": true,
7071             "field": "dropreason",
7072             "description": ""
7073           },
7074           {
7075             "group": "Body",
7076             "type": "String",
7077             "optional": true,
7078             "field": "campaign",
7079             "description": ""
7080           },
7081           {
7082             "group": "Body",
7083             "type": "String",
7084             "optional": true,
7085             "field": "campaigntype",
7086             "description": ""
7087           },
7088           {
7089             "group": "Body",
7090             "type": "String",
7091             "optional": true,
7092             "field": "membername",
7093             "description": ""
7094           },
7095           {
7096             "group": "Body",
7097             "type": "String",
7098             "optional": true,
7099             "field": "reason",
7100             "description": ""
7101           },
7102           {
7103             "group": "Body",
7104             "type": "Boolean",
7105             "optional": true,
7106             "field": "amd",
7107             "description": ""
7108           },
7109           {
7110             "group": "Body",
7111             "type": "Boolean",
7112             "optional": true,
7113             "field": "fax",
7114             "description": ""
7115           },
7116           {
7117             "group": "Body",
7118             "type": "Boolean",
7119             "optional": true,
7120             "field": "callback",
7121             "description": ""
7122           },
7123           {
7124             "group": "Body",
7125             "type": "String",
7126             "optional": true,
7127             "field": "callbackuniqueid",
7128             "description": ""
7129           },
7130           {
7131             "group": "Body",
7132             "type": "String",
7133             "optional": true,
7134             "field": "callbackat",
7135             "description": ""
7136           },
7137           {
7138             "group": "Body",
7139             "type": "Boolean",
7140             "optional": true,
7141             "field": "recallme",
7142             "description": ""
7143           },
7144           {
7145             "group": "Body",
7146             "type": "String",
7147             "optional": true,
7148             "field": "editedat",
7149             "description": ""
7150           },
7151           {
7152             "group": "Body",
7153             "type": "Boolean",
7154             "optional": true,
7155             "field": "edited",
7156             "description": ""
7157           },
7158           {
7159             "group": "Body",
7160             "type": "Integer",
7161             "optional": true,
7162             "field": "countnosuchnumberretry",
7163             "description": ""
7164           },
7165           {
7166             "group": "Body",
7167             "type": "Integer",
7168             "optional": true,
7169             "field": "countdropretry",
7170             "description": ""
7171           },
7172           {
7173             "group": "Body",
7174             "type": "Integer",
7175             "optional": true,
7176             "field": "countabandonedretry",
7177             "description": ""
7178           },
7179           {
7180             "group": "Body",
7181             "type": "Integer",
7182             "optional": true,
7183             "field": "countmachineretry",
7184             "description": ""
7185           },
7186           {
7187             "group": "Body",
7188             "type": "Integer",
7189             "optional": true,
7190             "field": "countagentrejectretry",
7191             "description": ""
7192           }
7193         ]
7194       }
7195     },
7196     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7197     "version": "0.0.0",
7198     "filename": "server/api/cmHopperHistory/index.js",
7199     "groupTitle": "Cm_Hopper_History"
7200   },
7201   {
7202     "type": "get",
7203     "url": "/api/cm/hopper_history/describe",
7204     "title": "Gets table info about HopperHistory",
7205     "examples": [
7206       {
7207         "title": "Example usage:",
7208         "content": "curl https://{domain}/api/cm/hopper_history/describe -v -u {name}:{password}",
7209         "type": "json"
7210       }
7211     ],
7212     "name": "DescribeHopperHistory",
7213     "group": "Cm_Hopper_History",
7214     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7215     "version": "0.0.0",
7216     "filename": "server/api/cmHopperHistory/index.js",
7217     "groupTitle": "Cm_Hopper_History"
7218   },
7219   {
7220     "type": "get",
7221     "url": "/api/cm/hopper_history",
7222     "title": "Gets a list of HopperHistory",
7223     "examples": [
7224       {
7225         "title": "Example usage:",
7226         "content": "curl https://{domain}/api/cm/hopper_history -v -u {name}:{password}",
7227         "type": "json"
7228       }
7229     ],
7230     "name": "GetHopperHistory",
7231     "group": "Cm_Hopper_History",
7232     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
7233     "version": "0.0.0",
7234     "filename": "server/api/cmHopperHistory/index.js",
7235     "groupTitle": "Cm_Hopper_History"
7236   },
7237   {
7238     "type": "get",
7239     "url": "/api/cm/hopper_history/{id}",
7240     "title": "Gets a single HopperHistory",
7241     "examples": [
7242       {
7243         "title": "Example usage:",
7244         "content": "curl https://{domain}/api/cm/hopper_history/{id} -v -u {name}:{password}",
7245         "type": "json"
7246       }
7247     ],
7248     "name": "ShowHopperHistory",
7249     "group": "Cm_Hopper_History",
7250     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7251     "version": "0.0.0",
7252     "filename": "server/api/cmHopperHistory/index.js",
7253     "groupTitle": "Cm_Hopper_History"
7254   },
7255   {
7256     "type": "put",
7257     "url": "/api/cm/hopper_history/{id}",
7258     "title": "Update a single hopper history",
7259     "examples": [
7260       {
7261         "title": "Example usage:",
7262         "content": "curl https://{domain}/api/hopper_history/{id} -d '{\"disposition\": \"OK\"}' -v -u {name}:{password} -X PUT",
7263         "type": "json"
7264       }
7265     ],
7266     "name": "update",
7267     "group": "Cm_Hopper_History",
7268     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7269     "version": "0.0.0",
7270     "filename": "server/api/cmHopperHistory/index.js",
7271     "groupTitle": "Cm_Hopper_History"
7272   },
7273   {
7274     "type": "delete",
7275     "url": "/api/cm/hopper/{id}",
7276     "title": "Delete Hopper",
7277     "examples": [
7278       {
7279         "title": "Example usage:",
7280         "content": "curl https://{domain}/api/cm/hopper/{id} -v -u {name}:{password} -X DELETE",
7281         "type": "json"
7282       }
7283     ],
7284     "name": "destroy",
7285     "group": "Cm_Hopper",
7286     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7287     "version": "0.0.0",
7288     "filename": "server/api/cmHopper/index.js",
7289     "groupTitle": "Cm_Hopper"
7290   },
7291   {
7292     "type": "get",
7293     "url": "/api/cm/hopper/opencontacts",
7294     "title": "Gets Open Contacts",
7295     "examples": [
7296       {
7297         "title": "Example usage:",
7298         "content": "curl https://{domain}/api/cm/hopper/opencontacts -v -u {name}:{password} -X GET",
7299         "type": "json"
7300       }
7301     ],
7302     "name": "getOpenContacts",
7303     "group": "Cm_Hopper",
7304     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7305     "version": "0.0.0",
7306     "filename": "server/api/cmHopper/index.js",
7307     "groupTitle": "Cm_Hopper"
7308   },
7309   {
7310     "type": "post",
7311     "url": "/api/cm/hopper/preview",
7312     "title": "Gets Preview Dialer Contacts",
7313     "examples": [
7314       {
7315         "title": "Example usage:",
7316         "content": "curl https://{domain}/api/cm/hopper/preview -d '{\"hopperIds\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X GET",
7317         "type": "json"
7318       }
7319     ],
7320     "name": "getPreview",
7321     "group": "Cm_Hopper",
7322     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7323     "version": "0.0.0",
7324     "filename": "server/api/cmHopper/index.js",
7325     "groupTitle": "Cm_Hopper"
7326   },
7327   {
7328     "type": "post",
7329     "url": "/api/cm/hopper/previewrecall",
7330     "title": "Gets Preview Dialer Contacts for Recall",
7331     "examples": [
7332       {
7333         "title": "Example usage:",
7334         "content": "curl https://{domain}/api/cm/hopper/previewrecall -d '{\"hopperId\": 1}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X GET",
7335         "type": "json"
7336       }
7337     ],
7338     "name": "getPreviewRecall",
7339     "group": "Cm_Hopper",
7340     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7341     "version": "0.0.0",
7342     "filename": "server/api/cmHopper/index.js",
7343     "groupTitle": "Cm_Hopper"
7344   },
7345   {
7346     "type": "get",
7347     "url": "/api/cm/hopper/timezones",
7348     "title": "Gets TZs list",
7349     "examples": [
7350       {
7351         "title": "Example usage:",
7352         "content": "curl https://{domain}/api/cm/hopper/timezones -v -u {name}:{password} -X GET",
7353         "type": "json"
7354       }
7355     ],
7356     "name": "getTimezones",
7357     "group": "Cm_Hopper",
7358     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7359     "version": "0.0.0",
7360     "filename": "server/api/cmHopper/index.js",
7361     "groupTitle": "Cm_Hopper"
7362   },
7363   {
7364     "type": "put",
7365     "url": "/api/cm/hopper/{id}",
7366     "title": "Update an existing Hopper",
7367     "examples": [
7368       {
7369         "title": "Example usage:",
7370         "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",
7371         "type": "json"
7372       }
7373     ],
7374     "name": "updateHopper",
7375     "group": "Cm_Hopper",
7376     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7377     "version": "0.0.0",
7378     "filename": "server/api/cmHopper/index.js",
7379     "groupTitle": "Cm_Hopper"
7380   },
7381   {
7382     "type": "post",
7383     "url": "/api/cm/lists",
7384     "title": "Creates a new List",
7385     "examples": [
7386       {
7387         "title": "Example usage:",
7388         "content": "curl https://{domain}/api/cm/lists -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
7389         "type": "json"
7390       }
7391     ],
7392     "name": "CreateLists",
7393     "group": "Cm_Lists",
7394     "parameter": {
7395       "fields": {
7396         "Body": [
7397           {
7398             "group": "Body",
7399             "type": "String",
7400             "optional": false,
7401             "field": "name",
7402             "description": ""
7403           },
7404           {
7405             "group": "Body",
7406             "type": "String",
7407             "optional": true,
7408             "field": "description",
7409             "description": ""
7410           },
7411           {
7412             "group": "Body",
7413             "type": "String",
7414             "optional": true,
7415             "field": "dialPrefix",
7416             "description": ""
7417           }
7418         ]
7419       }
7420     },
7421     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7422     "version": "0.0.0",
7423     "filename": "server/api/cmList/index.js",
7424     "groupTitle": "Cm_Lists"
7425   },
7426   {
7427     "type": "delete",
7428     "url": "/api/cm/lists/{id}",
7429     "title": "Deletes a List",
7430     "examples": [
7431       {
7432         "title": "Example usage:",
7433         "content": "curl https://{domain}/api/cm/lists/{id} -v -u {name}:{password} -X DELETE",
7434         "type": "json"
7435       }
7436     ],
7437     "name": "DeleteLists",
7438     "group": "Cm_Lists",
7439     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7440     "version": "0.0.0",
7441     "filename": "server/api/cmList/index.js",
7442     "groupTitle": "Cm_Lists"
7443   },
7444   {
7445     "type": "get",
7446     "url": "/api/cm/lists/describe",
7447     "title": "Gets table info about Lists",
7448     "examples": [
7449       {
7450         "title": "Example usage:",
7451         "content": "curl https://{domain}/api/cm/lists/describe -v -u {name}:{password}",
7452         "type": "json"
7453       }
7454     ],
7455     "name": "DescribeLists",
7456     "group": "Cm_Lists",
7457     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7458     "version": "0.0.0",
7459     "filename": "server/api/cmList/index.js",
7460     "groupTitle": "Cm_Lists"
7461   },
7462   {
7463     "type": "get",
7464     "url": "/api/cm/lists/{id}/users",
7465     "title": "Gets agents from list",
7466     "examples": [
7467       {
7468         "title": "Example usage:",
7469         "content": "curl https://{domain}/api/cm/lists/{id}/users -v -u {name}:{password} -X GET",
7470         "type": "json"
7471       }
7472     ],
7473     "name": "GetAgents",
7474     "group": "Cm_Lists",
7475     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7476     "version": "0.0.0",
7477     "filename": "server/api/cmList/index.js",
7478     "groupTitle": "Cm_Lists"
7479   },
7480   {
7481     "type": "get",
7482     "url": "/api/cm/lists",
7483     "title": "Gets a list of Lists",
7484     "examples": [
7485       {
7486         "title": "Example usage:",
7487         "content": "curl https://{domain}/api/cm/lists -v -u {name}:{password}",
7488         "type": "json"
7489       }
7490     ],
7491     "name": "GetLists",
7492     "group": "Cm_Lists",
7493     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
7494     "version": "0.0.0",
7495     "filename": "server/api/cmList/index.js",
7496     "groupTitle": "Cm_Lists"
7497   },
7498   {
7499     "type": "delete",
7500     "url": "/api/cm/lists/{id}/users",
7501     "title": "Removes agents from a list",
7502     "examples": [
7503       {
7504         "title": "Example usage:",
7505         "content": "curl https://{domain}/api/cm/lists/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
7506         "type": "json"
7507       }
7508     ],
7509     "name": "RemoveAgents",
7510     "group": "Cm_Lists",
7511     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7512     "version": "0.0.0",
7513     "filename": "server/api/cmList/index.js",
7514     "groupTitle": "Cm_Lists"
7515   },
7516   {
7517     "type": "delete",
7518     "url": "/api/cm/lists/{id}/dispositions",
7519     "title": "Removes dispositions from account",
7520     "examples": [
7521       {
7522         "title": "Example usage:",
7523         "content": "curl https://{domain}/api/cm/lists/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
7524         "type": "json"
7525       }
7526     ],
7527     "name": "RemoveDispositions",
7528     "group": "Cm_Lists",
7529     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7530     "version": "0.0.0",
7531     "filename": "server/api/cmList/index.js",
7532     "groupTitle": "Cm_Lists"
7533   },
7534   {
7535     "type": "get",
7536     "url": "/api/cm/lists/{id}",
7537     "title": "Gets a single List",
7538     "examples": [
7539       {
7540         "title": "Example usage:",
7541         "content": "curl https://{domain}/api/cm/lists/{id} -v -u {name}:{password}",
7542         "type": "json"
7543       }
7544     ],
7545     "name": "ShowLists",
7546     "group": "Cm_Lists",
7547     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7548     "version": "0.0.0",
7549     "filename": "server/api/cmList/index.js",
7550     "groupTitle": "Cm_Lists"
7551   },
7552   {
7553     "type": "post",
7554     "url": "/api/cm/lists/{id}/users",
7555     "title": "Adds agents to a list",
7556     "examples": [
7557       {
7558         "title": "Example usage:",
7559         "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",
7560         "type": "json"
7561       }
7562     ],
7563     "name": "addAgents",
7564     "group": "Cm_Lists",
7565     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7566     "version": "0.0.0",
7567     "filename": "server/api/cmList/index.js",
7568     "groupTitle": "Cm_Lists"
7569   },
7570   {
7571     "type": "post",
7572     "url": "/api/cm/lists/{id}/contacts",
7573     "title": "Creates new contacts",
7574     "examples": [
7575       {
7576         "title": "Example usage:",
7577         "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",
7578         "type": "json"
7579       }
7580     ],
7581     "name": "addContacts",
7582     "group": "Cm_Lists",
7583     "parameter": {
7584       "fields": {
7585         "Body": [
7586           {
7587             "group": "Body",
7588             "type": "String",
7589             "optional": false,
7590             "field": "firstName",
7591             "description": ""
7592           },
7593           {
7594             "group": "Body",
7595             "type": "String",
7596             "optional": true,
7597             "field": "lastName",
7598             "description": ""
7599           },
7600           {
7601             "group": "Body",
7602             "type": "String",
7603             "optional": true,
7604             "field": "street",
7605             "description": ""
7606           },
7607           {
7608             "group": "Body",
7609             "type": "String",
7610             "optional": true,
7611             "field": "postalCode",
7612             "description": ""
7613           },
7614           {
7615             "group": "Body",
7616             "type": "String",
7617             "optional": true,
7618             "field": "city",
7619             "description": ""
7620           },
7621           {
7622             "group": "Body",
7623             "type": "String",
7624             "optional": true,
7625             "field": "country",
7626             "description": ""
7627           },
7628           {
7629             "group": "Body",
7630             "type": "String",
7631             "optional": true,
7632             "field": "dateOfBirth",
7633             "description": ""
7634           },
7635           {
7636             "group": "Body",
7637             "type": "Text",
7638             "optional": true,
7639             "field": "description",
7640             "description": ""
7641           },
7642           {
7643             "group": "Body",
7644             "type": "String",
7645             "optional": true,
7646             "field": "phone",
7647             "description": ""
7648           },
7649           {
7650             "group": "Body",
7651             "type": "String",
7652             "optional": true,
7653             "field": "mobile",
7654             "description": ""
7655           },
7656           {
7657             "group": "Body",
7658             "type": "String",
7659             "optional": true,
7660             "field": "fax",
7661             "description": ""
7662           },
7663           {
7664             "group": "Body",
7665             "type": "String",
7666             "optional": true,
7667             "field": "email",
7668             "description": ""
7669           },
7670           {
7671             "group": "Body",
7672             "type": "String",
7673             "optional": true,
7674             "field": "url",
7675             "description": ""
7676           },
7677           {
7678             "group": "Body",
7679             "type": "String",
7680             "optional": true,
7681             "field": "facebook",
7682             "description": ""
7683           },
7684           {
7685             "group": "Body",
7686             "type": "String",
7687             "optional": true,
7688             "field": "fb_data",
7689             "description": ""
7690           },
7691           {
7692             "group": "Body",
7693             "type": "String",
7694             "optional": true,
7695             "field": "twitter",
7696             "description": ""
7697           },
7698           {
7699             "group": "Body",
7700             "type": "String",
7701             "optional": true,
7702             "field": "skype",
7703             "description": ""
7704           },
7705           {
7706             "group": "Body",
7707             "type": "String",
7708             "optional": true,
7709             "field": "teams",
7710             "description": ""
7711           },
7712           {
7713             "group": "Body",
7714             "type": "String",
7715             "optional": true,
7716             "field": "viber",
7717             "description": ""
7718           },
7719           {
7720             "group": "Body",
7721             "type": "String",
7722             "optional": true,
7723             "field": "line",
7724             "description": ""
7725           },
7726           {
7727             "group": "Body",
7728             "type": "String",
7729             "optional": true,
7730             "field": "wechat",
7731             "description": ""
7732           },
7733           {
7734             "group": "Body",
7735             "type": "String",
7736             "optional": true,
7737             "field": "telegram",
7738             "description": ""
7739           },
7740           {
7741             "group": "Body",
7742             "type": "Integer",
7743             "optional": true,
7744             "field": "UserId",
7745             "description": ""
7746           },
7747           {
7748             "group": "Body",
7749             "type": "Integer",
7750             "optional": true,
7751             "field": "priority",
7752             "description": ""
7753           },
7754           {
7755             "group": "Body",
7756             "type": "String",
7757             "optional": true,
7758             "field": "scheduledat",
7759             "description": ""
7760           }
7761         ]
7762       }
7763     },
7764     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7765     "version": "0.0.0",
7766     "filename": "server/api/cmList/index.js",
7767     "groupTitle": "Cm_Lists"
7768   },
7769   {
7770     "type": "post",
7771     "url": "/api/cm/lists/{id}/fields",
7772     "title": "Creates a new custom field",
7773     "examples": [
7774       {
7775         "title": "Example usage:",
7776         "content": "curl https://{domain}/api/cm/lists/{id}/fields -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
7777         "type": "json"
7778       }
7779     ],
7780     "name": "addCustomField",
7781     "group": "Cm_Lists",
7782     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7783     "version": "0.0.0",
7784     "filename": "server/api/cmList/index.js",
7785     "groupTitle": "Cm_Lists"
7786   },
7787   {
7788     "type": "post",
7789     "url": "/api/cm/lists/{id}/dispositions",
7790     "title": "Creates new disposition",
7791     "examples": [
7792       {
7793         "title": "Example usage:",
7794         "content": "curl https://{domain}/api/cm/lists/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
7795         "type": "json"
7796       }
7797     ],
7798     "name": "addDisposition",
7799     "group": "Cm_Lists",
7800     "parameter": {
7801       "fields": {
7802         "Body": [
7803           {
7804             "group": "Body",
7805             "type": "String",
7806             "optional": false,
7807             "field": "name",
7808             "description": ""
7809           },
7810           {
7811             "group": "Body",
7812             "type": "String",
7813             "allowedValues": [
7814               "\"first\"",
7815               "\"second\"",
7816               "\"third\""
7817             ],
7818             "optional": false,
7819             "field": "level",
7820             "description": ""
7821           },
7822           {
7823             "group": "Body",
7824             "type": "String",
7825             "optional": true,
7826             "field": "description",
7827             "description": ""
7828           }
7829         ]
7830       }
7831     },
7832     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7833     "version": "0.0.0",
7834     "filename": "server/api/cmList/index.js",
7835     "groupTitle": "Cm_Lists"
7836   },
7837   {
7838     "type": "get",
7839     "url": "/api/cm/lists/{id}/contacts",
7840     "title": "Gets List Contacts",
7841     "examples": [
7842       {
7843         "title": "Example usage:",
7844         "content": "curl https://{domain}/api/cm/lists/{id}/contacts -v -u {name}:{password} -X GET",
7845         "type": "json"
7846       }
7847     ],
7848     "name": "getContacts",
7849     "group": "Cm_Lists",
7850     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7851     "version": "0.0.0",
7852     "filename": "server/api/cmList/index.js",
7853     "groupTitle": "Cm_Lists"
7854   },
7855   {
7856     "type": "get",
7857     "url": "/api/cm/lists/{id}/fields",
7858     "title": "Gets Custom Fields",
7859     "examples": [
7860       {
7861         "title": "Example usage:",
7862         "content": "curl https://{domain}/api/cm/lists/{id}/fields -v -u {name}:{password} -X GET",
7863         "type": "json"
7864       }
7865     ],
7866     "name": "getCustomFields",
7867     "group": "Cm_Lists",
7868     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7869     "version": "0.0.0",
7870     "filename": "server/api/cmList/index.js",
7871     "groupTitle": "Cm_Lists"
7872   },
7873   {
7874     "type": "get",
7875     "url": "/api/cm/lists/{id}/dispositions",
7876     "title": "Gets list dispositions",
7877     "examples": [
7878       {
7879         "title": "Example usage:",
7880         "content": "curl https://{domain}/api/cm/lists/{id}/dispositions -v -u {name}:{password} -X GET",
7881         "type": "json"
7882       }
7883     ],
7884     "name": "getDispositions",
7885     "group": "Cm_Lists",
7886     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7887     "version": "0.0.0",
7888     "filename": "server/api/cmList/index.js",
7889     "groupTitle": "Cm_Lists"
7890   },
7891   {
7892     "type": "get",
7893     "url": "/api/cm/lists/{id}/contacts/csv",
7894     "title": "Gets CSV List Contacts",
7895     "examples": [
7896       {
7897         "title": "Example usage:",
7898         "content": "curl https://{domain}/api/cm/lists/{id}/contacts/csv -v -u {name}:{password} -X GET",
7899         "type": "json"
7900       }
7901     ],
7902     "name": "grunt",
7903     "group": "Cm_Lists",
7904     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7905     "version": "0.0.0",
7906     "filename": "server/api/cmList/index.js",
7907     "groupTitle": "Cm_Lists"
7908   },
7909   {
7910     "type": "put",
7911     "url": "/api/cm/lists/{id}",
7912     "title": "Update an existing List",
7913     "examples": [
7914       {
7915         "title": "Example usage:",
7916         "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",
7917         "type": "json"
7918       }
7919     ],
7920     "name": "updateLists",
7921     "group": "Cm_Lists",
7922     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7923     "version": "0.0.0",
7924     "filename": "server/api/cmList/index.js",
7925     "groupTitle": "Cm_Lists"
7926   },
7927   {
7928     "type": "post",
7929     "url": "/api/cm/contacts/upload/:id",
7930     "title": "Import new contacts by csv",
7931     "examples": [
7932       {
7933         "title": "Example usage:",
7934         "content": "curl https://{domain}/api/cm/contacts/upload/:id -v -u {name}:{password} -X POST",
7935         "type": "json"
7936       }
7937     ],
7938     "name": "import",
7939     "group": "Cm_contacts",
7940     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7941     "version": "0.0.0",
7942     "filename": "server/api/cmContact/index.js",
7943     "groupTitle": "Cm_contacts"
7944   },
7945   {
7946     "type": "post",
7947     "url": "/api/cm/contacts/upload",
7948     "title": "Upload csv",
7949     "examples": [
7950       {
7951         "title": "Example usage:",
7952         "content": "curl https://{domain}/api/cm/contacts/upload -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
7953         "type": "json"
7954       }
7955     ],
7956     "name": "upload",
7957     "group": "Cm_contacts",
7958     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7959     "version": "0.0.0",
7960     "filename": "server/api/cmContact/index.js",
7961     "groupTitle": "Cm_contacts"
7962   },
7963   {
7964     "type": "post",
7965     "url": "/api/cm/contacts/csv",
7966     "title": "Create new contacts by csv",
7967     "examples": [
7968       {
7969         "title": "Example usage:",
7970         "content": "curl https://{domain}/api/cm/contacts/csv -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
7971         "type": "json"
7972       }
7973     ],
7974     "name": "uploadCsv",
7975     "group": "Cm_contacts",
7976     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7977     "version": "0.0.0",
7978     "filename": "server/api/cmContact/index.js",
7979     "groupTitle": "Cm_contacts"
7980   },
7981   {
7982     "type": "delete",
7983     "url": "/api/conditions/{id}",
7984     "title": "Deletes a Condition",
7985     "examples": [
7986       {
7987         "title": "Example usage:",
7988         "content": "curl https://{domain}/api/conditions/{id} -v -u {name}:{password} -X DELETE",
7989         "type": "json"
7990       }
7991     ],
7992     "name": "DeleteConditions",
7993     "group": "Conditions",
7994     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7995     "version": "0.0.0",
7996     "filename": "server/api/condition/index.js",
7997     "groupTitle": "Conditions"
7998   },
7999   {
8000     "type": "put",
8001     "url": "/api/conditions/{id}",
8002     "title": "Update an existing Condition",
8003     "examples": [
8004       {
8005         "title": "Example usage:",
8006         "content": "curl https://{domain}/api/conditions/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
8007         "type": "json"
8008       }
8009     ],
8010     "name": "updateConditions",
8011     "group": "Conditions",
8012     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8013     "version": "0.0.0",
8014     "filename": "server/api/condition/index.js",
8015     "groupTitle": "Conditions"
8016   },
8017   {
8018     "type": "post",
8019     "url": "/api/cm/custom_field",
8020     "title": "Create a new custom field",
8021     "examples": [
8022       {
8023         "title": "Example usage:",
8024         "content": "curl https://{domain}/api/cm/custom_field  -d '{\"name\": \"mycf\", \"type\": \"text\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
8025         "type": "json"
8026       }
8027     ],
8028     "name": "CreateCustomField",
8029     "group": "Custom_Fields",
8030     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8031     "version": "0.0.0",
8032     "filename": "server/api/cmCustomField/index.js",
8033     "groupTitle": "Custom_Fields"
8034   },
8035   {
8036     "type": "post",
8037     "url": "/api/dashboards/items",
8038     "title": "Create dasboard item",
8039     "examples": [
8040       {
8041         "title": "Example usage:",
8042         "content": "curl https://{domain}/api/dashboards/items \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
8043         "type": "json"
8044       }
8045     ],
8046     "name": "Create",
8047     "group": "Dashboard_Items",
8048     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8049     "version": "0.0.0",
8050     "filename": "server/api/dashboardItem/index.js",
8051     "groupTitle": "Dashboard_Items"
8052   },
8053   {
8054     "type": "delete",
8055     "url": "/api/dashboards/items/{id}",
8056     "title": "Deletes a Dashboard Item",
8057     "examples": [
8058       {
8059         "title": "Example usage:",
8060         "content": "curl https://{domain}/api/dashboards/items/{id} -v -u {name}:{password} -X DELETE",
8061         "type": "json"
8062       }
8063     ],
8064     "name": "DeleteDashboard_Items",
8065     "group": "Dashboard_Items",
8066     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8067     "version": "0.0.0",
8068     "filename": "server/api/dashboardItem/index.js",
8069     "groupTitle": "Dashboard_Items"
8070   },
8071   {
8072     "type": "get",
8073     "url": "/api/dashboards/items/{id}",
8074     "title": "Gets a single Dashboard Item",
8075     "examples": [
8076       {
8077         "title": "Example usage:",
8078         "content": "curl https://{domain}/api/dashboards/items/{id} -v -u {name}:{password}",
8079         "type": "json"
8080       }
8081     ],
8082     "name": "ShowDashboard_Items",
8083     "group": "Dashboard_Items",
8084     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8085     "version": "0.0.0",
8086     "filename": "server/api/dashboardItem/index.js",
8087     "groupTitle": "Dashboard_Items"
8088   },
8089   {
8090     "type": "put",
8091     "url": "/api/dashboards/items/{id}",
8092     "title": "Update an existing item",
8093     "examples": [
8094       {
8095         "title": "Example usage:",
8096         "content": "curl https://{domain}/api/dashboards/items/{id} -v -u {name}:{password} -X PUT",
8097         "type": "json"
8098       }
8099     ],
8100     "name": "Update",
8101     "group": "Dashboard_Items",
8102     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8103     "version": "0.0.0",
8104     "filename": "server/api/dashboardItem/index.js",
8105     "groupTitle": "Dashboard_Items"
8106   },
8107   {
8108     "type": "post",
8109     "url": "/api/dashboards/clone",
8110     "title": "Clone an existing Dashboard",
8111     "examples": [
8112       {
8113         "title": "Example usage:",
8114         "content": "curl https://{domain}/api/dashboards/clone -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
8115         "type": "json"
8116       }
8117     ],
8118     "name": "CloneDashboards",
8119     "group": "Dashboards",
8120     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8121     "version": "0.0.0",
8122     "filename": "server/api/dashboard/index.js",
8123     "groupTitle": "Dashboards"
8124   },
8125   {
8126     "type": "post",
8127     "url": "/api/dashboards",
8128     "title": "Creates a new Dashboard",
8129     "examples": [
8130       {
8131         "title": "Example usage:",
8132         "content": "curl https://{domain}/api/dashboards -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
8133         "type": "json"
8134       }
8135     ],
8136     "name": "CreateDashboards",
8137     "group": "Dashboards",
8138     "parameter": {
8139       "fields": {
8140         "Body": [
8141           {
8142             "group": "Body",
8143             "type": "String",
8144             "optional": false,
8145             "field": "name",
8146             "description": ""
8147           },
8148           {
8149             "group": "Body",
8150             "type": "String",
8151             "optional": true,
8152             "field": "description",
8153             "description": ""
8154           }
8155         ]
8156       }
8157     },
8158     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8159     "version": "0.0.0",
8160     "filename": "server/api/dashboard/index.js",
8161     "groupTitle": "Dashboards"
8162   },
8163   {
8164     "type": "delete",
8165     "url": "/api/dashboards/{id}",
8166     "title": "Deletes a Dashboard",
8167     "examples": [
8168       {
8169         "title": "Example usage:",
8170         "content": "curl https://{domain}/api/dashboards/{id} -v -u {name}:{password} -X DELETE",
8171         "type": "json"
8172       }
8173     ],
8174     "name": "DeleteDashboards",
8175     "group": "Dashboards",
8176     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8177     "version": "0.0.0",
8178     "filename": "server/api/dashboard/index.js",
8179     "groupTitle": "Dashboards"
8180   },
8181   {
8182     "type": "get",
8183     "url": "/api/dashboards",
8184     "title": "Gets a list of Dashboards",
8185     "examples": [
8186       {
8187         "title": "Example usage:",
8188         "content": "curl https://{domain}/api/dashboards -v -u {name}:{password}",
8189         "type": "json"
8190       }
8191     ],
8192     "name": "GetDashboards",
8193     "group": "Dashboards",
8194     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
8195     "version": "0.0.0",
8196     "filename": "server/api/dashboard/index.js",
8197     "groupTitle": "Dashboards"
8198   },
8199   {
8200     "type": "get",
8201     "url": "/api/dashboards/{id}",
8202     "title": "Gets a single Dashboard",
8203     "examples": [
8204       {
8205         "title": "Example usage:",
8206         "content": "curl https://{domain}/api/dashboards/{id} -v -u {name}:{password}",
8207         "type": "json"
8208       }
8209     ],
8210     "name": "ShowDashboards",
8211     "group": "Dashboards",
8212     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8213     "version": "0.0.0",
8214     "filename": "server/api/dashboard/index.js",
8215     "groupTitle": "Dashboards"
8216   },
8217   {
8218     "type": "post",
8219     "url": "/api/dashboards/{id}/items",
8220     "title": "Creates new item",
8221     "examples": [
8222       {
8223         "title": "Example usage:",
8224         "content": "curl https://{domain}/api/dashboards/{id}/items -d '{\"type\": \"counter\", \"...\": \"...\"}]' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
8225         "type": "json"
8226       }
8227     ],
8228     "name": "addItem",
8229     "group": "Dashboards",
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/dashboard/index.js",
8233     "groupTitle": "Dashboards"
8234   },
8235   {
8236     "type": "get",
8237     "url": "/api/dashboards/{id}/items",
8238     "title": "Gets items",
8239     "examples": [
8240       {
8241         "title": "Example usage:",
8242         "content": "curl https://{domain}/api/dashboards/{id}/items -v -u {name}:{password} -X GET",
8243         "type": "json"
8244       }
8245     ],
8246     "name": "getItems",
8247     "group": "Dashboards",
8248     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8249     "version": "0.0.0",
8250     "filename": "server/api/dashboard/index.js",
8251     "groupTitle": "Dashboards"
8252   },
8253   {
8254     "type": "put",
8255     "url": "/api/dashboards/{id}",
8256     "title": "Update an existing Dashboard",
8257     "examples": [
8258       {
8259         "title": "Example usage:",
8260         "content": "curl https://{domain}/api/dashboards/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
8261         "type": "json"
8262       }
8263     ],
8264     "name": "updateDashboards",
8265     "group": "Dashboards",
8266     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8267     "version": "0.0.0",
8268     "filename": "server/api/dashboard/index.js",
8269     "groupTitle": "Dashboards"
8270   },
8271   {
8272     "type": "post",
8273     "url": "/api/integrations/desk/accounts",
8274     "title": "Creates a new Desk Account",
8275     "examples": [
8276       {
8277         "title": "Example usage:",
8278         "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",
8279         "type": "json"
8280       }
8281     ],
8282     "name": "CreateDesk_Accounts",
8283     "group": "Desk_Accounts",
8284     "parameter": {
8285       "fields": {
8286         "Body": [
8287           {
8288             "group": "Body",
8289             "type": "String",
8290             "optional": true,
8291             "field": "name",
8292             "description": ""
8293           },
8294           {
8295             "group": "Body",
8296             "type": "String",
8297             "optional": true,
8298             "field": "description",
8299             "description": ""
8300           },
8301           {
8302             "group": "Body",
8303             "type": "String",
8304             "optional": true,
8305             "field": "username",
8306             "description": ""
8307           },
8308           {
8309             "group": "Body",
8310             "type": "String",
8311             "optional": true,
8312             "field": "remoteUri",
8313             "description": ""
8314           },
8315           {
8316             "group": "Body",
8317             "type": "String",
8318             "allowedValues": [
8319               "\"basic\""
8320             ],
8321             "optional": true,
8322             "field": "authType",
8323             "description": ""
8324           },
8325           {
8326             "group": "Body",
8327             "type": "String",
8328             "optional": true,
8329             "field": "password",
8330             "description": ""
8331           },
8332           {
8333             "group": "Body",
8334             "type": "String",
8335             "optional": true,
8336             "field": "consumerKey",
8337             "description": ""
8338           },
8339           {
8340             "group": "Body",
8341             "type": "String",
8342             "optional": true,
8343             "field": "consumerSecret",
8344             "description": ""
8345           },
8346           {
8347             "group": "Body",
8348             "type": "String",
8349             "optional": true,
8350             "field": "token",
8351             "description": ""
8352           },
8353           {
8354             "group": "Body",
8355             "type": "String",
8356             "optional": true,
8357             "field": "tokenSecret",
8358             "description": ""
8359           },
8360           {
8361             "group": "Body",
8362             "type": "String",
8363             "optional": false,
8364             "field": "serverUrl",
8365             "description": ""
8366           },
8367           {
8368             "group": "Body",
8369             "type": "String",
8370             "allowedValues": [
8371               "\"integrationTab\"",
8372               "\"newTab\""
8373             ],
8374             "optional": true,
8375             "field": "type",
8376             "description": ""
8377           }
8378         ]
8379       }
8380     },
8381     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8382     "version": "0.0.0",
8383     "filename": "server/api/intDeskAccount/index.js",
8384     "groupTitle": "Desk_Accounts"
8385   },
8386   {
8387     "type": "delete",
8388     "url": "/api/integrations/desk/accounts/{id}",
8389     "title": "Deletes a Desk Account",
8390     "examples": [
8391       {
8392         "title": "Example usage:",
8393         "content": "curl https://{domain}/api/integrations/desk/accounts/{id} -v -u {name}:{password} -X DELETE",
8394         "type": "json"
8395       }
8396     ],
8397     "name": "DeleteDesk_Accounts",
8398     "group": "Desk_Accounts",
8399     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8400     "version": "0.0.0",
8401     "filename": "server/api/intDeskAccount/index.js",
8402     "groupTitle": "Desk_Accounts"
8403   },
8404   {
8405     "type": "get",
8406     "url": "/api/integrations/desk/accounts",
8407     "title": "Gets a list of Desk Accounts",
8408     "examples": [
8409       {
8410         "title": "Example usage:",
8411         "content": "curl https://{domain}/api/integrations/desk/accounts -v -u {name}:{password}",
8412         "type": "json"
8413       }
8414     ],
8415     "name": "GetDesk_Accounts",
8416     "group": "Desk_Accounts",
8417     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
8418     "version": "0.0.0",
8419     "filename": "server/api/intDeskAccount/index.js",
8420     "groupTitle": "Desk_Accounts"
8421   },
8422   {
8423     "type": "get",
8424     "url": "/api/integrations/desk/accounts/{id}",
8425     "title": "Gets a single Desk Account",
8426     "examples": [
8427       {
8428         "title": "Example usage:",
8429         "content": "curl https://{domain}/api/integrations/desk/accounts/{id} -v -u {name}:{password}",
8430         "type": "json"
8431       }
8432     ],
8433     "name": "ShowDesk_Accounts",
8434     "group": "Desk_Accounts",
8435     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8436     "version": "0.0.0",
8437     "filename": "server/api/intDeskAccount/index.js",
8438     "groupTitle": "Desk_Accounts"
8439   },
8440   {
8441     "type": "post",
8442     "url": "/api/integrations/desk/accounts/{id}/configurations",
8443     "title": "Creates new configuration",
8444     "examples": [
8445       {
8446         "title": "Example usage:",
8447         "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",
8448         "type": "json"
8449       }
8450     ],
8451     "name": "addConfiguration",
8452     "group": "Desk_Accounts",
8453     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8454     "version": "0.0.0",
8455     "filename": "server/api/intDeskAccount/index.js",
8456     "groupTitle": "Desk_Accounts"
8457   },
8458   {
8459     "type": "get",
8460     "url": "/api/integrations/desk/accounts/{id}/configurations",
8461     "title": "Gets account configurations",
8462     "examples": [
8463       {
8464         "title": "Example usage:",
8465         "content": "curl https://{domain}/api/integrations/desk/accounts/{id}/configurations -v -u {name}:{password} -X GET",
8466         "type": "json"
8467       }
8468     ],
8469     "name": "getConfigurations",
8470     "group": "Desk_Accounts",
8471     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8472     "version": "0.0.0",
8473     "filename": "server/api/intDeskAccount/index.js",
8474     "groupTitle": "Desk_Accounts"
8475   },
8476   {
8477     "type": "get",
8478     "url": "/api/integrations/desk/accounts/{id}/fields",
8479     "title": "Gets account fields",
8480     "examples": [
8481       {
8482         "title": "Example usage:",
8483         "content": "curl https://{domain}/api/integrations/desk/accounts/{id}/fields -v -u {name}:{password} -X GET",
8484         "type": "json"
8485       }
8486     ],
8487     "name": "getFields",
8488     "group": "Desk_Accounts",
8489     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8490     "version": "0.0.0",
8491     "filename": "server/api/intDeskAccount/index.js",
8492     "groupTitle": "Desk_Accounts"
8493   },
8494   {
8495     "type": "put",
8496     "url": "/api/integrations/desk/accounts/{id}",
8497     "title": "Update an existing Desk Account",
8498     "examples": [
8499       {
8500         "title": "Example usage:",
8501         "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",
8502         "type": "json"
8503       }
8504     ],
8505     "name": "updateDesk_Accounts",
8506     "group": "Desk_Accounts",
8507     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8508     "version": "0.0.0",
8509     "filename": "server/api/intDeskAccount/index.js",
8510     "groupTitle": "Desk_Accounts"
8511   },
8512   {
8513     "type": "post",
8514     "url": "/api/integrations/desk/configurations",
8515     "title": "Creates a new Desk Configuration",
8516     "examples": [
8517       {
8518         "title": "Example usage:",
8519         "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",
8520         "type": "json"
8521       }
8522     ],
8523     "name": "CreateDesk_Configurations",
8524     "group": "Desk_Configurations",
8525     "parameter": {
8526       "fields": {
8527         "Body": [
8528           {
8529             "group": "Body",
8530             "type": "String",
8531             "optional": true,
8532             "field": "name",
8533             "description": ""
8534           },
8535           {
8536             "group": "Body",
8537             "type": "String",
8538             "optional": true,
8539             "field": "description",
8540             "description": ""
8541           }
8542         ]
8543       }
8544     },
8545     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8546     "version": "0.0.0",
8547     "filename": "server/api/intDeskConfiguration/index.js",
8548     "groupTitle": "Desk_Configurations"
8549   },
8550   {
8551     "type": "delete",
8552     "url": "/api/integrations/desk/configurations/{id}",
8553     "title": "Deletes a Desk Configuration",
8554     "examples": [
8555       {
8556         "title": "Example usage:",
8557         "content": "curl https://{domain}/api/integrations/desk/configurations/{id} -v -u {name}:{password} -X DELETE",
8558         "type": "json"
8559       }
8560     ],
8561     "name": "DeleteDesk_Configurations",
8562     "group": "Desk_Configurations",
8563     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8564     "version": "0.0.0",
8565     "filename": "server/api/intDeskConfiguration/index.js",
8566     "groupTitle": "Desk_Configurations"
8567   },
8568   {
8569     "type": "get",
8570     "url": "/api/integrations/desk/configurations",
8571     "title": "Gets a list of Desk Configurations",
8572     "examples": [
8573       {
8574         "title": "Example usage:",
8575         "content": "curl https://{domain}/api/integrations/desk/configurations -v -u {name}:{password}",
8576         "type": "json"
8577       }
8578     ],
8579     "name": "GetDesk_Configurations",
8580     "group": "Desk_Configurations",
8581     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
8582     "version": "0.0.0",
8583     "filename": "server/api/intDeskConfiguration/index.js",
8584     "groupTitle": "Desk_Configurations"
8585   },
8586   {
8587     "type": "get",
8588     "url": "/api/integrations/desk/configurations/{id}",
8589     "title": "Gets a single Desk Configuration",
8590     "examples": [
8591       {
8592         "title": "Example usage:",
8593         "content": "curl https://{domain}/api/integrations/desk/configurations/{id} -v -u {name}:{password}",
8594         "type": "json"
8595       }
8596     ],
8597     "name": "ShowDesk_Configurations",
8598     "group": "Desk_Configurations",
8599     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8600     "version": "0.0.0",
8601     "filename": "server/api/intDeskConfiguration/index.js",
8602     "groupTitle": "Desk_Configurations"
8603   },
8604   {
8605     "type": "get",
8606     "url": "/api/integrations/desk/configurations/{id}/descriptions",
8607     "title": "Gets configurations descriptions",
8608     "examples": [
8609       {
8610         "title": "Example usage:",
8611         "content": "curl https://{domain}/api/integrations/desk/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
8612         "type": "json"
8613       }
8614     ],
8615     "name": "getDescriptions",
8616     "group": "Desk_Configurations",
8617     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8618     "version": "0.0.0",
8619     "filename": "server/api/intDeskConfiguration/index.js",
8620     "groupTitle": "Desk_Configurations"
8621   },
8622   {
8623     "type": "get",
8624     "url": "/api/integrations/desk/configurations/{id}/fields",
8625     "title": "Gets configurations fields",
8626     "examples": [
8627       {
8628         "title": "Example usage:",
8629         "content": "curl https://{domain}/api/integrations/desk/configurations/{id}/fields -v -u {name}:{password} -X GET",
8630         "type": "json"
8631       }
8632     ],
8633     "name": "getFields",
8634     "group": "Desk_Configurations",
8635     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8636     "version": "0.0.0",
8637     "filename": "server/api/intDeskConfiguration/index.js",
8638     "groupTitle": "Desk_Configurations"
8639   },
8640   {
8641     "type": "get",
8642     "url": "/api/integrations/desk/configurations/{id}/subjects",
8643     "title": "Gets configurations subjects",
8644     "examples": [
8645       {
8646         "title": "Example usage:",
8647         "content": "curl https://{domain}/api/integrations/desk/configurations/{id}/subjects -v -u {name}:{password} -X GET",
8648         "type": "json"
8649       }
8650     ],
8651     "name": "getSubjects",
8652     "group": "Desk_Configurations",
8653     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8654     "version": "0.0.0",
8655     "filename": "server/api/intDeskConfiguration/index.js",
8656     "groupTitle": "Desk_Configurations"
8657   },
8658   {
8659     "type": "get",
8660     "url": "/api/integrations/desk/configurations/{id}/tags",
8661     "title": "Gets configurations tags",
8662     "examples": [
8663       {
8664         "title": "Example usage:",
8665         "content": "curl https://{domain}/api/integrations/desk/configurations/{id}/tags -v -u {name}:{password} -X GET",
8666         "type": "json"
8667       }
8668     ],
8669     "name": "getTags",
8670     "group": "Desk_Configurations",
8671     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8672     "version": "0.0.0",
8673     "filename": "server/api/intDeskConfiguration/index.js",
8674     "groupTitle": "Desk_Configurations"
8675   },
8676   {
8677     "type": "post",
8678     "url": "/api/integrations/desk/configurations/{id}/tags",
8679     "title": "Sets new tags",
8680     "examples": [
8681       {
8682         "title": "Example usage:",
8683         "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",
8684         "type": "json"
8685       }
8686     ],
8687     "name": "setTags",
8688     "group": "Desk_Configurations",
8689     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8690     "version": "0.0.0",
8691     "filename": "server/api/intDeskConfiguration/index.js",
8692     "groupTitle": "Desk_Configurations"
8693   },
8694   {
8695     "type": "put",
8696     "url": "/api/integrations/desk/configurations/{id}",
8697     "title": "Update an existing Desk Configuration",
8698     "examples": [
8699       {
8700         "title": "Example usage:",
8701         "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",
8702         "type": "json"
8703       }
8704     ],
8705     "name": "updateDesk_Configurations",
8706     "group": "Desk_Configurations",
8707     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8708     "version": "0.0.0",
8709     "filename": "server/api/intDeskConfiguration/index.js",
8710     "groupTitle": "Desk_Configurations"
8711   },
8712   {
8713     "type": "post",
8714     "url": "/api/integrations/desk/fields",
8715     "title": "Creates a new Desk Field",
8716     "examples": [
8717       {
8718         "title": "Example usage:",
8719         "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",
8720         "type": "json"
8721       }
8722     ],
8723     "name": "CreateDesk_Fields",
8724     "group": "Desk_Fields",
8725     "parameter": {
8726       "fields": {
8727         "Body": [
8728           {
8729             "group": "Body",
8730             "type": "String",
8731             "allowedValues": [
8732               "\"string\"",
8733               "\"variable\"",
8734               "\"customVariable\"",
8735               "\"keyValue\"",
8736               "\"picklist\""
8737             ],
8738             "optional": true,
8739             "field": "type",
8740             "description": ""
8741           },
8742           {
8743             "group": "Body",
8744             "type": "String",
8745             "optional": true,
8746             "field": "content",
8747             "description": ""
8748           },
8749           {
8750             "group": "Body",
8751             "type": "String",
8752             "optional": true,
8753             "field": "key",
8754             "description": ""
8755           },
8756           {
8757             "group": "Body",
8758             "type": "String",
8759             "allowedValues": [
8760               "\"string\"",
8761               "\"variable\"",
8762               "\"customVariable\""
8763             ],
8764             "optional": true,
8765             "field": "keyType",
8766             "description": ""
8767           },
8768           {
8769             "group": "Body",
8770             "type": "String",
8771             "optional": true,
8772             "field": "keyContent",
8773             "description": ""
8774           },
8775           {
8776             "group": "Body",
8777             "type": "String",
8778             "optional": true,
8779             "field": "idField",
8780             "description": ""
8781           },
8782           {
8783             "group": "Body",
8784             "type": "String",
8785             "optional": true,
8786             "field": "nameField",
8787             "description": ""
8788           },
8789           {
8790             "group": "Body",
8791             "type": "Boolean",
8792             "optional": true,
8793             "field": "customField",
8794             "description": ""
8795           },
8796           {
8797             "group": "Body",
8798             "type": "String",
8799             "optional": true,
8800             "field": "variableName",
8801             "description": ""
8802           }
8803         ]
8804       }
8805     },
8806     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8807     "version": "0.0.0",
8808     "filename": "server/api/intDeskField/index.js",
8809     "groupTitle": "Desk_Fields"
8810   },
8811   {
8812     "type": "delete",
8813     "url": "/api/integrations/desk/fields/{id}",
8814     "title": "Deletes a Desk Field",
8815     "examples": [
8816       {
8817         "title": "Example usage:",
8818         "content": "curl https://{domain}/api/integrations/desk/fields/{id} -v -u {name}:{password} -X DELETE",
8819         "type": "json"
8820       }
8821     ],
8822     "name": "DeleteDesk_Fields",
8823     "group": "Desk_Fields",
8824     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8825     "version": "0.0.0",
8826     "filename": "server/api/intDeskField/index.js",
8827     "groupTitle": "Desk_Fields"
8828   },
8829   {
8830     "type": "get",
8831     "url": "/api/integrations/desk/fields",
8832     "title": "Gets a list of Desk Fields",
8833     "examples": [
8834       {
8835         "title": "Example usage:",
8836         "content": "curl https://{domain}/api/integrations/desk/fields -v -u {name}:{password}",
8837         "type": "json"
8838       }
8839     ],
8840     "name": "GetDesk_Fields",
8841     "group": "Desk_Fields",
8842     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
8843     "version": "0.0.0",
8844     "filename": "server/api/intDeskField/index.js",
8845     "groupTitle": "Desk_Fields"
8846   },
8847   {
8848     "type": "get",
8849     "url": "/api/integrations/desk/fields/{id}",
8850     "title": "Gets a single Desk Field",
8851     "examples": [
8852       {
8853         "title": "Example usage:",
8854         "content": "curl https://{domain}/api/integrations/desk/fields/{id} -v -u {name}:{password}",
8855         "type": "json"
8856       }
8857     ],
8858     "name": "ShowDesk_Fields",
8859     "group": "Desk_Fields",
8860     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8861     "version": "0.0.0",
8862     "filename": "server/api/intDeskField/index.js",
8863     "groupTitle": "Desk_Fields"
8864   },
8865   {
8866     "type": "put",
8867     "url": "/api/integrations/desk/fields/{id}",
8868     "title": "Update an existing Desk Field",
8869     "examples": [
8870       {
8871         "title": "Example usage:",
8872         "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",
8873         "type": "json"
8874       }
8875     ],
8876     "name": "updateDesk_Fields",
8877     "group": "Desk_Fields",
8878     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8879     "version": "0.0.0",
8880     "filename": "server/api/intDeskField/index.js",
8881     "groupTitle": "Desk_Fields"
8882   },
8883   {
8884     "type": "post",
8885     "url": "/api/dispositions",
8886     "title": "Creates a new Disposition",
8887     "examples": [
8888       {
8889         "title": "Example usage:",
8890         "content": "curl https://{domain}/api/dispositions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
8891         "type": "json"
8892       }
8893     ],
8894     "name": "CreateDispositions",
8895     "group": "Dispositions",
8896     "parameter": {
8897       "fields": {
8898         "Body": [
8899           {
8900             "group": "Body",
8901             "type": "String",
8902             "optional": false,
8903             "field": "name",
8904             "description": ""
8905           },
8906           {
8907             "group": "Body",
8908             "type": "String",
8909             "allowedValues": [
8910               "\"first\"",
8911               "\"second\"",
8912               "\"third\""
8913             ],
8914             "optional": false,
8915             "field": "level",
8916             "description": ""
8917           },
8918           {
8919             "group": "Body",
8920             "type": "String",
8921             "optional": true,
8922             "field": "description",
8923             "description": ""
8924           }
8925         ]
8926       }
8927     },
8928     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8929     "version": "0.0.0",
8930     "filename": "server/api/disposition/index.js",
8931     "groupTitle": "Dispositions"
8932   },
8933   {
8934     "type": "delete",
8935     "url": "/api/dispositions/{id}",
8936     "title": "Deletes a Disposition",
8937     "examples": [
8938       {
8939         "title": "Example usage:",
8940         "content": "curl https://{domain}/api/dispositions/{id} -v -u {name}:{password} -X DELETE",
8941         "type": "json"
8942       }
8943     ],
8944     "name": "DeleteDispositions",
8945     "group": "Dispositions",
8946     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8947     "version": "0.0.0",
8948     "filename": "server/api/disposition/index.js",
8949     "groupTitle": "Dispositions"
8950   },
8951   {
8952     "type": "get",
8953     "url": "/api/dispositions",
8954     "title": "Gets a list of Dispositions",
8955     "examples": [
8956       {
8957         "title": "Example usage:",
8958         "content": "curl https://{domain}/api/dispositions -v -u {name}:{password}",
8959         "type": "json"
8960       }
8961     ],
8962     "name": "GetDispositions",
8963     "group": "Dispositions",
8964     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
8965     "version": "0.0.0",
8966     "filename": "server/api/disposition/index.js",
8967     "groupTitle": "Dispositions"
8968   },
8969   {
8970     "type": "get",
8971     "url": "/api/dispositions/{id}",
8972     "title": "Gets a single Disposition",
8973     "examples": [
8974       {
8975         "title": "Example usage:",
8976         "content": "curl https://{domain}/api/dispositions/{id} -v -u {name}:{password}",
8977         "type": "json"
8978       }
8979     ],
8980     "name": "ShowDispositions",
8981     "group": "Dispositions",
8982     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8983     "version": "0.0.0",
8984     "filename": "server/api/disposition/index.js",
8985     "groupTitle": "Dispositions"
8986   },
8987   {
8988     "type": "put",
8989     "url": "/api/dispositions/{id}",
8990     "title": "Update an existing Disposition",
8991     "examples": [
8992       {
8993         "title": "Example usage:",
8994         "content": "curl https://{domain}/api/dispositions/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
8995         "type": "json"
8996       }
8997     ],
8998     "name": "updateDispositions",
8999     "group": "Dispositions",
9000     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <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/disposition/index.js",
9003     "groupTitle": "Dispositions"
9004   },
9005   {
9006     "type": "post",
9007     "url": "/api/integrations/dynamics365/accounts",
9008     "title": "Creates a new Dynamics365 Account",
9009     "examples": [
9010       {
9011         "title": "Example usage:",
9012         "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",
9013         "type": "json"
9014       }
9015     ],
9016     "name": "CreateDynamics365_Accounts",
9017     "group": "Dynamics365_Accounts",
9018     "parameter": {
9019       "fields": {
9020         "Body": [
9021           {
9022             "group": "Body",
9023             "type": "String",
9024             "optional": true,
9025             "field": "name",
9026             "description": ""
9027           },
9028           {
9029             "group": "Body",
9030             "type": "String",
9031             "optional": true,
9032             "field": "username",
9033             "description": ""
9034           },
9035           {
9036             "group": "Body",
9037             "type": "String",
9038             "optional": true,
9039             "field": "password",
9040             "description": ""
9041           },
9042           {
9043             "group": "Body",
9044             "type": "String",
9045             "optional": true,
9046             "field": "remoteUri",
9047             "description": ""
9048           },
9049           {
9050             "group": "Body",
9051             "type": "String",
9052             "optional": true,
9053             "field": "tenantId",
9054             "description": ""
9055           },
9056           {
9057             "group": "Body",
9058             "type": "String",
9059             "optional": true,
9060             "field": "clientId",
9061             "description": ""
9062           },
9063           {
9064             "group": "Body",
9065             "type": "String",
9066             "optional": true,
9067             "field": "clientSecret",
9068             "description": ""
9069           },
9070           {
9071             "group": "Body",
9072             "type": "String",
9073             "optional": false,
9074             "field": "serverUrl",
9075             "description": ""
9076           },
9077           {
9078             "group": "Body",
9079             "type": "String",
9080             "optional": true,
9081             "field": "description",
9082             "description": ""
9083           }
9084         ]
9085       }
9086     },
9087     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9088     "version": "0.0.0",
9089     "filename": "server/api/intDynamics365Account/index.js",
9090     "groupTitle": "Dynamics365_Accounts"
9091   },
9092   {
9093     "type": "delete",
9094     "url": "/api/integrations/dynamics365/accounts/{id}",
9095     "title": "Deletes a Dynamics365 Account",
9096     "examples": [
9097       {
9098         "title": "Example usage:",
9099         "content": "curl https://{domain}/api/integrations/dynamics365/accounts/{id} -v -u {name}:{password} -X DELETE",
9100         "type": "json"
9101       }
9102     ],
9103     "name": "DeleteDynamics365_Accounts",
9104     "group": "Dynamics365_Accounts",
9105     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9106     "version": "0.0.0",
9107     "filename": "server/api/intDynamics365Account/index.js",
9108     "groupTitle": "Dynamics365_Accounts"
9109   },
9110   {
9111     "type": "get",
9112     "url": "/api/integrations/dynamics365/accounts",
9113     "title": "Gets a list of Dynamics365 Accounts",
9114     "examples": [
9115       {
9116         "title": "Example usage:",
9117         "content": "curl https://{domain}/api/integrations/dynamics365/accounts -v -u {name}:{password}",
9118         "type": "json"
9119       }
9120     ],
9121     "name": "GetDynamics365_Accounts",
9122     "group": "Dynamics365_Accounts",
9123     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
9124     "version": "0.0.0",
9125     "filename": "server/api/intDynamics365Account/index.js",
9126     "groupTitle": "Dynamics365_Accounts"
9127   },
9128   {
9129     "type": "get",
9130     "url": "/api/integrations/dynamics365/accounts/{id}",
9131     "title": "Gets a single Dynamics365 Account",
9132     "examples": [
9133       {
9134         "title": "Example usage:",
9135         "content": "curl https://{domain}/api/integrations/dynamics365/accounts/{id} -v -u {name}:{password}",
9136         "type": "json"
9137       }
9138     ],
9139     "name": "ShowDynamics365_Accounts",
9140     "group": "Dynamics365_Accounts",
9141     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9142     "version": "0.0.0",
9143     "filename": "server/api/intDynamics365Account/index.js",
9144     "groupTitle": "Dynamics365_Accounts"
9145   },
9146   {
9147     "type": "post",
9148     "url": "/api/integrations/dynamics365/accounts/{id}/configurations",
9149     "title": "Creates new configuration",
9150     "examples": [
9151       {
9152         "title": "Example usage:",
9153         "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",
9154         "type": "json"
9155       }
9156     ],
9157     "name": "addConfiguration",
9158     "group": "Dynamics365_Accounts",
9159     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9160     "version": "0.0.0",
9161     "filename": "server/api/intDynamics365Account/index.js",
9162     "groupTitle": "Dynamics365_Accounts"
9163   },
9164   {
9165     "type": "get",
9166     "url": "/api/integrations/dynamics365/accounts/{id}/configurations",
9167     "title": "Gets account configurations",
9168     "examples": [
9169       {
9170         "title": "Example usage:",
9171         "content": "curl https://{domain}/api/integrations/dynamics365/accounts/{id}/configurations -v -u {name}:{password} -X GET",
9172         "type": "json"
9173       }
9174     ],
9175     "name": "getConfigurations",
9176     "group": "Dynamics365_Accounts",
9177     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9178     "version": "0.0.0",
9179     "filename": "server/api/intDynamics365Account/index.js",
9180     "groupTitle": "Dynamics365_Accounts"
9181   },
9182   {
9183     "type": "get",
9184     "url": "/api/integrations/dynamics365/accounts/{id}/fields",
9185     "title": "Gets account fields",
9186     "examples": [
9187       {
9188         "title": "Example usage:",
9189         "content": "curl https://{domain}/api/integrations/dynamics365/accounts/{id}/fields -v -u {name}:{password} -X GET",
9190         "type": "json"
9191       }
9192     ],
9193     "name": "getFields",
9194     "group": "Dynamics365_Accounts",
9195     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9196     "version": "0.0.0",
9197     "filename": "server/api/intDynamics365Account/index.js",
9198     "groupTitle": "Dynamics365_Accounts"
9199   },
9200   {
9201     "type": "put",
9202     "url": "/api/integrations/dynamics365/accounts/{id}",
9203     "title": "Update an existing Dynamics365 Account",
9204     "examples": [
9205       {
9206         "title": "Example usage:",
9207         "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",
9208         "type": "json"
9209       }
9210     ],
9211     "name": "updateDynamics365_Accounts",
9212     "group": "Dynamics365_Accounts",
9213     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9214     "version": "0.0.0",
9215     "filename": "server/api/intDynamics365Account/index.js",
9216     "groupTitle": "Dynamics365_Accounts"
9217   },
9218   {
9219     "type": "post",
9220     "url": "/api/integrations/dynamics365/configurations",
9221     "title": "Creates a new Dynamics365 Configuration",
9222     "examples": [
9223       {
9224         "title": "Example usage:",
9225         "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",
9226         "type": "json"
9227       }
9228     ],
9229     "name": "CreateDynamics365_Configurations",
9230     "group": "Dynamics365_Configurations",
9231     "parameter": {
9232       "fields": {
9233         "Body": [
9234           {
9235             "group": "Body",
9236             "type": "String",
9237             "optional": true,
9238             "field": "name",
9239             "description": ""
9240           },
9241           {
9242             "group": "Body",
9243             "type": "String",
9244             "optional": true,
9245             "field": "description",
9246             "description": ""
9247           },
9248           {
9249             "group": "Body",
9250             "type": "String",
9251             "allowedValues": [
9252               "\"incident\"",
9253               "\"phonecall\""
9254             ],
9255             "optional": true,
9256             "field": "ticketType",
9257             "description": ""
9258           }
9259         ]
9260       }
9261     },
9262     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9263     "version": "0.0.0",
9264     "filename": "server/api/intDynamics365Configuration/index.js",
9265     "groupTitle": "Dynamics365_Configurations"
9266   },
9267   {
9268     "type": "delete",
9269     "url": "/api/integrations/dynamics365/configurations/{id}",
9270     "title": "Deletes a Dynamics365 Configuration",
9271     "examples": [
9272       {
9273         "title": "Example usage:",
9274         "content": "curl https://{domain}/api/integrations/dynamics365/configurations/{id} -v -u {name}:{password} -X DELETE",
9275         "type": "json"
9276       }
9277     ],
9278     "name": "DeleteDynamics365_Configurations",
9279     "group": "Dynamics365_Configurations",
9280     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9281     "version": "0.0.0",
9282     "filename": "server/api/intDynamics365Configuration/index.js",
9283     "groupTitle": "Dynamics365_Configurations"
9284   },
9285   {
9286     "type": "get",
9287     "url": "/api/integrations/dynamics365/configurations",
9288     "title": "Gets a list of Dynamics365 Configurations",
9289     "examples": [
9290       {
9291         "title": "Example usage:",
9292         "content": "curl https://{domain}/api/integrations/dynamics365/configurations -v -u {name}:{password}",
9293         "type": "json"
9294       }
9295     ],
9296     "name": "GetDynamics365_Configurations",
9297     "group": "Dynamics365_Configurations",
9298     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
9299     "version": "0.0.0",
9300     "filename": "server/api/intDynamics365Configuration/index.js",
9301     "groupTitle": "Dynamics365_Configurations"
9302   },
9303   {
9304     "type": "get",
9305     "url": "/api/integrations/dynamics365/configurations/{id}",
9306     "title": "Gets a single Dynamics365 Configuration",
9307     "examples": [
9308       {
9309         "title": "Example usage:",
9310         "content": "curl https://{domain}/api/integrations/dynamics365/configurations/{id} -v -u {name}:{password}",
9311         "type": "json"
9312       }
9313     ],
9314     "name": "ShowDynamics365_Configurations",
9315     "group": "Dynamics365_Configurations",
9316     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9317     "version": "0.0.0",
9318     "filename": "server/api/intDynamics365Configuration/index.js",
9319     "groupTitle": "Dynamics365_Configurations"
9320   },
9321   {
9322     "type": "get",
9323     "url": "/api/integrations/dynamics365/configurations/{id}/descriptions",
9324     "title": "Gets configurations descriptions",
9325     "examples": [
9326       {
9327         "title": "Example usage:",
9328         "content": "curl https://{domain}/api/integrations/dynamics365/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
9329         "type": "json"
9330       }
9331     ],
9332     "name": "getDescriptions",
9333     "group": "Dynamics365_Configurations",
9334     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9335     "version": "0.0.0",
9336     "filename": "server/api/intDynamics365Configuration/index.js",
9337     "groupTitle": "Dynamics365_Configurations"
9338   },
9339   {
9340     "type": "get",
9341     "url": "/api/integrations/dynamics365/configurations/{id}/fields",
9342     "title": "Gets configurations fields",
9343     "examples": [
9344       {
9345         "title": "Example usage:",
9346         "content": "curl https://{domain}/api/integrations/zoho/configurations/{id}/fields -v -u {name}:{password} -X GET",
9347         "type": "json"
9348       }
9349     ],
9350     "name": "getFields",
9351     "group": "Dynamics365_Configurations",
9352     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9353     "version": "0.0.0",
9354     "filename": "server/api/intDynamics365Configuration/index.js",
9355     "groupTitle": "Dynamics365_Configurations"
9356   },
9357   {
9358     "type": "get",
9359     "url": "/api/integrations/zoho/configurations/{id}/subjects",
9360     "title": "Gets configurations subjects",
9361     "examples": [
9362       {
9363         "title": "Example usage:",
9364         "content": "curl https://{domain}/api/integrations/dynamics365/configurations/{id}/subjects -v -u {name}:{password} -X GET",
9365         "type": "json"
9366       }
9367     ],
9368     "name": "getSubjects",
9369     "group": "Dynamics365_Configurations",
9370     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9371     "version": "0.0.0",
9372     "filename": "server/api/intDynamics365Configuration/index.js",
9373     "groupTitle": "Dynamics365_Configurations"
9374   },
9375   {
9376     "type": "put",
9377     "url": "/api/integrations/dynamics365/configurations/{id}",
9378     "title": "Update an existing Dynamics365 Configuration",
9379     "examples": [
9380       {
9381         "title": "Example usage:",
9382         "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",
9383         "type": "json"
9384       }
9385     ],
9386     "name": "updateDynamics365_Configurations",
9387     "group": "Dynamics365_Configurations",
9388     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9389     "version": "0.0.0",
9390     "filename": "server/api/intDynamics365Configuration/index.js",
9391     "groupTitle": "Dynamics365_Configurations"
9392   },
9393   {
9394     "type": "post",
9395     "url": "/api/integrations/dynamics365/fields",
9396     "title": "Creates a new Dynamics365 Field",
9397     "examples": [
9398       {
9399         "title": "Example usage:",
9400         "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",
9401         "type": "json"
9402       }
9403     ],
9404     "name": "CreateDynamics365_Fields",
9405     "group": "Dynamics365_Fields",
9406     "parameter": {
9407       "fields": {
9408         "Body": [
9409           {
9410             "group": "Body",
9411             "type": "String",
9412             "allowedValues": [
9413               "\"string\"",
9414               "\"variable\"",
9415               "\"customVariable\"",
9416               "\"keyValue\"",
9417               "\"picklist\""
9418             ],
9419             "optional": true,
9420             "field": "type",
9421             "description": ""
9422           },
9423           {
9424             "group": "Body",
9425             "type": "String",
9426             "optional": true,
9427             "field": "content",
9428             "description": ""
9429           },
9430           {
9431             "group": "Body",
9432             "type": "String",
9433             "optional": true,
9434             "field": "key",
9435             "description": ""
9436           },
9437           {
9438             "group": "Body",
9439             "type": "String",
9440             "allowedValues": [
9441               "\"string\"",
9442               "\"variable\"",
9443               "\"customVariable\""
9444             ],
9445             "optional": true,
9446             "field": "keyType",
9447             "description": ""
9448           },
9449           {
9450             "group": "Body",
9451             "type": "String",
9452             "optional": true,
9453             "field": "keyContent",
9454             "description": ""
9455           },
9456           {
9457             "group": "Body",
9458             "type": "String",
9459             "optional": true,
9460             "field": "idField",
9461             "description": ""
9462           },
9463           {
9464             "group": "Body",
9465             "type": "String",
9466             "optional": true,
9467             "field": "nameField",
9468             "description": ""
9469           },
9470           {
9471             "group": "Body",
9472             "type": "Boolean",
9473             "optional": true,
9474             "field": "customField",
9475             "description": ""
9476           },
9477           {
9478             "group": "Body",
9479             "type": "String",
9480             "optional": true,
9481             "field": "variableName",
9482             "description": ""
9483           }
9484         ]
9485       }
9486     },
9487     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9488     "version": "0.0.0",
9489     "filename": "server/api/intDynamics365Field/index.js",
9490     "groupTitle": "Dynamics365_Fields"
9491   },
9492   {
9493     "type": "delete",
9494     "url": "/api/integrations/dynamics365/fields/{id}",
9495     "title": "Deletes a Dynamics365 Field",
9496     "examples": [
9497       {
9498         "title": "Example usage:",
9499         "content": "curl https://{domain}/api/integrations/dynamics365/fields/{id} -v -u {name}:{password} -X DELETE",
9500         "type": "json"
9501       }
9502     ],
9503     "name": "DeleteDynamics365_Fields",
9504     "group": "Dynamics365_Fields",
9505     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9506     "version": "0.0.0",
9507     "filename": "server/api/intDynamics365Field/index.js",
9508     "groupTitle": "Dynamics365_Fields"
9509   },
9510   {
9511     "type": "get",
9512     "url": "/api/integrations/dynamics365/fields",
9513     "title": "Gets a list of Dynamics365 Fields",
9514     "examples": [
9515       {
9516         "title": "Example usage:",
9517         "content": "curl https://{domain}/api/integrations/dynamics365/fields -v -u {name}:{password}",
9518         "type": "json"
9519       }
9520     ],
9521     "name": "GetDynamics365_Fields",
9522     "group": "Dynamics365_Fields",
9523     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
9524     "version": "0.0.0",
9525     "filename": "server/api/intDynamics365Field/index.js",
9526     "groupTitle": "Dynamics365_Fields"
9527   },
9528   {
9529     "type": "get",
9530     "url": "/api/integrations/dynamics365/fields/{id}",
9531     "title": "Gets a single Dynamics365 Field",
9532     "examples": [
9533       {
9534         "title": "Example usage:",
9535         "content": "curl https://{domain}/api/integrations/dynamics365/fields/{id} -v -u {name}:{password}",
9536         "type": "json"
9537       }
9538     ],
9539     "name": "ShowDynamics365_Fields",
9540     "group": "Dynamics365_Fields",
9541     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9542     "version": "0.0.0",
9543     "filename": "server/api/intDynamics365Field/index.js",
9544     "groupTitle": "Dynamics365_Fields"
9545   },
9546   {
9547     "type": "put",
9548     "url": "/api/integrations/dynamics365/fields/{id}",
9549     "title": "Update an existing Dynamics365 Field",
9550     "examples": [
9551       {
9552         "title": "Example usage:",
9553         "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",
9554         "type": "json"
9555       }
9556     ],
9557     "name": "updateDynamics365_Fields",
9558     "group": "Dynamics365_Fields",
9559     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9560     "version": "0.0.0",
9561     "filename": "server/api/intDynamics365Field/index.js",
9562     "groupTitle": "Dynamics365_Fields"
9563   },
9564   {
9565     "type": "post",
9566     "url": "/api/fax/accounts/{id}/users",
9567     "title": "Add agents to a fax account",
9568     "examples": [
9569       {
9570         "title": "Example usage:",
9571         "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",
9572         "type": "json"
9573       }
9574     ],
9575     "name": "AddAgents",
9576     "group": "Fax_Accounts",
9577     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9578     "version": "0.0.0",
9579     "filename": "server/api/faxAccount/index.js",
9580     "groupTitle": "Fax_Accounts"
9581   },
9582   {
9583     "type": "post",
9584     "url": "/api/fax/accounts",
9585     "title": "Creates a new Account",
9586     "examples": [
9587       {
9588         "title": "Example usage:",
9589         "content": "curl https://{domain}/api/fax/accounts -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
9590         "type": "json"
9591       }
9592     ],
9593     "name": "CreateAccounts",
9594     "group": "Fax_Accounts",
9595     "parameter": {
9596       "fields": {
9597         "Body": [
9598           {
9599             "group": "Body",
9600             "type": "String",
9601             "optional": false,
9602             "field": "name",
9603             "description": ""
9604           },
9605           {
9606             "group": "Body",
9607             "type": "String",
9608             "optional": true,
9609             "field": "description",
9610             "description": ""
9611           },
9612           {
9613             "group": "Body",
9614             "type": "String",
9615             "allowedValues": [
9616               "\"yes\"",
9617               "\"no\""
9618             ],
9619             "optional": true,
9620             "field": "ecm",
9621             "description": ""
9622           },
9623           {
9624             "group": "Body",
9625             "type": "String",
9626             "optional": true,
9627             "field": "headerinfo",
9628             "description": ""
9629           },
9630           {
9631             "group": "Body",
9632             "type": "String",
9633             "optional": true,
9634             "field": "localstationid",
9635             "description": ""
9636           },
9637           {
9638             "group": "Body",
9639             "type": "String",
9640             "allowedValues": [
9641               "\"2400\"",
9642               "\"4800\"",
9643               "\"7200\"",
9644               "\"9600\"",
9645               "\"12000\"",
9646               "\"14400\""
9647             ],
9648             "optional": true,
9649             "field": "minrate",
9650             "description": ""
9651           },
9652           {
9653             "group": "Body",
9654             "type": "String",
9655             "allowedValues": [
9656               "\"2400\"",
9657               "\"4800\"",
9658               "\"7200\"",
9659               "\"9600\"",
9660               "\"12000\"",
9661               "\"14400\""
9662             ],
9663             "optional": true,
9664             "field": "maxrate",
9665             "description": ""
9666           },
9667           {
9668             "group": "Body",
9669             "type": "String",
9670             "optional": true,
9671             "field": "modem",
9672             "description": ""
9673           },
9674           {
9675             "group": "Body",
9676             "type": "String",
9677             "optional": true,
9678             "field": "gateway",
9679             "description": ""
9680           },
9681           {
9682             "group": "Body",
9683             "type": "String",
9684             "optional": true,
9685             "field": "faxdetect",
9686             "description": ""
9687           },
9688           {
9689             "group": "Body",
9690             "type": "Integer",
9691             "optional": true,
9692             "field": "t38timeout",
9693             "description": ""
9694           },
9695           {
9696             "group": "Body",
9697             "type": "String",
9698             "allowedValues": [
9699               "\"SIP\"",
9700               "\"IAX\"",
9701               "\"DADHI\"",
9702               "\"KHOMP\""
9703             ],
9704             "optional": true,
9705             "field": "tech",
9706             "description": ""
9707           },
9708           {
9709             "group": "Body",
9710             "type": "String",
9711             "optional": false,
9712             "field": "key",
9713             "description": ""
9714           },
9715           {
9716             "group": "Body",
9717             "type": "Text",
9718             "optional": true,
9719             "field": "notificationTemplate",
9720             "description": ""
9721           },
9722           {
9723             "group": "Body",
9724             "type": "Boolean",
9725             "optional": true,
9726             "field": "notificationSound",
9727             "description": ""
9728           },
9729           {
9730             "group": "Body",
9731             "type": "Boolean",
9732             "optional": true,
9733             "field": "notificationShake",
9734             "description": ""
9735           },
9736           {
9737             "group": "Body",
9738             "type": "Integer",
9739             "optional": true,
9740             "field": "waitForTheAssignedAgent",
9741             "description": ""
9742           },
9743           {
9744             "group": "Body",
9745             "type": "Boolean",
9746             "optional": true,
9747             "field": "queueTransfer",
9748             "description": ""
9749           },
9750           {
9751             "group": "Body",
9752             "type": "Integer",
9753             "optional": true,
9754             "field": "queueTransferTimeout",
9755             "description": ""
9756           },
9757           {
9758             "group": "Body",
9759             "type": "Boolean",
9760             "optional": true,
9761             "field": "agentTransfer",
9762             "description": ""
9763           },
9764           {
9765             "group": "Body",
9766             "type": "Integer",
9767             "optional": true,
9768             "field": "agentTransferTimeout",
9769             "description": ""
9770           },
9771           {
9772             "group": "Body",
9773             "type": "Integer",
9774             "optional": true,
9775             "field": "mandatoryDispositionPauseId",
9776             "description": "<p>Status to put when mandatory disposition is enabled</p>"
9777           },
9778           {
9779             "group": "Body",
9780             "type": "Boolean",
9781             "optional": true,
9782             "field": "mandatoryDisposition",
9783             "description": "<p>Enabled/disables mandatory dispo on a queue</p>"
9784           }
9785         ]
9786       }
9787     },
9788     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9789     "version": "0.0.0",
9790     "filename": "server/api/faxAccount/index.js",
9791     "groupTitle": "Fax_Accounts"
9792   },
9793   {
9794     "type": "delete",
9795     "url": "/api/fax/accounts/{id}",
9796     "title": "Deletes a Account",
9797     "examples": [
9798       {
9799         "title": "Example usage:",
9800         "content": "curl https://{domain}/api/fax/accounts/{id} -v -u {name}:{password} -X DELETE",
9801         "type": "json"
9802       }
9803     ],
9804     "name": "DeleteAccounts",
9805     "group": "Fax_Accounts",
9806     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9807     "version": "0.0.0",
9808     "filename": "server/api/faxAccount/index.js",
9809     "groupTitle": "Fax_Accounts"
9810   },
9811   {
9812     "type": "get",
9813     "url": "/api/fax/accounts/describe",
9814     "title": "Gets table info about Accounts",
9815     "examples": [
9816       {
9817         "title": "Example usage:",
9818         "content": "curl https://{domain}/api/fax/accounts/describe -v -u {name}:{password}",
9819         "type": "json"
9820       }
9821     ],
9822     "name": "DescribeAccounts",
9823     "group": "Fax_Accounts",
9824     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9825     "version": "0.0.0",
9826     "filename": "server/api/faxAccount/index.js",
9827     "groupTitle": "Fax_Accounts"
9828   },
9829   {
9830     "type": "get",
9831     "url": "/api/fax/accounts",
9832     "title": "Gets a list of Accounts",
9833     "examples": [
9834       {
9835         "title": "Example usage:",
9836         "content": "curl https://{domain}/api/fax/accounts -v -u {name}:{password}",
9837         "type": "json"
9838       }
9839     ],
9840     "name": "GetAccounts",
9841     "group": "Fax_Accounts",
9842     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
9843     "version": "0.0.0",
9844     "filename": "server/api/faxAccount/index.js",
9845     "groupTitle": "Fax_Accounts"
9846   },
9847   {
9848     "type": "get",
9849     "url": "/api/fax/accounts/{id}/users",
9850     "title": "Gets agents from fax account",
9851     "examples": [
9852       {
9853         "title": "Example usage:",
9854         "content": "curl https://{domain}/api/fax/accounts/{id}/users -v -u {name}:{password} -X GET",
9855         "type": "json"
9856       }
9857     ],
9858     "name": "GetAgents",
9859     "group": "Fax_Accounts",
9860     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9861     "version": "0.0.0",
9862     "filename": "server/api/faxAccount/index.js",
9863     "groupTitle": "Fax_Accounts"
9864   },
9865   {
9866     "type": "delete",
9867     "url": "/api/fax/accounts/{id}/users",
9868     "title": "Removes agents from a fax account",
9869     "examples": [
9870       {
9871         "title": "Example usage:",
9872         "content": "curl https://{domain}/api/fax/accounts/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
9873         "type": "json"
9874       }
9875     ],
9876     "name": "RemoveAgents",
9877     "group": "Fax_Accounts",
9878     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9879     "version": "0.0.0",
9880     "filename": "server/api/faxAccount/index.js",
9881     "groupTitle": "Fax_Accounts"
9882   },
9883   {
9884     "type": "delete",
9885     "url": "/api/fax/accounts/{id}/canned_answers",
9886     "title": "Removes canned answers from account",
9887     "examples": [
9888       {
9889         "title": "Example usage:",
9890         "content": "curl https://{domain}/api/fax/accounts/{id}/canned_answers?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
9891         "type": "json"
9892       }
9893     ],
9894     "name": "RemoveAnswers",
9895     "group": "Fax_Accounts",
9896     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9897     "version": "0.0.0",
9898     "filename": "server/api/faxAccount/index.js",
9899     "groupTitle": "Fax_Accounts"
9900   },
9901   {
9902     "type": "delete",
9903     "url": "/api/fax/accounts/{id}/dispositions",
9904     "title": "Removes dispositions from account",
9905     "examples": [
9906       {
9907         "title": "Example usage:",
9908         "content": "curl https://{domain}/api/fax/accounts/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
9909         "type": "json"
9910       }
9911     ],
9912     "name": "RemoveDispositions",
9913     "group": "Fax_Accounts",
9914     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9915     "version": "0.0.0",
9916     "filename": "server/api/faxAccount/index.js",
9917     "groupTitle": "Fax_Accounts"
9918   },
9919   {
9920     "type": "get",
9921     "url": "/api/fax/accounts/{id}",
9922     "title": "Gets a single Account",
9923     "examples": [
9924       {
9925         "title": "Example usage:",
9926         "content": "curl https://{domain}/api/fax/accounts/{id} -v -u {name}:{password}",
9927         "type": "json"
9928       }
9929     ],
9930     "name": "ShowAccounts",
9931     "group": "Fax_Accounts",
9932     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9933     "version": "0.0.0",
9934     "filename": "server/api/faxAccount/index.js",
9935     "groupTitle": "Fax_Accounts"
9936   },
9937   {
9938     "type": "post",
9939     "url": "/api/fax/accounts/{id}/canned_answers",
9940     "title": "Creates new canned answer",
9941     "examples": [
9942       {
9943         "title": "Example usage:",
9944         "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",
9945         "type": "json"
9946       }
9947     ],
9948     "name": "addAnswer",
9949     "group": "Fax_Accounts",
9950     "parameter": {
9951       "fields": {
9952         "Body": [
9953           {
9954             "group": "Body",
9955             "type": "String",
9956             "optional": false,
9957             "field": "key",
9958             "description": ""
9959           },
9960           {
9961             "group": "Body",
9962             "type": "Text",
9963             "optional": false,
9964             "field": "value",
9965             "description": ""
9966           },
9967           {
9968             "group": "Body",
9969             "type": "String",
9970             "optional": true,
9971             "field": "description",
9972             "description": ""
9973           },
9974           {
9975             "group": "Body",
9976             "type": "Virtual",
9977             "optional": true,
9978             "field": "name",
9979             "description": ""
9980           }
9981         ]
9982       }
9983     },
9984     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9985     "version": "0.0.0",
9986     "filename": "server/api/faxAccount/index.js",
9987     "groupTitle": "Fax_Accounts"
9988   },
9989   {
9990     "type": "post",
9991     "url": "/api/fax/accounts/{id}/applications",
9992     "title": "Creates new applications",
9993     "examples": [
9994       {
9995         "title": "Example usage:",
9996         "content": "curl https://{domain}/api/fax/accounts/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
9997         "type": "json"
9998       }
9999     ],
10000     "name": "addApplications",
10001     "group": "Fax_Accounts",
10002     "parameter": {
10003       "fields": {
10004         "Body": [
10005           {
10006             "group": "Body",
10007             "type": "Integer",
10008             "optional": false,
10009             "field": "priority",
10010             "description": ""
10011           },
10012           {
10013             "group": "Body",
10014             "type": "String",
10015             "optional": false,
10016             "field": "app",
10017             "description": ""
10018           },
10019           {
10020             "group": "Body",
10021             "type": "Text",
10022             "optional": true,
10023             "field": "appdata",
10024             "description": ""
10025           },
10026           {
10027             "group": "Body",
10028             "type": "String",
10029             "optional": true,
10030             "field": "description",
10031             "description": ""
10032           },
10033           {
10034             "group": "Body",
10035             "type": "String",
10036             "optional": true,
10037             "field": "interval",
10038             "description": ""
10039           }
10040         ]
10041       }
10042     },
10043     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10044     "version": "0.0.0",
10045     "filename": "server/api/faxAccount/index.js",
10046     "groupTitle": "Fax_Accounts"
10047   },
10048   {
10049     "type": "post",
10050     "url": "/api/fax/accounts/addaccountapplications",
10051     "title": "Creates new account and applications",
10052     "examples": [
10053       {
10054         "title": "Example usage:",
10055         "content": "curl https://{domain}/api/fax/accounts/addaccountapplications -d '[{\"name\": \"name\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
10056         "type": "json"
10057       }
10058     ],
10059     "name": "addApplications",
10060     "group": "Fax_Accounts",
10061     "parameter": {
10062       "fields": {
10063         "Body": [
10064           {
10065             "group": "Body",
10066             "type": "Integer",
10067             "optional": false,
10068             "field": "priority",
10069             "description": ""
10070           },
10071           {
10072             "group": "Body",
10073             "type": "String",
10074             "optional": false,
10075             "field": "app",
10076             "description": ""
10077           },
10078           {
10079             "group": "Body",
10080             "type": "Text",
10081             "optional": true,
10082             "field": "appdata",
10083             "description": ""
10084           },
10085           {
10086             "group": "Body",
10087             "type": "String",
10088             "optional": true,
10089             "field": "description",
10090             "description": ""
10091           },
10092           {
10093             "group": "Body",
10094             "type": "String",
10095             "optional": true,
10096             "field": "interval",
10097             "description": ""
10098           }
10099         ]
10100       }
10101     },
10102     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10103     "version": "0.0.0",
10104     "filename": "server/api/faxAccount/index.js",
10105     "groupTitle": "Fax_Accounts"
10106   },
10107   {
10108     "type": "post",
10109     "url": "/api/fax/accounts/{id}/dispositions",
10110     "title": "Creates new disposition",
10111     "examples": [
10112       {
10113         "title": "Example usage:",
10114         "content": "curl https://{domain}/api/fax/accounts/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
10115         "type": "json"
10116       }
10117     ],
10118     "name": "addDisposition",
10119     "group": "Fax_Accounts",
10120     "parameter": {
10121       "fields": {
10122         "Body": [
10123           {
10124             "group": "Body",
10125             "type": "String",
10126             "optional": false,
10127             "field": "name",
10128             "description": ""
10129           },
10130           {
10131             "group": "Body",
10132             "type": "String",
10133             "allowedValues": [
10134               "\"first\"",
10135               "\"second\"",
10136               "\"third\""
10137             ],
10138             "optional": false,
10139             "field": "level",
10140             "description": ""
10141           },
10142           {
10143             "group": "Body",
10144             "type": "String",
10145             "optional": true,
10146             "field": "description",
10147             "description": ""
10148           }
10149         ]
10150       }
10151     },
10152     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10153     "version": "0.0.0",
10154     "filename": "server/api/faxAccount/index.js",
10155     "groupTitle": "Fax_Accounts"
10156   },
10157   {
10158     "type": "post",
10159     "url": "/api/fax/accounts/{id}/interactions",
10160     "title": "Creates new interactions",
10161     "examples": [
10162       {
10163         "title": "Example usage:",
10164         "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",
10165         "type": "json"
10166       }
10167     ],
10168     "name": "addInteraction",
10169     "group": "Fax_Accounts",
10170     "parameter": {
10171       "fields": {
10172         "Body": [
10173           {
10174             "group": "Body",
10175             "type": "Boolean",
10176             "optional": true,
10177             "field": "closed",
10178             "description": ""
10179           },
10180           {
10181             "group": "Body",
10182             "type": "String",
10183             "optional": true,
10184             "field": "closedAt",
10185             "description": ""
10186           },
10187           {
10188             "group": "Body",
10189             "type": "String",
10190             "optional": true,
10191             "field": "disposition",
10192             "description": ""
10193           },
10194           {
10195             "group": "Body",
10196             "type": "String",
10197             "optional": true,
10198             "field": "secondDisposition",
10199             "description": ""
10200           },
10201           {
10202             "group": "Body",
10203             "type": "String",
10204             "optional": true,
10205             "field": "thirdDisposition",
10206             "description": ""
10207           },
10208           {
10209             "group": "Body",
10210             "type": "String",
10211             "optional": true,
10212             "field": "note",
10213             "description": ""
10214           },
10215           {
10216             "group": "Body",
10217             "type": "String",
10218             "optional": true,
10219             "field": "read1stAt",
10220             "description": ""
10221           },
10222           {
10223             "group": "Body",
10224             "type": "String",
10225             "optional": true,
10226             "field": "fax",
10227             "description": ""
10228           },
10229           {
10230             "group": "Body",
10231             "type": "String",
10232             "allowedValues": [
10233               "\"in\"",
10234               "\"out\""
10235             ],
10236             "optional": false,
10237             "field": "firstMsgDirection",
10238             "description": ""
10239           },
10240           {
10241             "group": "Body",
10242             "type": "String",
10243             "optional": true,
10244             "field": "lastMsgAt",
10245             "description": ""
10246           },
10247           {
10248             "group": "Body",
10249             "type": "String",
10250             "allowedValues": [
10251               "\"in\"",
10252               "\"out\""
10253             ],
10254             "optional": false,
10255             "field": "lastMsgDirection",
10256             "description": ""
10257           }
10258         ]
10259       }
10260     },
10261     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10262     "version": "0.0.0",
10263     "filename": "server/api/faxAccount/index.js",
10264     "groupTitle": "Fax_Accounts"
10265   },
10266   {
10267     "type": "get",
10268     "url": "/api/fax/accounts/{id}/canned_answers",
10269     "title": "Gets account canned answers",
10270     "examples": [
10271       {
10272         "title": "Example usage:",
10273         "content": "curl https://{domain}/api/fax/accounts/{id}/canned_answers -v -u {name}:{password} -X GET",
10274         "type": "json"
10275       }
10276     ],
10277     "name": "getAnswers",
10278     "group": "Fax_Accounts",
10279     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10280     "version": "0.0.0",
10281     "filename": "server/api/faxAccount/index.js",
10282     "groupTitle": "Fax_Accounts"
10283   },
10284   {
10285     "type": "get",
10286     "url": "/api/fax/accounts/{id}/applications",
10287     "title": "Gets account pplications",
10288     "examples": [
10289       {
10290         "title": "Example usage:",
10291         "content": "curl https://{domain}/api/fax/accounts/{id}/applications -v -u {name}:{password} -X GET",
10292         "type": "json"
10293       }
10294     ],
10295     "name": "getApplications",
10296     "group": "Fax_Accounts",
10297     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10298     "version": "0.0.0",
10299     "filename": "server/api/faxAccount/index.js",
10300     "groupTitle": "Fax_Accounts"
10301   },
10302   {
10303     "type": "get",
10304     "url": "/api/fax/accounts/{id}/dispositions",
10305     "title": "Gets account dispositions",
10306     "examples": [
10307       {
10308         "title": "Example usage:",
10309         "content": "curl https://{domain}/api/fax/accounts/{id}/dispositions -v -u {name}:{password} -X GET",
10310         "type": "json"
10311       }
10312     ],
10313     "name": "getDispositions",
10314     "group": "Fax_Accounts",
10315     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10316     "version": "0.0.0",
10317     "filename": "server/api/faxAccount/index.js",
10318     "groupTitle": "Fax_Accounts"
10319   },
10320   {
10321     "type": "get",
10322     "url": "/api/fax/accounts/{id}/interactions",
10323     "title": "Gets account interactions",
10324     "examples": [
10325       {
10326         "title": "Example usage:",
10327         "content": "curl https://{domain}/api/fax/accounts/{id}/interactions -v -u {name}:{password} -X GET",
10328         "type": "json"
10329       }
10330     ],
10331     "name": "getInteraction",
10332     "group": "Fax_Accounts",
10333     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10334     "version": "0.0.0",
10335     "filename": "server/api/faxAccount/index.js",
10336     "groupTitle": "Fax_Accounts"
10337   },
10338   {
10339     "type": "get",
10340     "url": "/api/fax/accounts/{id}/messages",
10341     "title": "Gets account messages",
10342     "examples": [
10343       {
10344         "title": "Example usage:",
10345         "content": "curl https://{domain}/api/fax/accounts/{id}/messages -v -u {name}:{password} -X GET",
10346         "type": "json"
10347       }
10348     ],
10349     "name": "getMessages",
10350     "group": "Fax_Accounts",
10351     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10352     "version": "0.0.0",
10353     "filename": "server/api/faxAccount/index.js",
10354     "groupTitle": "Fax_Accounts"
10355   },
10356   {
10357     "type": "post",
10358     "url": "/api/fax/accounts/{id}/send",
10359     "title": "Send new fax",
10360     "examples": [
10361       {
10362         "title": "Example usage:",
10363         "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",
10364         "type": "json"
10365       }
10366     ],
10367     "name": "sendFax",
10368     "group": "Fax_Accounts",
10369     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10370     "version": "0.0.0",
10371     "filename": "server/api/faxAccount/index.js",
10372     "groupTitle": "Fax_Accounts"
10373   },
10374   {
10375     "type": "put",
10376     "url": "/api/fax/accounts/{id}",
10377     "title": "Update an existing Account",
10378     "examples": [
10379       {
10380         "title": "Example usage:",
10381         "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",
10382         "type": "json"
10383       }
10384     ],
10385     "name": "updateAccounts",
10386     "group": "Fax_Accounts",
10387     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10388     "version": "0.0.0",
10389     "filename": "server/api/faxAccount/index.js",
10390     "groupTitle": "Fax_Accounts"
10391   },
10392   {
10393     "type": "post",
10394     "url": "/api/fax/accounts/updateaccountapplications",
10395     "title": "Update account and applications",
10396     "examples": [
10397       {
10398         "title": "Example usage:",
10399         "content": "curl https://{domain}/api/fax/accounts/updateaccountapplications -d '[{\"name\": \"name\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
10400         "type": "json"
10401       }
10402     ],
10403     "name": "updateApplications",
10404     "group": "Fax_Accounts",
10405     "parameter": {
10406       "fields": {
10407         "Body": [
10408           {
10409             "group": "Body",
10410             "type": "Integer",
10411             "optional": false,
10412             "field": "priority",
10413             "description": ""
10414           },
10415           {
10416             "group": "Body",
10417             "type": "String",
10418             "optional": false,
10419             "field": "app",
10420             "description": ""
10421           },
10422           {
10423             "group": "Body",
10424             "type": "Text",
10425             "optional": true,
10426             "field": "appdata",
10427             "description": ""
10428           },
10429           {
10430             "group": "Body",
10431             "type": "String",
10432             "optional": true,
10433             "field": "description",
10434             "description": ""
10435           },
10436           {
10437             "group": "Body",
10438             "type": "String",
10439             "optional": true,
10440             "field": "interval",
10441             "description": ""
10442           }
10443         ]
10444       }
10445     },
10446     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10447     "version": "0.0.0",
10448     "filename": "server/api/faxAccount/index.js",
10449     "groupTitle": "Fax_Accounts"
10450   },
10451   {
10452     "type": "post",
10453     "url": "/api/fax/applications",
10454     "title": "Creates a new Application",
10455     "examples": [
10456       {
10457         "title": "Example usage:",
10458         "content": "curl https://{domain}/api/fax/applications -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
10459         "type": "json"
10460       }
10461     ],
10462     "name": "CreateApplications",
10463     "group": "Fax_Applications",
10464     "parameter": {
10465       "fields": {
10466         "Body": [
10467           {
10468             "group": "Body",
10469             "type": "Integer",
10470             "optional": false,
10471             "field": "priority",
10472             "description": ""
10473           },
10474           {
10475             "group": "Body",
10476             "type": "String",
10477             "optional": false,
10478             "field": "app",
10479             "description": ""
10480           },
10481           {
10482             "group": "Body",
10483             "type": "Text",
10484             "optional": true,
10485             "field": "appdata",
10486             "description": ""
10487           },
10488           {
10489             "group": "Body",
10490             "type": "String",
10491             "optional": true,
10492             "field": "description",
10493             "description": ""
10494           },
10495           {
10496             "group": "Body",
10497             "type": "String",
10498             "optional": true,
10499             "field": "interval",
10500             "description": ""
10501           }
10502         ]
10503       }
10504     },
10505     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10506     "version": "0.0.0",
10507     "filename": "server/api/faxApplication/index.js",
10508     "groupTitle": "Fax_Applications"
10509   },
10510   {
10511     "type": "delete",
10512     "url": "/api/fax/applications/{id}",
10513     "title": "Deletes a Application",
10514     "examples": [
10515       {
10516         "title": "Example usage:",
10517         "content": "curl https://{domain}/api/fax/applications/{id} -v -u {name}:{password} -X DELETE",
10518         "type": "json"
10519       }
10520     ],
10521     "name": "DeleteApplications",
10522     "group": "Fax_Applications",
10523     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10524     "version": "0.0.0",
10525     "filename": "server/api/faxApplication/index.js",
10526     "groupTitle": "Fax_Applications"
10527   },
10528   {
10529     "type": "get",
10530     "url": "/api/fax/applications",
10531     "title": "Gets a list of Applications",
10532     "examples": [
10533       {
10534         "title": "Example usage:",
10535         "content": "curl https://{domain}/api/fax/applications -v -u {name}:{password}",
10536         "type": "json"
10537       }
10538     ],
10539     "name": "GetApplications",
10540     "group": "Fax_Applications",
10541     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
10542     "version": "0.0.0",
10543     "filename": "server/api/faxApplication/index.js",
10544     "groupTitle": "Fax_Applications"
10545   },
10546   {
10547     "type": "get",
10548     "url": "/api/fax/applications/{id}",
10549     "title": "Gets a single Application",
10550     "examples": [
10551       {
10552         "title": "Example usage:",
10553         "content": "curl https://{domain}/api/fax/applications/{id} -v -u {name}:{password}",
10554         "type": "json"
10555       }
10556     ],
10557     "name": "ShowApplications",
10558     "group": "Fax_Applications",
10559     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10560     "version": "0.0.0",
10561     "filename": "server/api/faxApplication/index.js",
10562     "groupTitle": "Fax_Applications"
10563   },
10564   {
10565     "type": "put",
10566     "url": "/api/fax/applications/{id}",
10567     "title": "Update an existing Application",
10568     "examples": [
10569       {
10570         "title": "Example usage:",
10571         "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",
10572         "type": "json"
10573       }
10574     ],
10575     "name": "updateApplications",
10576     "group": "Fax_Applications",
10577     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10578     "version": "0.0.0",
10579     "filename": "server/api/faxApplication/index.js",
10580     "groupTitle": "Fax_Applications"
10581   },
10582   {
10583     "type": "post",
10584     "url": "/api/fax/interactions/{id}/tags",
10585     "title": "Add tags to the interaction",
10586     "examples": [
10587       {
10588         "title": "Example usage:",
10589         "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",
10590         "type": "json"
10591       }
10592     ],
10593     "name": "AddTags",
10594     "group": "Fax_Interactions",
10595     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10596     "version": "0.0.0",
10597     "filename": "server/api/faxInteraction/index.js",
10598     "groupTitle": "Fax_Interactions"
10599   },
10600   {
10601     "type": "post",
10602     "url": "/api/fax/interactions",
10603     "title": "Creates a new Interaction",
10604     "examples": [
10605       {
10606         "title": "Example usage:",
10607         "content": "curl https://{domain}/api/fax/interactions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
10608         "type": "json"
10609       }
10610     ],
10611     "name": "CreateInteractions",
10612     "group": "Fax_Interactions",
10613     "parameter": {
10614       "fields": {
10615         "Body": [
10616           {
10617             "group": "Body",
10618             "type": "Boolean",
10619             "optional": true,
10620             "field": "closed",
10621             "description": ""
10622           },
10623           {
10624             "group": "Body",
10625             "type": "String",
10626             "optional": true,
10627             "field": "closedAt",
10628             "description": ""
10629           },
10630           {
10631             "group": "Body",
10632             "type": "String",
10633             "optional": true,
10634             "field": "disposition",
10635             "description": ""
10636           },
10637           {
10638             "group": "Body",
10639             "type": "String",
10640             "optional": true,
10641             "field": "secondDisposition",
10642             "description": ""
10643           },
10644           {
10645             "group": "Body",
10646             "type": "String",
10647             "optional": true,
10648             "field": "thirdDisposition",
10649             "description": ""
10650           },
10651           {
10652             "group": "Body",
10653             "type": "String",
10654             "optional": true,
10655             "field": "note",
10656             "description": ""
10657           },
10658           {
10659             "group": "Body",
10660             "type": "String",
10661             "optional": true,
10662             "field": "read1stAt",
10663             "description": ""
10664           },
10665           {
10666             "group": "Body",
10667             "type": "String",
10668             "optional": true,
10669             "field": "fax",
10670             "description": ""
10671           },
10672           {
10673             "group": "Body",
10674             "type": "String",
10675             "allowedValues": [
10676               "\"in\"",
10677               "\"out\""
10678             ],
10679             "optional": false,
10680             "field": "firstMsgDirection",
10681             "description": ""
10682           },
10683           {
10684             "group": "Body",
10685             "type": "String",
10686             "optional": true,
10687             "field": "lastMsgAt",
10688             "description": ""
10689           },
10690           {
10691             "group": "Body",
10692             "type": "String",
10693             "allowedValues": [
10694               "\"in\"",
10695               "\"out\""
10696             ],
10697             "optional": false,
10698             "field": "lastMsgDirection",
10699             "description": ""
10700           }
10701         ]
10702       }
10703     },
10704     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10705     "version": "0.0.0",
10706     "filename": "server/api/faxInteraction/index.js",
10707     "groupTitle": "Fax_Interactions"
10708   },
10709   {
10710     "type": "delete",
10711     "url": "/api/fax/interactions/{id}",
10712     "title": "Deletes a Interaction",
10713     "examples": [
10714       {
10715         "title": "Example usage:",
10716         "content": "curl https://{domain}/api/fax/interactions/{id} -v -u {name}:{password} -X DELETE",
10717         "type": "json"
10718       }
10719     ],
10720     "name": "DeleteInteractions",
10721     "group": "Fax_Interactions",
10722     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10723     "version": "0.0.0",
10724     "filename": "server/api/faxInteraction/index.js",
10725     "groupTitle": "Fax_Interactions"
10726   },
10727   {
10728     "type": "get",
10729     "url": "/api/fax/interactions/describe",
10730     "title": "Gets table info about Interactions",
10731     "examples": [
10732       {
10733         "title": "Example usage:",
10734         "content": "curl https://{domain}/api/fax/interactions/describe -v -u {name}:{password}",
10735         "type": "json"
10736       }
10737     ],
10738     "name": "DescribeInteractions",
10739     "group": "Fax_Interactions",
10740     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10741     "version": "0.0.0",
10742     "filename": "server/api/faxInteraction/index.js",
10743     "groupTitle": "Fax_Interactions"
10744   },
10745   {
10746     "type": "get",
10747     "url": "/api/fax/interactions",
10748     "title": "Gets a list of Interactions",
10749     "examples": [
10750       {
10751         "title": "Example usage:",
10752         "content": "curl https://{domain}/api/fax/interactions -v -u {name}:{password}",
10753         "type": "json"
10754       }
10755     ],
10756     "name": "GetInteractions",
10757     "group": "Fax_Interactions",
10758     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
10759     "version": "0.0.0",
10760     "filename": "server/api/faxInteraction/index.js",
10761     "groupTitle": "Fax_Interactions"
10762   },
10763   {
10764     "type": "delete",
10765     "url": "/api/fax/interactions/{id}/tags",
10766     "title": "Removes tags from interaction",
10767     "examples": [
10768       {
10769         "title": "Example usage:",
10770         "content": "curl https://{domain}/api/fax/interactions/{id}/tags?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
10771         "type": "json"
10772       }
10773     ],
10774     "name": "RemoveTags",
10775     "group": "Fax_Interactions",
10776     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10777     "version": "0.0.0",
10778     "filename": "server/api/faxInteraction/index.js",
10779     "groupTitle": "Fax_Interactions"
10780   },
10781   {
10782     "type": "get",
10783     "url": "/api/fax/interactions/{id}",
10784     "title": "Gets a single Interaction",
10785     "examples": [
10786       {
10787         "title": "Example usage:",
10788         "content": "curl https://{domain}/api/fax/interactions/{id} -v -u {name}:{password}",
10789         "type": "json"
10790       }
10791     ],
10792     "name": "ShowInteractions",
10793     "group": "Fax_Interactions",
10794     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10795     "version": "0.0.0",
10796     "filename": "server/api/faxInteraction/index.js",
10797     "groupTitle": "Fax_Interactions"
10798   },
10799   {
10800     "type": "post",
10801     "url": "/api/fax/interactions/{id}/messages",
10802     "title": "Creates new messages",
10803     "examples": [
10804       {
10805         "title": "Example usage:",
10806         "content": "curl https://{domain}/api/fax/interactions/{id}/messages -d '[{\"to\": \"+3901119886500\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
10807         "type": "json"
10808       }
10809     ],
10810     "name": "addMessage",
10811     "group": "Fax_Interactions",
10812     "parameter": {
10813       "fields": {
10814         "Body": [
10815           {
10816             "group": "Body",
10817             "type": "Text",
10818             "optional": false,
10819             "field": "body",
10820             "description": ""
10821           },
10822           {
10823             "group": "Body",
10824             "type": "Boolean",
10825             "optional": true,
10826             "field": "read",
10827             "description": ""
10828           },
10829           {
10830             "group": "Body",
10831             "type": "String",
10832             "allowedValues": [
10833               "\"in\"",
10834               "\"out\""
10835             ],
10836             "optional": false,
10837             "field": "direction",
10838             "description": ""
10839           },
10840           {
10841             "group": "Body",
10842             "type": "Text",
10843             "optional": true,
10844             "field": "failMessage",
10845             "description": ""
10846           },
10847           {
10848             "group": "Body",
10849             "type": "String",
10850             "optional": true,
10851             "field": "readAt",
10852             "description": ""
10853           }
10854         ]
10855       }
10856     },
10857     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10858     "version": "0.0.0",
10859     "filename": "server/api/faxInteraction/index.js",
10860     "groupTitle": "Fax_Interactions"
10861   },
10862   {
10863     "type": "get",
10864     "url": "/api/fax/interactions/{id}/download",
10865     "title": "Get interactions",
10866     "examples": [
10867       {
10868         "title": "Example usage:",
10869         "content": "curl https://{domain}/api/fax/interactions/{id}/download -v -u {name}:{password} -X GET",
10870         "type": "json"
10871       }
10872     ],
10873     "name": "download",
10874     "group": "Fax_Interactions",
10875     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10876     "version": "0.0.0",
10877     "filename": "server/api/faxInteraction/index.js",
10878     "groupTitle": "Fax_Interactions"
10879   },
10880   {
10881     "type": "get",
10882     "url": "/api/fax/interactions/{id}/messages",
10883     "title": "Gets interaction messages",
10884     "examples": [
10885       {
10886         "title": "Example usage:",
10887         "content": "curl https://{domain}/api/fax/interactions/{id}/messages -v -u {name}:{password} -X GET",
10888         "type": "json"
10889       }
10890     ],
10891     "name": "getMessages",
10892     "group": "Fax_Interactions",
10893     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10894     "version": "0.0.0",
10895     "filename": "server/api/faxInteraction/index.js",
10896     "groupTitle": "Fax_Interactions"
10897   },
10898   {
10899     "type": "put",
10900     "url": "/api/fax/interactions/{id}",
10901     "title": "Update an existing Interaction",
10902     "examples": [
10903       {
10904         "title": "Example usage:",
10905         "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",
10906         "type": "json"
10907       }
10908     ],
10909     "name": "updateInteractions",
10910     "group": "Fax_Interactions",
10911     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10912     "version": "0.0.0",
10913     "filename": "server/api/faxInteraction/index.js",
10914     "groupTitle": "Fax_Interactions"
10915   },
10916   {
10917     "type": "get",
10918     "url": "/api/fax/messages/{id}/download",
10919     "title": "Get message",
10920     "examples": [
10921       {
10922         "title": "Example usage:",
10923         "content": "curl https://{domain}/api/fax/messages/{id}/download -v -u {name}:{password} -X GET",
10924         "type": "json"
10925       }
10926     ],
10927     "name": "download",
10928     "group": "Fax_Message",
10929     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10930     "version": "0.0.0",
10931     "filename": "server/api/faxMessage/index.js",
10932     "groupTitle": "Fax_Message"
10933   },
10934   {
10935     "type": "delete",
10936     "url": "/api/fax/messages/{id}",
10937     "title": "Deletes a Message",
10938     "examples": [
10939       {
10940         "title": "Example usage:",
10941         "content": "curl https://{domain}/api/fax/messages/{id} -v -u {name}:{password} -X DELETE",
10942         "type": "json"
10943       }
10944     ],
10945     "name": "DeleteMessages",
10946     "group": "Fax_Messages",
10947     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10948     "version": "0.0.0",
10949     "filename": "server/api/faxMessage/index.js",
10950     "groupTitle": "Fax_Messages"
10951   },
10952   {
10953     "type": "get",
10954     "url": "/api/fax/messages/describe",
10955     "title": "Gets table info about Messages",
10956     "examples": [
10957       {
10958         "title": "Example usage:",
10959         "content": "curl https://{domain}/api/fax/messages/describe -v -u {name}:{password}",
10960         "type": "json"
10961       }
10962     ],
10963     "name": "DescribeMessages",
10964     "group": "Fax_Messages",
10965     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10966     "version": "0.0.0",
10967     "filename": "server/api/faxMessage/index.js",
10968     "groupTitle": "Fax_Messages"
10969   },
10970   {
10971     "type": "get",
10972     "url": "/api/fax/messages",
10973     "title": "Gets a list of Messages",
10974     "examples": [
10975       {
10976         "title": "Example usage:",
10977         "content": "curl https://{domain}/api/fax/messages -v -u {name}:{password}",
10978         "type": "json"
10979       }
10980     ],
10981     "name": "GetMessages",
10982     "group": "Fax_Messages",
10983     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
10984     "version": "0.0.0",
10985     "filename": "server/api/faxMessage/index.js",
10986     "groupTitle": "Fax_Messages"
10987   },
10988   {
10989     "type": "get",
10990     "url": "/api/fax/messages/{id}",
10991     "title": "Gets a single Message",
10992     "examples": [
10993       {
10994         "title": "Example usage:",
10995         "content": "curl https://{domain}/api/fax/messages/{id} -v -u {name}:{password}",
10996         "type": "json"
10997       }
10998     ],
10999     "name": "ShowMessages",
11000     "group": "Fax_Messages",
11001     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11002     "version": "0.0.0",
11003     "filename": "server/api/faxMessage/index.js",
11004     "groupTitle": "Fax_Messages"
11005   },
11006   {
11007     "type": "put",
11008     "url": "/api/fax/messages/{id}/accept",
11009     "title": "Accepts message",
11010     "examples": [
11011       {
11012         "title": "Example usage:",
11013         "content": "curl https://{domain}/api/fax/messages/{id}/accept \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
11014         "type": "json"
11015       }
11016     ],
11017     "name": "acceptMessage",
11018     "group": "Fax_Messages",
11019     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11020     "version": "0.0.0",
11021     "filename": "server/api/faxMessage/index.js",
11022     "groupTitle": "Fax_Messages"
11023   },
11024   {
11025     "type": "put",
11026     "url": "/api/fax/messages/{id}/reject",
11027     "title": "Rejects message",
11028     "examples": [
11029       {
11030         "title": "Example usage:",
11031         "content": "curl https://{domain}/api/fax/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
11032         "type": "json"
11033       }
11034     ],
11035     "name": "rejectMessage",
11036     "group": "Fax_Messages",
11037     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11038     "version": "0.0.0",
11039     "filename": "server/api/faxMessage/index.js",
11040     "groupTitle": "Fax_Messages"
11041   },
11042   {
11043     "type": "post",
11044     "url": "/api/fax/messages",
11045     "title": "Create message and send Fax",
11046     "examples": [
11047       {
11048         "title": "Example usage:",
11049         "content": "curl https://{domain}/api/fax/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
11050         "type": "json"
11051       }
11052     ],
11053     "name": "rejectMessage",
11054     "group": "Fax_Messages",
11055     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11056     "version": "0.0.0",
11057     "filename": "server/api/faxMessage/index.js",
11058     "groupTitle": "Fax_Messages"
11059   },
11060   {
11061     "type": "put",
11062     "url": "/api/fax/messages/{id}",
11063     "title": "Update an existing Message",
11064     "examples": [
11065       {
11066         "title": "Example usage:",
11067         "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",
11068         "type": "json"
11069       }
11070     ],
11071     "name": "updateMessages",
11072     "group": "Fax_Messages",
11073     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11074     "version": "0.0.0",
11075     "filename": "server/api/faxMessage/index.js",
11076     "groupTitle": "Fax_Messages"
11077   },
11078   {
11079     "type": "post",
11080     "url": "/api/fax/reports/queue",
11081     "title": "Creates a new Fax Queue Report",
11082     "examples": [
11083       {
11084         "title": "Example usage:",
11085         "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",
11086         "type": "json"
11087       }
11088     ],
11089     "name": "CreateFax_Queue_Reports",
11090     "group": "Fax_Queue_Reports",
11091     "parameter": {
11092       "fields": {
11093         "Body": [
11094           {
11095             "group": "Body",
11096             "type": "String",
11097             "optional": false,
11098             "field": "uniqueid",
11099             "description": ""
11100           },
11101           {
11102             "group": "Body",
11103             "type": "String",
11104             "optional": true,
11105             "field": "from",
11106             "description": ""
11107           },
11108           {
11109             "group": "Body",
11110             "type": "String",
11111             "optional": true,
11112             "field": "joinAt",
11113             "description": ""
11114           },
11115           {
11116             "group": "Body",
11117             "type": "String",
11118             "optional": true,
11119             "field": "leaveAt",
11120             "description": ""
11121           },
11122           {
11123             "group": "Body",
11124             "type": "String",
11125             "optional": true,
11126             "field": "acceptAt",
11127             "description": ""
11128           },
11129           {
11130             "group": "Body",
11131             "type": "String",
11132             "optional": true,
11133             "field": "exitAt",
11134             "description": ""
11135           },
11136           {
11137             "group": "Body",
11138             "type": "String",
11139             "optional": true,
11140             "field": "reason",
11141             "description": ""
11142           }
11143         ]
11144       }
11145     },
11146     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11147     "version": "0.0.0",
11148     "filename": "server/api/faxQueueReport/index.js",
11149     "groupTitle": "Fax_Queue_Reports"
11150   },
11151   {
11152     "type": "delete",
11153     "url": "/api/fax/reports/queue/{id}",
11154     "title": "Deletes a Fax Queue Report",
11155     "examples": [
11156       {
11157         "title": "Example usage:",
11158         "content": "curl https://{domain}/api/fax/reports/queue/{id} -v -u {name}:{password} -X DELETE",
11159         "type": "json"
11160       }
11161     ],
11162     "name": "DeleteFax_Queue_Reports",
11163     "group": "Fax_Queue_Reports",
11164     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11165     "version": "0.0.0",
11166     "filename": "server/api/faxQueueReport/index.js",
11167     "groupTitle": "Fax_Queue_Reports"
11168   },
11169   {
11170     "type": "get",
11171     "url": "/api/fax/reports/queue/describe",
11172     "title": "Gets table info about Fax Queue Reports",
11173     "examples": [
11174       {
11175         "title": "Example usage:",
11176         "content": "curl https://{domain}/api/fax/reports/queue/describe -v -u {name}:{password}",
11177         "type": "json"
11178       }
11179     ],
11180     "name": "DescribeFax_Queue_Reports",
11181     "group": "Fax_Queue_Reports",
11182     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11183     "version": "0.0.0",
11184     "filename": "server/api/faxQueueReport/index.js",
11185     "groupTitle": "Fax_Queue_Reports"
11186   },
11187   {
11188     "type": "get",
11189     "url": "/api/fax/reports/queue",
11190     "title": "Gets a list of Fax Queue Reports",
11191     "examples": [
11192       {
11193         "title": "Example usage:",
11194         "content": "curl https://{domain}/api/fax/reports/queue -v -u {name}:{password}",
11195         "type": "json"
11196       }
11197     ],
11198     "name": "GetFax_Queue_Reports",
11199     "group": "Fax_Queue_Reports",
11200     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
11201     "version": "0.0.0",
11202     "filename": "server/api/faxQueueReport/index.js",
11203     "groupTitle": "Fax_Queue_Reports"
11204   },
11205   {
11206     "type": "get",
11207     "url": "/api/fax/reports/queue/{id}",
11208     "title": "Gets a single Fax Queue Report",
11209     "examples": [
11210       {
11211         "title": "Example usage:",
11212         "content": "curl https://{domain}/api/fax/reports/queue/{id} -v -u {name}:{password}",
11213         "type": "json"
11214       }
11215     ],
11216     "name": "ShowFax_Queue_Reports",
11217     "group": "Fax_Queue_Reports",
11218     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11219     "version": "0.0.0",
11220     "filename": "server/api/faxQueueReport/index.js",
11221     "groupTitle": "Fax_Queue_Reports"
11222   },
11223   {
11224     "type": "put",
11225     "url": "/api/fax/reports/queue/{id}",
11226     "title": "Update an existing Fax Queue Report",
11227     "examples": [
11228       {
11229         "title": "Example usage:",
11230         "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",
11231         "type": "json"
11232       }
11233     ],
11234     "name": "updateFax_Queue_Reports",
11235     "group": "Fax_Queue_Reports",
11236     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11237     "version": "0.0.0",
11238     "filename": "server/api/faxQueueReport/index.js",
11239     "groupTitle": "Fax_Queue_Reports"
11240   },
11241   {
11242     "type": "post",
11243     "url": "/api/fax/queues/{id}/users",
11244     "title": "Add agents to a queue",
11245     "examples": [
11246       {
11247         "title": "Example usage:",
11248         "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",
11249         "type": "json"
11250       }
11251     ],
11252     "name": "AddAgents",
11253     "group": "Fax_Queues",
11254     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11255     "version": "0.0.0",
11256     "filename": "server/api/faxQueue/index.js",
11257     "groupTitle": "Fax_Queues"
11258   },
11259   {
11260     "type": "post",
11261     "url": "/api/fax/queues/{id}/teams",
11262     "title": "Add teams to a queue",
11263     "examples": [
11264       {
11265         "title": "Example usage:",
11266         "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",
11267         "type": "json"
11268       }
11269     ],
11270     "name": "AddTeams",
11271     "group": "Fax_Queues",
11272     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11273     "version": "0.0.0",
11274     "filename": "server/api/faxQueue/index.js",
11275     "groupTitle": "Fax_Queues"
11276   },
11277   {
11278     "type": "post",
11279     "url": "/api/fax/queues",
11280     "title": "Creates a new Queue",
11281     "examples": [
11282       {
11283         "title": "Example usage:",
11284         "content": "curl https://{domain}/api/fax/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
11285         "type": "json"
11286       }
11287     ],
11288     "name": "CreateQueues",
11289     "group": "Fax_Queues",
11290     "parameter": {
11291       "fields": {
11292         "Body": [
11293           {
11294             "group": "Body",
11295             "type": "String",
11296             "optional": false,
11297             "field": "name",
11298             "description": ""
11299           },
11300           {
11301             "group": "Body",
11302             "type": "String",
11303             "optional": true,
11304             "field": "description",
11305             "description": ""
11306           },
11307           {
11308             "group": "Body",
11309             "type": "Integer",
11310             "optional": false,
11311             "field": "timeout",
11312             "description": ""
11313           },
11314           {
11315             "group": "Body",
11316             "type": "String",
11317             "allowedValues": [
11318               "\"rrmemory\"",
11319               "\"beepall\"",
11320               "\"roundrobin\""
11321             ],
11322             "optional": false,
11323             "field": "strategy",
11324             "description": ""
11325           },
11326           {
11327             "group": "Body",
11328             "type": "Integer",
11329             "optional": true,
11330             "field": "lastAgent",
11331             "description": ""
11332           }
11333         ]
11334       }
11335     },
11336     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11337     "version": "0.0.0",
11338     "filename": "server/api/faxQueue/index.js",
11339     "groupTitle": "Fax_Queues"
11340   },
11341   {
11342     "type": "delete",
11343     "url": "/api/fax/queues/{id}",
11344     "title": "Deletes a Queue",
11345     "examples": [
11346       {
11347         "title": "Example usage:",
11348         "content": "curl https://{domain}/api/fax/queues/{id} -v -u {name}:{password} -X DELETE",
11349         "type": "json"
11350       }
11351     ],
11352     "name": "DeleteQueues",
11353     "group": "Fax_Queues",
11354     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11355     "version": "0.0.0",
11356     "filename": "server/api/faxQueue/index.js",
11357     "groupTitle": "Fax_Queues"
11358   },
11359   {
11360     "type": "get",
11361     "url": "/api/fax/queues/describe",
11362     "title": "Gets table info about Queues",
11363     "examples": [
11364       {
11365         "title": "Example usage:",
11366         "content": "curl https://{domain}/api/fax/queues/describe -v -u {name}:{password}",
11367         "type": "json"
11368       }
11369     ],
11370     "name": "DescribeQueues",
11371     "group": "Fax_Queues",
11372     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11373     "version": "0.0.0",
11374     "filename": "server/api/faxQueue/index.js",
11375     "groupTitle": "Fax_Queues"
11376   },
11377   {
11378     "type": "get",
11379     "url": "/api/fax/queues/{id}/users",
11380     "title": "Gets queue agents",
11381     "examples": [
11382       {
11383         "title": "Example usage:",
11384         "content": "curl https://{domain}/api/fax/queues/{id}/users -v -u {name}:{password} -X POST",
11385         "type": "json"
11386       }
11387     ],
11388     "name": "GetAgents",
11389     "group": "Fax_Queues",
11390     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11391     "version": "0.0.0",
11392     "filename": "server/api/faxQueue/index.js",
11393     "groupTitle": "Fax_Queues"
11394   },
11395   {
11396     "type": "get",
11397     "url": "/api/fax/queues/{id}/members",
11398     "title": "GetMembers",
11399     "examples": [
11400       {
11401         "title": "Example usage:",
11402         "content": "curl https://{domain}/api/fax/queues/{id}/members  -v -u {name}:{password}",
11403         "type": "json"
11404       }
11405     ],
11406     "name": "GetMembers",
11407     "group": "Fax_Queues",
11408     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11409     "version": "0.0.0",
11410     "filename": "server/api/faxQueue/index.js",
11411     "groupTitle": "Fax_Queues"
11412   },
11413   {
11414     "type": "get",
11415     "url": "/api/fax/queues",
11416     "title": "Gets a list of Queues",
11417     "examples": [
11418       {
11419         "title": "Example usage:",
11420         "content": "curl https://{domain}/api/fax/queues -v -u {name}:{password}",
11421         "type": "json"
11422       }
11423     ],
11424     "name": "GetQueues",
11425     "group": "Fax_Queues",
11426     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/fax/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>",
11427     "version": "0.0.0",
11428     "filename": "server/api/faxQueue/index.js",
11429     "groupTitle": "Fax_Queues"
11430   },
11431   {
11432     "type": "get",
11433     "url": "/api/fax/queues/{id}/teams",
11434     "title": "Gets queues list",
11435     "examples": [
11436       {
11437         "title": "Example usage:",
11438         "content": "curl https://{domain}/api/fax/queues/{id}/teams -v -u {name}:{password}",
11439         "type": "json"
11440       }
11441     ],
11442     "name": "GetTeams",
11443     "group": "Fax_Queues",
11444     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11445     "version": "0.0.0",
11446     "filename": "server/api/faxQueue/index.js",
11447     "groupTitle": "Fax_Queues"
11448   },
11449   {
11450     "type": "delete",
11451     "url": "/api/fax/queues/{id}/users",
11452     "title": "Removes agents from a queue",
11453     "examples": [
11454       {
11455         "title": "Example usage:",
11456         "content": "curl https://{domain}/api/fax/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
11457         "type": "json"
11458       }
11459     ],
11460     "name": "RemoveAgents",
11461     "group": "Fax_Queues",
11462     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11463     "version": "0.0.0",
11464     "filename": "server/api/faxQueue/index.js",
11465     "groupTitle": "Fax_Queues"
11466   },
11467   {
11468     "type": "get",
11469     "url": "/api/fax/queues/{id}",
11470     "title": "Gets a single Queue",
11471     "examples": [
11472       {
11473         "title": "Example usage:",
11474         "content": "curl https://{domain}/api/fax/queues/{id} -v -u {name}:{password}",
11475         "type": "json"
11476       }
11477     ],
11478     "name": "ShowQueues",
11479     "group": "Fax_Queues",
11480     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11481     "version": "0.0.0",
11482     "filename": "server/api/faxQueue/index.js",
11483     "groupTitle": "Fax_Queues"
11484   },
11485   {
11486     "type": "put",
11487     "url": "/api/fax/queues/{id}",
11488     "title": "Update an existing Queue",
11489     "examples": [
11490       {
11491         "title": "Example usage:",
11492         "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",
11493         "type": "json"
11494       }
11495     ],
11496     "name": "updateQueues",
11497     "group": "Fax_Queues",
11498     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11499     "version": "0.0.0",
11500     "filename": "server/api/faxQueue/index.js",
11501     "groupTitle": "Fax_Queues"
11502   },
11503   {
11504     "type": "post",
11505     "url": "/api/fax/reports/transfer",
11506     "title": "Creates a new Fax Transfer Report",
11507     "examples": [
11508       {
11509         "title": "Example usage:",
11510         "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",
11511         "type": "json"
11512       }
11513     ],
11514     "name": "CreateFax_Transfer_Reports",
11515     "group": "Fax_Transfer_Reports",
11516     "parameter": {
11517       "fields": {
11518         "Body": [
11519           {
11520             "group": "Body",
11521             "type": "String",
11522             "optional": false,
11523             "field": "uniqueid",
11524             "description": ""
11525           },
11526           {
11527             "group": "Body",
11528             "type": "String",
11529             "allowedValues": [
11530               "\"account\"",
11531               "\"agent\"",
11532               "\"queue\""
11533             ],
11534             "optional": false,
11535             "field": "type",
11536             "description": ""
11537           },
11538           {
11539             "group": "Body",
11540             "type": "String",
11541             "optional": false,
11542             "field": "transferredAt",
11543             "description": ""
11544           }
11545         ]
11546       }
11547     },
11548     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11549     "version": "0.0.0",
11550     "filename": "server/api/faxTransferReport/index.js",
11551     "groupTitle": "Fax_Transfer_Reports"
11552   },
11553   {
11554     "type": "delete",
11555     "url": "/api/fax/reports/transfer/{id}",
11556     "title": "Deletes a Fax Transfer Report",
11557     "examples": [
11558       {
11559         "title": "Example usage:",
11560         "content": "curl https://{domain}/api/fax/reports/transfer/{id} -v -u {name}:{password} -X DELETE",
11561         "type": "json"
11562       }
11563     ],
11564     "name": "DeleteFax_Transfer_Reports",
11565     "group": "Fax_Transfer_Reports",
11566     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11567     "version": "0.0.0",
11568     "filename": "server/api/faxTransferReport/index.js",
11569     "groupTitle": "Fax_Transfer_Reports"
11570   },
11571   {
11572     "type": "get",
11573     "url": "/api/fax/reports/transfer/describe",
11574     "title": "Gets table info about Fax Transfer Reports",
11575     "examples": [
11576       {
11577         "title": "Example usage:",
11578         "content": "curl https://{domain}/api/fax/reports/transfer/describe -v -u {name}:{password}",
11579         "type": "json"
11580       }
11581     ],
11582     "name": "DescribeFax_Transfer_Reports",
11583     "group": "Fax_Transfer_Reports",
11584     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11585     "version": "0.0.0",
11586     "filename": "server/api/faxTransferReport/index.js",
11587     "groupTitle": "Fax_Transfer_Reports"
11588   },
11589   {
11590     "type": "get",
11591     "url": "/api/fax/reports/transfer",
11592     "title": "Gets a list of Fax Transfer Reports",
11593     "examples": [
11594       {
11595         "title": "Example usage:",
11596         "content": "curl https://{domain}/api/fax/reports/transfer -v -u {name}:{password}",
11597         "type": "json"
11598       }
11599     ],
11600     "name": "GetFax_Transfer_Reports",
11601     "group": "Fax_Transfer_Reports",
11602     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
11603     "version": "0.0.0",
11604     "filename": "server/api/faxTransferReport/index.js",
11605     "groupTitle": "Fax_Transfer_Reports"
11606   },
11607   {
11608     "type": "get",
11609     "url": "/api/fax/reports/transfer/{id}",
11610     "title": "Gets a single Fax Transfer Report",
11611     "examples": [
11612       {
11613         "title": "Example usage:",
11614         "content": "curl https://{domain}/api/fax/reports/transfer/{id} -v -u {name}:{password}",
11615         "type": "json"
11616       }
11617     ],
11618     "name": "ShowFax_Transfer_Reports",
11619     "group": "Fax_Transfer_Reports",
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/faxTransferReport/index.js",
11623     "groupTitle": "Fax_Transfer_Reports"
11624   },
11625   {
11626     "type": "put",
11627     "url": "/api/fax/reports/transfer/{id}",
11628     "title": "Update an existing Fax Transfer Report",
11629     "examples": [
11630       {
11631         "title": "Example usage:",
11632         "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",
11633         "type": "json"
11634       }
11635     ],
11636     "name": "updateFax_Transfer_Reports",
11637     "group": "Fax_Transfer_Reports",
11638     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11639     "version": "0.0.0",
11640     "filename": "server/api/faxTransferReport/index.js",
11641     "groupTitle": "Fax_Transfer_Reports"
11642   },
11643   {
11644     "type": "post",
11645     "url": "/api/integrations/freshdesk/accounts",
11646     "title": "Creates a new Freshdesk Account",
11647     "examples": [
11648       {
11649         "title": "Example usage:",
11650         "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",
11651         "type": "json"
11652       }
11653     ],
11654     "name": "CreateFreshdesk_Accounts",
11655     "group": "Freshdesk_Accounts",
11656     "parameter": {
11657       "fields": {
11658         "Body": [
11659           {
11660             "group": "Body",
11661             "type": "String",
11662             "optional": true,
11663             "field": "name",
11664             "description": ""
11665           },
11666           {
11667             "group": "Body",
11668             "type": "String",
11669             "optional": true,
11670             "field": "description",
11671             "description": ""
11672           },
11673           {
11674             "group": "Body",
11675             "type": "String",
11676             "optional": true,
11677             "field": "username",
11678             "description": ""
11679           },
11680           {
11681             "group": "Body",
11682             "type": "String",
11683             "optional": true,
11684             "field": "apiKey",
11685             "description": ""
11686           },
11687           {
11688             "group": "Body",
11689             "type": "String",
11690             "optional": true,
11691             "field": "remoteUri",
11692             "description": ""
11693           },
11694           {
11695             "group": "Body",
11696             "type": "String",
11697             "optional": false,
11698             "field": "serverUrl",
11699             "description": ""
11700           }
11701         ]
11702       }
11703     },
11704     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11705     "version": "0.0.0",
11706     "filename": "server/api/intFreshdeskAccount/index.js",
11707     "groupTitle": "Freshdesk_Accounts"
11708   },
11709   {
11710     "type": "delete",
11711     "url": "/api/integrations/freshdesk/accounts/{id}",
11712     "title": "Deletes a Freshdesk Account",
11713     "examples": [
11714       {
11715         "title": "Example usage:",
11716         "content": "curl https://{domain}/api/integrations/freshdesk/accounts/{id} -v -u {name}:{password} -X DELETE",
11717         "type": "json"
11718       }
11719     ],
11720     "name": "DeleteFreshdesk_Accounts",
11721     "group": "Freshdesk_Accounts",
11722     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11723     "version": "0.0.0",
11724     "filename": "server/api/intFreshdeskAccount/index.js",
11725     "groupTitle": "Freshdesk_Accounts"
11726   },
11727   {
11728     "type": "get",
11729     "url": "/api/integrations/freshdesk/accounts",
11730     "title": "Gets a list of Freshdesk Accounts",
11731     "examples": [
11732       {
11733         "title": "Example usage:",
11734         "content": "curl https://{domain}/api/integrations/freshdesk/accounts -v -u {name}:{password}",
11735         "type": "json"
11736       }
11737     ],
11738     "name": "GetFreshdesk_Accounts",
11739     "group": "Freshdesk_Accounts",
11740     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
11741     "version": "0.0.0",
11742     "filename": "server/api/intFreshdeskAccount/index.js",
11743     "groupTitle": "Freshdesk_Accounts"
11744   },
11745   {
11746     "type": "get",
11747     "url": "/api/integrations/freshdesk/accounts/{id}",
11748     "title": "Gets a single Freshdesk Account",
11749     "examples": [
11750       {
11751         "title": "Example usage:",
11752         "content": "curl https://{domain}/api/integrations/freshdesk/accounts/{id} -v -u {name}:{password}",
11753         "type": "json"
11754       }
11755     ],
11756     "name": "ShowFreshdesk_Accounts",
11757     "group": "Freshdesk_Accounts",
11758     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11759     "version": "0.0.0",
11760     "filename": "server/api/intFreshdeskAccount/index.js",
11761     "groupTitle": "Freshdesk_Accounts"
11762   },
11763   {
11764     "type": "post",
11765     "url": "/api/integrations/freshdesk/accounts/{id}/configurations",
11766     "title": "Creates new configuration",
11767     "examples": [
11768       {
11769         "title": "Example usage:",
11770         "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",
11771         "type": "json"
11772       }
11773     ],
11774     "name": "addConfiguration",
11775     "group": "Freshdesk_Accounts",
11776     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11777     "version": "0.0.0",
11778     "filename": "server/api/intFreshdeskAccount/index.js",
11779     "groupTitle": "Freshdesk_Accounts"
11780   },
11781   {
11782     "type": "get",
11783     "url": "/api/integrations/freshdesk/accounts/{id}/configurations",
11784     "title": "Gets account configurations",
11785     "examples": [
11786       {
11787         "title": "Example usage:",
11788         "content": "curl https://{domain}/api/integrations/freshdesk/accounts/{id}/configurations -v -u {name}:{password} -X GET",
11789         "type": "json"
11790       }
11791     ],
11792     "name": "getConfigurations",
11793     "group": "Freshdesk_Accounts",
11794     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11795     "version": "0.0.0",
11796     "filename": "server/api/intFreshdeskAccount/index.js",
11797     "groupTitle": "Freshdesk_Accounts"
11798   },
11799   {
11800     "type": "get",
11801     "url": "/api/integrations/freshdesk/accounts/{id}/fields",
11802     "title": "Gets account fields",
11803     "examples": [
11804       {
11805         "title": "Example usage:",
11806         "content": "curl https://{domain}/api/integrations/freshdesk/accounts/{id}/fields -v -u {name}:{password} -X GET",
11807         "type": "json"
11808       }
11809     ],
11810     "name": "getFields",
11811     "group": "Freshdesk_Accounts",
11812     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11813     "version": "0.0.0",
11814     "filename": "server/api/intFreshdeskAccount/index.js",
11815     "groupTitle": "Freshdesk_Accounts"
11816   },
11817   {
11818     "type": "put",
11819     "url": "/api/integrations/freshdesk/accounts/{id}",
11820     "title": "Update an existing Freshdesk Account",
11821     "examples": [
11822       {
11823         "title": "Example usage:",
11824         "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",
11825         "type": "json"
11826       }
11827     ],
11828     "name": "updateFreshdesk_Accounts",
11829     "group": "Freshdesk_Accounts",
11830     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11831     "version": "0.0.0",
11832     "filename": "server/api/intFreshdeskAccount/index.js",
11833     "groupTitle": "Freshdesk_Accounts"
11834   },
11835   {
11836     "type": "post",
11837     "url": "/api/integrations/freshdesk/configurations",
11838     "title": "Creates a new Freshdesk Configuration",
11839     "examples": [
11840       {
11841         "title": "Example usage:",
11842         "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",
11843         "type": "json"
11844       }
11845     ],
11846     "name": "CreateFreshdesk_Configurations",
11847     "group": "Freshdesk_Configurations",
11848     "parameter": {
11849       "fields": {
11850         "Body": [
11851           {
11852             "group": "Body",
11853             "type": "String",
11854             "optional": true,
11855             "field": "name",
11856             "description": ""
11857           },
11858           {
11859             "group": "Body",
11860             "type": "String",
11861             "optional": true,
11862             "field": "description",
11863             "description": ""
11864           }
11865         ]
11866       }
11867     },
11868     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11869     "version": "0.0.0",
11870     "filename": "server/api/intFreshdeskConfiguration/index.js",
11871     "groupTitle": "Freshdesk_Configurations"
11872   },
11873   {
11874     "type": "delete",
11875     "url": "/api/integrations/freshdesk/configurations/{id}",
11876     "title": "Deletes a Freshdesk Configuration",
11877     "examples": [
11878       {
11879         "title": "Example usage:",
11880         "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id} -v -u {name}:{password} -X DELETE",
11881         "type": "json"
11882       }
11883     ],
11884     "name": "DeleteFreshdesk_Configurations",
11885     "group": "Freshdesk_Configurations",
11886     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11887     "version": "0.0.0",
11888     "filename": "server/api/intFreshdeskConfiguration/index.js",
11889     "groupTitle": "Freshdesk_Configurations"
11890   },
11891   {
11892     "type": "get",
11893     "url": "/api/integrations/freshdesk/configurations",
11894     "title": "Gets a list of Freshdesk Configurations",
11895     "examples": [
11896       {
11897         "title": "Example usage:",
11898         "content": "curl https://{domain}/api/integrations/freshdesk/configurations -v -u {name}:{password}",
11899         "type": "json"
11900       }
11901     ],
11902     "name": "GetFreshdesk_Configurations",
11903     "group": "Freshdesk_Configurations",
11904     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
11905     "version": "0.0.0",
11906     "filename": "server/api/intFreshdeskConfiguration/index.js",
11907     "groupTitle": "Freshdesk_Configurations"
11908   },
11909   {
11910     "type": "get",
11911     "url": "/api/integrations/freshdesk/configurations/{id}",
11912     "title": "Gets a single Freshdesk Configuration",
11913     "examples": [
11914       {
11915         "title": "Example usage:",
11916         "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id} -v -u {name}:{password}",
11917         "type": "json"
11918       }
11919     ],
11920     "name": "ShowFreshdesk_Configurations",
11921     "group": "Freshdesk_Configurations",
11922     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11923     "version": "0.0.0",
11924     "filename": "server/api/intFreshdeskConfiguration/index.js",
11925     "groupTitle": "Freshdesk_Configurations"
11926   },
11927   {
11928     "type": "get",
11929     "url": "/api/integrations/freshdesk/configurations/{id}/descriptions",
11930     "title": "Gets configurations descriptions",
11931     "examples": [
11932       {
11933         "title": "Example usage:",
11934         "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
11935         "type": "json"
11936       }
11937     ],
11938     "name": "getDescriptions",
11939     "group": "Freshdesk_Configurations",
11940     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11941     "version": "0.0.0",
11942     "filename": "server/api/intFreshdeskConfiguration/index.js",
11943     "groupTitle": "Freshdesk_Configurations"
11944   },
11945   {
11946     "type": "get",
11947     "url": "/api/integrations/freshdesk/configurations/{id}/fields",
11948     "title": "Gets configurations fields",
11949     "examples": [
11950       {
11951         "title": "Example usage:",
11952         "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id}/fields -v -u {name}:{password} -X GET",
11953         "type": "json"
11954       }
11955     ],
11956     "name": "getFields",
11957     "group": "Freshdesk_Configurations",
11958     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11959     "version": "0.0.0",
11960     "filename": "server/api/intFreshdeskConfiguration/index.js",
11961     "groupTitle": "Freshdesk_Configurations"
11962   },
11963   {
11964     "type": "get",
11965     "url": "/api/integrations/freshdesk/configurations/{id}/subjects",
11966     "title": "Gets configurations subjects",
11967     "examples": [
11968       {
11969         "title": "Example usage:",
11970         "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id}/subjects -v -u {name}:{password} -X GET",
11971         "type": "json"
11972       }
11973     ],
11974     "name": "getSubjects",
11975     "group": "Freshdesk_Configurations",
11976     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11977     "version": "0.0.0",
11978     "filename": "server/api/intFreshdeskConfiguration/index.js",
11979     "groupTitle": "Freshdesk_Configurations"
11980   },
11981   {
11982     "type": "get",
11983     "url": "/api/integrations/freshdesk/configurations/{id}/tags",
11984     "title": "Gets configurations tags",
11985     "examples": [
11986       {
11987         "title": "Example usage:",
11988         "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id}/tags -v -u {name}:{password} -X GET",
11989         "type": "json"
11990       }
11991     ],
11992     "name": "getTags",
11993     "group": "Freshdesk_Configurations",
11994     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11995     "version": "0.0.0",
11996     "filename": "server/api/intFreshdeskConfiguration/index.js",
11997     "groupTitle": "Freshdesk_Configurations"
11998   },
11999   {
12000     "type": "post",
12001     "url": "/api/integrations/freshdesk/configurations/{id}/tags",
12002     "title": "Sets new tags",
12003     "examples": [
12004       {
12005         "title": "Example usage:",
12006         "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",
12007         "type": "json"
12008       }
12009     ],
12010     "name": "setTags",
12011     "group": "Freshdesk_Configurations",
12012     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12013     "version": "0.0.0",
12014     "filename": "server/api/intFreshdeskConfiguration/index.js",
12015     "groupTitle": "Freshdesk_Configurations"
12016   },
12017   {
12018     "type": "put",
12019     "url": "/api/integrations/freshdesk/configurations/{id}",
12020     "title": "Update an existing Freshdesk Configuration",
12021     "examples": [
12022       {
12023         "title": "Example usage:",
12024         "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",
12025         "type": "json"
12026       }
12027     ],
12028     "name": "updateFreshdesk_Configurations",
12029     "group": "Freshdesk_Configurations",
12030     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12031     "version": "0.0.0",
12032     "filename": "server/api/intFreshdeskConfiguration/index.js",
12033     "groupTitle": "Freshdesk_Configurations"
12034   },
12035   {
12036     "type": "post",
12037     "url": "/api/integrations/freshdesk/fields",
12038     "title": "Creates a new Freshdesk Field",
12039     "examples": [
12040       {
12041         "title": "Example usage:",
12042         "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",
12043         "type": "json"
12044       }
12045     ],
12046     "name": "CreateFreshdesk_Fields",
12047     "group": "Freshdesk_Fields",
12048     "parameter": {
12049       "fields": {
12050         "Body": [
12051           {
12052             "group": "Body",
12053             "type": "String",
12054             "allowedValues": [
12055               "\"string\"",
12056               "\"variable\"",
12057               "\"customVariable\"",
12058               "\"keyValue\"",
12059               "\"picklist\""
12060             ],
12061             "optional": true,
12062             "field": "type",
12063             "description": ""
12064           },
12065           {
12066             "group": "Body",
12067             "type": "String",
12068             "optional": true,
12069             "field": "content",
12070             "description": ""
12071           },
12072           {
12073             "group": "Body",
12074             "type": "String",
12075             "optional": true,
12076             "field": "key",
12077             "description": ""
12078           },
12079           {
12080             "group": "Body",
12081             "type": "String",
12082             "allowedValues": [
12083               "\"string\"",
12084               "\"variable\"",
12085               "\"customVariable\""
12086             ],
12087             "optional": true,
12088             "field": "keyType",
12089             "description": ""
12090           },
12091           {
12092             "group": "Body",
12093             "type": "String",
12094             "optional": true,
12095             "field": "keyContent",
12096             "description": ""
12097           },
12098           {
12099             "group": "Body",
12100             "type": "String",
12101             "optional": true,
12102             "field": "idField",
12103             "description": ""
12104           },
12105           {
12106             "group": "Body",
12107             "type": "String",
12108             "optional": true,
12109             "field": "nameField",
12110             "description": ""
12111           },
12112           {
12113             "group": "Body",
12114             "type": "Boolean",
12115             "optional": true,
12116             "field": "customField",
12117             "description": ""
12118           },
12119           {
12120             "group": "Body",
12121             "type": "String",
12122             "optional": true,
12123             "field": "variableName",
12124             "description": ""
12125           }
12126         ]
12127       }
12128     },
12129     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12130     "version": "0.0.0",
12131     "filename": "server/api/intFreshdeskField/index.js",
12132     "groupTitle": "Freshdesk_Fields"
12133   },
12134   {
12135     "type": "delete",
12136     "url": "/api/integrations/freshdesk/fields/{id}",
12137     "title": "Deletes a Freshdesk Field",
12138     "examples": [
12139       {
12140         "title": "Example usage:",
12141         "content": "curl https://{domain}/api/integrations/freshdesk/fields/{id} -v -u {name}:{password} -X DELETE",
12142         "type": "json"
12143       }
12144     ],
12145     "name": "DeleteFreshdesk_Fields",
12146     "group": "Freshdesk_Fields",
12147     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12148     "version": "0.0.0",
12149     "filename": "server/api/intFreshdeskField/index.js",
12150     "groupTitle": "Freshdesk_Fields"
12151   },
12152   {
12153     "type": "get",
12154     "url": "/api/integrations/freshdesk/fields",
12155     "title": "Gets a list of Freshdesk Fields",
12156     "examples": [
12157       {
12158         "title": "Example usage:",
12159         "content": "curl https://{domain}/api/integrations/freshdesk/fields -v -u {name}:{password}",
12160         "type": "json"
12161       }
12162     ],
12163     "name": "GetFreshdesk_Fields",
12164     "group": "Freshdesk_Fields",
12165     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
12166     "version": "0.0.0",
12167     "filename": "server/api/intFreshdeskField/index.js",
12168     "groupTitle": "Freshdesk_Fields"
12169   },
12170   {
12171     "type": "get",
12172     "url": "/api/integrations/freshdesk/fields/{id}",
12173     "title": "Gets a single Freshdesk Field",
12174     "examples": [
12175       {
12176         "title": "Example usage:",
12177         "content": "curl https://{domain}/api/integrations/freshdesk/fields/{id} -v -u {name}:{password}",
12178         "type": "json"
12179       }
12180     ],
12181     "name": "ShowFreshdesk_Fields",
12182     "group": "Freshdesk_Fields",
12183     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12184     "version": "0.0.0",
12185     "filename": "server/api/intFreshdeskField/index.js",
12186     "groupTitle": "Freshdesk_Fields"
12187   },
12188   {
12189     "type": "put",
12190     "url": "/api/integrations/freshdesk/fields/{id}",
12191     "title": "Update an existing Freshdesk Field",
12192     "examples": [
12193       {
12194         "title": "Example usage:",
12195         "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",
12196         "type": "json"
12197       }
12198     ],
12199     "name": "updateFreshdesk_Fields",
12200     "group": "Freshdesk_Fields",
12201     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12202     "version": "0.0.0",
12203     "filename": "server/api/intFreshdeskField/index.js",
12204     "groupTitle": "Freshdesk_Fields"
12205   },
12206   {
12207     "type": "post",
12208     "url": "/api/integrations/freshsales/accounts",
12209     "title": "Creates a new Freshsales Account",
12210     "examples": [
12211       {
12212         "title": "Example usage:",
12213         "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",
12214         "type": "json"
12215       }
12216     ],
12217     "name": "CreateFreshsales_Accounts",
12218     "group": "Freshsales_Accounts",
12219     "parameter": {
12220       "fields": {
12221         "Body": [
12222           {
12223             "group": "Body",
12224             "type": "String",
12225             "optional": true,
12226             "field": "name",
12227             "description": ""
12228           },
12229           {
12230             "group": "Body",
12231             "type": "String",
12232             "optional": true,
12233             "field": "description",
12234             "description": ""
12235           },
12236           {
12237             "group": "Body",
12238             "type": "String",
12239             "optional": true,
12240             "field": "username",
12241             "description": ""
12242           },
12243           {
12244             "group": "Body",
12245             "type": "String",
12246             "optional": true,
12247             "field": "apiKey",
12248             "description": ""
12249           },
12250           {
12251             "group": "Body",
12252             "type": "String",
12253             "optional": true,
12254             "field": "remoteUri",
12255             "description": ""
12256           },
12257           {
12258             "group": "Body",
12259             "type": "String",
12260             "optional": false,
12261             "field": "serverUrl",
12262             "description": ""
12263           }
12264         ]
12265       }
12266     },
12267     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12268     "version": "0.0.0",
12269     "filename": "server/api/intFreshsalesAccount/index.js",
12270     "groupTitle": "Freshsales_Accounts"
12271   },
12272   {
12273     "type": "delete",
12274     "url": "/api/integrations/freshsales/accounts/{id}",
12275     "title": "Deletes a Freshsales Account",
12276     "examples": [
12277       {
12278         "title": "Example usage:",
12279         "content": "curl https://{domain}/api/integrations/freshsales/accounts/{id} -v -u {name}:{password} -X DELETE",
12280         "type": "json"
12281       }
12282     ],
12283     "name": "DeleteFreshsales_Accounts",
12284     "group": "Freshsales_Accounts",
12285     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12286     "version": "0.0.0",
12287     "filename": "server/api/intFreshsalesAccount/index.js",
12288     "groupTitle": "Freshsales_Accounts"
12289   },
12290   {
12291     "type": "get",
12292     "url": "/api/integrations/freshsales/accounts",
12293     "title": "Gets a list of Freshsales Accounts",
12294     "examples": [
12295       {
12296         "title": "Example usage:",
12297         "content": "curl https://{domain}/api/integrations/freshsales/accounts -v -u {name}:{password}",
12298         "type": "json"
12299       }
12300     ],
12301     "name": "GetFreshsales_Accounts",
12302     "group": "Freshsales_Accounts",
12303     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
12304     "version": "0.0.0",
12305     "filename": "server/api/intFreshsalesAccount/index.js",
12306     "groupTitle": "Freshsales_Accounts"
12307   },
12308   {
12309     "type": "get",
12310     "url": "/api/integrations/freshsales/accounts/{id}",
12311     "title": "Gets a single Freshsales Account",
12312     "examples": [
12313       {
12314         "title": "Example usage:",
12315         "content": "curl https://{domain}/api/integrations/freshsales/accounts/{id} -v -u {name}:{password}",
12316         "type": "json"
12317       }
12318     ],
12319     "name": "ShowFreshsales_Accounts",
12320     "group": "Freshsales_Accounts",
12321     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12322     "version": "0.0.0",
12323     "filename": "server/api/intFreshsalesAccount/index.js",
12324     "groupTitle": "Freshsales_Accounts"
12325   },
12326   {
12327     "type": "post",
12328     "url": "/api/integrations/freshsales/accounts/{id}/configurations",
12329     "title": "Creates new configuration",
12330     "examples": [
12331       {
12332         "title": "Example usage:",
12333         "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",
12334         "type": "json"
12335       }
12336     ],
12337     "name": "addConfiguration",
12338     "group": "Freshsales_Accounts",
12339     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12340     "version": "0.0.0",
12341     "filename": "server/api/intFreshsalesAccount/index.js",
12342     "groupTitle": "Freshsales_Accounts"
12343   },
12344   {
12345     "type": "get",
12346     "url": "/api/integrations/freshsales/accounts/{id}/configurations",
12347     "title": "Gets account configurations",
12348     "examples": [
12349       {
12350         "title": "Example usage:",
12351         "content": "curl https://{domain}/api/integrations/freshsales/accounts/{id}/configurations -v -u {name}:{password} -X GET",
12352         "type": "json"
12353       }
12354     ],
12355     "name": "getConfigurations",
12356     "group": "Freshsales_Accounts",
12357     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12358     "version": "0.0.0",
12359     "filename": "server/api/intFreshsalesAccount/index.js",
12360     "groupTitle": "Freshsales_Accounts"
12361   },
12362   {
12363     "type": "get",
12364     "url": "/api/integrations/freshsales/accounts/{id}/fields",
12365     "title": "Gets account fields",
12366     "examples": [
12367       {
12368         "title": "Example usage:",
12369         "content": "curl https://{domain}/api/integrations/freshsales/accounts/{id}/fields -v -u {name}:{password} -X GET",
12370         "type": "json"
12371       }
12372     ],
12373     "name": "getFields",
12374     "group": "Freshsales_Accounts",
12375     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12376     "version": "0.0.0",
12377     "filename": "server/api/intFreshsalesAccount/index.js",
12378     "groupTitle": "Freshsales_Accounts"
12379   },
12380   {
12381     "type": "put",
12382     "url": "/api/integrations/freshsales/accounts/{id}",
12383     "title": "Update an existing Freshsales Account",
12384     "examples": [
12385       {
12386         "title": "Example usage:",
12387         "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",
12388         "type": "json"
12389       }
12390     ],
12391     "name": "updateFreshsales_Accounts",
12392     "group": "Freshsales_Accounts",
12393     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12394     "version": "0.0.0",
12395     "filename": "server/api/intFreshsalesAccount/index.js",
12396     "groupTitle": "Freshsales_Accounts"
12397   },
12398   {
12399     "type": "post",
12400     "url": "/api/integrations/freshsales/configurations",
12401     "title": "Creates a new Freshsales Configuration",
12402     "examples": [
12403       {
12404         "title": "Example usage:",
12405         "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",
12406         "type": "json"
12407       }
12408     ],
12409     "name": "CreateFreshsales_Configurations",
12410     "group": "Freshsales_Configurations",
12411     "parameter": {
12412       "fields": {
12413         "Body": [
12414           {
12415             "group": "Body",
12416             "type": "String",
12417             "optional": true,
12418             "field": "name",
12419             "description": ""
12420           },
12421           {
12422             "group": "Body",
12423             "type": "String",
12424             "optional": true,
12425             "field": "description",
12426             "description": ""
12427           }
12428         ]
12429       }
12430     },
12431     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12432     "version": "0.0.0",
12433     "filename": "server/api/intFreshsalesConfiguration/index.js",
12434     "groupTitle": "Freshsales_Configurations"
12435   },
12436   {
12437     "type": "delete",
12438     "url": "/api/integrations/freshsales/configurations/{id}",
12439     "title": "Deletes a Freshsales Configuration",
12440     "examples": [
12441       {
12442         "title": "Example usage:",
12443         "content": "curl https://{domain}/api/integrations/freshsales/configurations/{id} -v -u {name}:{password} -X DELETE",
12444         "type": "json"
12445       }
12446     ],
12447     "name": "DeleteFreshsales_Configurations",
12448     "group": "Freshsales_Configurations",
12449     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12450     "version": "0.0.0",
12451     "filename": "server/api/intFreshsalesConfiguration/index.js",
12452     "groupTitle": "Freshsales_Configurations"
12453   },
12454   {
12455     "type": "get",
12456     "url": "/api/integrations/freshsales/configurations",
12457     "title": "Gets a list of Freshsales Configurations",
12458     "examples": [
12459       {
12460         "title": "Example usage:",
12461         "content": "curl https://{domain}/api/integrations/freshsales/configurations -v -u {name}:{password}",
12462         "type": "json"
12463       }
12464     ],
12465     "name": "GetFreshsales_Configurations",
12466     "group": "Freshsales_Configurations",
12467     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
12468     "version": "0.0.0",
12469     "filename": "server/api/intFreshsalesConfiguration/index.js",
12470     "groupTitle": "Freshsales_Configurations"
12471   },
12472   {
12473     "type": "get",
12474     "url": "/api/integrations/freshsales/configurations/{id}",
12475     "title": "Gets a single Freshsales Configuration",
12476     "examples": [
12477       {
12478         "title": "Example usage:",
12479         "content": "curl https://{domain}/api/integrations/freshsales/configurations/{id} -v -u {name}:{password}",
12480         "type": "json"
12481       }
12482     ],
12483     "name": "ShowFreshsales_Configurations",
12484     "group": "Freshsales_Configurations",
12485     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12486     "version": "0.0.0",
12487     "filename": "server/api/intFreshsalesConfiguration/index.js",
12488     "groupTitle": "Freshsales_Configurations"
12489   },
12490   {
12491     "type": "get",
12492     "url": "/api/integrations/freshsales/configurations/{id}/descriptions",
12493     "title": "Gets configurations descriptions",
12494     "examples": [
12495       {
12496         "title": "Example usage:",
12497         "content": "curl https://{domain}/api/integrations/freshsales/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
12498         "type": "json"
12499       }
12500     ],
12501     "name": "getDescriptions",
12502     "group": "Freshsales_Configurations",
12503     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12504     "version": "0.0.0",
12505     "filename": "server/api/intFreshsalesConfiguration/index.js",
12506     "groupTitle": "Freshsales_Configurations"
12507   },
12508   {
12509     "type": "get",
12510     "url": "/api/integrations/freshsales/configurations/{id}/fields",
12511     "title": "Gets configurations fields",
12512     "examples": [
12513       {
12514         "title": "Example usage:",
12515         "content": "curl https://{domain}/api/integrations/freshsales/configurations/{id}/fields -v -u {name}:{password} -X GET",
12516         "type": "json"
12517       }
12518     ],
12519     "name": "getFields",
12520     "group": "Freshsales_Configurations",
12521     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12522     "version": "0.0.0",
12523     "filename": "server/api/intFreshsalesConfiguration/index.js",
12524     "groupTitle": "Freshsales_Configurations"
12525   },
12526   {
12527     "type": "get",
12528     "url": "/api/integrations/freshsales/configurations/{id}/subjects",
12529     "title": "Gets configurations subjects",
12530     "examples": [
12531       {
12532         "title": "Example usage:",
12533         "content": "curl https://{domain}/api/integrations/freshsales/configurations/{id}/subjects -v -u {name}:{password} -X GET",
12534         "type": "json"
12535       }
12536     ],
12537     "name": "getSubjects",
12538     "group": "Freshsales_Configurations",
12539     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12540     "version": "0.0.0",
12541     "filename": "server/api/intFreshsalesConfiguration/index.js",
12542     "groupTitle": "Freshsales_Configurations"
12543   },
12544   {
12545     "type": "put",
12546     "url": "/api/integrations/freshsales/configurations/{id}",
12547     "title": "Update an existing Freshsales Configuration",
12548     "examples": [
12549       {
12550         "title": "Example usage:",
12551         "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",
12552         "type": "json"
12553       }
12554     ],
12555     "name": "updateFreshsales_Configurations",
12556     "group": "Freshsales_Configurations",
12557     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12558     "version": "0.0.0",
12559     "filename": "server/api/intFreshsalesConfiguration/index.js",
12560     "groupTitle": "Freshsales_Configurations"
12561   },
12562   {
12563     "type": "post",
12564     "url": "/api/integrations/freshsales/fields",
12565     "title": "Creates a new Freshsales Field",
12566     "examples": [
12567       {
12568         "title": "Example usage:",
12569         "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",
12570         "type": "json"
12571       }
12572     ],
12573     "name": "CreateFreshsales_Fields",
12574     "group": "Freshsales_Fields",
12575     "parameter": {
12576       "fields": {
12577         "Body": [
12578           {
12579             "group": "Body",
12580             "type": "String",
12581             "allowedValues": [
12582               "\"string\"",
12583               "\"variable\"",
12584               "\"customVariable\"",
12585               "\"keyValue\"",
12586               "\"picklist\""
12587             ],
12588             "optional": true,
12589             "field": "type",
12590             "description": ""
12591           },
12592           {
12593             "group": "Body",
12594             "type": "String",
12595             "optional": true,
12596             "field": "content",
12597             "description": ""
12598           },
12599           {
12600             "group": "Body",
12601             "type": "String",
12602             "optional": true,
12603             "field": "key",
12604             "description": ""
12605           },
12606           {
12607             "group": "Body",
12608             "type": "String",
12609             "allowedValues": [
12610               "\"string\"",
12611               "\"variable\"",
12612               "\"customVariable\""
12613             ],
12614             "optional": true,
12615             "field": "keyType",
12616             "description": ""
12617           },
12618           {
12619             "group": "Body",
12620             "type": "String",
12621             "optional": true,
12622             "field": "keyContent",
12623             "description": ""
12624           },
12625           {
12626             "group": "Body",
12627             "type": "String",
12628             "optional": true,
12629             "field": "idField",
12630             "description": ""
12631           },
12632           {
12633             "group": "Body",
12634             "type": "String",
12635             "optional": true,
12636             "field": "nameField",
12637             "description": ""
12638           },
12639           {
12640             "group": "Body",
12641             "type": "Boolean",
12642             "optional": true,
12643             "field": "customField",
12644             "description": ""
12645           },
12646           {
12647             "group": "Body",
12648             "type": "String",
12649             "optional": true,
12650             "field": "variableName",
12651             "description": ""
12652           }
12653         ]
12654       }
12655     },
12656     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12657     "version": "0.0.0",
12658     "filename": "server/api/intFreshsalesField/index.js",
12659     "groupTitle": "Freshsales_Fields"
12660   },
12661   {
12662     "type": "delete",
12663     "url": "/api/integrations/freshsales/fields/{id}",
12664     "title": "Deletes a Freshsales Field",
12665     "examples": [
12666       {
12667         "title": "Example usage:",
12668         "content": "curl https://{domain}/api/integrations/freshsales/fields/{id} -v -u {name}:{password} -X DELETE",
12669         "type": "json"
12670       }
12671     ],
12672     "name": "DeleteFreshsales_Fields",
12673     "group": "Freshsales_Fields",
12674     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12675     "version": "0.0.0",
12676     "filename": "server/api/intFreshsalesField/index.js",
12677     "groupTitle": "Freshsales_Fields"
12678   },
12679   {
12680     "type": "get",
12681     "url": "/api/integrations/freshsales/fields",
12682     "title": "Gets a list of Freshsales Fields",
12683     "examples": [
12684       {
12685         "title": "Example usage:",
12686         "content": "curl https://{domain}/api/integrations/freshsales/fields -v -u {name}:{password}",
12687         "type": "json"
12688       }
12689     ],
12690     "name": "GetFreshsales_Fields",
12691     "group": "Freshsales_Fields",
12692     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
12693     "version": "0.0.0",
12694     "filename": "server/api/intFreshsalesField/index.js",
12695     "groupTitle": "Freshsales_Fields"
12696   },
12697   {
12698     "type": "get",
12699     "url": "/api/integrations/freshsales/fields/{id}",
12700     "title": "Gets a single Freshsales Field",
12701     "examples": [
12702       {
12703         "title": "Example usage:",
12704         "content": "curl https://{domain}/api/integrations/freshsales/fields/{id} -v -u {name}:{password}",
12705         "type": "json"
12706       }
12707     ],
12708     "name": "ShowFreshsales_Fields",
12709     "group": "Freshsales_Fields",
12710     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12711     "version": "0.0.0",
12712     "filename": "server/api/intFreshsalesField/index.js",
12713     "groupTitle": "Freshsales_Fields"
12714   },
12715   {
12716     "type": "put",
12717     "url": "/api/integrations/freshsales/fields/{id}",
12718     "title": "Update an existing Freshsales Field",
12719     "examples": [
12720       {
12721         "title": "Example usage:",
12722         "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",
12723         "type": "json"
12724       }
12725     ],
12726     "name": "updateFreshsales_Fields",
12727     "group": "Freshsales_Fields",
12728     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12729     "version": "0.0.0",
12730     "filename": "server/api/intFreshsalesField/index.js",
12731     "groupTitle": "Freshsales_Fields"
12732   },
12733   {
12734     "type": "post",
12735     "url": "/api/campaigns/{id}/blacklists",
12736     "title": "Add blacklists to an IVR campaign",
12737     "examples": [
12738       {
12739         "title": "Example usage:",
12740         "content": "curl https://{domain}/api/campaigns/{id}/blacklists -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
12741         "type": "json"
12742       }
12743     ],
12744     "name": "AddBlackLists",
12745     "group": "IVR_Campaigns",
12746     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12747     "version": "0.0.0",
12748     "filename": "server/api/campaign/index.js",
12749     "groupTitle": "IVR_Campaigns"
12750   },
12751   {
12752     "type": "post",
12753     "url": "/api/campaigns/{id}/lists",
12754     "title": "Add lists to an IVR campaign",
12755     "examples": [
12756       {
12757         "title": "Example usage:",
12758         "content": "curl https://{domain}/api/campaigns/{id}/lists -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
12759         "type": "json"
12760       }
12761     ],
12762     "name": "AddLists",
12763     "group": "IVR_Campaigns",
12764     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12765     "version": "0.0.0",
12766     "filename": "server/api/campaign/index.js",
12767     "groupTitle": "IVR_Campaigns"
12768   },
12769   {
12770     "type": "post",
12771     "url": "/api/campaigns/clone",
12772     "title": "Clone an existing IVR Campaign",
12773     "examples": [
12774       {
12775         "title": "Example usage:",
12776         "content": "curl https://{domain}/api/campaigns/clone -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
12777         "type": "json"
12778       }
12779     ],
12780     "name": "CloneIVR_Campaigns",
12781     "group": "IVR_Campaigns",
12782     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12783     "version": "0.0.0",
12784     "filename": "server/api/campaign/index.js",
12785     "groupTitle": "IVR_Campaigns"
12786   },
12787   {
12788     "type": "post",
12789     "url": "/api/campaigns",
12790     "title": "Creates a new IVR Campaign",
12791     "examples": [
12792       {
12793         "title": "Example usage:",
12794         "content": "curl https://{domain}/api/campaigns -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
12795         "type": "json"
12796       }
12797     ],
12798     "name": "CreateIVR_Campaigns",
12799     "group": "IVR_Campaigns",
12800     "parameter": {
12801       "fields": {
12802         "Body": [
12803           {
12804             "group": "Body",
12805             "type": "String",
12806             "optional": false,
12807             "field": "name",
12808             "description": ""
12809           },
12810           {
12811             "group": "Body",
12812             "type": "String",
12813             "allowedValues": [
12814               "\"ivr\""
12815             ],
12816             "optional": false,
12817             "field": "type",
12818             "description": ""
12819           },
12820           {
12821             "group": "Body",
12822             "type": "String",
12823             "optional": true,
12824             "field": "description",
12825             "description": ""
12826           },
12827           {
12828             "group": "Body",
12829             "type": "Boolean",
12830             "optional": true,
12831             "field": "active",
12832             "description": "<p>Active/Disactive Campaign</p>"
12833           },
12834           {
12835             "group": "Body",
12836             "type": "Integer",
12837             "optional": true,
12838             "field": "limitCalls",
12839             "description": "<p>Max 200 calls.</p>"
12840           },
12841           {
12842             "group": "Body",
12843             "type": "String",
12844             "optional": true,
12845             "field": "dialOriginateCallerIdName",
12846             "description": ""
12847           },
12848           {
12849             "group": "Body",
12850             "type": "String",
12851             "optional": true,
12852             "field": "dialOriginateCallerIdNumber",
12853             "description": ""
12854           },
12855           {
12856             "group": "Body",
12857             "type": "Integer",
12858             "optional": true,
12859             "field": "dialOriginateTimeout",
12860             "description": "<p>Originate Timeout Seconds (min:1, max:999)</p>"
12861           },
12862           {
12863             "group": "Body",
12864             "type": "Integer",
12865             "optional": true,
12866             "field": "dialCongestionMaxRetry",
12867             "description": "<p>#Congestion Retry (min:1, max:999)</p>"
12868           },
12869           {
12870             "group": "Body",
12871             "type": "Integer",
12872             "optional": true,
12873             "field": "dialCongestionRetryFrequency",
12874             "description": "<p>Congestion Retry Frequency Minutes (min:1, max:99999)</p>"
12875           },
12876           {
12877             "group": "Body",
12878             "type": "Integer",
12879             "optional": true,
12880             "field": "dialBusyMaxRetry",
12881             "description": "<p>#Busy Retry (min:1, max:999)</p>"
12882           },
12883           {
12884             "group": "Body",
12885             "type": "Integer",
12886             "optional": true,
12887             "field": "dialBusyRetryFrequency",
12888             "description": "<p>Busy Retry Frequency Minutes (min:1, max:99999)</p>"
12889           },
12890           {
12891             "group": "Body",
12892             "type": "Integer",
12893             "optional": true,
12894             "field": "dialNoAnswerMaxRetry",
12895             "description": "<p>#NoAnswer Retry (min:1, max:999)</p>"
12896           },
12897           {
12898             "group": "Body",
12899             "type": "Integer",
12900             "optional": true,
12901             "field": "dialNoAnswerRetryFrequency",
12902             "description": "<p>NoAnswer Retry Frequency Minutes (min:1, max:99999)</p>"
12903           },
12904           {
12905             "group": "Body",
12906             "type": "Integer",
12907             "optional": true,
12908             "field": "dialGlobalMaxRetry",
12909             "description": "<p>#Global Max Retry (min:1, max:999)</p>"
12910           },
12911           {
12912             "group": "Body",
12913             "type": "String",
12914             "optional": true,
12915             "field": "dialTimezone",
12916             "description": ""
12917           },
12918           {
12919             "group": "Body",
12920             "type": "String",
12921             "optional": true,
12922             "field": "dialGlobalInterval",
12923             "description": ""
12924           },
12925           {
12926             "group": "Body",
12927             "type": "String",
12928             "allowedValues": [
12929               "\"always\"",
12930               "\"never\"",
12931               "\"onlyIfOpen\""
12932             ],
12933             "optional": true,
12934             "field": "dialCheckDuplicateType",
12935             "description": ""
12936           },
12937           {
12938             "group": "Body",
12939             "type": "Boolean",
12940             "optional": true,
12941             "field": "dialAMDActive",
12942             "description": "<p>Active/Disactive AMD</p>"
12943           },
12944           {
12945             "group": "Body",
12946             "type": "Integer",
12947             "optional": true,
12948             "field": "dialAMDInitialSilence",
12949             "description": "<p>#AMD Initial Silence</p>"
12950           },
12951           {
12952             "group": "Body",
12953             "type": "Integer",
12954             "optional": true,
12955             "field": "dialAMDGreeting",
12956             "description": "<p>#AMD Greeting</p>"
12957           },
12958           {
12959             "group": "Body",
12960             "type": "Integer",
12961             "optional": true,
12962             "field": "dialAMDAfterGreetingSilence",
12963             "description": "<p>#AMD After Greeting Silence</p>"
12964           },
12965           {
12966             "group": "Body",
12967             "type": "Integer",
12968             "optional": true,
12969             "field": "dialAMDTotalAnalysisTime",
12970             "description": "<p>#AMD Total Analysis Time</p>"
12971           },
12972           {
12973             "group": "Body",
12974             "type": "Integer",
12975             "optional": true,
12976             "field": "dialAMDMinWordLength",
12977             "description": "<p>#AMD Min Word Length</p>"
12978           },
12979           {
12980             "group": "Body",
12981             "type": "Integer",
12982             "optional": true,
12983             "field": "dialAMDBetweenWordsSilence",
12984             "description": "<p>#AMD Between Words Silence</p>"
12985           },
12986           {
12987             "group": "Body",
12988             "type": "Integer",
12989             "optional": true,
12990             "field": "dialAMDMaximumNumberOfWords",
12991             "description": "<p>#AMD Maximum Number Of Words</p>"
12992           },
12993           {
12994             "group": "Body",
12995             "type": "Integer",
12996             "optional": true,
12997             "field": "dialAMDSilenceThreshold",
12998             "description": "<p>#AMD Silence Threshold (min:0, max:32767)</p>"
12999           },
13000           {
13001             "group": "Body",
13002             "type": "Integer",
13003             "optional": true,
13004             "field": "dialAMDMaximumWordLength",
13005             "description": "<p>#AMD Maximum Word Length</p>"
13006           },
13007           {
13008             "group": "Body",
13009             "type": "String",
13010             "allowedValues": [
13011               "\"DESC\"",
13012               "\"ASC\""
13013             ],
13014             "optional": true,
13015             "field": "dialOrderByScheduledAt",
13016             "description": ""
13017           },
13018           {
13019             "group": "Body",
13020             "type": "String",
13021             "optional": true,
13022             "field": "dialPrefix",
13023             "description": ""
13024           },
13025           {
13026             "group": "Body",
13027             "type": "Integer",
13028             "optional": true,
13029             "field": "dialRandomLastDigitCallerIdNumber",
13030             "description": "<p>Random Last Digit (min:1, max:15)</p>"
13031           },
13032           {
13033             "group": "Body",
13034             "type": "Integer",
13035             "optional": true,
13036             "field": "dialCutDigit",
13037             "description": "<p>Cut Digit (min:1, max:15)</p>"
13038           },
13039           {
13040             "group": "Body",
13041             "type": "Integer",
13042             "optional": true,
13043             "field": "dialNoSuchNumberMaxRetry",
13044             "description": "<p>#NoSuchNumber Retry (min:1, max:999)</p>"
13045           },
13046           {
13047             "group": "Body",
13048             "type": "Integer",
13049             "optional": true,
13050             "field": "dialNoSuchNumberRetryFrequency",
13051             "description": "<p>NoSuchNumber Retry Frequency Minutes (min:1, max:99999)</p>"
13052           },
13053           {
13054             "group": "Body",
13055             "type": "Integer",
13056             "optional": true,
13057             "field": "dialDropMaxRetry",
13058             "description": "<p>#Drop Retry (min:1, max:999)</p>"
13059           },
13060           {
13061             "group": "Body",
13062             "type": "Integer",
13063             "optional": true,
13064             "field": "dialDropRetryFrequency",
13065             "description": "<p>Drop Retry Frequency Minutes (min:1, max:99999)</p>"
13066           },
13067           {
13068             "group": "Body",
13069             "type": "Integer",
13070             "optional": true,
13071             "field": "dialAbandonedMaxRetry",
13072             "description": "<p>#Abandoned Retry (min:1, max:999)</p>"
13073           },
13074           {
13075             "group": "Body",
13076             "type": "Integer",
13077             "optional": true,
13078             "field": "dialAbandonedRetryFrequency",
13079             "description": "<p>Abandoned Retry Frequency Minutes (min:1, max:99999)</p>"
13080           },
13081           {
13082             "group": "Body",
13083             "type": "Integer",
13084             "optional": true,
13085             "field": "dialMachineMaxRetry",
13086             "description": "<p>#Machine Retry (min:1, max:999)</p>"
13087           },
13088           {
13089             "group": "Body",
13090             "type": "Integer",
13091             "optional": true,
13092             "field": "dialMachineRetryFrequency",
13093             "description": "<p>Machine Retry Frequency Minutes (min:1, max:99999)</p>"
13094           },
13095           {
13096             "group": "Body",
13097             "type": "Integer",
13098             "optional": true,
13099             "field": "dialAgentRejectMaxRetry",
13100             "description": "<p>#AgentReject Retry (min:1, max:999)</p>"
13101           },
13102           {
13103             "group": "Body",
13104             "type": "Integer",
13105             "optional": true,
13106             "field": "dialAgentRejectRetryFrequency",
13107             "description": "<p>AgentReject Retry Frequency Minutes (min:1, max:99999)</p>"
13108           }
13109         ]
13110       }
13111     },
13112     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13113     "version": "0.0.0",
13114     "filename": "server/api/campaign/index.js",
13115     "groupTitle": "IVR_Campaigns"
13116   },
13117   {
13118     "type": "delete",
13119     "url": "/api/campaigns/{id}",
13120     "title": "Deletes a IVR Campaign",
13121     "examples": [
13122       {
13123         "title": "Example usage:",
13124         "content": "curl https://{domain}/api/campaigns/{id} -v -u {name}:{password} -X DELETE",
13125         "type": "json"
13126       }
13127     ],
13128     "name": "DeleteIVR_Campaigns",
13129     "group": "IVR_Campaigns",
13130     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13131     "version": "0.0.0",
13132     "filename": "server/api/campaign/index.js",
13133     "groupTitle": "IVR_Campaigns"
13134   },
13135   {
13136     "type": "get",
13137     "url": "/api/campaigns/{id}/blacklists",
13138     "title": "Get IVR campaign blacklists",
13139     "examples": [
13140       {
13141         "title": "Example usage:",
13142         "content": "curl https://{domain}/api/campaigns/{id}/blacklists -v -u {name}:{password} -X GET",
13143         "type": "json"
13144       }
13145     ],
13146     "name": "GetBlackLists",
13147     "group": "IVR_Campaigns",
13148     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13149     "version": "0.0.0",
13150     "filename": "server/api/campaign/index.js",
13151     "groupTitle": "IVR_Campaigns"
13152   },
13153   {
13154     "type": "get",
13155     "url": "/api/campaigns/{id}/finals",
13156     "title": "Gets IVR campaign hopper finals",
13157     "examples": [
13158       {
13159         "title": "Example usage:",
13160         "content": "curl https://{domain}/api/campaigns/{id}/hopper_finals -v -u {name}:{password}  -X GET",
13161         "type": "json"
13162       }
13163     ],
13164     "name": "GetHopperFinals",
13165     "group": "IVR_Campaigns",
13166     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13167     "version": "0.0.0",
13168     "filename": "server/api/campaign/index.js",
13169     "groupTitle": "IVR_Campaigns"
13170   },
13171   {
13172     "type": "get",
13173     "url": "/api/campaigns/{id}/hopper_histories",
13174     "title": "Gets IVR campaign hopper histories",
13175     "examples": [
13176       {
13177         "title": "Example usage:",
13178         "content": "curl https://{domain}/api/campaigns/{id}/hopper_histories -v -u {name}:{password} -X GET",
13179         "type": "json"
13180       }
13181     ],
13182     "name": "GetHopperHistories",
13183     "group": "IVR_Campaigns",
13184     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13185     "version": "0.0.0",
13186     "filename": "server/api/campaign/index.js",
13187     "groupTitle": "IVR_Campaigns"
13188   },
13189   {
13190     "type": "get",
13191     "url": "/api/campaigns/{id}/hoppers",
13192     "title": "Gets IVR campaign hoppers",
13193     "examples": [
13194       {
13195         "title": "Example usage:",
13196         "content": "curl https://{domain}/api/campaigns/{id}/hoppers -v -u {name}:{password} -X GET",
13197         "type": "json"
13198       }
13199     ],
13200     "name": "GetHoppers",
13201     "group": "IVR_Campaigns",
13202     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13203     "version": "0.0.0",
13204     "filename": "server/api/campaign/index.js",
13205     "groupTitle": "IVR_Campaigns"
13206   },
13207   {
13208     "type": "get",
13209     "url": "/api/campaigns",
13210     "title": "Gets a list of IVR Campaigns",
13211     "examples": [
13212       {
13213         "title": "Example usage:",
13214         "content": "curl https://{domain}/api/campaigns -v -u {name}:{password}",
13215         "type": "json"
13216       }
13217     ],
13218     "name": "GetIVR_Campaigns",
13219     "group": "IVR_Campaigns",
13220     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
13221     "version": "0.0.0",
13222     "filename": "server/api/campaign/index.js",
13223     "groupTitle": "IVR_Campaigns"
13224   },
13225   {
13226     "type": "get",
13227     "url": "/api/campaigns/{id}/lists",
13228     "title": "Get IVR campaign lists",
13229     "examples": [
13230       {
13231         "title": "Example usage:",
13232         "content": "curl https://{domain}/api/campaigns/{id}/lists -v -u {name}:{password} -X GET",
13233         "type": "json"
13234       }
13235     ],
13236     "name": "GetLists",
13237     "group": "IVR_Campaigns",
13238     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13239     "version": "0.0.0",
13240     "filename": "server/api/campaign/index.js",
13241     "groupTitle": "IVR_Campaigns"
13242   },
13243   {
13244     "type": "delete",
13245     "url": "/api/campaigns/{id}/blacklists",
13246     "title": "Remove blacklists from an IVR Campaign",
13247     "examples": [
13248       {
13249         "title": "Example usage:",
13250         "content": "curl https://{domain}/api/campaigns/{id}/blacklists?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
13251         "type": "json"
13252       }
13253     ],
13254     "name": "RemoveBlackLists",
13255     "group": "IVR_Campaigns",
13256     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13257     "version": "0.0.0",
13258     "filename": "server/api/campaign/index.js",
13259     "groupTitle": "IVR_Campaigns"
13260   },
13261   {
13262     "type": "delete",
13263     "url": "/api/campaigns/{id}/lists",
13264     "title": "Remove lists from an IVR Campaign",
13265     "examples": [
13266       {
13267         "title": "Example usage:",
13268         "content": "curl https://{domain}/api/campaigns/{id}/lists?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
13269         "type": "json"
13270       }
13271     ],
13272     "name": "RemoveLists",
13273     "group": "IVR_Campaigns",
13274     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13275     "version": "0.0.0",
13276     "filename": "server/api/campaign/index.js",
13277     "groupTitle": "IVR_Campaigns"
13278   },
13279   {
13280     "type": "get",
13281     "url": "/api/campaigns/{id}",
13282     "title": "Gets a single IVR Campaign",
13283     "examples": [
13284       {
13285         "title": "Example usage:",
13286         "content": "curl https://{domain}/api/campaigns/{id} -v -u {name}:{password}",
13287         "type": "json"
13288       }
13289     ],
13290     "name": "ShowIVR_Campaigns",
13291     "group": "IVR_Campaigns",
13292     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13293     "version": "0.0.0",
13294     "filename": "server/api/campaign/index.js",
13295     "groupTitle": "IVR_Campaigns"
13296   },
13297   {
13298     "type": "get",
13299     "url": "/api/campaigns/{id}/blacks",
13300     "title": "Gets IVR campaign hopper blacks",
13301     "examples": [
13302       {
13303         "title": "Example usage:",
13304         "content": "curl https://{domain}/api/campaigns/{id}/hopper_black -v -u {name}:{password}  -X GET",
13305         "type": "json"
13306       }
13307     ],
13308     "name": "getHopperBlacks",
13309     "group": "IVR_Campaigns",
13310     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13311     "version": "0.0.0",
13312     "filename": "server/api/campaign/index.js",
13313     "groupTitle": "IVR_Campaigns"
13314   },
13315   {
13316     "type": "put",
13317     "url": "/api/campaigns/{id}",
13318     "title": "Update an existing IVR Campaign",
13319     "examples": [
13320       {
13321         "title": "Example usage:",
13322         "content": "curl https://{domain}/api/campaigns/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
13323         "type": "json"
13324       }
13325     ],
13326     "name": "updateIVR_Campaigns",
13327     "group": "IVR_Campaigns",
13328     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13329     "version": "0.0.0",
13330     "filename": "server/api/campaign/index.js",
13331     "groupTitle": "IVR_Campaigns"
13332   },
13333   {
13334     "type": "post",
13335     "url": "/api/integrations/reports",
13336     "title": "Creates a new Integration Report",
13337     "examples": [
13338       {
13339         "title": "Example usage:",
13340         "content": "curl https://{domain}/api/integrations/reports -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
13341         "type": "json"
13342       }
13343     ],
13344     "name": "CreateIntegration_Reports",
13345     "group": "Integration_Reports",
13346     "parameter": {
13347       "fields": {
13348         "Body": [
13349           {
13350             "group": "Body",
13351             "type": "String",
13352             "optional": true,
13353             "field": "integration",
13354             "description": ""
13355           },
13356           {
13357             "group": "Body",
13358             "type": "String",
13359             "optional": true,
13360             "field": "eventChannel",
13361             "description": ""
13362           },
13363           {
13364             "group": "Body",
13365             "type": "String",
13366             "optional": true,
13367             "field": "exitStatus",
13368             "description": ""
13369           },
13370           {
13371             "group": "Body",
13372             "type": "String",
13373             "optional": true,
13374             "field": "ticketId",
13375             "description": ""
13376           },
13377           {
13378             "group": "Body",
13379             "type": "Integer",
13380             "optional": true,
13381             "field": "integrationId",
13382             "description": ""
13383           },
13384           {
13385             "group": "Body",
13386             "type": "String",
13387             "optional": true,
13388             "field": "contacts",
13389             "description": ""
13390           },
13391           {
13392             "group": "Body",
13393             "type": "String",
13394             "optional": true,
13395             "field": "uniqueid",
13396             "description": ""
13397           },
13398           {
13399             "group": "Body",
13400             "type": "String",
13401             "optional": true,
13402             "field": "calleridnum",
13403             "description": ""
13404           },
13405           {
13406             "group": "Body",
13407             "type": "String",
13408             "optional": true,
13409             "field": "calleridname",
13410             "description": ""
13411           },
13412           {
13413             "group": "Body",
13414             "type": "String",
13415             "optional": true,
13416             "field": "queue",
13417             "description": ""
13418           },
13419           {
13420             "group": "Body",
13421             "type": "String",
13422             "optional": true,
13423             "field": "interface",
13424             "description": ""
13425           },
13426           {
13427             "group": "Body",
13428             "type": "String",
13429             "optional": true,
13430             "field": "membername",
13431             "description": ""
13432           },
13433           {
13434             "group": "Body",
13435             "type": "String",
13436             "optional": true,
13437             "field": "agentcalledAt",
13438             "description": ""
13439           },
13440           {
13441             "group": "Body",
13442             "type": "String",
13443             "optional": true,
13444             "field": "agentconnectAt",
13445             "description": ""
13446           },
13447           {
13448             "group": "Body",
13449             "type": "Integer",
13450             "optional": true,
13451             "field": "holdtime",
13452             "description": ""
13453           },
13454           {
13455             "group": "Body",
13456             "type": "Boolean",
13457             "optional": true,
13458             "field": "agentcomplete",
13459             "description": ""
13460           },
13461           {
13462             "group": "Body",
13463             "type": "String",
13464             "optional": true,
13465             "field": "agentcompleteAt",
13466             "description": ""
13467           },
13468           {
13469             "group": "Body",
13470             "type": "Integer",
13471             "optional": true,
13472             "field": "talktime",
13473             "description": ""
13474           },
13475           {
13476             "group": "Body",
13477             "type": "Boolean",
13478             "optional": true,
13479             "field": "agentacw",
13480             "description": ""
13481           },
13482           {
13483             "group": "Body",
13484             "type": "Integer",
13485             "optional": true,
13486             "field": "acwtime",
13487             "description": ""
13488           },
13489           {
13490             "group": "Body",
13491             "type": "String",
13492             "optional": true,
13493             "field": "reason",
13494             "description": ""
13495           },
13496           {
13497             "group": "Body",
13498             "type": "Boolean",
13499             "optional": true,
13500             "field": "agentringnoanswer",
13501             "description": ""
13502           },
13503           {
13504             "group": "Body",
13505             "type": "String",
13506             "optional": true,
13507             "field": "agentringnoanswerAt",
13508             "description": ""
13509           },
13510           {
13511             "group": "Body",
13512             "type": "Boolean",
13513             "optional": true,
13514             "field": "agentdump",
13515             "description": ""
13516           },
13517           {
13518             "group": "Body",
13519             "type": "String",
13520             "optional": true,
13521             "field": "agentdumpAt",
13522             "description": ""
13523           },
13524           {
13525             "group": "Body",
13526             "type": "String",
13527             "optional": true,
13528             "field": "lastevent",
13529             "description": ""
13530           },
13531           {
13532             "group": "Body",
13533             "type": "String",
13534             "optional": true,
13535             "field": "channel",
13536             "description": ""
13537           },
13538           {
13539             "group": "Body",
13540             "type": "Integer",
13541             "optional": true,
13542             "field": "channelstate",
13543             "description": ""
13544           },
13545           {
13546             "group": "Body",
13547             "type": "String",
13548             "optional": true,
13549             "field": "channelstatedesc",
13550             "description": ""
13551           },
13552           {
13553             "group": "Body",
13554             "type": "String",
13555             "optional": true,
13556             "field": "connectedlinenum",
13557             "description": ""
13558           },
13559           {
13560             "group": "Body",
13561             "type": "String",
13562             "optional": true,
13563             "field": "connectedlinename",
13564             "description": ""
13565           },
13566           {
13567             "group": "Body",
13568             "type": "String",
13569             "optional": true,
13570             "field": "language",
13571             "description": ""
13572           },
13573           {
13574             "group": "Body",
13575             "type": "String",
13576             "optional": true,
13577             "field": "accountcode",
13578             "description": ""
13579           },
13580           {
13581             "group": "Body",
13582             "type": "String",
13583             "optional": true,
13584             "field": "context",
13585             "description": ""
13586           },
13587           {
13588             "group": "Body",
13589             "type": "String",
13590             "optional": true,
13591             "field": "exten",
13592             "description": ""
13593           },
13594           {
13595             "group": "Body",
13596             "type": "String",
13597             "optional": true,
13598             "field": "priority",
13599             "description": ""
13600           },
13601           {
13602             "group": "Body",
13603             "type": "String",
13604             "optional": true,
13605             "field": "destchannel",
13606             "description": ""
13607           },
13608           {
13609             "group": "Body",
13610             "type": "Integer",
13611             "optional": true,
13612             "field": "destchannelstate",
13613             "description": ""
13614           },
13615           {
13616             "group": "Body",
13617             "type": "String",
13618             "optional": true,
13619             "field": "destchannelstatedesc",
13620             "description": ""
13621           },
13622           {
13623             "group": "Body",
13624             "type": "String",
13625             "optional": true,
13626             "field": "destcalleridnum",
13627             "description": ""
13628           },
13629           {
13630             "group": "Body",
13631             "type": "String",
13632             "optional": true,
13633             "field": "destcalleridname",
13634             "description": ""
13635           },
13636           {
13637             "group": "Body",
13638             "type": "String",
13639             "optional": true,
13640             "field": "destconnectedlinenum",
13641             "description": ""
13642           },
13643           {
13644             "group": "Body",
13645             "type": "String",
13646             "optional": true,
13647             "field": "destconnectedlinename",
13648             "description": ""
13649           },
13650           {
13651             "group": "Body",
13652             "type": "String",
13653             "optional": true,
13654             "field": "destlanguage",
13655             "description": ""
13656           },
13657           {
13658             "group": "Body",
13659             "type": "String",
13660             "optional": true,
13661             "field": "destaccountcode",
13662             "description": ""
13663           },
13664           {
13665             "group": "Body",
13666             "type": "String",
13667             "optional": true,
13668             "field": "destcontext",
13669             "description": ""
13670           },
13671           {
13672             "group": "Body",
13673             "type": "String",
13674             "optional": true,
13675             "field": "destexten",
13676             "description": ""
13677           },
13678           {
13679             "group": "Body",
13680             "type": "String",
13681             "optional": true,
13682             "field": "destpriority",
13683             "description": ""
13684           },
13685           {
13686             "group": "Body",
13687             "type": "String",
13688             "optional": true,
13689             "field": "destuniqueid",
13690             "description": ""
13691           },
13692           {
13693             "group": "Body",
13694             "type": "String",
13695             "optional": true,
13696             "field": "messageId",
13697             "description": ""
13698           },
13699           {
13700             "group": "Body",
13701             "type": "String",
13702             "optional": true,
13703             "field": "inReplyTo",
13704             "description": ""
13705           },
13706           {
13707             "group": "Body",
13708             "type": "String",
13709             "optional": true,
13710             "field": "subject",
13711             "description": ""
13712           },
13713           {
13714             "group": "Body",
13715             "type": "String",
13716             "optional": true,
13717             "field": "from",
13718             "description": ""
13719           },
13720           {
13721             "group": "Body",
13722             "type": "String",
13723             "optional": true,
13724             "field": "to",
13725             "description": ""
13726           },
13727           {
13728             "group": "Body",
13729             "type": "String",
13730             "optional": true,
13731             "field": "cc",
13732             "description": ""
13733           },
13734           {
13735             "group": "Body",
13736             "type": "Text",
13737             "optional": true,
13738             "field": "attachment",
13739             "description": ""
13740           },
13741           {
13742             "group": "Body",
13743             "type": "Text",
13744             "optional": true,
13745             "field": "html",
13746             "description": ""
13747           },
13748           {
13749             "group": "Body",
13750             "type": "Text",
13751             "optional": true,
13752             "field": "text",
13753             "description": ""
13754           },
13755           {
13756             "group": "Body",
13757             "type": "String",
13758             "allowedValues": [
13759               "\"SENT\"",
13760               "\"SENDING\"",
13761               "\"RECEIVED\"",
13762               "\"FAILED\""
13763             ],
13764             "optional": true,
13765             "field": "status",
13766             "description": ""
13767           },
13768           {
13769             "group": "Body",
13770             "type": "String",
13771             "optional": true,
13772             "field": "url",
13773             "description": ""
13774           },
13775           {
13776             "group": "Body",
13777             "type": "String",
13778             "optional": true,
13779             "field": "app",
13780             "description": ""
13781           },
13782           {
13783             "group": "Body",
13784             "type": "String",
13785             "optional": true,
13786             "field": "appdata",
13787             "description": ""
13788           },
13789           {
13790             "group": "Body",
13791             "type": "Integer",
13792             "optional": true,
13793             "field": "projectId",
13794             "description": ""
13795           }
13796         ]
13797       }
13798     },
13799     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13800     "version": "0.0.0",
13801     "filename": "server/api/integrationReport/index.js",
13802     "groupTitle": "Integration_Reports"
13803   },
13804   {
13805     "type": "delete",
13806     "url": "/api/integrations/reports/{id}",
13807     "title": "Deletes a Integration Report",
13808     "examples": [
13809       {
13810         "title": "Example usage:",
13811         "content": "curl https://{domain}/api/integrations/reports/{id} -v -u {name}:{password} -X DELETE",
13812         "type": "json"
13813       }
13814     ],
13815     "name": "DeleteIntegration_Reports",
13816     "group": "Integration_Reports",
13817     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13818     "version": "0.0.0",
13819     "filename": "server/api/integrationReport/index.js",
13820     "groupTitle": "Integration_Reports"
13821   },
13822   {
13823     "type": "get",
13824     "url": "/api/integrations/reports/describe",
13825     "title": "Gets table info about Integration Reports",
13826     "examples": [
13827       {
13828         "title": "Example usage:",
13829         "content": "curl https://{domain}/api/integrations/reports/describe -v -u {name}:{password}",
13830         "type": "json"
13831       }
13832     ],
13833     "name": "DescribeIntegration_Reports",
13834     "group": "Integration_Reports",
13835     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13836     "version": "0.0.0",
13837     "filename": "server/api/integrationReport/index.js",
13838     "groupTitle": "Integration_Reports"
13839   },
13840   {
13841     "type": "get",
13842     "url": "/api/integrations/reports",
13843     "title": "Gets a list of Integration Reports",
13844     "examples": [
13845       {
13846         "title": "Example usage:",
13847         "content": "curl https://{domain}/api/integrations/reports -v -u {name}:{password}",
13848         "type": "json"
13849       }
13850     ],
13851     "name": "GetIntegration_Reports",
13852     "group": "Integration_Reports",
13853     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
13854     "version": "0.0.0",
13855     "filename": "server/api/integrationReport/index.js",
13856     "groupTitle": "Integration_Reports"
13857   },
13858   {
13859     "type": "get",
13860     "url": "/api/integrations/reports/{id}",
13861     "title": "Gets a single Integration Report",
13862     "examples": [
13863       {
13864         "title": "Example usage:",
13865         "content": "curl https://{domain}/api/integrations/reports/{id} -v -u {name}:{password}",
13866         "type": "json"
13867       }
13868     ],
13869     "name": "ShowIntegration_Reports",
13870     "group": "Integration_Reports",
13871     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13872     "version": "0.0.0",
13873     "filename": "server/api/integrationReport/index.js",
13874     "groupTitle": "Integration_Reports"
13875   },
13876   {
13877     "type": "put",
13878     "url": "/api/integrations/reports/{id}",
13879     "title": "Update an existing Integration Report",
13880     "examples": [
13881       {
13882         "title": "Example usage:",
13883         "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",
13884         "type": "json"
13885       }
13886     ],
13887     "name": "updateIntegration_Reports",
13888     "group": "Integration_Reports",
13889     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13890     "version": "0.0.0",
13891     "filename": "server/api/integrationReport/index.js",
13892     "groupTitle": "Integration_Reports"
13893   },
13894   {
13895     "type": "post",
13896     "url": "/api/intervals",
13897     "title": "Creates a new Interval",
13898     "examples": [
13899       {
13900         "title": "Example usage:",
13901         "content": "curl https://{domain}/api/intervals -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
13902         "type": "json"
13903       }
13904     ],
13905     "name": "CreateIntervals",
13906     "group": "Intervals",
13907     "parameter": {
13908       "fields": {
13909         "Body": [
13910           {
13911             "group": "Body",
13912             "type": "String",
13913             "optional": true,
13914             "field": "name",
13915             "description": ""
13916           },
13917           {
13918             "group": "Body",
13919             "type": "String",
13920             "optional": true,
13921             "field": "description",
13922             "description": ""
13923           },
13924           {
13925             "group": "Body",
13926             "type": "String",
13927             "optional": true,
13928             "field": "interval",
13929             "description": ""
13930           }
13931         ]
13932       }
13933     },
13934     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13935     "version": "0.0.0",
13936     "filename": "server/api/interval/index.js",
13937     "groupTitle": "Intervals"
13938   },
13939   {
13940     "type": "delete",
13941     "url": "/api/intervals/{id}",
13942     "title": "Deletes a Interval",
13943     "examples": [
13944       {
13945         "title": "Example usage:",
13946         "content": "curl https://{domain}/api/intervals/{id} -v -u {name}:{password} -X DELETE",
13947         "type": "json"
13948       }
13949     ],
13950     "name": "DeleteIntervals",
13951     "group": "Intervals",
13952     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13953     "version": "0.0.0",
13954     "filename": "server/api/interval/index.js",
13955     "groupTitle": "Intervals"
13956   },
13957   {
13958     "type": "get",
13959     "url": "/api/intervals",
13960     "title": "Gets a list of Intervals",
13961     "examples": [
13962       {
13963         "title": "Example usage:",
13964         "content": "curl https://{domain}/api/intervals -v -u {name}:{password}",
13965         "type": "json"
13966       }
13967     ],
13968     "name": "GetIntervals",
13969     "group": "Intervals",
13970     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
13971     "version": "0.0.0",
13972     "filename": "server/api/interval/index.js",
13973     "groupTitle": "Intervals"
13974   },
13975   {
13976     "type": "get",
13977     "url": "/api/intervals/{id}",
13978     "title": "Gets a single Interval",
13979     "examples": [
13980       {
13981         "title": "Example usage:",
13982         "content": "curl https://{domain}/api/intervals/{id} -v -u {name}:{password}",
13983         "type": "json"
13984       }
13985     ],
13986     "name": "ShowIntervals",
13987     "group": "Intervals",
13988     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13989     "version": "0.0.0",
13990     "filename": "server/api/interval/index.js",
13991     "groupTitle": "Intervals"
13992   },
13993   {
13994     "type": "post",
13995     "url": "/api/intervals/{id}/sub_intervals",
13996     "title": "Creates a new sub interval",
13997     "examples": [
13998       {
13999         "title": "Example usage:",
14000         "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",
14001         "type": "json"
14002       }
14003     ],
14004     "name": "addInterval",
14005     "group": "Intervals",
14006     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14007     "version": "0.0.0",
14008     "filename": "server/api/interval/index.js",
14009     "groupTitle": "Intervals"
14010   },
14011   {
14012     "type": "post",
14013     "url": "/api/intervals/{id}/sub_intervals/create_many",
14014     "title": "Create new sub intervals set",
14015     "examples": [
14016       {
14017         "title": "Example usage:",
14018         "content": "curl https://{domain}/api/intervals/{id}/sub_intervals -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
14019         "type": "json"
14020       }
14021     ],
14022     "name": "addIntervals",
14023     "group": "Intervals",
14024     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14025     "version": "0.0.0",
14026     "filename": "server/api/interval/index.js",
14027     "groupTitle": "Intervals"
14028   },
14029   {
14030     "type": "get",
14031     "url": "/api/intervals/{id}/sub_intervals",
14032     "title": "Get sub intervals set",
14033     "examples": [
14034       {
14035         "title": "Example usage:",
14036         "content": "curl https://{domain}/api/intervals/{id}/sub_intervals -v -u {name}:{password} -X GET",
14037         "type": "json"
14038       }
14039     ],
14040     "name": "getIntervals",
14041     "group": "Intervals",
14042     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14043     "version": "0.0.0",
14044     "filename": "server/api/interval/index.js",
14045     "groupTitle": "Intervals"
14046   },
14047   {
14048     "type": "put",
14049     "url": "/api/intervals/{id}",
14050     "title": "Update an existing Interval",
14051     "examples": [
14052       {
14053         "title": "Example usage:",
14054         "content": "curl https://{domain}/api/intervals/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
14055         "type": "json"
14056       }
14057     ],
14058     "name": "updateIntervals",
14059     "group": "Intervals",
14060     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14061     "version": "0.0.0",
14062     "filename": "server/api/interval/index.js",
14063     "groupTitle": "Intervals"
14064   },
14065   {
14066     "type": "post",
14067     "url": "/api/jira",
14068     "title": "Creates a new issue",
14069     "examples": [
14070       {
14071         "title": "Example usage:",
14072         "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}",
14073         "type": "json"
14074       }
14075     ],
14076     "name": "Creates_Issue",
14077     "group": "Issue",
14078     "parameter": {
14079       "fields": {
14080         "Body": [
14081           {
14082             "group": "Body",
14083             "type": "String",
14084             "allowedValues": [
14085               "\"Bug\""
14086             ],
14087             "optional": true,
14088             "field": "issuetype",
14089             "description": ""
14090           },
14091           {
14092             "group": "Body",
14093             "type": "String",
14094             "optional": false,
14095             "field": "summary",
14096             "description": ""
14097           },
14098           {
14099             "group": "Body",
14100             "type": "String",
14101             "optional": false,
14102             "field": "description",
14103             "description": ""
14104           }
14105         ]
14106       }
14107     },
14108     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14109     "version": "0.0.0",
14110     "filename": "server/api/jira/index.js",
14111     "groupTitle": "Issue"
14112   },
14113   {
14114     "type": "post",
14115     "url": "/api/jscripty/answers/reports",
14116     "title": "Creates a new Report",
14117     "examples": [
14118       {
14119         "title": "Example usage:",
14120         "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",
14121         "type": "json"
14122       }
14123     ],
14124     "name": "CreateReports",
14125     "group": "JscriptyAnswerReport",
14126     "parameter": {
14127       "fields": {
14128         "Body": [
14129           {
14130             "group": "Body",
14131             "type": "Text",
14132             "optional": true,
14133             "field": "question",
14134             "description": ""
14135           },
14136           {
14137             "group": "Body",
14138             "type": "Text",
14139             "optional": true,
14140             "field": "answer",
14141             "description": ""
14142           },
14143           {
14144             "group": "Body",
14145             "type": "String",
14146             "optional": true,
14147             "field": "membername",
14148             "description": ""
14149           },
14150           {
14151             "group": "Body",
14152             "type": "String",
14153             "optional": true,
14154             "field": "projectname",
14155             "description": ""
14156           },
14157           {
14158             "group": "Body",
14159             "type": "String",
14160             "optional": true,
14161             "field": "queue",
14162             "description": ""
14163           },
14164           {
14165             "group": "Body",
14166             "type": "String",
14167             "optional": true,
14168             "field": "uniqueid",
14169             "description": ""
14170           },
14171           {
14172             "group": "Body",
14173             "type": "String",
14174             "optional": true,
14175             "field": "calleridname",
14176             "description": ""
14177           },
14178           {
14179             "group": "Body",
14180             "type": "String",
14181             "optional": true,
14182             "field": "calleridnum",
14183             "description": ""
14184           },
14185           {
14186             "group": "Body",
14187             "type": "String",
14188             "optional": true,
14189             "field": "questionId",
14190             "description": ""
14191           }
14192         ]
14193       }
14194     },
14195     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14196     "version": "0.0.0",
14197     "filename": "server/api/jscriptyAnswerReport/index.js",
14198     "groupTitle": "JscriptyAnswerReport"
14199   },
14200   {
14201     "type": "delete",
14202     "url": "/api/jscripty/answers/reports/{id}",
14203     "title": "Deletes a Report",
14204     "examples": [
14205       {
14206         "title": "Example usage:",
14207         "content": "curl https://{domain}/api/jscripty/answers/reports/{id} -v -u {name}:{password} -X DELETE",
14208         "type": "json"
14209       }
14210     ],
14211     "name": "DeleteReports",
14212     "group": "JscriptyAnswerReport",
14213     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14214     "version": "0.0.0",
14215     "filename": "server/api/jscriptyAnswerReport/index.js",
14216     "groupTitle": "JscriptyAnswerReport"
14217   },
14218   {
14219     "type": "get",
14220     "url": "/api/jscripty/answers/reports/describe",
14221     "title": "Gets table info about Reports",
14222     "examples": [
14223       {
14224         "title": "Example usage:",
14225         "content": "curl https://{domain}/api/jscripty/answers/reports/describe -v -u {name}:{password}",
14226         "type": "json"
14227       }
14228     ],
14229     "name": "DescribeReports",
14230     "group": "JscriptyAnswerReport",
14231     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14232     "version": "0.0.0",
14233     "filename": "server/api/jscriptyAnswerReport/index.js",
14234     "groupTitle": "JscriptyAnswerReport"
14235   },
14236   {
14237     "type": "get",
14238     "url": "/api/jscripty/answers/reports",
14239     "title": "Gets a list of Reports",
14240     "examples": [
14241       {
14242         "title": "Example usage:",
14243         "content": "curl https://{domain}/api/jscripty/answers/reports -v -u {name}:{password}",
14244         "type": "json"
14245       }
14246     ],
14247     "name": "GetReports",
14248     "group": "JscriptyAnswerReport",
14249     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
14250     "version": "0.0.0",
14251     "filename": "server/api/jscriptyAnswerReport/index.js",
14252     "groupTitle": "JscriptyAnswerReport"
14253   },
14254   {
14255     "type": "get",
14256     "url": "/api/jscripty/answers/reports/{id}",
14257     "title": "Gets a single Report",
14258     "examples": [
14259       {
14260         "title": "Example usage:",
14261         "content": "curl https://{domain}/api/jscripty/answers/reports/{id} -v -u {name}:{password}",
14262         "type": "json"
14263       }
14264     ],
14265     "name": "ShowReports",
14266     "group": "JscriptyAnswerReport",
14267     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14268     "version": "0.0.0",
14269     "filename": "server/api/jscriptyAnswerReport/index.js",
14270     "groupTitle": "JscriptyAnswerReport"
14271   },
14272   {
14273     "type": "put",
14274     "url": "/api/jscripty/answers/reports/{id}",
14275     "title": "Update an existing Report",
14276     "examples": [
14277       {
14278         "title": "Example usage:",
14279         "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",
14280         "type": "json"
14281       }
14282     ],
14283     "name": "updateReports",
14284     "group": "JscriptyAnswerReport",
14285     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14286     "version": "0.0.0",
14287     "filename": "server/api/jscriptyAnswerReport/index.js",
14288     "groupTitle": "JscriptyAnswerReport"
14289   },
14290   {
14291     "type": "post",
14292     "url": "/api/jscripty/questions/reports",
14293     "title": "Creates a new Report",
14294     "examples": [
14295       {
14296         "title": "Example usage:",
14297         "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",
14298         "type": "json"
14299       }
14300     ],
14301     "name": "CreateReports",
14302     "group": "JscriptyQuestionReport",
14303     "parameter": {
14304       "fields": {
14305         "Body": [
14306           {
14307             "group": "Body",
14308             "type": "Text",
14309             "optional": true,
14310             "field": "question",
14311             "description": ""
14312           },
14313           {
14314             "group": "Body",
14315             "type": "Text",
14316             "optional": true,
14317             "field": "answer",
14318             "description": ""
14319           },
14320           {
14321             "group": "Body",
14322             "type": "String",
14323             "optional": true,
14324             "field": "membername",
14325             "description": ""
14326           },
14327           {
14328             "group": "Body",
14329             "type": "String",
14330             "optional": true,
14331             "field": "projectname",
14332             "description": ""
14333           },
14334           {
14335             "group": "Body",
14336             "type": "String",
14337             "optional": true,
14338             "field": "queue",
14339             "description": ""
14340           },
14341           {
14342             "group": "Body",
14343             "type": "String",
14344             "optional": true,
14345             "field": "uniqueid",
14346             "description": ""
14347           },
14348           {
14349             "group": "Body",
14350             "type": "String",
14351             "optional": true,
14352             "field": "calleridname",
14353             "description": ""
14354           },
14355           {
14356             "group": "Body",
14357             "type": "String",
14358             "optional": true,
14359             "field": "calleridnum",
14360             "description": ""
14361           },
14362           {
14363             "group": "Body",
14364             "type": "String",
14365             "optional": true,
14366             "field": "questionId",
14367             "description": ""
14368           }
14369         ]
14370       }
14371     },
14372     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14373     "version": "0.0.0",
14374     "filename": "server/api/jscriptyQuestionReport/index.js",
14375     "groupTitle": "JscriptyQuestionReport"
14376   },
14377   {
14378     "type": "delete",
14379     "url": "/api/jscripty/questions/reports/{id}",
14380     "title": "Deletes a Report",
14381     "examples": [
14382       {
14383         "title": "Example usage:",
14384         "content": "curl https://{domain}/api/jscripty/questions/reports/{id} -v -u {name}:{password} -X DELETE",
14385         "type": "json"
14386       }
14387     ],
14388     "name": "DeleteReports",
14389     "group": "JscriptyQuestionReport",
14390     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14391     "version": "0.0.0",
14392     "filename": "server/api/jscriptyQuestionReport/index.js",
14393     "groupTitle": "JscriptyQuestionReport"
14394   },
14395   {
14396     "type": "get",
14397     "url": "/api/jscripty/questions/reports/describe",
14398     "title": "Gets table info about Reports",
14399     "examples": [
14400       {
14401         "title": "Example usage:",
14402         "content": "curl https://{domain}/api/jscripty/questions/reports/describe -v -u {name}:{password}",
14403         "type": "json"
14404       }
14405     ],
14406     "name": "DescribeReports",
14407     "group": "JscriptyQuestionReport",
14408     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14409     "version": "0.0.0",
14410     "filename": "server/api/jscriptyQuestionReport/index.js",
14411     "groupTitle": "JscriptyQuestionReport"
14412   },
14413   {
14414     "type": "get",
14415     "url": "/api/jscripty/questions/reports",
14416     "title": "Gets a list of Reports",
14417     "examples": [
14418       {
14419         "title": "Example usage:",
14420         "content": "curl https://{domain}/api/jscripty/questions/reports -v -u {name}:{password}",
14421         "type": "json"
14422       }
14423     ],
14424     "name": "GetReports",
14425     "group": "JscriptyQuestionReport",
14426     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
14427     "version": "0.0.0",
14428     "filename": "server/api/jscriptyQuestionReport/index.js",
14429     "groupTitle": "JscriptyQuestionReport"
14430   },
14431   {
14432     "type": "get",
14433     "url": "/api/jscripty/questions/reports/{id}",
14434     "title": "Gets a single Report",
14435     "examples": [
14436       {
14437         "title": "Example usage:",
14438         "content": "curl https://{domain}/api/jscripty/questions/reports/{id} -v -u {name}:{password}",
14439         "type": "json"
14440       }
14441     ],
14442     "name": "ShowReports",
14443     "group": "JscriptyQuestionReport",
14444     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14445     "version": "0.0.0",
14446     "filename": "server/api/jscriptyQuestionReport/index.js",
14447     "groupTitle": "JscriptyQuestionReport"
14448   },
14449   {
14450     "type": "put",
14451     "url": "/api/jscripty/questions/reports/{id}",
14452     "title": "Update an existing Report",
14453     "examples": [
14454       {
14455         "title": "Example usage:",
14456         "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",
14457         "type": "json"
14458       }
14459     ],
14460     "name": "updateReports",
14461     "group": "JscriptyQuestionReport",
14462     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14463     "version": "0.0.0",
14464     "filename": "server/api/jscriptyQuestionReport/index.js",
14465     "groupTitle": "JscriptyQuestionReport"
14466   },
14467   {
14468     "type": "post",
14469     "url": "/api/jscripty/sessions/reports",
14470     "title": "Creates a new Report",
14471     "examples": [
14472       {
14473         "title": "Example usage:",
14474         "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",
14475         "type": "json"
14476       }
14477     ],
14478     "name": "CreateReports",
14479     "group": "JscriptySessionReport",
14480     "parameter": {
14481       "fields": {
14482         "Body": [
14483           {
14484             "group": "Body",
14485             "type": "String",
14486             "optional": true,
14487             "field": "starttime",
14488             "description": ""
14489           },
14490           {
14491             "group": "Body",
14492             "type": "String",
14493             "optional": true,
14494             "field": "endtime",
14495             "description": ""
14496           },
14497           {
14498             "group": "Body",
14499             "type": "String",
14500             "optional": true,
14501             "field": "membername",
14502             "description": ""
14503           },
14504           {
14505             "group": "Body",
14506             "type": "String",
14507             "optional": true,
14508             "field": "projectname",
14509             "description": ""
14510           },
14511           {
14512             "group": "Body",
14513             "type": "String",
14514             "optional": true,
14515             "field": "queue",
14516             "description": ""
14517           },
14518           {
14519             "group": "Body",
14520             "type": "String",
14521             "optional": true,
14522             "field": "uniqueid",
14523             "description": ""
14524           },
14525           {
14526             "group": "Body",
14527             "type": "String",
14528             "optional": true,
14529             "field": "calleridname",
14530             "description": ""
14531           },
14532           {
14533             "group": "Body",
14534             "type": "String",
14535             "optional": true,
14536             "field": "calleridnum",
14537             "description": ""
14538           },
14539           {
14540             "group": "Body",
14541             "type": "Boolean",
14542             "optional": true,
14543             "field": "completed",
14544             "description": ""
14545           }
14546         ]
14547       }
14548     },
14549     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14550     "version": "0.0.0",
14551     "filename": "server/api/jscriptySessionReport/index.js",
14552     "groupTitle": "JscriptySessionReport"
14553   },
14554   {
14555     "type": "delete",
14556     "url": "/api/jscripty/sessions/reports/{id}",
14557     "title": "Deletes a Report",
14558     "examples": [
14559       {
14560         "title": "Example usage:",
14561         "content": "curl https://{domain}/api/jscripty/sessions/reports/{id} -v -u {name}:{password} -X DELETE",
14562         "type": "json"
14563       }
14564     ],
14565     "name": "DeleteReports",
14566     "group": "JscriptySessionReport",
14567     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14568     "version": "0.0.0",
14569     "filename": "server/api/jscriptySessionReport/index.js",
14570     "groupTitle": "JscriptySessionReport"
14571   },
14572   {
14573     "type": "get",
14574     "url": "/api/jscripty/sessions/reports/describe",
14575     "title": "Gets table info about Reports",
14576     "examples": [
14577       {
14578         "title": "Example usage:",
14579         "content": "curl https://{domain}/api/jscripty/sessions/reports/describe -v -u {name}:{password}",
14580         "type": "json"
14581       }
14582     ],
14583     "name": "DescribeReports",
14584     "group": "JscriptySessionReport",
14585     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14586     "version": "0.0.0",
14587     "filename": "server/api/jscriptySessionReport/index.js",
14588     "groupTitle": "JscriptySessionReport"
14589   },
14590   {
14591     "type": "get",
14592     "url": "/api/jscripty/sessions/reports",
14593     "title": "Gets a list of Reports",
14594     "examples": [
14595       {
14596         "title": "Example usage:",
14597         "content": "curl https://{domain}/api/jscripty/sessions/reports -v -u {name}:{password}",
14598         "type": "json"
14599       }
14600     ],
14601     "name": "GetReports",
14602     "group": "JscriptySessionReport",
14603     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
14604     "version": "0.0.0",
14605     "filename": "server/api/jscriptySessionReport/index.js",
14606     "groupTitle": "JscriptySessionReport"
14607   },
14608   {
14609     "type": "get",
14610     "url": "/api/jscripty/sessions/reports/{id}",
14611     "title": "Gets a single Report",
14612     "examples": [
14613       {
14614         "title": "Example usage:",
14615         "content": "curl https://{domain}/api/jscripty/sessions/reports/{id} -v -u {name}:{password}",
14616         "type": "json"
14617       }
14618     ],
14619     "name": "ShowReports",
14620     "group": "JscriptySessionReport",
14621     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14622     "version": "0.0.0",
14623     "filename": "server/api/jscriptySessionReport/index.js",
14624     "groupTitle": "JscriptySessionReport"
14625   },
14626   {
14627     "type": "get",
14628     "url": "/api/jscripty/sessions/reports/{id}/questions",
14629     "title": "Gets Jscripty Session questions",
14630     "examples": [
14631       {
14632         "title": "Example usage:",
14633         "content": "curl https://{domain}/api/jscripty/sessions/reports/{id}/questions -v -u {name}:{password}  -X GET",
14634         "type": "json"
14635       }
14636     ],
14637     "name": "getQuestions",
14638     "group": "JscriptySessionReport",
14639     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14640     "version": "0.0.0",
14641     "filename": "server/api/jscriptySessionReport/index.js",
14642     "groupTitle": "JscriptySessionReport"
14643   },
14644   {
14645     "type": "put",
14646     "url": "/api/jscripty/sessions/reports/{id}",
14647     "title": "Update an existing Report",
14648     "examples": [
14649       {
14650         "title": "Example usage:",
14651         "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",
14652         "type": "json"
14653       }
14654     ],
14655     "name": "updateReports",
14656     "group": "JscriptySessionReport",
14657     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14658     "version": "0.0.0",
14659     "filename": "server/api/jscriptySessionReport/index.js",
14660     "groupTitle": "JscriptySessionReport"
14661   },
14662   {
14663     "type": "post",
14664     "url": "/api/jscripty/projects/clone",
14665     "title": "Clone an existing Project",
14666     "examples": [
14667       {
14668         "title": "Example usage:",
14669         "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",
14670         "type": "json"
14671       }
14672     ],
14673     "name": "CloneProjects",
14674     "group": "Jscripty_Projects",
14675     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14676     "version": "0.0.0",
14677     "filename": "server/api/jscriptyProject/index.js",
14678     "groupTitle": "Jscripty_Projects"
14679   },
14680   {
14681     "type": "post",
14682     "url": "/api/jscripty/projects",
14683     "title": "Creates a new Project",
14684     "examples": [
14685       {
14686         "title": "Example usage:",
14687         "content": "curl https://{domain}/api/jscripty/projects -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
14688         "type": "json"
14689       }
14690     ],
14691     "name": "CreateProjects",
14692     "group": "Jscripty_Projects",
14693     "parameter": {
14694       "fields": {
14695         "Body": [
14696           {
14697             "group": "Body",
14698             "type": "String",
14699             "optional": true,
14700             "field": "name",
14701             "description": ""
14702           },
14703           {
14704             "group": "Body",
14705             "type": "String",
14706             "optional": true,
14707             "field": "description",
14708             "description": ""
14709           },
14710           {
14711             "group": "Body",
14712             "type": "Text",
14713             "optional": true,
14714             "field": "formData",
14715             "description": ""
14716           },
14717           {
14718             "group": "Body",
14719             "type": "Boolean",
14720             "optional": true,
14721             "field": "enableUncompleteSave",
14722             "description": ""
14723           },
14724           {
14725             "group": "Body",
14726             "type": "Boolean",
14727             "optional": true,
14728             "field": "sendUnpauseOnSubmit",
14729             "description": ""
14730           }
14731         ]
14732       }
14733     },
14734     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14735     "version": "0.0.0",
14736     "filename": "server/api/jscriptyProject/index.js",
14737     "groupTitle": "Jscripty_Projects"
14738   },
14739   {
14740     "type": "delete",
14741     "url": "/api/jscripty/projects/{id}",
14742     "title": "Deletes a Project",
14743     "examples": [
14744       {
14745         "title": "Example usage:",
14746         "content": "curl https://{domain}/api/jscripty/projects/{id} -v -u {name}:{password} -X DELETE",
14747         "type": "json"
14748       }
14749     ],
14750     "name": "DeleteProjects",
14751     "group": "Jscripty_Projects",
14752     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14753     "version": "0.0.0",
14754     "filename": "server/api/jscriptyProject/index.js",
14755     "groupTitle": "Jscripty_Projects"
14756   },
14757   {
14758     "type": "get",
14759     "url": "/api/jscripty/projects",
14760     "title": "Gets a list of Projects",
14761     "examples": [
14762       {
14763         "title": "Example usage:",
14764         "content": "curl https://{domain}/api/jscripty/projects -v -u {name}:{password}",
14765         "type": "json"
14766       }
14767     ],
14768     "name": "GetProjects",
14769     "group": "Jscripty_Projects",
14770     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
14771     "version": "0.0.0",
14772     "filename": "server/api/jscriptyProject/index.js",
14773     "groupTitle": "Jscripty_Projects"
14774   },
14775   {
14776     "type": "get",
14777     "url": "/api/jscripty/projects/{id}",
14778     "title": "Gets a single Project",
14779     "examples": [
14780       {
14781         "title": "Example usage:",
14782         "content": "curl https://{domain}/api/jscripty/projects/{id} -v -u {name}:{password}",
14783         "type": "json"
14784       }
14785     ],
14786     "name": "ShowProjects",
14787     "group": "Jscripty_Projects",
14788     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14789     "version": "0.0.0",
14790     "filename": "server/api/jscriptyProject/index.js",
14791     "groupTitle": "Jscripty_Projects"
14792   },
14793   {
14794     "type": "get",
14795     "url": "/api/jscripty/projects/{id}/answers",
14796     "title": "Gets jscripty project answers",
14797     "examples": [
14798       {
14799         "title": "Example usage:",
14800         "content": "curl https://{domain}/api/jscripty/projects/{id}/answers -v -u {name}:{password}  -X GET",
14801         "type": "json"
14802       }
14803     ],
14804     "name": "getAnswers",
14805     "group": "Jscripty_Projects",
14806     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14807     "version": "0.0.0",
14808     "filename": "server/api/jscriptyProject/index.js",
14809     "groupTitle": "Jscripty_Projects"
14810   },
14811   {
14812     "type": "get",
14813     "url": "/api/jscripty/projects/{id}/sessions",
14814     "title": "Gets jscripty project sessions",
14815     "examples": [
14816       {
14817         "title": "Example usage:",
14818         "content": "curl https://{domain}/api/jscripty/projects/{id}/sessions -v -u {name}:{password}  -X GET",
14819         "type": "json"
14820       }
14821     ],
14822     "name": "getSessions",
14823     "group": "Jscripty_Projects",
14824     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14825     "version": "0.0.0",
14826     "filename": "server/api/jscriptyProject/index.js",
14827     "groupTitle": "Jscripty_Projects"
14828   },
14829   {
14830     "type": "get",
14831     "url": "/api/jscripty/projects/{id}/summary",
14832     "title": "Gets jscripty project summary",
14833     "examples": [
14834       {
14835         "title": "Example usage:",
14836         "content": "curl https://{domain}/api/jscripty/projects/{id}/summary -v -u {name}:{password}  -X GET",
14837         "type": "json"
14838       }
14839     ],
14840     "name": "getSummary",
14841     "group": "Jscripty_Projects",
14842     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14843     "version": "0.0.0",
14844     "filename": "server/api/jscriptyProject/index.js",
14845     "groupTitle": "Jscripty_Projects"
14846   },
14847   {
14848     "type": "put",
14849     "url": "/api/jscripty/projects/{id}",
14850     "title": "Update an existing Project",
14851     "examples": [
14852       {
14853         "title": "Example usage:",
14854         "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",
14855         "type": "json"
14856       }
14857     ],
14858     "name": "updateProjects",
14859     "group": "Jscripty_Projects",
14860     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14861     "version": "0.0.0",
14862     "filename": "server/api/jscriptyProject/index.js",
14863     "groupTitle": "Jscripty_Projects"
14864   },
14865   {
14866     "type": "get",
14867     "url": "/api/license",
14868     "title": "Gets License Info",
14869     "examples": [
14870       {
14871         "title": "Example usage:",
14872         "content": "curl https://{domain}/api/license -v -u {name}:{password} -X GET",
14873         "type": "json"
14874       }
14875     ],
14876     "name": "index",
14877     "group": "License",
14878     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14879     "version": "0.0.0",
14880     "filename": "server/api/license/index.js",
14881     "groupTitle": "License"
14882   },
14883   {
14884     "type": "put",
14885     "url": "/api/license/{id}",
14886     "title": "Update License Info",
14887     "examples": [
14888       {
14889         "title": "Example usage:",
14890         "content": "curl https://{domain}/api/license/{id} -v -u {name}:{password} -X PUT",
14891         "type": "json"
14892       }
14893     ],
14894     "name": "update",
14895     "group": "License",
14896     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14897     "version": "0.0.0",
14898     "filename": "server/api/license/index.js",
14899     "groupTitle": "License"
14900   },
14901   {
14902     "type": "post",
14903     "url": "/api/mail/accounts/{id}/users",
14904     "title": "Add agents to a mail account",
14905     "examples": [
14906       {
14907         "title": "Example usage:",
14908         "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",
14909         "type": "json"
14910       }
14911     ],
14912     "name": "AddAgents",
14913     "group": "Mail_Accounts",
14914     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14915     "version": "0.0.0",
14916     "filename": "server/api/mailAccount/index.js",
14917     "groupTitle": "Mail_Accounts"
14918   },
14919   {
14920     "type": "post",
14921     "url": "/api/mail/accounts/{id}/in_servers",
14922     "title": "Creates a new IMAP server",
14923     "examples": [
14924       {
14925         "title": "Example usage:",
14926         "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",
14927         "type": "json"
14928       }
14929     ],
14930     "name": "AddImap",
14931     "group": "Mail_Accounts",
14932     "parameter": {
14933       "fields": {
14934         "Body": [
14935           {
14936             "group": "Body",
14937             "type": "String",
14938             "optional": true,
14939             "field": "description",
14940             "description": ""
14941           },
14942           {
14943             "group": "Body",
14944             "type": "String",
14945             "optional": true,
14946             "field": "host",
14947             "description": ""
14948           },
14949           {
14950             "group": "Body",
14951             "type": "Boolean",
14952             "optional": true,
14953             "field": "authentication",
14954             "description": ""
14955           },
14956           {
14957             "group": "Body",
14958             "type": "String",
14959             "optional": true,
14960             "field": "user",
14961             "description": ""
14962           },
14963           {
14964             "group": "Body",
14965             "type": "String",
14966             "optional": true,
14967             "field": "password",
14968             "description": ""
14969           },
14970           {
14971             "group": "Body",
14972             "type": "Integer",
14973             "optional": true,
14974             "field": "port",
14975             "description": ""
14976           },
14977           {
14978             "group": "Body",
14979             "type": "Boolean",
14980             "optional": true,
14981             "field": "tls",
14982             "description": ""
14983           },
14984           {
14985             "group": "Body",
14986             "type": "String",
14987             "optional": true,
14988             "field": "mailbox",
14989             "description": ""
14990           },
14991           {
14992             "group": "Body",
14993             "type": "Integer",
14994             "optional": true,
14995             "field": "connTimeout",
14996             "description": ""
14997           },
14998           {
14999             "group": "Body",
15000             "type": "Integer",
15001             "optional": true,
15002             "field": "authTimeout",
15003             "description": ""
15004           },
15005           {
15006             "group": "Body",
15007             "type": "String",
15008             "optional": true,
15009             "field": "service",
15010             "description": ""
15011           }
15012         ]
15013       }
15014     },
15015     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15016     "version": "0.0.0",
15017     "filename": "server/api/mailAccount/index.js",
15018     "groupTitle": "Mail_Accounts"
15019   },
15020   {
15021     "type": "post",
15022     "url": "/api/mail/accounts/{id}/out_servers",
15023     "title": "Creates a new SMTP server",
15024     "examples": [
15025       {
15026         "title": "Example usage:",
15027         "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",
15028         "type": "json"
15029       }
15030     ],
15031     "name": "AddSmtp",
15032     "group": "Mail_Accounts",
15033     "parameter": {
15034       "fields": {
15035         "Body": [
15036           {
15037             "group": "Body",
15038             "type": "String",
15039             "optional": true,
15040             "field": "description",
15041             "description": ""
15042           },
15043           {
15044             "group": "Body",
15045             "type": "String",
15046             "optional": true,
15047             "field": "host",
15048             "description": ""
15049           },
15050           {
15051             "group": "Body",
15052             "type": "String",
15053             "optional": true,
15054             "field": "user",
15055             "description": ""
15056           },
15057           {
15058             "group": "Body",
15059             "type": "String",
15060             "optional": true,
15061             "field": "pass",
15062             "description": ""
15063           },
15064           {
15065             "group": "Body",
15066             "type": "Integer",
15067             "optional": true,
15068             "field": "port",
15069             "description": ""
15070           },
15071           {
15072             "group": "Body",
15073             "type": "Boolean",
15074             "optional": true,
15075             "field": "secure",
15076             "description": ""
15077           },
15078           {
15079             "group": "Body",
15080             "type": "String",
15081             "optional": true,
15082             "field": "service",
15083             "description": ""
15084           },
15085           {
15086             "group": "Body",
15087             "type": "Boolean",
15088             "optional": true,
15089             "field": "authentication",
15090             "description": ""
15091           }
15092         ]
15093       }
15094     },
15095     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15096     "version": "0.0.0",
15097     "filename": "server/api/mailAccount/index.js",
15098     "groupTitle": "Mail_Accounts"
15099   },
15100   {
15101     "type": "delete",
15102     "url": "/api/mail/accounts/{id}",
15103     "title": "Deletes a mail account",
15104     "examples": [
15105       {
15106         "title": "Example usage:",
15107         "content": "curl https://{domain}/api/mail/accounts/{id} -v -u {name}:{password} -X DELETE",
15108         "type": "json"
15109       }
15110     ],
15111     "name": "DeleteMailAccounts",
15112     "group": "Mail_Accounts",
15113     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15114     "version": "0.0.0",
15115     "filename": "server/api/mailAccount/index.js",
15116     "groupTitle": "Mail_Accounts"
15117   },
15118   {
15119     "type": "get",
15120     "url": "/api/mail/accounts/describe",
15121     "title": "Gets table info about Accounts",
15122     "examples": [
15123       {
15124         "title": "Example usage:",
15125         "content": "curl https://{domain}/api/mail/accounts/describe -v -u {name}:{password}",
15126         "type": "json"
15127       }
15128     ],
15129     "name": "DescribeAccounts",
15130     "group": "Mail_Accounts",
15131     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15132     "version": "0.0.0",
15133     "filename": "server/api/mailAccount/index.js",
15134     "groupTitle": "Mail_Accounts"
15135   },
15136   {
15137     "type": "get",
15138     "url": "/api/mail/accounts",
15139     "title": "Gets a list of Accounts",
15140     "examples": [
15141       {
15142         "title": "Example usage:",
15143         "content": "curl https://{domain}/api/mail/accounts -v -u {name}:{password}",
15144         "type": "json"
15145       }
15146     ],
15147     "name": "GetAccounts",
15148     "group": "Mail_Accounts",
15149     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
15150     "version": "0.0.0",
15151     "filename": "server/api/mailAccount/index.js",
15152     "groupTitle": "Mail_Accounts"
15153   },
15154   {
15155     "type": "get",
15156     "url": "/api/mail/accounts/{id}/users",
15157     "title": "Gets agents from mail account",
15158     "examples": [
15159       {
15160         "title": "Example usage:",
15161         "content": "curl https://{domain}/api/mail/accounts/{id}/users -v -u {name}:{password} -X GET",
15162         "type": "json"
15163       }
15164     ],
15165     "name": "GetAgents",
15166     "group": "Mail_Accounts",
15167     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15168     "version": "0.0.0",
15169     "filename": "server/api/mailAccount/index.js",
15170     "groupTitle": "Mail_Accounts"
15171   },
15172   {
15173     "type": "get",
15174     "url": "/api/mail/accounts/{id}/in_servers",
15175     "title": "Gets account IMAP server",
15176     "examples": [
15177       {
15178         "title": "Example usage:",
15179         "content": "curl https://{domain}/api/mail/accounts/{id}/in_servers -v -u {name}:{password} -X GET",
15180         "type": "json"
15181       }
15182     ],
15183     "name": "GetImap",
15184     "group": "Mail_Accounts",
15185     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15186     "version": "0.0.0",
15187     "filename": "server/api/mailAccount/index.js",
15188     "groupTitle": "Mail_Accounts"
15189   },
15190   {
15191     "type": "get",
15192     "url": "/api/mail/accounts/{id}/out_servers",
15193     "title": "Gets account SMTP server",
15194     "examples": [
15195       {
15196         "title": "Example usage:",
15197         "content": "curl https://{domain}/api/mail/accounts/{id}/out_servers -v -u {name}:{password} -X GET",
15198         "type": "json"
15199       }
15200     ],
15201     "name": "GetSmtp",
15202     "group": "Mail_Accounts",
15203     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15204     "version": "0.0.0",
15205     "filename": "server/api/mailAccount/index.js",
15206     "groupTitle": "Mail_Accounts"
15207   },
15208   {
15209     "type": "delete",
15210     "url": "/api/mail/accounts/{id}/users",
15211     "title": "Removes agents from a mail account",
15212     "examples": [
15213       {
15214         "title": "Example usage:",
15215         "content": "curl https://{domain}/api/mail/accounts/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
15216         "type": "json"
15217       }
15218     ],
15219     "name": "RemoveAgents",
15220     "group": "Mail_Accounts",
15221     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15222     "version": "0.0.0",
15223     "filename": "server/api/mailAccount/index.js",
15224     "groupTitle": "Mail_Accounts"
15225   },
15226   {
15227     "type": "delete",
15228     "url": "/api/mail/accounts/{id}/canned_answers",
15229     "title": "Removes canned answers from account",
15230     "examples": [
15231       {
15232         "title": "Example usage:",
15233         "content": "curl https://{domain}/api/mail/accounts/{id}/canned_answers?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
15234         "type": "json"
15235       }
15236     ],
15237     "name": "RemoveAnswers",
15238     "group": "Mail_Accounts",
15239     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15240     "version": "0.0.0",
15241     "filename": "server/api/mailAccount/index.js",
15242     "groupTitle": "Mail_Accounts"
15243   },
15244   {
15245     "type": "delete",
15246     "url": "/api/mail/accounts/{id}/dispositions",
15247     "title": "Removes dispositions from account",
15248     "examples": [
15249       {
15250         "title": "Example usage:",
15251         "content": "curl https://{domain}/api/mail/accounts/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
15252         "type": "json"
15253       }
15254     ],
15255     "name": "RemoveDispositions",
15256     "group": "Mail_Accounts",
15257     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15258     "version": "0.0.0",
15259     "filename": "server/api/mailAccount/index.js",
15260     "groupTitle": "Mail_Accounts"
15261   },
15262   {
15263     "type": "delete",
15264     "url": "/api/mail/accounts/{id}/in_servers",
15265     "title": "Removes IMAP server from an account",
15266     "examples": [
15267       {
15268         "title": "Example usage:",
15269         "content": "curl https://{domain}/api/mail/accounts/{id}/in_servers -v -u {name}:{password} -X DELETE",
15270         "type": "json"
15271       }
15272     ],
15273     "name": "RemoveImmap",
15274     "group": "Mail_Accounts",
15275     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15276     "version": "0.0.0",
15277     "filename": "server/api/mailAccount/index.js",
15278     "groupTitle": "Mail_Accounts"
15279   },
15280   {
15281     "type": "delete",
15282     "url": "/api/mail/accounts/{id}/out_servers",
15283     "title": "Removes SMTP server from an account",
15284     "examples": [
15285       {
15286         "title": "Example usage:",
15287         "content": "curl https://{domain}/api/mail/accounts/{id}/out_servers -v -u {name}:{password} -X DELETE",
15288         "type": "json"
15289       }
15290     ],
15291     "name": "RemoveSmtp",
15292     "group": "Mail_Accounts",
15293     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15294     "version": "0.0.0",
15295     "filename": "server/api/mailAccount/index.js",
15296     "groupTitle": "Mail_Accounts"
15297   },
15298   {
15299     "type": "get",
15300     "url": "/api/mail/accounts/{id}",
15301     "title": "Gets a single Account",
15302     "examples": [
15303       {
15304         "title": "Example usage:",
15305         "content": "curl https://{domain}/api/mail/accounts/{id} -v -u {name}:{password}",
15306         "type": "json"
15307       }
15308     ],
15309     "name": "ShowAccounts",
15310     "group": "Mail_Accounts",
15311     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15312     "version": "0.0.0",
15313     "filename": "server/api/mailAccount/index.js",
15314     "groupTitle": "Mail_Accounts"
15315   },
15316   {
15317     "type": "post",
15318     "url": "/api/mail/accounts/{id}/canned_answers",
15319     "title": "Creates new canned answer",
15320     "examples": [
15321       {
15322         "title": "Example usage:",
15323         "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",
15324         "type": "json"
15325       }
15326     ],
15327     "name": "addAnswer",
15328     "group": "Mail_Accounts",
15329     "parameter": {
15330       "fields": {
15331         "Body": [
15332           {
15333             "group": "Body",
15334             "type": "String",
15335             "optional": false,
15336             "field": "key",
15337             "description": ""
15338           },
15339           {
15340             "group": "Body",
15341             "type": "Text",
15342             "optional": false,
15343             "field": "value",
15344             "description": ""
15345           },
15346           {
15347             "group": "Body",
15348             "type": "String",
15349             "optional": true,
15350             "field": "description",
15351             "description": ""
15352           },
15353           {
15354             "group": "Body",
15355             "type": "Virtual",
15356             "optional": true,
15357             "field": "name",
15358             "description": ""
15359           }
15360         ]
15361       }
15362     },
15363     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15364     "version": "0.0.0",
15365     "filename": "server/api/mailAccount/index.js",
15366     "groupTitle": "Mail_Accounts"
15367   },
15368   {
15369     "type": "post",
15370     "url": "/api/mail/accounts/{id}/applications",
15371     "title": "Creates new applications",
15372     "examples": [
15373       {
15374         "title": "Example usage:",
15375         "content": "curl https://{domain}/api/mail/accounts/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
15376         "type": "json"
15377       }
15378     ],
15379     "name": "addApplications",
15380     "group": "Mail_Accounts",
15381     "parameter": {
15382       "fields": {
15383         "Body": [
15384           {
15385             "group": "Body",
15386             "type": "Integer",
15387             "optional": false,
15388             "field": "priority",
15389             "description": ""
15390           },
15391           {
15392             "group": "Body",
15393             "type": "String",
15394             "optional": false,
15395             "field": "app",
15396             "description": ""
15397           },
15398           {
15399             "group": "Body",
15400             "type": "Text",
15401             "optional": true,
15402             "field": "appdata",
15403             "description": ""
15404           },
15405           {
15406             "group": "Body",
15407             "type": "String",
15408             "optional": true,
15409             "field": "description",
15410             "description": ""
15411           },
15412           {
15413             "group": "Body",
15414             "type": "String",
15415             "optional": true,
15416             "field": "interval",
15417             "description": ""
15418           }
15419         ]
15420       }
15421     },
15422     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15423     "version": "0.0.0",
15424     "filename": "server/api/mailAccount/index.js",
15425     "groupTitle": "Mail_Accounts"
15426   },
15427   {
15428     "type": "post",
15429     "url": "/api/mail/accounts/{id}/dispositions",
15430     "title": "Creates new disposition",
15431     "examples": [
15432       {
15433         "title": "Example usage:",
15434         "content": "curl https://{domain}/api/mail/accounts/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
15435         "type": "json"
15436       }
15437     ],
15438     "name": "addDisposition",
15439     "group": "Mail_Accounts",
15440     "parameter": {
15441       "fields": {
15442         "Body": [
15443           {
15444             "group": "Body",
15445             "type": "String",
15446             "optional": false,
15447             "field": "name",
15448             "description": ""
15449           },
15450           {
15451             "group": "Body",
15452             "type": "String",
15453             "allowedValues": [
15454               "\"first\"",
15455               "\"second\"",
15456               "\"third\""
15457             ],
15458             "optional": false,
15459             "field": "level",
15460             "description": ""
15461           },
15462           {
15463             "group": "Body",
15464             "type": "String",
15465             "optional": true,
15466             "field": "description",
15467             "description": ""
15468           }
15469         ]
15470       }
15471     },
15472     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15473     "version": "0.0.0",
15474     "filename": "server/api/mailAccount/index.js",
15475     "groupTitle": "Mail_Accounts"
15476   },
15477   {
15478     "type": "post",
15479     "url": "/api/mail/accounts/{id}/interactions",
15480     "title": "Creates new interactions",
15481     "examples": [
15482       {
15483         "title": "Example usage:",
15484         "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",
15485         "type": "json"
15486       }
15487     ],
15488     "name": "addInteraction",
15489     "group": "Mail_Accounts",
15490     "parameter": {
15491       "fields": {
15492         "Body": [
15493           {
15494             "group": "Body",
15495             "type": "Boolean",
15496             "optional": true,
15497             "field": "closed",
15498             "description": ""
15499           },
15500           {
15501             "group": "Body",
15502             "type": "String",
15503             "optional": true,
15504             "field": "closedAt",
15505             "description": ""
15506           },
15507           {
15508             "group": "Body",
15509             "type": "String",
15510             "optional": true,
15511             "field": "disposition",
15512             "description": ""
15513           },
15514           {
15515             "group": "Body",
15516             "type": "String",
15517             "optional": true,
15518             "field": "secondDisposition",
15519             "description": ""
15520           },
15521           {
15522             "group": "Body",
15523             "type": "String",
15524             "optional": true,
15525             "field": "thirdDisposition",
15526             "description": ""
15527           },
15528           {
15529             "group": "Body",
15530             "type": "String",
15531             "optional": true,
15532             "field": "note",
15533             "description": ""
15534           },
15535           {
15536             "group": "Body",
15537             "type": "String",
15538             "optional": true,
15539             "field": "inReplyTo",
15540             "description": ""
15541           },
15542           {
15543             "group": "Body",
15544             "type": "String",
15545             "optional": true,
15546             "field": "to",
15547             "description": ""
15548           },
15549           {
15550             "group": "Body",
15551             "type": "Text",
15552             "optional": true,
15553             "field": "cc",
15554             "description": ""
15555           },
15556           {
15557             "group": "Body",
15558             "type": "Text",
15559             "optional": true,
15560             "field": "subject",
15561             "description": ""
15562           },
15563           {
15564             "group": "Body",
15565             "type": "Boolean",
15566             "optional": true,
15567             "field": "attach",
15568             "description": ""
15569           },
15570           {
15571             "group": "Body",
15572             "type": "String",
15573             "optional": true,
15574             "field": "read1stAt",
15575             "description": ""
15576           },
15577           {
15578             "group": "Body",
15579             "type": "String",
15580             "optional": true,
15581             "field": "substatus",
15582             "description": ""
15583           },
15584           {
15585             "group": "Body",
15586             "type": "String",
15587             "optional": true,
15588             "field": "substatusAt",
15589             "description": ""
15590           },
15591           {
15592             "group": "Body",
15593             "type": "String",
15594             "allowedValues": [
15595               "\"in\"",
15596               "\"out\""
15597             ],
15598             "optional": false,
15599             "field": "firstMsgDirection",
15600             "description": ""
15601           },
15602           {
15603             "group": "Body",
15604             "type": "String",
15605             "optional": true,
15606             "field": "lastMsgAt",
15607             "description": ""
15608           },
15609           {
15610             "group": "Body",
15611             "type": "String",
15612             "allowedValues": [
15613               "\"in\"",
15614               "\"out\""
15615             ],
15616             "optional": false,
15617             "field": "lastMsgDirection",
15618             "description": ""
15619           },
15620           {
15621             "group": "Body",
15622             "type": "Boolean",
15623             "optional": true,
15624             "field": "autoreplyExecuted",
15625             "description": ""
15626           }
15627         ]
15628       }
15629     },
15630     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15631     "version": "0.0.0",
15632     "filename": "server/api/mailAccount/index.js",
15633     "groupTitle": "Mail_Accounts"
15634   },
15635   {
15636     "type": "post",
15637     "url": "/api/mail/accounts",
15638     "title": "Create a mail account",
15639     "examples": [
15640       {
15641         "title": "Example usage:",
15642         "content": "curl https://{domain}/api/mail/accounts \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
15643         "type": "json"
15644       }
15645     ],
15646     "name": "create",
15647     "group": "Mail_Accounts",
15648     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15649     "version": "0.0.0",
15650     "filename": "server/api/mailAccount/index.js",
15651     "groupTitle": "Mail_Accounts"
15652   },
15653   {
15654     "type": "get",
15655     "url": "/api/mail/accounts/{id}/canned_answers",
15656     "title": "Gets account canned answers",
15657     "examples": [
15658       {
15659         "title": "Example usage:",
15660         "content": "curl https://{domain}/api/mail/accounts/{id}/canned_answers -v -u {name}:{password} -X GET",
15661         "type": "json"
15662       }
15663     ],
15664     "name": "getAnswers",
15665     "group": "Mail_Accounts",
15666     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15667     "version": "0.0.0",
15668     "filename": "server/api/mailAccount/index.js",
15669     "groupTitle": "Mail_Accounts"
15670   },
15671   {
15672     "type": "get",
15673     "url": "/api/mail/accounts/{id}/applications",
15674     "title": "Gets account applications",
15675     "examples": [
15676       {
15677         "title": "Example usage:",
15678         "content": "curl https://{domain}/api/mail/accounts/{id}/applications -v -u {name}:{password} -X GET",
15679         "type": "json"
15680       }
15681     ],
15682     "name": "getApplications",
15683     "group": "Mail_Accounts",
15684     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15685     "version": "0.0.0",
15686     "filename": "server/api/mailAccount/index.js",
15687     "groupTitle": "Mail_Accounts"
15688   },
15689   {
15690     "type": "get",
15691     "url": "/api/mail/accounts/{id}/dispositions",
15692     "title": "Gets account dispositions",
15693     "examples": [
15694       {
15695         "title": "Example usage:",
15696         "content": "curl https://{domain}/api/mail/accounts/{id}/dispositions -v -u {name}:{password} -X GET",
15697         "type": "json"
15698       }
15699     ],
15700     "name": "getDispositions",
15701     "group": "Mail_Accounts",
15702     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15703     "version": "0.0.0",
15704     "filename": "server/api/mailAccount/index.js",
15705     "groupTitle": "Mail_Accounts"
15706   },
15707   {
15708     "type": "get",
15709     "url": "/api/mail/accounts/{id}/interactions",
15710     "title": "Gets account interactions",
15711     "examples": [
15712       {
15713         "title": "Example usage:",
15714         "content": "curl https://{domain}/api/mail/accounts/{id}/interactions -v -u {name}:{password} -X GET",
15715         "type": "json"
15716       }
15717     ],
15718     "name": "getInteraction",
15719     "group": "Mail_Accounts",
15720     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15721     "version": "0.0.0",
15722     "filename": "server/api/mailAccount/index.js",
15723     "groupTitle": "Mail_Accounts"
15724   },
15725   {
15726     "type": "get",
15727     "url": "/api/mail/accounts/{id}/messages",
15728     "title": "Gets account messages",
15729     "examples": [
15730       {
15731         "title": "Example usage:",
15732         "content": "curl https://{domain}/api/mail/accounts/{id}/messages -v -u {name}:{password} -X GET",
15733         "type": "json"
15734       }
15735     ],
15736     "name": "getMessages",
15737     "group": "Mail_Accounts",
15738     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15739     "version": "0.0.0",
15740     "filename": "server/api/mailAccount/index.js",
15741     "groupTitle": "Mail_Accounts"
15742   },
15743   {
15744     "type": "post",
15745     "url": "/api/mail/accounts/{id}/send",
15746     "title": "Send new mail",
15747     "examples": [
15748       {
15749         "title": "Example usage:",
15750         "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",
15751         "type": "json"
15752       }
15753     ],
15754     "name": "sendMail",
15755     "group": "Mail_Accounts",
15756     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15757     "version": "0.0.0",
15758     "filename": "server/api/mailAccount/index.js",
15759     "groupTitle": "Mail_Accounts"
15760   },
15761   {
15762     "type": "put",
15763     "url": "/api/mail/accounts/{id}",
15764     "title": "Update an existing Account",
15765     "examples": [
15766       {
15767         "title": "Example usage:",
15768         "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",
15769         "type": "json"
15770       }
15771     ],
15772     "name": "updateAccounts",
15773     "group": "Mail_Accounts",
15774     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15775     "version": "0.0.0",
15776     "filename": "server/api/mailAccount/index.js",
15777     "groupTitle": "Mail_Accounts"
15778   },
15779   {
15780     "type": "get",
15781     "url": "/api/mail/accounts/{id}/verify",
15782     "title": "Verify mail account",
15783     "examples": [
15784       {
15785         "title": "Example usage:",
15786         "content": "curl https://{domain}/api/mail/accounts/{id}/verify -v -u {name}:{password} -X GET",
15787         "type": "json"
15788       }
15789     ],
15790     "name": "verifySmtp",
15791     "group": "Mail_Accounts",
15792     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15793     "version": "0.0.0",
15794     "filename": "server/api/mailAccount/index.js",
15795     "groupTitle": "Mail_Accounts"
15796   },
15797   {
15798     "type": "delete",
15799     "url": "/api/mail/applications/{id}",
15800     "title": "Deletes a Application",
15801     "examples": [
15802       {
15803         "title": "Example usage:",
15804         "content": "curl https://{domain}/api/mail/applications/{id} -v -u {name}:{password} -X DELETE",
15805         "type": "json"
15806       }
15807     ],
15808     "name": "DeleteApplications",
15809     "group": "Mail_Applications",
15810     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15811     "version": "0.0.0",
15812     "filename": "server/api/mailApplication/index.js",
15813     "groupTitle": "Mail_Applications"
15814   },
15815   {
15816     "type": "get",
15817     "url": "/api/mail/applications/{id}",
15818     "title": "Gets a single Application",
15819     "examples": [
15820       {
15821         "title": "Example usage:",
15822         "content": "curl https://{domain}/api/mail/applications/{id} -v -u {name}:{password}",
15823         "type": "json"
15824       }
15825     ],
15826     "name": "ShowApplications",
15827     "group": "Mail_Applications",
15828     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15829     "version": "0.0.0",
15830     "filename": "server/api/mailApplication/index.js",
15831     "groupTitle": "Mail_Applications"
15832   },
15833   {
15834     "type": "put",
15835     "url": "/api/mail/applications/{id}",
15836     "title": "Update an existing Application",
15837     "examples": [
15838       {
15839         "title": "Example usage:",
15840         "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",
15841         "type": "json"
15842       }
15843     ],
15844     "name": "updateApplications",
15845     "group": "Mail_Applications",
15846     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15847     "version": "0.0.0",
15848     "filename": "server/api/mailApplication/index.js",
15849     "groupTitle": "Mail_Applications"
15850   },
15851   {
15852     "type": "post",
15853     "url": "/api/mail/interactions/{id}/tags",
15854     "title": "Add tags to the interaction",
15855     "examples": [
15856       {
15857         "title": "Example usage:",
15858         "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",
15859         "type": "json"
15860       }
15861     ],
15862     "name": "AddTags",
15863     "group": "Mail_Interactions",
15864     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15865     "version": "0.0.0",
15866     "filename": "server/api/mailInteraction/index.js",
15867     "groupTitle": "Mail_Interactions"
15868   },
15869   {
15870     "type": "post",
15871     "url": "/api/mail/interactions",
15872     "title": "Creates a new Interaction",
15873     "examples": [
15874       {
15875         "title": "Example usage:",
15876         "content": "curl https://{domain}/api/mail/interactions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
15877         "type": "json"
15878       }
15879     ],
15880     "name": "CreateInteractions",
15881     "group": "Mail_Interactions",
15882     "parameter": {
15883       "fields": {
15884         "Body": [
15885           {
15886             "group": "Body",
15887             "type": "Boolean",
15888             "optional": true,
15889             "field": "closed",
15890             "description": ""
15891           },
15892           {
15893             "group": "Body",
15894             "type": "String",
15895             "optional": true,
15896             "field": "closedAt",
15897             "description": ""
15898           },
15899           {
15900             "group": "Body",
15901             "type": "String",
15902             "optional": true,
15903             "field": "disposition",
15904             "description": ""
15905           },
15906           {
15907             "group": "Body",
15908             "type": "String",
15909             "optional": true,
15910             "field": "secondDisposition",
15911             "description": ""
15912           },
15913           {
15914             "group": "Body",
15915             "type": "String",
15916             "optional": true,
15917             "field": "thirdDisposition",
15918             "description": ""
15919           },
15920           {
15921             "group": "Body",
15922             "type": "String",
15923             "optional": true,
15924             "field": "note",
15925             "description": ""
15926           },
15927           {
15928             "group": "Body",
15929             "type": "String",
15930             "optional": true,
15931             "field": "inReplyTo",
15932             "description": ""
15933           },
15934           {
15935             "group": "Body",
15936             "type": "String",
15937             "optional": true,
15938             "field": "to",
15939             "description": ""
15940           },
15941           {
15942             "group": "Body",
15943             "type": "Text",
15944             "optional": true,
15945             "field": "cc",
15946             "description": ""
15947           },
15948           {
15949             "group": "Body",
15950             "type": "Text",
15951             "optional": true,
15952             "field": "subject",
15953             "description": ""
15954           },
15955           {
15956             "group": "Body",
15957             "type": "Boolean",
15958             "optional": true,
15959             "field": "attach",
15960             "description": ""
15961           },
15962           {
15963             "group": "Body",
15964             "type": "String",
15965             "optional": true,
15966             "field": "read1stAt",
15967             "description": ""
15968           },
15969           {
15970             "group": "Body",
15971             "type": "String",
15972             "optional": true,
15973             "field": "substatus",
15974             "description": ""
15975           },
15976           {
15977             "group": "Body",
15978             "type": "String",
15979             "optional": true,
15980             "field": "substatusAt",
15981             "description": ""
15982           },
15983           {
15984             "group": "Body",
15985             "type": "String",
15986             "allowedValues": [
15987               "\"in\"",
15988               "\"out\""
15989             ],
15990             "optional": false,
15991             "field": "firstMsgDirection",
15992             "description": ""
15993           },
15994           {
15995             "group": "Body",
15996             "type": "String",
15997             "optional": true,
15998             "field": "lastMsgAt",
15999             "description": ""
16000           },
16001           {
16002             "group": "Body",
16003             "type": "String",
16004             "allowedValues": [
16005               "\"in\"",
16006               "\"out\""
16007             ],
16008             "optional": false,
16009             "field": "lastMsgDirection",
16010             "description": ""
16011           },
16012           {
16013             "group": "Body",
16014             "type": "Boolean",
16015             "optional": true,
16016             "field": "autoreplyExecuted",
16017             "description": ""
16018           }
16019         ]
16020       }
16021     },
16022     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16023     "version": "0.0.0",
16024     "filename": "server/api/mailInteraction/index.js",
16025     "groupTitle": "Mail_Interactions"
16026   },
16027   {
16028     "type": "delete",
16029     "url": "/api/mail/interactions/{id}",
16030     "title": "Deletes a Interaction",
16031     "examples": [
16032       {
16033         "title": "Example usage:",
16034         "content": "curl https://{domain}/api/mail/interactions/{id} -v -u {name}:{password} -X DELETE",
16035         "type": "json"
16036       }
16037     ],
16038     "name": "DeleteInteractions",
16039     "group": "Mail_Interactions",
16040     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16041     "version": "0.0.0",
16042     "filename": "server/api/mailInteraction/index.js",
16043     "groupTitle": "Mail_Interactions"
16044   },
16045   {
16046     "type": "get",
16047     "url": "/api/mail/interactions/describe",
16048     "title": "Gets table info about Interactions",
16049     "examples": [
16050       {
16051         "title": "Example usage:",
16052         "content": "curl https://{domain}/api/mail/interactions/describe -v -u {name}:{password}",
16053         "type": "json"
16054       }
16055     ],
16056     "name": "DescribeInteractions",
16057     "group": "Mail_Interactions",
16058     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16059     "version": "0.0.0",
16060     "filename": "server/api/mailInteraction/index.js",
16061     "groupTitle": "Mail_Interactions"
16062   },
16063   {
16064     "type": "get",
16065     "url": "/api/mail/interactions",
16066     "title": "Gets a list of Interactions",
16067     "examples": [
16068       {
16069         "title": "Example usage:",
16070         "content": "curl https://{domain}/api/mail/interactions -v -u {name}:{password}",
16071         "type": "json"
16072       }
16073     ],
16074     "name": "GetInteractions",
16075     "group": "Mail_Interactions",
16076     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
16077     "version": "0.0.0",
16078     "filename": "server/api/mailInteraction/index.js",
16079     "groupTitle": "Mail_Interactions"
16080   },
16081   {
16082     "type": "delete",
16083     "url": "/api/mail/interactions/{id}/tags",
16084     "title": "Removes tags from interaction",
16085     "examples": [
16086       {
16087         "title": "Example usage:",
16088         "content": "curl https://{domain}/api/mail/interactions/{id}/tags?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
16089         "type": "json"
16090       }
16091     ],
16092     "name": "RemoveTags",
16093     "group": "Mail_Interactions",
16094     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16095     "version": "0.0.0",
16096     "filename": "server/api/mailInteraction/index.js",
16097     "groupTitle": "Mail_Interactions"
16098   },
16099   {
16100     "type": "get",
16101     "url": "/api/mail/interactions/{id}",
16102     "title": "Gets a single Interaction",
16103     "examples": [
16104       {
16105         "title": "Example usage:",
16106         "content": "curl https://{domain}/api/mail/interactions/{id} -v -u {name}:{password}",
16107         "type": "json"
16108       }
16109     ],
16110     "name": "ShowInteractions",
16111     "group": "Mail_Interactions",
16112     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16113     "version": "0.0.0",
16114     "filename": "server/api/mailInteraction/index.js",
16115     "groupTitle": "Mail_Interactions"
16116   },
16117   {
16118     "type": "post",
16119     "url": "/api/mail/interactions/{id}/messages",
16120     "title": "Creates new message",
16121     "examples": [
16122       {
16123         "title": "Example usage:",
16124         "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",
16125         "type": "json"
16126       }
16127     ],
16128     "name": "addMessage",
16129     "group": "Mail_Interactions",
16130     "parameter": {
16131       "fields": {
16132         "Body": [
16133           {
16134             "group": "Body",
16135             "type": "Text",
16136             "optional": false,
16137             "field": "body",
16138             "description": ""
16139           },
16140           {
16141             "group": "Body",
16142             "type": "Text",
16143             "optional": true,
16144             "field": "plainBody",
16145             "description": ""
16146           },
16147           {
16148             "group": "Body",
16149             "type": "Boolean",
16150             "optional": true,
16151             "field": "read",
16152             "description": ""
16153           },
16154           {
16155             "group": "Body",
16156             "type": "String",
16157             "allowedValues": [
16158               "\"in\"",
16159               "\"out\""
16160             ],
16161             "optional": false,
16162             "field": "direction",
16163             "description": ""
16164           },
16165           {
16166             "group": "Body",
16167             "type": "String",
16168             "optional": true,
16169             "field": "messageId",
16170             "description": ""
16171           },
16172           {
16173             "group": "Body",
16174             "type": "String",
16175             "optional": true,
16176             "field": "from",
16177             "description": ""
16178           },
16179           {
16180             "group": "Body",
16181             "type": "Text",
16182             "optional": true,
16183             "field": "to",
16184             "description": ""
16185           },
16186           {
16187             "group": "Body",
16188             "type": "Text",
16189             "optional": true,
16190             "field": "cc",
16191             "description": ""
16192           },
16193           {
16194             "group": "Body",
16195             "type": "Text",
16196             "optional": true,
16197             "field": "bcc",
16198             "description": ""
16199           },
16200           {
16201             "group": "Body",
16202             "type": "Text",
16203             "optional": true,
16204             "field": "subject",
16205             "description": ""
16206           },
16207           {
16208             "group": "Body",
16209             "type": "String",
16210             "optional": true,
16211             "field": "sentAt",
16212             "description": ""
16213           },
16214           {
16215             "group": "Body",
16216             "type": "Integer",
16217             "optional": true,
16218             "field": "attach",
16219             "description": ""
16220           },
16221           {
16222             "group": "Body",
16223             "type": "Boolean",
16224             "optional": true,
16225             "field": "secret",
16226             "description": ""
16227           },
16228           {
16229             "group": "Body",
16230             "type": "String",
16231             "optional": true,
16232             "field": "readAt",
16233             "description": ""
16234           },
16235           {
16236             "group": "Body",
16237             "type": "Text",
16238             "optional": true,
16239             "field": "originTo",
16240             "description": ""
16241           },
16242           {
16243             "group": "Body",
16244             "type": "Text",
16245             "optional": true,
16246             "field": "originCc",
16247             "description": ""
16248           },
16249           {
16250             "group": "Body",
16251             "type": "String",
16252             "allowedValues": [
16253               "\"Email\"",
16254               "\"Chat\""
16255             ],
16256             "optional": false,
16257             "field": "originChannel",
16258             "description": ""
16259           }
16260         ]
16261       }
16262     },
16263     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16264     "version": "0.0.0",
16265     "filename": "server/api/mailInteraction/index.js",
16266     "groupTitle": "Mail_Interactions"
16267   },
16268   {
16269     "type": "get",
16270     "url": "/api/mail/interactions/{id}/download",
16271     "title": "Gets interaction",
16272     "examples": [
16273       {
16274         "title": "Example usage:",
16275         "content": "curl https://{domain}/api/mail/interactions/{id}/download -v -u {name}:{password} -X GET",
16276         "type": "json"
16277       }
16278     ],
16279     "name": "download",
16280     "group": "Mail_Interactions",
16281     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16282     "version": "0.0.0",
16283     "filename": "server/api/mailInteraction/index.js",
16284     "groupTitle": "Mail_Interactions"
16285   },
16286   {
16287     "type": "get",
16288     "url": "/api/mail/interactions/{id}/messages",
16289     "title": "Gets interaction messages",
16290     "examples": [
16291       {
16292         "title": "Example usage:",
16293         "content": "curl https://{domain}/api/mail/interactions/{id}/messages -v -u {name}:{password} -X GET",
16294         "type": "json"
16295       }
16296     ],
16297     "name": "getMessages",
16298     "group": "Mail_Interactions",
16299     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16300     "version": "0.0.0",
16301     "filename": "server/api/mailInteraction/index.js",
16302     "groupTitle": "Mail_Interactions"
16303   },
16304   {
16305     "type": "put",
16306     "url": "/api/mail/interactions/{id}",
16307     "title": "Update an existing Interaction",
16308     "examples": [
16309       {
16310         "title": "Example usage:",
16311         "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",
16312         "type": "json"
16313       }
16314     ],
16315     "name": "updateInteractions",
16316     "group": "Mail_Interactions",
16317     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16318     "version": "0.0.0",
16319     "filename": "server/api/mailInteraction/index.js",
16320     "groupTitle": "Mail_Interactions"
16321   },
16322   {
16323     "type": "delete",
16324     "url": "/api/mail/messages/{id}",
16325     "title": "Deletes a Message",
16326     "examples": [
16327       {
16328         "title": "Example usage:",
16329         "content": "curl https://{domain}/api/mail/messages/{id} -v -u {name}:{password} -X DELETE",
16330         "type": "json"
16331       }
16332     ],
16333     "name": "DeleteMessages",
16334     "group": "Mail_Messages",
16335     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16336     "version": "0.0.0",
16337     "filename": "server/api/mailMessage/index.js",
16338     "groupTitle": "Mail_Messages"
16339   },
16340   {
16341     "type": "get",
16342     "url": "/api/mail/messages/describe",
16343     "title": "Gets table info about Messages",
16344     "examples": [
16345       {
16346         "title": "Example usage:",
16347         "content": "curl https://{domain}/api/mail/messages/describe -v -u {name}:{password}",
16348         "type": "json"
16349       }
16350     ],
16351     "name": "DescribeMessages",
16352     "group": "Mail_Messages",
16353     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16354     "version": "0.0.0",
16355     "filename": "server/api/mailMessage/index.js",
16356     "groupTitle": "Mail_Messages"
16357   },
16358   {
16359     "type": "get",
16360     "url": "/api/mail/messages",
16361     "title": "Gets a list of Messages",
16362     "examples": [
16363       {
16364         "title": "Example usage:",
16365         "content": "curl https://{domain}/api/mail/messages -v -u {name}:{password}",
16366         "type": "json"
16367       }
16368     ],
16369     "name": "GetMessages",
16370     "group": "Mail_Messages",
16371     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
16372     "version": "0.0.0",
16373     "filename": "server/api/mailMessage/index.js",
16374     "groupTitle": "Mail_Messages"
16375   },
16376   {
16377     "type": "get",
16378     "url": "/api/mail/messages/{id}",
16379     "title": "Gets a single Message",
16380     "examples": [
16381       {
16382         "title": "Example usage:",
16383         "content": "curl https://{domain}/api/mail/messages/{id} -v -u {name}:{password}",
16384         "type": "json"
16385       }
16386     ],
16387     "name": "ShowMessages",
16388     "group": "Mail_Messages",
16389     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16390     "version": "0.0.0",
16391     "filename": "server/api/mailMessage/index.js",
16392     "groupTitle": "Mail_Messages"
16393   },
16394   {
16395     "type": "put",
16396     "url": "/api/mail/messages/{id}/accept",
16397     "title": "Accepts message",
16398     "examples": [
16399       {
16400         "title": "Example usage:",
16401         "content": "curl https://{domain}/api/mail/messages/{id}/accept \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
16402         "type": "json"
16403       }
16404     ],
16405     "name": "acceptMessage",
16406     "group": "Mail_Messages",
16407     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16408     "version": "0.0.0",
16409     "filename": "server/api/mailMessage/index.js",
16410     "groupTitle": "Mail_Messages"
16411   },
16412   {
16413     "type": "post",
16414     "url": "/api/mail/messages",
16415     "title": "Create a message",
16416     "examples": [
16417       {
16418         "title": "Example usage:",
16419         "content": "curl https://{domain}/api/mail/messages \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
16420         "type": "json"
16421       }
16422     ],
16423     "name": "createMessage",
16424     "group": "Mail_Messages",
16425     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16426     "version": "0.0.0",
16427     "filename": "server/api/mailMessage/index.js",
16428     "groupTitle": "Mail_Messages"
16429   },
16430   {
16431     "type": "get",
16432     "url": "/api/mail/messages/{id}/download",
16433     "title": "Gets message",
16434     "examples": [
16435       {
16436         "title": "Example usage:",
16437         "content": "curl https://{domain}/api/mail/messages/{id}/download -v -u {name}:{password} -X GET",
16438         "type": "json"
16439       }
16440     ],
16441     "name": "download",
16442     "group": "Mail_Messages",
16443     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16444     "version": "0.0.0",
16445     "filename": "server/api/mailMessage/index.js",
16446     "groupTitle": "Mail_Messages"
16447   },
16448   {
16449     "type": "put",
16450     "url": "/api/mail/messages/{id}/reject",
16451     "title": "Rejects message",
16452     "examples": [
16453       {
16454         "title": "Example usage:",
16455         "content": "curl https://{domain}/api/mail/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
16456         "type": "json"
16457       }
16458     ],
16459     "name": "rejectMessage",
16460     "group": "Mail_Messages",
16461     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16462     "version": "0.0.0",
16463     "filename": "server/api/mailMessage/index.js",
16464     "groupTitle": "Mail_Messages"
16465   },
16466   {
16467     "type": "put",
16468     "url": "/api/mail/messages/{id}",
16469     "title": "Update an existing Message",
16470     "examples": [
16471       {
16472         "title": "Example usage:",
16473         "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",
16474         "type": "json"
16475       }
16476     ],
16477     "name": "updateMessages",
16478     "group": "Mail_Messages",
16479     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16480     "version": "0.0.0",
16481     "filename": "server/api/mailMessage/index.js",
16482     "groupTitle": "Mail_Messages"
16483   },
16484   {
16485     "type": "post",
16486     "url": "/api/mail/reports/queue",
16487     "title": "Creates a new Mail Queue Report",
16488     "examples": [
16489       {
16490         "title": "Example usage:",
16491         "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",
16492         "type": "json"
16493       }
16494     ],
16495     "name": "CreateMail_Queue_Reports",
16496     "group": "Mail_Queue_Reports",
16497     "parameter": {
16498       "fields": {
16499         "Body": [
16500           {
16501             "group": "Body",
16502             "type": "String",
16503             "optional": false,
16504             "field": "uniqueid",
16505             "description": ""
16506           },
16507           {
16508             "group": "Body",
16509             "type": "String",
16510             "optional": true,
16511             "field": "from",
16512             "description": ""
16513           },
16514           {
16515             "group": "Body",
16516             "type": "String",
16517             "optional": true,
16518             "field": "joinAt",
16519             "description": ""
16520           },
16521           {
16522             "group": "Body",
16523             "type": "String",
16524             "optional": true,
16525             "field": "leaveAt",
16526             "description": ""
16527           },
16528           {
16529             "group": "Body",
16530             "type": "String",
16531             "optional": true,
16532             "field": "acceptAt",
16533             "description": ""
16534           },
16535           {
16536             "group": "Body",
16537             "type": "String",
16538             "optional": true,
16539             "field": "exitAt",
16540             "description": ""
16541           },
16542           {
16543             "group": "Body",
16544             "type": "String",
16545             "optional": true,
16546             "field": "reason",
16547             "description": ""
16548           }
16549         ]
16550       }
16551     },
16552     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16553     "version": "0.0.0",
16554     "filename": "server/api/mailQueueReport/index.js",
16555     "groupTitle": "Mail_Queue_Reports"
16556   },
16557   {
16558     "type": "delete",
16559     "url": "/api/mail/reports/queue/{id}",
16560     "title": "Deletes a Mail Queue Report",
16561     "examples": [
16562       {
16563         "title": "Example usage:",
16564         "content": "curl https://{domain}/api/mail/reports/queue/{id} -v -u {name}:{password} -X DELETE",
16565         "type": "json"
16566       }
16567     ],
16568     "name": "DeleteMail_Queue_Reports",
16569     "group": "Mail_Queue_Reports",
16570     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16571     "version": "0.0.0",
16572     "filename": "server/api/mailQueueReport/index.js",
16573     "groupTitle": "Mail_Queue_Reports"
16574   },
16575   {
16576     "type": "get",
16577     "url": "/api/mail/reports/queue/describe",
16578     "title": "Gets table info about Mail Queue Reports",
16579     "examples": [
16580       {
16581         "title": "Example usage:",
16582         "content": "curl https://{domain}/api/mail/reports/queue/describe -v -u {name}:{password}",
16583         "type": "json"
16584       }
16585     ],
16586     "name": "DescribeMail_Queue_Reports",
16587     "group": "Mail_Queue_Reports",
16588     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16589     "version": "0.0.0",
16590     "filename": "server/api/mailQueueReport/index.js",
16591     "groupTitle": "Mail_Queue_Reports"
16592   },
16593   {
16594     "type": "get",
16595     "url": "/api/mail/reports/queue",
16596     "title": "Gets a list of Mail Queue Reports",
16597     "examples": [
16598       {
16599         "title": "Example usage:",
16600         "content": "curl https://{domain}/api/mail/reports/queue -v -u {name}:{password}",
16601         "type": "json"
16602       }
16603     ],
16604     "name": "GetMail_Queue_Reports",
16605     "group": "Mail_Queue_Reports",
16606     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
16607     "version": "0.0.0",
16608     "filename": "server/api/mailQueueReport/index.js",
16609     "groupTitle": "Mail_Queue_Reports"
16610   },
16611   {
16612     "type": "get",
16613     "url": "/api/mail/reports/queue/{id}",
16614     "title": "Gets a single Mail Queue Report",
16615     "examples": [
16616       {
16617         "title": "Example usage:",
16618         "content": "curl https://{domain}/api/mail/reports/queue/{id} -v -u {name}:{password}",
16619         "type": "json"
16620       }
16621     ],
16622     "name": "ShowMail_Queue_Reports",
16623     "group": "Mail_Queue_Reports",
16624     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16625     "version": "0.0.0",
16626     "filename": "server/api/mailQueueReport/index.js",
16627     "groupTitle": "Mail_Queue_Reports"
16628   },
16629   {
16630     "type": "put",
16631     "url": "/api/mail/reports/queue/{id}",
16632     "title": "Update an existing Mail Queue Report",
16633     "examples": [
16634       {
16635         "title": "Example usage:",
16636         "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",
16637         "type": "json"
16638       }
16639     ],
16640     "name": "updateMail_Queue_Reports",
16641     "group": "Mail_Queue_Reports",
16642     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16643     "version": "0.0.0",
16644     "filename": "server/api/mailQueueReport/index.js",
16645     "groupTitle": "Mail_Queue_Reports"
16646   },
16647   {
16648     "type": "post",
16649     "url": "/api/mail/queues/{id}/users",
16650     "title": "Add agents to a queue",
16651     "examples": [
16652       {
16653         "title": "Example usage:",
16654         "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",
16655         "type": "json"
16656       }
16657     ],
16658     "name": "AddAgents",
16659     "group": "Mail_Queues",
16660     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16661     "version": "0.0.0",
16662     "filename": "server/api/mailQueue/index.js",
16663     "groupTitle": "Mail_Queues"
16664   },
16665   {
16666     "type": "post",
16667     "url": "/api/mail/queues/{id}/teams",
16668     "title": "Add teams to a queue",
16669     "examples": [
16670       {
16671         "title": "Example usage:",
16672         "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",
16673         "type": "json"
16674       }
16675     ],
16676     "name": "AddTeams",
16677     "group": "Mail_Queues",
16678     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16679     "version": "0.0.0",
16680     "filename": "server/api/mailQueue/index.js",
16681     "groupTitle": "Mail_Queues"
16682   },
16683   {
16684     "type": "post",
16685     "url": "/api/mail/queues",
16686     "title": "Creates a new Queue",
16687     "examples": [
16688       {
16689         "title": "Example usage:",
16690         "content": "curl https://{domain}/api/mail/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
16691         "type": "json"
16692       }
16693     ],
16694     "name": "CreateQueues",
16695     "group": "Mail_Queues",
16696     "parameter": {
16697       "fields": {
16698         "Body": [
16699           {
16700             "group": "Body",
16701             "type": "String",
16702             "optional": true,
16703             "field": "name",
16704             "description": ""
16705           },
16706           {
16707             "group": "Body",
16708             "type": "String",
16709             "optional": true,
16710             "field": "description",
16711             "description": ""
16712           },
16713           {
16714             "group": "Body",
16715             "type": "Integer",
16716             "optional": true,
16717             "field": "timeout",
16718             "description": ""
16719           },
16720           {
16721             "group": "Body",
16722             "type": "String",
16723             "allowedValues": [
16724               "\"rrmemory\"",
16725               "\"beepall\"",
16726               "\"roundrobin\""
16727             ],
16728             "optional": true,
16729             "field": "strategy",
16730             "description": ""
16731           }
16732         ]
16733       }
16734     },
16735     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16736     "version": "0.0.0",
16737     "filename": "server/api/mailQueue/index.js",
16738     "groupTitle": "Mail_Queues"
16739   },
16740   {
16741     "type": "delete",
16742     "url": "/api/mail/queues/{id}",
16743     "title": "Deletes a Queue",
16744     "examples": [
16745       {
16746         "title": "Example usage:",
16747         "content": "curl https://{domain}/api/mail/queues/{id} -v -u {name}:{password} -X DELETE",
16748         "type": "json"
16749       }
16750     ],
16751     "name": "DeleteQueues",
16752     "group": "Mail_Queues",
16753     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16754     "version": "0.0.0",
16755     "filename": "server/api/mailQueue/index.js",
16756     "groupTitle": "Mail_Queues"
16757   },
16758   {
16759     "type": "get",
16760     "url": "/api/mail/queues/describe",
16761     "title": "Gets table info about Queues",
16762     "examples": [
16763       {
16764         "title": "Example usage:",
16765         "content": "curl https://{domain}/api/mail/queues/describe -v -u {name}:{password}",
16766         "type": "json"
16767       }
16768     ],
16769     "name": "DescribeQueues",
16770     "group": "Mail_Queues",
16771     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16772     "version": "0.0.0",
16773     "filename": "server/api/mailQueue/index.js",
16774     "groupTitle": "Mail_Queues"
16775   },
16776   {
16777     "type": "get",
16778     "url": "/api/mail/queues/{id}/users",
16779     "title": "Gets queue agents",
16780     "examples": [
16781       {
16782         "title": "Example usage:",
16783         "content": "curl https://{domain}/api/mail/queues/{id}/users -v -u {name}:{password} -X POST",
16784         "type": "json"
16785       }
16786     ],
16787     "name": "GetAgents",
16788     "group": "Mail_Queues",
16789     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16790     "version": "0.0.0",
16791     "filename": "server/api/mailQueue/index.js",
16792     "groupTitle": "Mail_Queues"
16793   },
16794   {
16795     "type": "get",
16796     "url": "/api/mail/queues/{id}/members",
16797     "title": "GetMembers",
16798     "examples": [
16799       {
16800         "title": "Example usage:",
16801         "content": "curl https://{domain}/api/mail/queues/{id}/members  -v -u {name}:{password}",
16802         "type": "json"
16803       }
16804     ],
16805     "name": "GetMembers",
16806     "group": "Mail_Queues",
16807     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16808     "version": "0.0.0",
16809     "filename": "server/api/mailQueue/index.js",
16810     "groupTitle": "Mail_Queues"
16811   },
16812   {
16813     "type": "get",
16814     "url": "/api/mail/queues",
16815     "title": "Gets a list of Queues",
16816     "examples": [
16817       {
16818         "title": "Example usage:",
16819         "content": "curl https://{domain}/api/mail/queues -v -u {name}:{password}",
16820         "type": "json"
16821       }
16822     ],
16823     "name": "GetQueues",
16824     "group": "Mail_Queues",
16825     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
16826     "version": "0.0.0",
16827     "filename": "server/api/mailQueue/index.js",
16828     "groupTitle": "Mail_Queues"
16829   },
16830   {
16831     "type": "get",
16832     "url": "/api/mail/queues/{id}/teams",
16833     "title": "Gets queues list",
16834     "examples": [
16835       {
16836         "title": "Example usage:",
16837         "content": "curl https://{domain}/api/mail/queues/{id}/teams -v -u {name}:{password}",
16838         "type": "json"
16839       }
16840     ],
16841     "name": "GetTeams",
16842     "group": "Mail_Queues",
16843     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16844     "version": "0.0.0",
16845     "filename": "server/api/mailQueue/index.js",
16846     "groupTitle": "Mail_Queues"
16847   },
16848   {
16849     "type": "delete",
16850     "url": "/api/mail/queues/{id}/users",
16851     "title": "Removes agents from a queue",
16852     "examples": [
16853       {
16854         "title": "Example usage:",
16855         "content": "curl https://{domain}/api/mail/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
16856         "type": "json"
16857       }
16858     ],
16859     "name": "RemoveAgents",
16860     "group": "Mail_Queues",
16861     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16862     "version": "0.0.0",
16863     "filename": "server/api/mailQueue/index.js",
16864     "groupTitle": "Mail_Queues"
16865   },
16866   {
16867     "type": "get",
16868     "url": "/api/mail/queues/{id}",
16869     "title": "Gets a single Queue",
16870     "examples": [
16871       {
16872         "title": "Example usage:",
16873         "content": "curl https://{domain}/api/mail/queues/{id} -v -u {name}:{password}",
16874         "type": "json"
16875       }
16876     ],
16877     "name": "ShowQueues",
16878     "group": "Mail_Queues",
16879     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16880     "version": "0.0.0",
16881     "filename": "server/api/mailQueue/index.js",
16882     "groupTitle": "Mail_Queues"
16883   },
16884   {
16885     "type": "put",
16886     "url": "/api/mail/queues/{id}",
16887     "title": "Update an existing Queue",
16888     "examples": [
16889       {
16890         "title": "Example usage:",
16891         "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",
16892         "type": "json"
16893       }
16894     ],
16895     "name": "updateQueues",
16896     "group": "Mail_Queues",
16897     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16898     "version": "0.0.0",
16899     "filename": "server/api/mailQueue/index.js",
16900     "groupTitle": "Mail_Queues"
16901   },
16902   {
16903     "type": "post",
16904     "url": "/api/mail/out_servers",
16905     "title": "Creates a new SMTP",
16906     "examples": [
16907       {
16908         "title": "Example usage:",
16909         "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",
16910         "type": "json"
16911       }
16912     ],
16913     "name": "CreateSMTPs",
16914     "group": "Mail_SMTP",
16915     "parameter": {
16916       "fields": {
16917         "Body": [
16918           {
16919             "group": "Body",
16920             "type": "String",
16921             "optional": true,
16922             "field": "description",
16923             "description": ""
16924           },
16925           {
16926             "group": "Body",
16927             "type": "String",
16928             "optional": true,
16929             "field": "host",
16930             "description": ""
16931           },
16932           {
16933             "group": "Body",
16934             "type": "String",
16935             "optional": true,
16936             "field": "user",
16937             "description": ""
16938           },
16939           {
16940             "group": "Body",
16941             "type": "String",
16942             "optional": true,
16943             "field": "pass",
16944             "description": ""
16945           },
16946           {
16947             "group": "Body",
16948             "type": "Integer",
16949             "optional": true,
16950             "field": "port",
16951             "description": ""
16952           },
16953           {
16954             "group": "Body",
16955             "type": "Boolean",
16956             "optional": true,
16957             "field": "secure",
16958             "description": ""
16959           },
16960           {
16961             "group": "Body",
16962             "type": "String",
16963             "optional": true,
16964             "field": "service",
16965             "description": ""
16966           },
16967           {
16968             "group": "Body",
16969             "type": "Boolean",
16970             "optional": true,
16971             "field": "authentication",
16972             "description": ""
16973           }
16974         ]
16975       }
16976     },
16977     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16978     "version": "0.0.0",
16979     "filename": "server/api/mailServerOut/index.js",
16980     "groupTitle": "Mail_SMTP"
16981   },
16982   {
16983     "type": "delete",
16984     "url": "/api/mail/out_servers/{id}",
16985     "title": "Deletes a SMTP",
16986     "examples": [
16987       {
16988         "title": "Example usage:",
16989         "content": "curl https://{domain}/api/mail/out_servers/{id} -v -u {name}:{password} -X DELETE",
16990         "type": "json"
16991       }
16992     ],
16993     "name": "DeleteSMTPs",
16994     "group": "Mail_SMTP",
16995     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16996     "version": "0.0.0",
16997     "filename": "server/api/mailServerOut/index.js",
16998     "groupTitle": "Mail_SMTP"
16999   },
17000   {
17001     "type": "get",
17002     "url": "/api/mail/out_servers",
17003     "title": "Gets a list of SMTPs",
17004     "examples": [
17005       {
17006         "title": "Example usage:",
17007         "content": "curl https://{domain}/api/mail/out_servers -v -u {name}:{password}",
17008         "type": "json"
17009       }
17010     ],
17011     "name": "GetSMTPs",
17012     "group": "Mail_SMTP",
17013     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
17014     "version": "0.0.0",
17015     "filename": "server/api/mailServerOut/index.js",
17016     "groupTitle": "Mail_SMTP"
17017   },
17018   {
17019     "type": "get",
17020     "url": "/api/mail/out_servers/{id}",
17021     "title": "Gets a single SMTP",
17022     "examples": [
17023       {
17024         "title": "Example usage:",
17025         "content": "curl https://{domain}/api/mail/out_servers/{id} -v -u {name}:{password}",
17026         "type": "json"
17027       }
17028     ],
17029     "name": "ShowSMTPs",
17030     "group": "Mail_SMTP",
17031     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17032     "version": "0.0.0",
17033     "filename": "server/api/mailServerOut/index.js",
17034     "groupTitle": "Mail_SMTP"
17035   },
17036   {
17037     "type": "put",
17038     "url": "/api/mail/out_servers/{id}",
17039     "title": "Update an existing SMTP",
17040     "examples": [
17041       {
17042         "title": "Example usage:",
17043         "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",
17044         "type": "json"
17045       }
17046     ],
17047     "name": "updateSMTPs",
17048     "group": "Mail_SMTP",
17049     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17050     "version": "0.0.0",
17051     "filename": "server/api/mailServerOut/index.js",
17052     "groupTitle": "Mail_SMTP"
17053   },
17054   {
17055     "type": "post",
17056     "url": "/api/mail/substatuses",
17057     "title": "Creates a new Queue",
17058     "examples": [
17059       {
17060         "title": "Example usage:",
17061         "content": "curl https://{domain}/api/mail/substatuses -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
17062         "type": "json"
17063       }
17064     ],
17065     "name": "CreateSubstatuses",
17066     "group": "Mail_Substatuses",
17067     "parameter": {
17068       "fields": {
17069         "Body": [
17070           {
17071             "group": "Body",
17072             "type": "String",
17073             "optional": false,
17074             "field": "name",
17075             "description": ""
17076           },
17077           {
17078             "group": "Body",
17079             "type": "String",
17080             "optional": true,
17081             "field": "description",
17082             "description": ""
17083           }
17084         ]
17085       }
17086     },
17087     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17088     "version": "0.0.0",
17089     "filename": "server/api/mailSubstatus/index.js",
17090     "groupTitle": "Mail_Substatuses"
17091   },
17092   {
17093     "type": "delete",
17094     "url": "/api/mail/substatuses/{id}",
17095     "title": "Deletes a Queue",
17096     "examples": [
17097       {
17098         "title": "Example usage:",
17099         "content": "curl https://{domain}/api/mail/substatuses/{id} -v -u {name}:{password} -X DELETE",
17100         "type": "json"
17101       }
17102     ],
17103     "name": "DeleteSubstatuses",
17104     "group": "Mail_Substatuses",
17105     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17106     "version": "0.0.0",
17107     "filename": "server/api/mailSubstatus/index.js",
17108     "groupTitle": "Mail_Substatuses"
17109   },
17110   {
17111     "type": "get",
17112     "url": "/api/mail/substatuses/describe",
17113     "title": "Gets table info about Substatuses",
17114     "examples": [
17115       {
17116         "title": "Example usage:",
17117         "content": "curl https://{domain}/api/mail/substatuses/describe -v -u {name}:{password}",
17118         "type": "json"
17119       }
17120     ],
17121     "name": "DescribeSubstatuses",
17122     "group": "Mail_Substatuses",
17123     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17124     "version": "0.0.0",
17125     "filename": "server/api/mailSubstatus/index.js",
17126     "groupTitle": "Mail_Substatuses"
17127   },
17128   {
17129     "type": "get",
17130     "url": "/api/mail/substatuses",
17131     "title": "Gets a list of Substatuses",
17132     "examples": [
17133       {
17134         "title": "Example usage:",
17135         "content": "curl https://{domain}/api/mail/substatuses -v -u {name}:{password}",
17136         "type": "json"
17137       }
17138     ],
17139     "name": "GetSubstatuses",
17140     "group": "Mail_Substatuses",
17141     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
17142     "version": "0.0.0",
17143     "filename": "server/api/mailSubstatus/index.js",
17144     "groupTitle": "Mail_Substatuses"
17145   },
17146   {
17147     "type": "get",
17148     "url": "/api/mail/substatuses/{id}",
17149     "title": "Gets a single Queue",
17150     "examples": [
17151       {
17152         "title": "Example usage:",
17153         "content": "curl https://{domain}/api/mail/substatuses/{id} -v -u {name}:{password}",
17154         "type": "json"
17155       }
17156     ],
17157     "name": "ShowSubstatuses",
17158     "group": "Mail_Substatuses",
17159     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17160     "version": "0.0.0",
17161     "filename": "server/api/mailSubstatus/index.js",
17162     "groupTitle": "Mail_Substatuses"
17163   },
17164   {
17165     "type": "put",
17166     "url": "/api/mail/substatuses/{id}",
17167     "title": "Update an existing Queue",
17168     "examples": [
17169       {
17170         "title": "Example usage:",
17171         "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",
17172         "type": "json"
17173       }
17174     ],
17175     "name": "updateSubstatuses",
17176     "group": "Mail_Substatuses",
17177     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17178     "version": "0.0.0",
17179     "filename": "server/api/mailSubstatus/index.js",
17180     "groupTitle": "Mail_Substatuses"
17181   },
17182   {
17183     "type": "post",
17184     "url": "/api/mail/reports/transfer",
17185     "title": "Creates a new Mail Transfer Report",
17186     "examples": [
17187       {
17188         "title": "Example usage:",
17189         "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",
17190         "type": "json"
17191       }
17192     ],
17193     "name": "CreateMail_Transfer_Reports",
17194     "group": "Mail_Transfer_Reports",
17195     "parameter": {
17196       "fields": {
17197         "Body": [
17198           {
17199             "group": "Body",
17200             "type": "String",
17201             "optional": false,
17202             "field": "uniqueid",
17203             "description": ""
17204           },
17205           {
17206             "group": "Body",
17207             "type": "String",
17208             "allowedValues": [
17209               "\"account\"",
17210               "\"agent\"",
17211               "\"queue\""
17212             ],
17213             "optional": false,
17214             "field": "type",
17215             "description": ""
17216           },
17217           {
17218             "group": "Body",
17219             "type": "String",
17220             "optional": false,
17221             "field": "transferredAt",
17222             "description": ""
17223           }
17224         ]
17225       }
17226     },
17227     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17228     "version": "0.0.0",
17229     "filename": "server/api/mailTransferReport/index.js",
17230     "groupTitle": "Mail_Transfer_Reports"
17231   },
17232   {
17233     "type": "delete",
17234     "url": "/api/mail/reports/transfer/{id}",
17235     "title": "Deletes a Mail Transfer Report",
17236     "examples": [
17237       {
17238         "title": "Example usage:",
17239         "content": "curl https://{domain}/api/mail/reports/transfer/{id} -v -u {name}:{password} -X DELETE",
17240         "type": "json"
17241       }
17242     ],
17243     "name": "DeleteMail_Transfer_Reports",
17244     "group": "Mail_Transfer_Reports",
17245     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17246     "version": "0.0.0",
17247     "filename": "server/api/mailTransferReport/index.js",
17248     "groupTitle": "Mail_Transfer_Reports"
17249   },
17250   {
17251     "type": "get",
17252     "url": "/api/mail/reports/transfer/describe",
17253     "title": "Gets table info about Mail Transfer Reports",
17254     "examples": [
17255       {
17256         "title": "Example usage:",
17257         "content": "curl https://{domain}/api/mail/reports/transfer/describe -v -u {name}:{password}",
17258         "type": "json"
17259       }
17260     ],
17261     "name": "DescribeMail_Transfer_Reports",
17262     "group": "Mail_Transfer_Reports",
17263     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17264     "version": "0.0.0",
17265     "filename": "server/api/mailTransferReport/index.js",
17266     "groupTitle": "Mail_Transfer_Reports"
17267   },
17268   {
17269     "type": "get",
17270     "url": "/api/mail/reports/transfer",
17271     "title": "Gets a list of Mail Transfer Reports",
17272     "examples": [
17273       {
17274         "title": "Example usage:",
17275         "content": "curl https://{domain}/api/mail/reports/transfer -v -u {name}:{password}",
17276         "type": "json"
17277       }
17278     ],
17279     "name": "GetMail_Transfer_Reports",
17280     "group": "Mail_Transfer_Reports",
17281     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/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>",
17282     "version": "0.0.0",
17283     "filename": "server/api/mailTransferReport/index.js",
17284     "groupTitle": "Mail_Transfer_Reports"
17285   },
17286   {
17287     "type": "get",
17288     "url": "/api/mail/reports/transfer/{id}",
17289     "title": "Gets a single Mail Transfer Report",
17290     "examples": [
17291       {
17292         "title": "Example usage:",
17293         "content": "curl https://{domain}/api/mail/reports/transfer/{id} -v -u {name}:{password}",
17294         "type": "json"
17295       }
17296     ],
17297     "name": "ShowMail_Transfer_Reports",
17298     "group": "Mail_Transfer_Reports",
17299     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17300     "version": "0.0.0",
17301     "filename": "server/api/mailTransferReport/index.js",
17302     "groupTitle": "Mail_Transfer_Reports"
17303   },
17304   {
17305     "type": "put",
17306     "url": "/api/mail/reports/transfer/{id}",
17307     "title": "Update an existing Mail Transfer Report",
17308     "examples": [
17309       {
17310         "title": "Example usage:",
17311         "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",
17312         "type": "json"
17313       }
17314     ],
17315     "name": "updateMail_Transfer_Reports",
17316     "group": "Mail_Transfer_Reports",
17317     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17318     "version": "0.0.0",
17319     "filename": "server/api/mailTransferReport/index.js",
17320     "groupTitle": "Mail_Transfer_Reports"
17321   },
17322   {
17323     "type": "get",
17324     "url": "/api/members/reports/describe",
17325     "title": "Gets table info about Member Reports",
17326     "examples": [
17327       {
17328         "title": "Example usage:",
17329         "content": "curl https://{domain}/api/members/reports/describe -v -u {name}:{password}",
17330         "type": "json"
17331       }
17332     ],
17333     "name": "DescribeMember_Reports",
17334     "group": "Member_Reports",
17335     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17336     "version": "0.0.0",
17337     "filename": "server/api/memberReport/index.js",
17338     "groupTitle": "Member_Reports"
17339   },
17340   {
17341     "type": "get",
17342     "url": "/api/members/reports",
17343     "title": "Gets a list of Member Reports",
17344     "examples": [
17345       {
17346         "title": "Example usage:",
17347         "content": "curl https://{domain}/api/members/reports -v -u {name}:{password}",
17348         "type": "json"
17349       }
17350     ],
17351     "name": "GetMember_Reports",
17352     "group": "Member_Reports",
17353     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
17354     "version": "0.0.0",
17355     "filename": "server/api/memberReport/index.js",
17356     "groupTitle": "Member_Reports"
17357   },
17358   {
17359     "type": "get",
17360     "url": "/api/members/reports/{id}",
17361     "title": "Gets a single Member Report",
17362     "examples": [
17363       {
17364         "title": "Example usage:",
17365         "content": "curl https://{domain}/api/members/reports/{id} -v -u {name}:{password}",
17366         "type": "json"
17367       }
17368     ],
17369     "name": "ShowMember_Reports",
17370     "group": "Member_Reports",
17371     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17372     "version": "0.0.0",
17373     "filename": "server/api/memberReport/index.js",
17374     "groupTitle": "Member_Reports"
17375   },
17376   {
17377     "type": "get",
17378     "url": "/api/migrations",
17379     "title": "Gets a list of Migrations",
17380     "examples": [
17381       {
17382         "title": "Example usage:",
17383         "content": "curl https://{domain}/api/migrations -v -u {name}:{password}",
17384         "type": "json"
17385       }
17386     ],
17387     "name": "GetMigrations",
17388     "group": "Migrations",
17389     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
17390     "version": "0.0.0",
17391     "filename": "server/api/migration/index.js",
17392     "groupTitle": "Migrations"
17393   },
17394   {
17395     "type": "post",
17396     "url": "/api/voice/networks",
17397     "title": "Create a new network",
17398     "examples": [
17399       {
17400         "title": "Example usage:",
17401         "content": "curl https://{domain}/api/voice/networks -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
17402         "type": "json"
17403       }
17404     ],
17405     "name": "Create",
17406     "group": "Networks",
17407     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17408     "version": "0.0.0",
17409     "filename": "server/api/network/index.js",
17410     "groupTitle": "Networks"
17411   },
17412   {
17413     "type": "delete",
17414     "url": "/api/voice/networks/{id}",
17415     "title": "Deletes a network",
17416     "examples": [
17417       {
17418         "title": "Example usage:",
17419         "content": "curl https://{domain}/api/voice/networks/{id} -v -u {name}:{password} -X DELETE",
17420         "type": "json"
17421       }
17422     ],
17423     "name": "Delete",
17424     "group": "Networks",
17425     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17426     "version": "0.0.0",
17427     "filename": "server/api/network/index.js",
17428     "groupTitle": "Networks"
17429   },
17430   {
17431     "type": "get",
17432     "url": "/api/networks",
17433     "title": "Gets a list of Networks",
17434     "examples": [
17435       {
17436         "title": "Example usage:",
17437         "content": "curl https://{domain}/api/networks -v -u {name}:{password}",
17438         "type": "json"
17439       }
17440     ],
17441     "name": "GetNetworks",
17442     "group": "Networks",
17443     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
17444     "version": "0.0.0",
17445     "filename": "server/api/network/index.js",
17446     "groupTitle": "Networks"
17447   },
17448   {
17449     "type": "get",
17450     "url": "/api/networks/{id}",
17451     "title": "Gets a single Network",
17452     "examples": [
17453       {
17454         "title": "Example usage:",
17455         "content": "curl https://{domain}/api/networks/{id} -v -u {name}:{password}",
17456         "type": "json"
17457       }
17458     ],
17459     "name": "ShowNetworks",
17460     "group": "Networks",
17461     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17462     "version": "0.0.0",
17463     "filename": "server/api/network/index.js",
17464     "groupTitle": "Networks"
17465   },
17466   {
17467     "type": "put",
17468     "url": "/api/voice/networks/{id}",
17469     "title": "Update an existing network",
17470     "examples": [
17471       {
17472         "title": "Example usage:",
17473         "content": "curl https://{domain}/api/voice/networks/{id} -v -u {name}:{password} -X PUT",
17474         "type": "json"
17475       }
17476     ],
17477     "name": "Update",
17478     "group": "Networks",
17479     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17480     "version": "0.0.0",
17481     "filename": "server/api/network/index.js",
17482     "groupTitle": "Networks"
17483   },
17484   {
17485     "type": "post",
17486     "url": "/api/openchannel/accounts/{id}/users",
17487     "title": "Add agents to a openchannel account",
17488     "examples": [
17489       {
17490         "title": "Example usage:",
17491         "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",
17492         "type": "json"
17493       }
17494     ],
17495     "name": "AddAgents",
17496     "group": "Openchannel_Accounts",
17497     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17498     "version": "0.0.0",
17499     "filename": "server/api/openchannelAccount/index.js",
17500     "groupTitle": "Openchannel_Accounts"
17501   },
17502   {
17503     "type": "post",
17504     "url": "/api/openchannel/accounts",
17505     "title": "Creates a new Account",
17506     "examples": [
17507       {
17508         "title": "Example usage:",
17509         "content": "curl https://{domain}/api/openchannel/accounts -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
17510         "type": "json"
17511       }
17512     ],
17513     "name": "CreateAccounts",
17514     "group": "Openchannel_Accounts",
17515     "parameter": {
17516       "fields": {
17517         "Body": [
17518           {
17519             "group": "Body",
17520             "type": "String",
17521             "optional": false,
17522             "field": "name",
17523             "description": ""
17524           },
17525           {
17526             "group": "Body",
17527             "type": "String",
17528             "optional": true,
17529             "field": "description",
17530             "description": ""
17531           },
17532           {
17533             "group": "Body",
17534             "type": "String",
17535             "optional": true,
17536             "field": "token",
17537             "description": ""
17538           },
17539           {
17540             "group": "Body",
17541             "type": "String",
17542             "optional": true,
17543             "field": "replyUri",
17544             "description": ""
17545           },
17546           {
17547             "group": "Body",
17548             "type": "String",
17549             "optional": false,
17550             "field": "key",
17551             "description": ""
17552           },
17553           {
17554             "group": "Body",
17555             "type": "Text",
17556             "optional": true,
17557             "field": "notificationTemplate",
17558             "description": ""
17559           },
17560           {
17561             "group": "Body",
17562             "type": "Boolean",
17563             "optional": true,
17564             "field": "notificationSound",
17565             "description": ""
17566           },
17567           {
17568             "group": "Body",
17569             "type": "Boolean",
17570             "optional": true,
17571             "field": "notificationShake",
17572             "description": ""
17573           },
17574           {
17575             "group": "Body",
17576             "type": "Integer",
17577             "optional": true,
17578             "field": "waitForTheAssignedAgent",
17579             "description": ""
17580           },
17581           {
17582             "group": "Body",
17583             "type": "String",
17584             "optional": true,
17585             "field": "mapKey",
17586             "description": ""
17587           },
17588           {
17589             "group": "Body",
17590             "type": "Boolean",
17591             "optional": true,
17592             "field": "queueTransfer",
17593             "description": ""
17594           },
17595           {
17596             "group": "Body",
17597             "type": "Integer",
17598             "optional": true,
17599             "field": "queueTransferTimeout",
17600             "description": ""
17601           },
17602           {
17603             "group": "Body",
17604             "type": "Boolean",
17605             "optional": true,
17606             "field": "agentTransfer",
17607             "description": ""
17608           },
17609           {
17610             "group": "Body",
17611             "type": "Integer",
17612             "optional": true,
17613             "field": "agentTransferTimeout",
17614             "description": ""
17615           },
17616           {
17617             "group": "Body",
17618             "type": "Integer",
17619             "optional": true,
17620             "field": "mandatoryDispositionPauseId",
17621             "description": "<p>Status to put when mandatory disposition is enabled</p>"
17622           },
17623           {
17624             "group": "Body",
17625             "type": "Boolean",
17626             "optional": true,
17627             "field": "mandatoryDisposition",
17628             "description": "<p>Enabled/disables mandatory dispo on a queue</p>"
17629           }
17630         ]
17631       }
17632     },
17633     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17634     "version": "0.0.0",
17635     "filename": "server/api/openchannelAccount/index.js",
17636     "groupTitle": "Openchannel_Accounts"
17637   },
17638   {
17639     "type": "delete",
17640     "url": "/api/openchannel/accounts/{id}",
17641     "title": "Deletes a Account",
17642     "examples": [
17643       {
17644         "title": "Example usage:",
17645         "content": "curl https://{domain}/api/openchannel/accounts/{id} -v -u {name}:{password} -X DELETE",
17646         "type": "json"
17647       }
17648     ],
17649     "name": "DeleteAccounts",
17650     "group": "Openchannel_Accounts",
17651     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17652     "version": "0.0.0",
17653     "filename": "server/api/openchannelAccount/index.js",
17654     "groupTitle": "Openchannel_Accounts"
17655   },
17656   {
17657     "type": "get",
17658     "url": "/api/openchannel/accounts/describe",
17659     "title": "Gets table info about Accounts",
17660     "examples": [
17661       {
17662         "title": "Example usage:",
17663         "content": "curl https://{domain}/api/openchannel/accounts/describe -v -u {name}:{password}",
17664         "type": "json"
17665       }
17666     ],
17667     "name": "DescribeAccounts",
17668     "group": "Openchannel_Accounts",
17669     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17670     "version": "0.0.0",
17671     "filename": "server/api/openchannelAccount/index.js",
17672     "groupTitle": "Openchannel_Accounts"
17673   },
17674   {
17675     "type": "get",
17676     "url": "/api/openchannel/accounts",
17677     "title": "Gets a list of Accounts",
17678     "examples": [
17679       {
17680         "title": "Example usage:",
17681         "content": "curl https://{domain}/api/openchannel/accounts -v -u {name}:{password}",
17682         "type": "json"
17683       }
17684     ],
17685     "name": "GetAccounts",
17686     "group": "Openchannel_Accounts",
17687     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
17688     "version": "0.0.0",
17689     "filename": "server/api/openchannelAccount/index.js",
17690     "groupTitle": "Openchannel_Accounts"
17691   },
17692   {
17693     "type": "get",
17694     "url": "/api/openchannel/accounts/{id}/users",
17695     "title": "Gets agents from openchannel account",
17696     "examples": [
17697       {
17698         "title": "Example usage:",
17699         "content": "curl https://{domain}/api/openchannel/accounts/{id}/users -v -u {name}:{password} -X GET",
17700         "type": "json"
17701       }
17702     ],
17703     "name": "GetAgents",
17704     "group": "Openchannel_Accounts",
17705     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17706     "version": "0.0.0",
17707     "filename": "server/api/openchannelAccount/index.js",
17708     "groupTitle": "Openchannel_Accounts"
17709   },
17710   {
17711     "type": "delete",
17712     "url": "/api/openchannel/accounts/{id}/users",
17713     "title": "Removes agents from a openchannel account",
17714     "examples": [
17715       {
17716         "title": "Example usage:",
17717         "content": "curl https://{domain}/api/openchannel/accounts/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
17718         "type": "json"
17719       }
17720     ],
17721     "name": "RemoveAgents",
17722     "group": "Openchannel_Accounts",
17723     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17724     "version": "0.0.0",
17725     "filename": "server/api/openchannelAccount/index.js",
17726     "groupTitle": "Openchannel_Accounts"
17727   },
17728   {
17729     "type": "delete",
17730     "url": "/api/openchannel/accounts/{id}/canned_answers",
17731     "title": "Removes canned answers from account",
17732     "examples": [
17733       {
17734         "title": "Example usage:",
17735         "content": "curl https://{domain}/api/openchannel/accounts/{id}/canned_answers?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
17736         "type": "json"
17737       }
17738     ],
17739     "name": "RemoveAnswers",
17740     "group": "Openchannel_Accounts",
17741     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17742     "version": "0.0.0",
17743     "filename": "server/api/openchannelAccount/index.js",
17744     "groupTitle": "Openchannel_Accounts"
17745   },
17746   {
17747     "type": "delete",
17748     "url": "/api/openchannel/accounts/{id}/dispositions",
17749     "title": "Removes dispositions from account",
17750     "examples": [
17751       {
17752         "title": "Example usage:",
17753         "content": "curl https://{domain}/api/openchannel/accounts/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
17754         "type": "json"
17755       }
17756     ],
17757     "name": "RemoveDispositions",
17758     "group": "Openchannel_Accounts",
17759     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17760     "version": "0.0.0",
17761     "filename": "server/api/openchannelAccount/index.js",
17762     "groupTitle": "Openchannel_Accounts"
17763   },
17764   {
17765     "type": "get",
17766     "url": "/api/openchannel/accounts/{id}",
17767     "title": "Gets a single Account",
17768     "examples": [
17769       {
17770         "title": "Example usage:",
17771         "content": "curl https://{domain}/api/openchannel/accounts/{id} -v -u {name}:{password}",
17772         "type": "json"
17773       }
17774     ],
17775     "name": "ShowAccounts",
17776     "group": "Openchannel_Accounts",
17777     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17778     "version": "0.0.0",
17779     "filename": "server/api/openchannelAccount/index.js",
17780     "groupTitle": "Openchannel_Accounts"
17781   },
17782   {
17783     "type": "post",
17784     "url": "/api/openchannel/accounts/{id}/canned_answers",
17785     "title": "Creates new canned answer",
17786     "examples": [
17787       {
17788         "title": "Example usage:",
17789         "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",
17790         "type": "json"
17791       }
17792     ],
17793     "name": "addAnswer",
17794     "group": "Openchannel_Accounts",
17795     "parameter": {
17796       "fields": {
17797         "Body": [
17798           {
17799             "group": "Body",
17800             "type": "String",
17801             "optional": false,
17802             "field": "key",
17803             "description": ""
17804           },
17805           {
17806             "group": "Body",
17807             "type": "Text",
17808             "optional": false,
17809             "field": "value",
17810             "description": ""
17811           },
17812           {
17813             "group": "Body",
17814             "type": "String",
17815             "optional": true,
17816             "field": "description",
17817             "description": ""
17818           },
17819           {
17820             "group": "Body",
17821             "type": "Virtual",
17822             "optional": true,
17823             "field": "name",
17824             "description": ""
17825           }
17826         ]
17827       }
17828     },
17829     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17830     "version": "0.0.0",
17831     "filename": "server/api/openchannelAccount/index.js",
17832     "groupTitle": "Openchannel_Accounts"
17833   },
17834   {
17835     "type": "post",
17836     "url": "/api/openchannel/accounts/{id}/applications",
17837     "title": "Creates new applications",
17838     "examples": [
17839       {
17840         "title": "Example usage:",
17841         "content": "curl https://{domain}/api/openchannel/accounts/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
17842         "type": "json"
17843       }
17844     ],
17845     "name": "addApplications",
17846     "group": "Openchannel_Accounts",
17847     "parameter": {
17848       "fields": {
17849         "Body": [
17850           {
17851             "group": "Body",
17852             "type": "Integer",
17853             "optional": false,
17854             "field": "priority",
17855             "description": ""
17856           },
17857           {
17858             "group": "Body",
17859             "type": "String",
17860             "optional": false,
17861             "field": "app",
17862             "description": ""
17863           },
17864           {
17865             "group": "Body",
17866             "type": "Text",
17867             "optional": true,
17868             "field": "appdata",
17869             "description": ""
17870           },
17871           {
17872             "group": "Body",
17873             "type": "String",
17874             "optional": true,
17875             "field": "description",
17876             "description": ""
17877           },
17878           {
17879             "group": "Body",
17880             "type": "String",
17881             "optional": true,
17882             "field": "interval",
17883             "description": ""
17884           }
17885         ]
17886       }
17887     },
17888     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17889     "version": "0.0.0",
17890     "filename": "server/api/openchannelAccount/index.js",
17891     "groupTitle": "Openchannel_Accounts"
17892   },
17893   {
17894     "type": "post",
17895     "url": "/api/openchannel/accounts/{id}/dispositions",
17896     "title": "Creates new disposition",
17897     "examples": [
17898       {
17899         "title": "Example usage:",
17900         "content": "curl https://{domain}/api/openchannel/accounts/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
17901         "type": "json"
17902       }
17903     ],
17904     "name": "addDisposition",
17905     "group": "Openchannel_Accounts",
17906     "parameter": {
17907       "fields": {
17908         "Body": [
17909           {
17910             "group": "Body",
17911             "type": "String",
17912             "optional": false,
17913             "field": "name",
17914             "description": ""
17915           },
17916           {
17917             "group": "Body",
17918             "type": "String",
17919             "allowedValues": [
17920               "\"first\"",
17921               "\"second\"",
17922               "\"third\""
17923             ],
17924             "optional": false,
17925             "field": "level",
17926             "description": ""
17927           },
17928           {
17929             "group": "Body",
17930             "type": "String",
17931             "optional": true,
17932             "field": "description",
17933             "description": ""
17934           }
17935         ]
17936       }
17937     },
17938     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17939     "version": "0.0.0",
17940     "filename": "server/api/openchannelAccount/index.js",
17941     "groupTitle": "Openchannel_Accounts"
17942   },
17943   {
17944     "type": "get",
17945     "url": "/api/openchannel/accounts/{id}/canned_answers",
17946     "title": "Gets account canned answers",
17947     "examples": [
17948       {
17949         "title": "Example usage:",
17950         "content": "curl https://{domain}/api/openchannel/accounts/{id}/canned_answers -v -u {name}:{password} -X GET",
17951         "type": "json"
17952       }
17953     ],
17954     "name": "getAnswers",
17955     "group": "Openchannel_Accounts",
17956     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17957     "version": "0.0.0",
17958     "filename": "server/api/openchannelAccount/index.js",
17959     "groupTitle": "Openchannel_Accounts"
17960   },
17961   {
17962     "type": "get",
17963     "url": "/api/openchannel/accounts/{id}/applications",
17964     "title": "Gets account applications",
17965     "examples": [
17966       {
17967         "title": "Example usage:",
17968         "content": "curl https://{domain}/api/openchannel/accounts/{id}/applications -v -u {name}:{password} -X GET",
17969         "type": "json"
17970       }
17971     ],
17972     "name": "getApplications",
17973     "group": "Openchannel_Accounts",
17974     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17975     "version": "0.0.0",
17976     "filename": "server/api/openchannelAccount/index.js",
17977     "groupTitle": "Openchannel_Accounts"
17978   },
17979   {
17980     "type": "get",
17981     "url": "/api/openchannel/accounts/{id}/dispositions",
17982     "title": "Gets account dispositions",
17983     "examples": [
17984       {
17985         "title": "Example usage:",
17986         "content": "curl https://{domain}/api/openchannel/accounts/{id}/dispositions -v -u {name}:{password} -X GET",
17987         "type": "json"
17988       }
17989     ],
17990     "name": "getDispositions",
17991     "group": "Openchannel_Accounts",
17992     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17993     "version": "0.0.0",
17994     "filename": "server/api/openchannelAccount/index.js",
17995     "groupTitle": "Openchannel_Accounts"
17996   },
17997   {
17998     "type": "get",
17999     "url": "/api/openchannel/accounts/{id}/interactions",
18000     "title": "Gets Openchannel Account Interactions",
18001     "examples": [
18002       {
18003         "title": "Example usage:",
18004         "content": "curl https://{domain}/api/openchannel/accounts/{id}/interactions -v -u {name}:{password} -X GET",
18005         "type": "json"
18006       }
18007     ],
18008     "name": "getInteractions",
18009     "group": "Openchannel_Accounts",
18010     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18011     "version": "0.0.0",
18012     "filename": "server/api/openchannelAccount/index.js",
18013     "groupTitle": "Openchannel_Accounts"
18014   },
18015   {
18016     "type": "post",
18017     "url": "/api/openchannel/accounts/{id}/notify",
18018     "title": "Notify new message",
18019     "examples": [
18020       {
18021         "title": "Example usage:",
18022         "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",
18023         "type": "json"
18024       }
18025     ],
18026     "name": "notify",
18027     "group": "Openchannel_Accounts",
18028     "description": "<p>Motion 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>",
18029     "version": "0.0.0",
18030     "filename": "server/api/openchannelAccount/index.js",
18031     "groupTitle": "Openchannel_Accounts"
18032   },
18033   {
18034     "type": "post",
18035     "url": "/api/openchannel/accounts/{id}/send",
18036     "title": "Send new openchannel message",
18037     "examples": [
18038       {
18039         "title": "Example usage:",
18040         "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",
18041         "type": "json"
18042       }
18043     ],
18044     "name": "sendOpenchannel",
18045     "group": "Openchannel_Accounts",
18046     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18047     "version": "0.0.0",
18048     "filename": "server/api/openchannelAccount/index.js",
18049     "groupTitle": "Openchannel_Accounts"
18050   },
18051   {
18052     "type": "put",
18053     "url": "/api/openchannel/accounts/{id}",
18054     "title": "Update an existing Account",
18055     "examples": [
18056       {
18057         "title": "Example usage:",
18058         "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",
18059         "type": "json"
18060       }
18061     ],
18062     "name": "updateAccounts",
18063     "group": "Openchannel_Accounts",
18064     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18065     "version": "0.0.0",
18066     "filename": "server/api/openchannelAccount/index.js",
18067     "groupTitle": "Openchannel_Accounts"
18068   },
18069   {
18070     "type": "post",
18071     "url": "/api/openchannel/applications",
18072     "title": "Creates a new Application",
18073     "examples": [
18074       {
18075         "title": "Example usage:",
18076         "content": "curl https://{domain}/api/openchannel/applications -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
18077         "type": "json"
18078       }
18079     ],
18080     "name": "CreateApplications",
18081     "group": "Openchannel_Applications",
18082     "parameter": {
18083       "fields": {
18084         "Body": [
18085           {
18086             "group": "Body",
18087             "type": "Integer",
18088             "optional": false,
18089             "field": "priority",
18090             "description": ""
18091           },
18092           {
18093             "group": "Body",
18094             "type": "String",
18095             "optional": false,
18096             "field": "app",
18097             "description": ""
18098           },
18099           {
18100             "group": "Body",
18101             "type": "Text",
18102             "optional": true,
18103             "field": "appdata",
18104             "description": ""
18105           },
18106           {
18107             "group": "Body",
18108             "type": "String",
18109             "optional": true,
18110             "field": "description",
18111             "description": ""
18112           },
18113           {
18114             "group": "Body",
18115             "type": "String",
18116             "optional": true,
18117             "field": "interval",
18118             "description": ""
18119           }
18120         ]
18121       }
18122     },
18123     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18124     "version": "0.0.0",
18125     "filename": "server/api/openchannelApplication/index.js",
18126     "groupTitle": "Openchannel_Applications"
18127   },
18128   {
18129     "type": "delete",
18130     "url": "/api/openchannel/applications/{id}",
18131     "title": "Deletes a Application",
18132     "examples": [
18133       {
18134         "title": "Example usage:",
18135         "content": "curl https://{domain}/api/openchannel/applications/{id} -v -u {name}:{password} -X DELETE",
18136         "type": "json"
18137       }
18138     ],
18139     "name": "DeleteApplications",
18140     "group": "Openchannel_Applications",
18141     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18142     "version": "0.0.0",
18143     "filename": "server/api/openchannelApplication/index.js",
18144     "groupTitle": "Openchannel_Applications"
18145   },
18146   {
18147     "type": "get",
18148     "url": "/api/openchannel/applications",
18149     "title": "Gets a list of Applications",
18150     "examples": [
18151       {
18152         "title": "Example usage:",
18153         "content": "curl https://{domain}/api/openchannel/applications -v -u {name}:{password}",
18154         "type": "json"
18155       }
18156     ],
18157     "name": "GetApplications",
18158     "group": "Openchannel_Applications",
18159     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
18160     "version": "0.0.0",
18161     "filename": "server/api/openchannelApplication/index.js",
18162     "groupTitle": "Openchannel_Applications"
18163   },
18164   {
18165     "type": "get",
18166     "url": "/api/openchannel/applications/{id}",
18167     "title": "Gets a single Application",
18168     "examples": [
18169       {
18170         "title": "Example usage:",
18171         "content": "curl https://{domain}/api/openchannel/applications/{id} -v -u {name}:{password}",
18172         "type": "json"
18173       }
18174     ],
18175     "name": "ShowApplications",
18176     "group": "Openchannel_Applications",
18177     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18178     "version": "0.0.0",
18179     "filename": "server/api/openchannelApplication/index.js",
18180     "groupTitle": "Openchannel_Applications"
18181   },
18182   {
18183     "type": "put",
18184     "url": "/api/openchannel/applications/{id}",
18185     "title": "Update an existing Application",
18186     "examples": [
18187       {
18188         "title": "Example usage:",
18189         "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",
18190         "type": "json"
18191       }
18192     ],
18193     "name": "updateApplications",
18194     "group": "Openchannel_Applications",
18195     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18196     "version": "0.0.0",
18197     "filename": "server/api/openchannelApplication/index.js",
18198     "groupTitle": "Openchannel_Applications"
18199   },
18200   {
18201     "type": "post",
18202     "url": "/api/openchannel/interactions/{id}/tags",
18203     "title": "Add tags to the interaction",
18204     "examples": [
18205       {
18206         "title": "Example usage:",
18207         "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",
18208         "type": "json"
18209       }
18210     ],
18211     "name": "AddTags",
18212     "group": "Openchannel_Interactions",
18213     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18214     "version": "0.0.0",
18215     "filename": "server/api/openchannelInteraction/index.js",
18216     "groupTitle": "Openchannel_Interactions"
18217   },
18218   {
18219     "type": "post",
18220     "url": "/api/openchannel/interactions",
18221     "title": "Creates a new Interaction",
18222     "examples": [
18223       {
18224         "title": "Example usage:",
18225         "content": "curl https://{domain}/api/openchannel/interactions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
18226         "type": "json"
18227       }
18228     ],
18229     "name": "CreateInteractions",
18230     "group": "Openchannel_Interactions",
18231     "parameter": {
18232       "fields": {
18233         "Body": [
18234           {
18235             "group": "Body",
18236             "type": "Boolean",
18237             "optional": true,
18238             "field": "closed",
18239             "description": ""
18240           },
18241           {
18242             "group": "Body",
18243             "type": "String",
18244             "optional": true,
18245             "field": "closedAt",
18246             "description": ""
18247           },
18248           {
18249             "group": "Body",
18250             "type": "String",
18251             "optional": true,
18252             "field": "disposition",
18253             "description": ""
18254           },
18255           {
18256             "group": "Body",
18257             "type": "String",
18258             "optional": true,
18259             "field": "secondDisposition",
18260             "description": ""
18261           },
18262           {
18263             "group": "Body",
18264             "type": "String",
18265             "optional": true,
18266             "field": "thirdDisposition",
18267             "description": ""
18268           },
18269           {
18270             "group": "Body",
18271             "type": "String",
18272             "optional": true,
18273             "field": "note",
18274             "description": ""
18275           },
18276           {
18277             "group": "Body",
18278             "type": "String",
18279             "optional": true,
18280             "field": "read1stAt",
18281             "description": ""
18282           },
18283           {
18284             "group": "Body",
18285             "type": "String",
18286             "optional": true,
18287             "field": "threadId",
18288             "description": ""
18289           },
18290           {
18291             "group": "Body",
18292             "type": "String",
18293             "optional": true,
18294             "field": "externalUrl",
18295             "description": ""
18296           },
18297           {
18298             "group": "Body",
18299             "type": "String",
18300             "optional": true,
18301             "field": "lastMsgAt",
18302             "description": ""
18303           },
18304           {
18305             "group": "Body",
18306             "type": "String",
18307             "allowedValues": [
18308               "\"in\"",
18309               "\"out\""
18310             ],
18311             "optional": false,
18312             "field": "lastMsgDirection",
18313             "description": ""
18314           },
18315           {
18316             "group": "Body",
18317             "type": "String",
18318             "optional": true,
18319             "field": "from",
18320             "description": ""
18321           },
18322           {
18323             "group": "Body",
18324             "type": "Boolean",
18325             "optional": true,
18326             "field": "autoreplyExecuted",
18327             "description": ""
18328           }
18329         ]
18330       }
18331     },
18332     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18333     "version": "0.0.0",
18334     "filename": "server/api/openchannelInteraction/index.js",
18335     "groupTitle": "Openchannel_Interactions"
18336   },
18337   {
18338     "type": "delete",
18339     "url": "/api/openchannel/interactions/{id}",
18340     "title": "Deletes a Interaction",
18341     "examples": [
18342       {
18343         "title": "Example usage:",
18344         "content": "curl https://{domain}/api/openchannel/interactions/{id} -v -u {name}:{password} -X DELETE",
18345         "type": "json"
18346       }
18347     ],
18348     "name": "DeleteInteractions",
18349     "group": "Openchannel_Interactions",
18350     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18351     "version": "0.0.0",
18352     "filename": "server/api/openchannelInteraction/index.js",
18353     "groupTitle": "Openchannel_Interactions"
18354   },
18355   {
18356     "type": "get",
18357     "url": "/api/openchannel/interactions/describe",
18358     "title": "Gets table info about Interactions",
18359     "examples": [
18360       {
18361         "title": "Example usage:",
18362         "content": "curl https://{domain}/api/openchannel/interactions/describe -v -u {name}:{password}",
18363         "type": "json"
18364       }
18365     ],
18366     "name": "DescribeInteractions",
18367     "group": "Openchannel_Interactions",
18368     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18369     "version": "0.0.0",
18370     "filename": "server/api/openchannelInteraction/index.js",
18371     "groupTitle": "Openchannel_Interactions"
18372   },
18373   {
18374     "type": "get",
18375     "url": "/api/openchannel/interactions",
18376     "title": "Gets a list of Interactions",
18377     "examples": [
18378       {
18379         "title": "Example usage:",
18380         "content": "curl https://{domain}/api/openchannel/interactions -v -u {name}:{password}",
18381         "type": "json"
18382       }
18383     ],
18384     "name": "GetInteractions",
18385     "group": "Openchannel_Interactions",
18386     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
18387     "version": "0.0.0",
18388     "filename": "server/api/openchannelInteraction/index.js",
18389     "groupTitle": "Openchannel_Interactions"
18390   },
18391   {
18392     "type": "delete",
18393     "url": "/api/openchannel/interactions/{id}/tags",
18394     "title": "Removes tags from interaction",
18395     "examples": [
18396       {
18397         "title": "Example usage:",
18398         "content": "curl https://{domain}/api/openchannel/interactions/{id}/tags?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
18399         "type": "json"
18400       }
18401     ],
18402     "name": "RemoveTags",
18403     "group": "Openchannel_Interactions",
18404     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18405     "version": "0.0.0",
18406     "filename": "server/api/openchannelInteraction/index.js",
18407     "groupTitle": "Openchannel_Interactions"
18408   },
18409   {
18410     "type": "get",
18411     "url": "/api/openchannel/interactions/{id}",
18412     "title": "Gets a single Interaction",
18413     "examples": [
18414       {
18415         "title": "Example usage:",
18416         "content": "curl https://{domain}/api/openchannel/interactions/{id} -v -u {name}:{password}",
18417         "type": "json"
18418       }
18419     ],
18420     "name": "ShowInteractions",
18421     "group": "Openchannel_Interactions",
18422     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18423     "version": "0.0.0",
18424     "filename": "server/api/openchannelInteraction/index.js",
18425     "groupTitle": "Openchannel_Interactions"
18426   },
18427   {
18428     "type": "post",
18429     "url": "/api/openchannel/interactions/{id}/messages",
18430     "title": "Creates new messages",
18431     "examples": [
18432       {
18433         "title": "Example usage:",
18434         "content": "curl https://{domain}/api/openchannel/interactions/{id}/messages -d '[{\"to\": \"+3901119886500\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
18435         "type": "json"
18436       }
18437     ],
18438     "name": "addMessage",
18439     "group": "Openchannel_Interactions",
18440     "parameter": {
18441       "fields": {
18442         "Body": [
18443           {
18444             "group": "Body",
18445             "type": "Text",
18446             "optional": false,
18447             "field": "body",
18448             "description": ""
18449           },
18450           {
18451             "group": "Body",
18452             "type": "Boolean",
18453             "optional": true,
18454             "field": "read",
18455             "description": ""
18456           },
18457           {
18458             "group": "Body",
18459             "type": "Boolean",
18460             "optional": true,
18461             "field": "secret",
18462             "description": ""
18463           },
18464           {
18465             "group": "Body",
18466             "type": "String",
18467             "allowedValues": [
18468               "\"in\"",
18469               "\"out\""
18470             ],
18471             "optional": false,
18472             "field": "direction",
18473             "description": ""
18474           },
18475           {
18476             "group": "Body",
18477             "type": "String",
18478             "optional": true,
18479             "field": "readAt",
18480             "description": ""
18481           },
18482           {
18483             "group": "Body",
18484             "type": "String",
18485             "optional": true,
18486             "field": "providerName",
18487             "description": ""
18488           },
18489           {
18490             "group": "Body",
18491             "type": "Text",
18492             "optional": true,
18493             "field": "providerResponse",
18494             "description": ""
18495           }
18496         ]
18497       }
18498     },
18499     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18500     "version": "0.0.0",
18501     "filename": "server/api/openchannelInteraction/index.js",
18502     "groupTitle": "Openchannel_Interactions"
18503   },
18504   {
18505     "type": "get",
18506     "url": "/api/openchannel/interactions/{id}/download",
18507     "title": "Gets interaction",
18508     "examples": [
18509       {
18510         "title": "Example usage:",
18511         "content": "curl https://{domain}/api/openchannel/interactions/{id}/download -v -u {name}:{password} -X GET",
18512         "type": "json"
18513       }
18514     ],
18515     "name": "download",
18516     "group": "Openchannel_Interactions",
18517     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18518     "version": "0.0.0",
18519     "filename": "server/api/openchannelInteraction/index.js",
18520     "groupTitle": "Openchannel_Interactions"
18521   },
18522   {
18523     "type": "get",
18524     "url": "/api/openchannel/interactions/{id}/messages",
18525     "title": "Gets interaction messages",
18526     "examples": [
18527       {
18528         "title": "Example usage:",
18529         "content": "curl https://{domain}/api/openchannel/interactions/{id}/messages -v -u {name}:{password} -X GET",
18530         "type": "json"
18531       }
18532     ],
18533     "name": "getMessages",
18534     "group": "Openchannel_Interactions",
18535     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18536     "version": "0.0.0",
18537     "filename": "server/api/openchannelInteraction/index.js",
18538     "groupTitle": "Openchannel_Interactions"
18539   },
18540   {
18541     "type": "put",
18542     "url": "/api/openchannel/interactions/{id}",
18543     "title": "Update an existing Interaction",
18544     "examples": [
18545       {
18546         "title": "Example usage:",
18547         "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",
18548         "type": "json"
18549       }
18550     ],
18551     "name": "updateInteractions",
18552     "group": "Openchannel_Interactions",
18553     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18554     "version": "0.0.0",
18555     "filename": "server/api/openchannelInteraction/index.js",
18556     "groupTitle": "Openchannel_Interactions"
18557   },
18558   {
18559     "type": "post",
18560     "url": "/api/openchannel/messages",
18561     "title": "Creates a new Message",
18562     "examples": [
18563       {
18564         "title": "Example usage:",
18565         "content": "curl https://{domain}/api/openchannel/messages -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
18566         "type": "json"
18567       }
18568     ],
18569     "name": "CreateMessages",
18570     "group": "Openchannel_Messages",
18571     "parameter": {
18572       "fields": {
18573         "Body": [
18574           {
18575             "group": "Body",
18576             "type": "Text",
18577             "optional": false,
18578             "field": "body",
18579             "description": ""
18580           },
18581           {
18582             "group": "Body",
18583             "type": "Boolean",
18584             "optional": true,
18585             "field": "read",
18586             "description": ""
18587           },
18588           {
18589             "group": "Body",
18590             "type": "Boolean",
18591             "optional": true,
18592             "field": "secret",
18593             "description": ""
18594           },
18595           {
18596             "group": "Body",
18597             "type": "String",
18598             "allowedValues": [
18599               "\"in\"",
18600               "\"out\""
18601             ],
18602             "optional": false,
18603             "field": "direction",
18604             "description": ""
18605           },
18606           {
18607             "group": "Body",
18608             "type": "String",
18609             "optional": true,
18610             "field": "readAt",
18611             "description": ""
18612           },
18613           {
18614             "group": "Body",
18615             "type": "String",
18616             "optional": true,
18617             "field": "providerName",
18618             "description": ""
18619           },
18620           {
18621             "group": "Body",
18622             "type": "Text",
18623             "optional": true,
18624             "field": "providerResponse",
18625             "description": ""
18626           }
18627         ]
18628       }
18629     },
18630     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18631     "version": "0.0.0",
18632     "filename": "server/api/openchannelMessage/index.js",
18633     "groupTitle": "Openchannel_Messages"
18634   },
18635   {
18636     "type": "delete",
18637     "url": "/api/openchannel/messages/{id}",
18638     "title": "Deletes a Message",
18639     "examples": [
18640       {
18641         "title": "Example usage:",
18642         "content": "curl https://{domain}/api/openchannel/messages/{id} -v -u {name}:{password} -X DELETE",
18643         "type": "json"
18644       }
18645     ],
18646     "name": "DeleteMessages",
18647     "group": "Openchannel_Messages",
18648     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18649     "version": "0.0.0",
18650     "filename": "server/api/openchannelMessage/index.js",
18651     "groupTitle": "Openchannel_Messages"
18652   },
18653   {
18654     "type": "get",
18655     "url": "/api/openchannel/messages/describe",
18656     "title": "Gets table info about Messages",
18657     "examples": [
18658       {
18659         "title": "Example usage:",
18660         "content": "curl https://{domain}/api/openchannel/messages/describe -v -u {name}:{password}",
18661         "type": "json"
18662       }
18663     ],
18664     "name": "DescribeMessages",
18665     "group": "Openchannel_Messages",
18666     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18667     "version": "0.0.0",
18668     "filename": "server/api/openchannelMessage/index.js",
18669     "groupTitle": "Openchannel_Messages"
18670   },
18671   {
18672     "type": "get",
18673     "url": "/api/openchannel/messages",
18674     "title": "Gets a list of Messages",
18675     "examples": [
18676       {
18677         "title": "Example usage:",
18678         "content": "curl https://{domain}/api/openchannel/messages -v -u {name}:{password}",
18679         "type": "json"
18680       }
18681     ],
18682     "name": "GetMessages",
18683     "group": "Openchannel_Messages",
18684     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
18685     "version": "0.0.0",
18686     "filename": "server/api/openchannelMessage/index.js",
18687     "groupTitle": "Openchannel_Messages"
18688   },
18689   {
18690     "type": "get",
18691     "url": "/api/openchannel/messages/{id}",
18692     "title": "Gets a single Message",
18693     "examples": [
18694       {
18695         "title": "Example usage:",
18696         "content": "curl https://{domain}/api/openchannel/messages/{id} -v -u {name}:{password}",
18697         "type": "json"
18698       }
18699     ],
18700     "name": "ShowMessages",
18701     "group": "Openchannel_Messages",
18702     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18703     "version": "0.0.0",
18704     "filename": "server/api/openchannelMessage/index.js",
18705     "groupTitle": "Openchannel_Messages"
18706   },
18707   {
18708     "type": "put",
18709     "url": "/api/openchannel/messages/{id}/accept",
18710     "title": "Accepts message",
18711     "examples": [
18712       {
18713         "title": "Example usage:",
18714         "content": "curl https://{domain}/api/openchannel/messages/{id}/accept \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
18715         "type": "json"
18716       }
18717     ],
18718     "name": "acceptMessage",
18719     "group": "Openchannel_Messages",
18720     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18721     "version": "0.0.0",
18722     "filename": "server/api/openchannelMessage/index.js",
18723     "groupTitle": "Openchannel_Messages"
18724   },
18725   {
18726     "type": "put",
18727     "url": "/api/openchannel/messages/{id}/reject",
18728     "title": "Rejects message",
18729     "examples": [
18730       {
18731         "title": "Example usage:",
18732         "content": "curl https://{domain}/api/openchannel/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
18733         "type": "json"
18734       }
18735     ],
18736     "name": "rejectMessage",
18737     "group": "Openchannel_Messages",
18738     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18739     "version": "0.0.0",
18740     "filename": "server/api/openchannelMessage/index.js",
18741     "groupTitle": "Openchannel_Messages"
18742   },
18743   {
18744     "type": "put",
18745     "url": "/api/openchannel/messages/{id}",
18746     "title": "Update an existing Message",
18747     "examples": [
18748       {
18749         "title": "Example usage:",
18750         "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",
18751         "type": "json"
18752       }
18753     ],
18754     "name": "updateMessages",
18755     "group": "Openchannel_Messages",
18756     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18757     "version": "0.0.0",
18758     "filename": "server/api/openchannelMessage/index.js",
18759     "groupTitle": "Openchannel_Messages"
18760   },
18761   {
18762     "type": "post",
18763     "url": "/api/openchannel/reports/queue",
18764     "title": "Creates a new Openchannel Queue Report",
18765     "examples": [
18766       {
18767         "title": "Example usage:",
18768         "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",
18769         "type": "json"
18770       }
18771     ],
18772     "name": "CreateOpenchannel_Queue_Reports",
18773     "group": "Openchannel_Queue_Reports",
18774     "parameter": {
18775       "fields": {
18776         "Body": [
18777           {
18778             "group": "Body",
18779             "type": "String",
18780             "optional": false,
18781             "field": "uniqueid",
18782             "description": ""
18783           },
18784           {
18785             "group": "Body",
18786             "type": "String",
18787             "optional": true,
18788             "field": "from",
18789             "description": ""
18790           },
18791           {
18792             "group": "Body",
18793             "type": "String",
18794             "optional": true,
18795             "field": "joinAt",
18796             "description": ""
18797           },
18798           {
18799             "group": "Body",
18800             "type": "String",
18801             "optional": true,
18802             "field": "leaveAt",
18803             "description": ""
18804           },
18805           {
18806             "group": "Body",
18807             "type": "String",
18808             "optional": true,
18809             "field": "acceptAt",
18810             "description": ""
18811           },
18812           {
18813             "group": "Body",
18814             "type": "String",
18815             "optional": true,
18816             "field": "exitAt",
18817             "description": ""
18818           },
18819           {
18820             "group": "Body",
18821             "type": "String",
18822             "optional": true,
18823             "field": "reason",
18824             "description": ""
18825           }
18826         ]
18827       }
18828     },
18829     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18830     "version": "0.0.0",
18831     "filename": "server/api/openchannelQueueReport/index.js",
18832     "groupTitle": "Openchannel_Queue_Reports"
18833   },
18834   {
18835     "type": "delete",
18836     "url": "/api/openchannel/reports/queue/{id}",
18837     "title": "Deletes a Openchannel Queue Report",
18838     "examples": [
18839       {
18840         "title": "Example usage:",
18841         "content": "curl https://{domain}/api/openchannel/reports/queue/{id} -v -u {name}:{password} -X DELETE",
18842         "type": "json"
18843       }
18844     ],
18845     "name": "DeleteOpenchannel_Queue_Reports",
18846     "group": "Openchannel_Queue_Reports",
18847     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18848     "version": "0.0.0",
18849     "filename": "server/api/openchannelQueueReport/index.js",
18850     "groupTitle": "Openchannel_Queue_Reports"
18851   },
18852   {
18853     "type": "get",
18854     "url": "/api/openchannel/reports/queue/describe",
18855     "title": "Gets table info about Openchannel Queue Reports",
18856     "examples": [
18857       {
18858         "title": "Example usage:",
18859         "content": "curl https://{domain}/api/openchannel/reports/queue/describe -v -u {name}:{password}",
18860         "type": "json"
18861       }
18862     ],
18863     "name": "DescribeOpenchannel_Queue_Reports",
18864     "group": "Openchannel_Queue_Reports",
18865     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18866     "version": "0.0.0",
18867     "filename": "server/api/openchannelQueueReport/index.js",
18868     "groupTitle": "Openchannel_Queue_Reports"
18869   },
18870   {
18871     "type": "get",
18872     "url": "/api/openchannel/reports/queue",
18873     "title": "Gets a list of Openchannel Queue Reports",
18874     "examples": [
18875       {
18876         "title": "Example usage:",
18877         "content": "curl https://{domain}/api/openchannel/reports/queue -v -u {name}:{password}",
18878         "type": "json"
18879       }
18880     ],
18881     "name": "GetOpenchannel_Queue_Reports",
18882     "group": "Openchannel_Queue_Reports",
18883     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
18884     "version": "0.0.0",
18885     "filename": "server/api/openchannelQueueReport/index.js",
18886     "groupTitle": "Openchannel_Queue_Reports"
18887   },
18888   {
18889     "type": "get",
18890     "url": "/api/openchannel/reports/queue/{id}",
18891     "title": "Gets a single Openchannel Queue Report",
18892     "examples": [
18893       {
18894         "title": "Example usage:",
18895         "content": "curl https://{domain}/api/openchannel/reports/queue/{id} -v -u {name}:{password}",
18896         "type": "json"
18897       }
18898     ],
18899     "name": "ShowOpenchannel_Queue_Reports",
18900     "group": "Openchannel_Queue_Reports",
18901     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18902     "version": "0.0.0",
18903     "filename": "server/api/openchannelQueueReport/index.js",
18904     "groupTitle": "Openchannel_Queue_Reports"
18905   },
18906   {
18907     "type": "put",
18908     "url": "/api/openchannel/reports/queue/{id}",
18909     "title": "Update an existing Openchannel Queue Report",
18910     "examples": [
18911       {
18912         "title": "Example usage:",
18913         "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",
18914         "type": "json"
18915       }
18916     ],
18917     "name": "updateOpenchannel_Queue_Reports",
18918     "group": "Openchannel_Queue_Reports",
18919     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18920     "version": "0.0.0",
18921     "filename": "server/api/openchannelQueueReport/index.js",
18922     "groupTitle": "Openchannel_Queue_Reports"
18923   },
18924   {
18925     "type": "post",
18926     "url": "/api/openchannel/queues/{id}/users",
18927     "title": "Add agents to a queue",
18928     "examples": [
18929       {
18930         "title": "Example usage:",
18931         "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",
18932         "type": "json"
18933       }
18934     ],
18935     "name": "AddAgents",
18936     "group": "Openchannel_Queues",
18937     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18938     "version": "0.0.0",
18939     "filename": "server/api/openchannelQueue/index.js",
18940     "groupTitle": "Openchannel_Queues"
18941   },
18942   {
18943     "type": "post",
18944     "url": "/api/openchannel/queues/{id}/teams",
18945     "title": "Add teams to a queue",
18946     "examples": [
18947       {
18948         "title": "Example usage:",
18949         "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",
18950         "type": "json"
18951       }
18952     ],
18953     "name": "AddTeams",
18954     "group": "Openchannel_Queues",
18955     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18956     "version": "0.0.0",
18957     "filename": "server/api/openchannelQueue/index.js",
18958     "groupTitle": "Openchannel_Queues"
18959   },
18960   {
18961     "type": "post",
18962     "url": "/api/openchannel/queues",
18963     "title": "Creates a new Queue",
18964     "examples": [
18965       {
18966         "title": "Example usage:",
18967         "content": "curl https://{domain}/api/openchannel/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
18968         "type": "json"
18969       }
18970     ],
18971     "name": "CreateQueues",
18972     "group": "Openchannel_Queues",
18973     "parameter": {
18974       "fields": {
18975         "Body": [
18976           {
18977             "group": "Body",
18978             "type": "String",
18979             "optional": true,
18980             "field": "name",
18981             "description": ""
18982           },
18983           {
18984             "group": "Body",
18985             "type": "String",
18986             "optional": true,
18987             "field": "description",
18988             "description": ""
18989           },
18990           {
18991             "group": "Body",
18992             "type": "Integer",
18993             "optional": true,
18994             "field": "timeout",
18995             "description": ""
18996           },
18997           {
18998             "group": "Body",
18999             "type": "String",
19000             "allowedValues": [
19001               "\"rrmemory\"",
19002               "\"beepall\"",
19003               "\"roundrobin\""
19004             ],
19005             "optional": true,
19006             "field": "strategy",
19007             "description": ""
19008           }
19009         ]
19010       }
19011     },
19012     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19013     "version": "0.0.0",
19014     "filename": "server/api/openchannelQueue/index.js",
19015     "groupTitle": "Openchannel_Queues"
19016   },
19017   {
19018     "type": "delete",
19019     "url": "/api/openchannel/queues/{id}",
19020     "title": "Deletes a Queue",
19021     "examples": [
19022       {
19023         "title": "Example usage:",
19024         "content": "curl https://{domain}/api/openchannel/queues/{id} -v -u {name}:{password} -X DELETE",
19025         "type": "json"
19026       }
19027     ],
19028     "name": "DeleteQueues",
19029     "group": "Openchannel_Queues",
19030     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19031     "version": "0.0.0",
19032     "filename": "server/api/openchannelQueue/index.js",
19033     "groupTitle": "Openchannel_Queues"
19034   },
19035   {
19036     "type": "get",
19037     "url": "/api/openchannel/queues/describe",
19038     "title": "Gets table info about Queues",
19039     "examples": [
19040       {
19041         "title": "Example usage:",
19042         "content": "curl https://{domain}/api/openchannel/queues/describe -v -u {name}:{password}",
19043         "type": "json"
19044       }
19045     ],
19046     "name": "DescribeQueues",
19047     "group": "Openchannel_Queues",
19048     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19049     "version": "0.0.0",
19050     "filename": "server/api/openchannelQueue/index.js",
19051     "groupTitle": "Openchannel_Queues"
19052   },
19053   {
19054     "type": "get",
19055     "url": "/api/openchannel/queues/{id}/users",
19056     "title": "Gets queue agents",
19057     "examples": [
19058       {
19059         "title": "Example usage:",
19060         "content": "curl https://{domain}/api/openchannel/queues/{id}/users -v -u {name}:{password} -X POST",
19061         "type": "json"
19062       }
19063     ],
19064     "name": "GetAgents",
19065     "group": "Openchannel_Queues",
19066     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19067     "version": "0.0.0",
19068     "filename": "server/api/openchannelQueue/index.js",
19069     "groupTitle": "Openchannel_Queues"
19070   },
19071   {
19072     "type": "get",
19073     "url": "/api/openchannel/queues/{id}/members",
19074     "title": "GetMembers",
19075     "examples": [
19076       {
19077         "title": "Example usage:",
19078         "content": "curl https://{domain}/api/openchannel/queues/{id}/members  -v -u {name}:{password}",
19079         "type": "json"
19080       }
19081     ],
19082     "name": "GetMembers",
19083     "group": "Openchannel_Queues",
19084     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19085     "version": "0.0.0",
19086     "filename": "server/api/openchannelQueue/index.js",
19087     "groupTitle": "Openchannel_Queues"
19088   },
19089   {
19090     "type": "get",
19091     "url": "/api/openchannel/queues",
19092     "title": "Gets a list of Queues",
19093     "examples": [
19094       {
19095         "title": "Example usage:",
19096         "content": "curl https://{domain}/api/openchannel/queues -v -u {name}:{password}",
19097         "type": "json"
19098       }
19099     ],
19100     "name": "GetQueues",
19101     "group": "Openchannel_Queues",
19102     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
19103     "version": "0.0.0",
19104     "filename": "server/api/openchannelQueue/index.js",
19105     "groupTitle": "Openchannel_Queues"
19106   },
19107   {
19108     "type": "get",
19109     "url": "/api/openchannel/queues/{id}/teams",
19110     "title": "Gets queues list",
19111     "examples": [
19112       {
19113         "title": "Example usage:",
19114         "content": "curl https://{domain}/api/openchannel/queues/{id}/teams -v -u {name}:{password}",
19115         "type": "json"
19116       }
19117     ],
19118     "name": "GetTeams",
19119     "group": "Openchannel_Queues",
19120     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19121     "version": "0.0.0",
19122     "filename": "server/api/openchannelQueue/index.js",
19123     "groupTitle": "Openchannel_Queues"
19124   },
19125   {
19126     "type": "delete",
19127     "url": "/api/openchannel/queues/{id}/users",
19128     "title": "Removes agents from a queue",
19129     "examples": [
19130       {
19131         "title": "Example usage:",
19132         "content": "curl https://{domain}/api/openchannel/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
19133         "type": "json"
19134       }
19135     ],
19136     "name": "RemoveAgents",
19137     "group": "Openchannel_Queues",
19138     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19139     "version": "0.0.0",
19140     "filename": "server/api/openchannelQueue/index.js",
19141     "groupTitle": "Openchannel_Queues"
19142   },
19143   {
19144     "type": "get",
19145     "url": "/api/openchannel/queues/{id}",
19146     "title": "Gets a single Queue",
19147     "examples": [
19148       {
19149         "title": "Example usage:",
19150         "content": "curl https://{domain}/api/openchannel/queues/{id} -v -u {name}:{password}",
19151         "type": "json"
19152       }
19153     ],
19154     "name": "ShowQueues",
19155     "group": "Openchannel_Queues",
19156     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19157     "version": "0.0.0",
19158     "filename": "server/api/openchannelQueue/index.js",
19159     "groupTitle": "Openchannel_Queues"
19160   },
19161   {
19162     "type": "put",
19163     "url": "/api/openchannel/queues/{id}",
19164     "title": "Update an existing Queue",
19165     "examples": [
19166       {
19167         "title": "Example usage:",
19168         "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",
19169         "type": "json"
19170       }
19171     ],
19172     "name": "updateQueues",
19173     "group": "Openchannel_Queues",
19174     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19175     "version": "0.0.0",
19176     "filename": "server/api/openchannelQueue/index.js",
19177     "groupTitle": "Openchannel_Queues"
19178   },
19179   {
19180     "type": "post",
19181     "url": "/api/openchannel/reports/transfer",
19182     "title": "Creates a new Openchannel Transfer Report",
19183     "examples": [
19184       {
19185         "title": "Example usage:",
19186         "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",
19187         "type": "json"
19188       }
19189     ],
19190     "name": "CreateOpenchannel_Transfer_Reports",
19191     "group": "Openchannel_Transfer_Reports",
19192     "parameter": {
19193       "fields": {
19194         "Body": [
19195           {
19196             "group": "Body",
19197             "type": "String",
19198             "optional": false,
19199             "field": "uniqueid",
19200             "description": ""
19201           },
19202           {
19203             "group": "Body",
19204             "type": "String",
19205             "allowedValues": [
19206               "\"account\"",
19207               "\"agent\"",
19208               "\"queue\""
19209             ],
19210             "optional": false,
19211             "field": "type",
19212             "description": ""
19213           },
19214           {
19215             "group": "Body",
19216             "type": "String",
19217             "optional": false,
19218             "field": "transferredAt",
19219             "description": ""
19220           }
19221         ]
19222       }
19223     },
19224     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19225     "version": "0.0.0",
19226     "filename": "server/api/openchannelTransferReport/index.js",
19227     "groupTitle": "Openchannel_Transfer_Reports"
19228   },
19229   {
19230     "type": "delete",
19231     "url": "/api/openchannel/reports/transfer/{id}",
19232     "title": "Deletes a Openchannel Transfer Report",
19233     "examples": [
19234       {
19235         "title": "Example usage:",
19236         "content": "curl https://{domain}/api/openchannel/reports/transfer/{id} -v -u {name}:{password} -X DELETE",
19237         "type": "json"
19238       }
19239     ],
19240     "name": "DeleteOpenchannel_Transfer_Reports",
19241     "group": "Openchannel_Transfer_Reports",
19242     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19243     "version": "0.0.0",
19244     "filename": "server/api/openchannelTransferReport/index.js",
19245     "groupTitle": "Openchannel_Transfer_Reports"
19246   },
19247   {
19248     "type": "get",
19249     "url": "/api/openchannel/reports/transfer/describe",
19250     "title": "Gets table info about Openchannel Transfer Reports",
19251     "examples": [
19252       {
19253         "title": "Example usage:",
19254         "content": "curl https://{domain}/api/openchannel/reports/transfer/describe -v -u {name}:{password}",
19255         "type": "json"
19256       }
19257     ],
19258     "name": "DescribeOpenchannel_Transfer_Reports",
19259     "group": "Openchannel_Transfer_Reports",
19260     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19261     "version": "0.0.0",
19262     "filename": "server/api/openchannelTransferReport/index.js",
19263     "groupTitle": "Openchannel_Transfer_Reports"
19264   },
19265   {
19266     "type": "get",
19267     "url": "/api/openchannel/reports/transfer",
19268     "title": "Gets a list of Openchannel Transfer Reports",
19269     "examples": [
19270       {
19271         "title": "Example usage:",
19272         "content": "curl https://{domain}/api/openchannel/reports/transfer -v -u {name}:{password}",
19273         "type": "json"
19274       }
19275     ],
19276     "name": "GetOpenchannel_Transfer_Reports",
19277     "group": "Openchannel_Transfer_Reports",
19278     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
19279     "version": "0.0.0",
19280     "filename": "server/api/openchannelTransferReport/index.js",
19281     "groupTitle": "Openchannel_Transfer_Reports"
19282   },
19283   {
19284     "type": "get",
19285     "url": "/api/openchannel/reports/transfer/{id}",
19286     "title": "Gets a single Openchannel Transfer Report",
19287     "examples": [
19288       {
19289         "title": "Example usage:",
19290         "content": "curl https://{domain}/api/openchannel/reports/transfer/{id} -v -u {name}:{password}",
19291         "type": "json"
19292       }
19293     ],
19294     "name": "ShowOpenchannel_Transfer_Reports",
19295     "group": "Openchannel_Transfer_Reports",
19296     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19297     "version": "0.0.0",
19298     "filename": "server/api/openchannelTransferReport/index.js",
19299     "groupTitle": "Openchannel_Transfer_Reports"
19300   },
19301   {
19302     "type": "put",
19303     "url": "/api/openchannel/reports/transfer/{id}",
19304     "title": "Update an existing Openchannel Transfer Report",
19305     "examples": [
19306       {
19307         "title": "Example usage:",
19308         "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",
19309         "type": "json"
19310       }
19311     ],
19312     "name": "updateOpenchannel_Transfer_Reports",
19313     "group": "Openchannel_Transfer_Reports",
19314     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19315     "version": "0.0.0",
19316     "filename": "server/api/openchannelTransferReport/index.js",
19317     "groupTitle": "Openchannel_Transfer_Reports"
19318   },
19319   {
19320     "type": "post",
19321     "url": "/api/pauses",
19322     "title": "Creates a new Pause",
19323     "examples": [
19324       {
19325         "title": "Example usage:",
19326         "content": "curl https://{domain}/api/pauses -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
19327         "type": "json"
19328       }
19329     ],
19330     "name": "CreatePauses",
19331     "group": "Pauses",
19332     "parameter": {
19333       "fields": {
19334         "Body": [
19335           {
19336             "group": "Body",
19337             "type": "String",
19338             "optional": false,
19339             "field": "name",
19340             "description": ""
19341           },
19342           {
19343             "group": "Body",
19344             "type": "String",
19345             "optional": true,
19346             "field": "description",
19347             "description": ""
19348           }
19349         ]
19350       }
19351     },
19352     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19353     "version": "0.0.0",
19354     "filename": "server/api/pause/index.js",
19355     "groupTitle": "Pauses"
19356   },
19357   {
19358     "type": "delete",
19359     "url": "/api/pauses/{id}",
19360     "title": "Deletes a Pause",
19361     "examples": [
19362       {
19363         "title": "Example usage:",
19364         "content": "curl https://{domain}/api/pauses/{id} -v -u {name}:{password} -X DELETE",
19365         "type": "json"
19366       }
19367     ],
19368     "name": "DeletePauses",
19369     "group": "Pauses",
19370     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19371     "version": "0.0.0",
19372     "filename": "server/api/pause/index.js",
19373     "groupTitle": "Pauses"
19374   },
19375   {
19376     "type": "get",
19377     "url": "/api/pauses",
19378     "title": "Gets a list of Pauses",
19379     "examples": [
19380       {
19381         "title": "Example usage:",
19382         "content": "curl https://{domain}/api/pauses -v -u {name}:{password}",
19383         "type": "json"
19384       }
19385     ],
19386     "name": "GetPauses",
19387     "group": "Pauses",
19388     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
19389     "version": "0.0.0",
19390     "filename": "server/api/pause/index.js",
19391     "groupTitle": "Pauses"
19392   },
19393   {
19394     "type": "get",
19395     "url": "/api/pauses/{id}",
19396     "title": "Gets a single Pause",
19397     "examples": [
19398       {
19399         "title": "Example usage:",
19400         "content": "curl https://{domain}/api/pauses/{id} -v -u {name}:{password}",
19401         "type": "json"
19402       }
19403     ],
19404     "name": "ShowPauses",
19405     "group": "Pauses",
19406     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19407     "version": "0.0.0",
19408     "filename": "server/api/pause/index.js",
19409     "groupTitle": "Pauses"
19410   },
19411   {
19412     "type": "put",
19413     "url": "/api/pauses/{id}",
19414     "title": "Update an existing Pause",
19415     "examples": [
19416       {
19417         "title": "Example usage:",
19418         "content": "curl https://{domain}/api/pauses/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
19419         "type": "json"
19420       }
19421     ],
19422     "name": "updatePauses",
19423     "group": "Pauses",
19424     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19425     "version": "0.0.0",
19426     "filename": "server/api/pause/index.js",
19427     "groupTitle": "Pauses"
19428   },
19429   {
19430     "type": "get",
19431     "url": "/api/plugins",
19432     "title": "Gets a list of Plugins",
19433     "examples": [
19434       {
19435         "title": "Example usage:",
19436         "content": "curl https://{domain}/api/plugins -v -u {name}:{password}",
19437         "type": "json"
19438       }
19439     ],
19440     "name": "GetPlugins",
19441     "group": "Plugins",
19442     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
19443     "version": "0.0.0",
19444     "filename": "server/api/plugin/index.js",
19445     "groupTitle": "Plugins"
19446   },
19447   {
19448     "type": "get",
19449     "url": "/api/plugins/{id}",
19450     "title": "Gets a single Plugin",
19451     "examples": [
19452       {
19453         "title": "Example usage:",
19454         "content": "curl https://{domain}/api/plugins/{id} -v -u {name}:{password}",
19455         "type": "json"
19456       }
19457     ],
19458     "name": "ShowPlugins",
19459     "group": "Plugins",
19460     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19461     "version": "0.0.0",
19462     "filename": "server/api/plugin/index.js",
19463     "groupTitle": "Plugins"
19464   },
19465   {
19466     "type": "delete",
19467     "url": "/api/plugins/{id}",
19468     "title": "Delete a plugin",
19469     "examples": [
19470       {
19471         "title": "Example usage:",
19472         "content": "curl https://{domain}/api/plugins/{id} -v -u {name}:{password} -X DELETE",
19473         "type": "json"
19474       }
19475     ],
19476     "name": "destroyPlugin",
19477     "group": "Plugins",
19478     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19479     "version": "0.0.0",
19480     "filename": "server/api/plugin/index.js",
19481     "groupTitle": "Plugins"
19482   },
19483   {
19484     "type": "get",
19485     "url": "/api/plugins/{id}/download",
19486     "title": "Download plugin source code",
19487     "examples": [
19488       {
19489         "title": "Example usage:",
19490         "content": "curl https://{domain}/api/plugins/{id}/download -v -u {name}:{password} -X GET",
19491         "type": "json"
19492       }
19493     ],
19494     "name": "download",
19495     "group": "Plugins",
19496     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19497     "version": "0.0.0",
19498     "filename": "server/api/plugin/index.js",
19499     "groupTitle": "Plugins"
19500   },
19501   {
19502     "type": "put",
19503     "url": "/api/plugins/{id}",
19504     "title": "Update an existing plugin",
19505     "examples": [
19506       {
19507         "title": "Example usage:",
19508         "content": "curl https://{domain}/api/plugins/{id} -v -u {name}:{password} -X PUT",
19509         "type": "json"
19510       }
19511     ],
19512     "name": "updatePlugin",
19513     "group": "Plugins",
19514     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19515     "version": "0.0.0",
19516     "filename": "server/api/plugin/index.js",
19517     "groupTitle": "Plugins"
19518   },
19519   {
19520     "type": "post",
19521     "url": "/api/plugins",
19522     "title": "Upload new plugin",
19523     "examples": [
19524       {
19525         "title": "Example usage:",
19526         "content": "curl https://{domain}/api/plugins -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
19527         "type": "json"
19528       }
19529     ],
19530     "name": "uploadPlugin",
19531     "group": "Plugins",
19532     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19533     "version": "0.0.0",
19534     "filename": "server/api/plugin/index.js",
19535     "groupTitle": "Plugins"
19536   },
19537   {
19538     "type": "get",
19539     "url": "/api/plugins/webhook?hostname={host}&port={port}&encoding={encoding}&json={json}&path={path}",
19540     "title": "Redirect a plugin request to the specified path",
19541     "examples": [
19542       {
19543         "title": "Example usage:",
19544         "content": "curl https://{domain}/api/plugins/webhook?port={port}&path={path} -v -u {name}:{password} -X GET",
19545         "type": "json"
19546       }
19547     ],
19548     "name": "webhookPlugin",
19549     "group": "Plugins",
19550     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19551     "version": "0.0.0",
19552     "filename": "server/api/plugin/index.js",
19553     "groupTitle": "Plugins"
19554   },
19555   {
19556     "type": "post",
19557     "url": "/api/plugins/webhook?hostname={host}&port={port}&encoding={encoding}&json={json}&path={path}",
19558     "title": "Redirect a plugin request to the specified path",
19559     "examples": [
19560       {
19561         "title": "Example usage:",
19562         "content": "curl https://{domain}/api/plugins/webhook?port={port}&path={path} -H 'Content-Type: application/json' -X POST",
19563         "type": "json"
19564       }
19565     ],
19566     "name": "webhookPlugin",
19567     "group": "Plugins",
19568     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19569     "version": "0.0.0",
19570     "filename": "server/api/plugin/index.js",
19571     "groupTitle": "Plugins"
19572   },
19573   {
19574     "type": "delete",
19575     "url": "/api/pm2/{id}",
19576     "title": "Deletes an existing process",
19577     "examples": [
19578       {
19579         "title": "Example usage:",
19580         "content": "curl https://{domain}/api/pm2/{id} -v -u {name}:{password} -X DELETE",
19581         "type": "json"
19582       }
19583     ],
19584     "name": "DeletePm2Process",
19585     "group": "Pm2",
19586     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19587     "version": "0.0.0",
19588     "filename": "server/api/pm2/index.js",
19589     "groupTitle": "Pm2"
19590   },
19591   {
19592     "type": "get",
19593     "url": "/api/pm2/{id}",
19594     "title": "Gets a single pm2 process",
19595     "examples": [
19596       {
19597         "title": "Example usage:",
19598         "content": "curl https://{domain}/api/pm2/{id} -v -u {name}:{password}",
19599         "type": "json"
19600       }
19601     ],
19602     "name": "GetPm2Process",
19603     "group": "Pm2",
19604     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19605     "version": "0.0.0",
19606     "filename": "server/api/pm2/index.js",
19607     "groupTitle": "Pm2"
19608   },
19609   {
19610     "type": "get",
19611     "url": "/api/pm2",
19612     "title": "Gets pm2 processes",
19613     "examples": [
19614       {
19615         "title": "Example usage:",
19616         "content": "curl https://{domain}/api/pm2 -v -u {name}:{password}",
19617         "type": "json"
19618       }
19619     ],
19620     "name": "GetPm2Processes",
19621     "group": "Pm2",
19622     "description": "<p>Motion returns the pm2 processes list.</p>",
19623     "version": "0.0.0",
19624     "filename": "server/api/pm2/index.js",
19625     "groupTitle": "Pm2"
19626   },
19627   {
19628     "type": "post",
19629     "url": "/api/pm2",
19630     "title": "Start a single pm2 process",
19631     "examples": [
19632       {
19633         "title": "Example usage:",
19634         "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",
19635         "type": "json"
19636       }
19637     ],
19638     "name": "StartPm2Process",
19639     "group": "Pm2",
19640     "parameter": {
19641       "fields": {
19642         "Body": [
19643           {
19644             "group": "Body",
19645             "type": "String",
19646             "optional": false,
19647             "field": "name",
19648             "description": ""
19649           },
19650           {
19651             "group": "Body",
19652             "type": "String",
19653             "optional": false,
19654             "field": "script",
19655             "description": ""
19656           }
19657         ]
19658       }
19659     },
19660     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19661     "version": "0.0.0",
19662     "filename": "server/api/pm2/index.js",
19663     "groupTitle": "Pm2"
19664   },
19665   {
19666     "type": "put",
19667     "url": "/api/pm2/{id}",
19668     "title": "Update an existing process",
19669     "examples": [
19670       {
19671         "title": "Example usage:",
19672         "content": "curl https://{domain}/api/pm2/{id} -d '{\"status\": \"online\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
19673         "type": "json"
19674       }
19675     ],
19676     "name": "UpdatePm2Process",
19677     "group": "Pm2",
19678     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19679     "version": "0.0.0",
19680     "filename": "server/api/pm2/index.js",
19681     "groupTitle": "Pm2"
19682   },
19683   {
19684     "type": "get",
19685     "url": "/api/rpc/campaigns/",
19686     "title": "Gets a list of campaigns",
19687     "examples": [
19688       {
19689         "title": "Example usage:",
19690         "content": "curl https://{domain}/api/rpc/campaigns -v -u {name}:{password}",
19691         "type": "json"
19692       }
19693     ],
19694     "name": "Campaigns",
19695     "group": "RPC_Realtime",
19696     "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>",
19697     "version": "0.0.0",
19698     "filename": "server/api/rpc/index.js",
19699     "groupTitle": "RPC_Realtime"
19700   },
19701   {
19702     "type": "get",
19703     "url": "/api/rpc/fax/accounts",
19704     "title": "Gets a list of FaxAccounts",
19705     "examples": [
19706       {
19707         "title": "Example usage:",
19708         "content": "curl https://{domain}/api/rpc/fax/accounts -v -u {name}:{password}",
19709         "type": "json"
19710       }
19711     ],
19712     "name": "FaxAccounts",
19713     "group": "RPC_Realtime",
19714     "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>",
19715     "version": "0.0.0",
19716     "filename": "server/api/rpc/index.js",
19717     "groupTitle": "RPC_Realtime"
19718   },
19719   {
19720     "type": "put",
19721     "url": "/api/rpc/agents/:id/capacity",
19722     "title": "Sets agent capacity",
19723     "examples": [
19724       {
19725         "title": "Example usage:",
19726         "content": "curl https://{domain}/api/rpc/agents/:id/capacity -v -u {name}:{password}",
19727         "type": "json"
19728       }
19729     ],
19730     "name": "RTAgentCapacity",
19731     "group": "RPC_Realtime",
19732     "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>",
19733     "version": "0.0.0",
19734     "filename": "server/api/rpc/index.js",
19735     "groupTitle": "RPC_Realtime"
19736   },
19737   {
19738     "type": "get",
19739     "url": "/api/rpc/agents",
19740     "title": "Gets a list of RTAgents",
19741     "examples": [
19742       {
19743         "title": "Example usage:",
19744         "content": "curl https://{domain}/api/rpc/agents -v -u {name}:{password}",
19745         "type": "json"
19746       }
19747     ],
19748     "name": "RTAgents",
19749     "group": "RPC_Realtime",
19750     "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>",
19751     "version": "0.0.0",
19752     "filename": "server/api/rpc/index.js",
19753     "groupTitle": "RPC_Realtime"
19754   },
19755   {
19756     "type": "get",
19757     "url": "/api/rpc/chat/queues",
19758     "title": "Gets a list of RTChatQueues",
19759     "examples": [
19760       {
19761         "title": "Example usage:",
19762         "content": "curl https://{domain}/api/rpc/chat/queues -v -u {name}:{password}",
19763         "type": "json"
19764       }
19765     ],
19766     "name": "RTChatQueues",
19767     "group": "RPC_Realtime",
19768     "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>",
19769     "version": "0.0.0",
19770     "filename": "server/api/rpc/index.js",
19771     "groupTitle": "RPC_Realtime"
19772   },
19773   {
19774     "type": "get",
19775     "url": "/api/rpc/fax/queues",
19776     "title": "Gets a list of RTFaxQueues",
19777     "examples": [
19778       {
19779         "title": "Example usage:",
19780         "content": "curl https://{domain}/api/rpc/fax/queues -v -u {name}:{password}",
19781         "type": "json"
19782       }
19783     ],
19784     "name": "RTFaxQueues",
19785     "group": "RPC_Realtime",
19786     "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>",
19787     "version": "0.0.0",
19788     "filename": "server/api/rpc/index.js",
19789     "groupTitle": "RPC_Realtime"
19790   },
19791   {
19792     "type": "get",
19793     "url": "/api/rpc/mail/accounts",
19794     "title": "Gets a list of RTMailAccounts",
19795     "examples": [
19796       {
19797         "title": "Example usage:",
19798         "content": "curl https://{domain}/api/rpc/mail/accounts -v -u {name}:{password}",
19799         "type": "json"
19800       }
19801     ],
19802     "name": "RTMailAccounts",
19803     "group": "RPC_Realtime",
19804     "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>",
19805     "version": "0.0.0",
19806     "filename": "server/api/rpc/index.js",
19807     "groupTitle": "RPC_Realtime"
19808   },
19809   {
19810     "type": "get",
19811     "url": "/api/rpc/mail/queues",
19812     "title": "Gets a list of RTMailQueues",
19813     "examples": [
19814       {
19815         "title": "Example usage:",
19816         "content": "curl https://{domain}/api/rpc/mail/queues -v -u {name}:{password}",
19817         "type": "json"
19818       }
19819     ],
19820     "name": "RTMailQueues",
19821     "group": "RPC_Realtime",
19822     "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>",
19823     "version": "0.0.0",
19824     "filename": "server/api/rpc/index.js",
19825     "groupTitle": "RPC_Realtime"
19826   },
19827   {
19828     "type": "get",
19829     "url": "/api/rpc/openchannel/queues",
19830     "title": "Gets a list of RTOpenchannelQueues",
19831     "examples": [
19832       {
19833         "title": "Example usage:",
19834         "content": "curl https://{domain}/api/rpc/openchannel/queues -v -u {name}:{password}",
19835         "type": "json"
19836       }
19837     ],
19838     "name": "RTOpenchannelQueues",
19839     "group": "RPC_Realtime",
19840     "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>",
19841     "version": "0.0.0",
19842     "filename": "server/api/rpc/index.js",
19843     "groupTitle": "RPC_Realtime"
19844   },
19845   {
19846     "type": "get",
19847     "url": "/api/rpc/outbound/channels",
19848     "title": "Gets a list of RTOutboundChannels",
19849     "examples": [
19850       {
19851         "title": "Example usage:",
19852         "content": "curl https://{domain}/api/rpc/outbound/channels -v -u {name}:{password}",
19853         "type": "json"
19854       }
19855     ],
19856     "name": "RTOutboundChannels",
19857     "group": "RPC_Realtime",
19858     "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>",
19859     "version": "0.0.0",
19860     "filename": "server/api/rpc/index.js",
19861     "groupTitle": "RPC_Realtime"
19862   },
19863   {
19864     "type": "get",
19865     "url": "/api/rpc/sms/queues",
19866     "title": "Gets a list of RTSmsQueues",
19867     "examples": [
19868       {
19869         "title": "Example usage:",
19870         "content": "curl https://{domain}/api/rpc/sms/queues -v -u {name}:{password}",
19871         "type": "json"
19872       }
19873     ],
19874     "name": "RTSmsQueues",
19875     "group": "RPC_Realtime",
19876     "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>",
19877     "version": "0.0.0",
19878     "filename": "server/api/rpc/index.js",
19879     "groupTitle": "RPC_Realtime"
19880   },
19881   {
19882     "type": "get",
19883     "url": "/api/rpc/telephones",
19884     "title": "Gets a list of RTTelephones",
19885     "examples": [
19886       {
19887         "title": "Example usage:",
19888         "content": "curl https://{domain}/api/rpc/telephones -v -u {name}:{password}",
19889         "type": "json"
19890       }
19891     ],
19892     "name": "RTTelephones",
19893     "group": "RPC_Realtime",
19894     "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>",
19895     "version": "0.0.0",
19896     "filename": "server/api/rpc/index.js",
19897     "groupTitle": "RPC_Realtime"
19898   },
19899   {
19900     "type": "get",
19901     "url": "/api/rpc/trunks",
19902     "title": "Gets a list of RTTrunks",
19903     "examples": [
19904       {
19905         "title": "Example usage:",
19906         "content": "curl https://{domain}/api/rpc/trunks -v -u {name}:{password}",
19907         "type": "json"
19908       }
19909     ],
19910     "name": "RTTrunks",
19911     "group": "RPC_Realtime",
19912     "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>",
19913     "version": "0.0.0",
19914     "filename": "server/api/rpc/index.js",
19915     "groupTitle": "RPC_Realtime"
19916   },
19917   {
19918     "type": "get",
19919     "url": "/api/rpc/voice/channels",
19920     "title": "Gets a list of RTVoiceChannelMixMonitor",
19921     "examples": [
19922       {
19923         "title": "Example usage:",
19924         "content": "curl https://{domain}/api/rpc/voice/channels/{uniqueid}/mixmonitor -v -u {name}:{password}",
19925         "type": "json"
19926       }
19927     ],
19928     "name": "RTVoiceChannelMixMonitor",
19929     "group": "RPC_Realtime",
19930     "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>",
19931     "version": "0.0.0",
19932     "filename": "server/api/rpc/index.js",
19933     "groupTitle": "RPC_Realtime"
19934   },
19935   {
19936     "type": "get",
19937     "url": "/api/rpc/voice/channels",
19938     "title": "Gets a list of RTVoiceChannelStopMixMonitor",
19939     "examples": [
19940       {
19941         "title": "Example usage:",
19942         "content": "curl https://{domain}/api/rpc/voice/channels/{uniqueid}/stopmixmonitor -v -u {name}:{password}",
19943         "type": "json"
19944       }
19945     ],
19946     "name": "RTVoiceChannelStopMixMonitor",
19947     "group": "RPC_Realtime",
19948     "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>",
19949     "version": "0.0.0",
19950     "filename": "server/api/rpc/index.js",
19951     "groupTitle": "RPC_Realtime"
19952   },
19953   {
19954     "type": "get",
19955     "url": "/api/rpc/voice/channels",
19956     "title": "Gets a list of RTVoiceChannels",
19957     "examples": [
19958       {
19959         "title": "Example usage:",
19960         "content": "curl https://{domain}/api/rpc/voice/channels -v -u {name}:{password}",
19961         "type": "json"
19962       }
19963     ],
19964     "name": "RTVoiceChannels",
19965     "group": "RPC_Realtime",
19966     "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>",
19967     "version": "0.0.0",
19968     "filename": "server/api/rpc/index.js",
19969     "groupTitle": "RPC_Realtime"
19970   },
19971   {
19972     "type": "get",
19973     "url": "/api/rpc/voice/queues/channels/{uniqueid}",
19974     "title": "Gets a single RTVoiceQueueChannel",
19975     "examples": [
19976       {
19977         "title": "Example usage:",
19978         "content": "curl https://{domain}/api/rpc/voice/queues/channels/{uniqueid} -v -u {name}:{password}",
19979         "type": "json"
19980       }
19981     ],
19982     "name": "RTVoiceQueueChannel",
19983     "group": "RPC_Realtime",
19984     "description": "<p>Motion will return a specific realtime voice queue channel.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19985     "version": "0.0.0",
19986     "filename": "server/api/rpc/index.js",
19987     "groupTitle": "RPC_Realtime"
19988   },
19989   {
19990     "type": "get",
19991     "url": "/api/rpc/voice/queues/channels/{uniqueid}/hangup",
19992     "title": "Hangup a single RTVoiceQueueChannel",
19993     "examples": [
19994       {
19995         "title": "Example usage:",
19996         "content": "curl https://{domain}/api/rpc/voice/queues/channels/{uniqueid}/hangup -v -u {name}:{password}",
19997         "type": "json"
19998       }
19999     ],
20000     "name": "RTVoiceQueueChannelHangup",
20001     "group": "RPC_Realtime",
20002     "description": "<p>Motion will hangup a specific realtime voice queue channel.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20003     "version": "0.0.0",
20004     "filename": "server/api/rpc/index.js",
20005     "groupTitle": "RPC_Realtime"
20006   },
20007   {
20008     "type": "get",
20009     "url": "/api/rpc/voice/queues/channels/{uniqueid}/redirect/{exten}",
20010     "title": "Hangup a single RTVoiceQueueChannel",
20011     "examples": [
20012       {
20013         "title": "Example usage:",
20014         "content": "curl https://{domain}/api/rpc/voice/queues/channels/{uniqueid}/redirect/{exten} -v -u {name}:{password}",
20015         "type": "json"
20016       }
20017     ],
20018     "name": "RTVoiceQueueChannelRedirect",
20019     "group": "RPC_Realtime",
20020     "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>",
20021     "version": "0.0.0",
20022     "filename": "server/api/rpc/index.js",
20023     "groupTitle": "RPC_Realtime"
20024   },
20025   {
20026     "type": "get",
20027     "url": "/api/rpc/voice/queues/preview/{id}",
20028     "title": "Gets a single preview contact",
20029     "examples": [
20030       {
20031         "title": "Example usage:",
20032         "content": "curl https://{domain}/api/rpc/voice/queues/preview/{id} -v -u {name}:{password}",
20033         "type": "json"
20034       }
20035     ],
20036     "name": "RTVoiceQueuePreview",
20037     "group": "RPC_Realtime",
20038     "description": "<p>Motion will return a specific preview contact.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20039     "version": "0.0.0",
20040     "filename": "server/api/rpc/index.js",
20041     "groupTitle": "RPC_Realtime"
20042   },
20043   {
20044     "type": "get",
20045     "url": "/api/rpc/outbound",
20046     "title": "Gets a list of RTOutbound",
20047     "examples": [
20048       {
20049         "title": "Example usage:",
20050         "content": "curl https://{domain}/api/rpc/outbound -v -u {name}:{password}",
20051         "type": "json"
20052       }
20053     ],
20054     "name": "RTVoiceQueues",
20055     "group": "RPC_Realtime",
20056     "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>",
20057     "version": "0.0.0",
20058     "filename": "server/api/rpc/index.js",
20059     "groupTitle": "RPC_Realtime"
20060   },
20061   {
20062     "type": "get",
20063     "url": "/api/rpc/voice/queues",
20064     "title": "Gets a list of RTVoiceQueues",
20065     "examples": [
20066       {
20067         "title": "Example usage:",
20068         "content": "curl https://{domain}/api/rpc/voice/queues -v -u {name}:{password}",
20069         "type": "json"
20070       }
20071     ],
20072     "name": "RTVoiceQueues",
20073     "group": "RPC_Realtime",
20074     "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>",
20075     "version": "0.0.0",
20076     "filename": "server/api/rpc/index.js",
20077     "groupTitle": "RPC_Realtime"
20078   },
20079   {
20080     "type": "get",
20081     "url": "/api/rpc/voice/queues/channels",
20082     "title": "Gets a list of RTVoiceQueuesChannels",
20083     "examples": [
20084       {
20085         "title": "Example usage:",
20086         "content": "curl https://{domain}/api/rpc/voice/queues/channels -v -u {name}:{password}",
20087         "type": "json"
20088       }
20089     ],
20090     "name": "RTVoiceQueuesChannels",
20091     "group": "RPC_Realtime",
20092     "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>",
20093     "version": "0.0.0",
20094     "filename": "server/api/rpc/index.js",
20095     "groupTitle": "RPC_Realtime"
20096   },
20097   {
20098     "type": "get",
20099     "url": "/api/rpc/chat/queues/{id}",
20100     "title": "Gets a single RTChatQueue",
20101     "examples": [
20102       {
20103         "title": "Example usage:",
20104         "content": "curl https://{domain}/api/rpc/chat/queues/{id} -v -u {name}:{password}",
20105         "type": "json"
20106       }
20107     ],
20108     "name": "ShowRTChatQueues",
20109     "group": "RPC_Realtime",
20110     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20111     "version": "0.0.0",
20112     "filename": "server/api/rpc/index.js",
20113     "groupTitle": "RPC_Realtime"
20114   },
20115   {
20116     "type": "get",
20117     "url": "/api/rpc/fax/queues/{id}",
20118     "title": "Gets a single RTFaxQueue",
20119     "examples": [
20120       {
20121         "title": "Example usage:",
20122         "content": "curl https://{domain}/api/rpc/fax/queues/{id} -v -u {name}:{password}",
20123         "type": "json"
20124       }
20125     ],
20126     "name": "ShowRTFaxQueues",
20127     "group": "RPC_Realtime",
20128     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20129     "version": "0.0.0",
20130     "filename": "server/api/rpc/index.js",
20131     "groupTitle": "RPC_Realtime"
20132   },
20133   {
20134     "type": "get",
20135     "url": "/api/rpc/mail/queues/{id}",
20136     "title": "Gets a single RTMailQueue",
20137     "examples": [
20138       {
20139         "title": "Example usage:",
20140         "content": "curl https://{domain}/api/rpc/mail/queues/{id} -v -u {name}:{password}",
20141         "type": "json"
20142       }
20143     ],
20144     "name": "ShowRTMailQueues",
20145     "group": "RPC_Realtime",
20146     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20147     "version": "0.0.0",
20148     "filename": "server/api/rpc/index.js",
20149     "groupTitle": "RPC_Realtime"
20150   },
20151   {
20152     "type": "get",
20153     "url": "/api/rpc/openchannel/queues/{id}",
20154     "title": "Gets a single RTOpenchannelQueue",
20155     "examples": [
20156       {
20157         "title": "Example usage:",
20158         "content": "curl https://{domain}/api/rpc/openchannel/queues/{id} -v -u {name}:{password}",
20159         "type": "json"
20160       }
20161     ],
20162     "name": "ShowRTOpenchannelQueues",
20163     "group": "RPC_Realtime",
20164     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20165     "version": "0.0.0",
20166     "filename": "server/api/rpc/index.js",
20167     "groupTitle": "RPC_Realtime"
20168   },
20169   {
20170     "type": "get",
20171     "url": "/api/rpc/sms/queues/{id}",
20172     "title": "Gets a single RTSmsQueue",
20173     "examples": [
20174       {
20175         "title": "Example usage:",
20176         "content": "curl https://{domain}/api/rpc/sms/queues/{id} -v -u {name}:{password}",
20177         "type": "json"
20178       }
20179     ],
20180     "name": "ShowRTSmsQueues",
20181     "group": "RPC_Realtime",
20182     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20183     "version": "0.0.0",
20184     "filename": "server/api/rpc/index.js",
20185     "groupTitle": "RPC_Realtime"
20186   },
20187   {
20188     "type": "get",
20189     "url": "/api/rpc/voice/queues/{id}",
20190     "title": "Gets a single RTVoiceQueue",
20191     "examples": [
20192       {
20193         "title": "Example usage:",
20194         "content": "curl https://{domain}/api/rpc/voice/queues/{id} -v -u {name}:{password}",
20195         "type": "json"
20196       }
20197     ],
20198     "name": "ShowRTVoiceQueues",
20199     "group": "RPC_Realtime",
20200     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20201     "version": "0.0.0",
20202     "filename": "server/api/rpc/index.js",
20203     "groupTitle": "RPC_Realtime"
20204   },
20205   {
20206     "type": "put",
20207     "url": "/api/rpc/voice/{id}/queues",
20208     "title": "Updates a single VoiceQueue",
20209     "examples": [
20210       {
20211         "title": "Example usage:",
20212         "content": "curl https://{domain}/api/rpc/voice/queues/{id} -v -u {name}:{password}",
20213         "type": "json"
20214       }
20215     ],
20216     "name": "UpdateVoiceQueues",
20217     "group": "RPC_Realtime",
20218     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20219     "version": "0.0.0",
20220     "filename": "server/api/rpc/index.js",
20221     "groupTitle": "RPC_Realtime"
20222   },
20223   {
20224     "type": "post",
20225     "url": "/api/rpc/agents/:id/notify",
20226     "title": "Notify message to a specific agent",
20227     "examples": [
20228       {
20229         "title": "Example usage:",
20230         "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",
20231         "type": "json"
20232       }
20233     ],
20234     "name": "agentNotify",
20235     "group": "RPC_Realtime",
20236     "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>",
20237     "version": "0.0.0",
20238     "filename": "server/api/rpc/index.js",
20239     "groupTitle": "RPC_Realtime"
20240   },
20241   {
20242     "type": "post",
20243     "url": "/api/rpc/chat/queues/:id/notify",
20244     "title": "Notify message to a specific queue",
20245     "examples": [
20246       {
20247         "title": "Example usage:",
20248         "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",
20249         "type": "json"
20250       }
20251     ],
20252     "name": "chatQueueNotify",
20253     "group": "RPC_Realtime",
20254     "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>",
20255     "version": "0.0.0",
20256     "filename": "server/api/rpc/index.js",
20257     "groupTitle": "RPC_Realtime"
20258   },
20259   {
20260     "type": "get",
20261     "url": "/api/rpc/chat/queues/waitinginteractions",
20262     "title": "Gets a list of chatQueuesWaitingInteractions",
20263     "examples": [
20264       {
20265         "title": "Example usage:",
20266         "content": "curl https://{domain}/api/rpc/chat/queues/waitinginteractions -v -u {name}:{password}",
20267         "type": "json"
20268       }
20269     ],
20270     "name": "chatQueuesWaitingInteractions",
20271     "group": "RPC_Realtime",
20272     "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>",
20273     "version": "0.0.0",
20274     "filename": "server/api/rpc/index.js",
20275     "groupTitle": "RPC_Realtime"
20276   },
20277   {
20278     "type": "post",
20279     "url": "/api/rpc/fax/queues/:id/notify",
20280     "title": "Notify message to a specific queue",
20281     "examples": [
20282       {
20283         "title": "Example usage:",
20284         "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",
20285         "type": "json"
20286       }
20287     ],
20288     "name": "faxQueueNotify",
20289     "group": "RPC_Realtime",
20290     "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>",
20291     "version": "0.0.0",
20292     "filename": "server/api/rpc/index.js",
20293     "groupTitle": "RPC_Realtime"
20294   },
20295   {
20296     "type": "get",
20297     "url": "/api/rpc/fax/queues/waitinginteractions",
20298     "title": "Gets a list of faxQueuesWaitingInteractions",
20299     "examples": [
20300       {
20301         "title": "Example usage:",
20302         "content": "curl https://{domain}/api/rpc/fax/queues/waitinginteractions -v -u {name}:{password}",
20303         "type": "json"
20304       }
20305     ],
20306     "name": "faxQueuesWaitingInteractions",
20307     "group": "RPC_Realtime",
20308     "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>",
20309     "version": "0.0.0",
20310     "filename": "server/api/rpc/index.js",
20311     "groupTitle": "RPC_Realtime"
20312   },
20313   {
20314     "type": "post",
20315     "url": "/api/rpc/mail/queues/:id/notify",
20316     "title": "Notify message to a specific queue",
20317     "examples": [
20318       {
20319         "title": "Example usage:",
20320         "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",
20321         "type": "json"
20322       }
20323     ],
20324     "name": "mailQueueNotify",
20325     "group": "RPC_Realtime",
20326     "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>",
20327     "version": "0.0.0",
20328     "filename": "server/api/rpc/index.js",
20329     "groupTitle": "RPC_Realtime"
20330   },
20331   {
20332     "type": "get",
20333     "url": "/api/rpc/mail/queues/waitinginteractions",
20334     "title": "Gets a list of mailQueuesWaitingInteractions",
20335     "examples": [
20336       {
20337         "title": "Example usage:",
20338         "content": "curl https://{domain}/api/rpc/mail/queues/waitinginteractions -v -u {name}:{password}",
20339         "type": "json"
20340       }
20341     ],
20342     "name": "mailQueuesWaitingInteractions",
20343     "group": "RPC_Realtime",
20344     "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>",
20345     "version": "0.0.0",
20346     "filename": "server/api/rpc/index.js",
20347     "groupTitle": "RPC_Realtime"
20348   },
20349   {
20350     "type": "post",
20351     "url": "/api/rpc/openchannel/queues/:id/notify",
20352     "title": "Notify message to a specific queue",
20353     "examples": [
20354       {
20355         "title": "Example usage:",
20356         "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",
20357         "type": "json"
20358       }
20359     ],
20360     "name": "openchannelQueueNotify",
20361     "group": "RPC_Realtime",
20362     "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>",
20363     "version": "0.0.0",
20364     "filename": "server/api/rpc/index.js",
20365     "groupTitle": "RPC_Realtime"
20366   },
20367   {
20368     "type": "get",
20369     "url": "/api/rpc/openchannel/queues/:id/waitinginteractions",
20370     "title": "Gets a list of openchannelQueuesIdWaitingInteractions",
20371     "examples": [
20372       {
20373         "title": "Example usage:",
20374         "content": "curl https://{domain}/api/rpc/openchannel/queues/:id/waitinginteractions -v -u {name}:{password}",
20375         "type": "json"
20376       }
20377     ],
20378     "name": "openchannelQueuesIdWaitingInteractions",
20379     "group": "RPC_Realtime",
20380     "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>",
20381     "version": "0.0.0",
20382     "filename": "server/api/rpc/index.js",
20383     "groupTitle": "RPC_Realtime"
20384   },
20385   {
20386     "type": "get",
20387     "url": "/api/rpc/openchannel/queues/waitinginteractions",
20388     "title": "Gets a list of openchannelQueuesWaitingInteractions",
20389     "examples": [
20390       {
20391         "title": "Example usage:",
20392         "content": "curl https://{domain}/api/rpc/openchannel/queues/waitinginteractions -v -u {name}:{password}",
20393         "type": "json"
20394       }
20395     ],
20396     "name": "openchannelQueuesWaitingInteractions",
20397     "group": "RPC_Realtime",
20398     "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>",
20399     "version": "0.0.0",
20400     "filename": "server/api/rpc/index.js",
20401     "groupTitle": "RPC_Realtime"
20402   },
20403   {
20404     "type": "post",
20405     "url": "/api/rpc/sms/queues/:id/notify",
20406     "title": "Notify message to a specific queue",
20407     "examples": [
20408       {
20409         "title": "Example usage:",
20410         "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",
20411         "type": "json"
20412       }
20413     ],
20414     "name": "smsQueueNotify",
20415     "group": "RPC_Realtime",
20416     "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>",
20417     "version": "0.0.0",
20418     "filename": "server/api/rpc/index.js",
20419     "groupTitle": "RPC_Realtime"
20420   },
20421   {
20422     "type": "get",
20423     "url": "/api/rpc/sms/queues/waitinginteractions",
20424     "title": "Gets a list of smsQueuesWaitingInteractions",
20425     "examples": [
20426       {
20427         "title": "Example usage:",
20428         "content": "curl https://{domain}/api/rpc/sms/queues/waitinginteractions -v -u {name}:{password}",
20429         "type": "json"
20430       }
20431     ],
20432     "name": "smsQueuesWaitingInteractions",
20433     "group": "RPC_Realtime",
20434     "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>",
20435     "version": "0.0.0",
20436     "filename": "server/api/rpc/index.js",
20437     "groupTitle": "RPC_Realtime"
20438   },
20439   {
20440     "type": "get",
20441     "url": "/api/realtime/agents",
20442     "title": "Gets realtime agents info",
20443     "examples": [
20444       {
20445         "title": "Example usage:",
20446         "content": "curl https://{domain}/api/realtime/agents -v -u {name}:{password}  -X GET",
20447         "type": "json"
20448       }
20449     ],
20450     "name": "getAgents",
20451     "group": "Realtime",
20452     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20453     "version": "0.0.0",
20454     "filename": "server/api/realtime/index.js",
20455     "groupTitle": "Realtime"
20456   },
20457   {
20458     "type": "get",
20459     "url": "/api/realtime/queues",
20460     "title": "Gets realtime queues info",
20461     "examples": [
20462       {
20463         "title": "Example usage:",
20464         "content": "curl https://{domain}/api/realtime/queues -v -u {name}:{password}  -X GET",
20465         "type": "json"
20466       }
20467     ],
20468     "name": "getQueues",
20469     "group": "Realtime",
20470     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20471     "version": "0.0.0",
20472     "filename": "server/api/realtime/index.js",
20473     "groupTitle": "Realtime"
20474   },
20475   {
20476     "type": "post",
20477     "url": "/api/integrations/salesforce/accounts",
20478     "title": "Creates a new Salesforce Account",
20479     "examples": [
20480       {
20481         "title": "Example usage:",
20482         "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",
20483         "type": "json"
20484       }
20485     ],
20486     "name": "CreateSalesforce_Accounts",
20487     "group": "Salesforce_Accounts",
20488     "parameter": {
20489       "fields": {
20490         "Body": [
20491           {
20492             "group": "Body",
20493             "type": "String",
20494             "optional": true,
20495             "field": "name",
20496             "description": ""
20497           },
20498           {
20499             "group": "Body",
20500             "type": "String",
20501             "optional": true,
20502             "field": "description",
20503             "description": ""
20504           },
20505           {
20506             "group": "Body",
20507             "type": "String",
20508             "optional": true,
20509             "field": "username",
20510             "description": ""
20511           },
20512           {
20513             "group": "Body",
20514             "type": "String",
20515             "optional": true,
20516             "field": "remoteUri",
20517             "description": ""
20518           },
20519           {
20520             "group": "Body",
20521             "type": "String",
20522             "optional": true,
20523             "field": "password",
20524             "description": ""
20525           },
20526           {
20527             "group": "Body",
20528             "type": "String",
20529             "optional": true,
20530             "field": "clientId",
20531             "description": ""
20532           },
20533           {
20534             "group": "Body",
20535             "type": "String",
20536             "optional": true,
20537             "field": "clientSecret",
20538             "description": ""
20539           },
20540           {
20541             "group": "Body",
20542             "type": "String",
20543             "optional": true,
20544             "field": "securityToken",
20545             "description": ""
20546           },
20547           {
20548             "group": "Body",
20549             "type": "String",
20550             "optional": false,
20551             "field": "serverUrl",
20552             "description": ""
20553           },
20554           {
20555             "group": "Body",
20556             "type": "String",
20557             "allowedValues": [
20558               "\"integrationTab\"",
20559               "\"newTab\""
20560             ],
20561             "optional": true,
20562             "field": "type",
20563             "description": ""
20564           }
20565         ]
20566       }
20567     },
20568     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20569     "version": "0.0.0",
20570     "filename": "server/api/intSalesforceAccount/index.js",
20571     "groupTitle": "Salesforce_Accounts"
20572   },
20573   {
20574     "type": "delete",
20575     "url": "/api/integrations/salesforce/accounts/{id}",
20576     "title": "Deletes a Salesforce Account",
20577     "examples": [
20578       {
20579         "title": "Example usage:",
20580         "content": "curl https://{domain}/api/integrations/salesforce/accounts/{id} -v -u {name}:{password} -X DELETE",
20581         "type": "json"
20582       }
20583     ],
20584     "name": "DeleteSalesforce_Accounts",
20585     "group": "Salesforce_Accounts",
20586     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20587     "version": "0.0.0",
20588     "filename": "server/api/intSalesforceAccount/index.js",
20589     "groupTitle": "Salesforce_Accounts"
20590   },
20591   {
20592     "type": "get",
20593     "url": "/api/integrations/salesforce/accounts",
20594     "title": "Gets a list of Salesforce Accounts",
20595     "examples": [
20596       {
20597         "title": "Example usage:",
20598         "content": "curl https://{domain}/api/integrations/salesforce/accounts -v -u {name}:{password}",
20599         "type": "json"
20600       }
20601     ],
20602     "name": "GetSalesforce_Accounts",
20603     "group": "Salesforce_Accounts",
20604     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
20605     "version": "0.0.0",
20606     "filename": "server/api/intSalesforceAccount/index.js",
20607     "groupTitle": "Salesforce_Accounts"
20608   },
20609   {
20610     "type": "get",
20611     "url": "/api/integrations/salesforce/accounts/{id}",
20612     "title": "Gets a single Salesforce Account",
20613     "examples": [
20614       {
20615         "title": "Example usage:",
20616         "content": "curl https://{domain}/api/integrations/salesforce/accounts/{id} -v -u {name}:{password}",
20617         "type": "json"
20618       }
20619     ],
20620     "name": "ShowSalesforce_Accounts",
20621     "group": "Salesforce_Accounts",
20622     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20623     "version": "0.0.0",
20624     "filename": "server/api/intSalesforceAccount/index.js",
20625     "groupTitle": "Salesforce_Accounts"
20626   },
20627   {
20628     "type": "post",
20629     "url": "/api/integrations/salesforce/accounts/{id}/configurations",
20630     "title": "Creates new configuration",
20631     "examples": [
20632       {
20633         "title": "Example usage:",
20634         "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",
20635         "type": "json"
20636       }
20637     ],
20638     "name": "addConfiguration",
20639     "group": "Salesforce_Accounts",
20640     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20641     "version": "0.0.0",
20642     "filename": "server/api/intSalesforceAccount/index.js",
20643     "groupTitle": "Salesforce_Accounts"
20644   },
20645   {
20646     "type": "get",
20647     "url": "/api/integrations/salesforce/accounts/{id}/configurations",
20648     "title": "Gets account configurations",
20649     "examples": [
20650       {
20651         "title": "Example usage:",
20652         "content": "curl https://{domain}/api/integrations/salesforce/accounts/{id}/configurations -v -u {name}:{password} -X GET",
20653         "type": "json"
20654       }
20655     ],
20656     "name": "getConfigurations",
20657     "group": "Salesforce_Accounts",
20658     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20659     "version": "0.0.0",
20660     "filename": "server/api/intSalesforceAccount/index.js",
20661     "groupTitle": "Salesforce_Accounts"
20662   },
20663   {
20664     "type": "get",
20665     "url": "/api/integrations/salesforce/accounts/{id}/fields",
20666     "title": "Gets account fields",
20667     "examples": [
20668       {
20669         "title": "Example usage:",
20670         "content": "curl https://{domain}/api/integrations/salesforce/accounts/{id}/fields -v -u {name}:{password} -X GET",
20671         "type": "json"
20672       }
20673     ],
20674     "name": "getFields",
20675     "group": "Salesforce_Accounts",
20676     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20677     "version": "0.0.0",
20678     "filename": "server/api/intSalesforceAccount/index.js",
20679     "groupTitle": "Salesforce_Accounts"
20680   },
20681   {
20682     "type": "put",
20683     "url": "/api/integrations/salesforce/accounts/{id}",
20684     "title": "Update an existing Salesforce Account",
20685     "examples": [
20686       {
20687         "title": "Example usage:",
20688         "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",
20689         "type": "json"
20690       }
20691     ],
20692     "name": "updateSalesforce_Accounts",
20693     "group": "Salesforce_Accounts",
20694     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20695     "version": "0.0.0",
20696     "filename": "server/api/intSalesforceAccount/index.js",
20697     "groupTitle": "Salesforce_Accounts"
20698   },
20699   {
20700     "type": "post",
20701     "url": "/api/integrations/salesforce/configurations",
20702     "title": "Creates a new Salesforce Configuration",
20703     "examples": [
20704       {
20705         "title": "Example usage:",
20706         "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",
20707         "type": "json"
20708       }
20709     ],
20710     "name": "CreateSalesforce_Configurations",
20711     "group": "Salesforce_Configurations",
20712     "parameter": {
20713       "fields": {
20714         "Body": [
20715           {
20716             "group": "Body",
20717             "type": "String",
20718             "optional": true,
20719             "field": "name",
20720             "description": ""
20721           },
20722           {
20723             "group": "Body",
20724             "type": "String",
20725             "optional": true,
20726             "field": "description",
20727             "description": ""
20728           },
20729           {
20730             "group": "Body",
20731             "type": "String",
20732             "allowedValues": [
20733               "\"Task\"",
20734               "\"Case\""
20735             ],
20736             "optional": true,
20737             "field": "ticketType",
20738             "description": ""
20739           },
20740           {
20741             "group": "Body",
20742             "type": "String",
20743             "allowedValues": [
20744               "\"contact_lead\"",
20745               "\"contact\"",
20746               "\"lead\"",
20747               "\"account_contact_lead\"",
20748               "\"account\""
20749             ],
20750             "optional": true,
20751             "field": "moduleSearch",
20752             "description": ""
20753           },
20754           {
20755             "group": "Body",
20756             "type": "String",
20757             "allowedValues": [
20758               "\"nothing\"",
20759               "\"contact\"",
20760               "\"lead\"",
20761               "\"account\""
20762             ],
20763             "optional": true,
20764             "field": "moduleCreate",
20765             "description": ""
20766           },
20767           {
20768             "group": "Body",
20769             "type": "String",
20770             "optional": true,
20771             "field": "leadId",
20772             "description": ""
20773           },
20774           {
20775             "group": "Body",
20776             "type": "String",
20777             "optional": true,
20778             "field": "additionalSearchAccount",
20779             "description": ""
20780           },
20781           {
20782             "group": "Body",
20783             "type": "String",
20784             "optional": true,
20785             "field": "additionalSearchContact",
20786             "description": ""
20787           },
20788           {
20789             "group": "Body",
20790             "type": "String",
20791             "optional": true,
20792             "field": "additionalSearchLead",
20793             "description": ""
20794           }
20795         ]
20796       }
20797     },
20798     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20799     "version": "0.0.0",
20800     "filename": "server/api/intSalesforceConfiguration/index.js",
20801     "groupTitle": "Salesforce_Configurations"
20802   },
20803   {
20804     "type": "delete",
20805     "url": "/api/integrations/salesforce/configurations/{id}",
20806     "title": "Deletes a Salesforce Configuration",
20807     "examples": [
20808       {
20809         "title": "Example usage:",
20810         "content": "curl https://{domain}/api/integrations/salesforce/configurations/{id} -v -u {name}:{password} -X DELETE",
20811         "type": "json"
20812       }
20813     ],
20814     "name": "DeleteSalesforce_Configurations",
20815     "group": "Salesforce_Configurations",
20816     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20817     "version": "0.0.0",
20818     "filename": "server/api/intSalesforceConfiguration/index.js",
20819     "groupTitle": "Salesforce_Configurations"
20820   },
20821   {
20822     "type": "get",
20823     "url": "/api/integrations/salesforce/configurations",
20824     "title": "Gets a list of Salesforce Configurations",
20825     "examples": [
20826       {
20827         "title": "Example usage:",
20828         "content": "curl https://{domain}/api/integrations/salesforce/configurations -v -u {name}:{password}",
20829         "type": "json"
20830       }
20831     ],
20832     "name": "GetSalesforce_Configurations",
20833     "group": "Salesforce_Configurations",
20834     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
20835     "version": "0.0.0",
20836     "filename": "server/api/intSalesforceConfiguration/index.js",
20837     "groupTitle": "Salesforce_Configurations"
20838   },
20839   {
20840     "type": "get",
20841     "url": "/api/integrations/salesforce/configurations/{id}",
20842     "title": "Gets a single Salesforce Configuration",
20843     "examples": [
20844       {
20845         "title": "Example usage:",
20846         "content": "curl https://{domain}/api/integrations/salesforce/configurations/{id} -v -u {name}:{password}",
20847         "type": "json"
20848       }
20849     ],
20850     "name": "ShowSalesforce_Configurations",
20851     "group": "Salesforce_Configurations",
20852     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20853     "version": "0.0.0",
20854     "filename": "server/api/intSalesforceConfiguration/index.js",
20855     "groupTitle": "Salesforce_Configurations"
20856   },
20857   {
20858     "type": "get",
20859     "url": "/api/integrations/salesforce/configurations/{id}/descriptions",
20860     "title": "Gets configurations descriptions",
20861     "examples": [
20862       {
20863         "title": "Example usage:",
20864         "content": "curl https://{domain}/api/integrations/salesforce/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
20865         "type": "json"
20866       }
20867     ],
20868     "name": "getDescriptions",
20869     "group": "Salesforce_Configurations",
20870     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20871     "version": "0.0.0",
20872     "filename": "server/api/intSalesforceConfiguration/index.js",
20873     "groupTitle": "Salesforce_Configurations"
20874   },
20875   {
20876     "type": "get",
20877     "url": "/api/integrations/salesforce/configurations/{id}/fields",
20878     "title": "Gets configurations fields",
20879     "examples": [
20880       {
20881         "title": "Example usage:",
20882         "content": "curl https://{domain}/api/integrations/salesforce/configurations/{id}/fields -v -u {name}:{password} -X GET",
20883         "type": "json"
20884       }
20885     ],
20886     "name": "getFields",
20887     "group": "Salesforce_Configurations",
20888     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20889     "version": "0.0.0",
20890     "filename": "server/api/intSalesforceConfiguration/index.js",
20891     "groupTitle": "Salesforce_Configurations"
20892   },
20893   {
20894     "type": "get",
20895     "url": "/api/integrations/salesforce/configurations/{id}/subjects",
20896     "title": "Gets configurations subjects",
20897     "examples": [
20898       {
20899         "title": "Example usage:",
20900         "content": "curl https://{domain}/api/integrations/salesforce/configurations/{id}/subjects -v -u {name}:{password} -X GET",
20901         "type": "json"
20902       }
20903     ],
20904     "name": "getSubjects",
20905     "group": "Salesforce_Configurations",
20906     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20907     "version": "0.0.0",
20908     "filename": "server/api/intSalesforceConfiguration/index.js",
20909     "groupTitle": "Salesforce_Configurations"
20910   },
20911   {
20912     "type": "put",
20913     "url": "/api/integrations/salesforce/configurations/{id}",
20914     "title": "Update an existing Salesforce Configuration",
20915     "examples": [
20916       {
20917         "title": "Example usage:",
20918         "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",
20919         "type": "json"
20920       }
20921     ],
20922     "name": "updateSalesforce_Configurations",
20923     "group": "Salesforce_Configurations",
20924     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20925     "version": "0.0.0",
20926     "filename": "server/api/intSalesforceConfiguration/index.js",
20927     "groupTitle": "Salesforce_Configurations"
20928   },
20929   {
20930     "type": "post",
20931     "url": "/api/integrations/salesforce/fields",
20932     "title": "Creates a new Salesforce Field",
20933     "examples": [
20934       {
20935         "title": "Example usage:",
20936         "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",
20937         "type": "json"
20938       }
20939     ],
20940     "name": "CreateSalesforce_Fields",
20941     "group": "Salesforce_Fields",
20942     "parameter": {
20943       "fields": {
20944         "Body": [
20945           {
20946             "group": "Body",
20947             "type": "String",
20948             "allowedValues": [
20949               "\"string\"",
20950               "\"variable\"",
20951               "\"customVariable\"",
20952               "\"keyValue\"",
20953               "\"picklist\""
20954             ],
20955             "optional": true,
20956             "field": "type",
20957             "description": ""
20958           },
20959           {
20960             "group": "Body",
20961             "type": "String",
20962             "optional": true,
20963             "field": "content",
20964             "description": ""
20965           },
20966           {
20967             "group": "Body",
20968             "type": "String",
20969             "optional": true,
20970             "field": "key",
20971             "description": ""
20972           },
20973           {
20974             "group": "Body",
20975             "type": "String",
20976             "allowedValues": [
20977               "\"string\"",
20978               "\"variable\"",
20979               "\"customVariable\""
20980             ],
20981             "optional": true,
20982             "field": "keyType",
20983             "description": ""
20984           },
20985           {
20986             "group": "Body",
20987             "type": "String",
20988             "optional": true,
20989             "field": "keyContent",
20990             "description": ""
20991           },
20992           {
20993             "group": "Body",
20994             "type": "String",
20995             "optional": true,
20996             "field": "idField",
20997             "description": ""
20998           },
20999           {
21000             "group": "Body",
21001             "type": "String",
21002             "optional": true,
21003             "field": "variableName",
21004             "description": ""
21005           }
21006         ]
21007       }
21008     },
21009     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21010     "version": "0.0.0",
21011     "filename": "server/api/intSalesforceField/index.js",
21012     "groupTitle": "Salesforce_Fields"
21013   },
21014   {
21015     "type": "delete",
21016     "url": "/api/integrations/salesforce/fields/{id}",
21017     "title": "Deletes a Salesforce Field",
21018     "examples": [
21019       {
21020         "title": "Example usage:",
21021         "content": "curl https://{domain}/api/integrations/salesforce/fields/{id} -v -u {name}:{password} -X DELETE",
21022         "type": "json"
21023       }
21024     ],
21025     "name": "DeleteSalesforce_Fields",
21026     "group": "Salesforce_Fields",
21027     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21028     "version": "0.0.0",
21029     "filename": "server/api/intSalesforceField/index.js",
21030     "groupTitle": "Salesforce_Fields"
21031   },
21032   {
21033     "type": "get",
21034     "url": "/api/integrations/salesforce/fields",
21035     "title": "Gets a list of Salesforce Fields",
21036     "examples": [
21037       {
21038         "title": "Example usage:",
21039         "content": "curl https://{domain}/api/integrations/salesforce/fields -v -u {name}:{password}",
21040         "type": "json"
21041       }
21042     ],
21043     "name": "GetSalesforce_Fields",
21044     "group": "Salesforce_Fields",
21045     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
21046     "version": "0.0.0",
21047     "filename": "server/api/intSalesforceField/index.js",
21048     "groupTitle": "Salesforce_Fields"
21049   },
21050   {
21051     "type": "get",
21052     "url": "/api/integrations/salesforce/fields/{id}",
21053     "title": "Gets a single Salesforce Field",
21054     "examples": [
21055       {
21056         "title": "Example usage:",
21057         "content": "curl https://{domain}/api/integrations/salesforce/fields/{id} -v -u {name}:{password}",
21058         "type": "json"
21059       }
21060     ],
21061     "name": "ShowSalesforce_Fields",
21062     "group": "Salesforce_Fields",
21063     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21064     "version": "0.0.0",
21065     "filename": "server/api/intSalesforceField/index.js",
21066     "groupTitle": "Salesforce_Fields"
21067   },
21068   {
21069     "type": "put",
21070     "url": "/api/integrations/salesforce/fields/{id}",
21071     "title": "Update an existing Salesforce Field",
21072     "examples": [
21073       {
21074         "title": "Example usage:",
21075         "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",
21076         "type": "json"
21077       }
21078     ],
21079     "name": "updateSalesforce_Fields",
21080     "group": "Salesforce_Fields",
21081     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21082     "version": "0.0.0",
21083     "filename": "server/api/intSalesforceField/index.js",
21084     "groupTitle": "Salesforce_Fields"
21085   },
21086   {
21087     "type": "post",
21088     "url": "/api/schedules",
21089     "title": "Creates a new Schedule",
21090     "examples": [
21091       {
21092         "title": "Example usage:",
21093         "content": "curl https://{domain}/api/schedules -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
21094         "type": "json"
21095       }
21096     ],
21097     "name": "CreateSchedules",
21098     "group": "Schedules",
21099     "parameter": {
21100       "fields": {
21101         "Body": [
21102           {
21103             "group": "Body",
21104             "type": "String",
21105             "optional": false,
21106             "field": "name",
21107             "description": ""
21108           },
21109           {
21110             "group": "Body",
21111             "type": "String",
21112             "optional": true,
21113             "field": "description",
21114             "description": ""
21115           },
21116           {
21117             "group": "Body",
21118             "type": "Boolean",
21119             "optional": false,
21120             "field": "active",
21121             "description": ""
21122           },
21123           {
21124             "group": "Body",
21125             "type": "String",
21126             "optional": false,
21127             "field": "cron",
21128             "description": ""
21129           },
21130           {
21131             "group": "Body",
21132             "type": "String",
21133             "optional": false,
21134             "field": "startAt",
21135             "description": ""
21136           },
21137           {
21138             "group": "Body",
21139             "type": "String",
21140             "optional": false,
21141             "field": "endAt",
21142             "description": ""
21143           },
21144           {
21145             "group": "Body",
21146             "type": "Integer",
21147             "optional": false,
21148             "field": "subtractNumber",
21149             "description": ""
21150           },
21151           {
21152             "group": "Body",
21153             "type": "String",
21154             "allowedValues": [
21155               "\"years\"",
21156               "\"quarters\"",
21157               "\"months\"",
21158               "\"weeks\"",
21159               "\"days\"",
21160               "\"hours\"",
21161               "\"minutes\""
21162             ],
21163             "optional": false,
21164             "field": "subtractUnit",
21165             "description": ""
21166           },
21167           {
21168             "group": "Body",
21169             "type": "String",
21170             "allowedValues": [
21171               "\"csv\"",
21172               "\"pdf\"",
21173               "\"xlsx\""
21174             ],
21175             "optional": false,
21176             "field": "output",
21177             "description": ""
21178           },
21179           {
21180             "group": "Body",
21181             "type": "String",
21182             "allowedValues": [
21183               "\"custom\"",
21184               "\"default\""
21185             ],
21186             "optional": false,
21187             "field": "type",
21188             "description": ""
21189           },
21190           {
21191             "group": "Body",
21192             "type": "Boolean",
21193             "optional": true,
21194             "field": "sendMail",
21195             "description": ""
21196           },
21197           {
21198             "group": "Body",
21199             "type": "String",
21200             "optional": true,
21201             "field": "email",
21202             "description": ""
21203           },
21204           {
21205             "group": "Body",
21206             "type": "Text",
21207             "optional": true,
21208             "field": "cc",
21209             "description": ""
21210           },
21211           {
21212             "group": "Body",
21213             "type": "Text",
21214             "optional": true,
21215             "field": "bcc",
21216             "description": ""
21217           },
21218           {
21219             "group": "Body",
21220             "type": "Boolean",
21221             "optional": true,
21222             "field": "sendIfEmpty",
21223             "description": ""
21224           }
21225         ]
21226       }
21227     },
21228     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21229     "version": "0.0.0",
21230     "filename": "server/api/schedule/index.js",
21231     "groupTitle": "Schedules"
21232   },
21233   {
21234     "type": "delete",
21235     "url": "/api/schedules/{id}",
21236     "title": "Deletes a Schedule",
21237     "examples": [
21238       {
21239         "title": "Example usage:",
21240         "content": "curl https://{domain}/api/schedules/{id} -v -u {name}:{password} -X DELETE",
21241         "type": "json"
21242       }
21243     ],
21244     "name": "DeleteSchedules",
21245     "group": "Schedules",
21246     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21247     "version": "0.0.0",
21248     "filename": "server/api/schedule/index.js",
21249     "groupTitle": "Schedules"
21250   },
21251   {
21252     "type": "get",
21253     "url": "/api/schedules",
21254     "title": "Gets a list of Schedules",
21255     "examples": [
21256       {
21257         "title": "Example usage:",
21258         "content": "curl https://{domain}/api/schedules -v -u {name}:{password}",
21259         "type": "json"
21260       }
21261     ],
21262     "name": "GetSchedules",
21263     "group": "Schedules",
21264     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
21265     "version": "0.0.0",
21266     "filename": "server/api/schedule/index.js",
21267     "groupTitle": "Schedules"
21268   },
21269   {
21270     "type": "get",
21271     "url": "/api/schedules/{id}",
21272     "title": "Gets a single Schedule",
21273     "examples": [
21274       {
21275         "title": "Example usage:",
21276         "content": "curl https://{domain}/api/schedules/{id} -v -u {name}:{password}",
21277         "type": "json"
21278       }
21279     ],
21280     "name": "ShowSchedules",
21281     "group": "Schedules",
21282     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21283     "version": "0.0.0",
21284     "filename": "server/api/schedule/index.js",
21285     "groupTitle": "Schedules"
21286   },
21287   {
21288     "type": "get",
21289     "url": "/api/schedules/{id}/run",
21290     "title": "Run Scheduler",
21291     "examples": [
21292       {
21293         "title": "Example usage:",
21294         "content": "curl https://{domain}/api/schedules/{id}/run -v -u {name}:{password} -X GET",
21295         "type": "json"
21296       }
21297     ],
21298     "name": "run",
21299     "group": "Schedules",
21300     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21301     "version": "0.0.0",
21302     "filename": "server/api/schedule/index.js",
21303     "groupTitle": "Schedules"
21304   },
21305   {
21306     "type": "put",
21307     "url": "/api/schedules/{id}",
21308     "title": "Update an existing Schedule",
21309     "examples": [
21310       {
21311         "title": "Example usage:",
21312         "content": "curl https://{domain}/api/schedules/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
21313         "type": "json"
21314       }
21315     ],
21316     "name": "updateSchedules",
21317     "group": "Schedules",
21318     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21319     "version": "0.0.0",
21320     "filename": "server/api/schedule/index.js",
21321     "groupTitle": "Schedules"
21322   },
21323   {
21324     "type": "post",
21325     "url": "/api/screen/recordings",
21326     "title": "Creates a new Recording",
21327     "examples": [
21328       {
21329         "title": "Example usage:",
21330         "content": "curl https://{domain}/api/screen/recordings -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
21331         "type": "json"
21332       }
21333     ],
21334     "name": "CreateRecordings",
21335     "group": "Screen_Recordings",
21336     "parameter": {
21337       "fields": {
21338         "Body": [
21339           {
21340             "group": "Body",
21341             "type": "Virtual",
21342             "optional": true,
21343             "field": "format",
21344             "description": ""
21345           },
21346           {
21347             "group": "Body",
21348             "type": "String",
21349             "optional": true,
21350             "field": "interactionid",
21351             "description": ""
21352           },
21353           {
21354             "group": "Body",
21355             "type": "String",
21356             "optional": true,
21357             "field": "channel",
21358             "description": ""
21359           },
21360           {
21361             "group": "Body",
21362             "type": "String",
21363             "optional": true,
21364             "field": "value",
21365             "description": ""
21366           },
21367           {
21368             "group": "Body",
21369             "type": "Integer",
21370             "optional": true,
21371             "field": "rating",
21372             "description": ""
21373           },
21374           {
21375             "group": "Body",
21376             "type": "Integer",
21377             "optional": true,
21378             "field": "duration",
21379             "description": ""
21380           },
21381           {
21382             "group": "Body",
21383             "type": "String",
21384             "optional": true,
21385             "field": "startedAt",
21386             "description": ""
21387           },
21388           {
21389             "group": "Body",
21390             "type": "String",
21391             "optional": true,
21392             "field": "closedAt",
21393             "description": ""
21394           },
21395           {
21396             "group": "Body",
21397             "type": "String",
21398             "optional": true,
21399             "field": "createdAt",
21400             "description": ""
21401           },
21402           {
21403             "group": "Body",
21404             "type": "String",
21405             "optional": true,
21406             "field": "updatedAt",
21407             "description": ""
21408           }
21409         ]
21410       }
21411     },
21412     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21413     "version": "0.0.0",
21414     "filename": "server/api/screenRecording/index.js",
21415     "groupTitle": "Screen_Recordings"
21416   },
21417   {
21418     "type": "get",
21419     "url": "/api/screen/recordings/describe",
21420     "title": "Gets table info about Recordings",
21421     "examples": [
21422       {
21423         "title": "Example usage:",
21424         "content": "curl https://{domain}/api/screen/recordings/describe -v -u {name}:{password}",
21425         "type": "json"
21426       }
21427     ],
21428     "name": "DescribeRecordings",
21429     "group": "Screen_Recordings",
21430     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21431     "version": "0.0.0",
21432     "filename": "server/api/screenRecording/index.js",
21433     "groupTitle": "Screen_Recordings"
21434   },
21435   {
21436     "type": "get",
21437     "url": "/api/screen/recordings",
21438     "title": "Gets a list of Recordings",
21439     "examples": [
21440       {
21441         "title": "Example usage:",
21442         "content": "curl https://{domain}/api/screen/recordings -v -u {name}:{password}",
21443         "type": "json"
21444       }
21445     ],
21446     "name": "GetRecordings",
21447     "group": "Screen_Recordings",
21448     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
21449     "version": "0.0.0",
21450     "filename": "server/api/screenRecording/index.js",
21451     "groupTitle": "Screen_Recordings"
21452   },
21453   {
21454     "type": "get",
21455     "url": "/api/screen/recordings/{id}",
21456     "title": "Gets a single Recording",
21457     "examples": [
21458       {
21459         "title": "Example usage:",
21460         "content": "curl https://{domain}/api/screen/recordings/{id} -v -u {name}:{password}",
21461         "type": "json"
21462       }
21463     ],
21464     "name": "ShowRecordings",
21465     "group": "Screen_Recordings",
21466     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21467     "version": "0.0.0",
21468     "filename": "server/api/screenRecording/index.js",
21469     "groupTitle": "Screen_Recordings"
21470   },
21471   {
21472     "type": "delete",
21473     "url": "/api/screen/recordings/{id}",
21474     "title": "Delete screen recording",
21475     "examples": [
21476       {
21477         "title": "Example usage:",
21478         "content": "curl https://{domain}/api/screen/recordings/{id} -v -u {name}:{password} -X DELETE",
21479         "type": "json"
21480       }
21481     ],
21482     "name": "destroy",
21483     "group": "Screen_Recordings",
21484     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21485     "version": "0.0.0",
21486     "filename": "server/api/screenRecording/index.js",
21487     "groupTitle": "Screen_Recordings"
21488   },
21489   {
21490     "type": "get",
21491     "url": "/api/screen/recordings/{id}/download",
21492     "title": "Download Recording",
21493     "examples": [
21494       {
21495         "title": "Example usage:",
21496         "content": "curl https://{domain}/api/screen/recordings/{id}/download -v -u {name}:{password} -X GET",
21497         "type": "json"
21498       }
21499     ],
21500     "name": "download",
21501     "group": "Screen_Recordings",
21502     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21503     "version": "0.0.0",
21504     "filename": "server/api/screenRecording/index.js",
21505     "groupTitle": "Screen_Recordings"
21506   },
21507   {
21508     "type": "put",
21509     "url": "/api/screen/recordings/{id}",
21510     "title": "Update an existing Recording",
21511     "examples": [
21512       {
21513         "title": "Example usage:",
21514         "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",
21515         "type": "json"
21516       }
21517     ],
21518     "name": "updateRecordings",
21519     "group": "Screen_Recordings",
21520     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21521     "version": "0.0.0",
21522     "filename": "server/api/screenRecording/index.js",
21523     "groupTitle": "Screen_Recordings"
21524   },
21525   {
21526     "type": "post",
21527     "url": "/api/integrations/servicenow/accounts",
21528     "title": "Creates a new Servicenow Account",
21529     "examples": [
21530       {
21531         "title": "Example usage:",
21532         "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",
21533         "type": "json"
21534       }
21535     ],
21536     "name": "CreateServicenow_Accounts",
21537     "group": "Servicenow_Accounts",
21538     "parameter": {
21539       "fields": {
21540         "Body": [
21541           {
21542             "group": "Body",
21543             "type": "String",
21544             "optional": true,
21545             "field": "name",
21546             "description": ""
21547           },
21548           {
21549             "group": "Body",
21550             "type": "String",
21551             "optional": true,
21552             "field": "description",
21553             "description": ""
21554           },
21555           {
21556             "group": "Body",
21557             "type": "String",
21558             "optional": true,
21559             "field": "username",
21560             "description": ""
21561           },
21562           {
21563             "group": "Body",
21564             "type": "String",
21565             "optional": true,
21566             "field": "password",
21567             "description": ""
21568           },
21569           {
21570             "group": "Body",
21571             "type": "String",
21572             "optional": true,
21573             "field": "email",
21574             "description": ""
21575           },
21576           {
21577             "group": "Body",
21578             "type": "String",
21579             "optional": true,
21580             "field": "remoteUri",
21581             "description": ""
21582           },
21583           {
21584             "group": "Body",
21585             "type": "String",
21586             "optional": false,
21587             "field": "serverUrl",
21588             "description": ""
21589           }
21590         ]
21591       }
21592     },
21593     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21594     "version": "0.0.0",
21595     "filename": "server/api/intServicenowAccount/index.js",
21596     "groupTitle": "Servicenow_Accounts"
21597   },
21598   {
21599     "type": "delete",
21600     "url": "/api/integrations/servicenow/accounts/{id}",
21601     "title": "Deletes a Servicenow Account",
21602     "examples": [
21603       {
21604         "title": "Example usage:",
21605         "content": "curl https://{domain}/api/integrations/servicenow/accounts/{id} -v -u {name}:{password} -X DELETE",
21606         "type": "json"
21607       }
21608     ],
21609     "name": "DeleteServicenow_Accounts",
21610     "group": "Servicenow_Accounts",
21611     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21612     "version": "0.0.0",
21613     "filename": "server/api/intServicenowAccount/index.js",
21614     "groupTitle": "Servicenow_Accounts"
21615   },
21616   {
21617     "type": "get",
21618     "url": "/api/integrations/servicenow/accounts",
21619     "title": "Gets a list of Servicenow Accounts",
21620     "examples": [
21621       {
21622         "title": "Example usage:",
21623         "content": "curl https://{domain}/api/integrations/servicenow/accounts -v -u {name}:{password}",
21624         "type": "json"
21625       }
21626     ],
21627     "name": "GetServicenow_Accounts",
21628     "group": "Servicenow_Accounts",
21629     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
21630     "version": "0.0.0",
21631     "filename": "server/api/intServicenowAccount/index.js",
21632     "groupTitle": "Servicenow_Accounts"
21633   },
21634   {
21635     "type": "get",
21636     "url": "/api/integrations/servicenow/accounts/{id}",
21637     "title": "Gets a single Servicenow Account",
21638     "examples": [
21639       {
21640         "title": "Example usage:",
21641         "content": "curl https://{domain}/api/integrations/servicenow/accounts/{id} -v -u {name}:{password}",
21642         "type": "json"
21643       }
21644     ],
21645     "name": "ShowServicenow_Accounts",
21646     "group": "Servicenow_Accounts",
21647     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21648     "version": "0.0.0",
21649     "filename": "server/api/intServicenowAccount/index.js",
21650     "groupTitle": "Servicenow_Accounts"
21651   },
21652   {
21653     "type": "post",
21654     "url": "/api/integrations/servicenow/accounts/{id}/configurations",
21655     "title": "Creates new configuration",
21656     "examples": [
21657       {
21658         "title": "Example usage:",
21659         "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",
21660         "type": "json"
21661       }
21662     ],
21663     "name": "addConfiguration",
21664     "group": "Servicenow_Accounts",
21665     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21666     "version": "0.0.0",
21667     "filename": "server/api/intServicenowAccount/index.js",
21668     "groupTitle": "Servicenow_Accounts"
21669   },
21670   {
21671     "type": "get",
21672     "url": "/api/integrations/servicenow/accounts/{id}/configurations",
21673     "title": "Gets account configurations",
21674     "examples": [
21675       {
21676         "title": "Example usage:",
21677         "content": "curl https://{domain}/api/integrations/servicenow/accounts/{id}/configurations -v -u {name}:{password} -X GET",
21678         "type": "json"
21679       }
21680     ],
21681     "name": "getConfigurations",
21682     "group": "Servicenow_Accounts",
21683     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21684     "version": "0.0.0",
21685     "filename": "server/api/intServicenowAccount/index.js",
21686     "groupTitle": "Servicenow_Accounts"
21687   },
21688   {
21689     "type": "get",
21690     "url": "/api/integrations/servicenow/accounts/{id}/fields",
21691     "title": "Gets account fields",
21692     "examples": [
21693       {
21694         "title": "Example usage:",
21695         "content": "curl https://{domain}/api/integrations/servicenow/accounts/{id}/fields -v -u {name}:{password} -X GET",
21696         "type": "json"
21697       }
21698     ],
21699     "name": "getFields",
21700     "group": "Servicenow_Accounts",
21701     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21702     "version": "0.0.0",
21703     "filename": "server/api/intServicenowAccount/index.js",
21704     "groupTitle": "Servicenow_Accounts"
21705   },
21706   {
21707     "type": "put",
21708     "url": "/api/integrations/servicenow/accounts/{id}",
21709     "title": "Update an existing Servicenow Account",
21710     "examples": [
21711       {
21712         "title": "Example usage:",
21713         "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",
21714         "type": "json"
21715       }
21716     ],
21717     "name": "updateServicenow_Accounts",
21718     "group": "Servicenow_Accounts",
21719     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21720     "version": "0.0.0",
21721     "filename": "server/api/intServicenowAccount/index.js",
21722     "groupTitle": "Servicenow_Accounts"
21723   },
21724   {
21725     "type": "post",
21726     "url": "/api/integrations/servicenow/configurations",
21727     "title": "Creates a new Servicenow Configuration",
21728     "examples": [
21729       {
21730         "title": "Example usage:",
21731         "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",
21732         "type": "json"
21733       }
21734     ],
21735     "name": "CreateServicenow_Configurations",
21736     "group": "Servicenow_Configurations",
21737     "parameter": {
21738       "fields": {
21739         "Body": [
21740           {
21741             "group": "Body",
21742             "type": "String",
21743             "optional": true,
21744             "field": "name",
21745             "description": ""
21746           },
21747           {
21748             "group": "Body",
21749             "type": "String",
21750             "optional": true,
21751             "field": "description",
21752             "description": ""
21753           }
21754         ]
21755       }
21756     },
21757     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21758     "version": "0.0.0",
21759     "filename": "server/api/intServicenowConfiguration/index.js",
21760     "groupTitle": "Servicenow_Configurations"
21761   },
21762   {
21763     "type": "delete",
21764     "url": "/api/integrations/servicenow/configurations/{id}",
21765     "title": "Deletes a Servicenow Configuration",
21766     "examples": [
21767       {
21768         "title": "Example usage:",
21769         "content": "curl https://{domain}/api/integrations/servicenow/configurations/{id} -v -u {name}:{password} -X DELETE",
21770         "type": "json"
21771       }
21772     ],
21773     "name": "DeleteServicenow_Configurations",
21774     "group": "Servicenow_Configurations",
21775     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21776     "version": "0.0.0",
21777     "filename": "server/api/intServicenowConfiguration/index.js",
21778     "groupTitle": "Servicenow_Configurations"
21779   },
21780   {
21781     "type": "get",
21782     "url": "/api/integrations/servicenow/configurations",
21783     "title": "Gets a list of Servicenow Configurations",
21784     "examples": [
21785       {
21786         "title": "Example usage:",
21787         "content": "curl https://{domain}/api/integrations/servicenow/configurations -v -u {name}:{password}",
21788         "type": "json"
21789       }
21790     ],
21791     "name": "GetServicenow_Configurations",
21792     "group": "Servicenow_Configurations",
21793     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
21794     "version": "0.0.0",
21795     "filename": "server/api/intServicenowConfiguration/index.js",
21796     "groupTitle": "Servicenow_Configurations"
21797   },
21798   {
21799     "type": "get",
21800     "url": "/api/integrations/servicenow/configurations/{id}",
21801     "title": "Gets a single Servicenow Configuration",
21802     "examples": [
21803       {
21804         "title": "Example usage:",
21805         "content": "curl https://{domain}/api/integrations/servicenow/configurations/{id} -v -u {name}:{password}",
21806         "type": "json"
21807       }
21808     ],
21809     "name": "ShowServicenow_Configurations",
21810     "group": "Servicenow_Configurations",
21811     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21812     "version": "0.0.0",
21813     "filename": "server/api/intServicenowConfiguration/index.js",
21814     "groupTitle": "Servicenow_Configurations"
21815   },
21816   {
21817     "type": "get",
21818     "url": "/api/integrations/servicenow/configurations/{id}/descriptions",
21819     "title": "Gets configurations descriptions",
21820     "examples": [
21821       {
21822         "title": "Example usage:",
21823         "content": "curl https://{domain}/api/integrations/servicenow/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
21824         "type": "json"
21825       }
21826     ],
21827     "name": "getDescriptions",
21828     "group": "Servicenow_Configurations",
21829     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21830     "version": "0.0.0",
21831     "filename": "server/api/intServicenowConfiguration/index.js",
21832     "groupTitle": "Servicenow_Configurations"
21833   },
21834   {
21835     "type": "get",
21836     "url": "/api/integrations/servicenow/configurations/{id}/fields",
21837     "title": "Gets configurations fields",
21838     "examples": [
21839       {
21840         "title": "Example usage:",
21841         "content": "curl https://{domain}/api/integrations/servicenow/configurations/{id}/fields -v -u {name}:{password} -X GET",
21842         "type": "json"
21843       }
21844     ],
21845     "name": "getFields",
21846     "group": "Servicenow_Configurations",
21847     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <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/intServicenowConfiguration/index.js",
21850     "groupTitle": "Servicenow_Configurations"
21851   },
21852   {
21853     "type": "get",
21854     "url": "/api/integrations/servicenow/configurations/{id}/subjects",
21855     "title": "Gets configurations subjects",
21856     "examples": [
21857       {
21858         "title": "Example usage:",
21859         "content": "curl https://{domain}/api/integrations/servicenow/configurations/{id}/subjects -v -u {name}:{password} -X GET",
21860         "type": "json"
21861       }
21862     ],
21863     "name": "getSubjects",
21864     "group": "Servicenow_Configurations",
21865     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21866     "version": "0.0.0",
21867     "filename": "server/api/intServicenowConfiguration/index.js",
21868     "groupTitle": "Servicenow_Configurations"
21869   },
21870   {
21871     "type": "put",
21872     "url": "/api/integrations/servicenow/configurations/{id}",
21873     "title": "Update an existing Servicenow Configuration",
21874     "examples": [
21875       {
21876         "title": "Example usage:",
21877         "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",
21878         "type": "json"
21879       }
21880     ],
21881     "name": "updateServicenow_Configurations",
21882     "group": "Servicenow_Configurations",
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/intServicenowConfiguration/index.js",
21886     "groupTitle": "Servicenow_Configurations"
21887   },
21888   {
21889     "type": "post",
21890     "url": "/api/integrations/servicenow/fields",
21891     "title": "Creates a new Servicenow Field",
21892     "examples": [
21893       {
21894         "title": "Example usage:",
21895         "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",
21896         "type": "json"
21897       }
21898     ],
21899     "name": "CreateServicenow_Fields",
21900     "group": "Servicenow_Fields",
21901     "parameter": {
21902       "fields": {
21903         "Body": [
21904           {
21905             "group": "Body",
21906             "type": "String",
21907             "allowedValues": [
21908               "\"string\"",
21909               "\"variable\"",
21910               "\"customVariable\"",
21911               "\"keyValue\"",
21912               "\"picklist\""
21913             ],
21914             "optional": true,
21915             "field": "type",
21916             "description": ""
21917           },
21918           {
21919             "group": "Body",
21920             "type": "String",
21921             "optional": true,
21922             "field": "content",
21923             "description": ""
21924           },
21925           {
21926             "group": "Body",
21927             "type": "String",
21928             "optional": true,
21929             "field": "key",
21930             "description": ""
21931           },
21932           {
21933             "group": "Body",
21934             "type": "String",
21935             "allowedValues": [
21936               "\"string\"",
21937               "\"variable\"",
21938               "\"customVariable\""
21939             ],
21940             "optional": true,
21941             "field": "keyType",
21942             "description": ""
21943           },
21944           {
21945             "group": "Body",
21946             "type": "String",
21947             "optional": true,
21948             "field": "keyContent",
21949             "description": ""
21950           },
21951           {
21952             "group": "Body",
21953             "type": "String",
21954             "optional": true,
21955             "field": "idField",
21956             "description": ""
21957           },
21958           {
21959             "group": "Body",
21960             "type": "String",
21961             "optional": true,
21962             "field": "nameField",
21963             "description": ""
21964           },
21965           {
21966             "group": "Body",
21967             "type": "Boolean",
21968             "optional": true,
21969             "field": "customField",
21970             "description": ""
21971           },
21972           {
21973             "group": "Body",
21974             "type": "String",
21975             "optional": true,
21976             "field": "variableName",
21977             "description": ""
21978           }
21979         ]
21980       }
21981     },
21982     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21983     "version": "0.0.0",
21984     "filename": "server/api/intServicenowField/index.js",
21985     "groupTitle": "Servicenow_Fields"
21986   },
21987   {
21988     "type": "delete",
21989     "url": "/api/integrations/servicenow/fields/{id}",
21990     "title": "Deletes a Servicenow Field",
21991     "examples": [
21992       {
21993         "title": "Example usage:",
21994         "content": "curl https://{domain}/api/integrations/servicenow/fields/{id} -v -u {name}:{password} -X DELETE",
21995         "type": "json"
21996       }
21997     ],
21998     "name": "DeleteServicenow_Fields",
21999     "group": "Servicenow_Fields",
22000     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22001     "version": "0.0.0",
22002     "filename": "server/api/intServicenowField/index.js",
22003     "groupTitle": "Servicenow_Fields"
22004   },
22005   {
22006     "type": "get",
22007     "url": "/api/integrations/servicenow/fields",
22008     "title": "Gets a list of Servicenow Fields",
22009     "examples": [
22010       {
22011         "title": "Example usage:",
22012         "content": "curl https://{domain}/api/integrations/servicenow/fields -v -u {name}:{password}",
22013         "type": "json"
22014       }
22015     ],
22016     "name": "GetServicenow_Fields",
22017     "group": "Servicenow_Fields",
22018     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
22019     "version": "0.0.0",
22020     "filename": "server/api/intServicenowField/index.js",
22021     "groupTitle": "Servicenow_Fields"
22022   },
22023   {
22024     "type": "get",
22025     "url": "/api/integrations/servicenow/fields/{id}",
22026     "title": "Gets a single Servicenow Field",
22027     "examples": [
22028       {
22029         "title": "Example usage:",
22030         "content": "curl https://{domain}/api/integrations/servicenow/fields/{id} -v -u {name}:{password}",
22031         "type": "json"
22032       }
22033     ],
22034     "name": "ShowServicenow_Fields",
22035     "group": "Servicenow_Fields",
22036     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22037     "version": "0.0.0",
22038     "filename": "server/api/intServicenowField/index.js",
22039     "groupTitle": "Servicenow_Fields"
22040   },
22041   {
22042     "type": "put",
22043     "url": "/api/integrations/servicenow/fields/{id}",
22044     "title": "Update an existing Servicenow Field",
22045     "examples": [
22046       {
22047         "title": "Example usage:",
22048         "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",
22049         "type": "json"
22050       }
22051     ],
22052     "name": "updateServicenow_Fields",
22053     "group": "Servicenow_Fields",
22054     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22055     "version": "0.0.0",
22056     "filename": "server/api/intServicenowField/index.js",
22057     "groupTitle": "Servicenow_Fields"
22058   },
22059   {
22060     "type": "get",
22061     "url": "/api/settings",
22062     "title": "Gets a list of Settings",
22063     "examples": [
22064       {
22065         "title": "Example usage:",
22066         "content": "curl https://{domain}/api/settings -v -u {name}:{password}",
22067         "type": "json"
22068       }
22069     ],
22070     "name": "GetSettings",
22071     "group": "Settings",
22072     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
22073     "version": "0.0.0",
22074     "filename": "server/api/setting/index.js",
22075     "groupTitle": "Settings"
22076   },
22077   {
22078     "type": "get",
22079     "url": "/api/settings/{id}",
22080     "title": "Gets a single Setting",
22081     "examples": [
22082       {
22083         "title": "Example usage:",
22084         "content": "curl https://{domain}/api/settings/{id} -v -u {name}:{password}",
22085         "type": "json"
22086       }
22087     ],
22088     "name": "ShowSettings",
22089     "group": "Settings",
22090     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22091     "version": "0.0.0",
22092     "filename": "server/api/setting/index.js",
22093     "groupTitle": "Settings"
22094   },
22095   {
22096     "type": "post",
22097     "url": "/api/settings/{id}/favicon",
22098     "title": "Add Favicon",
22099     "examples": [
22100       {
22101         "title": "Example usage:",
22102         "content": "curl https://{domain}/api/settings/{id}/favicon -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
22103         "type": "json"
22104       }
22105     ],
22106     "name": "addFavicon",
22107     "group": "Settings",
22108     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22109     "version": "0.0.0",
22110     "filename": "server/api/setting/index.js",
22111     "groupTitle": "Settings"
22112   },
22113   {
22114     "type": "post",
22115     "url": "/api/settings/{id}/logo",
22116     "title": "Add logo",
22117     "examples": [
22118       {
22119         "title": "Example usage:",
22120         "content": "curl https://{domain}/api/settings/{id}/logo -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
22121         "type": "json"
22122       }
22123     ],
22124     "name": "addLogo",
22125     "group": "Settings",
22126     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22127     "version": "0.0.0",
22128     "filename": "server/api/setting/index.js",
22129     "groupTitle": "Settings"
22130   },
22131   {
22132     "type": "post",
22133     "url": "/api/settings/{id}/logo_login",
22134     "title": "Add logo login",
22135     "examples": [
22136       {
22137         "title": "Example usage:",
22138         "content": "curl https://{domain}/api/settings/{id}/logo_login -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
22139         "type": "json"
22140       }
22141     ],
22142     "name": "addLogoLogin",
22143     "group": "Settings",
22144     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22145     "version": "0.0.0",
22146     "filename": "server/api/setting/index.js",
22147     "groupTitle": "Settings"
22148   },
22149   {
22150     "type": "post",
22151     "url": "/api/settings/{id}/preferred",
22152     "title": "Add Preferred",
22153     "examples": [
22154       {
22155         "title": "Example usage:",
22156         "content": "curl https://{domain}/api/settings/{id}/preferred -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
22157         "type": "json"
22158       }
22159     ],
22160     "name": "addPreferred",
22161     "group": "Settings",
22162     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22163     "version": "0.0.0",
22164     "filename": "server/api/setting/index.js",
22165     "groupTitle": "Settings"
22166   },
22167   {
22168     "type": "get",
22169     "url": "/api/settings/now",
22170     "title": "Get Server Current Date",
22171     "examples": [
22172       {
22173         "title": "Example usage:",
22174         "content": "curl https://{domain}/api/settings/now -v -X GET",
22175         "type": "json"
22176       }
22177     ],
22178     "name": "getDate",
22179     "group": "Settings",
22180     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22181     "version": "0.0.0",
22182     "filename": "server/api/setting/index.js",
22183     "groupTitle": "Settings"
22184   },
22185   {
22186     "type": "get",
22187     "url": "/api/settings/{id}/favicon",
22188     "title": "Get Favicon",
22189     "examples": [
22190       {
22191         "title": "Example usage:",
22192         "content": "curl https://{domain}/api/settings/{id}/favicon -v -X GET",
22193         "type": "json"
22194       }
22195     ],
22196     "name": "getFavicon",
22197     "group": "Settings",
22198     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22199     "version": "0.0.0",
22200     "filename": "server/api/setting/index.js",
22201     "groupTitle": "Settings"
22202   },
22203   {
22204     "type": "get",
22205     "url": "/api/settings/{id}/gdpr",
22206     "title": "Get gdpr settings",
22207     "examples": [
22208       {
22209         "title": "Example usage:",
22210         "content": "curl https://{domain}/api/settings/{id}/gdpr -v -u {name}:{password} -X GET",
22211         "type": "json"
22212       }
22213     ],
22214     "name": "getGdpr",
22215     "group": "Settings",
22216     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22217     "version": "0.0.0",
22218     "filename": "server/api/setting/index.js",
22219     "groupTitle": "Settings"
22220   },
22221   {
22222     "type": "get",
22223     "url": "/api/settings/{id}/logo",
22224     "title": "Get logo",
22225     "examples": [
22226       {
22227         "title": "Example usage:",
22228         "content": "curl https://{domain}/api/settings/{id}/logo -v -X GET",
22229         "type": "json"
22230       }
22231     ],
22232     "name": "getLogo",
22233     "group": "Settings",
22234     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22235     "version": "0.0.0",
22236     "filename": "server/api/setting/index.js",
22237     "groupTitle": "Settings"
22238   },
22239   {
22240     "type": "get",
22241     "url": "/api/settings/{id}/logo_login",
22242     "title": "Get logo login",
22243     "examples": [
22244       {
22245         "title": "Example usage:",
22246         "content": "curl https://{domain}/api/settings/{id}/logo_login -v -X GET",
22247         "type": "json"
22248       }
22249     ],
22250     "name": "getLogoLogin",
22251     "group": "Settings",
22252     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22253     "version": "0.0.0",
22254     "filename": "server/api/setting/index.js",
22255     "groupTitle": "Settings"
22256   },
22257   {
22258     "type": "get",
22259     "url": "/api/settings/{id}/preferred",
22260     "title": "Get Preferred",
22261     "examples": [
22262       {
22263         "title": "Example usage:",
22264         "content": "curl https://{domain}/api/settings/{id}/preferred -v -X GET",
22265         "type": "json"
22266       }
22267     ],
22268     "name": "getPreferred",
22269     "group": "Settings",
22270     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22271     "version": "0.0.0",
22272     "filename": "server/api/setting/index.js",
22273     "groupTitle": "Settings"
22274   },
22275   {
22276     "type": "put",
22277     "url": "/api/settings/{id}",
22278     "title": "Update an existing Setting",
22279     "examples": [
22280       {
22281         "title": "Example usage:",
22282         "content": "curl https://{domain}/api/settings/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
22283         "type": "json"
22284       }
22285     ],
22286     "name": "updateSettings",
22287     "group": "Settings",
22288     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22289     "version": "0.0.0",
22290     "filename": "server/api/setting/index.js",
22291     "groupTitle": "Settings"
22292   },
22293   {
22294     "type": "post",
22295     "url": "/api/sms/accounts/{id}/users",
22296     "title": "Add agents to a sms account",
22297     "examples": [
22298       {
22299         "title": "Example usage:",
22300         "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",
22301         "type": "json"
22302       }
22303     ],
22304     "name": "AddAgents",
22305     "group": "Sms_Accounts",
22306     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22307     "version": "0.0.0",
22308     "filename": "server/api/smsAccount/index.js",
22309     "groupTitle": "Sms_Accounts"
22310   },
22311   {
22312     "type": "post",
22313     "url": "/api/sms/accounts",
22314     "title": "Creates a new Account",
22315     "examples": [
22316       {
22317         "title": "Example usage:",
22318         "content": "curl https://{domain}/api/sms/accounts -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
22319         "type": "json"
22320       }
22321     ],
22322     "name": "CreateAccounts",
22323     "group": "Sms_Accounts",
22324     "parameter": {
22325       "fields": {
22326         "Body": [
22327           {
22328             "group": "Body",
22329             "type": "String",
22330             "optional": false,
22331             "field": "name",
22332             "description": ""
22333           },
22334           {
22335             "group": "Body",
22336             "type": "String",
22337             "optional": false,
22338             "field": "key",
22339             "description": ""
22340           },
22341           {
22342             "group": "Body",
22343             "type": "String",
22344             "optional": false,
22345             "field": "remote",
22346             "description": ""
22347           },
22348           {
22349             "group": "Body",
22350             "type": "String",
22351             "optional": true,
22352             "field": "token",
22353             "description": ""
22354           },
22355           {
22356             "group": "Body",
22357             "type": "String",
22358             "optional": true,
22359             "field": "phone",
22360             "description": ""
22361           },
22362           {
22363             "group": "Body",
22364             "type": "String",
22365             "allowedValues": [
22366               "\"twilio\"",
22367               "\"skebby\"",
22368               "\"connectel\"",
22369               "\"clicksend\"",
22370               "\"plivo\"",
22371               "\"clickatell\"",
22372               "\"bandwidth\"",
22373               "\"csc\"",
22374               "\"infobip\"",
22375               "\"intelepeer\""
22376             ],
22377             "optional": true,
22378             "field": "type",
22379             "description": ""
22380           },
22381           {
22382             "group": "Body",
22383             "type": "String",
22384             "optional": true,
22385             "field": "accountSid",
22386             "description": ""
22387           },
22388           {
22389             "group": "Body",
22390             "type": "String",
22391             "optional": true,
22392             "field": "authId",
22393             "description": ""
22394           },
22395           {
22396             "group": "Body",
22397             "type": "String",
22398             "optional": true,
22399             "field": "authToken",
22400             "description": ""
22401           },
22402           {
22403             "group": "Body",
22404             "type": "String",
22405             "allowedValues": [
22406               "\"SI\"",
22407               "\"TI\"",
22408               "\"GP\""
22409             ],
22410             "optional": true,
22411             "field": "smsMethod",
22412             "description": ""
22413           },
22414           {
22415             "group": "Body",
22416             "type": "String",
22417             "optional": true,
22418             "field": "username",
22419             "description": ""
22420           },
22421           {
22422             "group": "Body",
22423             "type": "String",
22424             "optional": true,
22425             "field": "password",
22426             "description": ""
22427           },
22428           {
22429             "group": "Body",
22430             "type": "String",
22431             "optional": true,
22432             "field": "apiKey",
22433             "description": ""
22434           },
22435           {
22436             "group": "Body",
22437             "type": "String",
22438             "optional": true,
22439             "field": "applicationId",
22440             "description": ""
22441           },
22442           {
22443             "group": "Body",
22444             "type": "String",
22445             "optional": true,
22446             "field": "accountId",
22447             "description": ""
22448           },
22449           {
22450             "group": "Body",
22451             "type": "String",
22452             "optional": true,
22453             "field": "senderString",
22454             "description": ""
22455           },
22456           {
22457             "group": "Body",
22458             "type": "Boolean",
22459             "optional": true,
22460             "field": "deliveryReport",
22461             "description": ""
22462           },
22463           {
22464             "group": "Body",
22465             "type": "String",
22466             "optional": true,
22467             "field": "description",
22468             "description": ""
22469           },
22470           {
22471             "group": "Body",
22472             "type": "Text",
22473             "optional": true,
22474             "field": "notificationTemplate",
22475             "description": ""
22476           },
22477           {
22478             "group": "Body",
22479             "type": "Boolean",
22480             "optional": true,
22481             "field": "notificationSound",
22482             "description": ""
22483           },
22484           {
22485             "group": "Body",
22486             "type": "Boolean",
22487             "optional": true,
22488             "field": "notificationShake",
22489             "description": ""
22490           },
22491           {
22492             "group": "Body",
22493             "type": "Integer",
22494             "optional": true,
22495             "field": "waitForTheAssignedAgent",
22496             "description": ""
22497           },
22498           {
22499             "group": "Body",
22500             "type": "Boolean",
22501             "optional": true,
22502             "field": "queueTransfer",
22503             "description": ""
22504           },
22505           {
22506             "group": "Body",
22507             "type": "Integer",
22508             "optional": true,
22509             "field": "queueTransferTimeout",
22510             "description": ""
22511           },
22512           {
22513             "group": "Body",
22514             "type": "Boolean",
22515             "optional": true,
22516             "field": "agentTransfer",
22517             "description": ""
22518           },
22519           {
22520             "group": "Body",
22521             "type": "Integer",
22522             "optional": true,
22523             "field": "agentTransferTimeout",
22524             "description": ""
22525           },
22526           {
22527             "group": "Body",
22528             "type": "String",
22529             "optional": true,
22530             "field": "baseUrl",
22531             "description": ""
22532           },
22533           {
22534             "group": "Body",
22535             "type": "Integer",
22536             "optional": true,
22537             "field": "mandatoryDispositionPauseId",
22538             "description": "<p>Status to put when mandatory disposition is enabled</p>"
22539           },
22540           {
22541             "group": "Body",
22542             "type": "Boolean",
22543             "optional": true,
22544             "field": "mandatoryDisposition",
22545             "description": "<p>Enabled/disables mandatory dispo on a queue</p>"
22546           }
22547         ]
22548       }
22549     },
22550     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22551     "version": "0.0.0",
22552     "filename": "server/api/smsAccount/index.js",
22553     "groupTitle": "Sms_Accounts"
22554   },
22555   {
22556     "type": "delete",
22557     "url": "/api/sms/accounts/{id}",
22558     "title": "Deletes a Account",
22559     "examples": [
22560       {
22561         "title": "Example usage:",
22562         "content": "curl https://{domain}/api/sms/accounts/{id} -v -u {name}:{password} -X DELETE",
22563         "type": "json"
22564       }
22565     ],
22566     "name": "DeleteAccounts",
22567     "group": "Sms_Accounts",
22568     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22569     "version": "0.0.0",
22570     "filename": "server/api/smsAccount/index.js",
22571     "groupTitle": "Sms_Accounts"
22572   },
22573   {
22574     "type": "get",
22575     "url": "/api/sms/accounts/describe",
22576     "title": "Gets table info about Accounts",
22577     "examples": [
22578       {
22579         "title": "Example usage:",
22580         "content": "curl https://{domain}/api/sms/accounts/describe -v -u {name}:{password}",
22581         "type": "json"
22582       }
22583     ],
22584     "name": "DescribeAccounts",
22585     "group": "Sms_Accounts",
22586     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22587     "version": "0.0.0",
22588     "filename": "server/api/smsAccount/index.js",
22589     "groupTitle": "Sms_Accounts"
22590   },
22591   {
22592     "type": "get",
22593     "url": "/api/sms/accounts",
22594     "title": "Gets a list of Accounts",
22595     "examples": [
22596       {
22597         "title": "Example usage:",
22598         "content": "curl https://{domain}/api/sms/accounts -v -u {name}:{password}",
22599         "type": "json"
22600       }
22601     ],
22602     "name": "GetAccounts",
22603     "group": "Sms_Accounts",
22604     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
22605     "version": "0.0.0",
22606     "filename": "server/api/smsAccount/index.js",
22607     "groupTitle": "Sms_Accounts"
22608   },
22609   {
22610     "type": "get",
22611     "url": "/api/sms/accounts/{id}/users",
22612     "title": "Gets agents from sms account",
22613     "examples": [
22614       {
22615         "title": "Example usage:",
22616         "content": "curl https://{domain}/api/sms/accounts/{id}/users -v -u {name}:{password} -X GET",
22617         "type": "json"
22618       }
22619     ],
22620     "name": "GetAgents",
22621     "group": "Sms_Accounts",
22622     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22623     "version": "0.0.0",
22624     "filename": "server/api/smsAccount/index.js",
22625     "groupTitle": "Sms_Accounts"
22626   },
22627   {
22628     "type": "delete",
22629     "url": "/api/sms/accounts/{id}/users",
22630     "title": "Removes agents from a sms account",
22631     "examples": [
22632       {
22633         "title": "Example usage:",
22634         "content": "curl https://{domain}/api/sms/accounts/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
22635         "type": "json"
22636       }
22637     ],
22638     "name": "RemoveAgents",
22639     "group": "Sms_Accounts",
22640     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22641     "version": "0.0.0",
22642     "filename": "server/api/smsAccount/index.js",
22643     "groupTitle": "Sms_Accounts"
22644   },
22645   {
22646     "type": "delete",
22647     "url": "/api/sms/accounts/{id}/canned_answers",
22648     "title": "Removes canned answers from account",
22649     "examples": [
22650       {
22651         "title": "Example usage:",
22652         "content": "curl https://{domain}/api/sms/accounts/{id}/canned_answers?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
22653         "type": "json"
22654       }
22655     ],
22656     "name": "RemoveAnswers",
22657     "group": "Sms_Accounts",
22658     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22659     "version": "0.0.0",
22660     "filename": "server/api/smsAccount/index.js",
22661     "groupTitle": "Sms_Accounts"
22662   },
22663   {
22664     "type": "delete",
22665     "url": "/api/sms/accounts/{id}/dispositions",
22666     "title": "Removes dispositions from account",
22667     "examples": [
22668       {
22669         "title": "Example usage:",
22670         "content": "curl https://{domain}/api/sms/accounts/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
22671         "type": "json"
22672       }
22673     ],
22674     "name": "RemoveDispositions",
22675     "group": "Sms_Accounts",
22676     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22677     "version": "0.0.0",
22678     "filename": "server/api/smsAccount/index.js",
22679     "groupTitle": "Sms_Accounts"
22680   },
22681   {
22682     "type": "get",
22683     "url": "/api/sms/accounts/{id}",
22684     "title": "Gets a single Account",
22685     "examples": [
22686       {
22687         "title": "Example usage:",
22688         "content": "curl https://{domain}/api/sms/accounts/{id} -v -u {name}:{password}",
22689         "type": "json"
22690       }
22691     ],
22692     "name": "ShowAccounts",
22693     "group": "Sms_Accounts",
22694     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22695     "version": "0.0.0",
22696     "filename": "server/api/smsAccount/index.js",
22697     "groupTitle": "Sms_Accounts"
22698   },
22699   {
22700     "type": "put",
22701     "url": "/api/sms/messages/{id}/accept",
22702     "title": "Accepts message",
22703     "examples": [
22704       {
22705         "title": "Example usage:",
22706         "content": "curl https://{domain}/api/sms/messages/{id}/accept \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
22707         "type": "json"
22708       }
22709     ],
22710     "name": "acceptMessage",
22711     "group": "Sms_Accounts",
22712     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22713     "version": "0.0.0",
22714     "filename": "server/api/smsMessage/index.js",
22715     "groupTitle": "Sms_Accounts"
22716   },
22717   {
22718     "type": "post",
22719     "url": "/api/sms/accounts/{id}/canned_answers",
22720     "title": "Creates new canned answer",
22721     "examples": [
22722       {
22723         "title": "Example usage:",
22724         "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",
22725         "type": "json"
22726       }
22727     ],
22728     "name": "addAnswer",
22729     "group": "Sms_Accounts",
22730     "parameter": {
22731       "fields": {
22732         "Body": [
22733           {
22734             "group": "Body",
22735             "type": "String",
22736             "optional": false,
22737             "field": "key",
22738             "description": ""
22739           },
22740           {
22741             "group": "Body",
22742             "type": "Text",
22743             "optional": false,
22744             "field": "value",
22745             "description": ""
22746           },
22747           {
22748             "group": "Body",
22749             "type": "String",
22750             "optional": true,
22751             "field": "description",
22752             "description": ""
22753           },
22754           {
22755             "group": "Body",
22756             "type": "Virtual",
22757             "optional": true,
22758             "field": "name",
22759             "description": ""
22760           }
22761         ]
22762       }
22763     },
22764     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22765     "version": "0.0.0",
22766     "filename": "server/api/smsAccount/index.js",
22767     "groupTitle": "Sms_Accounts"
22768   },
22769   {
22770     "type": "post",
22771     "url": "/api/sms/accounts/{id}/applications",
22772     "title": "Creates new applications",
22773     "examples": [
22774       {
22775         "title": "Example usage:",
22776         "content": "curl https://{domain}/api/sms/accounts/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
22777         "type": "json"
22778       }
22779     ],
22780     "name": "addApplications",
22781     "group": "Sms_Accounts",
22782     "parameter": {
22783       "fields": {
22784         "Body": [
22785           {
22786             "group": "Body",
22787             "type": "Integer",
22788             "optional": false,
22789             "field": "priority",
22790             "description": ""
22791           },
22792           {
22793             "group": "Body",
22794             "type": "String",
22795             "optional": false,
22796             "field": "app",
22797             "description": ""
22798           },
22799           {
22800             "group": "Body",
22801             "type": "Text",
22802             "optional": true,
22803             "field": "appdata",
22804             "description": ""
22805           },
22806           {
22807             "group": "Body",
22808             "type": "String",
22809             "optional": true,
22810             "field": "description",
22811             "description": ""
22812           },
22813           {
22814             "group": "Body",
22815             "type": "String",
22816             "optional": true,
22817             "field": "interval",
22818             "description": ""
22819           }
22820         ]
22821       }
22822     },
22823     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22824     "version": "0.0.0",
22825     "filename": "server/api/smsAccount/index.js",
22826     "groupTitle": "Sms_Accounts"
22827   },
22828   {
22829     "type": "post",
22830     "url": "/api/sms/accounts/{id}/dispositions",
22831     "title": "Creates new disposition",
22832     "examples": [
22833       {
22834         "title": "Example usage:",
22835         "content": "curl https://{domain}/api/sms/accounts/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
22836         "type": "json"
22837       }
22838     ],
22839     "name": "addDisposition",
22840     "group": "Sms_Accounts",
22841     "parameter": {
22842       "fields": {
22843         "Body": [
22844           {
22845             "group": "Body",
22846             "type": "String",
22847             "optional": false,
22848             "field": "name",
22849             "description": ""
22850           },
22851           {
22852             "group": "Body",
22853             "type": "String",
22854             "allowedValues": [
22855               "\"first\"",
22856               "\"second\"",
22857               "\"third\""
22858             ],
22859             "optional": false,
22860             "field": "level",
22861             "description": ""
22862           },
22863           {
22864             "group": "Body",
22865             "type": "String",
22866             "optional": true,
22867             "field": "description",
22868             "description": ""
22869           }
22870         ]
22871       }
22872     },
22873     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22874     "version": "0.0.0",
22875     "filename": "server/api/smsAccount/index.js",
22876     "groupTitle": "Sms_Accounts"
22877   },
22878   {
22879     "type": "get",
22880     "url": "/api/sms/accounts/{id}/canned_answers",
22881     "title": "Gets account canned answers",
22882     "examples": [
22883       {
22884         "title": "Example usage:",
22885         "content": "curl https://{domain}/api/sms/accounts/{id}/canned_answers -v -u {name}:{password} -X GET",
22886         "type": "json"
22887       }
22888     ],
22889     "name": "getAnswers",
22890     "group": "Sms_Accounts",
22891     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22892     "version": "0.0.0",
22893     "filename": "server/api/smsAccount/index.js",
22894     "groupTitle": "Sms_Accounts"
22895   },
22896   {
22897     "type": "get",
22898     "url": "/api/sms/accounts/{id}/applications",
22899     "title": "Gets account applications",
22900     "examples": [
22901       {
22902         "title": "Example usage:",
22903         "content": "curl https://{domain}/api/sms/accounts/{id}/applications -v -u {name}:{password} -X GET",
22904         "type": "json"
22905       }
22906     ],
22907     "name": "getApplications",
22908     "group": "Sms_Accounts",
22909     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22910     "version": "0.0.0",
22911     "filename": "server/api/smsAccount/index.js",
22912     "groupTitle": "Sms_Accounts"
22913   },
22914   {
22915     "type": "get",
22916     "url": "/api/sms/accounts/{id}/dispositions",
22917     "title": "Gets account dispositions",
22918     "examples": [
22919       {
22920         "title": "Example usage:",
22921         "content": "curl https://{domain}/api/sms/accounts/{id}/dispositions -v -u {name}:{password} -X GET",
22922         "type": "json"
22923       }
22924     ],
22925     "name": "getDispositions",
22926     "group": "Sms_Accounts",
22927     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22928     "version": "0.0.0",
22929     "filename": "server/api/smsAccount/index.js",
22930     "groupTitle": "Sms_Accounts"
22931   },
22932   {
22933     "type": "get",
22934     "url": "/api/sms/accounts/{id}/interactions",
22935     "title": "Gets Sms Account interactions",
22936     "examples": [
22937       {
22938         "title": "Example usage:",
22939         "content": "curl https://{domain}/api/sms/accounts/{id}/interactions -v -u {name}:{password} -X GET",
22940         "type": "json"
22941       }
22942     ],
22943     "name": "getInteractions",
22944     "group": "Sms_Accounts",
22945     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22946     "version": "0.0.0",
22947     "filename": "server/api/smsAccount/index.js",
22948     "groupTitle": "Sms_Accounts"
22949   },
22950   {
22951     "type": "post",
22952     "url": "/api/sms/accounts/{id}/notify",
22953     "title": "Notify new message",
22954     "examples": [
22955       {
22956         "title": "Example usage:",
22957         "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",
22958         "type": "json"
22959       }
22960     ],
22961     "name": "notify",
22962     "group": "Sms_Accounts",
22963     "description": "<p>Motion 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>",
22964     "version": "0.0.0",
22965     "filename": "server/api/smsAccount/index.js",
22966     "groupTitle": "Sms_Accounts"
22967   },
22968   {
22969     "type": "put",
22970     "url": "/api/sms/messages/{id}/reject",
22971     "title": "Rejects message",
22972     "examples": [
22973       {
22974         "title": "Example usage:",
22975         "content": "curl https://{domain}/api/sms/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
22976         "type": "json"
22977       }
22978     ],
22979     "name": "rejectMessage",
22980     "group": "Sms_Accounts",
22981     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22982     "version": "0.0.0",
22983     "filename": "server/api/smsMessage/index.js",
22984     "groupTitle": "Sms_Accounts"
22985   },
22986   {
22987     "type": "post",
22988     "url": "/api/sms/accounts/{id}/send",
22989     "title": "Send new sms message",
22990     "examples": [
22991       {
22992         "title": "Example usage:",
22993         "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",
22994         "type": "json"
22995       }
22996     ],
22997     "name": "sendSms",
22998     "group": "Sms_Accounts",
22999     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23000     "version": "0.0.0",
23001     "filename": "server/api/smsAccount/index.js",
23002     "groupTitle": "Sms_Accounts"
23003   },
23004   {
23005     "type": "get",
23006     "url": "/api/sms/accounts/{id}/status",
23007     "title": "Receive message status as get request",
23008     "examples": [
23009       {
23010         "title": "Example usage:",
23011         "content": "curl https://{domain}/api/sms/accounts/{id}/status -H 'Content-Type: application/json' -v -X GET",
23012         "type": "json"
23013       }
23014     ],
23015     "name": "statusMessage",
23016     "group": "Sms_Accounts",
23017     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23018     "version": "0.0.0",
23019     "filename": "server/api/smsAccount/index.js",
23020     "groupTitle": "Sms_Accounts"
23021   },
23022   {
23023     "type": "post",
23024     "url": "/api/sms/messages/{id}/status",
23025     "title": "Receive message status",
23026     "examples": [
23027       {
23028         "title": "Example usage:",
23029         "content": "curl https://{domain}/api/sms/messages/{id}/status \\ \n -H 'Content-Type: application/json' -v -X POST",
23030         "type": "json"
23031       }
23032     ],
23033     "name": "statusMessage",
23034     "group": "Sms_Accounts",
23035     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23036     "version": "0.0.0",
23037     "filename": "server/api/smsMessage/index.js",
23038     "groupTitle": "Sms_Accounts"
23039   },
23040   {
23041     "type": "post",
23042     "url": "/api/sms/accounts/{id}/status",
23043     "title": "Receive message status",
23044     "examples": [
23045       {
23046         "title": "Example usage:",
23047         "content": "curl https://{domain}/api/sms/accounts/{id}/status -H 'Content-Type: application/json' -v -X POST",
23048         "type": "json"
23049       }
23050     ],
23051     "name": "statusMessage",
23052     "group": "Sms_Accounts",
23053     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23054     "version": "0.0.0",
23055     "filename": "server/api/smsAccount/index.js",
23056     "groupTitle": "Sms_Accounts"
23057   },
23058   {
23059     "type": "put",
23060     "url": "/api/sms/accounts/{id}",
23061     "title": "Update an existing Account",
23062     "examples": [
23063       {
23064         "title": "Example usage:",
23065         "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",
23066         "type": "json"
23067       }
23068     ],
23069     "name": "updateAccounts",
23070     "group": "Sms_Accounts",
23071     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23072     "version": "0.0.0",
23073     "filename": "server/api/smsAccount/index.js",
23074     "groupTitle": "Sms_Accounts"
23075   },
23076   {
23077     "type": "post",
23078     "url": "/api/sms/applications",
23079     "title": "Creates a new Application",
23080     "examples": [
23081       {
23082         "title": "Example usage:",
23083         "content": "curl https://{domain}/api/sms/applications -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
23084         "type": "json"
23085       }
23086     ],
23087     "name": "CreateApplications",
23088     "group": "Sms_Applications",
23089     "parameter": {
23090       "fields": {
23091         "Body": [
23092           {
23093             "group": "Body",
23094             "type": "Integer",
23095             "optional": false,
23096             "field": "priority",
23097             "description": ""
23098           },
23099           {
23100             "group": "Body",
23101             "type": "String",
23102             "optional": false,
23103             "field": "app",
23104             "description": ""
23105           },
23106           {
23107             "group": "Body",
23108             "type": "Text",
23109             "optional": true,
23110             "field": "appdata",
23111             "description": ""
23112           },
23113           {
23114             "group": "Body",
23115             "type": "String",
23116             "optional": true,
23117             "field": "description",
23118             "description": ""
23119           },
23120           {
23121             "group": "Body",
23122             "type": "String",
23123             "optional": true,
23124             "field": "interval",
23125             "description": ""
23126           }
23127         ]
23128       }
23129     },
23130     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23131     "version": "0.0.0",
23132     "filename": "server/api/smsApplication/index.js",
23133     "groupTitle": "Sms_Applications"
23134   },
23135   {
23136     "type": "delete",
23137     "url": "/api/sms/applications/{id}",
23138     "title": "Deletes a Application",
23139     "examples": [
23140       {
23141         "title": "Example usage:",
23142         "content": "curl https://{domain}/api/sms/applications/{id} -v -u {name}:{password} -X DELETE",
23143         "type": "json"
23144       }
23145     ],
23146     "name": "DeleteApplications",
23147     "group": "Sms_Applications",
23148     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23149     "version": "0.0.0",
23150     "filename": "server/api/smsApplication/index.js",
23151     "groupTitle": "Sms_Applications"
23152   },
23153   {
23154     "type": "get",
23155     "url": "/api/sms/applications",
23156     "title": "Gets a list of Applications",
23157     "examples": [
23158       {
23159         "title": "Example usage:",
23160         "content": "curl https://{domain}/api/sms/applications -v -u {name}:{password}",
23161         "type": "json"
23162       }
23163     ],
23164     "name": "GetApplications",
23165     "group": "Sms_Applications",
23166     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
23167     "version": "0.0.0",
23168     "filename": "server/api/smsApplication/index.js",
23169     "groupTitle": "Sms_Applications"
23170   },
23171   {
23172     "type": "get",
23173     "url": "/api/sms/applications/{id}",
23174     "title": "Gets a single Application",
23175     "examples": [
23176       {
23177         "title": "Example usage:",
23178         "content": "curl https://{domain}/api/sms/applications/{id} -v -u {name}:{password}",
23179         "type": "json"
23180       }
23181     ],
23182     "name": "ShowApplications",
23183     "group": "Sms_Applications",
23184     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23185     "version": "0.0.0",
23186     "filename": "server/api/smsApplication/index.js",
23187     "groupTitle": "Sms_Applications"
23188   },
23189   {
23190     "type": "put",
23191     "url": "/api/sms/applications/{id}",
23192     "title": "Update an existing Application",
23193     "examples": [
23194       {
23195         "title": "Example usage:",
23196         "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",
23197         "type": "json"
23198       }
23199     ],
23200     "name": "updateApplications",
23201     "group": "Sms_Applications",
23202     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23203     "version": "0.0.0",
23204     "filename": "server/api/smsApplication/index.js",
23205     "groupTitle": "Sms_Applications"
23206   },
23207   {
23208     "type": "post",
23209     "url": "/api/sms/interactions/{id}/tags",
23210     "title": "Add tags to the interaction",
23211     "examples": [
23212       {
23213         "title": "Example usage:",
23214         "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",
23215         "type": "json"
23216       }
23217     ],
23218     "name": "AddTags",
23219     "group": "Sms_Interactions",
23220     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23221     "version": "0.0.0",
23222     "filename": "server/api/smsInteraction/index.js",
23223     "groupTitle": "Sms_Interactions"
23224   },
23225   {
23226     "type": "post",
23227     "url": "/api/sms/interactions",
23228     "title": "Creates a new Interaction",
23229     "examples": [
23230       {
23231         "title": "Example usage:",
23232         "content": "curl https://{domain}/api/sms/interactions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
23233         "type": "json"
23234       }
23235     ],
23236     "name": "CreateInteractions",
23237     "group": "Sms_Interactions",
23238     "parameter": {
23239       "fields": {
23240         "Body": [
23241           {
23242             "group": "Body",
23243             "type": "Boolean",
23244             "optional": true,
23245             "field": "closed",
23246             "description": ""
23247           },
23248           {
23249             "group": "Body",
23250             "type": "String",
23251             "optional": true,
23252             "field": "closedAt",
23253             "description": ""
23254           },
23255           {
23256             "group": "Body",
23257             "type": "String",
23258             "optional": true,
23259             "field": "disposition",
23260             "description": ""
23261           },
23262           {
23263             "group": "Body",
23264             "type": "String",
23265             "optional": true,
23266             "field": "secondDisposition",
23267             "description": ""
23268           },
23269           {
23270             "group": "Body",
23271             "type": "String",
23272             "optional": true,
23273             "field": "thirdDisposition",
23274             "description": ""
23275           },
23276           {
23277             "group": "Body",
23278             "type": "String",
23279             "optional": true,
23280             "field": "note",
23281             "description": ""
23282           },
23283           {
23284             "group": "Body",
23285             "type": "String",
23286             "optional": true,
23287             "field": "phone",
23288             "description": ""
23289           },
23290           {
23291             "group": "Body",
23292             "type": "String",
23293             "optional": true,
23294             "field": "read1stAt",
23295             "description": ""
23296           },
23297           {
23298             "group": "Body",
23299             "type": "String",
23300             "allowedValues": [
23301               "\"in\"",
23302               "\"out\""
23303             ],
23304             "optional": false,
23305             "field": "firstMsgDirection",
23306             "description": ""
23307           },
23308           {
23309             "group": "Body",
23310             "type": "String",
23311             "optional": true,
23312             "field": "lastMsgAt",
23313             "description": ""
23314           },
23315           {
23316             "group": "Body",
23317             "type": "String",
23318             "allowedValues": [
23319               "\"in\"",
23320               "\"out\""
23321             ],
23322             "optional": false,
23323             "field": "lastMsgDirection",
23324             "description": ""
23325           },
23326           {
23327             "group": "Body",
23328             "type": "Boolean",
23329             "optional": true,
23330             "field": "autoreplyExecuted",
23331             "description": ""
23332           }
23333         ]
23334       }
23335     },
23336     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23337     "version": "0.0.0",
23338     "filename": "server/api/smsInteraction/index.js",
23339     "groupTitle": "Sms_Interactions"
23340   },
23341   {
23342     "type": "delete",
23343     "url": "/api/sms/interactions/{id}",
23344     "title": "Deletes a Interaction",
23345     "examples": [
23346       {
23347         "title": "Example usage:",
23348         "content": "curl https://{domain}/api/sms/interactions/{id} -v -u {name}:{password} -X DELETE",
23349         "type": "json"
23350       }
23351     ],
23352     "name": "DeleteInteractions",
23353     "group": "Sms_Interactions",
23354     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23355     "version": "0.0.0",
23356     "filename": "server/api/smsInteraction/index.js",
23357     "groupTitle": "Sms_Interactions"
23358   },
23359   {
23360     "type": "get",
23361     "url": "/api/sms/interactions/describe",
23362     "title": "Gets table info about Interactions",
23363     "examples": [
23364       {
23365         "title": "Example usage:",
23366         "content": "curl https://{domain}/api/sms/interactions/describe -v -u {name}:{password}",
23367         "type": "json"
23368       }
23369     ],
23370     "name": "DescribeInteractions",
23371     "group": "Sms_Interactions",
23372     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23373     "version": "0.0.0",
23374     "filename": "server/api/smsInteraction/index.js",
23375     "groupTitle": "Sms_Interactions"
23376   },
23377   {
23378     "type": "get",
23379     "url": "/api/sms/interactions",
23380     "title": "Gets a list of Interactions",
23381     "examples": [
23382       {
23383         "title": "Example usage:",
23384         "content": "curl https://{domain}/api/sms/interactions -v -u {name}:{password}",
23385         "type": "json"
23386       }
23387     ],
23388     "name": "GetInteractions",
23389     "group": "Sms_Interactions",
23390     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
23391     "version": "0.0.0",
23392     "filename": "server/api/smsInteraction/index.js",
23393     "groupTitle": "Sms_Interactions"
23394   },
23395   {
23396     "type": "delete",
23397     "url": "/api/sms/interactions/{id}/tags",
23398     "title": "Removes tags from interaction",
23399     "examples": [
23400       {
23401         "title": "Example usage:",
23402         "content": "curl https://{domain}/api/sms/interactions/{id}/tags?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
23403         "type": "json"
23404       }
23405     ],
23406     "name": "RemoveTags",
23407     "group": "Sms_Interactions",
23408     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23409     "version": "0.0.0",
23410     "filename": "server/api/smsInteraction/index.js",
23411     "groupTitle": "Sms_Interactions"
23412   },
23413   {
23414     "type": "get",
23415     "url": "/api/sms/interactions/{id}",
23416     "title": "Gets a single Interaction",
23417     "examples": [
23418       {
23419         "title": "Example usage:",
23420         "content": "curl https://{domain}/api/sms/interactions/{id} -v -u {name}:{password}",
23421         "type": "json"
23422       }
23423     ],
23424     "name": "ShowInteractions",
23425     "group": "Sms_Interactions",
23426     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23427     "version": "0.0.0",
23428     "filename": "server/api/smsInteraction/index.js",
23429     "groupTitle": "Sms_Interactions"
23430   },
23431   {
23432     "type": "post",
23433     "url": "/api/sms/interactions/{id}/messages",
23434     "title": "Creates new messages",
23435     "examples": [
23436       {
23437         "title": "Example usage:",
23438         "content": "curl https://{domain}/api/sms/interactions/{id}/messages -d '[{\"to\": \"+3901119886500\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
23439         "type": "json"
23440       }
23441     ],
23442     "name": "addMessage",
23443     "group": "Sms_Interactions",
23444     "parameter": {
23445       "fields": {
23446         "Body": [
23447           {
23448             "group": "Body",
23449             "type": "Text",
23450             "optional": false,
23451             "field": "body",
23452             "description": ""
23453           },
23454           {
23455             "group": "Body",
23456             "type": "Boolean",
23457             "optional": true,
23458             "field": "read",
23459             "description": ""
23460           },
23461           {
23462             "group": "Body",
23463             "type": "String",
23464             "allowedValues": [
23465               "\"in\"",
23466               "\"out\""
23467             ],
23468             "optional": false,
23469             "field": "direction",
23470             "description": ""
23471           },
23472           {
23473             "group": "Body",
23474             "type": "String",
23475             "optional": true,
23476             "field": "messageId",
23477             "description": ""
23478           },
23479           {
23480             "group": "Body",
23481             "type": "String",
23482             "optional": true,
23483             "field": "phone",
23484             "description": ""
23485           },
23486           {
23487             "group": "Body",
23488             "type": "String",
23489             "optional": true,
23490             "field": "readAt",
23491             "description": ""
23492           },
23493           {
23494             "group": "Body",
23495             "type": "Boolean",
23496             "optional": true,
23497             "field": "secret",
23498             "description": ""
23499           },
23500           {
23501             "group": "Body",
23502             "type": "String",
23503             "optional": true,
23504             "field": "providerName",
23505             "description": ""
23506           },
23507           {
23508             "group": "Body",
23509             "type": "Text",
23510             "optional": true,
23511             "field": "providerResponse",
23512             "description": ""
23513           }
23514         ]
23515       }
23516     },
23517     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23518     "version": "0.0.0",
23519     "filename": "server/api/smsInteraction/index.js",
23520     "groupTitle": "Sms_Interactions"
23521   },
23522   {
23523     "type": "get",
23524     "url": "/api/sms/interactions/{id}/download",
23525     "title": "Gets interaction",
23526     "examples": [
23527       {
23528         "title": "Example usage:",
23529         "content": "curl https://{domain}/api/sms/interactions/{id}/download -v -u {name}:{password} -X GET",
23530         "type": "json"
23531       }
23532     ],
23533     "name": "download",
23534     "group": "Sms_Interactions",
23535     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23536     "version": "0.0.0",
23537     "filename": "server/api/smsInteraction/index.js",
23538     "groupTitle": "Sms_Interactions"
23539   },
23540   {
23541     "type": "get",
23542     "url": "/api/sms/interactions/{id}/messages",
23543     "title": "Gets interaction messages",
23544     "examples": [
23545       {
23546         "title": "Example usage:",
23547         "content": "curl https://{domain}/api/sms/interactions/{id}/messages -v -u {name}:{password} -X GET",
23548         "type": "json"
23549       }
23550     ],
23551     "name": "getMessages",
23552     "group": "Sms_Interactions",
23553     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23554     "version": "0.0.0",
23555     "filename": "server/api/smsInteraction/index.js",
23556     "groupTitle": "Sms_Interactions"
23557   },
23558   {
23559     "type": "put",
23560     "url": "/api/sms/interactions/{id}",
23561     "title": "Update an existing Interaction",
23562     "examples": [
23563       {
23564         "title": "Example usage:",
23565         "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",
23566         "type": "json"
23567       }
23568     ],
23569     "name": "updateInteractions",
23570     "group": "Sms_Interactions",
23571     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23572     "version": "0.0.0",
23573     "filename": "server/api/smsInteraction/index.js",
23574     "groupTitle": "Sms_Interactions"
23575   },
23576   {
23577     "type": "post",
23578     "url": "/api/sms/messages",
23579     "title": "Creates a new Message",
23580     "examples": [
23581       {
23582         "title": "Example usage:",
23583         "content": "curl https://{domain}/api/sms/messages -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
23584         "type": "json"
23585       }
23586     ],
23587     "name": "CreateMessages",
23588     "group": "Sms_Messages",
23589     "parameter": {
23590       "fields": {
23591         "Body": [
23592           {
23593             "group": "Body",
23594             "type": "Text",
23595             "optional": false,
23596             "field": "body",
23597             "description": ""
23598           },
23599           {
23600             "group": "Body",
23601             "type": "Boolean",
23602             "optional": true,
23603             "field": "read",
23604             "description": ""
23605           },
23606           {
23607             "group": "Body",
23608             "type": "String",
23609             "allowedValues": [
23610               "\"in\"",
23611               "\"out\""
23612             ],
23613             "optional": false,
23614             "field": "direction",
23615             "description": ""
23616           },
23617           {
23618             "group": "Body",
23619             "type": "String",
23620             "optional": true,
23621             "field": "messageId",
23622             "description": ""
23623           },
23624           {
23625             "group": "Body",
23626             "type": "String",
23627             "optional": true,
23628             "field": "phone",
23629             "description": ""
23630           },
23631           {
23632             "group": "Body",
23633             "type": "String",
23634             "optional": true,
23635             "field": "readAt",
23636             "description": ""
23637           },
23638           {
23639             "group": "Body",
23640             "type": "Boolean",
23641             "optional": true,
23642             "field": "secret",
23643             "description": ""
23644           },
23645           {
23646             "group": "Body",
23647             "type": "String",
23648             "optional": true,
23649             "field": "providerName",
23650             "description": ""
23651           },
23652           {
23653             "group": "Body",
23654             "type": "Text",
23655             "optional": true,
23656             "field": "providerResponse",
23657             "description": ""
23658           }
23659         ]
23660       }
23661     },
23662     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23663     "version": "0.0.0",
23664     "filename": "server/api/smsMessage/index.js",
23665     "groupTitle": "Sms_Messages"
23666   },
23667   {
23668     "type": "delete",
23669     "url": "/api/sms/messages/{id}",
23670     "title": "Deletes a Message",
23671     "examples": [
23672       {
23673         "title": "Example usage:",
23674         "content": "curl https://{domain}/api/sms/messages/{id} -v -u {name}:{password} -X DELETE",
23675         "type": "json"
23676       }
23677     ],
23678     "name": "DeleteMessages",
23679     "group": "Sms_Messages",
23680     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23681     "version": "0.0.0",
23682     "filename": "server/api/smsMessage/index.js",
23683     "groupTitle": "Sms_Messages"
23684   },
23685   {
23686     "type": "get",
23687     "url": "/api/sms/messages/describe",
23688     "title": "Gets table info about Messages",
23689     "examples": [
23690       {
23691         "title": "Example usage:",
23692         "content": "curl https://{domain}/api/sms/messages/describe -v -u {name}:{password}",
23693         "type": "json"
23694       }
23695     ],
23696     "name": "DescribeMessages",
23697     "group": "Sms_Messages",
23698     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23699     "version": "0.0.0",
23700     "filename": "server/api/smsMessage/index.js",
23701     "groupTitle": "Sms_Messages"
23702   },
23703   {
23704     "type": "get",
23705     "url": "/api/sms/messages",
23706     "title": "Gets a list of Messages",
23707     "examples": [
23708       {
23709         "title": "Example usage:",
23710         "content": "curl https://{domain}/api/sms/messages -v -u {name}:{password}",
23711         "type": "json"
23712       }
23713     ],
23714     "name": "GetMessages",
23715     "group": "Sms_Messages",
23716     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
23717     "version": "0.0.0",
23718     "filename": "server/api/smsMessage/index.js",
23719     "groupTitle": "Sms_Messages"
23720   },
23721   {
23722     "type": "get",
23723     "url": "/api/sms/messages/{id}",
23724     "title": "Gets a single Message",
23725     "examples": [
23726       {
23727         "title": "Example usage:",
23728         "content": "curl https://{domain}/api/sms/messages/{id} -v -u {name}:{password}",
23729         "type": "json"
23730       }
23731     ],
23732     "name": "ShowMessages",
23733     "group": "Sms_Messages",
23734     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23735     "version": "0.0.0",
23736     "filename": "server/api/smsMessage/index.js",
23737     "groupTitle": "Sms_Messages"
23738   },
23739   {
23740     "type": "put",
23741     "url": "/api/sms/messages/{id}",
23742     "title": "Update an existing Message",
23743     "examples": [
23744       {
23745         "title": "Example usage:",
23746         "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",
23747         "type": "json"
23748       }
23749     ],
23750     "name": "updateMessages",
23751     "group": "Sms_Messages",
23752     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23753     "version": "0.0.0",
23754     "filename": "server/api/smsMessage/index.js",
23755     "groupTitle": "Sms_Messages"
23756   },
23757   {
23758     "type": "post",
23759     "url": "/api/sms/reports/queue",
23760     "title": "Creates a new Sms Queue Report",
23761     "examples": [
23762       {
23763         "title": "Example usage:",
23764         "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",
23765         "type": "json"
23766       }
23767     ],
23768     "name": "CreateSms_Queue_Reports",
23769     "group": "Sms_Queue_Reports",
23770     "parameter": {
23771       "fields": {
23772         "Body": [
23773           {
23774             "group": "Body",
23775             "type": "String",
23776             "optional": false,
23777             "field": "uniqueid",
23778             "description": ""
23779           },
23780           {
23781             "group": "Body",
23782             "type": "String",
23783             "optional": true,
23784             "field": "from",
23785             "description": ""
23786           },
23787           {
23788             "group": "Body",
23789             "type": "String",
23790             "optional": true,
23791             "field": "joinAt",
23792             "description": ""
23793           },
23794           {
23795             "group": "Body",
23796             "type": "String",
23797             "optional": true,
23798             "field": "leaveAt",
23799             "description": ""
23800           },
23801           {
23802             "group": "Body",
23803             "type": "String",
23804             "optional": true,
23805             "field": "acceptAt",
23806             "description": ""
23807           },
23808           {
23809             "group": "Body",
23810             "type": "String",
23811             "optional": true,
23812             "field": "exitAt",
23813             "description": ""
23814           },
23815           {
23816             "group": "Body",
23817             "type": "String",
23818             "optional": true,
23819             "field": "reason",
23820             "description": ""
23821           }
23822         ]
23823       }
23824     },
23825     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23826     "version": "0.0.0",
23827     "filename": "server/api/smsQueueReport/index.js",
23828     "groupTitle": "Sms_Queue_Reports"
23829   },
23830   {
23831     "type": "delete",
23832     "url": "/api/sms/reports/queue/{id}",
23833     "title": "Deletes a Sms Queue Report",
23834     "examples": [
23835       {
23836         "title": "Example usage:",
23837         "content": "curl https://{domain}/api/sms/reports/queue/{id} -v -u {name}:{password} -X DELETE",
23838         "type": "json"
23839       }
23840     ],
23841     "name": "DeleteSms_Queue_Reports",
23842     "group": "Sms_Queue_Reports",
23843     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23844     "version": "0.0.0",
23845     "filename": "server/api/smsQueueReport/index.js",
23846     "groupTitle": "Sms_Queue_Reports"
23847   },
23848   {
23849     "type": "get",
23850     "url": "/api/sms/reports/queue/describe",
23851     "title": "Gets table info about Sms Queue Reports",
23852     "examples": [
23853       {
23854         "title": "Example usage:",
23855         "content": "curl https://{domain}/api/sms/reports/queue/describe -v -u {name}:{password}",
23856         "type": "json"
23857       }
23858     ],
23859     "name": "DescribeSms_Queue_Reports",
23860     "group": "Sms_Queue_Reports",
23861     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23862     "version": "0.0.0",
23863     "filename": "server/api/smsQueueReport/index.js",
23864     "groupTitle": "Sms_Queue_Reports"
23865   },
23866   {
23867     "type": "get",
23868     "url": "/api/sms/reports/queue",
23869     "title": "Gets a list of Sms Queue Reports",
23870     "examples": [
23871       {
23872         "title": "Example usage:",
23873         "content": "curl https://{domain}/api/sms/reports/queue -v -u {name}:{password}",
23874         "type": "json"
23875       }
23876     ],
23877     "name": "GetSms_Queue_Reports",
23878     "group": "Sms_Queue_Reports",
23879     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
23880     "version": "0.0.0",
23881     "filename": "server/api/smsQueueReport/index.js",
23882     "groupTitle": "Sms_Queue_Reports"
23883   },
23884   {
23885     "type": "get",
23886     "url": "/api/sms/reports/queue/{id}",
23887     "title": "Gets a single Sms Queue Report",
23888     "examples": [
23889       {
23890         "title": "Example usage:",
23891         "content": "curl https://{domain}/api/sms/reports/queue/{id} -v -u {name}:{password}",
23892         "type": "json"
23893       }
23894     ],
23895     "name": "ShowSms_Queue_Reports",
23896     "group": "Sms_Queue_Reports",
23897     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23898     "version": "0.0.0",
23899     "filename": "server/api/smsQueueReport/index.js",
23900     "groupTitle": "Sms_Queue_Reports"
23901   },
23902   {
23903     "type": "put",
23904     "url": "/api/sms/reports/queue/{id}",
23905     "title": "Update an existing Sms Queue Report",
23906     "examples": [
23907       {
23908         "title": "Example usage:",
23909         "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",
23910         "type": "json"
23911       }
23912     ],
23913     "name": "updateSms_Queue_Reports",
23914     "group": "Sms_Queue_Reports",
23915     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23916     "version": "0.0.0",
23917     "filename": "server/api/smsQueueReport/index.js",
23918     "groupTitle": "Sms_Queue_Reports"
23919   },
23920   {
23921     "type": "post",
23922     "url": "/api/sms/queues/{id}/users",
23923     "title": "Add agents to a queue",
23924     "examples": [
23925       {
23926         "title": "Example usage:",
23927         "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",
23928         "type": "json"
23929       }
23930     ],
23931     "name": "AddAgents",
23932     "group": "Sms_Queues",
23933     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23934     "version": "0.0.0",
23935     "filename": "server/api/smsQueue/index.js",
23936     "groupTitle": "Sms_Queues"
23937   },
23938   {
23939     "type": "post",
23940     "url": "/api/sms/queues/{id}/teams",
23941     "title": "Add teams to a queue",
23942     "examples": [
23943       {
23944         "title": "Example usage:",
23945         "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",
23946         "type": "json"
23947       }
23948     ],
23949     "name": "AddTeams",
23950     "group": "Sms_Queues",
23951     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23952     "version": "0.0.0",
23953     "filename": "server/api/smsQueue/index.js",
23954     "groupTitle": "Sms_Queues"
23955   },
23956   {
23957     "type": "post",
23958     "url": "/api/sms/queues",
23959     "title": "Creates a new Queue",
23960     "examples": [
23961       {
23962         "title": "Example usage:",
23963         "content": "curl https://{domain}/api/sms/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
23964         "type": "json"
23965       }
23966     ],
23967     "name": "CreateQueues",
23968     "group": "Sms_Queues",
23969     "parameter": {
23970       "fields": {
23971         "Body": [
23972           {
23973             "group": "Body",
23974             "type": "String",
23975             "optional": true,
23976             "field": "name",
23977             "description": ""
23978           },
23979           {
23980             "group": "Body",
23981             "type": "String",
23982             "optional": true,
23983             "field": "description",
23984             "description": ""
23985           },
23986           {
23987             "group": "Body",
23988             "type": "Integer",
23989             "optional": true,
23990             "field": "timeout",
23991             "description": ""
23992           },
23993           {
23994             "group": "Body",
23995             "type": "String",
23996             "allowedValues": [
23997               "\"rrmemory\"",
23998               "\"beepall\"",
23999               "\"roundrobin\""
24000             ],
24001             "optional": true,
24002             "field": "strategy",
24003             "description": ""
24004           }
24005         ]
24006       }
24007     },
24008     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24009     "version": "0.0.0",
24010     "filename": "server/api/smsQueue/index.js",
24011     "groupTitle": "Sms_Queues"
24012   },
24013   {
24014     "type": "delete",
24015     "url": "/api/sms/queues/{id}",
24016     "title": "Deletes a Queue",
24017     "examples": [
24018       {
24019         "title": "Example usage:",
24020         "content": "curl https://{domain}/api/sms/queues/{id} -v -u {name}:{password} -X DELETE",
24021         "type": "json"
24022       }
24023     ],
24024     "name": "DeleteQueues",
24025     "group": "Sms_Queues",
24026     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24027     "version": "0.0.0",
24028     "filename": "server/api/smsQueue/index.js",
24029     "groupTitle": "Sms_Queues"
24030   },
24031   {
24032     "type": "get",
24033     "url": "/api/sms/queues/describe",
24034     "title": "Gets table info about Queues",
24035     "examples": [
24036       {
24037         "title": "Example usage:",
24038         "content": "curl https://{domain}/api/sms/queues/describe -v -u {name}:{password}",
24039         "type": "json"
24040       }
24041     ],
24042     "name": "DescribeQueues",
24043     "group": "Sms_Queues",
24044     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24045     "version": "0.0.0",
24046     "filename": "server/api/smsQueue/index.js",
24047     "groupTitle": "Sms_Queues"
24048   },
24049   {
24050     "type": "get",
24051     "url": "/api/sms/queues/{id}/users",
24052     "title": "Gets queue agents",
24053     "examples": [
24054       {
24055         "title": "Example usage:",
24056         "content": "curl https://{domain}/api/sms/queues/{id}/users -v -u {name}:{password} -X POST",
24057         "type": "json"
24058       }
24059     ],
24060     "name": "GetAgents",
24061     "group": "Sms_Queues",
24062     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24063     "version": "0.0.0",
24064     "filename": "server/api/smsQueue/index.js",
24065     "groupTitle": "Sms_Queues"
24066   },
24067   {
24068     "type": "get",
24069     "url": "/api/sms/queues/{id}/members",
24070     "title": "GetMembers",
24071     "examples": [
24072       {
24073         "title": "Example usage:",
24074         "content": "curl https://{domain}/api/sms/queues/{id}/members  -v -u {name}:{password}",
24075         "type": "json"
24076       }
24077     ],
24078     "name": "GetMembers",
24079     "group": "Sms_Queues",
24080     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24081     "version": "0.0.0",
24082     "filename": "server/api/smsQueue/index.js",
24083     "groupTitle": "Sms_Queues"
24084   },
24085   {
24086     "type": "get",
24087     "url": "/api/sms/queues",
24088     "title": "Gets a list of Queues",
24089     "examples": [
24090       {
24091         "title": "Example usage:",
24092         "content": "curl https://{domain}/api/sms/queues -v -u {name}:{password}",
24093         "type": "json"
24094       }
24095     ],
24096     "name": "GetQueues",
24097     "group": "Sms_Queues",
24098     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
24099     "version": "0.0.0",
24100     "filename": "server/api/smsQueue/index.js",
24101     "groupTitle": "Sms_Queues"
24102   },
24103   {
24104     "type": "get",
24105     "url": "/api/sms/queues/{id}/teams",
24106     "title": "Gets queues list",
24107     "examples": [
24108       {
24109         "title": "Example usage:",
24110         "content": "curl https://{domain}/api/sms/queues/{id}/teams -v -u {name}:{password}",
24111         "type": "json"
24112       }
24113     ],
24114     "name": "GetTeams",
24115     "group": "Sms_Queues",
24116     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24117     "version": "0.0.0",
24118     "filename": "server/api/smsQueue/index.js",
24119     "groupTitle": "Sms_Queues"
24120   },
24121   {
24122     "type": "delete",
24123     "url": "/api/sms/queues/{id}/users",
24124     "title": "Removes agents from a queue",
24125     "examples": [
24126       {
24127         "title": "Example usage:",
24128         "content": "curl https://{domain}/api/sms/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
24129         "type": "json"
24130       }
24131     ],
24132     "name": "RemoveAgents",
24133     "group": "Sms_Queues",
24134     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24135     "version": "0.0.0",
24136     "filename": "server/api/smsQueue/index.js",
24137     "groupTitle": "Sms_Queues"
24138   },
24139   {
24140     "type": "get",
24141     "url": "/api/sms/queues/{id}",
24142     "title": "Gets a single Queue",
24143     "examples": [
24144       {
24145         "title": "Example usage:",
24146         "content": "curl https://{domain}/api/sms/queues/{id} -v -u {name}:{password}",
24147         "type": "json"
24148       }
24149     ],
24150     "name": "ShowQueues",
24151     "group": "Sms_Queues",
24152     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24153     "version": "0.0.0",
24154     "filename": "server/api/smsQueue/index.js",
24155     "groupTitle": "Sms_Queues"
24156   },
24157   {
24158     "type": "put",
24159     "url": "/api/sms/queues/{id}",
24160     "title": "Update an existing Queue",
24161     "examples": [
24162       {
24163         "title": "Example usage:",
24164         "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",
24165         "type": "json"
24166       }
24167     ],
24168     "name": "updateQueues",
24169     "group": "Sms_Queues",
24170     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24171     "version": "0.0.0",
24172     "filename": "server/api/smsQueue/index.js",
24173     "groupTitle": "Sms_Queues"
24174   },
24175   {
24176     "type": "post",
24177     "url": "/api/sms/reports/transfer",
24178     "title": "Creates a new Sms Transfer Report",
24179     "examples": [
24180       {
24181         "title": "Example usage:",
24182         "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",
24183         "type": "json"
24184       }
24185     ],
24186     "name": "CreateSms_Transfer_Reports",
24187     "group": "Sms_Transfer_Reports",
24188     "parameter": {
24189       "fields": {
24190         "Body": [
24191           {
24192             "group": "Body",
24193             "type": "String",
24194             "optional": false,
24195             "field": "uniqueid",
24196             "description": ""
24197           },
24198           {
24199             "group": "Body",
24200             "type": "String",
24201             "allowedValues": [
24202               "\"account\"",
24203               "\"agent\"",
24204               "\"queue\""
24205             ],
24206             "optional": false,
24207             "field": "type",
24208             "description": ""
24209           },
24210           {
24211             "group": "Body",
24212             "type": "String",
24213             "optional": false,
24214             "field": "transferredAt",
24215             "description": ""
24216           }
24217         ]
24218       }
24219     },
24220     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24221     "version": "0.0.0",
24222     "filename": "server/api/smsTransferReport/index.js",
24223     "groupTitle": "Sms_Transfer_Reports"
24224   },
24225   {
24226     "type": "delete",
24227     "url": "/api/sms/reports/transfer/{id}",
24228     "title": "Deletes a Sms Transfer Report",
24229     "examples": [
24230       {
24231         "title": "Example usage:",
24232         "content": "curl https://{domain}/api/sms/reports/transfer/{id} -v -u {name}:{password} -X DELETE",
24233         "type": "json"
24234       }
24235     ],
24236     "name": "DeleteSms_Transfer_Reports",
24237     "group": "Sms_Transfer_Reports",
24238     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24239     "version": "0.0.0",
24240     "filename": "server/api/smsTransferReport/index.js",
24241     "groupTitle": "Sms_Transfer_Reports"
24242   },
24243   {
24244     "type": "get",
24245     "url": "/api/sms/reports/transfer/describe",
24246     "title": "Gets table info about Sms Transfer Reports",
24247     "examples": [
24248       {
24249         "title": "Example usage:",
24250         "content": "curl https://{domain}/api/sms/reports/transfer/describe -v -u {name}:{password}",
24251         "type": "json"
24252       }
24253     ],
24254     "name": "DescribeSms_Transfer_Reports",
24255     "group": "Sms_Transfer_Reports",
24256     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24257     "version": "0.0.0",
24258     "filename": "server/api/smsTransferReport/index.js",
24259     "groupTitle": "Sms_Transfer_Reports"
24260   },
24261   {
24262     "type": "get",
24263     "url": "/api/sms/reports/transfer",
24264     "title": "Gets a list of Sms Transfer Reports",
24265     "examples": [
24266       {
24267         "title": "Example usage:",
24268         "content": "curl https://{domain}/api/sms/reports/transfer -v -u {name}:{password}",
24269         "type": "json"
24270       }
24271     ],
24272     "name": "GetSms_Transfer_Reports",
24273     "group": "Sms_Transfer_Reports",
24274     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
24275     "version": "0.0.0",
24276     "filename": "server/api/smsTransferReport/index.js",
24277     "groupTitle": "Sms_Transfer_Reports"
24278   },
24279   {
24280     "type": "get",
24281     "url": "/api/sms/reports/transfer/{id}",
24282     "title": "Gets a single Sms Transfer Report",
24283     "examples": [
24284       {
24285         "title": "Example usage:",
24286         "content": "curl https://{domain}/api/sms/reports/transfer/{id} -v -u {name}:{password}",
24287         "type": "json"
24288       }
24289     ],
24290     "name": "ShowSms_Transfer_Reports",
24291     "group": "Sms_Transfer_Reports",
24292     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24293     "version": "0.0.0",
24294     "filename": "server/api/smsTransferReport/index.js",
24295     "groupTitle": "Sms_Transfer_Reports"
24296   },
24297   {
24298     "type": "put",
24299     "url": "/api/sms/reports/transfer/{id}",
24300     "title": "Update an existing Sms Transfer Report",
24301     "examples": [
24302       {
24303         "title": "Example usage:",
24304         "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",
24305         "type": "json"
24306       }
24307     ],
24308     "name": "updateSms_Transfer_Reports",
24309     "group": "Sms_Transfer_Reports",
24310     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24311     "version": "0.0.0",
24312     "filename": "server/api/smsTransferReport/index.js",
24313     "groupTitle": "Sms_Transfer_Reports"
24314   },
24315   {
24316     "type": "get",
24317     "url": "/api/sounds",
24318     "title": "Gets a list of Sounds",
24319     "examples": [
24320       {
24321         "title": "Example usage:",
24322         "content": "curl https://{domain}/api/sounds -v -u {name}:{password}",
24323         "type": "json"
24324       }
24325     ],
24326     "name": "GetSounds",
24327     "group": "Sounds",
24328     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
24329     "version": "0.0.0",
24330     "filename": "server/api/sound/index.js",
24331     "groupTitle": "Sounds"
24332   },
24333   {
24334     "type": "get",
24335     "url": "/api/sounds/{id}",
24336     "title": "Gets a single Sound",
24337     "examples": [
24338       {
24339         "title": "Example usage:",
24340         "content": "curl https://{domain}/api/sounds/{id} -v -u {name}:{password}",
24341         "type": "json"
24342       }
24343     ],
24344     "name": "ShowSounds",
24345     "group": "Sounds",
24346     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24347     "version": "0.0.0",
24348     "filename": "server/api/sound/index.js",
24349     "groupTitle": "Sounds"
24350   },
24351   {
24352     "type": "post",
24353     "url": "/api/sounds",
24354     "title": "Create a new sound",
24355     "examples": [
24356       {
24357         "title": "Example usage:",
24358         "content": "curl https://{domain}/api/sounds -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
24359         "type": "json"
24360       }
24361     ],
24362     "name": "addSound",
24363     "group": "Sounds",
24364     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24365     "version": "0.0.0",
24366     "filename": "server/api/sound/index.js",
24367     "groupTitle": "Sounds"
24368   },
24369   {
24370     "type": "delete",
24371     "url": "/api/sounds/{id}",
24372     "title": "Deletes a sound",
24373     "examples": [
24374       {
24375         "title": "Example usage:",
24376         "content": "curl https://{domain}/api/sounds/{id} -v -u {name}:{password} -X DELETE",
24377         "type": "json"
24378       }
24379     ],
24380     "name": "destroySound",
24381     "group": "Sounds",
24382     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24383     "version": "0.0.0",
24384     "filename": "server/api/sound/index.js",
24385     "groupTitle": "Sounds"
24386   },
24387   {
24388     "type": "get",
24389     "url": "/api/sounds/{id}/download",
24390     "title": "Download Sound",
24391     "examples": [
24392       {
24393         "title": "Example usage:",
24394         "content": "curl https://{domain}/api/sounds/{id}/download -v -u {name}:{password} -X GET",
24395         "type": "json"
24396       }
24397     ],
24398     "name": "download",
24399     "group": "Sounds",
24400     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24401     "version": "0.0.0",
24402     "filename": "server/api/sound/index.js",
24403     "groupTitle": "Sounds"
24404   },
24405   {
24406     "type": "put",
24407     "url": "/api/sounds",
24408     "title": "Update an existing new sound",
24409     "examples": [
24410       {
24411         "title": "Example usage:",
24412         "content": "curl https://{domain}/api/sounds -d '[\"name\": \"sound_name\", \"description\": \"sound_desc\"]' -v -u {name}:{password} -X PUT",
24413         "type": "json"
24414       }
24415     ],
24416     "name": "updateSound",
24417     "group": "Sounds",
24418     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24419     "version": "0.0.0",
24420     "filename": "server/api/sound/index.js",
24421     "groupTitle": "Sounds"
24422   },
24423   {
24424     "type": "post",
24425     "url": "/api/square/details/reports",
24426     "title": "Creates a new Square Detail Report",
24427     "examples": [
24428       {
24429         "title": "Example usage:",
24430         "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",
24431         "type": "json"
24432       }
24433     ],
24434     "name": "CreateSquare_Detail_Reports",
24435     "group": "Square_Details_Reports",
24436     "parameter": {
24437       "fields": {
24438         "Body": [
24439           {
24440             "group": "Body",
24441             "type": "String",
24442             "optional": true,
24443             "field": "uniqueid",
24444             "description": ""
24445           },
24446           {
24447             "group": "Body",
24448             "type": "String",
24449             "optional": true,
24450             "field": "node",
24451             "description": ""
24452           },
24453           {
24454             "group": "Body",
24455             "type": "String",
24456             "optional": true,
24457             "field": "application",
24458             "description": ""
24459           },
24460           {
24461             "group": "Body",
24462             "type": "Text",
24463             "optional": true,
24464             "field": "data",
24465             "description": ""
24466           },
24467           {
24468             "group": "Body",
24469             "type": "String",
24470             "optional": true,
24471             "field": "project_name",
24472             "description": ""
24473           },
24474           {
24475             "group": "Body",
24476             "type": "String",
24477             "optional": true,
24478             "field": "callerid",
24479             "description": ""
24480           }
24481         ]
24482       }
24483     },
24484     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24485     "version": "0.0.0",
24486     "filename": "server/api/squareReportDetail/index.js",
24487     "groupTitle": "Square_Details_Reports"
24488   },
24489   {
24490     "type": "delete",
24491     "url": "/api/square/details/reports/{id}",
24492     "title": "Deletes a Square Detail Report",
24493     "examples": [
24494       {
24495         "title": "Example usage:",
24496         "content": "curl https://{domain}/api/square/details/reports/{id} -v -u {name}:{password} -X DELETE",
24497         "type": "json"
24498       }
24499     ],
24500     "name": "DeleteSquare_Detail_Reports",
24501     "group": "Square_Details_Reports",
24502     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24503     "version": "0.0.0",
24504     "filename": "server/api/squareReportDetail/index.js",
24505     "groupTitle": "Square_Details_Reports"
24506   },
24507   {
24508     "type": "get",
24509     "url": "/api/square/details/reports/describe",
24510     "title": "Gets table info about Square Detail Reports",
24511     "examples": [
24512       {
24513         "title": "Example usage:",
24514         "content": "curl https://{domain}/api/square/details/reports/describe -v -u {name}:{password}",
24515         "type": "json"
24516       }
24517     ],
24518     "name": "DescribeSquare_Detail_Reports",
24519     "group": "Square_Details_Reports",
24520     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24521     "version": "0.0.0",
24522     "filename": "server/api/squareReportDetail/index.js",
24523     "groupTitle": "Square_Details_Reports"
24524   },
24525   {
24526     "type": "get",
24527     "url": "/api/square/details/reports",
24528     "title": "Gets a list of Square Detail Reports",
24529     "examples": [
24530       {
24531         "title": "Example usage:",
24532         "content": "curl https://{domain}/api/square/details/reports -v -u {name}:{password}",
24533         "type": "json"
24534       }
24535     ],
24536     "name": "GetSquare_Detail_Reports",
24537     "group": "Square_Details_Reports",
24538     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
24539     "version": "0.0.0",
24540     "filename": "server/api/squareReportDetail/index.js",
24541     "groupTitle": "Square_Details_Reports"
24542   },
24543   {
24544     "type": "get",
24545     "url": "/api/square/details/reports/{id}",
24546     "title": "Gets a single Square Detail Report",
24547     "examples": [
24548       {
24549         "title": "Example usage:",
24550         "content": "curl https://{domain}/api/square/details/reports/{id} -v -u {name}:{password}",
24551         "type": "json"
24552       }
24553     ],
24554     "name": "ShowSquare_Detail_Reports",
24555     "group": "Square_Details_Reports",
24556     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24557     "version": "0.0.0",
24558     "filename": "server/api/squareReportDetail/index.js",
24559     "groupTitle": "Square_Details_Reports"
24560   },
24561   {
24562     "type": "put",
24563     "url": "/api/square/details/reports/{id}",
24564     "title": "Update an existing Square Detail Report",
24565     "examples": [
24566       {
24567         "title": "Example usage:",
24568         "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",
24569         "type": "json"
24570       }
24571     ],
24572     "name": "updateSquare_Detail_Reports",
24573     "group": "Square_Details_Reports",
24574     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24575     "version": "0.0.0",
24576     "filename": "server/api/squareReportDetail/index.js",
24577     "groupTitle": "Square_Details_Reports"
24578   },
24579   {
24580     "type": "post",
24581     "url": "/api/square/messages",
24582     "title": "Creates a new Message",
24583     "examples": [
24584       {
24585         "title": "Example usage:",
24586         "content": "curl https://{domain}/api/square/messages -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
24587         "type": "json"
24588       }
24589     ],
24590     "name": "CreateMessages",
24591     "group": "Square_Messages",
24592     "parameter": {
24593       "fields": {
24594         "Body": [
24595           {
24596             "group": "Body",
24597             "type": "String",
24598             "optional": true,
24599             "field": "uniqueid",
24600             "description": ""
24601           },
24602           {
24603             "group": "Body",
24604             "type": "Text",
24605             "optional": false,
24606             "field": "body",
24607             "description": ""
24608           },
24609           {
24610             "group": "Body",
24611             "type": "String",
24612             "allowedValues": [
24613               "\"in\"",
24614               "\"out\""
24615             ],
24616             "optional": false,
24617             "field": "direction",
24618             "description": ""
24619           },
24620           {
24621             "group": "Body",
24622             "type": "String",
24623             "optional": true,
24624             "field": "providerName",
24625             "description": ""
24626           },
24627           {
24628             "group": "Body",
24629             "type": "Text",
24630             "optional": true,
24631             "field": "providerResponse",
24632             "description": ""
24633           }
24634         ]
24635       }
24636     },
24637     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24638     "version": "0.0.0",
24639     "filename": "server/api/squareMessage/index.js",
24640     "groupTitle": "Square_Messages"
24641   },
24642   {
24643     "type": "delete",
24644     "url": "/api/square/messages/{id}",
24645     "title": "Deletes a Message",
24646     "examples": [
24647       {
24648         "title": "Example usage:",
24649         "content": "curl https://{domain}/api/square/messages/{id} -v -u {name}:{password} -X DELETE",
24650         "type": "json"
24651       }
24652     ],
24653     "name": "DeleteMessages",
24654     "group": "Square_Messages",
24655     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24656     "version": "0.0.0",
24657     "filename": "server/api/squareMessage/index.js",
24658     "groupTitle": "Square_Messages"
24659   },
24660   {
24661     "type": "get",
24662     "url": "/api/square/messages",
24663     "title": "Gets a list of Messages",
24664     "examples": [
24665       {
24666         "title": "Example usage:",
24667         "content": "curl https://{domain}/api/square/messages -v -u {name}:{password}",
24668         "type": "json"
24669       }
24670     ],
24671     "name": "GetMessages",
24672     "group": "Square_Messages",
24673     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
24674     "version": "0.0.0",
24675     "filename": "server/api/squareMessage/index.js",
24676     "groupTitle": "Square_Messages"
24677   },
24678   {
24679     "type": "get",
24680     "url": "/api/square/messages/{id}",
24681     "title": "Gets a single Message",
24682     "examples": [
24683       {
24684         "title": "Example usage:",
24685         "content": "curl https://{domain}/api/square/messages/{id} -v -u {name}:{password}",
24686         "type": "json"
24687       }
24688     ],
24689     "name": "ShowMessages",
24690     "group": "Square_Messages",
24691     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24692     "version": "0.0.0",
24693     "filename": "server/api/squareMessage/index.js",
24694     "groupTitle": "Square_Messages"
24695   },
24696   {
24697     "type": "put",
24698     "url": "/api/square/messages/{id}",
24699     "title": "Update an existing Message",
24700     "examples": [
24701       {
24702         "title": "Example usage:",
24703         "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",
24704         "type": "json"
24705       }
24706     ],
24707     "name": "updateMessages",
24708     "group": "Square_Messages",
24709     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24710     "version": "0.0.0",
24711     "filename": "server/api/squareMessage/index.js",
24712     "groupTitle": "Square_Messages"
24713   },
24714   {
24715     "type": "post",
24716     "url": "/api/square/odbc",
24717     "title": "Creates a new ODBC",
24718     "examples": [
24719       {
24720         "title": "Example usage:",
24721         "content": "curl https://{domain}/api/square/odbc -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
24722         "type": "json"
24723       }
24724     ],
24725     "name": "CreateODBCs",
24726     "group": "Square_ODBC",
24727     "parameter": {
24728       "fields": {
24729         "Body": [
24730           {
24731             "group": "Body",
24732             "type": "String",
24733             "optional": false,
24734             "field": "name",
24735             "description": ""
24736           },
24737           {
24738             "group": "Body",
24739             "type": "String",
24740             "optional": true,
24741             "field": "dsn",
24742             "description": ""
24743           },
24744           {
24745             "group": "Body",
24746             "type": "String",
24747             "optional": true,
24748             "field": "description",
24749             "description": ""
24750           }
24751         ]
24752       }
24753     },
24754     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24755     "version": "0.0.0",
24756     "filename": "server/api/squareOdbc/index.js",
24757     "groupTitle": "Square_ODBC"
24758   },
24759   {
24760     "type": "delete",
24761     "url": "/api/square/odbc/{id}",
24762     "title": "Deletes a ODBC",
24763     "examples": [
24764       {
24765         "title": "Example usage:",
24766         "content": "curl https://{domain}/api/square/odbc/{id} -v -u {name}:{password} -X DELETE",
24767         "type": "json"
24768       }
24769     ],
24770     "name": "DeleteODBCs",
24771     "group": "Square_ODBC",
24772     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24773     "version": "0.0.0",
24774     "filename": "server/api/squareOdbc/index.js",
24775     "groupTitle": "Square_ODBC"
24776   },
24777   {
24778     "type": "get",
24779     "url": "/api/square/odbc",
24780     "title": "Gets a list of ODBCs",
24781     "examples": [
24782       {
24783         "title": "Example usage:",
24784         "content": "curl https://{domain}/api/square/odbc -v -u {name}:{password}",
24785         "type": "json"
24786       }
24787     ],
24788     "name": "GetODBCs",
24789     "group": "Square_ODBC",
24790     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
24791     "version": "0.0.0",
24792     "filename": "server/api/squareOdbc/index.js",
24793     "groupTitle": "Square_ODBC"
24794   },
24795   {
24796     "type": "get",
24797     "url": "/api/square/odbc/{id}",
24798     "title": "Gets a single ODBC",
24799     "examples": [
24800       {
24801         "title": "Example usage:",
24802         "content": "curl https://{domain}/api/square/odbc/{id} -v -u {name}:{password}",
24803         "type": "json"
24804       }
24805     ],
24806     "name": "ShowODBCs",
24807     "group": "Square_ODBC",
24808     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24809     "version": "0.0.0",
24810     "filename": "server/api/squareOdbc/index.js",
24811     "groupTitle": "Square_ODBC"
24812   },
24813   {
24814     "type": "get",
24815     "url": "/api/square/odbc/{id}/test",
24816     "title": "Test Odbc",
24817     "examples": [
24818       {
24819         "title": "Example usage:",
24820         "content": "curl https://{domain}/api/square/odbc/{id}/test -v -u {name}:{password} -X GET",
24821         "type": "json"
24822       }
24823     ],
24824     "name": "test",
24825     "group": "Square_ODBC",
24826     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24827     "version": "0.0.0",
24828     "filename": "server/api/squareOdbc/index.js",
24829     "groupTitle": "Square_ODBC"
24830   },
24831   {
24832     "type": "put",
24833     "url": "/api/square/odbc/{id}",
24834     "title": "Update an existing ODBC",
24835     "examples": [
24836       {
24837         "title": "Example usage:",
24838         "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",
24839         "type": "json"
24840       }
24841     ],
24842     "name": "updateODBCs",
24843     "group": "Square_ODBC",
24844     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24845     "version": "0.0.0",
24846     "filename": "server/api/squareOdbc/index.js",
24847     "groupTitle": "Square_ODBC"
24848   },
24849   {
24850     "type": "post",
24851     "url": "/api/square/projects",
24852     "title": "Creates a new Project",
24853     "examples": [
24854       {
24855         "title": "Example usage:",
24856         "content": "curl https://{domain}/api/square/projects -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
24857         "type": "json"
24858       }
24859     ],
24860     "name": "CreateProjects",
24861     "group": "Square_Projects",
24862     "parameter": {
24863       "fields": {
24864         "Body": [
24865           {
24866             "group": "Body",
24867             "type": "String",
24868             "optional": false,
24869             "field": "name",
24870             "description": ""
24871           },
24872           {
24873             "group": "Body",
24874             "type": "String",
24875             "optional": true,
24876             "field": "description",
24877             "description": ""
24878           },
24879           {
24880             "group": "Body",
24881             "type": "Text",
24882             "optional": true,
24883             "field": "notes",
24884             "description": ""
24885           },
24886           {
24887             "group": "Body",
24888             "type": "Blob",
24889             "optional": true,
24890             "field": "preproduction",
24891             "description": ""
24892           },
24893           {
24894             "group": "Body",
24895             "type": "Blob",
24896             "optional": true,
24897             "field": "production",
24898             "description": ""
24899           },
24900           {
24901             "group": "Body",
24902             "type": "String",
24903             "optional": true,
24904             "field": "savedAt",
24905             "description": ""
24906           },
24907           {
24908             "group": "Body",
24909             "type": "String",
24910             "optional": true,
24911             "field": "publishedAt",
24912             "description": ""
24913           }
24914         ]
24915       }
24916     },
24917     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24918     "version": "0.0.0",
24919     "filename": "server/api/squareProject/index.js",
24920     "groupTitle": "Square_Projects"
24921   },
24922   {
24923     "type": "delete",
24924     "url": "/api/square/projects/{id}",
24925     "title": "Deletes a Project",
24926     "examples": [
24927       {
24928         "title": "Example usage:",
24929         "content": "curl https://{domain}/api/square/projects/{id} -v -u {name}:{password} -X DELETE",
24930         "type": "json"
24931       }
24932     ],
24933     "name": "DeleteProjects",
24934     "group": "Square_Projects",
24935     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24936     "version": "0.0.0",
24937     "filename": "server/api/squareProject/index.js",
24938     "groupTitle": "Square_Projects"
24939   },
24940   {
24941     "type": "get",
24942     "url": "/api/square/projects",
24943     "title": "Gets a list of Projects",
24944     "examples": [
24945       {
24946         "title": "Example usage:",
24947         "content": "curl https://{domain}/api/square/projects -v -u {name}:{password}",
24948         "type": "json"
24949       }
24950     ],
24951     "name": "GetProjects",
24952     "group": "Square_Projects",
24953     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
24954     "version": "0.0.0",
24955     "filename": "server/api/squareProject/index.js",
24956     "groupTitle": "Square_Projects"
24957   },
24958   {
24959     "type": "get",
24960     "url": "/api/square/projects/{id}",
24961     "title": "Gets a single Project",
24962     "examples": [
24963       {
24964         "title": "Example usage:",
24965         "content": "curl https://{domain}/api/square/projects/{id} -v -u {name}:{password}",
24966         "type": "json"
24967       }
24968     ],
24969     "name": "ShowProjects",
24970     "group": "Square_Projects",
24971     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24972     "version": "0.0.0",
24973     "filename": "server/api/squareProject/index.js",
24974     "groupTitle": "Square_Projects"
24975   },
24976   {
24977     "type": "post",
24978     "url": "/api/square/projects/{id}/users",
24979     "title": "Adds user permissions to a Project",
24980     "examples": [
24981       {
24982         "title": "Example usage:",
24983         "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",
24984         "type": "json"
24985       }
24986     ],
24987     "name": "addUsers",
24988     "group": "Square_Projects",
24989     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24990     "version": "0.0.0",
24991     "filename": "server/api/squareProject/index.js",
24992     "groupTitle": "Square_Projects"
24993   },
24994   {
24995     "type": "get",
24996     "url": "/api/square/projects/{id}/users",
24997     "title": "Gets users permissions from Project",
24998     "examples": [
24999       {
25000         "title": "Example usage:",
25001         "content": "curl https://{domain}/api/square/projects/{id}/users -v -u {name}:{password} -X GET",
25002         "type": "json"
25003       }
25004     ],
25005     "name": "getUsers",
25006     "group": "Square_Projects",
25007     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25008     "version": "0.0.0",
25009     "filename": "server/api/squareProject/index.js",
25010     "groupTitle": "Square_Projects"
25011   },
25012   {
25013     "type": "delete",
25014     "url": "/api/square/projects/{id}/users",
25015     "title": "Removes user permissions from a Project",
25016     "examples": [
25017       {
25018         "title": "Example usage:",
25019         "content": "curl https://{domain}/api/square/projects/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
25020         "type": "json"
25021       }
25022     ],
25023     "name": "removeUsers",
25024     "group": "Square_Projects",
25025     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25026     "version": "0.0.0",
25027     "filename": "server/api/squareProject/index.js",
25028     "groupTitle": "Square_Projects"
25029   },
25030   {
25031     "type": "put",
25032     "url": "/api/square/projects/{id}",
25033     "title": "Update an existing Project",
25034     "examples": [
25035       {
25036         "title": "Example usage:",
25037         "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",
25038         "type": "json"
25039       }
25040     ],
25041     "name": "updateProjects",
25042     "group": "Square_Projects",
25043     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25044     "version": "0.0.0",
25045     "filename": "server/api/squareProject/index.js",
25046     "groupTitle": "Square_Projects"
25047   },
25048   {
25049     "type": "post",
25050     "url": "/api/square/recordings",
25051     "title": "Creates a new Recording",
25052     "examples": [
25053       {
25054         "title": "Example usage:",
25055         "content": "curl https://{domain}/api/square/recordings -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
25056         "type": "json"
25057       }
25058     ],
25059     "name": "CreateRecordings",
25060     "group": "Square_Recordings",
25061     "parameter": {
25062       "fields": {
25063         "Body": [
25064           {
25065             "group": "Body",
25066             "type": "String",
25067             "optional": true,
25068             "field": "uniqueid",
25069             "description": ""
25070           },
25071           {
25072             "group": "Body",
25073             "type": "String",
25074             "optional": true,
25075             "field": "callerid",
25076             "description": ""
25077           },
25078           {
25079             "group": "Body",
25080             "type": "String",
25081             "optional": true,
25082             "field": "calleridname",
25083             "description": ""
25084           },
25085           {
25086             "group": "Body",
25087             "type": "String",
25088             "optional": true,
25089             "field": "context",
25090             "description": ""
25091           },
25092           {
25093             "group": "Body",
25094             "type": "String",
25095             "optional": true,
25096             "field": "extension",
25097             "description": ""
25098           },
25099           {
25100             "group": "Body",
25101             "type": "String",
25102             "optional": true,
25103             "field": "priority",
25104             "description": ""
25105           },
25106           {
25107             "group": "Body",
25108             "type": "String",
25109             "optional": true,
25110             "field": "accountcode",
25111             "description": ""
25112           },
25113           {
25114             "group": "Body",
25115             "type": "String",
25116             "optional": true,
25117             "field": "dnid",
25118             "description": ""
25119           },
25120           {
25121             "group": "Body",
25122             "type": "String",
25123             "optional": true,
25124             "field": "projectName",
25125             "description": ""
25126           },
25127           {
25128             "group": "Body",
25129             "type": "String",
25130             "optional": true,
25131             "field": "saveName",
25132             "description": ""
25133           },
25134           {
25135             "group": "Body",
25136             "type": "String",
25137             "optional": true,
25138             "field": "filename",
25139             "description": ""
25140           },
25141           {
25142             "group": "Body",
25143             "type": "String",
25144             "optional": true,
25145             "field": "savePath",
25146             "description": ""
25147           },
25148           {
25149             "group": "Body",
25150             "type": "Virtual",
25151             "optional": true,
25152             "field": "format",
25153             "description": ""
25154           }
25155         ]
25156       }
25157     },
25158     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25159     "version": "0.0.0",
25160     "filename": "server/api/squareRecording/index.js",
25161     "groupTitle": "Square_Recordings"
25162   },
25163   {
25164     "type": "get",
25165     "url": "/api/square/recordings",
25166     "title": "Gets a list of Recordings",
25167     "examples": [
25168       {
25169         "title": "Example usage:",
25170         "content": "curl https://{domain}/api/square/recordings -v -u {name}:{password}",
25171         "type": "json"
25172       }
25173     ],
25174     "name": "GetRecordings",
25175     "group": "Square_Recordings",
25176     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
25177     "version": "0.0.0",
25178     "filename": "server/api/squareRecording/index.js",
25179     "groupTitle": "Square_Recordings"
25180   },
25181   {
25182     "type": "get",
25183     "url": "/api/square/recordings/{id}",
25184     "title": "Gets a single Recording",
25185     "examples": [
25186       {
25187         "title": "Example usage:",
25188         "content": "curl https://{domain}/api/square/recordings/{id} -v -u {name}:{password}",
25189         "type": "json"
25190       }
25191     ],
25192     "name": "ShowRecordings",
25193     "group": "Square_Recordings",
25194     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25195     "version": "0.0.0",
25196     "filename": "server/api/squareRecording/index.js",
25197     "groupTitle": "Square_Recordings"
25198   },
25199   {
25200     "type": "delete",
25201     "url": "/api/square/recordings/{id}",
25202     "title": "Delete recording",
25203     "examples": [
25204       {
25205         "title": "Example usage:",
25206         "content": "curl https://{domain}/api/square/recordings/{id} -v -u {name}:{password} -X DELETE",
25207         "type": "json"
25208       }
25209     ],
25210     "name": "destroy",
25211     "group": "Square_Recordings",
25212     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25213     "version": "0.0.0",
25214     "filename": "server/api/squareRecording/index.js",
25215     "groupTitle": "Square_Recordings"
25216   },
25217   {
25218     "type": "get",
25219     "url": "/api/square/recordings/{id}/download",
25220     "title": "Download Recording",
25221     "examples": [
25222       {
25223         "title": "Example usage:",
25224         "content": "curl https://{domain}/api/square/recordings/{id}/download -v -u {name}:{password} -X GET",
25225         "type": "json"
25226       }
25227     ],
25228     "name": "download",
25229     "group": "Square_Recordings",
25230     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25231     "version": "0.0.0",
25232     "filename": "server/api/squareRecording/index.js",
25233     "groupTitle": "Square_Recordings"
25234   },
25235   {
25236     "type": "put",
25237     "url": "/api/square/recordings/{id}",
25238     "title": "Update an existing Recording",
25239     "examples": [
25240       {
25241         "title": "Example usage:",
25242         "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",
25243         "type": "json"
25244       }
25245     ],
25246     "name": "updateRecordings",
25247     "group": "Square_Recordings",
25248     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25249     "version": "0.0.0",
25250     "filename": "server/api/squareRecording/index.js",
25251     "groupTitle": "Square_Recordings"
25252   },
25253   {
25254     "type": "post",
25255     "url": "/api/square/reports",
25256     "title": "Creates a new Square Report",
25257     "examples": [
25258       {
25259         "title": "Example usage:",
25260         "content": "curl https://{domain}/api/square/reports -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
25261         "type": "json"
25262       }
25263     ],
25264     "name": "CreateSquare_Reports",
25265     "group": "Square_Reports",
25266     "parameter": {
25267       "fields": {
25268         "Body": [
25269           {
25270             "group": "Body",
25271             "type": "String",
25272             "optional": true,
25273             "field": "network",
25274             "description": ""
25275           },
25276           {
25277             "group": "Body",
25278             "type": "String",
25279             "optional": true,
25280             "field": "network_script",
25281             "description": ""
25282           },
25283           {
25284             "group": "Body",
25285             "type": "String",
25286             "optional": true,
25287             "field": "request",
25288             "description": ""
25289           },
25290           {
25291             "group": "Body",
25292             "type": "String",
25293             "optional": true,
25294             "field": "channel",
25295             "description": ""
25296           },
25297           {
25298             "group": "Body",
25299             "type": "String",
25300             "optional": true,
25301             "field": "language",
25302             "description": ""
25303           },
25304           {
25305             "group": "Body",
25306             "type": "String",
25307             "optional": true,
25308             "field": "type",
25309             "description": ""
25310           },
25311           {
25312             "group": "Body",
25313             "type": "String",
25314             "optional": true,
25315             "field": "uniqueid",
25316             "description": ""
25317           },
25318           {
25319             "group": "Body",
25320             "type": "String",
25321             "optional": true,
25322             "field": "version",
25323             "description": ""
25324           },
25325           {
25326             "group": "Body",
25327             "type": "String",
25328             "optional": true,
25329             "field": "callerid",
25330             "description": ""
25331           },
25332           {
25333             "group": "Body",
25334             "type": "String",
25335             "optional": true,
25336             "field": "calleridname",
25337             "description": ""
25338           },
25339           {
25340             "group": "Body",
25341             "type": "String",
25342             "optional": true,
25343             "field": "callingpres",
25344             "description": ""
25345           },
25346           {
25347             "group": "Body",
25348             "type": "String",
25349             "optional": true,
25350             "field": "callingani2",
25351             "description": ""
25352           },
25353           {
25354             "group": "Body",
25355             "type": "String",
25356             "optional": true,
25357             "field": "callington",
25358             "description": ""
25359           },
25360           {
25361             "group": "Body",
25362             "type": "String",
25363             "optional": true,
25364             "field": "callingtns",
25365             "description": ""
25366           },
25367           {
25368             "group": "Body",
25369             "type": "String",
25370             "optional": true,
25371             "field": "dnid",
25372             "description": ""
25373           },
25374           {
25375             "group": "Body",
25376             "type": "String",
25377             "optional": true,
25378             "field": "rdnis",
25379             "description": ""
25380           },
25381           {
25382             "group": "Body",
25383             "type": "String",
25384             "optional": true,
25385             "field": "context",
25386             "description": ""
25387           },
25388           {
25389             "group": "Body",
25390             "type": "String",
25391             "optional": true,
25392             "field": "extension",
25393             "description": ""
25394           },
25395           {
25396             "group": "Body",
25397             "type": "String",
25398             "optional": true,
25399             "field": "priority",
25400             "description": ""
25401           },
25402           {
25403             "group": "Body",
25404             "type": "String",
25405             "optional": true,
25406             "field": "enhanced",
25407             "description": ""
25408           },
25409           {
25410             "group": "Body",
25411             "type": "String",
25412             "optional": true,
25413             "field": "accountcode",
25414             "description": ""
25415           },
25416           {
25417             "group": "Body",
25418             "type": "String",
25419             "optional": true,
25420             "field": "threadid",
25421             "description": ""
25422           },
25423           {
25424             "group": "Body",
25425             "type": "String",
25426             "optional": true,
25427             "field": "project_name",
25428             "description": ""
25429           },
25430           {
25431             "group": "Body",
25432             "type": "String",
25433             "optional": true,
25434             "field": "joinAt",
25435             "description": ""
25436           },
25437           {
25438             "group": "Body",
25439             "type": "String",
25440             "optional": true,
25441             "field": "leaveAt",
25442             "description": ""
25443           },
25444           {
25445             "group": "Body",
25446             "type": "Boolean",
25447             "optional": true,
25448             "field": "bot",
25449             "description": ""
25450           }
25451         ]
25452       }
25453     },
25454     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25455     "version": "0.0.0",
25456     "filename": "server/api/squareReport/index.js",
25457     "groupTitle": "Square_Reports"
25458   },
25459   {
25460     "type": "delete",
25461     "url": "/api/square/reports/{id}",
25462     "title": "Deletes a Square Report",
25463     "examples": [
25464       {
25465         "title": "Example usage:",
25466         "content": "curl https://{domain}/api/square/reports/{id} -v -u {name}:{password} -X DELETE",
25467         "type": "json"
25468       }
25469     ],
25470     "name": "DeleteSquare_Reports",
25471     "group": "Square_Reports",
25472     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25473     "version": "0.0.0",
25474     "filename": "server/api/squareReport/index.js",
25475     "groupTitle": "Square_Reports"
25476   },
25477   {
25478     "type": "get",
25479     "url": "/api/square/reports/describe",
25480     "title": "Gets table info about Square Reports",
25481     "examples": [
25482       {
25483         "title": "Example usage:",
25484         "content": "curl https://{domain}/api/square/reports/describe -v -u {name}:{password}",
25485         "type": "json"
25486       }
25487     ],
25488     "name": "DescribeSquare_Reports",
25489     "group": "Square_Reports",
25490     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25491     "version": "0.0.0",
25492     "filename": "server/api/squareReport/index.js",
25493     "groupTitle": "Square_Reports"
25494   },
25495   {
25496     "type": "get",
25497     "url": "/api/square/reports",
25498     "title": "Gets a list of Square Reports",
25499     "examples": [
25500       {
25501         "title": "Example usage:",
25502         "content": "curl https://{domain}/api/square/reports -v -u {name}:{password}",
25503         "type": "json"
25504       }
25505     ],
25506     "name": "GetSquare_Reports",
25507     "group": "Square_Reports",
25508     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
25509     "version": "0.0.0",
25510     "filename": "server/api/squareReport/index.js",
25511     "groupTitle": "Square_Reports"
25512   },
25513   {
25514     "type": "get",
25515     "url": "/api/square/reports/{id}",
25516     "title": "Gets a single Square Report",
25517     "examples": [
25518       {
25519         "title": "Example usage:",
25520         "content": "curl https://{domain}/api/square/reports/{id} -v -u {name}:{password}",
25521         "type": "json"
25522       }
25523     ],
25524     "name": "ShowSquare_Reports",
25525     "group": "Square_Reports",
25526     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25527     "version": "0.0.0",
25528     "filename": "server/api/squareReport/index.js",
25529     "groupTitle": "Square_Reports"
25530   },
25531   {
25532     "type": "put",
25533     "url": "/api/square/reports/{id}",
25534     "title": "Update an existing Square Report",
25535     "examples": [
25536       {
25537         "title": "Example usage:",
25538         "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",
25539         "type": "json"
25540       }
25541     ],
25542     "name": "updateSquare_Reports",
25543     "group": "Square_Reports",
25544     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25545     "version": "0.0.0",
25546     "filename": "server/api/squareReport/index.js",
25547     "groupTitle": "Square_Reports"
25548   },
25549   {
25550     "type": "post",
25551     "url": "/api/integrations/sugarcrm/configurations",
25552     "title": "Creates a new SugarCRM Configuration",
25553     "examples": [
25554       {
25555         "title": "Example usage:",
25556         "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",
25557         "type": "json"
25558       }
25559     ],
25560     "name": "CreateSugarCRM_Configurations",
25561     "group": "SugarCRM_Configurations",
25562     "parameter": {
25563       "fields": {
25564         "Body": [
25565           {
25566             "group": "Body",
25567             "type": "String",
25568             "optional": true,
25569             "field": "name",
25570             "description": ""
25571           },
25572           {
25573             "group": "Body",
25574             "type": "String",
25575             "optional": true,
25576             "field": "description",
25577             "description": ""
25578           }
25579         ]
25580       }
25581     },
25582     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25583     "version": "0.0.0",
25584     "filename": "server/api/intSugarcrmConfiguration/index.js",
25585     "groupTitle": "SugarCRM_Configurations"
25586   },
25587   {
25588     "type": "delete",
25589     "url": "/api/integrations/sugarcrm/configurations/{id}",
25590     "title": "Deletes a SugarCRM Configuration",
25591     "examples": [
25592       {
25593         "title": "Example usage:",
25594         "content": "curl https://{domain}/api/integrations/sugarcrm/configurations/{id} -v -u {name}:{password} -X DELETE",
25595         "type": "json"
25596       }
25597     ],
25598     "name": "DeleteSugarCRM_Configurations",
25599     "group": "SugarCRM_Configurations",
25600     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25601     "version": "0.0.0",
25602     "filename": "server/api/intSugarcrmConfiguration/index.js",
25603     "groupTitle": "SugarCRM_Configurations"
25604   },
25605   {
25606     "type": "get",
25607     "url": "/api/integrations/sugarcrm/configurations",
25608     "title": "Gets a list of SugarCRM Configurations",
25609     "examples": [
25610       {
25611         "title": "Example usage:",
25612         "content": "curl https://{domain}/api/integrations/sugarcrm/configurations -v -u {name}:{password}",
25613         "type": "json"
25614       }
25615     ],
25616     "name": "GetSugarCRM_Configurations",
25617     "group": "SugarCRM_Configurations",
25618     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
25619     "version": "0.0.0",
25620     "filename": "server/api/intSugarcrmConfiguration/index.js",
25621     "groupTitle": "SugarCRM_Configurations"
25622   },
25623   {
25624     "type": "get",
25625     "url": "/api/integrations/sugarcrm/configurations/{id}",
25626     "title": "Gets a single SugarCRM Configuration",
25627     "examples": [
25628       {
25629         "title": "Example usage:",
25630         "content": "curl https://{domain}/api/integrations/sugarcrm/configurations/{id} -v -u {name}:{password}",
25631         "type": "json"
25632       }
25633     ],
25634     "name": "ShowSugarCRM_Configurations",
25635     "group": "SugarCRM_Configurations",
25636     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25637     "version": "0.0.0",
25638     "filename": "server/api/intSugarcrmConfiguration/index.js",
25639     "groupTitle": "SugarCRM_Configurations"
25640   },
25641   {
25642     "type": "put",
25643     "url": "/api/integrations/sugarcrm/configurations/{id}",
25644     "title": "Update an existing SugarCRM Configuration",
25645     "examples": [
25646       {
25647         "title": "Example usage:",
25648         "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",
25649         "type": "json"
25650       }
25651     ],
25652     "name": "updateSugarCRM_Configurations",
25653     "group": "SugarCRM_Configurations",
25654     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25655     "version": "0.0.0",
25656     "filename": "server/api/intSugarcrmConfiguration/index.js",
25657     "groupTitle": "SugarCRM_Configurations"
25658   },
25659   {
25660     "type": "post",
25661     "url": "/api/integrations/sugarcrm/accounts",
25662     "title": "Creates a new Sugarcrm Account",
25663     "examples": [
25664       {
25665         "title": "Example usage:",
25666         "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",
25667         "type": "json"
25668       }
25669     ],
25670     "name": "CreateSugarcrm_Accounts",
25671     "group": "Sugarcrm_Accounts",
25672     "parameter": {
25673       "fields": {
25674         "Body": [
25675           {
25676             "group": "Body",
25677             "type": "String",
25678             "optional": true,
25679             "field": "name",
25680             "description": ""
25681           },
25682           {
25683             "group": "Body",
25684             "type": "String",
25685             "optional": true,
25686             "field": "description",
25687             "description": ""
25688           },
25689           {
25690             "group": "Body",
25691             "type": "String",
25692             "optional": true,
25693             "field": "username",
25694             "description": ""
25695           },
25696           {
25697             "group": "Body",
25698             "type": "String",
25699             "optional": true,
25700             "field": "password",
25701             "description": ""
25702           },
25703           {
25704             "group": "Body",
25705             "type": "String",
25706             "optional": true,
25707             "field": "remoteUri",
25708             "description": ""
25709           },
25710           {
25711             "group": "Body",
25712             "type": "String",
25713             "optional": false,
25714             "field": "serverUrl",
25715             "description": ""
25716           }
25717         ]
25718       }
25719     },
25720     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25721     "version": "0.0.0",
25722     "filename": "server/api/intSugarcrmAccount/index.js",
25723     "groupTitle": "Sugarcrm_Accounts"
25724   },
25725   {
25726     "type": "delete",
25727     "url": "/api/integrations/sugarcrm/accounts/{id}",
25728     "title": "Deletes a Sugarcrm Account",
25729     "examples": [
25730       {
25731         "title": "Example usage:",
25732         "content": "curl https://{domain}/api/integrations/sugarcrm/accounts/{id} -v -u {name}:{password} -X DELETE",
25733         "type": "json"
25734       }
25735     ],
25736     "name": "DeleteSugarcrm_Accounts",
25737     "group": "Sugarcrm_Accounts",
25738     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25739     "version": "0.0.0",
25740     "filename": "server/api/intSugarcrmAccount/index.js",
25741     "groupTitle": "Sugarcrm_Accounts"
25742   },
25743   {
25744     "type": "get",
25745     "url": "/api/integrations/sugarcrm/accounts",
25746     "title": "Gets a list of Sugarcrm Accounts",
25747     "examples": [
25748       {
25749         "title": "Example usage:",
25750         "content": "curl https://{domain}/api/integrations/sugarcrm/accounts -v -u {name}:{password}",
25751         "type": "json"
25752       }
25753     ],
25754     "name": "GetSugarcrm_Accounts",
25755     "group": "Sugarcrm_Accounts",
25756     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
25757     "version": "0.0.0",
25758     "filename": "server/api/intSugarcrmAccount/index.js",
25759     "groupTitle": "Sugarcrm_Accounts"
25760   },
25761   {
25762     "type": "get",
25763     "url": "/api/integrations/sugarcrm/accounts/{id}",
25764     "title": "Gets a single Sugarcrm Account",
25765     "examples": [
25766       {
25767         "title": "Example usage:",
25768         "content": "curl https://{domain}/api/integrations/sugarcrm/accounts/{id} -v -u {name}:{password}",
25769         "type": "json"
25770       }
25771     ],
25772     "name": "ShowSugarcrm_Accounts",
25773     "group": "Sugarcrm_Accounts",
25774     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25775     "version": "0.0.0",
25776     "filename": "server/api/intSugarcrmAccount/index.js",
25777     "groupTitle": "Sugarcrm_Accounts"
25778   },
25779   {
25780     "type": "post",
25781     "url": "/api/integrations/sugarcrm/accounts/{id}/configurations",
25782     "title": "Creates new configuration",
25783     "examples": [
25784       {
25785         "title": "Example usage:",
25786         "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",
25787         "type": "json"
25788       }
25789     ],
25790     "name": "addConfiguration",
25791     "group": "Sugarcrm_Accounts",
25792     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25793     "version": "0.0.0",
25794     "filename": "server/api/intSugarcrmAccount/index.js",
25795     "groupTitle": "Sugarcrm_Accounts"
25796   },
25797   {
25798     "type": "get",
25799     "url": "/api/integrations/sugarcrm/accounts/{id}/configurations",
25800     "title": "Gets account configurations",
25801     "examples": [
25802       {
25803         "title": "Example usage:",
25804         "content": "curl https://{domain}/api/integrations/sugarcrm/accounts/{id}/configurations -v -u {name}:{password} -X GET",
25805         "type": "json"
25806       }
25807     ],
25808     "name": "getConfigurations",
25809     "group": "Sugarcrm_Accounts",
25810     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25811     "version": "0.0.0",
25812     "filename": "server/api/intSugarcrmAccount/index.js",
25813     "groupTitle": "Sugarcrm_Accounts"
25814   },
25815   {
25816     "type": "get",
25817     "url": "/api/integrations/sugarcrm/accounts/{id}/fields",
25818     "title": "Gets account fields",
25819     "examples": [
25820       {
25821         "title": "Example usage:",
25822         "content": "curl https://{domain}/api/integrations/sugarcrm/accounts/{id}/fields -v -u {name}:{password} -X GET",
25823         "type": "json"
25824       }
25825     ],
25826     "name": "getFields",
25827     "group": "Sugarcrm_Accounts",
25828     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25829     "version": "0.0.0",
25830     "filename": "server/api/intSugarcrmAccount/index.js",
25831     "groupTitle": "Sugarcrm_Accounts"
25832   },
25833   {
25834     "type": "put",
25835     "url": "/api/integrations/sugarcrm/accounts/{id}",
25836     "title": "Update an existing Sugarcrm Account",
25837     "examples": [
25838       {
25839         "title": "Example usage:",
25840         "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",
25841         "type": "json"
25842       }
25843     ],
25844     "name": "updateSugarcrm_Accounts",
25845     "group": "Sugarcrm_Accounts",
25846     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25847     "version": "0.0.0",
25848     "filename": "server/api/intSugarcrmAccount/index.js",
25849     "groupTitle": "Sugarcrm_Accounts"
25850   },
25851   {
25852     "type": "get",
25853     "url": "/api/integrations/sugarcrm/configurations/{id}/descriptions",
25854     "title": "Gets configurations descriptions",
25855     "examples": [
25856       {
25857         "title": "Example usage:",
25858         "content": "curl https://{domain}/api/integrations/sugarcrm/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
25859         "type": "json"
25860       }
25861     ],
25862     "name": "getDescriptions",
25863     "group": "Sugarcrm_Configurations",
25864     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25865     "version": "0.0.0",
25866     "filename": "server/api/intSugarcrmConfiguration/index.js",
25867     "groupTitle": "Sugarcrm_Configurations"
25868   },
25869   {
25870     "type": "get",
25871     "url": "/api/integrations/sugarcrm/configurations/{id}/fields",
25872     "title": "Gets configurations fields",
25873     "examples": [
25874       {
25875         "title": "Example usage:",
25876         "content": "curl https://{domain}/api/integrations/sugarcrm/configurations/{id}/fields -v -u {name}:{password} -X GET",
25877         "type": "json"
25878       }
25879     ],
25880     "name": "getFields",
25881     "group": "Sugarcrm_Configurations",
25882     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25883     "version": "0.0.0",
25884     "filename": "server/api/intSugarcrmConfiguration/index.js",
25885     "groupTitle": "Sugarcrm_Configurations"
25886   },
25887   {
25888     "type": "get",
25889     "url": "/api/integrations/sugarcrm/configurations/{id}/subjects",
25890     "title": "Gets configurations subjects",
25891     "examples": [
25892       {
25893         "title": "Example usage:",
25894         "content": "curl https://{domain}/api/integrations/sugarcrm/configurations/{id}/subjects -v -u {name}:{password} -X GET",
25895         "type": "json"
25896       }
25897     ],
25898     "name": "getSubjects",
25899     "group": "Sugarcrm_Configurations",
25900     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25901     "version": "0.0.0",
25902     "filename": "server/api/intSugarcrmConfiguration/index.js",
25903     "groupTitle": "Sugarcrm_Configurations"
25904   },
25905   {
25906     "type": "post",
25907     "url": "/api/integrations/sugarcrm/fields",
25908     "title": "Creates a new Sugarcrm Field",
25909     "examples": [
25910       {
25911         "title": "Example usage:",
25912         "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",
25913         "type": "json"
25914       }
25915     ],
25916     "name": "CreateSugarcrm_Fields",
25917     "group": "Sugarcrm_Fields",
25918     "parameter": {
25919       "fields": {
25920         "Body": [
25921           {
25922             "group": "Body",
25923             "type": "String",
25924             "allowedValues": [
25925               "\"string\"",
25926               "\"variable\"",
25927               "\"customVariable\"",
25928               "\"keyValue\"",
25929               "\"picklist\""
25930             ],
25931             "optional": true,
25932             "field": "type",
25933             "description": ""
25934           },
25935           {
25936             "group": "Body",
25937             "type": "String",
25938             "optional": true,
25939             "field": "content",
25940             "description": ""
25941           },
25942           {
25943             "group": "Body",
25944             "type": "String",
25945             "optional": true,
25946             "field": "key",
25947             "description": ""
25948           },
25949           {
25950             "group": "Body",
25951             "type": "String",
25952             "allowedValues": [
25953               "\"string\"",
25954               "\"variable\"",
25955               "\"customVariable\""
25956             ],
25957             "optional": true,
25958             "field": "keyType",
25959             "description": ""
25960           },
25961           {
25962             "group": "Body",
25963             "type": "String",
25964             "optional": true,
25965             "field": "keyContent",
25966             "description": ""
25967           },
25968           {
25969             "group": "Body",
25970             "type": "String",
25971             "optional": true,
25972             "field": "idField",
25973             "description": ""
25974           },
25975           {
25976             "group": "Body",
25977             "type": "String",
25978             "optional": true,
25979             "field": "nameField",
25980             "description": ""
25981           },
25982           {
25983             "group": "Body",
25984             "type": "Boolean",
25985             "optional": true,
25986             "field": "customField",
25987             "description": ""
25988           },
25989           {
25990             "group": "Body",
25991             "type": "String",
25992             "optional": true,
25993             "field": "variableName",
25994             "description": ""
25995           }
25996         ]
25997       }
25998     },
25999     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26000     "version": "0.0.0",
26001     "filename": "server/api/intSugarcrmField/index.js",
26002     "groupTitle": "Sugarcrm_Fields"
26003   },
26004   {
26005     "type": "delete",
26006     "url": "/api/integrations/sugarcrm/fields/{id}",
26007     "title": "Deletes a Sugarcrm Field",
26008     "examples": [
26009       {
26010         "title": "Example usage:",
26011         "content": "curl https://{domain}/api/integrations/sugarcrm/fields/{id} -v -u {name}:{password} -X DELETE",
26012         "type": "json"
26013       }
26014     ],
26015     "name": "DeleteSugarcrm_Fields",
26016     "group": "Sugarcrm_Fields",
26017     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26018     "version": "0.0.0",
26019     "filename": "server/api/intSugarcrmField/index.js",
26020     "groupTitle": "Sugarcrm_Fields"
26021   },
26022   {
26023     "type": "get",
26024     "url": "/api/integrations/sugarcrm/fields",
26025     "title": "Gets a list of Sugarcrm Fields",
26026     "examples": [
26027       {
26028         "title": "Example usage:",
26029         "content": "curl https://{domain}/api/integrations/sugarcrm/fields -v -u {name}:{password}",
26030         "type": "json"
26031       }
26032     ],
26033     "name": "GetSugarcrm_Fields",
26034     "group": "Sugarcrm_Fields",
26035     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
26036     "version": "0.0.0",
26037     "filename": "server/api/intSugarcrmField/index.js",
26038     "groupTitle": "Sugarcrm_Fields"
26039   },
26040   {
26041     "type": "get",
26042     "url": "/api/integrations/sugarcrm/fields/{id}",
26043     "title": "Gets a single Sugarcrm Field",
26044     "examples": [
26045       {
26046         "title": "Example usage:",
26047         "content": "curl https://{domain}/api/integrations/sugarcrm/fields/{id} -v -u {name}:{password}",
26048         "type": "json"
26049       }
26050     ],
26051     "name": "ShowSugarcrm_Fields",
26052     "group": "Sugarcrm_Fields",
26053     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26054     "version": "0.0.0",
26055     "filename": "server/api/intSugarcrmField/index.js",
26056     "groupTitle": "Sugarcrm_Fields"
26057   },
26058   {
26059     "type": "put",
26060     "url": "/api/integrations/sugarcrm/fields/{id}",
26061     "title": "Update an existing Sugarcrm Field",
26062     "examples": [
26063       {
26064         "title": "Example usage:",
26065         "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",
26066         "type": "json"
26067       }
26068     ],
26069     "name": "updateSugarcrm_Fields",
26070     "group": "Sugarcrm_Fields",
26071     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26072     "version": "0.0.0",
26073     "filename": "server/api/intSugarcrmField/index.js",
26074     "groupTitle": "Sugarcrm_Fields"
26075   },
26076   {
26077     "type": "get",
26078     "url": "/api/system",
26079     "title": "Gets system information",
26080     "examples": [
26081       {
26082         "title": "Example usage:",
26083         "content": "curl https://{domain}/api/system -v -u {name}:{password}",
26084         "type": "json"
26085       }
26086     ],
26087     "name": "GetSystemInformation",
26088     "group": "System_Information",
26089     "description": "<p>Motion returns the system information.</p>",
26090     "version": "0.0.0",
26091     "filename": "server/api/system/index.js",
26092     "groupTitle": "System_Information"
26093   },
26094   {
26095     "type": "get",
26096     "url": "/api/system/process",
26097     "title": "Gets system information",
26098     "examples": [
26099       {
26100         "title": "Example usage:",
26101         "content": "curl https://{domain}/api/system -v -u {name}:{password}",
26102         "type": "json"
26103       }
26104     ],
26105     "name": "GetSystemInformation",
26106     "group": "System_Information",
26107     "description": "<p>Motion returns the system information.</p>",
26108     "version": "0.0.0",
26109     "filename": "server/api/system/index.js",
26110     "groupTitle": "System_Information"
26111   },
26112   {
26113     "type": "post",
26114     "url": "/api/tags",
26115     "title": "Creates a new Tag",
26116     "examples": [
26117       {
26118         "title": "Example usage:",
26119         "content": "curl https://{domain}/api/tags -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
26120         "type": "json"
26121       }
26122     ],
26123     "name": "CreateTags",
26124     "group": "Tags",
26125     "parameter": {
26126       "fields": {
26127         "Body": [
26128           {
26129             "group": "Body",
26130             "type": "String",
26131             "optional": false,
26132             "field": "name",
26133             "description": ""
26134           },
26135           {
26136             "group": "Body",
26137             "type": "String",
26138             "optional": true,
26139             "field": "color",
26140             "description": ""
26141           },
26142           {
26143             "group": "Body",
26144             "type": "String",
26145             "optional": true,
26146             "field": "description",
26147             "description": ""
26148           }
26149         ]
26150       }
26151     },
26152     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26153     "version": "0.0.0",
26154     "filename": "server/api/tag/index.js",
26155     "groupTitle": "Tags"
26156   },
26157   {
26158     "type": "delete",
26159     "url": "/api/tags/{id}",
26160     "title": "Deletes a Tag",
26161     "examples": [
26162       {
26163         "title": "Example usage:",
26164         "content": "curl https://{domain}/api/tags/{id} -v -u {name}:{password} -X DELETE",
26165         "type": "json"
26166       }
26167     ],
26168     "name": "DeleteTags",
26169     "group": "Tags",
26170     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26171     "version": "0.0.0",
26172     "filename": "server/api/tag/index.js",
26173     "groupTitle": "Tags"
26174   },
26175   {
26176     "type": "get",
26177     "url": "/api/tags",
26178     "title": "Gets a list of Tags",
26179     "examples": [
26180       {
26181         "title": "Example usage:",
26182         "content": "curl https://{domain}/api/tags -v -u {name}:{password}",
26183         "type": "json"
26184       }
26185     ],
26186     "name": "GetTags",
26187     "group": "Tags",
26188     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
26189     "version": "0.0.0",
26190     "filename": "server/api/tag/index.js",
26191     "groupTitle": "Tags"
26192   },
26193   {
26194     "type": "get",
26195     "url": "/api/tags/{id}",
26196     "title": "Gets a single Tag",
26197     "examples": [
26198       {
26199         "title": "Example usage:",
26200         "content": "curl https://{domain}/api/tags/{id} -v -u {name}:{password}",
26201         "type": "json"
26202       }
26203     ],
26204     "name": "ShowTags",
26205     "group": "Tags",
26206     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26207     "version": "0.0.0",
26208     "filename": "server/api/tag/index.js",
26209     "groupTitle": "Tags"
26210   },
26211   {
26212     "type": "put",
26213     "url": "/api/tags/{id}",
26214     "title": "Update an existing Tag",
26215     "examples": [
26216       {
26217         "title": "Example usage:",
26218         "content": "curl https://{domain}/api/tags/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
26219         "type": "json"
26220       }
26221     ],
26222     "name": "updateTags",
26223     "group": "Tags",
26224     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26225     "version": "0.0.0",
26226     "filename": "server/api/tag/index.js",
26227     "groupTitle": "Tags"
26228   },
26229   {
26230     "type": "post",
26231     "url": "/api/teams/{id}/queues",
26232     "title": "Add queues to a team",
26233     "examples": [
26234       {
26235         "title": "Example usage:",
26236         "content": "curl https://{domain}/api/teams/{id}/queues -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
26237         "type": "json"
26238       }
26239     ],
26240     "name": "AddQueues",
26241     "group": "Teams",
26242     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26243     "version": "0.0.0",
26244     "filename": "server/api/team/index.js",
26245     "groupTitle": "Teams"
26246   },
26247   {
26248     "type": "post",
26249     "url": "/api/teams",
26250     "title": "Creates a new Team",
26251     "examples": [
26252       {
26253         "title": "Example usage:",
26254         "content": "curl https://{domain}/api/teams -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
26255         "type": "json"
26256       }
26257     ],
26258     "name": "CreateTeams",
26259     "group": "Teams",
26260     "parameter": {
26261       "fields": {
26262         "Body": [
26263           {
26264             "group": "Body",
26265             "type": "String",
26266             "optional": false,
26267             "field": "name",
26268             "description": ""
26269           },
26270           {
26271             "group": "Body",
26272             "type": "String",
26273             "optional": true,
26274             "field": "description",
26275             "description": ""
26276           }
26277         ]
26278       }
26279     },
26280     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26281     "version": "0.0.0",
26282     "filename": "server/api/team/index.js",
26283     "groupTitle": "Teams"
26284   },
26285   {
26286     "type": "delete",
26287     "url": "/api/teams/{id}",
26288     "title": "Deletes a Team",
26289     "examples": [
26290       {
26291         "title": "Example usage:",
26292         "content": "curl https://{domain}/api/teams/{id} -v -u {name}:{password} -X DELETE",
26293         "type": "json"
26294       }
26295     ],
26296     "name": "DeleteTeams",
26297     "group": "Teams",
26298     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26299     "version": "0.0.0",
26300     "filename": "server/api/team/index.js",
26301     "groupTitle": "Teams"
26302   },
26303   {
26304     "type": "get",
26305     "url": "/api/teams/{id}/users",
26306     "title": "Gets agents from team",
26307     "examples": [
26308       {
26309         "title": "Example usage:",
26310         "content": "curl https://{domain}/api/teams/{id}/users -v -u {name}:{password} -X GET",
26311         "type": "json"
26312       }
26313     ],
26314     "name": "GetAgents",
26315     "group": "Teams",
26316     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26317     "version": "0.0.0",
26318     "filename": "server/api/team/index.js",
26319     "groupTitle": "Teams"
26320   },
26321   {
26322     "type": "get",
26323     "url": "/api/teams/{id}/queues?channel={channel}",
26324     "title": "Gets Queues list",
26325     "examples": [
26326       {
26327         "title": "Example usage:",
26328         "content": "curl https://{domain}/api/teams/{id}/queues?channel={channel} -v -u {name}:{password}",
26329         "type": "json"
26330       }
26331     ],
26332     "name": "GetQueues",
26333     "group": "Teams",
26334     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26335     "version": "0.0.0",
26336     "filename": "server/api/team/index.js",
26337     "groupTitle": "Teams"
26338   },
26339   {
26340     "type": "get",
26341     "url": "/api/teams",
26342     "title": "Gets a list of Teams",
26343     "examples": [
26344       {
26345         "title": "Example usage:",
26346         "content": "curl https://{domain}/api/teams -v -u {name}:{password}",
26347         "type": "json"
26348       }
26349     ],
26350     "name": "GetTeams",
26351     "group": "Teams",
26352     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
26353     "version": "0.0.0",
26354     "filename": "server/api/team/index.js",
26355     "groupTitle": "Teams"
26356   },
26357   {
26358     "type": "delete",
26359     "url": "/api/teams/{id}/users",
26360     "title": "Removes agents from a team",
26361     "examples": [
26362       {
26363         "title": "Example usage:",
26364         "content": "curl https://{domain}/api/teams/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
26365         "type": "json"
26366       }
26367     ],
26368     "name": "RemoveAgents",
26369     "group": "Teams",
26370     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26371     "version": "0.0.0",
26372     "filename": "server/api/team/index.js",
26373     "groupTitle": "Teams"
26374   },
26375   {
26376     "type": "delete",
26377     "url": "/api/teams/{id}/queues",
26378     "title": "Remove queues to a team",
26379     "examples": [
26380       {
26381         "title": "Example usage:",
26382         "content": "curl https://{domain}/api/teams/{id}/queues?channel=voice&ids=1&ids=2 -v -u {name}:{password} -X DELETE",
26383         "type": "json"
26384       }
26385     ],
26386     "name": "RemoveQueues",
26387     "group": "Teams",
26388     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26389     "version": "0.0.0",
26390     "filename": "server/api/team/index.js",
26391     "groupTitle": "Teams"
26392   },
26393   {
26394     "type": "delete",
26395     "url": "/api/openchannel/queues/{id}/teams",
26396     "title": "Remove teams from a queue",
26397     "examples": [
26398       {
26399         "title": "Example usage:",
26400         "content": "curl https://{domain}/api/openchannel/queues/{id}/teams -v -u {name}:{password} -X DELETE",
26401         "type": "json"
26402       }
26403     ],
26404     "name": "RemoveTeams",
26405     "group": "Teams",
26406     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26407     "version": "0.0.0",
26408     "filename": "server/api/openchannelQueue/index.js",
26409     "groupTitle": "Teams"
26410   },
26411   {
26412     "type": "delete",
26413     "url": "/api/voice/queues/{id}/teams",
26414     "title": "Remove teams from a queue",
26415     "examples": [
26416       {
26417         "title": "Example usage:",
26418         "content": "curl https://{domain}/api/voice/queues/{id}/teams -v -u {name}:{password} -X DELETE",
26419         "type": "json"
26420       }
26421     ],
26422     "name": "RemoveTeams",
26423     "group": "Teams",
26424     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26425     "version": "0.0.0",
26426     "filename": "server/api/voiceQueue/index.js",
26427     "groupTitle": "Teams"
26428   },
26429   {
26430     "type": "delete",
26431     "url": "/api/voice/Prefixes/{id}/teams",
26432     "title": "Remove teams from a voice prefix",
26433     "examples": [
26434       {
26435         "title": "Example usage:",
26436         "content": "curl https://{domain}/api/voice/prefixes/{id}/teams -v -u {name}:{password} -X DELETE",
26437         "type": "json"
26438       }
26439     ],
26440     "name": "RemoveTeams",
26441     "group": "Teams",
26442     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26443     "version": "0.0.0",
26444     "filename": "server/api/voicePrefix/index.js",
26445     "groupTitle": "Teams"
26446   },
26447   {
26448     "type": "delete",
26449     "url": "/api/sms/queues/{id}/teams",
26450     "title": "Remove teams from a queue",
26451     "examples": [
26452       {
26453         "title": "Example usage:",
26454         "content": "curl https://{domain}/api/sms/queues/{id}/teams -v -u {name}:{password} -X DELETE",
26455         "type": "json"
26456       }
26457     ],
26458     "name": "RemoveTeams",
26459     "group": "Teams",
26460     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26461     "version": "0.0.0",
26462     "filename": "server/api/smsQueue/index.js",
26463     "groupTitle": "Teams"
26464   },
26465   {
26466     "type": "delete",
26467     "url": "/api/whatsapp/queues/{id}/teams",
26468     "title": "Remove teams from a queue",
26469     "examples": [
26470       {
26471         "title": "Example usage:",
26472         "content": "curl https://{domain}/api/whatsapp/queues/{id}/teams -v -u {name}:{password} -X DELETE",
26473         "type": "json"
26474       }
26475     ],
26476     "name": "RemoveTeams",
26477     "group": "Teams",
26478     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26479     "version": "0.0.0",
26480     "filename": "server/api/whatsappQueue/index.js",
26481     "groupTitle": "Teams"
26482   },
26483   {
26484     "type": "delete",
26485     "url": "/api/chat/queues/{id}/teams",
26486     "title": "Remove teams from a queue",
26487     "examples": [
26488       {
26489         "title": "Example usage:",
26490         "content": "curl https://{domain}/api/chat/queues/{id}/teams -v -u {name}:{password} -X DELETE",
26491         "type": "json"
26492       }
26493     ],
26494     "name": "RemoveTeams",
26495     "group": "Teams",
26496     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26497     "version": "0.0.0",
26498     "filename": "server/api/chatQueue/index.js",
26499     "groupTitle": "Teams"
26500   },
26501   {
26502     "type": "delete",
26503     "url": "/api/mail/queues/{id}/teams",
26504     "title": "Remove teams from a queue",
26505     "examples": [
26506       {
26507         "title": "Example usage:",
26508         "content": "curl https://{domain}/api/mail/queues/{id}/teams -v -u {name}:{password} -X DELETE",
26509         "type": "json"
26510       }
26511     ],
26512     "name": "RemoveTeams",
26513     "group": "Teams",
26514     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26515     "version": "0.0.0",
26516     "filename": "server/api/mailQueue/index.js",
26517     "groupTitle": "Teams"
26518   },
26519   {
26520     "type": "delete",
26521     "url": "/api/fax/queues/{id}/teams",
26522     "title": "Remove teams from a queue",
26523     "examples": [
26524       {
26525         "title": "Example usage:",
26526         "content": "curl https://{domain}/api/fax/queues/{id}/teams -v -u {name}:{password} -X DELETE",
26527         "type": "json"
26528       }
26529     ],
26530     "name": "RemoveTeams",
26531     "group": "Teams",
26532     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26533     "version": "0.0.0",
26534     "filename": "server/api/faxQueue/index.js",
26535     "groupTitle": "Teams"
26536   },
26537   {
26538     "type": "get",
26539     "url": "/api/teams/{id}",
26540     "title": "Gets a single Team",
26541     "examples": [
26542       {
26543         "title": "Example usage:",
26544         "content": "curl https://{domain}/api/teams/{id} -v -u {name}:{password}",
26545         "type": "json"
26546       }
26547     ],
26548     "name": "ShowTeams",
26549     "group": "Teams",
26550     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26551     "version": "0.0.0",
26552     "filename": "server/api/team/index.js",
26553     "groupTitle": "Teams"
26554   },
26555   {
26556     "type": "post",
26557     "url": "/api/teams/{id}/users",
26558     "title": "Adds agents to a team",
26559     "examples": [
26560       {
26561         "title": "Example usage:",
26562         "content": "curl https://{domain}/api/teams/{id}/users -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
26563         "type": "json"
26564       }
26565     ],
26566     "name": "addAgents",
26567     "group": "Teams",
26568     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26569     "version": "0.0.0",
26570     "filename": "server/api/team/index.js",
26571     "groupTitle": "Teams"
26572   },
26573   {
26574     "type": "put",
26575     "url": "/api/teams/{id}",
26576     "title": "Update an existing Team",
26577     "examples": [
26578       {
26579         "title": "Example usage:",
26580         "content": "curl https://{domain}/api/teams/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
26581         "type": "json"
26582       }
26583     ],
26584     "name": "updateTeams",
26585     "group": "Teams",
26586     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26587     "version": "0.0.0",
26588     "filename": "server/api/team/index.js",
26589     "groupTitle": "Teams"
26590   },
26591   {
26592     "type": "post",
26593     "url": "/api/templates",
26594     "title": "Creates a new Template",
26595     "examples": [
26596       {
26597         "title": "Example usage:",
26598         "content": "curl https://{domain}/api/templates -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
26599         "type": "json"
26600       }
26601     ],
26602     "name": "CreateTemplates",
26603     "group": "Templates",
26604     "parameter": {
26605       "fields": {
26606         "Body": [
26607           {
26608             "group": "Body",
26609             "type": "String",
26610             "optional": true,
26611             "field": "name",
26612             "description": ""
26613           },
26614           {
26615             "group": "Body",
26616             "type": "String",
26617             "optional": true,
26618             "field": "description",
26619             "description": ""
26620           },
26621           {
26622             "group": "Body",
26623             "type": "Text",
26624             "optional": true,
26625             "field": "html",
26626             "description": ""
26627           }
26628         ]
26629       }
26630     },
26631     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26632     "version": "0.0.0",
26633     "filename": "server/api/template/index.js",
26634     "groupTitle": "Templates"
26635   },
26636   {
26637     "type": "delete",
26638     "url": "/api/templates/{id}",
26639     "title": "Deletes a Template",
26640     "examples": [
26641       {
26642         "title": "Example usage:",
26643         "content": "curl https://{domain}/api/templates/{id} -v -u {name}:{password} -X DELETE",
26644         "type": "json"
26645       }
26646     ],
26647     "name": "DeleteTemplates",
26648     "group": "Templates",
26649     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26650     "version": "0.0.0",
26651     "filename": "server/api/template/index.js",
26652     "groupTitle": "Templates"
26653   },
26654   {
26655     "type": "get",
26656     "url": "/api/templates",
26657     "title": "Gets a list of Templates",
26658     "examples": [
26659       {
26660         "title": "Example usage:",
26661         "content": "curl https://{domain}/api/templates -v -u {name}:{password}",
26662         "type": "json"
26663       }
26664     ],
26665     "name": "GetTemplates",
26666     "group": "Templates",
26667     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
26668     "version": "0.0.0",
26669     "filename": "server/api/template/index.js",
26670     "groupTitle": "Templates"
26671   },
26672   {
26673     "type": "get",
26674     "url": "/api/templates/{id}",
26675     "title": "Gets a single Template",
26676     "examples": [
26677       {
26678         "title": "Example usage:",
26679         "content": "curl https://{domain}/api/templates/{id} -v -u {name}:{password}",
26680         "type": "json"
26681       }
26682     ],
26683     "name": "ShowTemplates",
26684     "group": "Templates",
26685     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26686     "version": "0.0.0",
26687     "filename": "server/api/template/index.js",
26688     "groupTitle": "Templates"
26689   },
26690   {
26691     "type": "put",
26692     "url": "/api/templates/{id}",
26693     "title": "Update an existing Template",
26694     "examples": [
26695       {
26696         "title": "Example usage:",
26697         "content": "curl https://{domain}/api/templates/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
26698         "type": "json"
26699       }
26700     ],
26701     "name": "updateTemplates",
26702     "group": "Templates",
26703     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26704     "version": "0.0.0",
26705     "filename": "server/api/template/index.js",
26706     "groupTitle": "Templates"
26707   },
26708   {
26709     "type": "post",
26710     "url": "/api/triggers",
26711     "title": "Creates a new Trigger",
26712     "examples": [
26713       {
26714         "title": "Example usage:",
26715         "content": "curl https://{domain}/api/triggers -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
26716         "type": "json"
26717       }
26718     ],
26719     "name": "CreateTriggers",
26720     "group": "Triggers",
26721     "parameter": {
26722       "fields": {
26723         "Body": [
26724           {
26725             "group": "Body",
26726             "type": "String",
26727             "optional": true,
26728             "field": "name",
26729             "description": ""
26730           },
26731           {
26732             "group": "Body",
26733             "type": "String",
26734             "optional": true,
26735             "field": "channel",
26736             "description": ""
26737           },
26738           {
26739             "group": "Body",
26740             "type": "String",
26741             "optional": true,
26742             "field": "description",
26743             "description": ""
26744           },
26745           {
26746             "group": "Body",
26747             "type": "Boolean",
26748             "optional": true,
26749             "field": "status",
26750             "description": ""
26751           }
26752         ]
26753       }
26754     },
26755     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26756     "version": "0.0.0",
26757     "filename": "server/api/trigger/index.js",
26758     "groupTitle": "Triggers"
26759   },
26760   {
26761     "type": "delete",
26762     "url": "/api/triggers/{id}",
26763     "title": "Deletes a Trigger",
26764     "examples": [
26765       {
26766         "title": "Example usage:",
26767         "content": "curl https://{domain}/api/triggers/{id} -v -u {name}:{password} -X DELETE",
26768         "type": "json"
26769       }
26770     ],
26771     "name": "DeleteTriggers",
26772     "group": "Triggers",
26773     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26774     "version": "0.0.0",
26775     "filename": "server/api/trigger/index.js",
26776     "groupTitle": "Triggers"
26777   },
26778   {
26779     "type": "get",
26780     "url": "/api/triggers",
26781     "title": "Gets a list of Triggers",
26782     "examples": [
26783       {
26784         "title": "Example usage:",
26785         "content": "curl https://{domain}/api/triggers -v -u {name}:{password}",
26786         "type": "json"
26787       }
26788     ],
26789     "name": "GetTriggers",
26790     "group": "Triggers",
26791     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
26792     "version": "0.0.0",
26793     "filename": "server/api/trigger/index.js",
26794     "groupTitle": "Triggers"
26795   },
26796   {
26797     "type": "get",
26798     "url": "/api/triggers/{id}",
26799     "title": "Gets a single Trigger",
26800     "examples": [
26801       {
26802         "title": "Example usage:",
26803         "content": "curl https://{domain}/api/triggers/{id} -v -u {name}:{password}",
26804         "type": "json"
26805       }
26806     ],
26807     "name": "ShowTriggers",
26808     "group": "Triggers",
26809     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26810     "version": "0.0.0",
26811     "filename": "server/api/trigger/index.js",
26812     "groupTitle": "Triggers"
26813   },
26814   {
26815     "type": "post",
26816     "url": "/api/triggers/{id}/actions",
26817     "title": "Creates new actions",
26818     "examples": [
26819       {
26820         "title": "Example usage:",
26821         "content": "curl https://{domain}/api/triggers/{id}/actions -d '{\"action\": \"contactManager\",\"data1\": \"1\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
26822         "type": "json"
26823       }
26824     ],
26825     "name": "addAction",
26826     "group": "Triggers",
26827     "parameter": {
26828       "fields": {
26829         "Body": [
26830           {
26831             "group": "Body",
26832             "type": "Virtual",
26833             "optional": true,
26834             "field": "name",
26835             "description": ""
26836           },
26837           {
26838             "group": "Body",
26839             "type": "String",
26840             "optional": false,
26841             "field": "action",
26842             "description": "<p>Allowed values: contactManager, integration, motionbar, jscripty, urlForward, browser, bot, script</p>"
26843           },
26844           {
26845             "group": "Body",
26846             "type": "String",
26847             "optional": true,
26848             "field": "data1",
26849             "description": "<p>contactManager[ListId], integration[intName(zendesk)], motionbar[Popup(0),URL(1),WinApp(2)], urlForward[GET,POST], browser[TemplateId(0),URL(1)]</p>"
26850           },
26851           {
26852             "group": "Body",
26853             "type": "String",
26854             "optional": true,
26855             "field": "data2",
26856             "description": "<p>integration[AccountId], motionbar[TemplateId,URL,WinAppPath], urlForward[URL]</p>"
26857           },
26858           {
26859             "group": "Body",
26860             "type": "String",
26861             "optional": true,
26862             "field": "data3",
26863             "description": "<p>motionbar[NULL,NULL,WinAppArguments]</p>"
26864           },
26865           {
26866             "group": "Body",
26867             "type": "String",
26868             "optional": true,
26869             "field": "data4",
26870             "description": ""
26871           },
26872           {
26873             "group": "Body",
26874             "type": "String",
26875             "optional": true,
26876             "field": "data5",
26877             "description": ""
26878           },
26879           {
26880             "group": "Body",
26881             "type": "String",
26882             "optional": true,
26883             "field": "data6",
26884             "description": ""
26885           },
26886           {
26887             "group": "Body",
26888             "type": "Text",
26889             "optional": true,
26890             "field": "data7",
26891             "description": ""
26892           }
26893         ]
26894       }
26895     },
26896     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26897     "version": "0.0.0",
26898     "filename": "server/api/trigger/index.js",
26899     "groupTitle": "Triggers"
26900   },
26901   {
26902     "type": "post",
26903     "url": "/api/triggers/{id}/all_conditions",
26904     "title": "Creates a new \"AND\"condition",
26905     "examples": [
26906       {
26907         "title": "Example usage:",
26908         "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",
26909         "type": "json"
26910       }
26911     ],
26912     "name": "addAllCondition",
26913     "group": "Triggers",
26914     "parameter": {
26915       "fields": {
26916         "Body": [
26917           {
26918             "group": "Body",
26919             "type": "Virtual",
26920             "optional": true,
26921             "field": "name",
26922             "description": ""
26923           },
26924           {
26925             "group": "Body",
26926             "type": "String",
26927             "optional": false,
26928             "field": "field",
26929             "description": ""
26930           },
26931           {
26932             "group": "Body",
26933             "type": "String",
26934             "optional": false,
26935             "field": "operator",
26936             "description": ""
26937           },
26938           {
26939             "group": "Body",
26940             "type": "String",
26941             "optional": false,
26942             "field": "value",
26943             "description": ""
26944           }
26945         ]
26946       }
26947     },
26948     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26949     "version": "0.0.0",
26950     "filename": "server/api/trigger/index.js",
26951     "groupTitle": "Triggers"
26952   },
26953   {
26954     "type": "post",
26955     "url": "/api/triggers/{id}/any_conditions",
26956     "title": "Creates a new \"OR\"condition",
26957     "examples": [
26958       {
26959         "title": "Example usage:",
26960         "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",
26961         "type": "json"
26962       }
26963     ],
26964     "name": "addAnyCondition",
26965     "group": "Triggers",
26966     "parameter": {
26967       "fields": {
26968         "Body": [
26969           {
26970             "group": "Body",
26971             "type": "Virtual",
26972             "optional": true,
26973             "field": "name",
26974             "description": ""
26975           },
26976           {
26977             "group": "Body",
26978             "type": "String",
26979             "optional": false,
26980             "field": "field",
26981             "description": ""
26982           },
26983           {
26984             "group": "Body",
26985             "type": "String",
26986             "optional": false,
26987             "field": "operator",
26988             "description": ""
26989           },
26990           {
26991             "group": "Body",
26992             "type": "String",
26993             "optional": false,
26994             "field": "value",
26995             "description": ""
26996           }
26997         ]
26998       }
26999     },
27000     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27001     "version": "0.0.0",
27002     "filename": "server/api/trigger/index.js",
27003     "groupTitle": "Triggers"
27004   },
27005   {
27006     "type": "get",
27007     "url": "/api/triggers/{id}/actions",
27008     "title": "Gets Trigger Actions",
27009     "examples": [
27010       {
27011         "title": "Example usage:",
27012         "content": "curl https://{domain}/api/triggers/{id}/actions -v -u {name}:{password} -X GET",
27013         "type": "json"
27014       }
27015     ],
27016     "name": "getActions",
27017     "group": "Triggers",
27018     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27019     "version": "0.0.0",
27020     "filename": "server/api/trigger/index.js",
27021     "groupTitle": "Triggers"
27022   },
27023   {
27024     "type": "get",
27025     "url": "/api/triggers/{id}/all_conditions",
27026     "title": "Gets \"AND\" Trigger Conditions",
27027     "examples": [
27028       {
27029         "title": "Example usage:",
27030         "content": "curl https://{domain}/api/triggers/{id}/all_conditions -v -u {name}:{password} -X GET",
27031         "type": "json"
27032       }
27033     ],
27034     "name": "getAllConditions",
27035     "group": "Triggers",
27036     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27037     "version": "0.0.0",
27038     "filename": "server/api/trigger/index.js",
27039     "groupTitle": "Triggers"
27040   },
27041   {
27042     "type": "get",
27043     "url": "/api/triggers/{id}/any_conditions",
27044     "title": "Gets \"OR\" Trigger Conditions",
27045     "examples": [
27046       {
27047         "title": "Example usage:",
27048         "content": "curl https://{domain}/api/triggers/{id}/any_conditions -v -u {name}:{password} -X GET",
27049         "type": "json"
27050       }
27051     ],
27052     "name": "getAnyConditions",
27053     "group": "Triggers",
27054     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27055     "version": "0.0.0",
27056     "filename": "server/api/trigger/index.js",
27057     "groupTitle": "Triggers"
27058   },
27059   {
27060     "type": "put",
27061     "url": "/api/triggers/{id}",
27062     "title": "Update an existing Trigger",
27063     "examples": [
27064       {
27065         "title": "Example usage:",
27066         "content": "curl https://{domain}/api/triggers/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
27067         "type": "json"
27068       }
27069     ],
27070     "name": "updateTriggers",
27071     "group": "Triggers",
27072     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27073     "version": "0.0.0",
27074     "filename": "server/api/trigger/index.js",
27075     "groupTitle": "Triggers"
27076   },
27077   {
27078     "type": "post",
27079     "url": "/api/trunks/clone",
27080     "title": "Clone an existing Trunk",
27081     "examples": [
27082       {
27083         "title": "Example usage:",
27084         "content": "curl https://{domain}/api/trunks/clone -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
27085         "type": "json"
27086       }
27087     ],
27088     "name": "CloneTrunks",
27089     "group": "Trunks",
27090     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27091     "version": "0.0.0",
27092     "filename": "server/api/trunk/index.js",
27093     "groupTitle": "Trunks"
27094   },
27095   {
27096     "type": "post",
27097     "url": "/api/trunks",
27098     "title": "Create a new trunk",
27099     "examples": [
27100       {
27101         "title": "Example usage:",
27102         "content": "curl https://{domain}/api/trunks -v -u {name}:{password} -X POST",
27103         "type": "json"
27104       }
27105     ],
27106     "name": "Create",
27107     "group": "Trunks",
27108     "parameter": {
27109       "fields": {
27110         "Body": [
27111           {
27112             "group": "Body",
27113             "type": "String",
27114             "optional": false,
27115             "field": "name",
27116             "description": ""
27117           },
27118           {
27119             "group": "Body",
27120             "type": "String",
27121             "allowedValues": [
27122               "\"friend\"",
27123               "\"user\"",
27124               "\"peer\""
27125             ],
27126             "optional": false,
27127             "field": "type",
27128             "description": ""
27129           },
27130           {
27131             "group": "Body",
27132             "type": "String",
27133             "optional": false,
27134             "field": "context",
27135             "description": ""
27136           },
27137           {
27138             "group": "Body",
27139             "type": "String",
27140             "allowedValues": [
27141               "\"ALLOWED_NOT_SCREENED\"",
27142               "\"ALLOWED_PASSED_SCREEN\"",
27143               "\"ALLOWED_FAILED_SCREEN\"",
27144               "\"ALLOWED\"",
27145               "\"PROHIB_NOT_SCREENED\"",
27146               "\"PROHIB_PASSED_SCREEN\"",
27147               "\"PROHIB_FAILED_SCREEN\"",
27148               "\"PROHIB\""
27149             ],
27150             "optional": true,
27151             "field": "callingpres",
27152             "description": ""
27153           },
27154           {
27155             "group": "Body",
27156             "type": "String",
27157             "optional": true,
27158             "field": "deny",
27159             "description": ""
27160           },
27161           {
27162             "group": "Body",
27163             "type": "String",
27164             "optional": true,
27165             "field": "permit",
27166             "description": ""
27167           },
27168           {
27169             "group": "Body",
27170             "type": "String",
27171             "optional": true,
27172             "field": "secret",
27173             "description": ""
27174           },
27175           {
27176             "group": "Body",
27177             "type": "String",
27178             "optional": true,
27179             "field": "md5secret",
27180             "description": ""
27181           },
27182           {
27183             "group": "Body",
27184             "type": "String",
27185             "optional": true,
27186             "field": "remotesecret",
27187             "description": ""
27188           },
27189           {
27190             "group": "Body",
27191             "type": "String",
27192             "optional": true,
27193             "field": "transport",
27194             "description": "<p>String is deprecated. Please use an Array as [&quot;udp&quot;, &quot;tcp&quot;]</p>"
27195           },
27196           {
27197             "group": "Body",
27198             "type": "String",
27199             "allowedValues": [
27200               "\"rfc2833\"",
27201               "\"info\"",
27202               "\"shortinfo\"",
27203               "\"inband\"",
27204               "\"auto\""
27205             ],
27206             "optional": true,
27207             "field": "dtmfmode",
27208             "description": ""
27209           },
27210           {
27211             "group": "Body",
27212             "type": "String",
27213             "allowedValues": [
27214               "\"yes\"",
27215               "\"no\"",
27216               "\"nonat\"",
27217               "\"update\"",
27218               "\"outgoing\""
27219             ],
27220             "optional": true,
27221             "field": "directmedia",
27222             "description": ""
27223           },
27224           {
27225             "group": "Body",
27226             "type": "String",
27227             "allowedValues": [
27228               "\"yes\"",
27229               "\"no\""
27230             ],
27231             "optional": true,
27232             "field": "directrtpsetup",
27233             "description": ""
27234           },
27235           {
27236             "group": "Body",
27237             "type": "String",
27238             "optional": true,
27239             "field": "directmediapermit",
27240             "description": ""
27241           },
27242           {
27243             "group": "Body",
27244             "type": "String",
27245             "optional": true,
27246             "field": "directmediadeny",
27247             "description": ""
27248           },
27249           {
27250             "group": "Body",
27251             "type": "String",
27252             "optional": true,
27253             "field": "nat",
27254             "description": "<p>String is deprecated. Please use an Array as [&quot;force_rport&quot;, &quot;comedia&quot;]</p>"
27255           },
27256           {
27257             "group": "Body",
27258             "type": "String",
27259             "optional": true,
27260             "field": "callgroup",
27261             "description": ""
27262           },
27263           {
27264             "group": "Body",
27265             "type": "String",
27266             "optional": true,
27267             "field": "namedcallgroup",
27268             "description": ""
27269           },
27270           {
27271             "group": "Body",
27272             "type": "String",
27273             "optional": true,
27274             "field": "pickupgroup",
27275             "description": ""
27276           },
27277           {
27278             "group": "Body",
27279             "type": "String",
27280             "optional": true,
27281             "field": "namedpickupgroup",
27282             "description": ""
27283           },
27284           {
27285             "group": "Body",
27286             "type": "String",
27287             "optional": true,
27288             "field": "language",
27289             "description": ""
27290           },
27291           {
27292             "group": "Body",
27293             "type": "String",
27294             "optional": true,
27295             "field": "tonezone",
27296             "description": ""
27297           },
27298           {
27299             "group": "Body",
27300             "type": "String",
27301             "optional": true,
27302             "field": "disallow",
27303             "description": ""
27304           },
27305           {
27306             "group": "Body",
27307             "type": "String",
27308             "optional": false,
27309             "field": "allow",
27310             "description": "<p>String is deprecated. Please use an Array as [&quot;ulaw&quot;, &quot;alaw&quot;, &quot;alaw&quot;]</p>"
27311           },
27312           {
27313             "group": "Body",
27314             "type": "String",
27315             "allowedValues": [
27316               "\"yes\"",
27317               "\"no\""
27318             ],
27319             "optional": true,
27320             "field": "autoframing",
27321             "description": ""
27322           },
27323           {
27324             "group": "Body",
27325             "type": "String",
27326             "optional": true,
27327             "field": "insecure",
27328             "description": "<p>String is deprecated. Please use an Array as [&quot;port&quot;, &quot;invite&quot;]</p>"
27329           },
27330           {
27331             "group": "Body",
27332             "type": "String",
27333             "allowedValues": [
27334               "\"yes\"",
27335               "\"no\""
27336             ],
27337             "optional": true,
27338             "field": "trustrpid",
27339             "description": ""
27340           },
27341           {
27342             "group": "Body",
27343             "type": "String",
27344             "allowedValues": [
27345               "\"yes\"",
27346               "\"no\""
27347             ],
27348             "optional": true,
27349             "field": "trust_id_outbound",
27350             "description": ""
27351           },
27352           {
27353             "group": "Body",
27354             "type": "String",
27355             "allowedValues": [
27356               "\"yes\"",
27357               "\"no\"",
27358               "\"never\""
27359             ],
27360             "optional": true,
27361             "field": "progressinband",
27362             "description": ""
27363           },
27364           {
27365             "group": "Body",
27366             "type": "String",
27367             "allowedValues": [
27368               "\"yes\"",
27369               "\"no\""
27370             ],
27371             "optional": true,
27372             "field": "promiscredir",
27373             "description": ""
27374           },
27375           {
27376             "group": "Body",
27377             "type": "String",
27378             "allowedValues": [
27379               "\"yes\"",
27380               "\"no\""
27381             ],
27382             "optional": true,
27383             "field": "useclientcode",
27384             "description": ""
27385           },
27386           {
27387             "group": "Body",
27388             "type": "Integer",
27389             "optional": true,
27390             "field": "accountcode",
27391             "description": ""
27392           },
27393           {
27394             "group": "Body",
27395             "type": "String",
27396             "optional": true,
27397             "field": "setvar",
27398             "description": ""
27399           },
27400           {
27401             "group": "Body",
27402             "type": "String",
27403             "optional": true,
27404             "field": "callerid",
27405             "description": ""
27406           },
27407           {
27408             "group": "Body",
27409             "type": "String",
27410             "optional": true,
27411             "field": "amaflags",
27412             "description": ""
27413           },
27414           {
27415             "group": "Body",
27416             "type": "String",
27417             "allowedValues": [
27418               "\"yes\"",
27419               "\"no\""
27420             ],
27421             "optional": true,
27422             "field": "callcounter",
27423             "description": ""
27424           },
27425           {
27426             "group": "Body",
27427             "type": "Integer",
27428             "optional": true,
27429             "field": "busylevel",
27430             "description": ""
27431           },
27432           {
27433             "group": "Body",
27434             "type": "String",
27435             "allowedValues": [
27436               "\"yes\"",
27437               "\"no\""
27438             ],
27439             "optional": true,
27440             "field": "allowoverlap",
27441             "description": ""
27442           },
27443           {
27444             "group": "Body",
27445             "type": "String",
27446             "allowedValues": [
27447               "\"yes\"",
27448               "\"no\""
27449             ],
27450             "optional": true,
27451             "field": "allowsubscribe",
27452             "description": ""
27453           },
27454           {
27455             "group": "Body",
27456             "type": "String",
27457             "allowedValues": [
27458               "\"yes\"",
27459               "\"no\""
27460             ],
27461             "optional": true,
27462             "field": "allowtransfer",
27463             "description": ""
27464           },
27465           {
27466             "group": "Body",
27467             "type": "String",
27468             "allowedValues": [
27469               "\"yes\"",
27470               "\"no\""
27471             ],
27472             "optional": true,
27473             "field": "ignoresdpversion",
27474             "description": ""
27475           },
27476           {
27477             "group": "Body",
27478             "type": "String",
27479             "optional": true,
27480             "field": "subscribecontext",
27481             "description": ""
27482           },
27483           {
27484             "group": "Body",
27485             "type": "String",
27486             "optional": true,
27487             "field": "template",
27488             "description": ""
27489           },
27490           {
27491             "group": "Body",
27492             "type": "String",
27493             "allowedValues": [
27494               "\"yes\"",
27495               "\"no\"",
27496               "\"always\""
27497             ],
27498             "optional": true,
27499             "field": "videosupport",
27500             "description": ""
27501           },
27502           {
27503             "group": "Body",
27504             "type": "Integer",
27505             "optional": true,
27506             "field": "maxcallbitrate",
27507             "description": ""
27508           },
27509           {
27510             "group": "Body",
27511             "type": "String",
27512             "allowedValues": [
27513               "\"yes\"",
27514               "\"no\""
27515             ],
27516             "optional": true,
27517             "field": "rfc2833compensate",
27518             "description": ""
27519           },
27520           {
27521             "group": "Body",
27522             "type": "String",
27523             "optional": true,
27524             "field": "mailbox",
27525             "description": ""
27526           },
27527           {
27528             "group": "Body",
27529             "type": "String",
27530             "allowedValues": [
27531               "\"accept\"",
27532               "\"refuse\"",
27533               "\"originate\""
27534             ],
27535             "optional": true,
27536             "field": "session_timers",
27537             "description": ""
27538           },
27539           {
27540             "group": "Body",
27541             "type": "Integer",
27542             "optional": true,
27543             "field": "session_expires",
27544             "description": ""
27545           },
27546           {
27547             "group": "Body",
27548             "type": "Integer",
27549             "optional": true,
27550             "field": "session_minse",
27551             "description": ""
27552           },
27553           {
27554             "group": "Body",
27555             "type": "String",
27556             "allowedValues": [
27557               "\"uac\"",
27558               "\"uas\""
27559             ],
27560             "optional": true,
27561             "field": "session_refresher",
27562             "description": ""
27563           },
27564           {
27565             "group": "Body",
27566             "type": "String",
27567             "optional": true,
27568             "field": "t38pt_usertpsource",
27569             "description": ""
27570           },
27571           {
27572             "group": "Body",
27573             "type": "String",
27574             "optional": true,
27575             "field": "regexten",
27576             "description": ""
27577           },
27578           {
27579             "group": "Body",
27580             "type": "String",
27581             "optional": true,
27582             "field": "fromdomain",
27583             "description": ""
27584           },
27585           {
27586             "group": "Body",
27587             "type": "String",
27588             "optional": true,
27589             "field": "fromuser",
27590             "description": ""
27591           },
27592           {
27593             "group": "Body",
27594             "type": "Integer",
27595             "optional": true,
27596             "field": "port",
27597             "description": ""
27598           },
27599           {
27600             "group": "Body",
27601             "type": "String",
27602             "allowedValues": [
27603               "\"yes\"",
27604               "\"no\""
27605             ],
27606             "optional": true,
27607             "field": "qualify",
27608             "description": ""
27609           },
27610           {
27611             "group": "Body",
27612             "type": "Integer",
27613             "optional": true,
27614             "field": "keepalive",
27615             "description": ""
27616           },
27617           {
27618             "group": "Body",
27619             "type": "String",
27620             "optional": true,
27621             "field": "defaultip",
27622             "description": ""
27623           },
27624           {
27625             "group": "Body",
27626             "type": "String",
27627             "optional": true,
27628             "field": "defaultuser",
27629             "description": ""
27630           },
27631           {
27632             "group": "Body",
27633             "type": "Integer",
27634             "optional": true,
27635             "field": "rtptimeout",
27636             "description": ""
27637           },
27638           {
27639             "group": "Body",
27640             "type": "Integer",
27641             "optional": true,
27642             "field": "rtpholdtimeout",
27643             "description": ""
27644           },
27645           {
27646             "group": "Body",
27647             "type": "Integer",
27648             "optional": true,
27649             "field": "rtpkeepalive",
27650             "description": ""
27651           },
27652           {
27653             "group": "Body",
27654             "type": "String",
27655             "allowedValues": [
27656               "\"yes\"",
27657               "\"no\"",
27658               "\"pai\""
27659             ],
27660             "optional": true,
27661             "field": "sendrpid",
27662             "description": ""
27663           },
27664           {
27665             "group": "Body",
27666             "type": "String",
27667             "optional": true,
27668             "field": "outboundproxy",
27669             "description": ""
27670           },
27671           {
27672             "group": "Body",
27673             "type": "String",
27674             "optional": true,
27675             "field": "callbackextension",
27676             "description": ""
27677           },
27678           {
27679             "group": "Body",
27680             "type": "Integer",
27681             "optional": true,
27682             "field": "timert1",
27683             "description": ""
27684           },
27685           {
27686             "group": "Body",
27687             "type": "Integer",
27688             "optional": true,
27689             "field": "timerb",
27690             "description": ""
27691           },
27692           {
27693             "group": "Body",
27694             "type": "Integer",
27695             "optional": true,
27696             "field": "qualifyfreq",
27697             "description": ""
27698           },
27699           {
27700             "group": "Body",
27701             "type": "String",
27702             "optional": true,
27703             "field": "contactpermit",
27704             "description": ""
27705           },
27706           {
27707             "group": "Body",
27708             "type": "String",
27709             "optional": true,
27710             "field": "contactdeny",
27711             "description": ""
27712           },
27713           {
27714             "group": "Body",
27715             "type": "String",
27716             "optional": true,
27717             "field": "contactacl",
27718             "description": ""
27719           },
27720           {
27721             "group": "Body",
27722             "type": "String",
27723             "optional": true,
27724             "field": "unsolicited_mailbox",
27725             "description": ""
27726           },
27727           {
27728             "group": "Body",
27729             "type": "String",
27730             "optional": true,
27731             "field": "use_q850_reason",
27732             "description": ""
27733           },
27734           {
27735             "group": "Body",
27736             "type": "Integer",
27737             "optional": true,
27738             "field": "maxforwards",
27739             "description": ""
27740           },
27741           {
27742             "group": "Body",
27743             "type": "String",
27744             "allowedValues": [
27745               "\"yes\"",
27746               "\"no\""
27747             ],
27748             "optional": true,
27749             "field": "encryption",
27750             "description": ""
27751           },
27752           {
27753             "group": "Body",
27754             "type": "String",
27755             "allowedValues": [
27756               "\"yes\"",
27757               "\"no\""
27758             ],
27759             "optional": true,
27760             "field": "avpf",
27761             "description": ""
27762           },
27763           {
27764             "group": "Body",
27765             "type": "String",
27766             "allowedValues": [
27767               "\"yes\"",
27768               "\"no\""
27769             ],
27770             "optional": true,
27771             "field": "force_avp",
27772             "description": ""
27773           },
27774           {
27775             "group": "Body",
27776             "type": "String",
27777             "allowedValues": [
27778               "\"yes\"",
27779               "\"no\""
27780             ],
27781             "optional": true,
27782             "field": "icesupport",
27783             "description": ""
27784           },
27785           {
27786             "group": "Body",
27787             "type": "String",
27788             "allowedValues": [
27789               "\"yes\"",
27790               "\"no\""
27791             ],
27792             "optional": true,
27793             "field": "dtlsenable",
27794             "description": ""
27795           },
27796           {
27797             "group": "Body",
27798             "type": "String",
27799             "allowedValues": [
27800               "\"yes\"",
27801               "\"no\"",
27802               "\"fingerprint\"",
27803               "\"certificate\""
27804             ],
27805             "optional": true,
27806             "field": "dtlsverify",
27807             "description": ""
27808           },
27809           {
27810             "group": "Body",
27811             "type": "Integer",
27812             "optional": true,
27813             "field": "dtlsrekey",
27814             "description": ""
27815           },
27816           {
27817             "group": "Body",
27818             "type": "String",
27819             "optional": true,
27820             "field": "dtlscertfile",
27821             "description": ""
27822           },
27823           {
27824             "group": "Body",
27825             "type": "String",
27826             "optional": true,
27827             "field": "dtlsprivatekey",
27828             "description": ""
27829           },
27830           {
27831             "group": "Body",
27832             "type": "String",
27833             "optional": true,
27834             "field": "dtlscipher",
27835             "description": ""
27836           },
27837           {
27838             "group": "Body",
27839             "type": "String",
27840             "optional": true,
27841             "field": "dtlscafile",
27842             "description": ""
27843           },
27844           {
27845             "group": "Body",
27846             "type": "String",
27847             "optional": true,
27848             "field": "dtlscapath",
27849             "description": ""
27850           },
27851           {
27852             "group": "Body",
27853             "type": "String",
27854             "allowedValues": [
27855               "\"active\"",
27856               "\"passive\"",
27857               "\"actpass\""
27858             ],
27859             "optional": true,
27860             "field": "dtlssetup",
27861             "description": ""
27862           },
27863           {
27864             "group": "Body",
27865             "type": "String",
27866             "optional": true,
27867             "field": "dtlsfingerprint",
27868             "description": ""
27869           },
27870           {
27871             "group": "Body",
27872             "type": "String",
27873             "allowedValues": [
27874               "\"yes\"",
27875               "\"no\""
27876             ],
27877             "optional": true,
27878             "field": "usereqphone",
27879             "description": ""
27880           },
27881           {
27882             "group": "Body",
27883             "type": "String",
27884             "optional": true,
27885             "field": "recordonfeature",
27886             "description": ""
27887           },
27888           {
27889             "group": "Body",
27890             "type": "String",
27891             "optional": true,
27892             "field": "recordofffeature",
27893             "description": ""
27894           },
27895           {
27896             "group": "Body",
27897             "type": "Integer",
27898             "optional": true,
27899             "field": "call_limit",
27900             "description": ""
27901           },
27902           {
27903             "group": "Body",
27904             "type": "String",
27905             "allowedValues": [
27906               "\"yes\"",
27907               "\"no\""
27908             ],
27909             "optional": true,
27910             "field": "registertrying",
27911             "description": ""
27912           },
27913           {
27914             "group": "Body",
27915             "type": "String",
27916             "allowedValues": [
27917               "\"yes\"",
27918               "\"no\""
27919             ],
27920             "optional": true,
27921             "field": "subscribemwi",
27922             "description": ""
27923           },
27924           {
27925             "group": "Body",
27926             "type": "String",
27927             "optional": true,
27928             "field": "vmexten",
27929             "description": ""
27930           },
27931           {
27932             "group": "Body",
27933             "type": "String",
27934             "optional": true,
27935             "field": "mohinterpret",
27936             "description": ""
27937           },
27938           {
27939             "group": "Body",
27940             "type": "String",
27941             "optional": true,
27942             "field": "mohsuggest",
27943             "description": ""
27944           },
27945           {
27946             "group": "Body",
27947             "type": "String",
27948             "optional": true,
27949             "field": "parkinglot",
27950             "description": ""
27951           },
27952           {
27953             "group": "Body",
27954             "type": "String",
27955             "optional": true,
27956             "field": "description",
27957             "description": ""
27958           },
27959           {
27960             "group": "Body",
27961             "type": "String",
27962             "optional": true,
27963             "field": "host",
27964             "description": ""
27965           },
27966           {
27967             "group": "Body",
27968             "type": "String",
27969             "allowedValues": [
27970               "\"yes\"",
27971               "\"no\"",
27972               "\"nonat\"",
27973               "\"update\"",
27974               "\"update,nonat\""
27975             ],
27976             "optional": true,
27977             "field": "canreinvite",
27978             "description": ""
27979           },
27980           {
27981             "group": "Body",
27982             "type": "String",
27983             "optional": true,
27984             "field": "registry",
27985             "description": ""
27986           },
27987           {
27988             "group": "Body",
27989             "type": "String",
27990             "optional": true,
27991             "field": "otherFields",
27992             "description": ""
27993           },
27994           {
27995             "group": "Body",
27996             "type": "Boolean",
27997             "optional": false,
27998             "field": "active",
27999             "description": ""
28000           },
28001           {
28002             "group": "Body",
28003             "type": "String",
28004             "optional": true,
28005             "field": "t38pt_udptl",
28006             "description": ""
28007           }
28008         ]
28009       }
28010     },
28011     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28012     "version": "0.0.0",
28013     "filename": "server/api/trunk/index.js",
28014     "groupTitle": "Trunks"
28015   },
28016   {
28017     "type": "delete",
28018     "url": "/api/trunks/{id}",
28019     "title": "Deletes a trunk",
28020     "examples": [
28021       {
28022         "title": "Example usage:",
28023         "content": "curl https://{domain}/api/trunks/{id} -v -u {name}:{password} -X DELETE",
28024         "type": "json"
28025       }
28026     ],
28027     "name": "Delete",
28028     "group": "Trunks",
28029     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28030     "version": "0.0.0",
28031     "filename": "server/api/trunk/index.js",
28032     "groupTitle": "Trunks"
28033   },
28034   {
28035     "type": "get",
28036     "url": "/api/trunks",
28037     "title": "Gets a list of Trunks",
28038     "examples": [
28039       {
28040         "title": "Example usage:",
28041         "content": "curl https://{domain}/api/trunks -v -u {name}:{password}",
28042         "type": "json"
28043       }
28044     ],
28045     "name": "GetTrunks",
28046     "group": "Trunks",
28047     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
28048     "version": "0.0.0",
28049     "filename": "server/api/trunk/index.js",
28050     "groupTitle": "Trunks"
28051   },
28052   {
28053     "type": "get",
28054     "url": "/api/trunks/{id}",
28055     "title": "Gets a single Trunk",
28056     "examples": [
28057       {
28058         "title": "Example usage:",
28059         "content": "curl https://{domain}/api/trunks/{id} -v -u {name}:{password}",
28060         "type": "json"
28061       }
28062     ],
28063     "name": "ShowTrunks",
28064     "group": "Trunks",
28065     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28066     "version": "0.0.0",
28067     "filename": "server/api/trunk/index.js",
28068     "groupTitle": "Trunks"
28069   },
28070   {
28071     "type": "put",
28072     "url": "/api/trunks/{id}",
28073     "title": "Update an existing trunk",
28074     "examples": [
28075       {
28076         "title": "Example usage:",
28077         "content": "curl https://{domain}/api/trunks/{id} -v -u {name}:{password} -X PUT",
28078         "type": "json"
28079       }
28080     ],
28081     "name": "Update",
28082     "group": "Trunks",
28083     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28084     "version": "0.0.0",
28085     "filename": "server/api/trunk/index.js",
28086     "groupTitle": "Trunks"
28087   },
28088   {
28089     "type": "post",
28090     "url": "/api/userNotifications",
28091     "title": "Send notification to user",
28092     "examples": [
28093       {
28094         "title": "Example usage:",
28095         "content": "curl https://{domain}/api/userNotifications -d '{\"text\": \"Hello!\", \"TemplateId\": 1}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
28096         "type": "json"
28097       }
28098     ],
28099     "name": "Send",
28100     "group": "UserNotifications",
28101     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28102     "version": "0.0.0",
28103     "filename": "server/api/userNotification/index.js",
28104     "groupTitle": "UserNotifications"
28105   },
28106   {
28107     "type": "post",
28108     "url": "/api/userProfile/resources",
28109     "title": "Creates a new User Profile Resource",
28110     "examples": [
28111       {
28112         "title": "Example usage:",
28113         "content": "curl https://{domain}/api/userProfile/resources -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
28114         "type": "json"
28115       }
28116     ],
28117     "name": "CreateUser_Profile_Resources",
28118     "group": "User_Profile_Resources",
28119     "parameter": {
28120       "fields": {
28121         "Body": [
28122           {
28123             "group": "Body",
28124             "type": "String",
28125             "optional": false,
28126             "field": "name",
28127             "description": ""
28128           },
28129           {
28130             "group": "Body",
28131             "type": "Integer",
28132             "optional": false,
28133             "field": "resourceId",
28134             "description": ""
28135           },
28136           {
28137             "group": "Body",
28138             "type": "String",
28139             "optional": false,
28140             "field": "type",
28141             "description": ""
28142           }
28143         ]
28144       }
28145     },
28146     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28147     "version": "0.0.0",
28148     "filename": "server/api/userProfileResource/index.js",
28149     "groupTitle": "User_Profile_Resources"
28150   },
28151   {
28152     "type": "delete",
28153     "url": "/api/userProfile/resources/{id}",
28154     "title": "Deletes a User Profile Resource",
28155     "examples": [
28156       {
28157         "title": "Example usage:",
28158         "content": "curl https://{domain}/api/userProfile/resources/{id} -v -u {name}:{password} -X DELETE",
28159         "type": "json"
28160       }
28161     ],
28162     "name": "DeleteUser_Profile_Resources",
28163     "group": "User_Profile_Resources",
28164     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28165     "version": "0.0.0",
28166     "filename": "server/api/userProfileResource/index.js",
28167     "groupTitle": "User_Profile_Resources"
28168   },
28169   {
28170     "type": "get",
28171     "url": "/api/userProfile/resources/describe",
28172     "title": "Gets table info about User Profile Resources",
28173     "examples": [
28174       {
28175         "title": "Example usage:",
28176         "content": "curl https://{domain}/api/userProfile/resources/describe -v -u {name}:{password}",
28177         "type": "json"
28178       }
28179     ],
28180     "name": "DescribeUser_Profile_Resources",
28181     "group": "User_Profile_Resources",
28182     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28183     "version": "0.0.0",
28184     "filename": "server/api/userProfileResource/index.js",
28185     "groupTitle": "User_Profile_Resources"
28186   },
28187   {
28188     "type": "get",
28189     "url": "/api/userProfile/resources",
28190     "title": "Gets a list of User Profile Resources",
28191     "examples": [
28192       {
28193         "title": "Example usage:",
28194         "content": "curl https://{domain}/api/userProfile/resources -v -u {name}:{password}",
28195         "type": "json"
28196       }
28197     ],
28198     "name": "GetUser_Profile_Resources",
28199     "group": "User_Profile_Resources",
28200     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
28201     "version": "0.0.0",
28202     "filename": "server/api/userProfileResource/index.js",
28203     "groupTitle": "User_Profile_Resources"
28204   },
28205   {
28206     "type": "get",
28207     "url": "/api/userProfile/resources/{id}",
28208     "title": "Gets a single User Profile Resource",
28209     "examples": [
28210       {
28211         "title": "Example usage:",
28212         "content": "curl https://{domain}/api/userProfile/resources/{id} -v -u {name}:{password}",
28213         "type": "json"
28214       }
28215     ],
28216     "name": "ShowUser_Profile_Resources",
28217     "group": "User_Profile_Resources",
28218     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28219     "version": "0.0.0",
28220     "filename": "server/api/userProfileResource/index.js",
28221     "groupTitle": "User_Profile_Resources"
28222   },
28223   {
28224     "type": "put",
28225     "url": "/api/userProfile/resources/{id}",
28226     "title": "Update an existing User Profile Resource",
28227     "examples": [
28228       {
28229         "title": "Example usage:",
28230         "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",
28231         "type": "json"
28232       }
28233     ],
28234     "name": "updateUser_Profile_Resources",
28235     "group": "User_Profile_Resources",
28236     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28237     "version": "0.0.0",
28238     "filename": "server/api/userProfileResource/index.js",
28239     "groupTitle": "User_Profile_Resources"
28240   },
28241   {
28242     "type": "post",
28243     "url": "/api/userProfile/sections",
28244     "title": "Creates a new User Profile Section",
28245     "examples": [
28246       {
28247         "title": "Example usage:",
28248         "content": "curl https://{domain}/api/userProfile/sections -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
28249         "type": "json"
28250       }
28251     ],
28252     "name": "CreateUser_Profile_Sections",
28253     "group": "User_Profile_Sections",
28254     "parameter": {
28255       "fields": {
28256         "Body": [
28257           {
28258             "group": "Body",
28259             "type": "String",
28260             "optional": false,
28261             "field": "name",
28262             "description": ""
28263           },
28264           {
28265             "group": "Body",
28266             "type": "String",
28267             "optional": false,
28268             "field": "category",
28269             "description": ""
28270           },
28271           {
28272             "group": "Body",
28273             "type": "Integer",
28274             "optional": false,
28275             "field": "sectionId",
28276             "description": ""
28277           },
28278           {
28279             "group": "Body",
28280             "type": "Boolean",
28281             "optional": true,
28282             "field": "enabled",
28283             "description": ""
28284           },
28285           {
28286             "group": "Body",
28287             "type": "Boolean",
28288             "optional": true,
28289             "field": "autoAssociation",
28290             "description": ""
28291           },
28292           {
28293             "group": "Body",
28294             "type": "String",
28295             "optional": true,
28296             "field": "crudPermissions",
28297             "description": ""
28298           }
28299         ]
28300       }
28301     },
28302     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28303     "version": "0.0.0",
28304     "filename": "server/api/userProfileSection/index.js",
28305     "groupTitle": "User_Profile_Sections"
28306   },
28307   {
28308     "type": "delete",
28309     "url": "/api/userProfile/sections/{id}",
28310     "title": "Deletes a User Profile Section",
28311     "examples": [
28312       {
28313         "title": "Example usage:",
28314         "content": "curl https://{domain}/api/userProfile/sections/{id} -v -u {name}:{password} -X DELETE",
28315         "type": "json"
28316       }
28317     ],
28318     "name": "DeleteUser_Profile_Sections",
28319     "group": "User_Profile_Sections",
28320     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28321     "version": "0.0.0",
28322     "filename": "server/api/userProfileSection/index.js",
28323     "groupTitle": "User_Profile_Sections"
28324   },
28325   {
28326     "type": "get",
28327     "url": "/api/userProfile/sections/describe",
28328     "title": "Gets table info about User Profile Sections",
28329     "examples": [
28330       {
28331         "title": "Example usage:",
28332         "content": "curl https://{domain}/api/userProfile/sections/describe -v -u {name}:{password}",
28333         "type": "json"
28334       }
28335     ],
28336     "name": "DescribeUser_Profile_Sections",
28337     "group": "User_Profile_Sections",
28338     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28339     "version": "0.0.0",
28340     "filename": "server/api/userProfileSection/index.js",
28341     "groupTitle": "User_Profile_Sections"
28342   },
28343   {
28344     "type": "get",
28345     "url": "/api/userProfile/sections",
28346     "title": "Gets a list of User Profile Sections",
28347     "examples": [
28348       {
28349         "title": "Example usage:",
28350         "content": "curl https://{domain}/api/userProfile/sections -v -u {name}:{password}",
28351         "type": "json"
28352       }
28353     ],
28354     "name": "GetUser_Profile_Sections",
28355     "group": "User_Profile_Sections",
28356     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
28357     "version": "0.0.0",
28358     "filename": "server/api/userProfileSection/index.js",
28359     "groupTitle": "User_Profile_Sections"
28360   },
28361   {
28362     "type": "get",
28363     "url": "/api/userProfile/sections/{id}",
28364     "title": "Gets a single User Profile Section",
28365     "examples": [
28366       {
28367         "title": "Example usage:",
28368         "content": "curl https://{domain}/api/userProfile/sections/{id} -v -u {name}:{password}",
28369         "type": "json"
28370       }
28371     ],
28372     "name": "ShowUser_Profile_Sections",
28373     "group": "User_Profile_Sections",
28374     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28375     "version": "0.0.0",
28376     "filename": "server/api/userProfileSection/index.js",
28377     "groupTitle": "User_Profile_Sections"
28378   },
28379   {
28380     "type": "put",
28381     "url": "/api/userProfile/sections/{id}",
28382     "title": "Update an existing User Profile Section",
28383     "examples": [
28384       {
28385         "title": "Example usage:",
28386         "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",
28387         "type": "json"
28388       }
28389     ],
28390     "name": "updateUser_Profile_Sections",
28391     "group": "User_Profile_Sections",
28392     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28393     "version": "0.0.0",
28394     "filename": "server/api/userProfileSection/index.js",
28395     "groupTitle": "User_Profile_Sections"
28396   },
28397   {
28398     "type": "post",
28399     "url": "/api/userProfiles/{id}/resources",
28400     "title": "Add resources' permissions to User Profile",
28401     "examples": [
28402       {
28403         "title": "Example usage:",
28404         "content": "curl https://{domain}/api/userProfiles/{id}/resources -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
28405         "type": "json"
28406       }
28407     ],
28408     "name": "AddResources",
28409     "group": "User_Profiles",
28410     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28411     "version": "0.0.0",
28412     "filename": "server/api/userProfile/index.js",
28413     "groupTitle": "User_Profiles"
28414   },
28415   {
28416     "type": "post",
28417     "url": "/api/userProfiles/{id}/sections",
28418     "title": "Add sections' permissions to User Profile",
28419     "examples": [
28420       {
28421         "title": "Example usage:",
28422         "content": "curl https://{domain}/api/userProfiles/{id}/sections -d '[{\"sectionId\": \"name\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
28423         "type": "json"
28424       }
28425     ],
28426     "name": "AddSections",
28427     "group": "User_Profiles",
28428     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28429     "version": "0.0.0",
28430     "filename": "server/api/userProfile/index.js",
28431     "groupTitle": "User_Profiles"
28432   },
28433   {
28434     "type": "post",
28435     "url": "/api/userProfiles/clone",
28436     "title": "Clone an existing User Profile",
28437     "examples": [
28438       {
28439         "title": "Example usage:",
28440         "content": "curl https://{domain}/api/userProfiles/clone -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
28441         "type": "json"
28442       }
28443     ],
28444     "name": "CloneUser_Profiles",
28445     "group": "User_Profiles",
28446     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28447     "version": "0.0.0",
28448     "filename": "server/api/userProfile/index.js",
28449     "groupTitle": "User_Profiles"
28450   },
28451   {
28452     "type": "post",
28453     "url": "/api/userProfiles",
28454     "title": "Creates a new User Profile",
28455     "examples": [
28456       {
28457         "title": "Example usage:",
28458         "content": "curl https://{domain}/api/userProfiles -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
28459         "type": "json"
28460       }
28461     ],
28462     "name": "CreateUser_Profiles",
28463     "group": "User_Profiles",
28464     "parameter": {
28465       "fields": {
28466         "Body": [
28467           {
28468             "group": "Body",
28469             "type": "String",
28470             "optional": false,
28471             "field": "name",
28472             "description": ""
28473           },
28474           {
28475             "group": "Body",
28476             "type": "String",
28477             "optional": false,
28478             "field": "crudPermissions",
28479             "description": ""
28480           },
28481           {
28482             "group": "Body",
28483             "type": "String",
28484             "optional": true,
28485             "field": "description",
28486             "description": ""
28487           },
28488           {
28489             "group": "Body",
28490             "type": "Boolean",
28491             "optional": true,
28492             "field": "privacyEnabled",
28493             "description": ""
28494           },
28495           {
28496             "group": "Body",
28497             "type": "Boolean",
28498             "optional": true,
28499             "field": "downloadAttachments",
28500             "description": ""
28501           },
28502           {
28503             "group": "Body",
28504             "type": "Boolean",
28505             "optional": true,
28506             "field": "downloadCallySquareRecordings",
28507             "description": ""
28508           },
28509           {
28510             "group": "Body",
28511             "type": "Boolean",
28512             "optional": true,
28513             "field": "downloadContactManagerLists",
28514             "description": ""
28515           },
28516           {
28517             "group": "Body",
28518             "type": "Boolean",
28519             "optional": true,
28520             "field": "downloadJscriptySessions",
28521             "description": ""
28522           },
28523           {
28524             "group": "Body",
28525             "type": "Boolean",
28526             "optional": true,
28527             "field": "downloadOmnichannelInteractions",
28528             "description": ""
28529           },
28530           {
28531             "group": "Body",
28532             "type": "Boolean",
28533             "optional": true,
28534             "field": "downloadScreenRecordings",
28535             "description": ""
28536           },
28537           {
28538             "group": "Body",
28539             "type": "Boolean",
28540             "optional": true,
28541             "field": "downloadVoiceRecordings",
28542             "description": ""
28543           }
28544         ]
28545       }
28546     },
28547     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28548     "version": "0.0.0",
28549     "filename": "server/api/userProfile/index.js",
28550     "groupTitle": "User_Profiles"
28551   },
28552   {
28553     "type": "delete",
28554     "url": "/api/userProfiles/{id}",
28555     "title": "Deletes a User Profile",
28556     "examples": [
28557       {
28558         "title": "Example usage:",
28559         "content": "curl https://{domain}/api/userProfiles/{id} -v -u {name}:{password} -X DELETE",
28560         "type": "json"
28561       }
28562     ],
28563     "name": "DeleteUser_Profiles",
28564     "group": "User_Profiles",
28565     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28566     "version": "0.0.0",
28567     "filename": "server/api/userProfile/index.js",
28568     "groupTitle": "User_Profiles"
28569   },
28570   {
28571     "type": "get",
28572     "url": "/api/userProfiles/describe",
28573     "title": "Gets table info about User Profiles",
28574     "examples": [
28575       {
28576         "title": "Example usage:",
28577         "content": "curl https://{domain}/api/userProfiles/describe -v -u {name}:{password}",
28578         "type": "json"
28579       }
28580     ],
28581     "name": "DescribeUser_Profiles",
28582     "group": "User_Profiles",
28583     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28584     "version": "0.0.0",
28585     "filename": "server/api/userProfile/index.js",
28586     "groupTitle": "User_Profiles"
28587   },
28588   {
28589     "type": "get",
28590     "url": "/api/userProfiles/{id}/resources?section={section}",
28591     "title": "Get Resources assigned to a Section",
28592     "examples": [
28593       {
28594         "title": "Example usage:",
28595         "content": "curl https://{domain}/api/userProfiles/{id}/resources?section={section} -v -u {name}:{password} -X GET",
28596         "type": "json"
28597       }
28598     ],
28599     "name": "GetResources",
28600     "group": "User_Profiles",
28601     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28602     "version": "0.0.0",
28603     "filename": "server/api/userProfile/index.js",
28604     "groupTitle": "User_Profiles"
28605   },
28606   {
28607     "type": "get",
28608     "url": "/api/userProfiles/{id}/sections",
28609     "title": "Get sections associated to a User Profile",
28610     "examples": [
28611       {
28612         "title": "Example usage:",
28613         "content": "curl https://{domain}/api/userProfiles/{id}/sections -v -u {name}:{password} -X GET",
28614         "type": "json"
28615       }
28616     ],
28617     "name": "GetSections",
28618     "group": "User_Profiles",
28619     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28620     "version": "0.0.0",
28621     "filename": "server/api/userProfile/index.js",
28622     "groupTitle": "User_Profiles"
28623   },
28624   {
28625     "type": "get",
28626     "url": "/api/userProfiles",
28627     "title": "Gets a list of User Profiles",
28628     "examples": [
28629       {
28630         "title": "Example usage:",
28631         "content": "curl https://{domain}/api/userProfiles -v -u {name}:{password}",
28632         "type": "json"
28633       }
28634     ],
28635     "name": "GetUser_Profiles",
28636     "group": "User_Profiles",
28637     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
28638     "version": "0.0.0",
28639     "filename": "server/api/userProfile/index.js",
28640     "groupTitle": "User_Profiles"
28641   },
28642   {
28643     "type": "delete",
28644     "url": "/api/userProfiles/{id}/resources",
28645     "title": "Removes resources' permissions from User Profile",
28646     "examples": [
28647       {
28648         "title": "Example usage:",
28649         "content": "curl https://{domain}/api/userProfiles/{id}/resources?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
28650         "type": "json"
28651       }
28652     ],
28653     "name": "RemoveResources",
28654     "group": "User_Profiles",
28655     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28656     "version": "0.0.0",
28657     "filename": "server/api/userProfile/index.js",
28658     "groupTitle": "User_Profiles"
28659   },
28660   {
28661     "type": "delete",
28662     "url": "/api/userProfiles/{id}/sections",
28663     "title": "Removes sections' permissions from User Profile",
28664     "examples": [
28665       {
28666         "title": "Example usage:",
28667         "content": "curl https://{domain}/api/userProfiles/{id}/sections?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
28668         "type": "json"
28669       }
28670     ],
28671     "name": "RemoveSections",
28672     "group": "User_Profiles",
28673     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28674     "version": "0.0.0",
28675     "filename": "server/api/userProfile/index.js",
28676     "groupTitle": "User_Profiles"
28677   },
28678   {
28679     "type": "get",
28680     "url": "/api/userProfiles/{id}",
28681     "title": "Gets a single User Profile",
28682     "examples": [
28683       {
28684         "title": "Example usage:",
28685         "content": "curl https://{domain}/api/userProfiles/{id} -v -u {name}:{password}",
28686         "type": "json"
28687       }
28688     ],
28689     "name": "ShowUser_Profiles",
28690     "group": "User_Profiles",
28691     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28692     "version": "0.0.0",
28693     "filename": "server/api/userProfile/index.js",
28694     "groupTitle": "User_Profiles"
28695   },
28696   {
28697     "type": "put",
28698     "url": "/api/userProfiles/{id}",
28699     "title": "Update an existing User Profile",
28700     "examples": [
28701       {
28702         "title": "Example usage:",
28703         "content": "curl https://{domain}/api/userProfiles/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
28704         "type": "json"
28705       }
28706     ],
28707     "name": "updateUser_Profiles",
28708     "group": "User_Profiles",
28709     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28710     "version": "0.0.0",
28711     "filename": "server/api/userProfile/index.js",
28712     "groupTitle": "User_Profiles"
28713   },
28714   {
28715     "type": "put",
28716     "url": "/api/user-settings/{id}",
28717     "title": "Update an existing User Setting",
28718     "examples": [
28719       {
28720         "title": "Example usage:",
28721         "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",
28722         "type": "json"
28723       }
28724     ],
28725     "name": "updateUserSettings",
28726     "group": "User_Settings",
28727     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28728     "version": "0.0.0",
28729     "filename": "server/api/user-setting/index.js",
28730     "groupTitle": "User_Settings"
28731   },
28732   {
28733     "type": "post",
28734     "url": "/api/users/{id}/chat_interactions",
28735     "title": "Add chat interaction tabs to an agent",
28736     "examples": [
28737       {
28738         "title": "Example usage:",
28739         "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",
28740         "type": "json"
28741       }
28742     ],
28743     "name": "AddChatInteractions",
28744     "group": "Users",
28745     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28746     "version": "0.0.0",
28747     "filename": "server/api/user/index.js",
28748     "groupTitle": "Users"
28749   },
28750   {
28751     "type": "post",
28752     "url": "/api/users/{id}/chat_websites",
28753     "title": "Add a Chat Website to a user",
28754     "examples": [
28755       {
28756         "title": "Example usage:",
28757         "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",
28758         "type": "json"
28759       }
28760     ],
28761     "name": "AddChatWebsites",
28762     "group": "Users",
28763     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28764     "version": "0.0.0",
28765     "filename": "server/api/user/index.js",
28766     "groupTitle": "Users"
28767   },
28768   {
28769     "type": "post",
28770     "url": "/api/users/{id}/contacts",
28771     "title": "Add contacts to a user",
28772     "examples": [
28773       {
28774         "title": "Example usage:",
28775         "content": "curl https://{domain}/api/users/{id}/contacts -d '{\"ids\": [1,2]}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
28776         "type": "json"
28777       }
28778     ],
28779     "name": "AddContacts",
28780     "group": "Users",
28781     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28782     "version": "0.0.0",
28783     "filename": "server/api/user/index.js",
28784     "groupTitle": "Users"
28785   },
28786   {
28787     "type": "post",
28788     "url": "/api/users/{id}/fax_accounts",
28789     "title": "Add a Fax Account to a user",
28790     "examples": [
28791       {
28792         "title": "Example usage:",
28793         "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",
28794         "type": "json"
28795       }
28796     ],
28797     "name": "AddFaxAccounts",
28798     "group": "Users",
28799     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28800     "version": "0.0.0",
28801     "filename": "server/api/user/index.js",
28802     "groupTitle": "Users"
28803   },
28804   {
28805     "type": "post",
28806     "url": "/api/users/{id}/fax_interactions",
28807     "title": "Add fax interaction tabs to an agent",
28808     "examples": [
28809       {
28810         "title": "Example usage:",
28811         "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",
28812         "type": "json"
28813       }
28814     ],
28815     "name": "AddFaxInteractions",
28816     "group": "Users",
28817     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28818     "version": "0.0.0",
28819     "filename": "server/api/user/index.js",
28820     "groupTitle": "Users"
28821   },
28822   {
28823     "type": "post",
28824     "url": "/api/users/{id}/mail_accounts",
28825     "title": "Add a Mail Account to a user",
28826     "examples": [
28827       {
28828         "title": "Example usage:",
28829         "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",
28830         "type": "json"
28831       }
28832     ],
28833     "name": "AddMailAccounts",
28834     "group": "Users",
28835     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28836     "version": "0.0.0",
28837     "filename": "server/api/user/index.js",
28838     "groupTitle": "Users"
28839   },
28840   {
28841     "type": "post",
28842     "url": "/api/users/{id}/mail_interactions",
28843     "title": "Add mail interaction tabs to an agent",
28844     "examples": [
28845       {
28846         "title": "Example usage:",
28847         "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",
28848         "type": "json"
28849       }
28850     ],
28851     "name": "AddMailInteractions",
28852     "group": "Users",
28853     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28854     "version": "0.0.0",
28855     "filename": "server/api/user/index.js",
28856     "groupTitle": "Users"
28857   },
28858   {
28859     "type": "post",
28860     "url": "/api/users/{id}/openchannel_accounts",
28861     "title": "Add a Open Channel Account to a user",
28862     "examples": [
28863       {
28864         "title": "Example usage:",
28865         "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",
28866         "type": "json"
28867       }
28868     ],
28869     "name": "AddOpenchannelAccounts",
28870     "group": "Users",
28871     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28872     "version": "0.0.0",
28873     "filename": "server/api/user/index.js",
28874     "groupTitle": "Users"
28875   },
28876   {
28877     "type": "post",
28878     "url": "/api/users/{id}/openchannel_interactions",
28879     "title": "Add openchannel interaction tabs to an agent",
28880     "examples": [
28881       {
28882         "title": "Example usage:",
28883         "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",
28884         "type": "json"
28885       }
28886     ],
28887     "name": "AddOpenchannelInteractions",
28888     "group": "Users",
28889     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28890     "version": "0.0.0",
28891     "filename": "server/api/user/index.js",
28892     "groupTitle": "Users"
28893   },
28894   {
28895     "type": "post",
28896     "url": "/api/users/{id}/queues",
28897     "title": "Add queues to an agent",
28898     "examples": [
28899       {
28900         "title": "Example usage:",
28901         "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",
28902         "type": "json"
28903       }
28904     ],
28905     "name": "AddQueues",
28906     "group": "Users",
28907     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28908     "version": "0.0.0",
28909     "filename": "server/api/user/index.js",
28910     "groupTitle": "Users"
28911   },
28912   {
28913     "type": "post",
28914     "url": "/api/users/{id}/sms_accounts",
28915     "title": "Add a Sms Account to a user",
28916     "examples": [
28917       {
28918         "title": "Example usage:",
28919         "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",
28920         "type": "json"
28921       }
28922     ],
28923     "name": "AddSmsAccounts",
28924     "group": "Users",
28925     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28926     "version": "0.0.0",
28927     "filename": "server/api/user/index.js",
28928     "groupTitle": "Users"
28929   },
28930   {
28931     "type": "post",
28932     "url": "/api/users/{id}/sms_interactions",
28933     "title": "Add sms interaction tabs to an agent",
28934     "examples": [
28935       {
28936         "title": "Example usage:",
28937         "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",
28938         "type": "json"
28939       }
28940     ],
28941     "name": "AddSmsInteractions",
28942     "group": "Users",
28943     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28944     "version": "0.0.0",
28945     "filename": "server/api/user/index.js",
28946     "groupTitle": "Users"
28947   },
28948   {
28949     "type": "post",
28950     "url": "/api/users/{id}/square_projects",
28951     "title": "Add a Square Project to a user",
28952     "examples": [
28953       {
28954         "title": "Example usage:",
28955         "content": "curl https://{domain}/api/users/{id}/square_projects -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
28956         "type": "json"
28957       }
28958     ],
28959     "name": "AddSquareProjects",
28960     "group": "Users",
28961     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28962     "version": "0.0.0",
28963     "filename": "server/api/user/index.js",
28964     "groupTitle": "Users"
28965   },
28966   {
28967     "type": "post",
28968     "url": "/api/users/{id}/teams",
28969     "title": "Add teams to an agent",
28970     "examples": [
28971       {
28972         "title": "Example usage:",
28973         "content": "curl https://{domain}/api/users/{id}/teams -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
28974         "type": "json"
28975       }
28976     ],
28977     "name": "AddTeams",
28978     "group": "Users",
28979     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28980     "version": "0.0.0",
28981     "filename": "server/api/user/index.js",
28982     "groupTitle": "Users"
28983   },
28984   {
28985     "type": "post",
28986     "url": "/api/users/{id}/whatsapp_accounts",
28987     "title": "Add a Whatsapp Account to a user",
28988     "examples": [
28989       {
28990         "title": "Example usage:",
28991         "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",
28992         "type": "json"
28993       }
28994     ],
28995     "name": "AddWhatsappAccounts",
28996     "group": "Users",
28997     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28998     "version": "0.0.0",
28999     "filename": "server/api/user/index.js",
29000     "groupTitle": "Users"
29001   },
29002   {
29003     "type": "post",
29004     "url": "/api/users/{id}/whatsapp_interactions",
29005     "title": "Add Whatsapp interaction tabs to an agent",
29006     "examples": [
29007       {
29008         "title": "Example usage:",
29009         "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",
29010         "type": "json"
29011       }
29012     ],
29013     "name": "AddWhatsappInteractions",
29014     "group": "Users",
29015     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29016     "version": "0.0.0",
29017     "filename": "server/api/user/index.js",
29018     "groupTitle": "Users"
29019   },
29020   {
29021     "type": "put",
29022     "url": "/api/users/{id}/password",
29023     "title": "Change user password",
29024     "examples": [
29025       {
29026         "title": "Example usage:",
29027         "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",
29028         "type": "json"
29029       }
29030     ],
29031     "name": "ChangePwd",
29032     "group": "Users",
29033     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29034     "version": "0.0.0",
29035     "filename": "server/api/user/index.js",
29036     "groupTitle": "Users"
29037   },
29038   {
29039     "type": "post",
29040     "url": "/api/users",
29041     "title": "Create a new user",
29042     "examples": [
29043       {
29044         "title": "Example usage:",
29045         "content": "curl https://{domain}/api/users -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
29046         "type": "json"
29047       }
29048     ],
29049     "name": "Create",
29050     "group": "Users",
29051     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29052     "version": "0.0.0",
29053     "filename": "server/api/user/index.js",
29054     "groupTitle": "Users"
29055   },
29056   {
29057     "type": "post",
29058     "url": "/api/users/{id}/api_key",
29059     "title": "Create a new API access key for the user",
29060     "examples": [
29061       {
29062         "title": "Example usage:",
29063         "content": "curl https://{domain}/api/users/:id/api_key -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
29064         "type": "json"
29065       }
29066     ],
29067     "name": "CreateApiKey",
29068     "group": "Users",
29069     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29070     "version": "0.0.0",
29071     "filename": "server/api/user/index.js",
29072     "groupTitle": "Users"
29073   },
29074   {
29075     "type": "delete",
29076     "url": "/api/users/{id}",
29077     "title": "Deletes a user",
29078     "examples": [
29079       {
29080         "title": "Example usage:",
29081         "content": "curl https://{domain}/api/users/{id} -v -u {name}:{password} -X DELETE",
29082         "type": "json"
29083       }
29084     ],
29085     "name": "Delete",
29086     "group": "Users",
29087     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29088     "version": "0.0.0",
29089     "filename": "server/api/user/index.js",
29090     "groupTitle": "Users"
29091   },
29092   {
29093     "type": "get",
29094     "url": "/api/users/describe",
29095     "title": "Gets table info about Users",
29096     "examples": [
29097       {
29098         "title": "Example usage:",
29099         "content": "curl https://{domain}/api/users/describe -v -u {name}:{password}",
29100         "type": "json"
29101       }
29102     ],
29103     "name": "DescribeUsers",
29104     "group": "Users",
29105     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29106     "version": "0.0.0",
29107     "filename": "server/api/user/index.js",
29108     "groupTitle": "Users"
29109   },
29110   {
29111     "type": "get",
29112     "url": "/api/users/{id}/agents",
29113     "title": "GetAgents",
29114     "examples": [
29115       {
29116         "title": "Example usage:",
29117         "content": "curl https://{domain}/api/users/{id}/agents -v -u {name}:{password} -X GET",
29118         "type": "json"
29119       }
29120     ],
29121     "name": "GetAgents",
29122     "group": "Users",
29123     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29124     "version": "0.0.0",
29125     "filename": "server/api/user/index.js",
29126     "groupTitle": "Users"
29127   },
29128   {
29129     "type": "get",
29130     "url": "/api/users/{id}/api_key",
29131     "title": "Get the API access key for the user",
29132     "examples": [
29133       {
29134         "title": "Example usage:",
29135         "content": "curl https://{domain}/api/users/:id/api_key -v -u {name}:{password} -X GET",
29136         "type": "json"
29137       }
29138     ],
29139     "name": "GetApiKey",
29140     "group": "Users",
29141     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29142     "version": "0.0.0",
29143     "filename": "server/api/user/index.js",
29144     "groupTitle": "Users"
29145   },
29146   {
29147     "type": "get",
29148     "url": "/api/users/{id}/groups",
29149     "title": "GetChatGroups",
29150     "examples": [
29151       {
29152         "title": "Example usage:",
29153         "content": "curl https://{domain}/api/users/{id}/groups -v -u {name}:{password} -X GET",
29154         "type": "json"
29155       }
29156     ],
29157     "name": "GetChatGroups",
29158     "group": "Users",
29159     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29160     "version": "0.0.0",
29161     "filename": "server/api/user/index.js",
29162     "groupTitle": "Users"
29163   },
29164   {
29165     "type": "get",
29166     "url": "/api/users/{id}/chat/interactions",
29167     "title": "GetChatInteractions",
29168     "examples": [
29169       {
29170         "title": "Example usage:",
29171         "content": "curl https://{domain}/api/users/{id}/chat/interactions -v -u {name}:{password} -X GET",
29172         "type": "json"
29173       }
29174     ],
29175     "name": "GetChatInteractions",
29176     "group": "Users",
29177     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29178     "version": "0.0.0",
29179     "filename": "server/api/user/index.js",
29180     "groupTitle": "Users"
29181   },
29182   {
29183     "type": "get",
29184     "url": "/api/users/{id}/chat_websites",
29185     "title": "GetChatWebsites",
29186     "examples": [
29187       {
29188         "title": "Example usage:",
29189         "content": "curl https://{domain}/api/users/{id}/chat_websites -v -u {name}:{password} -X GET",
29190         "type": "json"
29191       }
29192     ],
29193     "name": "GetChatWebsites",
29194     "group": "Users",
29195     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29196     "version": "0.0.0",
29197     "filename": "server/api/user/index.js",
29198     "groupTitle": "Users"
29199   },
29200   {
29201     "type": "get",
29202     "url": "/api/users/{id}/contacts",
29203     "title": "GetContacts",
29204     "examples": [
29205       {
29206         "title": "Example usage:",
29207         "content": "curl https://{domain}/api/users/{id}/contacts -v -u {name}:{password} -X GET",
29208         "type": "json"
29209       }
29210     ],
29211     "name": "GetContacts",
29212     "group": "Users",
29213     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29214     "version": "0.0.0",
29215     "filename": "server/api/user/index.js",
29216     "groupTitle": "Users"
29217   },
29218   {
29219     "type": "get",
29220     "url": "/api/users/{id}/fax_accounts",
29221     "title": "GetFaxAccounts",
29222     "examples": [
29223       {
29224         "title": "Example usage:",
29225         "content": "curl https://{domain}/api/users/{id}/fax_accounts -v -u {name}:{password} -X GET",
29226         "type": "json"
29227       }
29228     ],
29229     "name": "GetFaxAccounts",
29230     "group": "Users",
29231     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29232     "version": "0.0.0",
29233     "filename": "server/api/user/index.js",
29234     "groupTitle": "Users"
29235   },
29236   {
29237     "type": "get",
29238     "url": "/api/users/{id}/fax/interactions",
29239     "title": "GetFaxInteractions",
29240     "examples": [
29241       {
29242         "title": "Example usage:",
29243         "content": "curl https://{domain}/api/users/{id}/fax/interactions -v -u {name}:{password} -X GET",
29244         "type": "json"
29245       }
29246     ],
29247     "name": "GetFaxInteractions",
29248     "group": "Users",
29249     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29250     "version": "0.0.0",
29251     "filename": "server/api/user/index.js",
29252     "groupTitle": "Users"
29253   },
29254   {
29255     "type": "get",
29256     "url": "/api/users/{id}/lists",
29257     "title": "GetLists",
29258     "examples": [
29259       {
29260         "title": "Example usage:",
29261         "content": "curl https://{domain}/api/users/{id}/lists -v -u {name}:{password} -X GET",
29262         "type": "json"
29263       }
29264     ],
29265     "name": "GetLists",
29266     "group": "Users",
29267     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29268     "version": "0.0.0",
29269     "filename": "server/api/user/index.js",
29270     "groupTitle": "Users"
29271   },
29272   {
29273     "type": "get",
29274     "url": "/api/users/{id}/mail_accounts",
29275     "title": "GetMailAccounts",
29276     "examples": [
29277       {
29278         "title": "Example usage:",
29279         "content": "curl https://{domain}/api/users/{id}/mail_accounts -v -u {name}:{password} -X GET",
29280         "type": "json"
29281       }
29282     ],
29283     "name": "GetMailAccounts",
29284     "group": "Users",
29285     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29286     "version": "0.0.0",
29287     "filename": "server/api/user/index.js",
29288     "groupTitle": "Users"
29289   },
29290   {
29291     "type": "get",
29292     "url": "/api/users/{id}/mail/interactions",
29293     "title": "GetMailInteractions",
29294     "examples": [
29295       {
29296         "title": "Example usage:",
29297         "content": "curl https://{domain}/api/users/{id}/mail/interactions -v -u {name}:{password} -X GET",
29298         "type": "json"
29299       }
29300     ],
29301     "name": "GetMailInteractions",
29302     "group": "Users",
29303     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29304     "version": "0.0.0",
29305     "filename": "server/api/user/index.js",
29306     "groupTitle": "Users"
29307   },
29308   {
29309     "type": "get",
29310     "url": "/api/users/{id}/openchannel_accounts",
29311     "title": "GetOpenchannelAccounts",
29312     "examples": [
29313       {
29314         "title": "Example usage:",
29315         "content": "curl https://{domain}/api/users/{id}/openchannel_accounts -v -u {name}:{password} -X GET",
29316         "type": "json"
29317       }
29318     ],
29319     "name": "GetOpenchannelAccounts",
29320     "group": "Users",
29321     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29322     "version": "0.0.0",
29323     "filename": "server/api/user/index.js",
29324     "groupTitle": "Users"
29325   },
29326   {
29327     "type": "get",
29328     "url": "/api/users/{id}/openchannel/interactions",
29329     "title": "GetOpenchannelInteractions",
29330     "examples": [
29331       {
29332         "title": "Example usage:",
29333         "content": "curl https://{domain}/api/users/{id}/openchannel/interactions -v -u {name}:{password}",
29334         "type": "json"
29335       }
29336     ],
29337     "name": "GetOpenchannelInteractions",
29338     "group": "Users",
29339     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29340     "version": "0.0.0",
29341     "filename": "server/api/user/index.js",
29342     "groupTitle": "Users"
29343   },
29344   {
29345     "type": "get",
29346     "url": "/api/users/{id}/prefixes",
29347     "title": "GetPrefixes",
29348     "examples": [
29349       {
29350         "title": "Example usage:",
29351         "content": "curl https://{domain}/api/users/{id}/prefixes -v -u {name}:{password} -X GET",
29352         "type": "json"
29353       }
29354     ],
29355     "name": "GetPrefixes",
29356     "group": "Users",
29357     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29358     "version": "0.0.0",
29359     "filename": "server/api/user/index.js",
29360     "groupTitle": "Users"
29361   },
29362   {
29363     "type": "get",
29364     "url": "/api/users/{id}/queues?channel={channel}",
29365     "title": "Gets Queues list",
29366     "examples": [
29367       {
29368         "title": "Example usage:",
29369         "content": "curl https://{domain}/api/users/{id}/queues/?channel={channel} -v -u {name}:{password} -X GET",
29370         "type": "json"
29371       }
29372     ],
29373     "name": "GetQueues",
29374     "group": "Users",
29375     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29376     "version": "0.0.0",
29377     "filename": "server/api/user/index.js",
29378     "groupTitle": "Users"
29379   },
29380   {
29381     "type": "get",
29382     "url": "/api/users/{id}/recordings",
29383     "title": "GetRecordings",
29384     "examples": [
29385       {
29386         "title": "Example usage:",
29387         "content": "curl https://{domain}/api/users/{id}/recordings -v -u {name}:{password} -X GET",
29388         "type": "json"
29389       }
29390     ],
29391     "name": "GetRecordings",
29392     "group": "Users",
29393     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29394     "version": "0.0.0",
29395     "filename": "server/api/user/index.js",
29396     "groupTitle": "Users"
29397   },
29398   {
29399     "type": "get",
29400     "url": "/api/users/{id}/scheduled_calls",
29401     "title": "GetScheduledCalls",
29402     "examples": [
29403       {
29404         "title": "Example usage:",
29405         "content": "curl https://{domain}/api/users/{id}/scheduled_calls -v -u {name}:{password} -X GET",
29406         "type": "json"
29407       }
29408     ],
29409     "name": "GetScheduledCalls",
29410     "group": "Users",
29411     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29412     "version": "0.0.0",
29413     "filename": "server/api/user/index.js",
29414     "groupTitle": "Users"
29415   },
29416   {
29417     "type": "get",
29418     "url": "/api/users/{id}/screen_recordings",
29419     "title": "GetScreenRecordings",
29420     "examples": [
29421       {
29422         "title": "Example usage:",
29423         "content": "curl https://{domain}/api/users/{id}/screen_recordings -v -u {name}:{password} -X GET",
29424         "type": "json"
29425       }
29426     ],
29427     "name": "GetScreenRecordings",
29428     "group": "Users",
29429     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29430     "version": "0.0.0",
29431     "filename": "server/api/user/index.js",
29432     "groupTitle": "Users"
29433   },
29434   {
29435     "type": "get",
29436     "url": "/api/users/{id}/sms_accounts",
29437     "title": "GetSmsAccounts",
29438     "examples": [
29439       {
29440         "title": "Example usage:",
29441         "content": "curl https://{domain}/api/users/{id}/sms_accounts -v -u {name}:{password} -X GET",
29442         "type": "json"
29443       }
29444     ],
29445     "name": "GetSmsAccounts",
29446     "group": "Users",
29447     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29448     "version": "0.0.0",
29449     "filename": "server/api/user/index.js",
29450     "groupTitle": "Users"
29451   },
29452   {
29453     "type": "get",
29454     "url": "/api/users/{id}/sms/interactions",
29455     "title": "GetSmsInteractions",
29456     "examples": [
29457       {
29458         "title": "Example usage:",
29459         "content": "curl https://{domain}/api/users/{id}/sms/interactions -v -u {name}:{password} -X GET",
29460         "type": "json"
29461       }
29462     ],
29463     "name": "GetSmsInteractions",
29464     "group": "Users",
29465     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29466     "version": "0.0.0",
29467     "filename": "server/api/user/index.js",
29468     "groupTitle": "Users"
29469   },
29470   {
29471     "type": "get",
29472     "url": "/api/users/{id}/square_projects",
29473     "title": "GetSquareProjects",
29474     "examples": [
29475       {
29476         "title": "Example usage:",
29477         "content": "curl https://{domain}/api/users/{id}/square_projects -v -u {name}:{password} -X GET",
29478         "type": "json"
29479       }
29480     ],
29481     "name": "GetSquareProjects",
29482     "group": "Users",
29483     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29484     "version": "0.0.0",
29485     "filename": "server/api/user/index.js",
29486     "groupTitle": "Users"
29487   },
29488   {
29489     "type": "get",
29490     "url": "/api/users/{id}/teams",
29491     "title": "GetTeams",
29492     "examples": [
29493       {
29494         "title": "Example usage:",
29495         "content": "curl https://{domain}/api/users/{id}/teams -v -u {name}:{password} -X GET",
29496         "type": "json"
29497       }
29498     ],
29499     "name": "GetTeams",
29500     "group": "Users",
29501     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29502     "version": "0.0.0",
29503     "filename": "server/api/user/index.js",
29504     "groupTitle": "Users"
29505   },
29506   {
29507     "type": "get",
29508     "url": "/api/users",
29509     "title": "Gets a list of Users",
29510     "examples": [
29511       {
29512         "title": "Example usage:",
29513         "content": "curl https://{domain}/api/users -v -u {name}:{password}",
29514         "type": "json"
29515       }
29516     ],
29517     "name": "GetUsers",
29518     "group": "Users",
29519     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
29520     "version": "0.0.0",
29521     "filename": "server/api/user/index.js",
29522     "groupTitle": "Users"
29523   },
29524   {
29525     "type": "get",
29526     "url": "/api/users/{id}/queues_rt",
29527     "title": "GetVoiceQueuesRt",
29528     "examples": [
29529       {
29530         "title": "Example usage:",
29531         "content": "curl https://{domain}/api/users/{id}/queues_rt -v -u {name}:{password} -X GET",
29532         "type": "json"
29533       }
29534     ],
29535     "name": "GetVoiceQueuesRt",
29536     "group": "Users",
29537     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29538     "version": "0.0.0",
29539     "filename": "server/api/user/index.js",
29540     "groupTitle": "Users"
29541   },
29542   {
29543     "type": "get",
29544     "url": "/api/users/{id}/whatsapp_accounts",
29545     "title": "GetWhatsappAccounts",
29546     "examples": [
29547       {
29548         "title": "Example usage:",
29549         "content": "curl https://{domain}/api/users/{id}/whatsapp_accounts -v -u {name}:{password} -X GET",
29550         "type": "json"
29551       }
29552     ],
29553     "name": "GetWhatsappAccounts",
29554     "group": "Users",
29555     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29556     "version": "0.0.0",
29557     "filename": "server/api/user/index.js",
29558     "groupTitle": "Users"
29559   },
29560   {
29561     "type": "get",
29562     "url": "/api/users/{id}/whatsapp/interactions",
29563     "title": "GetWhatsappInteractions",
29564     "examples": [
29565       {
29566         "title": "Example usage:",
29567         "content": "curl https://{domain}/api/users/{id}/whatsapp/interactions -v -u {name}:{password} -X GET",
29568         "type": "json"
29569       }
29570     ],
29571     "name": "GetWhatsappInteractions",
29572     "group": "Users",
29573     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29574     "version": "0.0.0",
29575     "filename": "server/api/user/index.js",
29576     "groupTitle": "Users"
29577   },
29578   {
29579     "type": "post",
29580     "url": "/api/users/{id}/login",
29581     "title": "Login",
29582     "examples": [
29583       {
29584         "title": "Example usage:",
29585         "content": "curl https://{domain}/api/users/{id}/login  -v -u {name}:{password} -X POST",
29586         "type": "json"
29587       }
29588     ],
29589     "name": "Login",
29590     "group": "Users",
29591     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29592     "version": "0.0.0",
29593     "filename": "server/api/user/index.js",
29594     "groupTitle": "Users"
29595   },
29596   {
29597     "type": "post",
29598     "url": "/api/users/{id}/logout",
29599     "title": "Logout",
29600     "examples": [
29601       {
29602         "title": "Example usage:",
29603         "content": "curl https://{domain}/api/users/{id}/logout -v -u {name}:{password} -X POST",
29604         "type": "json"
29605       }
29606     ],
29607     "name": "Logout",
29608     "group": "Users",
29609     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29610     "version": "0.0.0",
29611     "filename": "server/api/user/index.js",
29612     "groupTitle": "Users"
29613   },
29614   {
29615     "type": "post",
29616     "url": "/api/users/{id}/pause",
29617     "title": "Pause",
29618     "examples": [
29619       {
29620         "title": "Example usage:",
29621         "content": "curl https://{domain}/api/users/{id}/pause -v -u {name}:{password} -X POST",
29622         "type": "json"
29623       }
29624     ],
29625     "name": "Pause",
29626     "group": "Users",
29627     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29628     "version": "0.0.0",
29629     "filename": "server/api/user/index.js",
29630     "groupTitle": "Users"
29631   },
29632   {
29633     "type": "delete",
29634     "url": "/api/users/{id}/api_key",
29635     "title": "Remove API access key for the user",
29636     "examples": [
29637       {
29638         "title": "Example usage:",
29639         "content": "curl https://{domain}/api/users/:id/api_key -v -u {name}:{password} -X DELETE",
29640         "type": "json"
29641       }
29642     ],
29643     "name": "RemoveApiKey",
29644     "group": "Users",
29645     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29646     "version": "0.0.0",
29647     "filename": "server/api/user/index.js",
29648     "groupTitle": "Users"
29649   },
29650   {
29651     "type": "delete",
29652     "url": "/api/users/{id}/chat_interactions",
29653     "title": "Removes interactions from an agent",
29654     "examples": [
29655       {
29656         "title": "Example usage:",
29657         "content": "curl https://{domain}/api/users/{id}/chat_interactions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29658         "type": "json"
29659       }
29660     ],
29661     "name": "RemoveChatInteractions",
29662     "group": "Users",
29663     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29664     "version": "0.0.0",
29665     "filename": "server/api/user/index.js",
29666     "groupTitle": "Users"
29667   },
29668   {
29669     "type": "delete",
29670     "url": "/api/users/{id}/chat_websites",
29671     "title": "Removes a Chat Website from a user",
29672     "examples": [
29673       {
29674         "title": "Example usage:",
29675         "content": "curl https://{domain}/api/users/{id}/chat_websites?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29676         "type": "json"
29677       }
29678     ],
29679     "name": "RemoveChatWebsites",
29680     "group": "Users",
29681     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29682     "version": "0.0.0",
29683     "filename": "server/api/user/index.js",
29684     "groupTitle": "Users"
29685   },
29686   {
29687     "type": "delete",
29688     "url": "/api/users/{id}/fax_accounts",
29689     "title": "Removes a Fax Account from a user",
29690     "examples": [
29691       {
29692         "title": "Example usage:",
29693         "content": "curl https://{domain}/api/users/{id}/fax_accounts?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29694         "type": "json"
29695       }
29696     ],
29697     "name": "RemoveFaxAccounts",
29698     "group": "Users",
29699     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29700     "version": "0.0.0",
29701     "filename": "server/api/user/index.js",
29702     "groupTitle": "Users"
29703   },
29704   {
29705     "type": "delete",
29706     "url": "/api/users/{id}/fax_interactions",
29707     "title": "Removes interactions from an agent",
29708     "examples": [
29709       {
29710         "title": "Example usage:",
29711         "content": "curl https://{domain}/api/users/{id}/fax_interactions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29712         "type": "json"
29713       }
29714     ],
29715     "name": "RemoveFaxInteractions",
29716     "group": "Users",
29717     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29718     "version": "0.0.0",
29719     "filename": "server/api/user/index.js",
29720     "groupTitle": "Users"
29721   },
29722   {
29723     "type": "delete",
29724     "url": "/api/users/{id}/mail_accounts",
29725     "title": "Removes a Mail Account from a user",
29726     "examples": [
29727       {
29728         "title": "Example usage:",
29729         "content": "curl https://{domain}/api/users/{id}/mail_accounts?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29730         "type": "json"
29731       }
29732     ],
29733     "name": "RemoveMailAccounts",
29734     "group": "Users",
29735     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29736     "version": "0.0.0",
29737     "filename": "server/api/user/index.js",
29738     "groupTitle": "Users"
29739   },
29740   {
29741     "type": "delete",
29742     "url": "/api/users/{id}/mail_interactions",
29743     "title": "Removes interactions from an agent",
29744     "examples": [
29745       {
29746         "title": "Example usage:",
29747         "content": "curl https://{domain}/api/users/{id}/mail_interactions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29748         "type": "json"
29749       }
29750     ],
29751     "name": "RemoveMailInteractions",
29752     "group": "Users",
29753     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29754     "version": "0.0.0",
29755     "filename": "server/api/user/index.js",
29756     "groupTitle": "Users"
29757   },
29758   {
29759     "type": "delete",
29760     "url": "/api/users/{id}/openchannel_accounts",
29761     "title": "Removes a Open Channel Account from a user",
29762     "examples": [
29763       {
29764         "title": "Example usage:",
29765         "content": "curl https://{domain}/api/users/{id}/openchannel_accounts?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29766         "type": "json"
29767       }
29768     ],
29769     "name": "RemoveOpenchannelAccounts",
29770     "group": "Users",
29771     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29772     "version": "0.0.0",
29773     "filename": "server/api/user/index.js",
29774     "groupTitle": "Users"
29775   },
29776   {
29777     "type": "delete",
29778     "url": "/api/users/{id}/openchannel_interactions",
29779     "title": "Removes openchannel interactions from an agent",
29780     "examples": [
29781       {
29782         "title": "Example usage:",
29783         "content": "curl https://{domain}/api/users/{id}/openchannel_interactions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29784         "type": "json"
29785       }
29786     ],
29787     "name": "RemoveOpenchannelInteractions",
29788     "group": "Users",
29789     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29790     "version": "0.0.0",
29791     "filename": "server/api/user/index.js",
29792     "groupTitle": "Users"
29793   },
29794   {
29795     "type": "delete",
29796     "url": "/api/users/{id}/queues",
29797     "title": "Remove queues to an agent",
29798     "examples": [
29799       {
29800         "title": "Example usage:",
29801         "content": "curl https://{domain}/api/users/{id}/queues?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29802         "type": "json"
29803       }
29804     ],
29805     "name": "RemoveQueues",
29806     "group": "Users",
29807     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29808     "version": "0.0.0",
29809     "filename": "server/api/user/index.js",
29810     "groupTitle": "Users"
29811   },
29812   {
29813     "type": "delete",
29814     "url": "/api/users/{id}/sms_accounts",
29815     "title": "Removes a Sms Account from a user",
29816     "examples": [
29817       {
29818         "title": "Example usage:",
29819         "content": "curl https://{domain}/api/users/{id}/sms_accounts?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29820         "type": "json"
29821       }
29822     ],
29823     "name": "RemoveSmsAccounts",
29824     "group": "Users",
29825     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29826     "version": "0.0.0",
29827     "filename": "server/api/user/index.js",
29828     "groupTitle": "Users"
29829   },
29830   {
29831     "type": "delete",
29832     "url": "/api/users/{id}/sms_interactions",
29833     "title": "Removes interactions from an agent",
29834     "examples": [
29835       {
29836         "title": "Example usage:",
29837         "content": "curl https://{domain}/api/users/{id}/sms_interactions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29838         "type": "json"
29839       }
29840     ],
29841     "name": "RemoveSmsInteractions",
29842     "group": "Users",
29843     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29844     "version": "0.0.0",
29845     "filename": "server/api/user/index.js",
29846     "groupTitle": "Users"
29847   },
29848   {
29849     "type": "delete",
29850     "url": "/api/users/{id}/square_projects",
29851     "title": "Removes a Square Project from a user",
29852     "examples": [
29853       {
29854         "title": "Example usage:",
29855         "content": "curl https://{domain}/api/users/{id}/square_projects?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29856         "type": "json"
29857       }
29858     ],
29859     "name": "RemoveSquareProjects",
29860     "group": "Users",
29861     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29862     "version": "0.0.0",
29863     "filename": "server/api/user/index.js",
29864     "groupTitle": "Users"
29865   },
29866   {
29867     "type": "delete",
29868     "url": "/api/users/{id}/teams",
29869     "title": "Removes teams from an agent",
29870     "examples": [
29871       {
29872         "title": "Example usage:",
29873         "content": "curl https://{domain}/api/users/{id}/teams?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29874         "type": "json"
29875       }
29876     ],
29877     "name": "RemoveTeams",
29878     "group": "Users",
29879     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29880     "version": "0.0.0",
29881     "filename": "server/api/user/index.js",
29882     "groupTitle": "Users"
29883   },
29884   {
29885     "type": "delete",
29886     "url": "/api/users/{id}/whatsapp_accounts",
29887     "title": "Removes a Whatsapp Account from a user",
29888     "examples": [
29889       {
29890         "title": "Example usage:",
29891         "content": "curl https://{domain}/api/users/{id}/whatsapp_accounts?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29892         "type": "json"
29893       }
29894     ],
29895     "name": "RemoveWhatsappAccounts",
29896     "group": "Users",
29897     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29898     "version": "0.0.0",
29899     "filename": "server/api/user/index.js",
29900     "groupTitle": "Users"
29901   },
29902   {
29903     "type": "delete",
29904     "url": "/api/users/{id}/whatsapp_interactions",
29905     "title": "Removes Whatsapp interactions from an agent",
29906     "examples": [
29907       {
29908         "title": "Example usage:",
29909         "content": "curl https://{domain}/api/users/{id}/whatsapp_interactions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29910         "type": "json"
29911       }
29912     ],
29913     "name": "RemoveWhatsappInteractions",
29914     "group": "Users",
29915     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29916     "version": "0.0.0",
29917     "filename": "server/api/user/index.js",
29918     "groupTitle": "Users"
29919   },
29920   {
29921     "type": "get",
29922     "url": "/api/users/{id}",
29923     "title": "Gets a single User",
29924     "examples": [
29925       {
29926         "title": "Example usage:",
29927         "content": "curl https://{domain}/api/users/{id} -v -u {name}:{password}",
29928         "type": "json"
29929       }
29930     ],
29931     "name": "ShowUsers",
29932     "group": "Users",
29933     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29934     "version": "0.0.0",
29935     "filename": "server/api/user/index.js",
29936     "groupTitle": "Users"
29937   },
29938   {
29939     "type": "post",
29940     "url": "/api/users/{id}/unpause",
29941     "title": "Unpause",
29942     "examples": [
29943       {
29944         "title": "Example usage:",
29945         "content": "curl https://{domain}/api/users/{id}/unpause -v -u {name}:{password} -X POST",
29946         "type": "json"
29947       }
29948     ],
29949     "name": "Unpause",
29950     "group": "Users",
29951     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29952     "version": "0.0.0",
29953     "filename": "server/api/user/index.js",
29954     "groupTitle": "Users"
29955   },
29956   {
29957     "type": "get",
29958     "url": "/api/users/whoami",
29959     "title": "WhoAmI",
29960     "examples": [
29961       {
29962         "title": "Example usage:",
29963         "content": "curl https://{domain}/api/users/whoami -v -u {name}:{password} -X GET",
29964         "type": "json"
29965       }
29966     ],
29967     "name": "WhoAmI",
29968     "group": "Users",
29969     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29970     "version": "0.0.0",
29971     "filename": "server/api/user/index.js",
29972     "groupTitle": "Users"
29973   },
29974   {
29975     "type": "post",
29976     "url": "/api/users/{id}/avatar",
29977     "title": "Add avatar",
29978     "examples": [
29979       {
29980         "title": "Example usage:",
29981         "content": "curl https://{domain}/api/users/{id}/avatar -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
29982         "type": "json"
29983       }
29984     ],
29985     "name": "addAvatar",
29986     "group": "Users",
29987     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29988     "version": "0.0.0",
29989     "filename": "server/api/user/index.js",
29990     "groupTitle": "Users"
29991   },
29992   {
29993     "type": "post",
29994     "url": "/api/users/create_many",
29995     "title": "Create Users",
29996     "examples": [
29997       {
29998         "title": "Example usage:",
29999         "content": "curl https://{domain}/api/users/create_many -d '[{\"name\": \"john.doe\", \"role\": \"user\", \"...\": \"...\"}]' -v -u {name}:{password} -X POST",
30000         "type": "json"
30001       }
30002     ],
30003     "name": "bulkCreate",
30004     "group": "Users",
30005     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30006     "version": "0.0.0",
30007     "filename": "server/api/user/index.js",
30008     "groupTitle": "Users"
30009   },
30010   {
30011     "type": "get",
30012     "url": "/api/users/{id}/avatar",
30013     "title": "Get avatar",
30014     "examples": [
30015       {
30016         "title": "Example usage:",
30017         "content": "curl https://{domain}/api/users/{id}/avatar -v -u {name}:{password} -X GET",
30018         "type": "json"
30019       }
30020     ],
30021     "name": "getAvatar",
30022     "group": "Users",
30023     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30024     "version": "0.0.0",
30025     "filename": "server/api/user/index.js",
30026     "groupTitle": "Users"
30027   },
30028   {
30029     "type": "get",
30030     "url": "/api/users/{id}/open_tabs",
30031     "title": "Get interactions opened tabs",
30032     "examples": [
30033       {
30034         "title": "Example usage:",
30035         "content": "curl https://{domain}/api/users/{id}/open_tabs -v -u {name}:{password} -X GET",
30036         "type": "json"
30037       }
30038     ],
30039     "name": "getOpenTabs",
30040     "group": "Users",
30041     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30042     "version": "0.0.0",
30043     "filename": "server/api/user/index.js",
30044     "groupTitle": "Users"
30045   },
30046   {
30047     "type": "get",
30048     "url": "/api/users/presence",
30049     "title": "Gets agent presence",
30050     "examples": [
30051       {
30052         "title": "Example usage:",
30053         "content": "curl https://{domain}/api/users/presence -v -u {name}:{password}  -X GET",
30054         "type": "json"
30055       }
30056     ],
30057     "name": "getPresence",
30058     "group": "Users",
30059     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30060     "version": "0.0.0",
30061     "filename": "server/api/user/index.js",
30062     "groupTitle": "Users"
30063   },
30064   {
30065     "type": "put",
30066     "url": "/api/users/{id}",
30067     "title": "Update an existing User",
30068     "examples": [
30069       {
30070         "title": "Example usage:",
30071         "content": "curl https://{domain}/api/users/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
30072         "type": "json"
30073       }
30074     ],
30075     "name": "updateUsers",
30076     "group": "Users",
30077     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30078     "version": "0.0.0",
30079     "filename": "server/api/user/index.js",
30080     "groupTitle": "Users"
30081   },
30082   {
30083     "type": "post",
30084     "url": "/api/variables",
30085     "title": "Creates a new Variable",
30086     "examples": [
30087       {
30088         "title": "Example usage:",
30089         "content": "curl https://{domain}/api/variables -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
30090         "type": "json"
30091       }
30092     ],
30093     "name": "CreateVariables",
30094     "group": "Variables",
30095     "parameter": {
30096       "fields": {
30097         "Body": [
30098           {
30099             "group": "Body",
30100             "type": "String",
30101             "optional": false,
30102             "field": "name",
30103             "description": ""
30104           },
30105           {
30106             "group": "Body",
30107             "type": "String",
30108             "optional": true,
30109             "field": "description",
30110             "description": ""
30111           }
30112         ]
30113       }
30114     },
30115     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30116     "version": "0.0.0",
30117     "filename": "server/api/variable/index.js",
30118     "groupTitle": "Variables"
30119   },
30120   {
30121     "type": "delete",
30122     "url": "/api/variables/{id}",
30123     "title": "Deletes a Variable",
30124     "examples": [
30125       {
30126         "title": "Example usage:",
30127         "content": "curl https://{domain}/api/variables/{id} -v -u {name}:{password} -X DELETE",
30128         "type": "json"
30129       }
30130     ],
30131     "name": "DeleteVariables",
30132     "group": "Variables",
30133     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30134     "version": "0.0.0",
30135     "filename": "server/api/variable/index.js",
30136     "groupTitle": "Variables"
30137   },
30138   {
30139     "type": "get",
30140     "url": "/api/variables",
30141     "title": "Gets a list of Variables",
30142     "examples": [
30143       {
30144         "title": "Example usage:",
30145         "content": "curl https://{domain}/api/variables -v -u {name}:{password}",
30146         "type": "json"
30147       }
30148     ],
30149     "name": "GetVariables",
30150     "group": "Variables",
30151     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
30152     "version": "0.0.0",
30153     "filename": "server/api/variable/index.js",
30154     "groupTitle": "Variables"
30155   },
30156   {
30157     "type": "get",
30158     "url": "/api/variables/{id}",
30159     "title": "Gets a single Variable",
30160     "examples": [
30161       {
30162         "title": "Example usage:",
30163         "content": "curl https://{domain}/api/variables/{id} -v -u {name}:{password}",
30164         "type": "json"
30165       }
30166     ],
30167     "name": "ShowVariables",
30168     "group": "Variables",
30169     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30170     "version": "0.0.0",
30171     "filename": "server/api/variable/index.js",
30172     "groupTitle": "Variables"
30173   },
30174   {
30175     "type": "put",
30176     "url": "/api/variables/{id}",
30177     "title": "Update an existing Variable",
30178     "examples": [
30179       {
30180         "title": "Example usage:",
30181         "content": "curl https://{domain}/api/variables/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
30182         "type": "json"
30183       }
30184     ],
30185     "name": "updateVariables",
30186     "group": "Variables",
30187     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30188     "version": "0.0.0",
30189     "filename": "server/api/variable/index.js",
30190     "groupTitle": "Variables"
30191   },
30192   {
30193     "type": "get",
30194     "url": "/api/version/fetch",
30195     "title": "Fetch git version",
30196     "examples": [
30197       {
30198         "title": "Example usage:",
30199         "content": "curl https://{domain}/api/version/fetch -v -u {name}:{password}",
30200         "type": "json"
30201       }
30202     ],
30203     "name": "FetchVersion",
30204     "group": "Version",
30205     "description": "<p>Motion run the following command: git fetch origin master</p>",
30206     "version": "0.0.0",
30207     "filename": "server/api/version/index.js",
30208     "groupTitle": "Version"
30209   },
30210   {
30211     "type": "get",
30212     "url": "/api/version",
30213     "title": "Gets version",
30214     "examples": [
30215       {
30216         "title": "Example usage:",
30217         "content": "curl https://{domain}/api/version -v -u {name}:{password}",
30218         "type": "json"
30219       }
30220     ],
30221     "name": "GetVersion",
30222     "group": "Version",
30223     "description": "<p>Motion returns the current and latest motion version.</p>",
30224     "version": "0.0.0",
30225     "filename": "server/api/version/index.js",
30226     "groupTitle": "Version"
30227   },
30228   {
30229     "type": "get",
30230     "url": "/api/version/migrations",
30231     "title": "Launch database migrations",
30232     "examples": [
30233       {
30234         "title": "Example usage:",
30235         "content": "curl https://{domain}/api/version/migrations -v -u {name}:{password}",
30236         "type": "json"
30237       }
30238     ],
30239     "name": "MigrateVersion",
30240     "group": "Version",
30241     "description": "<p>Motion launch the database migrations, according to the application version</p>",
30242     "version": "0.0.0",
30243     "filename": "server/api/version/index.js",
30244     "groupTitle": "Version"
30245   },
30246   {
30247     "type": "get",
30248     "url": "/api/version/pull",
30249     "title": "Pull git version",
30250     "examples": [
30251       {
30252         "title": "Example usage:",
30253         "content": "curl https://{domain}/api/version/pull -v -u {name}:{password}",
30254         "type": "json"
30255       }
30256     ],
30257     "name": "PullVersion",
30258     "group": "Version",
30259     "description": "<p>Motion run the following command: git pull</p>",
30260     "version": "0.0.0",
30261     "filename": "server/api/version/index.js",
30262     "groupTitle": "Version"
30263   },
30264   {
30265     "type": "get",
30266     "url": "/api/version/reset",
30267     "title": "Reset git version",
30268     "examples": [
30269       {
30270         "title": "Example usage:",
30271         "content": "curl https://{domain}/api/version/reset -v -u {name}:{password}",
30272         "type": "json"
30273       }
30274     ],
30275     "name": "ResetVersion",
30276     "group": "Version",
30277     "description": "<p>Motion run the following command: git reset --hard FETCH_HEAD</p>",
30278     "version": "0.0.0",
30279     "filename": "server/api/version/index.js",
30280     "groupTitle": "Version"
30281   },
30282   {
30283     "type": "get",
30284     "url": "/api/version/restart",
30285     "title": "Restart motion2 after update",
30286     "examples": [
30287       {
30288         "title": "Example usage:",
30289         "content": "curl https://{domain}/api/version/restart -v -u {name}:{password}",
30290         "type": "json"
30291       }
30292     ],
30293     "name": "RestartVersion",
30294     "group": "Version",
30295     "description": "<p>Motion run the following command: pm2 restart motion</p>",
30296     "version": "0.0.0",
30297     "filename": "server/api/version/index.js",
30298     "groupTitle": "Version"
30299   },
30300   {
30301     "type": "get",
30302     "url": "/api/voice/agents/reports/describe",
30303     "title": "Gets table info about Agent Reports",
30304     "examples": [
30305       {
30306         "title": "Example usage:",
30307         "content": "curl https://{domain}/api/voice/agents/reports/describe -v -u {name}:{password}",
30308         "type": "json"
30309       }
30310     ],
30311     "name": "DescribeAgent_Reports",
30312     "group": "Voice_Agent_Reports",
30313     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30314     "version": "0.0.0",
30315     "filename": "server/api/voiceAgentReport/index.js",
30316     "groupTitle": "Voice_Agent_Reports"
30317   },
30318   {
30319     "type": "get",
30320     "url": "/api/voice/agents/reports",
30321     "title": "Gets a list of Agent Reports",
30322     "examples": [
30323       {
30324         "title": "Example usage:",
30325         "content": "curl https://{domain}/api/voice/agents/reports -v -u {name}:{password}",
30326         "type": "json"
30327       }
30328     ],
30329     "name": "GetAgent_Reports",
30330     "group": "Voice_Agent_Reports",
30331     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
30332     "version": "0.0.0",
30333     "filename": "server/api/voiceAgentReport/index.js",
30334     "groupTitle": "Voice_Agent_Reports"
30335   },
30336   {
30337     "type": "get",
30338     "url": "/api/voice/agents/reports/{id}",
30339     "title": "Gets a single Agent Report",
30340     "examples": [
30341       {
30342         "title": "Example usage:",
30343         "content": "curl https://{domain}/api/voice/agents/reports/{id} -v -u {name}:{password}",
30344         "type": "json"
30345       }
30346     ],
30347     "name": "ShowAgent_Reports",
30348     "group": "Voice_Agent_Reports",
30349     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30350     "version": "0.0.0",
30351     "filename": "server/api/voiceAgentReport/index.js",
30352     "groupTitle": "Voice_Agent_Reports"
30353   },
30354   {
30355     "type": "get",
30356     "url": "/api/voice/calls/reports/describe",
30357     "title": "Gets table info about Call Reports",
30358     "examples": [
30359       {
30360         "title": "Example usage:",
30361         "content": "curl https://{domain}/api/voice/calls/reports/describe -v -u {name}:{password}",
30362         "type": "json"
30363       }
30364     ],
30365     "name": "DescribeCall_Reports",
30366     "group": "Voice_Call_Reports",
30367     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30368     "version": "0.0.0",
30369     "filename": "server/api/voiceCallReport/index.js",
30370     "groupTitle": "Voice_Call_Reports"
30371   },
30372   {
30373     "type": "get",
30374     "url": "/api/voice/calls/reports",
30375     "title": "Gets a list of Call Reports",
30376     "examples": [
30377       {
30378         "title": "Example usage:",
30379         "content": "curl https://{domain}/api/voice/calls/reports -v -u {name}:{password}",
30380         "type": "json"
30381       }
30382     ],
30383     "name": "GetCall_Reports",
30384     "group": "Voice_Call_Reports",
30385     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
30386     "version": "0.0.0",
30387     "filename": "server/api/voiceCallReport/index.js",
30388     "groupTitle": "Voice_Call_Reports"
30389   },
30390   {
30391     "type": "get",
30392     "url": "/api/voice/calls/reports/{id}",
30393     "title": "Gets a single Call Report",
30394     "examples": [
30395       {
30396         "title": "Example usage:",
30397         "content": "curl https://{domain}/api/voice/calls/reports/{id} -v -u {name}:{password}",
30398         "type": "json"
30399       }
30400     ],
30401     "name": "ShowCall_Reports",
30402     "group": "Voice_Call_Reports",
30403     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30404     "version": "0.0.0",
30405     "filename": "server/api/voiceCallReport/index.js",
30406     "groupTitle": "Voice_Call_Reports"
30407   },
30408   {
30409     "type": "put",
30410     "url": "/api/voice/calls/reports/{id}",
30411     "title": "Update a single cdr",
30412     "examples": [
30413       {
30414         "title": "Example usage:",
30415         "content": "curl https://{domain}/api/voice/calls/reports/{id} -d '{\"userDispositio\": \"OK\"}' -v -u {name}:{password} -X PUT",
30416         "type": "json"
30417       }
30418     ],
30419     "name": "update",
30420     "group": "Voice_Call_Reports",
30421     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30422     "version": "0.0.0",
30423     "filename": "server/api/voiceCallReport/index.js",
30424     "groupTitle": "Voice_Call_Reports"
30425   },
30426   {
30427     "type": "post",
30428     "url": "/api/voice/chanspy",
30429     "title": "Creates a new ChanSpy",
30430     "examples": [
30431       {
30432         "title": "Example usage:",
30433         "content": "curl https://{domain}/api/voice/chanspy -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
30434         "type": "json"
30435       }
30436     ],
30437     "name": "CreateChanSpy",
30438     "group": "Voice_ChanSpy",
30439     "parameter": {
30440       "fields": {
30441         "Body": [
30442           {
30443             "group": "Body",
30444             "type": "String",
30445             "optional": true,
30446             "field": "name",
30447             "description": ""
30448           },
30449           {
30450             "group": "Body",
30451             "type": "String",
30452             "optional": false,
30453             "field": "prefix",
30454             "description": ""
30455           },
30456           {
30457             "group": "Body",
30458             "type": "String",
30459             "optional": true,
30460             "field": "options",
30461             "description": ""
30462           },
30463           {
30464             "group": "Body",
30465             "type": "Boolean",
30466             "optional": true,
30467             "field": "auth",
30468             "description": ""
30469           },
30470           {
30471             "group": "Body",
30472             "type": "String",
30473             "optional": true,
30474             "field": "password",
30475             "description": ""
30476           },
30477           {
30478             "group": "Body",
30479             "type": "Boolean",
30480             "optional": true,
30481             "field": "record",
30482             "description": ""
30483           },
30484           {
30485             "group": "Body",
30486             "type": "String",
30487             "optional": true,
30488             "field": "recordingFormat",
30489             "description": ""
30490           },
30491           {
30492             "group": "Body",
30493             "type": "String",
30494             "optional": true,
30495             "field": "description",
30496             "description": ""
30497           }
30498         ]
30499       }
30500     },
30501     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30502     "version": "0.0.0",
30503     "filename": "server/api/voiceChanSpy/index.js",
30504     "groupTitle": "Voice_ChanSpy"
30505   },
30506   {
30507     "type": "delete",
30508     "url": "/api/voice/chanspy/{id}",
30509     "title": "Deletes a ChanSpy",
30510     "examples": [
30511       {
30512         "title": "Example usage:",
30513         "content": "curl https://{domain}/api/voice/chanspy/{id} -v -u {name}:{password} -X DELETE",
30514         "type": "json"
30515       }
30516     ],
30517     "name": "DeleteChanSpy",
30518     "group": "Voice_ChanSpy",
30519     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30520     "version": "0.0.0",
30521     "filename": "server/api/voiceChanSpy/index.js",
30522     "groupTitle": "Voice_ChanSpy"
30523   },
30524   {
30525     "type": "get",
30526     "url": "/api/voice/chanspy",
30527     "title": "Gets a list of ChanSpy",
30528     "examples": [
30529       {
30530         "title": "Example usage:",
30531         "content": "curl https://{domain}/api/voice/chanspy -v -u {name}:{password}",
30532         "type": "json"
30533       }
30534     ],
30535     "name": "GetChanSpy",
30536     "group": "Voice_ChanSpy",
30537     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
30538     "version": "0.0.0",
30539     "filename": "server/api/voiceChanSpy/index.js",
30540     "groupTitle": "Voice_ChanSpy"
30541   },
30542   {
30543     "type": "get",
30544     "url": "/api/voice/chanspy/{id}",
30545     "title": "Gets a single ChanSpy",
30546     "examples": [
30547       {
30548         "title": "Example usage:",
30549         "content": "curl https://{domain}/api/voice/chanspy/{id} -v -u {name}:{password}",
30550         "type": "json"
30551       }
30552     ],
30553     "name": "ShowChanSpy",
30554     "group": "Voice_ChanSpy",
30555     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30556     "version": "0.0.0",
30557     "filename": "server/api/voiceChanSpy/index.js",
30558     "groupTitle": "Voice_ChanSpy"
30559   },
30560   {
30561     "type": "put",
30562     "url": "/api/voice/chanspy/{id}",
30563     "title": "Update an existing ChanSpy",
30564     "examples": [
30565       {
30566         "title": "Example usage:",
30567         "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",
30568         "type": "json"
30569       }
30570     ],
30571     "name": "updateChanSpy",
30572     "group": "Voice_ChanSpy",
30573     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30574     "version": "0.0.0",
30575     "filename": "server/api/voiceChanSpy/index.js",
30576     "groupTitle": "Voice_ChanSpy"
30577   },
30578   {
30579     "type": "post",
30580     "url": "/api/voice/contexts",
30581     "title": "Create a new context",
30582     "examples": [
30583       {
30584         "title": "Example usage:",
30585         "content": "curl https://{domain}/api/voice/contexts -v -u {name}:{password} -X POST",
30586         "type": "json"
30587       }
30588     ],
30589     "name": "Create",
30590     "group": "Voice_Contexts",
30591     "parameter": {
30592       "fields": {
30593         "Body": [
30594           {
30595             "group": "Body",
30596             "type": "String",
30597             "optional": true,
30598             "field": "name",
30599             "description": ""
30600           },
30601           {
30602             "group": "Body",
30603             "type": "String",
30604             "optional": true,
30605             "field": "description",
30606             "description": ""
30607           },
30608           {
30609             "group": "Body",
30610             "type": "Boolean",
30611             "optional": true,
30612             "field": "defaultEntry",
30613             "description": ""
30614           }
30615         ]
30616       }
30617     },
30618     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30619     "version": "0.0.0",
30620     "filename": "server/api/voiceContext/index.js",
30621     "groupTitle": "Voice_Contexts"
30622   },
30623   {
30624     "type": "delete",
30625     "url": "/api/voice/contexts/{id}",
30626     "title": "Deletes a context",
30627     "examples": [
30628       {
30629         "title": "Example usage:",
30630         "content": "curl https://{domain}/api/voice/contexts/{id} -v -u {name}:{password} -X DELETE",
30631         "type": "json"
30632       }
30633     ],
30634     "name": "Delete",
30635     "group": "Voice_Contexts",
30636     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30637     "version": "0.0.0",
30638     "filename": "server/api/voiceContext/index.js",
30639     "groupTitle": "Voice_Contexts"
30640   },
30641   {
30642     "type": "get",
30643     "url": "/api/voice/contexts",
30644     "title": "Gets a list of Contexts",
30645     "examples": [
30646       {
30647         "title": "Example usage:",
30648         "content": "curl https://{domain}/api/voice/contexts -v -u {name}:{password}",
30649         "type": "json"
30650       }
30651     ],
30652     "name": "GetContexts",
30653     "group": "Voice_Contexts",
30654     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
30655     "version": "0.0.0",
30656     "filename": "server/api/voiceContext/index.js",
30657     "groupTitle": "Voice_Contexts"
30658   },
30659   {
30660     "type": "get",
30661     "url": "/api/voice/contexts/{id}",
30662     "title": "Gets a single Context",
30663     "examples": [
30664       {
30665         "title": "Example usage:",
30666         "content": "curl https://{domain}/api/voice/contexts/{id} -v -u {name}:{password}",
30667         "type": "json"
30668       }
30669     ],
30670     "name": "ShowContexts",
30671     "group": "Voice_Contexts",
30672     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30673     "version": "0.0.0",
30674     "filename": "server/api/voiceContext/index.js",
30675     "groupTitle": "Voice_Contexts"
30676   },
30677   {
30678     "type": "put",
30679     "url": "/api/voice/contexts/{id}",
30680     "title": "Update an existing context",
30681     "examples": [
30682       {
30683         "title": "Example usage:",
30684         "content": "curl https://{domain}/api/voice/contexts/{id} -v -u {name}:{password} -X PUT",
30685         "type": "json"
30686       }
30687     ],
30688     "name": "Update",
30689     "group": "Voice_Contexts",
30690     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30691     "version": "0.0.0",
30692     "filename": "server/api/voiceContext/index.js",
30693     "groupTitle": "Voice_Contexts"
30694   },
30695   {
30696     "type": "get",
30697     "url": "/api/voice/dials/reports/describe",
30698     "title": "Gets table info about Dial Reports",
30699     "examples": [
30700       {
30701         "title": "Example usage:",
30702         "content": "curl https://{domain}/api/voice/dials/reports/describe -v -u {name}:{password}",
30703         "type": "json"
30704       }
30705     ],
30706     "name": "DescribeDial_Reports",
30707     "group": "Voice_Dial_Reports",
30708     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30709     "version": "0.0.0",
30710     "filename": "server/api/voiceDialReport/index.js",
30711     "groupTitle": "Voice_Dial_Reports"
30712   },
30713   {
30714     "type": "get",
30715     "url": "/api/voice/dials/reports",
30716     "title": "Gets a list of Dial Reports",
30717     "examples": [
30718       {
30719         "title": "Example usage:",
30720         "content": "curl https://{domain}/api/voice/dials/reports -v -u {name}:{password}",
30721         "type": "json"
30722       }
30723     ],
30724     "name": "GetDial_Reports",
30725     "group": "Voice_Dial_Reports",
30726     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
30727     "version": "0.0.0",
30728     "filename": "server/api/voiceDialReport/index.js",
30729     "groupTitle": "Voice_Dial_Reports"
30730   },
30731   {
30732     "type": "get",
30733     "url": "/api/voice/dials/reports/{id}",
30734     "title": "Gets a single Dial Report",
30735     "examples": [
30736       {
30737         "title": "Example usage:",
30738         "content": "curl https://{domain}/api/voice/dials/reports/{id} -v -u {name}:{password}",
30739         "type": "json"
30740       }
30741     ],
30742     "name": "ShowDial_Reports",
30743     "group": "Voice_Dial_Reports",
30744     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30745     "version": "0.0.0",
30746     "filename": "server/api/voiceDialReport/index.js",
30747     "groupTitle": "Voice_Dial_Reports"
30748   },
30749   {
30750     "type": "delete",
30751     "url": "/api/voice/extensions/{id}",
30752     "title": "Deletes a Extension",
30753     "examples": [
30754       {
30755         "title": "Example usage:",
30756         "content": "curl https://{domain}/api/voice/extensions/{id} -v -u {name}:{password} -X DELETE",
30757         "type": "json"
30758       }
30759     ],
30760     "name": "DeleteExtensions",
30761     "group": "Voice_Extensions",
30762     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30763     "version": "0.0.0",
30764     "filename": "server/api/voiceExtension/index.js",
30765     "groupTitle": "Voice_Extensions"
30766   },
30767   {
30768     "type": "get",
30769     "url": "/api/voice/extensions",
30770     "title": "Gets a list of Extensions",
30771     "examples": [
30772       {
30773         "title": "Example usage:",
30774         "content": "curl https://{domain}/api/voice/extensions -v -u {name}:{password}",
30775         "type": "json"
30776       }
30777     ],
30778     "name": "GetExtensions",
30779     "group": "Voice_Extensions",
30780     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
30781     "version": "0.0.0",
30782     "filename": "server/api/voiceExtension/index.js",
30783     "groupTitle": "Voice_Extensions"
30784   },
30785   {
30786     "type": "get",
30787     "url": "/api/voice/extensions/{id}",
30788     "title": "Gets a single Extension",
30789     "examples": [
30790       {
30791         "title": "Example usage:",
30792         "content": "curl https://{domain}/api/voice/extensions/{id} -v -u {name}:{password}",
30793         "type": "json"
30794       }
30795     ],
30796     "name": "ShowExtensions",
30797     "group": "Voice_Extensions",
30798     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30799     "version": "0.0.0",
30800     "filename": "server/api/voiceExtension/index.js",
30801     "groupTitle": "Voice_Extensions"
30802   },
30803   {
30804     "type": "post",
30805     "url": "/api/voice/extensions",
30806     "title": "Create new applications",
30807     "examples": [
30808       {
30809         "title": "Example usage:",
30810         "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",
30811         "type": "json"
30812       }
30813     ],
30814     "name": "addApplications",
30815     "group": "Voice_Extensions",
30816     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30817     "version": "0.0.0",
30818     "filename": "server/api/voiceExtension/index.js",
30819     "groupTitle": "Voice_Extensions"
30820   },
30821   {
30822     "type": "post",
30823     "url": "/api/voice/extensions",
30824     "title": "Create an extension",
30825     "examples": [
30826       {
30827         "title": "Example usage:",
30828         "content": "curl https://{domain}/api/voice/extensions -d '{\"exten\": \"12345\", \"context\": \"from-custom\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
30829         "type": "json"
30830       }
30831     ],
30832     "name": "create",
30833     "group": "Voice_Extensions",
30834     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30835     "version": "0.0.0",
30836     "filename": "server/api/voiceExtension/index.js",
30837     "groupTitle": "Voice_Extensions"
30838   },
30839   {
30840     "type": "put",
30841     "url": "/api/voice/extensions/{id}",
30842     "title": "Update an extension",
30843     "examples": [
30844       {
30845         "title": "Example usage:",
30846         "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",
30847         "type": "json"
30848       }
30849     ],
30850     "name": "update",
30851     "group": "Voice_Extensions",
30852     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30853     "version": "0.0.0",
30854     "filename": "server/api/voiceExtension/index.js",
30855     "groupTitle": "Voice_Extensions"
30856   },
30857   {
30858     "type": "post",
30859     "url": "/api/voice/mohs",
30860     "title": "Create a new a new MOH",
30861     "examples": [
30862       {
30863         "title": "Example usage:",
30864         "content": "curl https://{domain}/api/voice/mohs -d '{\"name\": \"xmas_musics\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
30865         "type": "json"
30866       }
30867     ],
30868     "name": "AddMoh",
30869     "group": "Voice_MOHs",
30870     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30871     "version": "0.0.0",
30872     "filename": "server/api/voiceMusicOnHold/index.js",
30873     "groupTitle": "Voice_MOHs"
30874   },
30875   {
30876     "type": "post",
30877     "url": "/api/voice/mohs/{id}/sounds",
30878     "title": "Add sound to MOH",
30879     "examples": [
30880       {
30881         "title": "Example usage:",
30882         "content": "curl https://{domain}/api/voice/mohs/{id}/sounds -d '{\"id\": 1}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
30883         "type": "json"
30884       }
30885     ],
30886     "name": "AddSound",
30887     "group": "Voice_MOHs",
30888     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30889     "version": "0.0.0",
30890     "filename": "server/api/voiceMusicOnHold/index.js",
30891     "groupTitle": "Voice_MOHs"
30892   },
30893   {
30894     "type": "delete",
30895     "url": "/api/voice/mohs/{id}",
30896     "title": "Deletes an MOH",
30897     "examples": [
30898       {
30899         "title": "Example usage:",
30900         "content": "curl https://{domain}/api/voice/mohs/{id} -v -u {name}:{password} -X DELETE",
30901         "type": "json"
30902       }
30903     ],
30904     "name": "DestroyMoh",
30905     "group": "Voice_MOHs",
30906     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30907     "version": "0.0.0",
30908     "filename": "server/api/voiceMusicOnHold/index.js",
30909     "groupTitle": "Voice_MOHs"
30910   },
30911   {
30912     "type": "get",
30913     "url": "/api/voice/mohs",
30914     "title": "Gets a list of Music On Holds",
30915     "examples": [
30916       {
30917         "title": "Example usage:",
30918         "content": "curl https://{domain}/api/voice/mohs -v -u {name}:{password}",
30919         "type": "json"
30920       }
30921     ],
30922     "name": "GetMusic_On_Holds",
30923     "group": "Voice_MOHs",
30924     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
30925     "version": "0.0.0",
30926     "filename": "server/api/voiceMusicOnHold/index.js",
30927     "groupTitle": "Voice_MOHs"
30928   },
30929   {
30930     "type": "get",
30931     "url": "/api/voice/mohs/{id}/sounds",
30932     "title": "Gets sounds from MOH",
30933     "examples": [
30934       {
30935         "title": "Example usage:",
30936         "content": "curl https://{domain}/api/voice/mohs/{id}/sounds -v -u {name}:{password} -X DELETE",
30937         "type": "json"
30938       }
30939     ],
30940     "name": "GetSounds",
30941     "group": "Voice_MOHs",
30942     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30943     "version": "0.0.0",
30944     "filename": "server/api/voiceMusicOnHold/index.js",
30945     "groupTitle": "Voice_MOHs"
30946   },
30947   {
30948     "type": "delete",
30949     "url": "/api/voice/mohs/{id}/sounds/{id2}",
30950     "title": "Remove sound from MOH",
30951     "examples": [
30952       {
30953         "title": "Example usage:",
30954         "content": "curl https://{domain}/api/voice/mohs/{id}/sounds/{id2} -v -u {name}:{password} -X DELETE",
30955         "type": "json"
30956       }
30957     ],
30958     "name": "RemoveSound",
30959     "group": "Voice_MOHs",
30960     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30961     "version": "0.0.0",
30962     "filename": "server/api/voiceMusicOnHold/index.js",
30963     "groupTitle": "Voice_MOHs"
30964   },
30965   {
30966     "type": "get",
30967     "url": "/api/voice/mohs/{id}",
30968     "title": "Gets a single Music On Hold",
30969     "examples": [
30970       {
30971         "title": "Example usage:",
30972         "content": "curl https://{domain}/api/voice/mohs/{id} -v -u {name}:{password}",
30973         "type": "json"
30974       }
30975     ],
30976     "name": "ShowMusic_On_Holds",
30977     "group": "Voice_MOHs",
30978     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30979     "version": "0.0.0",
30980     "filename": "server/api/voiceMusicOnHold/index.js",
30981     "groupTitle": "Voice_MOHs"
30982   },
30983   {
30984     "type": "put",
30985     "url": "/api/voice/mohs/{id}",
30986     "title": "Update an existing Music On Hold",
30987     "examples": [
30988       {
30989         "title": "Example usage:",
30990         "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",
30991         "type": "json"
30992       }
30993     ],
30994     "name": "updateMusic_On_Holds",
30995     "group": "Voice_MOHs",
30996     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30997     "version": "0.0.0",
30998     "filename": "server/api/voiceMusicOnHold/index.js",
30999     "groupTitle": "Voice_MOHs"
31000   },
31001   {
31002     "type": "post",
31003     "url": "/api/voice/mails",
31004     "title": "Creates a new Mail",
31005     "examples": [
31006       {
31007         "title": "Example usage:",
31008         "content": "curl https://{domain}/api/voice/mails -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
31009         "type": "json"
31010       }
31011     ],
31012     "name": "CreateMails",
31013     "group": "Voice_Mails",
31014     "parameter": {
31015       "fields": {
31016         "Body": [
31017           {
31018             "group": "Body",
31019             "type": "String",
31020             "optional": true,
31021             "field": "customer_id",
31022             "description": ""
31023           },
31024           {
31025             "group": "Body",
31026             "type": "String",
31027             "optional": true,
31028             "field": "context",
31029             "description": ""
31030           },
31031           {
31032             "group": "Body",
31033             "type": "String",
31034             "optional": false,
31035             "field": "mailbox",
31036             "description": ""
31037           },
31038           {
31039             "group": "Body",
31040             "type": "String",
31041             "optional": true,
31042             "field": "password",
31043             "description": ""
31044           },
31045           {
31046             "group": "Body",
31047             "type": "String",
31048             "optional": true,
31049             "field": "fullname",
31050             "description": ""
31051           },
31052           {
31053             "group": "Body",
31054             "type": "String",
31055             "optional": true,
31056             "field": "email",
31057             "description": ""
31058           },
31059           {
31060             "group": "Body",
31061             "type": "String",
31062             "optional": true,
31063             "field": "pager",
31064             "description": ""
31065           },
31066           {
31067             "group": "Body",
31068             "type": "String",
31069             "optional": true,
31070             "field": "tz",
31071             "description": ""
31072           },
31073           {
31074             "group": "Body",
31075             "type": "String",
31076             "allowedValues": [
31077               "\"yes\"",
31078               "\"no\""
31079             ],
31080             "optional": false,
31081             "field": "attach",
31082             "description": ""
31083           },
31084           {
31085             "group": "Body",
31086             "type": "String",
31087             "allowedValues": [
31088               "\"yes\"",
31089               "\"no\""
31090             ],
31091             "optional": false,
31092             "field": "saycid",
31093             "description": ""
31094           },
31095           {
31096             "group": "Body",
31097             "type": "String",
31098             "optional": true,
31099             "field": "dialout",
31100             "description": ""
31101           },
31102           {
31103             "group": "Body",
31104             "type": "String",
31105             "optional": true,
31106             "field": "callback",
31107             "description": ""
31108           },
31109           {
31110             "group": "Body",
31111             "type": "String",
31112             "allowedValues": [
31113               "\"yes\"",
31114               "\"no\""
31115             ],
31116             "optional": false,
31117             "field": "review",
31118             "description": ""
31119           },
31120           {
31121             "group": "Body",
31122             "type": "String",
31123             "allowedValues": [
31124               "\"yes\"",
31125               "\"no\""
31126             ],
31127             "optional": false,
31128             "field": "operator",
31129             "description": ""
31130           },
31131           {
31132             "group": "Body",
31133             "type": "String",
31134             "allowedValues": [
31135               "\"yes\"",
31136               "\"no\""
31137             ],
31138             "optional": false,
31139             "field": "envelope",
31140             "description": ""
31141           },
31142           {
31143             "group": "Body",
31144             "type": "String",
31145             "allowedValues": [
31146               "\"yes\"",
31147               "\"no\""
31148             ],
31149             "optional": false,
31150             "field": "sayduration",
31151             "description": ""
31152           },
31153           {
31154             "group": "Body",
31155             "type": "String",
31156             "optional": false,
31157             "field": "saydurationm",
31158             "description": ""
31159           },
31160           {
31161             "group": "Body",
31162             "type": "String",
31163             "allowedValues": [
31164               "\"yes\"",
31165               "\"no\""
31166             ],
31167             "optional": false,
31168             "field": "sendvoicemail",
31169             "description": ""
31170           },
31171           {
31172             "group": "Body",
31173             "type": "String",
31174             "allowedValues": [
31175               "\"yes\"",
31176               "\"no\""
31177             ],
31178             "optional": false,
31179             "field": "delete",
31180             "description": ""
31181           },
31182           {
31183             "group": "Body",
31184             "type": "String",
31185             "allowedValues": [
31186               "\"yes\"",
31187               "\"no\""
31188             ],
31189             "optional": false,
31190             "field": "nextaftercmd",
31191             "description": ""
31192           },
31193           {
31194             "group": "Body",
31195             "type": "String",
31196             "allowedValues": [
31197               "\"yes\"",
31198               "\"no\""
31199             ],
31200             "optional": false,
31201             "field": "forcename",
31202             "description": ""
31203           },
31204           {
31205             "group": "Body",
31206             "type": "String",
31207             "allowedValues": [
31208               "\"yes\"",
31209               "\"no\""
31210             ],
31211             "optional": false,
31212             "field": "forcegreetings",
31213             "description": ""
31214           },
31215           {
31216             "group": "Body",
31217             "type": "String",
31218             "allowedValues": [
31219               "\"yes\"",
31220               "\"no\""
31221             ],
31222             "optional": false,
31223             "field": "hidefromdir",
31224             "description": ""
31225           },
31226           {
31227             "group": "Body",
31228             "type": "String",
31229             "optional": true,
31230             "field": "stamp",
31231             "description": ""
31232           },
31233           {
31234             "group": "Body",
31235             "type": "String",
31236             "optional": true,
31237             "field": "emailsubject",
31238             "description": ""
31239           },
31240           {
31241             "group": "Body",
31242             "type": "String",
31243             "optional": true,
31244             "field": "emailbody",
31245             "description": ""
31246           },
31247           {
31248             "group": "Body",
31249             "type": "Integer",
31250             "optional": false,
31251             "field": "maxsecs",
31252             "description": ""
31253           },
31254           {
31255             "group": "Body",
31256             "type": "Integer",
31257             "optional": false,
31258             "field": "maxmsg",
31259             "description": ""
31260           },
31261           {
31262             "group": "Body",
31263             "type": "Virtual",
31264             "optional": true,
31265             "field": "name",
31266             "description": ""
31267           }
31268         ]
31269       }
31270     },
31271     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31272     "version": "0.0.0",
31273     "filename": "server/api/voiceMail/index.js",
31274     "groupTitle": "Voice_Mails"
31275   },
31276   {
31277     "type": "delete",
31278     "url": "/api/voice/mails/{id}",
31279     "title": "Deletes a Mail",
31280     "examples": [
31281       {
31282         "title": "Example usage:",
31283         "content": "curl https://{domain}/api/voice/mails/{id} -v -u {name}:{password} -X DELETE",
31284         "type": "json"
31285       }
31286     ],
31287     "name": "DeleteMails",
31288     "group": "Voice_Mails",
31289     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31290     "version": "0.0.0",
31291     "filename": "server/api/voiceMail/index.js",
31292     "groupTitle": "Voice_Mails"
31293   },
31294   {
31295     "type": "get",
31296     "url": "/api/voice/mails",
31297     "title": "Gets a list of Mails",
31298     "examples": [
31299       {
31300         "title": "Example usage:",
31301         "content": "curl https://{domain}/api/voice/mails -v -u {name}:{password}",
31302         "type": "json"
31303       }
31304     ],
31305     "name": "GetMails",
31306     "group": "Voice_Mails",
31307     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
31308     "version": "0.0.0",
31309     "filename": "server/api/voiceMail/index.js",
31310     "groupTitle": "Voice_Mails"
31311   },
31312   {
31313     "type": "get",
31314     "url": "/api/voice/mails/{id}",
31315     "title": "Gets a single Mail",
31316     "examples": [
31317       {
31318         "title": "Example usage:",
31319         "content": "curl https://{domain}/api/voice/mails/{id} -v -u {name}:{password}",
31320         "type": "json"
31321       }
31322     ],
31323     "name": "ShowMails",
31324     "group": "Voice_Mails",
31325     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31326     "version": "0.0.0",
31327     "filename": "server/api/voiceMail/index.js",
31328     "groupTitle": "Voice_Mails"
31329   },
31330   {
31331     "type": "get",
31332     "url": "/api/voice/mails/{id}/messages",
31333     "title": "Gets voice mail messages",
31334     "examples": [
31335       {
31336         "title": "Example usage:",
31337         "content": "curl https://{domain}/api/voice/mails/{id}/messages -v -u {name}:{password} -X GET",
31338         "type": "json"
31339       }
31340     ],
31341     "name": "getMessages",
31342     "group": "Voice_Mails",
31343     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31344     "version": "0.0.0",
31345     "filename": "server/api/voiceMail/index.js",
31346     "groupTitle": "Voice_Mails"
31347   },
31348   {
31349     "type": "put",
31350     "url": "/api/voice/mails/{id}",
31351     "title": "Update an existing Mail",
31352     "examples": [
31353       {
31354         "title": "Example usage:",
31355         "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",
31356         "type": "json"
31357       }
31358     ],
31359     "name": "updateMails",
31360     "group": "Voice_Mails",
31361     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31362     "version": "0.0.0",
31363     "filename": "server/api/voiceMail/index.js",
31364     "groupTitle": "Voice_Mails"
31365   },
31366   {
31367     "type": "post",
31368     "url": "/api/voice/mails/messages",
31369     "title": "Creates a new Message",
31370     "examples": [
31371       {
31372         "title": "Example usage:",
31373         "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",
31374         "type": "json"
31375       }
31376     ],
31377     "name": "CreateMessages",
31378     "group": "Voice_Messages",
31379     "parameter": {
31380       "fields": {
31381         "Body": [
31382           {
31383             "group": "Body",
31384             "type": "Virtual",
31385             "optional": true,
31386             "field": "name",
31387             "description": ""
31388           },
31389           {
31390             "group": "Body",
31391             "type": "Integer",
31392             "optional": false,
31393             "field": "msgnum",
31394             "description": ""
31395           },
31396           {
31397             "group": "Body",
31398             "type": "String",
31399             "optional": true,
31400             "field": "dir",
31401             "description": ""
31402           },
31403           {
31404             "group": "Body",
31405             "type": "String",
31406             "optional": true,
31407             "field": "context",
31408             "description": ""
31409           },
31410           {
31411             "group": "Body",
31412             "type": "String",
31413             "optional": true,
31414             "field": "macrocontext",
31415             "description": ""
31416           },
31417           {
31418             "group": "Body",
31419             "type": "String",
31420             "optional": true,
31421             "field": "callerid",
31422             "description": ""
31423           },
31424           {
31425             "group": "Body",
31426             "type": "String",
31427             "optional": true,
31428             "field": "origtime",
31429             "description": ""
31430           },
31431           {
31432             "group": "Body",
31433             "type": "String",
31434             "optional": true,
31435             "field": "duration",
31436             "description": ""
31437           },
31438           {
31439             "group": "Body",
31440             "type": "String",
31441             "optional": true,
31442             "field": "mailboxuser",
31443             "description": ""
31444           },
31445           {
31446             "group": "Body",
31447             "type": "String",
31448             "optional": true,
31449             "field": "mailboxcontext",
31450             "description": ""
31451           },
31452           {
31453             "group": "Body",
31454             "type": "Blob",
31455             "optional": true,
31456             "field": "recording",
31457             "description": ""
31458           },
31459           {
31460             "group": "Body",
31461             "type": "String",
31462             "optional": true,
31463             "field": "flag",
31464             "description": ""
31465           },
31466           {
31467             "group": "Body",
31468             "type": "String",
31469             "optional": true,
31470             "field": "msg_id",
31471             "description": ""
31472           },
31473           {
31474             "group": "Body",
31475             "type": "String",
31476             "optional": true,
31477             "field": "stamp",
31478             "description": ""
31479           }
31480         ]
31481       }
31482     },
31483     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31484     "version": "0.0.0",
31485     "filename": "server/api/voiceMailMessage/index.js",
31486     "groupTitle": "Voice_Messages"
31487   },
31488   {
31489     "type": "delete",
31490     "url": "/api/voice/mails/messages/{id}",
31491     "title": "Deletes a Message",
31492     "examples": [
31493       {
31494         "title": "Example usage:",
31495         "content": "curl https://{domain}/api/voice/mails/messages/{id} -v -u {name}:{password} -X DELETE",
31496         "type": "json"
31497       }
31498     ],
31499     "name": "DeleteMessages",
31500     "group": "Voice_Messages",
31501     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31502     "version": "0.0.0",
31503     "filename": "server/api/voiceMailMessage/index.js",
31504     "groupTitle": "Voice_Messages"
31505   },
31506   {
31507     "type": "get",
31508     "url": "/api/voice/mails/messages",
31509     "title": "Gets a list of Messages",
31510     "examples": [
31511       {
31512         "title": "Example usage:",
31513         "content": "curl https://{domain}/api/voice/mails/messages -v -u {name}:{password}",
31514         "type": "json"
31515       }
31516     ],
31517     "name": "GetMessages",
31518     "group": "Voice_Messages",
31519     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
31520     "version": "0.0.0",
31521     "filename": "server/api/voiceMailMessage/index.js",
31522     "groupTitle": "Voice_Messages"
31523   },
31524   {
31525     "type": "get",
31526     "url": "/api/voice/mails/messages/{id}",
31527     "title": "Gets a single Message",
31528     "examples": [
31529       {
31530         "title": "Example usage:",
31531         "content": "curl https://{domain}/api/voice/mails/messages/{id} -v -u {name}:{password}",
31532         "type": "json"
31533       }
31534     ],
31535     "name": "ShowMessages",
31536     "group": "Voice_Messages",
31537     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31538     "version": "0.0.0",
31539     "filename": "server/api/voiceMailMessage/index.js",
31540     "groupTitle": "Voice_Messages"
31541   },
31542   {
31543     "type": "get",
31544     "url": "voice/mails/messages/{id}/download",
31545     "title": "Download Voice Message",
31546     "examples": [
31547       {
31548         "title": "Example usage:",
31549         "content": "curl https://{domain}voice/mails/messages/{id}/download -v -u {name}:{password} -X GET",
31550         "type": "json"
31551       }
31552     ],
31553     "name": "download",
31554     "group": "Voice_Messages",
31555     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31556     "version": "0.0.0",
31557     "filename": "server/api/voiceMailMessage/index.js",
31558     "groupTitle": "Voice_Messages"
31559   },
31560   {
31561     "type": "put",
31562     "url": "/api/voice/mails/messages/{id}",
31563     "title": "Update an existing Message",
31564     "examples": [
31565       {
31566         "title": "Example usage:",
31567         "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",
31568         "type": "json"
31569       }
31570     ],
31571     "name": "updateMessages",
31572     "group": "Voice_Messages",
31573     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31574     "version": "0.0.0",
31575     "filename": "server/api/voiceMailMessage/index.js",
31576     "groupTitle": "Voice_Messages"
31577   },
31578   {
31579     "type": "post",
31580     "url": "/api/voice/prefixes/{id}/teams",
31581     "title": "Add teams to voice prefix",
31582     "examples": [
31583       {
31584         "title": "Example usage:",
31585         "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",
31586         "type": "json"
31587       }
31588     ],
31589     "name": "AddTeams",
31590     "group": "Voice_Prefix",
31591     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31592     "version": "0.0.0",
31593     "filename": "server/api/voicePrefix/index.js",
31594     "groupTitle": "Voice_Prefix"
31595   },
31596   {
31597     "type": "get",
31598     "url": "/api/voice/prefixes/{id}/teams",
31599     "title": "Gets voice prefix team",
31600     "examples": [
31601       {
31602         "title": "Example usage:",
31603         "content": "curl https://{domain}/api/voice/prefixes/{id}/teams -v -u {name}:{password}  -X GET",
31604         "type": "json"
31605       }
31606     ],
31607     "name": "GetTeams",
31608     "group": "Voice_Prefix",
31609     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31610     "version": "0.0.0",
31611     "filename": "server/api/voicePrefix/index.js",
31612     "groupTitle": "Voice_Prefix"
31613   },
31614   {
31615     "type": "post",
31616     "url": "/api/voice/prefixes/{id}/users",
31617     "title": "Add agents to a prefix",
31618     "examples": [
31619       {
31620         "title": "Example usage:",
31621         "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",
31622         "type": "json"
31623       }
31624     ],
31625     "name": "AddAgents",
31626     "group": "Voice_Prefixes",
31627     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31628     "version": "0.0.0",
31629     "filename": "server/api/voicePrefix/index.js",
31630     "groupTitle": "Voice_Prefixes"
31631   },
31632   {
31633     "type": "delete",
31634     "url": "/api/voice/prefixes/{id}",
31635     "title": "Deletes a Prefix",
31636     "examples": [
31637       {
31638         "title": "Example usage:",
31639         "content": "curl https://{domain}/api/voice/prefixes/{id} -v -u {name}:{password} -X DELETE",
31640         "type": "json"
31641       }
31642     ],
31643     "name": "DeletePrefixes",
31644     "group": "Voice_Prefixes",
31645     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31646     "version": "0.0.0",
31647     "filename": "server/api/voicePrefix/index.js",
31648     "groupTitle": "Voice_Prefixes"
31649   },
31650   {
31651     "type": "get",
31652     "url": "/api/voice/prefixes/describe",
31653     "title": "Gets table info about Prefixes",
31654     "examples": [
31655       {
31656         "title": "Example usage:",
31657         "content": "curl https://{domain}/api/voice/prefixes/describe -v -u {name}:{password}",
31658         "type": "json"
31659       }
31660     ],
31661     "name": "DescribePrefixes",
31662     "group": "Voice_Prefixes",
31663     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31664     "version": "0.0.0",
31665     "filename": "server/api/voicePrefix/index.js",
31666     "groupTitle": "Voice_Prefixes"
31667   },
31668   {
31669     "type": "get",
31670     "url": "/api/voice/prefixes/{id}/users",
31671     "title": "Gets agents from prefix",
31672     "examples": [
31673       {
31674         "title": "Example usage:",
31675         "content": "curl https://{domain}/api/voice/prefixes/{id}/users -v -u {name}:{password} -X GET",
31676         "type": "json"
31677       }
31678     ],
31679     "name": "GetAgents",
31680     "group": "Voice_Prefixes",
31681     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31682     "version": "0.0.0",
31683     "filename": "server/api/voicePrefix/index.js",
31684     "groupTitle": "Voice_Prefixes"
31685   },
31686   {
31687     "type": "get",
31688     "url": "/api/voice/prefixes",
31689     "title": "Gets a list of Prefixes",
31690     "examples": [
31691       {
31692         "title": "Example usage:",
31693         "content": "curl https://{domain}/api/voice/prefixes -v -u {name}:{password}",
31694         "type": "json"
31695       }
31696     ],
31697     "name": "GetPrefixes",
31698     "group": "Voice_Prefixes",
31699     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
31700     "version": "0.0.0",
31701     "filename": "server/api/voicePrefix/index.js",
31702     "groupTitle": "Voice_Prefixes"
31703   },
31704   {
31705     "type": "delete",
31706     "url": "/api/voice/prefixes/{id}/users",
31707     "title": "Removes agents from a prefix",
31708     "examples": [
31709       {
31710         "title": "Example usage:",
31711         "content": "curl https://{domain}/api/voice/prefixes/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
31712         "type": "json"
31713       }
31714     ],
31715     "name": "RemoveAgents",
31716     "group": "Voice_Prefixes",
31717     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31718     "version": "0.0.0",
31719     "filename": "server/api/voicePrefix/index.js",
31720     "groupTitle": "Voice_Prefixes"
31721   },
31722   {
31723     "type": "get",
31724     "url": "/api/voice/prefixes/{id}",
31725     "title": "Gets a single Prefix",
31726     "examples": [
31727       {
31728         "title": "Example usage:",
31729         "content": "curl https://{domain}/api/voice/prefixes/{id} -v -u {name}:{password}",
31730         "type": "json"
31731       }
31732     ],
31733     "name": "ShowPrefixes",
31734     "group": "Voice_Prefixes",
31735     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31736     "version": "0.0.0",
31737     "filename": "server/api/voicePrefix/index.js",
31738     "groupTitle": "Voice_Prefixes"
31739   },
31740   {
31741     "type": "put",
31742     "url": "/api/voice/prefixes/{id}",
31743     "title": "Update an existing prefix",
31744     "examples": [
31745       {
31746         "title": "Example usage:",
31747         "content": "curl https://{domain}/api/voice/prefixes/{id} -v -u {name}:{password} -X PUT",
31748         "type": "json"
31749       }
31750     ],
31751     "name": "Update",
31752     "group": "Voice_Prefixes",
31753     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31754     "version": "0.0.0",
31755     "filename": "server/api/voicePrefix/index.js",
31756     "groupTitle": "Voice_Prefixes"
31757   },
31758   {
31759     "type": "post",
31760     "url": "/api/voice/prefixes",
31761     "title": "Create a prefix",
31762     "examples": [
31763       {
31764         "title": "Example usage:",
31765         "content": "curl https://{domain}/api/voice/prefixes -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
31766         "type": "json"
31767       }
31768     ],
31769     "name": "create",
31770     "group": "Voice_Prefixes",
31771     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31772     "version": "0.0.0",
31773     "filename": "server/api/voicePrefix/index.js",
31774     "groupTitle": "Voice_Prefixes"
31775   },
31776   {
31777     "type": "get",
31778     "url": "/api/voice/queues/reports/describe",
31779     "title": "Gets table info about Queue Reports",
31780     "examples": [
31781       {
31782         "title": "Example usage:",
31783         "content": "curl https://{domain}/api/voice/queues/reports/describe -v -u {name}:{password}",
31784         "type": "json"
31785       }
31786     ],
31787     "name": "DescribeQueue_Reports",
31788     "group": "Voice_Queue_Reports",
31789     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31790     "version": "0.0.0",
31791     "filename": "server/api/voiceQueueReport/index.js",
31792     "groupTitle": "Voice_Queue_Reports"
31793   },
31794   {
31795     "type": "get",
31796     "url": "/api/voice/queues/reports",
31797     "title": "Gets a list of Queue Reports",
31798     "examples": [
31799       {
31800         "title": "Example usage:",
31801         "content": "curl https://{domain}/api/voice/queues/reports -v -u {name}:{password}",
31802         "type": "json"
31803       }
31804     ],
31805     "name": "GetQueue_Reports",
31806     "group": "Voice_Queue_Reports",
31807     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
31808     "version": "0.0.0",
31809     "filename": "server/api/voiceQueueReport/index.js",
31810     "groupTitle": "Voice_Queue_Reports"
31811   },
31812   {
31813     "type": "get",
31814     "url": "/api/voice/queues/reports/{id}",
31815     "title": "Gets a single Queue Report",
31816     "examples": [
31817       {
31818         "title": "Example usage:",
31819         "content": "curl https://{domain}/api/voice/queues/reports/{id} -v -u {name}:{password}",
31820         "type": "json"
31821       }
31822     ],
31823     "name": "ShowQueue_Reports",
31824     "group": "Voice_Queue_Reports",
31825     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31826     "version": "0.0.0",
31827     "filename": "server/api/voiceQueueReport/index.js",
31828     "groupTitle": "Voice_Queue_Reports"
31829   },
31830   {
31831     "type": "get",
31832     "url": "/api/voice/queues/reports/index",
31833     "title": "Get Voice Queues Report",
31834     "examples": [
31835       {
31836         "title": "Example usage:",
31837         "content": "curl https://{domain}/api/voice/queues/reports/index -v -u {name}:{password} -X GET",
31838         "type": "json"
31839       }
31840     ],
31841     "name": "getVoiceQueuesReport",
31842     "group": "Voice_Queue_Reports",
31843     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31844     "version": "0.0.0",
31845     "filename": "server/api/voiceQueueReport/index.js",
31846     "groupTitle": "Voice_Queue_Reports"
31847   },
31848   {
31849     "type": "post",
31850     "url": "/api/voice/queues/{id}/users",
31851     "title": "Add agents to queue",
31852     "examples": [
31853       {
31854         "title": "Example usage:",
31855         "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",
31856         "type": "json"
31857       }
31858     ],
31859     "name": "AddAgents",
31860     "group": "Voice_Queues",
31861     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31862     "version": "0.0.0",
31863     "filename": "server/api/voiceQueue/index.js",
31864     "groupTitle": "Voice_Queues"
31865   },
31866   {
31867     "type": "post",
31868     "url": "/api/voice/queues/{id}/blacklists",
31869     "title": "Add blacklists to a queue",
31870     "examples": [
31871       {
31872         "title": "Example usage:",
31873         "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",
31874         "type": "json"
31875       }
31876     ],
31877     "name": "AddBlackLists",
31878     "group": "Voice_Queues",
31879     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31880     "version": "0.0.0",
31881     "filename": "server/api/voiceQueue/index.js",
31882     "groupTitle": "Voice_Queues"
31883   },
31884   {
31885     "type": "post",
31886     "url": "/api/voice/queues/{id}/lists",
31887     "title": "Add lists to a queue",
31888     "examples": [
31889       {
31890         "title": "Example usage:",
31891         "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",
31892         "type": "json"
31893       }
31894     ],
31895     "name": "AddLists",
31896     "group": "Voice_Queues",
31897     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31898     "version": "0.0.0",
31899     "filename": "server/api/voiceQueue/index.js",
31900     "groupTitle": "Voice_Queues"
31901   },
31902   {
31903     "type": "post",
31904     "url": "/api/voice/queues/{id}/teams",
31905     "title": "Add teams to queue",
31906     "examples": [
31907       {
31908         "title": "Example usage:",
31909         "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",
31910         "type": "json"
31911       }
31912     ],
31913     "name": "AddTeams",
31914     "group": "Voice_Queues",
31915     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31916     "version": "0.0.0",
31917     "filename": "server/api/voiceQueue/index.js",
31918     "groupTitle": "Voice_Queues"
31919   },
31920   {
31921     "type": "post",
31922     "url": "/api/voice/queues/clone",
31923     "title": "Clone an existing Queue",
31924     "examples": [
31925       {
31926         "title": "Example usage:",
31927         "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",
31928         "type": "json"
31929       }
31930     ],
31931     "name": "CloneQueues",
31932     "group": "Voice_Queues",
31933     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31934     "version": "0.0.0",
31935     "filename": "server/api/voiceQueue/index.js",
31936     "groupTitle": "Voice_Queues"
31937   },
31938   {
31939     "type": "post",
31940     "url": "/api/voice/queues",
31941     "title": "Creates a new Queue",
31942     "examples": [
31943       {
31944         "title": "Example usage:",
31945         "content": "curl https://{domain}/api/voice/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
31946         "type": "json"
31947       }
31948     ],
31949     "name": "CreateQueues",
31950     "group": "Voice_Queues",
31951     "parameter": {
31952       "fields": {
31953         "Body": [
31954           {
31955             "group": "Body",
31956             "type": "String",
31957             "optional": false,
31958             "field": "name",
31959             "description": ""
31960           },
31961           {
31962             "group": "Body",
31963             "type": "String",
31964             "allowedValues": [
31965               "\"inbound\"",
31966               "\"outbound\""
31967             ],
31968             "optional": false,
31969             "field": "type",
31970             "description": ""
31971           },
31972           {
31973             "group": "Body",
31974             "type": "String",
31975             "optional": true,
31976             "field": "musiconhold",
31977             "description": ""
31978           },
31979           {
31980             "group": "Body",
31981             "type": "String",
31982             "optional": true,
31983             "field": "announce",
31984             "description": ""
31985           },
31986           {
31987             "group": "Body",
31988             "type": "String",
31989             "allowedValues": [
31990               "\"rr\"",
31991               "\"ringall\"",
31992               "\"leastrecent\"",
31993               "\"fewestcalls\"",
31994               "\"random\"",
31995               "\"rrmemory\"",
31996               "\"linear\"",
31997               "\"wrandom\"",
31998               "\"rrordered\""
31999             ],
32000             "optional": false,
32001             "field": "strategy",
32002             "description": ""
32003           },
32004           {
32005             "group": "Body",
32006             "type": "Integer",
32007             "optional": true,
32008             "field": "servicelevel",
32009             "description": ""
32010           },
32011           {
32012             "group": "Body",
32013             "type": "String",
32014             "optional": true,
32015             "field": "context",
32016             "description": ""
32017           },
32018           {
32019             "group": "Body",
32020             "type": "Integer",
32021             "optional": true,
32022             "field": "penaltymemberslimit",
32023             "description": ""
32024           },
32025           {
32026             "group": "Body",
32027             "type": "Integer",
32028             "optional": true,
32029             "field": "timeout",
32030             "description": ""
32031           },
32032           {
32033             "group": "Body",
32034             "type": "Integer",
32035             "optional": true,
32036             "field": "retry",
32037             "description": ""
32038           },
32039           {
32040             "group": "Body",
32041             "type": "String",
32042             "optional": true,
32043             "field": "timeoutpriority",
32044             "description": ""
32045           },
32046           {
32047             "group": "Body",
32048             "type": "Integer",
32049             "optional": true,
32050             "field": "weight",
32051             "description": ""
32052           },
32053           {
32054             "group": "Body",
32055             "type": "Integer",
32056             "optional": true,
32057             "field": "wrapuptime",
32058             "description": ""
32059           },
32060           {
32061             "group": "Body",
32062             "type": "String",
32063             "allowedValues": [
32064               "\"yes\"",
32065               "\"no\""
32066             ],
32067             "optional": true,
32068             "field": "autofill",
32069             "description": ""
32070           },
32071           {
32072             "group": "Body",
32073             "type": "String",
32074             "allowedValues": [
32075               "\"yes\"",
32076               "\"no\"",
32077               "\"all\""
32078             ],
32079             "optional": true,
32080             "field": "autopause",
32081             "description": ""
32082           },
32083           {
32084             "group": "Body",
32085             "type": "Integer",
32086             "optional": true,
32087             "field": "autopausedelay",
32088             "description": ""
32089           },
32090           {
32091             "group": "Body",
32092             "type": "String",
32093             "allowedValues": [
32094               "\"yes\"",
32095               "\"no\""
32096             ],
32097             "optional": true,
32098             "field": "autopausebusy",
32099             "description": ""
32100           },
32101           {
32102             "group": "Body",
32103             "type": "String",
32104             "allowedValues": [
32105               "\"yes\"",
32106               "\"no\""
32107             ],
32108             "optional": true,
32109             "field": "autopauseunavail",
32110             "description": ""
32111           },
32112           {
32113             "group": "Body",
32114             "type": "Integer",
32115             "optional": true,
32116             "field": "maxlen",
32117             "description": ""
32118           },
32119           {
32120             "group": "Body",
32121             "type": "String",
32122             "allowedValues": [
32123               "\"yes\"",
32124               "\"no\""
32125             ],
32126             "optional": true,
32127             "field": "setinterfacevar",
32128             "description": ""
32129           },
32130           {
32131             "group": "Body",
32132             "type": "String",
32133             "allowedValues": [
32134               "\"yes\"",
32135               "\"no\""
32136             ],
32137             "optional": true,
32138             "field": "setqueueentryvar",
32139             "description": ""
32140           },
32141           {
32142             "group": "Body",
32143             "type": "String",
32144             "allowedValues": [
32145               "\"yes\"",
32146               "\"no\""
32147             ],
32148             "optional": true,
32149             "field": "setqueuevar",
32150             "description": ""
32151           },
32152           {
32153             "group": "Body",
32154             "type": "String",
32155             "allowedValues": [
32156               "\"yes\"",
32157               "\"no\""
32158             ],
32159             "optional": true,
32160             "field": "eventmemberstatus",
32161             "description": ""
32162           },
32163           {
32164             "group": "Body",
32165             "type": "String",
32166             "optional": true,
32167             "field": "membermacro",
32168             "description": ""
32169           },
32170           {
32171             "group": "Body",
32172             "type": "String",
32173             "optional": true,
32174             "field": "membergosub",
32175             "description": ""
32176           },
32177           {
32178             "group": "Body",
32179             "type": "Integer",
32180             "optional": true,
32181             "field": "announce_frequency",
32182             "description": ""
32183           },
32184           {
32185             "group": "Body",
32186             "type": "Integer",
32187             "optional": true,
32188             "field": "min_announce_frequency",
32189             "description": ""
32190           },
32191           {
32192             "group": "Body",
32193             "type": "Integer",
32194             "optional": true,
32195             "field": "periodic_announce_frequency",
32196             "description": ""
32197           },
32198           {
32199             "group": "Body",
32200             "type": "String",
32201             "allowedValues": [
32202               "\"yes\"",
32203               "\"no\""
32204             ],
32205             "optional": true,
32206             "field": "random_periodic_announce",
32207             "description": ""
32208           },
32209           {
32210             "group": "Body",
32211             "type": "String",
32212             "allowedValues": [
32213               "\"yes\"",
32214               "\"no\""
32215             ],
32216             "optional": true,
32217             "field": "relative_periodic_announce",
32218             "description": ""
32219           },
32220           {
32221             "group": "Body",
32222             "type": "String",
32223             "allowedValues": [
32224               "\"yes\"",
32225               "\"no\"",
32226               "\"once\""
32227             ],
32228             "optional": true,
32229             "field": "announce_holdtime",
32230             "description": ""
32231           },
32232           {
32233             "group": "Body",
32234             "type": "String",
32235             "optional": true,
32236             "field": "announce_position",
32237             "description": ""
32238           },
32239           {
32240             "group": "Body",
32241             "type": "String",
32242             "allowedValues": [
32243               "\"yes\"",
32244               "\"no\""
32245             ],
32246             "optional": true,
32247             "field": "announce_to_first_user",
32248             "description": ""
32249           },
32250           {
32251             "group": "Body",
32252             "type": "Integer",
32253             "optional": true,
32254             "field": "announce_position_limit",
32255             "description": ""
32256           },
32257           {
32258             "group": "Body",
32259             "type": "String",
32260             "allowedValues": [
32261               "\"0\"",
32262               "\"5\"",
32263               "\"10\"",
32264               "\"15\"",
32265               "\"20\"",
32266               "\"30\""
32267             ],
32268             "optional": true,
32269             "field": "announce_round_seconds",
32270             "description": ""
32271           },
32272           {
32273             "group": "Body",
32274             "type": "String",
32275             "optional": true,
32276             "field": "monitor_format",
32277             "description": ""
32278           },
32279           {
32280             "group": "Body",
32281             "type": "String",
32282             "optional": true,
32283             "field": "monitor_type",
32284             "description": ""
32285           },
32286           {
32287             "group": "Body",
32288             "type": "String",
32289             "optional": true,
32290             "field": "queue_youarenext",
32291             "description": ""
32292           },
32293           {
32294             "group": "Body",
32295             "type": "String",
32296             "optional": true,
32297             "field": "queue_thereare",
32298             "description": ""
32299           },
32300           {
32301             "group": "Body",
32302             "type": "String",
32303             "optional": true,
32304             "field": "queue_callswaiting",
32305             "description": ""
32306           },
32307           {
32308             "group": "Body",
32309             "type": "String",
32310             "optional": true,
32311             "field": "queue_holdtime",
32312             "description": ""
32313           },
32314           {
32315             "group": "Body",
32316             "type": "String",
32317             "optional": true,
32318             "field": "queue_minute",
32319             "description": ""
32320           },
32321           {
32322             "group": "Body",
32323             "type": "String",
32324             "optional": true,
32325             "field": "queue_minutes",
32326             "description": ""
32327           },
32328           {
32329             "group": "Body",
32330             "type": "String",
32331             "optional": true,
32332             "field": "queue_seconds",
32333             "description": ""
32334           },
32335           {
32336             "group": "Body",
32337             "type": "String",
32338             "optional": true,
32339             "field": "queue_thankyou",
32340             "description": ""
32341           },
32342           {
32343             "group": "Body",
32344             "type": "String",
32345             "optional": true,
32346             "field": "queue_reporthold",
32347             "description": ""
32348           },
32349           {
32350             "group": "Body",
32351             "type": "String",
32352             "optional": true,
32353             "field": "queue_quantity1",
32354             "description": ""
32355           },
32356           {
32357             "group": "Body",
32358             "type": "String",
32359             "optional": true,
32360             "field": "queue_quantity2",
32361             "description": ""
32362           },
32363           {
32364             "group": "Body",
32365             "type": "String",
32366             "optional": true,
32367             "field": "queue_periodic_announce",
32368             "description": ""
32369           },
32370           {
32371             "group": "Body",
32372             "type": "String",
32373             "optional": true,
32374             "field": "queue_less_than",
32375             "description": ""
32376           },
32377           {
32378             "group": "Body",
32379             "type": "Text",
32380             "optional": true,
32381             "field": "periodic_announce",
32382             "description": ""
32383           },
32384           {
32385             "group": "Body",
32386             "type": "String",
32387             "optional": true,
32388             "field": "joinempty",
32389             "description": ""
32390           },
32391           {
32392             "group": "Body",
32393             "type": "String",
32394             "optional": true,
32395             "field": "leavewhenempty",
32396             "description": ""
32397           },
32398           {
32399             "group": "Body",
32400             "type": "String",
32401             "allowedValues": [
32402               "\"yes\"",
32403               "\"no\""
32404             ],
32405             "optional": true,
32406             "field": "reportholdtime",
32407             "description": ""
32408           },
32409           {
32410             "group": "Body",
32411             "type": "String",
32412             "allowedValues": [
32413               "\"yes\"",
32414               "\"no\""
32415             ],
32416             "optional": true,
32417             "field": "ringinuse",
32418             "description": ""
32419           },
32420           {
32421             "group": "Body",
32422             "type": "Integer",
32423             "optional": true,
32424             "field": "memberdelay",
32425             "description": ""
32426           },
32427           {
32428             "group": "Body",
32429             "type": "String",
32430             "allowedValues": [
32431               "\"yes\"",
32432               "\"no\""
32433             ],
32434             "optional": true,
32435             "field": "timeoutrestart",
32436             "description": ""
32437           },
32438           {
32439             "group": "Body",
32440             "type": "String",
32441             "optional": true,
32442             "field": "defaultrule",
32443             "description": ""
32444           },
32445           {
32446             "group": "Body",
32447             "type": "String",
32448             "optional": true,
32449             "field": "description",
32450             "description": ""
32451           },
32452           {
32453             "group": "Body",
32454             "type": "Boolean",
32455             "optional": true,
32456             "field": "acw",
32457             "description": ""
32458           },
32459           {
32460             "group": "Body",
32461             "type": "Integer",
32462             "optional": true,
32463             "field": "acwTimeout",
32464             "description": ""
32465           },
32466           {
32467             "group": "Body",
32468             "type": "Boolean",
32469             "optional": true,
32470             "field": "dialActive",
32471             "description": "<p>Active/Disactive Campaign</p>"
32472           },
32473           {
32474             "group": "Body",
32475             "type": "String",
32476             "allowedValues": [
32477               "\"preview\"",
32478               "\"progressive\"",
32479               "\"power\"",
32480               "\"predictive\"",
32481               "\"booked\""
32482             ],
32483             "optional": true,
32484             "field": "dialMethod",
32485             "description": "<p>Dial Method.</p>"
32486           },
32487           {
32488             "group": "Body",
32489             "type": "Integer",
32490             "optional": true,
32491             "field": "dialLimitChannel",
32492             "description": "<p>Max 9999 channels, 0 means unlimited.</p>"
32493           },
32494           {
32495             "group": "Body",
32496             "type": "Integer",
32497             "optional": true,
32498             "field": "dialLimitQueue",
32499             "description": "<p>Max 9999 member in queue(min:1, max:9999), 0 means unlimited.</p>"
32500           },
32501           {
32502             "group": "Body",
32503             "type": "Float",
32504             "optional": true,
32505             "field": "dialPowerLevel",
32506             "description": "<p>Power Level: Calls for agents (min:1, max:10).</p>"
32507           },
32508           {
32509             "group": "Body",
32510             "type": "String",
32511             "allowedValues": [
32512               "\"agentBusyFactor\"",
32513               "\"dropRate\""
32514             ],
32515             "optional": true,
32516             "field": "dialPredictiveOptimization",
32517             "description": "<p>Only for predictive method.</p>"
32518           },
32519           {
32520             "group": "Body",
32521             "type": "Float",
32522             "optional": true,
32523             "field": "dialPredictiveOptimizationPercentage",
32524             "description": "<p>Predictive Optimization Percentage (min: 1, max: 95)</p>"
32525           },
32526           {
32527             "group": "Body",
32528             "type": "Integer",
32529             "optional": true,
32530             "field": "dialPredictiveInterval",
32531             "description": "<p>Interval Predictive Minutes (min:5 max:30)</p>"
32532           },
32533           {
32534             "group": "Body",
32535             "type": "String",
32536             "optional": true,
32537             "field": "dialOriginateCallerIdName",
32538             "description": ""
32539           },
32540           {
32541             "group": "Body",
32542             "type": "String",
32543             "optional": true,
32544             "field": "dialOriginateCallerIdNumber",
32545             "description": ""
32546           },
32547           {
32548             "group": "Body",
32549             "type": "Integer",
32550             "optional": true,
32551             "field": "dialOriginateTimeout",
32552             "description": "<p>Originate Timeout Seconds (min:1, max:999)</p>"
32553           },
32554           {
32555             "group": "Body",
32556             "type": "String",
32557             "optional": true,
32558             "field": "dialQueueOptions",
32559             "description": "<p>https://wiki.asterisk.org/wiki/display/AST/Asterisk+13+Application_Queue</p>"
32560           },
32561           {
32562             "group": "Body",
32563             "type": "Integer",
32564             "optional": true,
32565             "field": "dialQueueTimeout",
32566             "description": "<p>Queue Timeout Seconds (min:1, max:999)</p>"
32567           },
32568           {
32569             "group": "Body",
32570             "type": "String",
32571             "optional": true,
32572             "field": "dialQueueProject",
32573             "description": "<p>AGI queue option (use: agi://127.0.0.1/square,&lt;project_name&gt;)</p>"
32574           },
32575           {
32576             "group": "Body",
32577             "type": "Integer",
32578             "optional": true,
32579             "field": "dialCongestionMaxRetry",
32580             "description": "<p>#Congestion Retry (min:1, max:999)</p>"
32581           },
32582           {
32583             "group": "Body",
32584             "type": "Integer",
32585             "optional": true,
32586             "field": "dialCongestionRetryFrequency",
32587             "description": "<p>Congestion Retry Frequency Minutes (min:1, max:99999)</p>"
32588           },
32589           {
32590             "group": "Body",
32591             "type": "Integer",
32592             "optional": true,
32593             "field": "dialBusyMaxRetry",
32594             "description": "<p>#Busy Retry (min:1, max:999)</p>"
32595           },
32596           {
32597             "group": "Body",
32598             "type": "Integer",
32599             "optional": true,
32600             "field": "dialBusyRetryFrequency",
32601             "description": "<p>Busy Retry Frequency Minutes (min:1, max:99999)</p>"
32602           },
32603           {
32604             "group": "Body",
32605             "type": "Integer",
32606             "optional": true,
32607             "field": "dialNoAnswerMaxRetry",
32608             "description": "<p>#NoAnswer Retry (min:1, max:999)</p>"
32609           },
32610           {
32611             "group": "Body",
32612             "type": "Integer",
32613             "optional": true,
32614             "field": "dialNoAnswerRetryFrequency",
32615             "description": "<p>NoAnswer Retry Frequency Minutes (min:1, max:99999)</p>"
32616           },
32617           {
32618             "group": "Body",
32619             "type": "Integer",
32620             "optional": true,
32621             "field": "dialGlobalMaxRetry",
32622             "description": "<p>#Global Max Retry (min:1, max:999)</p>"
32623           },
32624           {
32625             "group": "Body",
32626             "type": "String",
32627             "optional": true,
32628             "field": "dialTimezone",
32629             "description": ""
32630           },
32631           {
32632             "group": "Body",
32633             "type": "String",
32634             "optional": true,
32635             "field": "dialGlobalInterval",
32636             "description": ""
32637           },
32638           {
32639             "group": "Body",
32640             "type": "String",
32641             "optional": true,
32642             "field": "dialPrefix",
32643             "description": ""
32644           },
32645           {
32646             "group": "Body",
32647             "type": "String",
32648             "allowedValues": [
32649               "\"always\"",
32650               "\"never\"",
32651               "\"onlyIfOpen\""
32652             ],
32653             "optional": true,
32654             "field": "dialCheckDuplicateType",
32655             "description": ""
32656           },
32657           {
32658             "group": "Body",
32659             "type": "Boolean",
32660             "optional": true,
32661             "field": "dialAMDActive",
32662             "description": "<p>Active/Disactive AMD</p>"
32663           },
32664           {
32665             "group": "Body",
32666             "type": "Integer",
32667             "optional": true,
32668             "field": "dialAMDInitialSilence",
32669             "description": "<p>#AMD Initial Silence</p>"
32670           },
32671           {
32672             "group": "Body",
32673             "type": "Integer",
32674             "optional": true,
32675             "field": "dialAMDGreeting",
32676             "description": "<p>#AMD Greeting</p>"
32677           },
32678           {
32679             "group": "Body",
32680             "type": "Integer",
32681             "optional": true,
32682             "field": "dialAMDAfterGreetingSilence",
32683             "description": "<p>#AMD After Greeting Silence</p>"
32684           },
32685           {
32686             "group": "Body",
32687             "type": "Integer",
32688             "optional": true,
32689             "field": "dialAMDTotalAnalysisTime",
32690             "description": "<p>#AMD Total Analysis Time</p>"
32691           },
32692           {
32693             "group": "Body",
32694             "type": "Integer",
32695             "optional": true,
32696             "field": "dialAMDMinWordLength",
32697             "description": "<p>#AMD Min Word Length</p>"
32698           },
32699           {
32700             "group": "Body",
32701             "type": "Integer",
32702             "optional": true,
32703             "field": "dialAMDBetweenWordsSilence",
32704             "description": "<p>#AMD Between Words Silence</p>"
32705           },
32706           {
32707             "group": "Body",
32708             "type": "Integer",
32709             "optional": true,
32710             "field": "dialAMDMaximumNumberOfWords",
32711             "description": "<p>#AMD Maximum Number Of Words</p>"
32712           },
32713           {
32714             "group": "Body",
32715             "type": "Integer",
32716             "optional": true,
32717             "field": "dialAMDSilenceThreshold",
32718             "description": "<p>#AMD Silence Threshold (min:0, max:32767)</p>"
32719           },
32720           {
32721             "group": "Body",
32722             "type": "Integer",
32723             "optional": true,
32724             "field": "dialAMDMaximumWordLength",
32725             "description": "<p>#AMD Maximum Word Length</p>"
32726           },
32727           {
32728             "group": "Body",
32729             "type": "Integer",
32730             "optional": true,
32731             "field": "dialRecallMeTimeout",
32732             "description": "<p>#RecallMe Timeout (min:1)</p>"
32733           },
32734           {
32735             "group": "Body",
32736             "type": "Boolean",
32737             "optional": true,
32738             "field": "dialRecallInQueue",
32739             "description": "<p>Active/Disactive Recall In Queue</p>"
32740           },
32741           {
32742             "group": "Body",
32743             "type": "String",
32744             "allowedValues": [
32745               "\"DESC\"",
32746               "\"ASC\""
32747             ],
32748             "optional": true,
32749             "field": "dialOrderByScheduledAt",
32750             "description": ""
32751           },
32752           {
32753             "group": "Body",
32754             "type": "String",
32755             "optional": true,
32756             "field": "dialQueueProject2",
32757             "description": "<p>AGI queue option (use: agi://127.0.0.1/square,&lt;project_name&gt;)</p>"
32758           },
32759           {
32760             "group": "Body",
32761             "type": "Boolean",
32762             "optional": true,
32763             "field": "dialAgiAfterHangupClient",
32764             "description": ""
32765           },
32766           {
32767             "group": "Body",
32768             "type": "Boolean",
32769             "optional": true,
32770             "field": "dialAgiAfterHangupAgent",
32771             "description": ""
32772           },
32773           {
32774             "group": "Body",
32775             "type": "Integer",
32776             "optional": true,
32777             "field": "dialRandomLastDigitCallerIdNumber",
32778             "description": "<p>Random Last Digit (min:1, max:15)</p>"
32779           },
32780           {
32781             "group": "Body",
32782             "type": "Integer",
32783             "optional": true,
32784             "field": "dialCutDigit",
32785             "description": "<p>Cut Digit (min:1, max:15)</p>"
32786           },
32787           {
32788             "group": "Body",
32789             "type": "Integer",
32790             "optional": true,
32791             "field": "dialNoSuchNumberMaxRetry",
32792             "description": "<p>#NoSuchNumber Retry (min:1, max:999)</p>"
32793           },
32794           {
32795             "group": "Body",
32796             "type": "Integer",
32797             "optional": true,
32798             "field": "dialNoSuchNumberRetryFrequency",
32799             "description": "<p>NoSuchNumber Retry Frequency Minutes (min:1, max:99999)</p>"
32800           },
32801           {
32802             "group": "Body",
32803             "type": "Integer",
32804             "optional": true,
32805             "field": "dialDropMaxRetry",
32806             "description": "<p>#Drop Retry (min:1, max:999)</p>"
32807           },
32808           {
32809             "group": "Body",
32810             "type": "Integer",
32811             "optional": true,
32812             "field": "dialDropRetryFrequency",
32813             "description": "<p>Drop Retry Frequency Minutes (min:1, max:99999)</p>"
32814           },
32815           {
32816             "group": "Body",
32817             "type": "Integer",
32818             "optional": true,
32819             "field": "dialAbandonedMaxRetry",
32820             "description": "<p>#Abandoned Retry (min:1, max:999)</p>"
32821           },
32822           {
32823             "group": "Body",
32824             "type": "Integer",
32825             "optional": true,
32826             "field": "dialAbandonedRetryFrequency",
32827             "description": "<p>Abandoned Retry Frequency Minutes (min:1, max:99999)</p>"
32828           },
32829           {
32830             "group": "Body",
32831             "type": "Integer",
32832             "optional": true,
32833             "field": "dialMachineMaxRetry",
32834             "description": "<p>#Machine Retry (min:1, max:999)</p>"
32835           },
32836           {
32837             "group": "Body",
32838             "type": "Integer",
32839             "optional": true,
32840             "field": "dialMachineRetryFrequency",
32841             "description": "<p>Machine Retry Frequency Minutes (min:1, max:99999)</p>"
32842           },
32843           {
32844             "group": "Body",
32845             "type": "Integer",
32846             "optional": true,
32847             "field": "dialAgentRejectMaxRetry",
32848             "description": "<p>#AgentReject Retry (min:1, max:999)</p>"
32849           },
32850           {
32851             "group": "Body",
32852             "type": "Integer",
32853             "optional": true,
32854             "field": "dialAgentRejectRetryFrequency",
32855             "description": "<p>AgentReject Retry Frequency Minutes (min:1, max:99999)</p>"
32856           },
32857           {
32858             "group": "Body",
32859             "type": "Integer",
32860             "optional": true,
32861             "field": "mandatoryDispositionPauseId",
32862             "description": "<p>Status to put when mandatory disposition is enabled</p>"
32863           },
32864           {
32865             "group": "Body",
32866             "type": "Boolean",
32867             "optional": true,
32868             "field": "mandatoryDisposition",
32869             "description": "<p>Enabled/disables mandatory dispo on a queue</p>"
32870           },
32871           {
32872             "group": "Body",
32873             "type": "Integer",
32874             "optional": true,
32875             "field": "dialPredictiveIntervalMaxThreshold",
32876             "description": ""
32877           },
32878           {
32879             "group": "Body",
32880             "type": "Integer",
32881             "optional": true,
32882             "field": "dialPredictiveIntervalMinThreshold",
32883             "description": ""
32884           },
32885           {
32886             "group": "Body",
32887             "type": "Boolean",
32888             "optional": true,
32889             "field": "dialPreviewAutoRecallMe",
32890             "description": ""
32891           }
32892         ]
32893       }
32894     },
32895     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32896     "version": "0.0.0",
32897     "filename": "server/api/voiceQueue/index.js",
32898     "groupTitle": "Voice_Queues"
32899   },
32900   {
32901     "type": "delete",
32902     "url": "/api/voice/queues/{id}",
32903     "title": "Deletes a Queue",
32904     "examples": [
32905       {
32906         "title": "Example usage:",
32907         "content": "curl https://{domain}/api/voice/queues/{id} -v -u {name}:{password} -X DELETE",
32908         "type": "json"
32909       }
32910     ],
32911     "name": "DeleteQueues",
32912     "group": "Voice_Queues",
32913     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32914     "version": "0.0.0",
32915     "filename": "server/api/voiceQueue/index.js",
32916     "groupTitle": "Voice_Queues"
32917   },
32918   {
32919     "type": "get",
32920     "url": "/api/voice/queues/{id}/users",
32921     "title": "Gets queue agents",
32922     "examples": [
32923       {
32924         "title": "Example usage:",
32925         "content": "curl https://{domain}/api/voice/queues/{id}/users -v -u {name}:{password} -X GET",
32926         "type": "json"
32927       }
32928     ],
32929     "name": "GetAgents",
32930     "group": "Voice_Queues",
32931     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32932     "version": "0.0.0",
32933     "filename": "server/api/voiceQueue/index.js",
32934     "groupTitle": "Voice_Queues"
32935   },
32936   {
32937     "type": "get",
32938     "url": "/api/voice/queues/{id}/blacklists",
32939     "title": "Get queue blacklists",
32940     "examples": [
32941       {
32942         "title": "Example usage:",
32943         "content": "curl https://{domain}/api/voice/queues/{id}/blacklists -v -u {name}:{password} -X GET",
32944         "type": "json"
32945       }
32946     ],
32947     "name": "GetBlackLists",
32948     "group": "Voice_Queues",
32949     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32950     "version": "0.0.0",
32951     "filename": "server/api/voiceQueue/index.js",
32952     "groupTitle": "Voice_Queues"
32953   },
32954   {
32955     "type": "get",
32956     "url": "/api/voice/queues/{id}/finals",
32957     "title": "Gets queue hopper finals",
32958     "examples": [
32959       {
32960         "title": "Example usage:",
32961         "content": "curl https://{domain}/api/voice/queues/{id}/hopper_finals -v -u {name}:{password}  -X GET",
32962         "type": "json"
32963       }
32964     ],
32965     "name": "GetHopperFinals",
32966     "group": "Voice_Queues",
32967     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32968     "version": "0.0.0",
32969     "filename": "server/api/voiceQueue/index.js",
32970     "groupTitle": "Voice_Queues"
32971   },
32972   {
32973     "type": "get",
32974     "url": "/api/voice/queues/{id}/hopper_histories",
32975     "title": "Gets queue hopper histories",
32976     "examples": [
32977       {
32978         "title": "Example usage:",
32979         "content": "curl https://{domain}/api/voice/queues/{id}/hopper_histories -v -u {name}:{password} -X GET",
32980         "type": "json"
32981       }
32982     ],
32983     "name": "GetHopperHistories",
32984     "group": "Voice_Queues",
32985     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32986     "version": "0.0.0",
32987     "filename": "server/api/voiceQueue/index.js",
32988     "groupTitle": "Voice_Queues"
32989   },
32990   {
32991     "type": "get",
32992     "url": "/api/voice/queues/{id}/hoppers",
32993     "title": "Gets queue hoppers",
32994     "examples": [
32995       {
32996         "title": "Example usage:",
32997         "content": "curl https://{domain}/api/voice/queues/{id}/hoppers -v -u {name}:{password} -X GET",
32998         "type": "json"
32999       }
33000     ],
33001     "name": "GetHoppers",
33002     "group": "Voice_Queues",
33003     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33004     "version": "0.0.0",
33005     "filename": "server/api/voiceQueue/index.js",
33006     "groupTitle": "Voice_Queues"
33007   },
33008   {
33009     "type": "get",
33010     "url": "/api/voice/queues/{id}/lists",
33011     "title": "Get queue lists",
33012     "examples": [
33013       {
33014         "title": "Example usage:",
33015         "content": "curl https://{domain}/api/voice/queues/{id}/lists -v -u {name}:{password} -X GET",
33016         "type": "json"
33017       }
33018     ],
33019     "name": "GetLists",
33020     "group": "Voice_Queues",
33021     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33022     "version": "0.0.0",
33023     "filename": "server/api/voiceQueue/index.js",
33024     "groupTitle": "Voice_Queues"
33025   },
33026   {
33027     "type": "get",
33028     "url": "/api/voice/queues/{id}/members",
33029     "title": "Gets queue members",
33030     "examples": [
33031       {
33032         "title": "Example usage:",
33033         "content": "curl https://{domain}/api/voice/queues/{id}/members -v -u {name}:{password} -X GET",
33034         "type": "json"
33035       }
33036     ],
33037     "name": "GetMembers",
33038     "group": "Voice_Queues",
33039     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33040     "version": "0.0.0",
33041     "filename": "server/api/voiceQueue/index.js",
33042     "groupTitle": "Voice_Queues"
33043   },
33044   {
33045     "type": "get",
33046     "url": "/api/voice/queues",
33047     "title": "Gets a list of Queues",
33048     "examples": [
33049       {
33050         "title": "Example usage:",
33051         "content": "curl https://{domain}/api/voice/queues -v -u {name}:{password}",
33052         "type": "json"
33053       }
33054     ],
33055     "name": "GetQueues",
33056     "group": "Voice_Queues",
33057     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
33058     "version": "0.0.0",
33059     "filename": "server/api/voiceQueue/index.js",
33060     "groupTitle": "Voice_Queues"
33061   },
33062   {
33063     "type": "get",
33064     "url": "/api/voice/queues/{id}/teams",
33065     "title": "Gets queue team",
33066     "examples": [
33067       {
33068         "title": "Example usage:",
33069         "content": "curl https://{domain}/api/voice/queues/{id}/teams -v -u {name}:{password}  -X GET",
33070         "type": "json"
33071       }
33072     ],
33073     "name": "GetTeams",
33074     "group": "Voice_Queues",
33075     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33076     "version": "0.0.0",
33077     "filename": "server/api/voiceQueue/index.js",
33078     "groupTitle": "Voice_Queues"
33079   },
33080   {
33081     "type": "delete",
33082     "url": "/api/voice/queues/{id}/users",
33083     "title": "Removes agents from a queue",
33084     "examples": [
33085       {
33086         "title": "Example usage:",
33087         "content": "curl https://{domain}/api/voice/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
33088         "type": "json"
33089       }
33090     ],
33091     "name": "RemoveAgents",
33092     "group": "Voice_Queues",
33093     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33094     "version": "0.0.0",
33095     "filename": "server/api/voiceQueue/index.js",
33096     "groupTitle": "Voice_Queues"
33097   },
33098   {
33099     "type": "delete",
33100     "url": "/api/voice/queues/{id}/blacklists",
33101     "title": "Remove blacklists from a queue",
33102     "examples": [
33103       {
33104         "title": "Example usage:",
33105         "content": "curl https://{domain}/api/voice/queues/{id}/blacklists?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
33106         "type": "json"
33107       }
33108     ],
33109     "name": "RemoveBlackLists",
33110     "group": "Voice_Queues",
33111     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33112     "version": "0.0.0",
33113     "filename": "server/api/voiceQueue/index.js",
33114     "groupTitle": "Voice_Queues"
33115   },
33116   {
33117     "type": "delete",
33118     "url": "/api/voice/queues/{id}/lists",
33119     "title": "Remove lists from a queue",
33120     "examples": [
33121       {
33122         "title": "Example usage:",
33123         "content": "curl https://{domain}/api/voice/queues/{id}/lists?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
33124         "type": "json"
33125       }
33126     ],
33127     "name": "RemoveLists",
33128     "group": "Voice_Queues",
33129     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33130     "version": "0.0.0",
33131     "filename": "server/api/voiceQueue/index.js",
33132     "groupTitle": "Voice_Queues"
33133   },
33134   {
33135     "type": "get",
33136     "url": "/api/voice/queues/{id}",
33137     "title": "Gets a single Queue",
33138     "examples": [
33139       {
33140         "title": "Example usage:",
33141         "content": "curl https://{domain}/api/voice/queues/{id} -v -u {name}:{password}",
33142         "type": "json"
33143       }
33144     ],
33145     "name": "ShowQueues",
33146     "group": "Voice_Queues",
33147     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33148     "version": "0.0.0",
33149     "filename": "server/api/voiceQueue/index.js",
33150     "groupTitle": "Voice_Queues"
33151   },
33152   {
33153     "type": "get",
33154     "url": "/api/voice/queues/{id}/blacks",
33155     "title": "Gets queue hopper blacks",
33156     "examples": [
33157       {
33158         "title": "Example usage:",
33159         "content": "curl https://{domain}/api/voice/queues/{id}/hopper_black -v -u {name}:{password}  -X GET",
33160         "type": "json"
33161       }
33162     ],
33163     "name": "getHopperBlacks",
33164     "group": "Voice_Queues",
33165     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33166     "version": "0.0.0",
33167     "filename": "server/api/voiceQueue/index.js",
33168     "groupTitle": "Voice_Queues"
33169   },
33170   {
33171     "type": "put",
33172     "url": "/api/voice/queues/{id}",
33173     "title": "Update an existing Queue",
33174     "examples": [
33175       {
33176         "title": "Example usage:",
33177         "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",
33178         "type": "json"
33179       }
33180     ],
33181     "name": "updateQueues",
33182     "group": "Voice_Queues",
33183     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33184     "version": "0.0.0",
33185     "filename": "server/api/voiceQueue/index.js",
33186     "groupTitle": "Voice_Queues"
33187   },
33188   {
33189     "type": "post",
33190     "url": "/api/voice/recordings",
33191     "title": "Creates a new Recording",
33192     "examples": [
33193       {
33194         "title": "Example usage:",
33195         "content": "curl https://{domain}/api/voice/recordings -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
33196         "type": "json"
33197       }
33198     ],
33199     "name": "CreateRecordings",
33200     "group": "Voice_Recordings",
33201     "parameter": {
33202       "fields": {
33203         "Body": [
33204           {
33205             "group": "Body",
33206             "type": "Virtual",
33207             "optional": true,
33208             "field": "format",
33209             "description": ""
33210           },
33211           {
33212             "group": "Body",
33213             "type": "String",
33214             "optional": true,
33215             "field": "uniqueid",
33216             "description": ""
33217           },
33218           {
33219             "group": "Body",
33220             "type": "String",
33221             "optional": true,
33222             "field": "channel",
33223             "description": ""
33224           },
33225           {
33226             "group": "Body",
33227             "type": "String",
33228             "optional": true,
33229             "field": "membername",
33230             "description": ""
33231           },
33232           {
33233             "group": "Body",
33234             "type": "String",
33235             "optional": true,
33236             "field": "calleridnum",
33237             "description": ""
33238           },
33239           {
33240             "group": "Body",
33241             "type": "String",
33242             "optional": true,
33243             "field": "calleridname",
33244             "description": ""
33245           },
33246           {
33247             "group": "Body",
33248             "type": "String",
33249             "optional": true,
33250             "field": "connectedlinenum",
33251             "description": ""
33252           },
33253           {
33254             "group": "Body",
33255             "type": "String",
33256             "optional": true,
33257             "field": "connectedlinename",
33258             "description": ""
33259           },
33260           {
33261             "group": "Body",
33262             "type": "String",
33263             "optional": true,
33264             "field": "accountcode",
33265             "description": ""
33266           },
33267           {
33268             "group": "Body",
33269             "type": "String",
33270             "optional": true,
33271             "field": "context",
33272             "description": ""
33273           },
33274           {
33275             "group": "Body",
33276             "type": "String",
33277             "optional": true,
33278             "field": "exten",
33279             "description": ""
33280           },
33281           {
33282             "group": "Body",
33283             "type": "String",
33284             "optional": true,
33285             "field": "value",
33286             "description": ""
33287           },
33288           {
33289             "group": "Body",
33290             "type": "String",
33291             "optional": true,
33292             "field": "type",
33293             "description": ""
33294           },
33295           {
33296             "group": "Body",
33297             "type": "Integer",
33298             "optional": true,
33299             "field": "rating",
33300             "description": ""
33301           },
33302           {
33303             "group": "Body",
33304             "type": "String",
33305             "optional": true,
33306             "field": "queue",
33307             "description": ""
33308           },
33309           {
33310             "group": "Body",
33311             "type": "String",
33312             "optional": true,
33313             "field": "userDisposition",
33314             "description": ""
33315           },
33316           {
33317             "group": "Body",
33318             "type": "String",
33319             "optional": true,
33320             "field": "userSecondDisposition",
33321             "description": ""
33322           },
33323           {
33324             "group": "Body",
33325             "type": "String",
33326             "optional": true,
33327             "field": "userThirdDisposition",
33328             "description": ""
33329           },
33330           {
33331             "group": "Body",
33332             "type": "Text",
33333             "optional": true,
33334             "field": "location",
33335             "description": ""
33336           },
33337           {
33338             "group": "Body",
33339             "type": "String",
33340             "optional": true,
33341             "field": "transcribeName",
33342             "description": ""
33343           },
33344           {
33345             "group": "Body",
33346             "type": "String",
33347             "optional": true,
33348             "field": "transcribeStatus",
33349             "description": ""
33350           },
33351           {
33352             "group": "Body",
33353             "type": "Text",
33354             "optional": true,
33355             "field": "fileUri",
33356             "description": ""
33357           },
33358           {
33359             "group": "Body",
33360             "type": "Text",
33361             "optional": true,
33362             "field": "fileText",
33363             "description": ""
33364           },
33365           {
33366             "group": "Body",
33367             "type": "Text",
33368             "optional": true,
33369             "field": "failureReason",
33370             "description": ""
33371           },
33372           {
33373             "group": "Body",
33374             "type": "String",
33375             "optional": true,
33376             "field": "sentiment",
33377             "description": ""
33378           },
33379           {
33380             "group": "Body",
33381             "type": "Float",
33382             "optional": true,
33383             "field": "sPositive",
33384             "description": ""
33385           },
33386           {
33387             "group": "Body",
33388             "type": "Float",
33389             "optional": true,
33390             "field": "sNegative",
33391             "description": ""
33392           },
33393           {
33394             "group": "Body",
33395             "type": "Float",
33396             "optional": true,
33397             "field": "sNeutral",
33398             "description": ""
33399           },
33400           {
33401             "group": "Body",
33402             "type": "Float",
33403             "optional": true,
33404             "field": "sMixed",
33405             "description": ""
33406           },
33407           {
33408             "group": "Body",
33409             "type": "Boolean",
33410             "optional": true,
33411             "field": "tempSentiment",
33412             "description": ""
33413           },
33414           {
33415             "group": "Body",
33416             "type": "String",
33417             "optional": true,
33418             "field": "createdAt",
33419             "description": ""
33420           },
33421           {
33422             "group": "Body",
33423             "type": "String",
33424             "optional": true,
33425             "field": "updatedAt",
33426             "description": ""
33427           }
33428         ]
33429       }
33430     },
33431     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33432     "version": "0.0.0",
33433     "filename": "server/api/voiceRecording/index.js",
33434     "groupTitle": "Voice_Recordings"
33435   },
33436   {
33437     "type": "get",
33438     "url": "/api/voice/recordings/describe",
33439     "title": "Gets table info about Recordings",
33440     "examples": [
33441       {
33442         "title": "Example usage:",
33443         "content": "curl https://{domain}/api/voice/recordings/describe -v -u {name}:{password}",
33444         "type": "json"
33445       }
33446     ],
33447     "name": "DescribeRecordings",
33448     "group": "Voice_Recordings",
33449     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33450     "version": "0.0.0",
33451     "filename": "server/api/voiceRecording/index.js",
33452     "groupTitle": "Voice_Recordings"
33453   },
33454   {
33455     "type": "get",
33456     "url": "/api/voice/recordings",
33457     "title": "Gets a list of Recordings",
33458     "examples": [
33459       {
33460         "title": "Example usage:",
33461         "content": "curl https://{domain}/api/voice/recordings -v -u {name}:{password}",
33462         "type": "json"
33463       }
33464     ],
33465     "name": "GetRecordings",
33466     "group": "Voice_Recordings",
33467     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
33468     "version": "0.0.0",
33469     "filename": "server/api/voiceRecording/index.js",
33470     "groupTitle": "Voice_Recordings"
33471   },
33472   {
33473     "type": "get",
33474     "url": "/api/voice/recordings/{id}",
33475     "title": "Gets a single Recording",
33476     "examples": [
33477       {
33478         "title": "Example usage:",
33479         "content": "curl https://{domain}/api/voice/recordings/{id} -v -u {name}:{password}",
33480         "type": "json"
33481       }
33482     ],
33483     "name": "ShowRecordings",
33484     "group": "Voice_Recordings",
33485     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33486     "version": "0.0.0",
33487     "filename": "server/api/voiceRecording/index.js",
33488     "groupTitle": "Voice_Recordings"
33489   },
33490   {
33491     "type": "delete",
33492     "url": "/api/voice/recordings/{id}",
33493     "title": "Delete voice recording",
33494     "examples": [
33495       {
33496         "title": "Example usage:",
33497         "content": "curl https://{domain}/api/voice/recordings/{id} -v -u {name}:{password} -X DELETE",
33498         "type": "json"
33499       }
33500     ],
33501     "name": "destroy",
33502     "group": "Voice_Recordings",
33503     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33504     "version": "0.0.0",
33505     "filename": "server/api/voiceRecording/index.js",
33506     "groupTitle": "Voice_Recordings"
33507   },
33508   {
33509     "type": "get",
33510     "url": "/api/voice/recordings/{id}/download",
33511     "title": "Download Recording",
33512     "examples": [
33513       {
33514         "title": "Example usage:",
33515         "content": "curl https://{domain}/api/voice/recordings/{id}/download -v -u {name}:{password} -X GET",
33516         "type": "json"
33517       }
33518     ],
33519     "name": "download",
33520     "group": "Voice_Recordings",
33521     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33522     "version": "0.0.0",
33523     "filename": "server/api/voiceRecording/index.js",
33524     "groupTitle": "Voice_Recordings"
33525   },
33526   {
33527     "type": "get",
33528     "url": "/api/voice/recordings/{id}/downloads",
33529     "title": "Download Recording",
33530     "examples": [
33531       {
33532         "title": "Example usage:",
33533         "content": "curl https://{domain}/api/voice/recordings/{id}/downloads -v -u {name}:{password} -X GET",
33534         "type": "json"
33535       }
33536     ],
33537     "name": "downloads",
33538     "group": "Voice_Recordings",
33539     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33540     "version": "0.0.0",
33541     "filename": "server/api/voiceRecording/index.js",
33542     "groupTitle": "Voice_Recordings"
33543   },
33544   {
33545     "type": "post",
33546     "url": "/api/voice/recordings/{id}/transcribe",
33547     "title": "Run Transcribe Recording",
33548     "examples": [
33549       {
33550         "title": "Example usage:",
33551         "content": "curl https://{domain}/api/voice/recordings/{id}/transcribe -d '{\"runSentiment\": \"true\"}' -v -u {name}:{password} -X POST",
33552         "type": "json"
33553       }
33554     ],
33555     "name": "transcribe",
33556     "group": "Voice_Recordings",
33557     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33558     "version": "0.0.0",
33559     "filename": "server/api/voiceRecording/index.js",
33560     "groupTitle": "Voice_Recordings"
33561   },
33562   {
33563     "type": "get",
33564     "url": "/api/voice/recordings/{id}/transcribe",
33565     "title": "Run Transcribe Recording",
33566     "examples": [
33567       {
33568         "title": "Example usage:",
33569         "content": "curl https://{domain}/api/voice/recordings/{id}/transcribe -v -u {name}:{password} -X GET",
33570         "type": "json"
33571       }
33572     ],
33573     "name": "transcribe",
33574     "group": "Voice_Recordings",
33575     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33576     "version": "0.0.0",
33577     "filename": "server/api/voiceRecording/index.js",
33578     "groupTitle": "Voice_Recordings"
33579   },
33580   {
33581     "type": "put",
33582     "url": "/api/voice/recordings/{id}",
33583     "title": "Update an existing Recording",
33584     "examples": [
33585       {
33586         "title": "Example usage:",
33587         "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",
33588         "type": "json"
33589       }
33590     ],
33591     "name": "updateRecordings",
33592     "group": "Voice_Recordings",
33593     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33594     "version": "0.0.0",
33595     "filename": "server/api/voiceRecording/index.js",
33596     "groupTitle": "Voice_Recordings"
33597   },
33598   {
33599     "type": "post",
33600     "url": "/api/voice/transfers/reports",
33601     "title": "Creates a new Transfer Report",
33602     "examples": [
33603       {
33604         "title": "Example usage:",
33605         "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",
33606         "type": "json"
33607       }
33608     ],
33609     "name": "CreateTransfer_Reports",
33610     "group": "Voice_Transfer_Reports",
33611     "parameter": {
33612       "fields": {
33613         "Body": [
33614           {
33615             "group": "Body",
33616             "type": "String",
33617             "allowedValues": [
33618               "\"blind\"",
33619               "\"attended\""
33620             ],
33621             "optional": true,
33622             "field": "type",
33623             "description": ""
33624           },
33625           {
33626             "group": "Body",
33627             "type": "String",
33628             "optional": true,
33629             "field": "result",
33630             "description": ""
33631           },
33632           {
33633             "group": "Body",
33634             "type": "String",
33635             "optional": true,
33636             "field": "transfererchannel",
33637             "description": ""
33638           },
33639           {
33640             "group": "Body",
33641             "type": "String",
33642             "optional": true,
33643             "field": "transferercalleridnum",
33644             "description": ""
33645           },
33646           {
33647             "group": "Body",
33648             "type": "String",
33649             "optional": true,
33650             "field": "transferercalleridname",
33651             "description": ""
33652           },
33653           {
33654             "group": "Body",
33655             "type": "String",
33656             "optional": true,
33657             "field": "transfererconnectedlinenum",
33658             "description": ""
33659           },
33660           {
33661             "group": "Body",
33662             "type": "String",
33663             "optional": true,
33664             "field": "transfererconnectedlinename",
33665             "description": ""
33666           },
33667           {
33668             "group": "Body",
33669             "type": "String",
33670             "optional": true,
33671             "field": "transfereraccountcode",
33672             "description": ""
33673           },
33674           {
33675             "group": "Body",
33676             "type": "String",
33677             "optional": true,
33678             "field": "transferercontext",
33679             "description": ""
33680           },
33681           {
33682             "group": "Body",
33683             "type": "String",
33684             "optional": true,
33685             "field": "transfererexten",
33686             "description": ""
33687           },
33688           {
33689             "group": "Body",
33690             "type": "String",
33691             "optional": true,
33692             "field": "transfererlinkedid",
33693             "description": ""
33694           },
33695           {
33696             "group": "Body",
33697             "type": "String",
33698             "optional": true,
33699             "field": "transfereechannel",
33700             "description": ""
33701           },
33702           {
33703             "group": "Body",
33704             "type": "String",
33705             "optional": true,
33706             "field": "transfereecalleridnum",
33707             "description": ""
33708           },
33709           {
33710             "group": "Body",
33711             "type": "String",
33712             "optional": true,
33713             "field": "transfereecalleridname",
33714             "description": ""
33715           },
33716           {
33717             "group": "Body",
33718             "type": "String",
33719             "optional": true,
33720             "field": "transfereeconnectedlinenum",
33721             "description": ""
33722           },
33723           {
33724             "group": "Body",
33725             "type": "String",
33726             "optional": true,
33727             "field": "transfereeconnectedlinename",
33728             "description": ""
33729           },
33730           {
33731             "group": "Body",
33732             "type": "String",
33733             "optional": true,
33734             "field": "transfereeaccountcode",
33735             "description": ""
33736           },
33737           {
33738             "group": "Body",
33739             "type": "String",
33740             "optional": true,
33741             "field": "transfereecontext",
33742             "description": ""
33743           },
33744           {
33745             "group": "Body",
33746             "type": "String",
33747             "optional": true,
33748             "field": "transfereeexten",
33749             "description": ""
33750           },
33751           {
33752             "group": "Body",
33753             "type": "String",
33754             "optional": true,
33755             "field": "transfereelinkedid",
33756             "description": ""
33757           },
33758           {
33759             "group": "Body",
33760             "type": "String",
33761             "allowedValues": [
33762               "\"Yes\"",
33763               "\"No\""
33764             ],
33765             "optional": true,
33766             "field": "isexternal",
33767             "description": ""
33768           },
33769           {
33770             "group": "Body",
33771             "type": "String",
33772             "optional": true,
33773             "field": "context",
33774             "description": ""
33775           },
33776           {
33777             "group": "Body",
33778             "type": "String",
33779             "optional": true,
33780             "field": "extension",
33781             "description": ""
33782           }
33783         ]
33784       }
33785     },
33786     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33787     "version": "0.0.0",
33788     "filename": "server/api/voiceTransferReport/index.js",
33789     "groupTitle": "Voice_Transfer_Reports"
33790   },
33791   {
33792     "type": "delete",
33793     "url": "/api/voice/transfers/reports/{id}",
33794     "title": "Deletes a Transfer Report",
33795     "examples": [
33796       {
33797         "title": "Example usage:",
33798         "content": "curl https://{domain}/api/voice/transfers/reports/{id} -v -u {name}:{password} -X DELETE",
33799         "type": "json"
33800       }
33801     ],
33802     "name": "DeleteTransfer_Reports",
33803     "group": "Voice_Transfer_Reports",
33804     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33805     "version": "0.0.0",
33806     "filename": "server/api/voiceTransferReport/index.js",
33807     "groupTitle": "Voice_Transfer_Reports"
33808   },
33809   {
33810     "type": "get",
33811     "url": "/api/voice/transfers/reports/describe",
33812     "title": "Gets table info about Transfer Reports",
33813     "examples": [
33814       {
33815         "title": "Example usage:",
33816         "content": "curl https://{domain}/api/voice/transfers/reports/describe -v -u {name}:{password}",
33817         "type": "json"
33818       }
33819     ],
33820     "name": "DescribeTransfer_Reports",
33821     "group": "Voice_Transfer_Reports",
33822     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33823     "version": "0.0.0",
33824     "filename": "server/api/voiceTransferReport/index.js",
33825     "groupTitle": "Voice_Transfer_Reports"
33826   },
33827   {
33828     "type": "get",
33829     "url": "/api/voice/transfers/reports",
33830     "title": "Gets a list of Transfer Reports",
33831     "examples": [
33832       {
33833         "title": "Example usage:",
33834         "content": "curl https://{domain}/api/voice/transfers/reports -v -u {name}:{password}",
33835         "type": "json"
33836       }
33837     ],
33838     "name": "GetTransfer_Reports",
33839     "group": "Voice_Transfer_Reports",
33840     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
33841     "version": "0.0.0",
33842     "filename": "server/api/voiceTransferReport/index.js",
33843     "groupTitle": "Voice_Transfer_Reports"
33844   },
33845   {
33846     "type": "get",
33847     "url": "/api/voice/transfers/reports/{id}",
33848     "title": "Gets a single Transfer Report",
33849     "examples": [
33850       {
33851         "title": "Example usage:",
33852         "content": "curl https://{domain}/api/voice/transfers/reports/{id} -v -u {name}:{password}",
33853         "type": "json"
33854       }
33855     ],
33856     "name": "ShowTransfer_Reports",
33857     "group": "Voice_Transfer_Reports",
33858     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33859     "version": "0.0.0",
33860     "filename": "server/api/voiceTransferReport/index.js",
33861     "groupTitle": "Voice_Transfer_Reports"
33862   },
33863   {
33864     "type": "put",
33865     "url": "/api/voice/transfers/reports/{id}",
33866     "title": "Update an existing Transfer Report",
33867     "examples": [
33868       {
33869         "title": "Example usage:",
33870         "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",
33871         "type": "json"
33872       }
33873     ],
33874     "name": "updateTransfer_Reports",
33875     "group": "Voice_Transfer_Reports",
33876     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33877     "version": "0.0.0",
33878     "filename": "server/api/voiceTransferReport/index.js",
33879     "groupTitle": "Voice_Transfer_Reports"
33880   },
33881   {
33882     "type": "post",
33883     "url": "/api/integrations/vtiger/accounts",
33884     "title": "Creates a new Vtiger Account",
33885     "examples": [
33886       {
33887         "title": "Example usage:",
33888         "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",
33889         "type": "json"
33890       }
33891     ],
33892     "name": "CreateVtiger_Accounts",
33893     "group": "Vtiger_Accounts",
33894     "parameter": {
33895       "fields": {
33896         "Body": [
33897           {
33898             "group": "Body",
33899             "type": "String",
33900             "optional": false,
33901             "field": "name",
33902             "description": ""
33903           },
33904           {
33905             "group": "Body",
33906             "type": "String",
33907             "optional": true,
33908             "field": "description",
33909             "description": ""
33910           },
33911           {
33912             "group": "Body",
33913             "type": "String",
33914             "optional": false,
33915             "field": "username",
33916             "description": ""
33917           },
33918           {
33919             "group": "Body",
33920             "type": "String",
33921             "optional": false,
33922             "field": "moduleName",
33923             "description": ""
33924           },
33925           {
33926             "group": "Body",
33927             "type": "String",
33928             "optional": false,
33929             "field": "remoteUri",
33930             "description": ""
33931           },
33932           {
33933             "group": "Body",
33934             "type": "String",
33935             "optional": false,
33936             "field": "serverUrl",
33937             "description": ""
33938           },
33939           {
33940             "group": "Body",
33941             "type": "String",
33942             "optional": false,
33943             "field": "accessKey",
33944             "description": ""
33945           }
33946         ]
33947       }
33948     },
33949     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33950     "version": "0.0.0",
33951     "filename": "server/api/intVtigerAccount/index.js",
33952     "groupTitle": "Vtiger_Accounts"
33953   },
33954   {
33955     "type": "delete",
33956     "url": "/api/integrations/vtiger/accounts/{id}",
33957     "title": "Deletes a Vtiger Account",
33958     "examples": [
33959       {
33960         "title": "Example usage:",
33961         "content": "curl https://{domain}/api/integrations/vtiger/accounts/{id} -v -u {name}:{password} -X DELETE",
33962         "type": "json"
33963       }
33964     ],
33965     "name": "DeleteVtiger_Accounts",
33966     "group": "Vtiger_Accounts",
33967     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33968     "version": "0.0.0",
33969     "filename": "server/api/intVtigerAccount/index.js",
33970     "groupTitle": "Vtiger_Accounts"
33971   },
33972   {
33973     "type": "get",
33974     "url": "/api/integrations/vtiger/accounts",
33975     "title": "Gets a list of Vtiger Accounts",
33976     "examples": [
33977       {
33978         "title": "Example usage:",
33979         "content": "curl https://{domain}/api/integrations/vtiger/accounts -v -u {name}:{password}",
33980         "type": "json"
33981       }
33982     ],
33983     "name": "GetVtiger_Accounts",
33984     "group": "Vtiger_Accounts",
33985     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
33986     "version": "0.0.0",
33987     "filename": "server/api/intVtigerAccount/index.js",
33988     "groupTitle": "Vtiger_Accounts"
33989   },
33990   {
33991     "type": "get",
33992     "url": "/api/integrations/vtiger/accounts/{id}",
33993     "title": "Gets a single Vtiger Account",
33994     "examples": [
33995       {
33996         "title": "Example usage:",
33997         "content": "curl https://{domain}/api/integrations/vtiger/accounts/{id} -v -u {name}:{password}",
33998         "type": "json"
33999       }
34000     ],
34001     "name": "ShowVtiger_Accounts",
34002     "group": "Vtiger_Accounts",
34003     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34004     "version": "0.0.0",
34005     "filename": "server/api/intVtigerAccount/index.js",
34006     "groupTitle": "Vtiger_Accounts"
34007   },
34008   {
34009     "type": "post",
34010     "url": "/api/integrations/vtiger/accounts/{id}/configurations",
34011     "title": "Creates new configuration",
34012     "examples": [
34013       {
34014         "title": "Example usage:",
34015         "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",
34016         "type": "json"
34017       }
34018     ],
34019     "name": "addConfiguration",
34020     "group": "Vtiger_Accounts",
34021     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34022     "version": "0.0.0",
34023     "filename": "server/api/intVtigerAccount/index.js",
34024     "groupTitle": "Vtiger_Accounts"
34025   },
34026   {
34027     "type": "get",
34028     "url": "/api/integrations/vtiger/accounts/{id}/configurations",
34029     "title": "Gets account configurations",
34030     "examples": [
34031       {
34032         "title": "Example usage:",
34033         "content": "curl https://{domain}/api/integrations/vtiger/accounts/{id}/configurations -v -u {name}:{password} -X GET",
34034         "type": "json"
34035       }
34036     ],
34037     "name": "getConfigurations",
34038     "group": "Vtiger_Accounts",
34039     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34040     "version": "0.0.0",
34041     "filename": "server/api/intVtigerAccount/index.js",
34042     "groupTitle": "Vtiger_Accounts"
34043   },
34044   {
34045     "type": "get",
34046     "url": "/api/integrations/vtiger/accounts/{id}/fields",
34047     "title": "Gets account fields",
34048     "examples": [
34049       {
34050         "title": "Example usage:",
34051         "content": "curl https://{domain}/api/integrations/vtiger/accounts/{id}/fields -v -u {name}:{password} -X GET",
34052         "type": "json"
34053       }
34054     ],
34055     "name": "getFields",
34056     "group": "Vtiger_Accounts",
34057     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34058     "version": "0.0.0",
34059     "filename": "server/api/intVtigerAccount/index.js",
34060     "groupTitle": "Vtiger_Accounts"
34061   },
34062   {
34063     "type": "put",
34064     "url": "/api/integrations/vtiger/accounts/{id}",
34065     "title": "Update an existing Vtiger Account",
34066     "examples": [
34067       {
34068         "title": "Example usage:",
34069         "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",
34070         "type": "json"
34071       }
34072     ],
34073     "name": "updateVtiger_Accounts",
34074     "group": "Vtiger_Accounts",
34075     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34076     "version": "0.0.0",
34077     "filename": "server/api/intVtigerAccount/index.js",
34078     "groupTitle": "Vtiger_Accounts"
34079   },
34080   {
34081     "type": "post",
34082     "url": "/api/integrations/vtiger/configurations",
34083     "title": "Creates a new Vtiger Configuration",
34084     "examples": [
34085       {
34086         "title": "Example usage:",
34087         "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",
34088         "type": "json"
34089       }
34090     ],
34091     "name": "CreateVtiger_Configurations",
34092     "group": "Vtiger_Configurations",
34093     "parameter": {
34094       "fields": {
34095         "Body": [
34096           {
34097             "group": "Body",
34098             "type": "String",
34099             "optional": true,
34100             "field": "name",
34101             "description": ""
34102           },
34103           {
34104             "group": "Body",
34105             "type": "String",
34106             "optional": true,
34107             "field": "description",
34108             "description": ""
34109           }
34110         ]
34111       }
34112     },
34113     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34114     "version": "0.0.0",
34115     "filename": "server/api/intVtigerConfiguration/index.js",
34116     "groupTitle": "Vtiger_Configurations"
34117   },
34118   {
34119     "type": "delete",
34120     "url": "/api/integrations/vtiger/configurations/{id}",
34121     "title": "Deletes a Vtiger Configuration",
34122     "examples": [
34123       {
34124         "title": "Example usage:",
34125         "content": "curl https://{domain}/api/integrations/vtiger/configurations/{id} -v -u {name}:{password} -X DELETE",
34126         "type": "json"
34127       }
34128     ],
34129     "name": "DeleteVtiger_Configurations",
34130     "group": "Vtiger_Configurations",
34131     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34132     "version": "0.0.0",
34133     "filename": "server/api/intVtigerConfiguration/index.js",
34134     "groupTitle": "Vtiger_Configurations"
34135   },
34136   {
34137     "type": "get",
34138     "url": "/api/integrations/vtiger/configurations",
34139     "title": "Gets a list of Vtiger Configurations",
34140     "examples": [
34141       {
34142         "title": "Example usage:",
34143         "content": "curl https://{domain}/api/integrations/vtiger/configurations -v -u {name}:{password}",
34144         "type": "json"
34145       }
34146     ],
34147     "name": "GetVtiger_Configurations",
34148     "group": "Vtiger_Configurations",
34149     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
34150     "version": "0.0.0",
34151     "filename": "server/api/intVtigerConfiguration/index.js",
34152     "groupTitle": "Vtiger_Configurations"
34153   },
34154   {
34155     "type": "get",
34156     "url": "/api/integrations/vtiger/configurations/{id}",
34157     "title": "Gets a single Vtiger Configuration",
34158     "examples": [
34159       {
34160         "title": "Example usage:",
34161         "content": "curl https://{domain}/api/integrations/vtiger/configurations/{id} -v -u {name}:{password}",
34162         "type": "json"
34163       }
34164     ],
34165     "name": "ShowVtiger_Configurations",
34166     "group": "Vtiger_Configurations",
34167     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34168     "version": "0.0.0",
34169     "filename": "server/api/intVtigerConfiguration/index.js",
34170     "groupTitle": "Vtiger_Configurations"
34171   },
34172   {
34173     "type": "get",
34174     "url": "/api/integrations/vtiger/configurations/{id}/descriptions",
34175     "title": "Gets configurations descriptions",
34176     "examples": [
34177       {
34178         "title": "Example usage:",
34179         "content": "curl https://{domain}/api/integrations/vtiger/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
34180         "type": "json"
34181       }
34182     ],
34183     "name": "getDescriptions",
34184     "group": "Vtiger_Configurations",
34185     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34186     "version": "0.0.0",
34187     "filename": "server/api/intVtigerConfiguration/index.js",
34188     "groupTitle": "Vtiger_Configurations"
34189   },
34190   {
34191     "type": "get",
34192     "url": "/api/integrations/vtiger/configurations/{id}/fields",
34193     "title": "Gets configurations fields",
34194     "examples": [
34195       {
34196         "title": "Example usage:",
34197         "content": "curl https://{domain}/api/integrations/vtiger/configurations/{id}/fields -v -u {name}:{password} -X GET",
34198         "type": "json"
34199       }
34200     ],
34201     "name": "getFields",
34202     "group": "Vtiger_Configurations",
34203     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34204     "version": "0.0.0",
34205     "filename": "server/api/intVtigerConfiguration/index.js",
34206     "groupTitle": "Vtiger_Configurations"
34207   },
34208   {
34209     "type": "get",
34210     "url": "/api/integrations/vtiger/configurations/{id}/subjects",
34211     "title": "Gets configurations subjects",
34212     "examples": [
34213       {
34214         "title": "Example usage:",
34215         "content": "curl https://{domain}/api/integrations/vtiger/configurations/{id}/subjects -v -u {name}:{password} -X GET",
34216         "type": "json"
34217       }
34218     ],
34219     "name": "getSubjects",
34220     "group": "Vtiger_Configurations",
34221     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34222     "version": "0.0.0",
34223     "filename": "server/api/intVtigerConfiguration/index.js",
34224     "groupTitle": "Vtiger_Configurations"
34225   },
34226   {
34227     "type": "put",
34228     "url": "/api/integrations/vtiger/configurations/{id}",
34229     "title": "Update an existing Vtiger Configuration",
34230     "examples": [
34231       {
34232         "title": "Example usage:",
34233         "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",
34234         "type": "json"
34235       }
34236     ],
34237     "name": "updateVtiger_Configurations",
34238     "group": "Vtiger_Configurations",
34239     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34240     "version": "0.0.0",
34241     "filename": "server/api/intVtigerConfiguration/index.js",
34242     "groupTitle": "Vtiger_Configurations"
34243   },
34244   {
34245     "type": "post",
34246     "url": "/api/integrations/vtiger/fields",
34247     "title": "Creates a new Vtiger Field",
34248     "examples": [
34249       {
34250         "title": "Example usage:",
34251         "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",
34252         "type": "json"
34253       }
34254     ],
34255     "name": "CreateVtiger_Fields",
34256     "group": "Vtiger_Fields",
34257     "parameter": {
34258       "fields": {
34259         "Body": [
34260           {
34261             "group": "Body",
34262             "type": "String",
34263             "allowedValues": [
34264               "\"string\"",
34265               "\"variable\"",
34266               "\"customVariable\"",
34267               "\"keyValue\"",
34268               "\"picklist\""
34269             ],
34270             "optional": true,
34271             "field": "type",
34272             "description": ""
34273           },
34274           {
34275             "group": "Body",
34276             "type": "String",
34277             "optional": true,
34278             "field": "content",
34279             "description": ""
34280           },
34281           {
34282             "group": "Body",
34283             "type": "String",
34284             "optional": true,
34285             "field": "key",
34286             "description": ""
34287           },
34288           {
34289             "group": "Body",
34290             "type": "String",
34291             "allowedValues": [
34292               "\"string\"",
34293               "\"variable\"",
34294               "\"customVariable\""
34295             ],
34296             "optional": true,
34297             "field": "keyType",
34298             "description": ""
34299           },
34300           {
34301             "group": "Body",
34302             "type": "String",
34303             "optional": true,
34304             "field": "keyContent",
34305             "description": ""
34306           },
34307           {
34308             "group": "Body",
34309             "type": "String",
34310             "optional": true,
34311             "field": "idField",
34312             "description": ""
34313           },
34314           {
34315             "group": "Body",
34316             "type": "String",
34317             "optional": true,
34318             "field": "nameField",
34319             "description": ""
34320           },
34321           {
34322             "group": "Body",
34323             "type": "Boolean",
34324             "optional": true,
34325             "field": "customField",
34326             "description": ""
34327           },
34328           {
34329             "group": "Body",
34330             "type": "String",
34331             "optional": true,
34332             "field": "variableName",
34333             "description": ""
34334           }
34335         ]
34336       }
34337     },
34338     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34339     "version": "0.0.0",
34340     "filename": "server/api/intVtigerField/index.js",
34341     "groupTitle": "Vtiger_Fields"
34342   },
34343   {
34344     "type": "delete",
34345     "url": "/api/integrations/vtiger/fields/{id}",
34346     "title": "Deletes a Vtiger Field",
34347     "examples": [
34348       {
34349         "title": "Example usage:",
34350         "content": "curl https://{domain}/api/integrations/vtiger/fields/{id} -v -u {name}:{password} -X DELETE",
34351         "type": "json"
34352       }
34353     ],
34354     "name": "DeleteVtiger_Fields",
34355     "group": "Vtiger_Fields",
34356     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34357     "version": "0.0.0",
34358     "filename": "server/api/intVtigerField/index.js",
34359     "groupTitle": "Vtiger_Fields"
34360   },
34361   {
34362     "type": "get",
34363     "url": "/api/integrations/vtiger/fields",
34364     "title": "Gets a list of Vtiger Fields",
34365     "examples": [
34366       {
34367         "title": "Example usage:",
34368         "content": "curl https://{domain}/api/integrations/vtiger/fields -v -u {name}:{password}",
34369         "type": "json"
34370       }
34371     ],
34372     "name": "GetVtiger_Fields",
34373     "group": "Vtiger_Fields",
34374     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
34375     "version": "0.0.0",
34376     "filename": "server/api/intVtigerField/index.js",
34377     "groupTitle": "Vtiger_Fields"
34378   },
34379   {
34380     "type": "get",
34381     "url": "/api/integrations/vtiger/fields/{id}",
34382     "title": "Gets a single Vtiger Field",
34383     "examples": [
34384       {
34385         "title": "Example usage:",
34386         "content": "curl https://{domain}/api/integrations/vtiger/fields/{id} -v -u {name}:{password}",
34387         "type": "json"
34388       }
34389     ],
34390     "name": "ShowVtiger_Fields",
34391     "group": "Vtiger_Fields",
34392     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34393     "version": "0.0.0",
34394     "filename": "server/api/intVtigerField/index.js",
34395     "groupTitle": "Vtiger_Fields"
34396   },
34397   {
34398     "type": "put",
34399     "url": "/api/integrations/vtiger/fields/{id}",
34400     "title": "Update an existing Vtiger Field",
34401     "examples": [
34402       {
34403         "title": "Example usage:",
34404         "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",
34405         "type": "json"
34406       }
34407     ],
34408     "name": "updateVtiger_Fields",
34409     "group": "Vtiger_Fields",
34410     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34411     "version": "0.0.0",
34412     "filename": "server/api/intVtigerField/index.js",
34413     "groupTitle": "Vtiger_Fields"
34414   },
34415   {
34416     "type": "post",
34417     "url": "/api/webbar/answer",
34418     "title": "answer webrtc call",
34419     "examples": [
34420       {
34421         "title": "Example usage:",
34422         "content": "curl https://{domain}/api/webbar/answer -d '{\"sessionId\": \"<sessionId>\", \"userId\": 54}' \\\n -H \"Content-Type: application/json\" -X POST",
34423         "type": "json"
34424       }
34425     ],
34426     "name": "Web_Bar_answer",
34427     "group": "WebBar",
34428     "parameter": {
34429       "fields": {
34430         "Body": [
34431           {
34432             "group": "Body",
34433             "type": "String",
34434             "optional": false,
34435             "field": "sessionId",
34436             "description": ""
34437           },
34438           {
34439             "group": "Body",
34440             "type": "number",
34441             "optional": false,
34442             "field": "userId",
34443             "description": ""
34444           }
34445         ]
34446       }
34447     },
34448     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34449     "version": "0.0.0",
34450     "filename": "server/api/webbar/index.js",
34451     "groupTitle": "WebBar"
34452   },
34453   {
34454     "type": "post",
34455     "url": "/api/webbar/calls",
34456     "title": "webrtc call list",
34457     "examples": [
34458       {
34459         "title": "Example usage:",
34460         "content": "curl https://{domain}/api/webbar/calls -d '{\"userId\": 54}' \\\n -H \"Content-Type: application/json\" -X POST",
34461         "type": "json"
34462       }
34463     ],
34464     "name": "Web_Bar_calls",
34465     "group": "WebBar",
34466     "parameter": {
34467       "fields": {
34468         "Body": [
34469           {
34470             "group": "Body",
34471             "type": "number",
34472             "optional": false,
34473             "field": "userId",
34474             "description": ""
34475           }
34476         ]
34477       }
34478     },
34479     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34480     "version": "0.0.0",
34481     "filename": "server/api/webbar/index.js",
34482     "groupTitle": "WebBar"
34483   },
34484   {
34485     "type": "post",
34486     "url": "/api/webbar/hangup",
34487     "title": "hangup webrtc call",
34488     "examples": [
34489       {
34490         "title": "Example usage:",
34491         "content": "curl https://{domain}/api/webbar/hangup -d '{\"sessionId\": \"<sessionId>\", \"userId\": 54}' \\\n -H \"Content-Type: application/json\" -X POST",
34492         "type": "json"
34493       }
34494     ],
34495     "name": "Web_Bar_hangup",
34496     "group": "WebBar",
34497     "parameter": {
34498       "fields": {
34499         "Body": [
34500           {
34501             "group": "Body",
34502             "type": "String",
34503             "optional": false,
34504             "field": "sessionId",
34505             "description": ""
34506           },
34507           {
34508             "group": "Body",
34509             "type": "number",
34510             "optional": false,
34511             "field": "userId",
34512             "description": ""
34513           }
34514         ]
34515       }
34516     },
34517     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34518     "version": "0.0.0",
34519     "filename": "server/api/webbar/index.js",
34520     "groupTitle": "WebBar"
34521   },
34522   {
34523     "type": "post",
34524     "url": "/api/webbar/unhold",
34525     "title": "unhold webrtc call",
34526     "examples": [
34527       {
34528         "title": "Example usage:",
34529         "content": "curl https://{domain}/api/webbar/unhold -d '{\"sessionId\": \"<sessionId>\", \"userId\": 54}' \\\n -H \"Content-Type: application/json\" -X POST",
34530         "type": "json"
34531       }
34532     ],
34533     "name": "Web_Bar_hold",
34534     "group": "WebBar",
34535     "parameter": {
34536       "fields": {
34537         "Body": [
34538           {
34539             "group": "Body",
34540             "type": "String",
34541             "optional": false,
34542             "field": "sessionId",
34543             "description": ""
34544           },
34545           {
34546             "group": "Body",
34547             "type": "number",
34548             "optional": false,
34549             "field": "userId",
34550             "description": ""
34551           }
34552         ]
34553       }
34554     },
34555     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34556     "version": "0.0.0",
34557     "filename": "server/api/webbar/index.js",
34558     "groupTitle": "WebBar"
34559   },
34560   {
34561     "type": "post",
34562     "url": "/api/webbar/hold",
34563     "title": "hold webrtc call",
34564     "examples": [
34565       {
34566         "title": "Example usage:",
34567         "content": "curl https://{domain}/api/webbar/hold -d '{\"sessionId\": \"<sessionId>\", \"userId\": 54}' \\\n -H \"Content-Type: application/json\" -X POST",
34568         "type": "json"
34569       }
34570     ],
34571     "name": "Web_Bar_hold",
34572     "group": "WebBar",
34573     "parameter": {
34574       "fields": {
34575         "Body": [
34576           {
34577             "group": "Body",
34578             "type": "String",
34579             "optional": true,
34580             "field": "sessionId",
34581             "description": ""
34582           },
34583           {
34584             "group": "Body",
34585             "type": "number",
34586             "optional": false,
34587             "field": "userId",
34588             "description": ""
34589           }
34590         ]
34591       }
34592     },
34593     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34594     "version": "0.0.0",
34595     "filename": "server/api/webbar/index.js",
34596     "groupTitle": "WebBar"
34597   },
34598   {
34599     "type": "post",
34600     "url": "/api/webbar/originate",
34601     "title": "Originate new webrtc call",
34602     "examples": [
34603       {
34604         "title": "Example usage:",
34605         "content": "curl https://{domain}/api/webbar/originate -d '{\"callNumber\": \"0119692844\", \"userId\": 54}' \\\n -H \"Content-Type: application/json\" -X POST",
34606         "type": "json"
34607       }
34608     ],
34609     "name": "Web_Bar_originate",
34610     "group": "WebBar",
34611     "parameter": {
34612       "fields": {
34613         "Body": [
34614           {
34615             "group": "Body",
34616             "type": "String",
34617             "optional": false,
34618             "field": "callNumber",
34619             "description": ""
34620           },
34621           {
34622             "group": "Body",
34623             "type": "number",
34624             "optional": false,
34625             "field": "userId",
34626             "description": ""
34627           },
34628           {
34629             "group": "Body",
34630             "type": "String",
34631             "optional": false,
34632             "field": "callerId",
34633             "description": ""
34634           },
34635           {
34636             "group": "Body",
34637             "type": "String",
34638             "optional": false,
34639             "field": "callbackUrl",
34640             "description": ""
34641           }
34642         ]
34643       }
34644     },
34645     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34646     "version": "0.0.0",
34647     "filename": "server/api/webbar/index.js",
34648     "groupTitle": "WebBar"
34649   },
34650   {
34651     "type": "post",
34652     "url": "/api/webbar/transfer",
34653     "title": "blind transfer webrtc call",
34654     "examples": [
34655       {
34656         "title": "Example usage:",
34657         "content": "curl https://{domain}/api/webbar/transfer -d '{\"userId\": 54, \"sessionId\":\"<sessionId>\", \"transferNumber\":\"<transferNumber>\"}' \\\n -H \"Content-Type: application/json\" -X POST",
34658         "type": "json"
34659       }
34660     ],
34661     "name": "Web_Bar_transfer",
34662     "group": "WebBar",
34663     "parameter": {
34664       "fields": {
34665         "Body": [
34666           {
34667             "group": "Body",
34668             "type": "number",
34669             "optional": false,
34670             "field": "userId",
34671             "description": ""
34672           },
34673           {
34674             "group": "Body",
34675             "type": "string",
34676             "optional": false,
34677             "field": "sessionId",
34678             "description": ""
34679           },
34680           {
34681             "group": "Body",
34682             "type": "string",
34683             "optional": false,
34684             "field": "transferNumber",
34685             "description": ""
34686           }
34687         ]
34688       }
34689     },
34690     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34691     "version": "0.0.0",
34692     "filename": "server/api/webbar/index.js",
34693     "groupTitle": "WebBar"
34694   },
34695   {
34696     "type": "post",
34697     "url": "/api/whatsapp/accounts/{id}/users",
34698     "title": "Add agents to a whatsapp account",
34699     "examples": [
34700       {
34701         "title": "Example usage:",
34702         "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",
34703         "type": "json"
34704       }
34705     ],
34706     "name": "AddAgents",
34707     "group": "Whatsapp_Accounts",
34708     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34709     "version": "0.0.0",
34710     "filename": "server/api/whatsappAccount/index.js",
34711     "groupTitle": "Whatsapp_Accounts"
34712   },
34713   {
34714     "type": "post",
34715     "url": "/api/whatsapp/accounts",
34716     "title": "Creates a new Account",
34717     "examples": [
34718       {
34719         "title": "Example usage:",
34720         "content": "curl https://{domain}/api/whatsapp/accounts -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
34721         "type": "json"
34722       }
34723     ],
34724     "name": "CreateAccounts",
34725     "group": "Whatsapp_Accounts",
34726     "parameter": {
34727       "fields": {
34728         "Body": [
34729           {
34730             "group": "Body",
34731             "type": "String",
34732             "optional": false,
34733             "field": "name",
34734             "description": ""
34735           },
34736           {
34737             "group": "Body",
34738             "type": "String",
34739             "optional": false,
34740             "field": "key",
34741             "description": ""
34742           },
34743           {
34744             "group": "Body",
34745             "type": "String",
34746             "optional": false,
34747             "field": "remote",
34748             "description": ""
34749           },
34750           {
34751             "group": "Body",
34752             "type": "String",
34753             "optional": true,
34754             "field": "token",
34755             "description": ""
34756           },
34757           {
34758             "group": "Body",
34759             "type": "String",
34760             "optional": true,
34761             "field": "phone",
34762             "description": ""
34763           },
34764           {
34765             "group": "Body",
34766             "type": "String",
34767             "allowedValues": [
34768               "\"twilio\""
34769             ],
34770             "optional": true,
34771             "field": "type",
34772             "description": ""
34773           },
34774           {
34775             "group": "Body",
34776             "type": "String",
34777             "optional": true,
34778             "field": "accountSid",
34779             "description": ""
34780           },
34781           {
34782             "group": "Body",
34783             "type": "String",
34784             "optional": true,
34785             "field": "authToken",
34786             "description": ""
34787           },
34788           {
34789             "group": "Body",
34790             "type": "Text",
34791             "optional": true,
34792             "field": "notificationTemplate",
34793             "description": ""
34794           },
34795           {
34796             "group": "Body",
34797             "type": "Boolean",
34798             "optional": true,
34799             "field": "notificationSound",
34800             "description": ""
34801           },
34802           {
34803             "group": "Body",
34804             "type": "Boolean",
34805             "optional": true,
34806             "field": "notificationShake",
34807             "description": ""
34808           },
34809           {
34810             "group": "Body",
34811             "type": "Integer",
34812             "optional": true,
34813             "field": "waitForTheAssignedAgent",
34814             "description": ""
34815           },
34816           {
34817             "group": "Body",
34818             "type": "Boolean",
34819             "optional": true,
34820             "field": "queueTransfer",
34821             "description": ""
34822           },
34823           {
34824             "group": "Body",
34825             "type": "Integer",
34826             "optional": true,
34827             "field": "queueTransferTimeout",
34828             "description": ""
34829           },
34830           {
34831             "group": "Body",
34832             "type": "Boolean",
34833             "optional": true,
34834             "field": "agentTransfer",
34835             "description": ""
34836           },
34837           {
34838             "group": "Body",
34839             "type": "Integer",
34840             "optional": true,
34841             "field": "agentTransferTimeout",
34842             "description": ""
34843           },
34844           {
34845             "group": "Body",
34846             "type": "Integer",
34847             "optional": true,
34848             "field": "mandatoryDispositionPauseId",
34849             "description": "<p>Status to put when mandatory disposition is enabled</p>"
34850           },
34851           {
34852             "group": "Body",
34853             "type": "Boolean",
34854             "optional": true,
34855             "field": "mandatoryDisposition",
34856             "description": "<p>Enabled/disables mandatory dispo on a queue</p>"
34857           },
34858           {
34859             "group": "Body",
34860             "type": "String",
34861             "optional": true,
34862             "field": "description",
34863             "description": ""
34864           }
34865         ]
34866       }
34867     },
34868     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34869     "version": "0.0.0",
34870     "filename": "server/api/whatsappAccount/index.js",
34871     "groupTitle": "Whatsapp_Accounts"
34872   },
34873   {
34874     "type": "delete",
34875     "url": "/api/whatsapp/accounts/{id}",
34876     "title": "Deletes a Account",
34877     "examples": [
34878       {
34879         "title": "Example usage:",
34880         "content": "curl https://{domain}/api/whatsapp/accounts/{id} -v -u {name}:{password} -X DELETE",
34881         "type": "json"
34882       }
34883     ],
34884     "name": "DeleteAccounts",
34885     "group": "Whatsapp_Accounts",
34886     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34887     "version": "0.0.0",
34888     "filename": "server/api/whatsappAccount/index.js",
34889     "groupTitle": "Whatsapp_Accounts"
34890   },
34891   {
34892     "type": "get",
34893     "url": "/api/whatsapp/accounts/describe",
34894     "title": "Gets table info about Accounts",
34895     "examples": [
34896       {
34897         "title": "Example usage:",
34898         "content": "curl https://{domain}/api/whatsapp/accounts/describe -v -u {name}:{password}",
34899         "type": "json"
34900       }
34901     ],
34902     "name": "DescribeAccounts",
34903     "group": "Whatsapp_Accounts",
34904     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34905     "version": "0.0.0",
34906     "filename": "server/api/whatsappAccount/index.js",
34907     "groupTitle": "Whatsapp_Accounts"
34908   },
34909   {
34910     "type": "get",
34911     "url": "/api/whatsapp/accounts",
34912     "title": "Gets a list of Accounts",
34913     "examples": [
34914       {
34915         "title": "Example usage:",
34916         "content": "curl https://{domain}/api/whatsapp/accounts -v -u {name}:{password}",
34917         "type": "json"
34918       }
34919     ],
34920     "name": "GetAccounts",
34921     "group": "Whatsapp_Accounts",
34922     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
34923     "version": "0.0.0",
34924     "filename": "server/api/whatsappAccount/index.js",
34925     "groupTitle": "Whatsapp_Accounts"
34926   },
34927   {
34928     "type": "get",
34929     "url": "/api/whatsapp/accounts/{id}/users",
34930     "title": "Gets agents from whatsapp account",
34931     "examples": [
34932       {
34933         "title": "Example usage:",
34934         "content": "curl https://{domain}/api/whatsapp/accounts/{id}/users -v -u {name}:{password} -X GET",
34935         "type": "json"
34936       }
34937     ],
34938     "name": "GetAgents",
34939     "group": "Whatsapp_Accounts",
34940     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34941     "version": "0.0.0",
34942     "filename": "server/api/whatsappAccount/index.js",
34943     "groupTitle": "Whatsapp_Accounts"
34944   },
34945   {
34946     "type": "delete",
34947     "url": "/api/whatsapp/accounts/{id}/users",
34948     "title": "Removes agents from a whatsapp account",
34949     "examples": [
34950       {
34951         "title": "Example usage:",
34952         "content": "curl https://{domain}/api/whatsapp/accounts/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
34953         "type": "json"
34954       }
34955     ],
34956     "name": "RemoveAgents",
34957     "group": "Whatsapp_Accounts",
34958     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34959     "version": "0.0.0",
34960     "filename": "server/api/whatsappAccount/index.js",
34961     "groupTitle": "Whatsapp_Accounts"
34962   },
34963   {
34964     "type": "delete",
34965     "url": "/api/whatsapp/accounts/{id}/canned_answers",
34966     "title": "Removes canned answers from account",
34967     "examples": [
34968       {
34969         "title": "Example usage:",
34970         "content": "curl https://{domain}/api/whatsapp/accounts/{id}/canned_answers?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
34971         "type": "json"
34972       }
34973     ],
34974     "name": "RemoveAnswers",
34975     "group": "Whatsapp_Accounts",
34976     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34977     "version": "0.0.0",
34978     "filename": "server/api/whatsappAccount/index.js",
34979     "groupTitle": "Whatsapp_Accounts"
34980   },
34981   {
34982     "type": "delete",
34983     "url": "/api/whatsapp/accounts/{id}/dispositions",
34984     "title": "Removes dispositions from account",
34985     "examples": [
34986       {
34987         "title": "Example usage:",
34988         "content": "curl https://{domain}/api/whatsapp/accounts/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
34989         "type": "json"
34990       }
34991     ],
34992     "name": "RemoveDispositions",
34993     "group": "Whatsapp_Accounts",
34994     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34995     "version": "0.0.0",
34996     "filename": "server/api/whatsappAccount/index.js",
34997     "groupTitle": "Whatsapp_Accounts"
34998   },
34999   {
35000     "type": "get",
35001     "url": "/api/whatsapp/accounts/{id}",
35002     "title": "Gets a single Account",
35003     "examples": [
35004       {
35005         "title": "Example usage:",
35006         "content": "curl https://{domain}/api/whatsapp/accounts/{id} -v -u {name}:{password}",
35007         "type": "json"
35008       }
35009     ],
35010     "name": "ShowAccounts",
35011     "group": "Whatsapp_Accounts",
35012     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35013     "version": "0.0.0",
35014     "filename": "server/api/whatsappAccount/index.js",
35015     "groupTitle": "Whatsapp_Accounts"
35016   },
35017   {
35018     "type": "put",
35019     "url": "/api/whatsapp/messages/{id}/accept",
35020     "title": "Accepts message",
35021     "examples": [
35022       {
35023         "title": "Example usage:",
35024         "content": "curl https://{domain}/api/whatsapp/messages/{id}/accept \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
35025         "type": "json"
35026       }
35027     ],
35028     "name": "acceptMessage",
35029     "group": "Whatsapp_Accounts",
35030     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35031     "version": "0.0.0",
35032     "filename": "server/api/whatsappMessage/index.js",
35033     "groupTitle": "Whatsapp_Accounts"
35034   },
35035   {
35036     "type": "post",
35037     "url": "/api/whatsapp/accounts/{id}/canned_answers",
35038     "title": "Creates new canned answer",
35039     "examples": [
35040       {
35041         "title": "Example usage:",
35042         "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",
35043         "type": "json"
35044       }
35045     ],
35046     "name": "addAnswer",
35047     "group": "Whatsapp_Accounts",
35048     "parameter": {
35049       "fields": {
35050         "Body": [
35051           {
35052             "group": "Body",
35053             "type": "String",
35054             "optional": false,
35055             "field": "key",
35056             "description": ""
35057           },
35058           {
35059             "group": "Body",
35060             "type": "Text",
35061             "optional": false,
35062             "field": "value",
35063             "description": ""
35064           },
35065           {
35066             "group": "Body",
35067             "type": "String",
35068             "optional": true,
35069             "field": "description",
35070             "description": ""
35071           },
35072           {
35073             "group": "Body",
35074             "type": "Virtual",
35075             "optional": true,
35076             "field": "name",
35077             "description": ""
35078           }
35079         ]
35080       }
35081     },
35082     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35083     "version": "0.0.0",
35084     "filename": "server/api/whatsappAccount/index.js",
35085     "groupTitle": "Whatsapp_Accounts"
35086   },
35087   {
35088     "type": "post",
35089     "url": "/api/whatsapp/accounts/{id}/applications",
35090     "title": "Creates new applications",
35091     "examples": [
35092       {
35093         "title": "Example usage:",
35094         "content": "curl https://{domain}/api/whatsapp/accounts/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
35095         "type": "json"
35096       }
35097     ],
35098     "name": "addApplications",
35099     "group": "Whatsapp_Accounts",
35100     "parameter": {
35101       "fields": {
35102         "Body": [
35103           {
35104             "group": "Body",
35105             "type": "Integer",
35106             "optional": false,
35107             "field": "priority",
35108             "description": ""
35109           },
35110           {
35111             "group": "Body",
35112             "type": "String",
35113             "optional": false,
35114             "field": "app",
35115             "description": ""
35116           },
35117           {
35118             "group": "Body",
35119             "type": "Text",
35120             "optional": true,
35121             "field": "appdata",
35122             "description": ""
35123           },
35124           {
35125             "group": "Body",
35126             "type": "String",
35127             "optional": true,
35128             "field": "description",
35129             "description": ""
35130           },
35131           {
35132             "group": "Body",
35133             "type": "String",
35134             "optional": true,
35135             "field": "interval",
35136             "description": ""
35137           }
35138         ]
35139       }
35140     },
35141     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35142     "version": "0.0.0",
35143     "filename": "server/api/whatsappAccount/index.js",
35144     "groupTitle": "Whatsapp_Accounts"
35145   },
35146   {
35147     "type": "post",
35148     "url": "/api/whatsapp/accounts/{id}/dispositions",
35149     "title": "Creates new disposition",
35150     "examples": [
35151       {
35152         "title": "Example usage:",
35153         "content": "curl https://{domain}/api/whatsapp/accounts/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
35154         "type": "json"
35155       }
35156     ],
35157     "name": "addDisposition",
35158     "group": "Whatsapp_Accounts",
35159     "parameter": {
35160       "fields": {
35161         "Body": [
35162           {
35163             "group": "Body",
35164             "type": "String",
35165             "optional": false,
35166             "field": "name",
35167             "description": ""
35168           },
35169           {
35170             "group": "Body",
35171             "type": "String",
35172             "allowedValues": [
35173               "\"first\"",
35174               "\"second\"",
35175               "\"third\""
35176             ],
35177             "optional": false,
35178             "field": "level",
35179             "description": ""
35180           },
35181           {
35182             "group": "Body",
35183             "type": "String",
35184             "optional": true,
35185             "field": "description",
35186             "description": ""
35187           }
35188         ]
35189       }
35190     },
35191     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35192     "version": "0.0.0",
35193     "filename": "server/api/whatsappAccount/index.js",
35194     "groupTitle": "Whatsapp_Accounts"
35195   },
35196   {
35197     "type": "get",
35198     "url": "/api/whatsapp/accounts/{id}/canned_answers",
35199     "title": "Gets account canned answers",
35200     "examples": [
35201       {
35202         "title": "Example usage:",
35203         "content": "curl https://{domain}/api/whatsapp/accounts/{id}/canned_answers -v -u {name}:{password} -X GET",
35204         "type": "json"
35205       }
35206     ],
35207     "name": "getAnswers",
35208     "group": "Whatsapp_Accounts",
35209     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35210     "version": "0.0.0",
35211     "filename": "server/api/whatsappAccount/index.js",
35212     "groupTitle": "Whatsapp_Accounts"
35213   },
35214   {
35215     "type": "get",
35216     "url": "/api/whatsapp/accounts/{id}/applications",
35217     "title": "Gets account applications",
35218     "examples": [
35219       {
35220         "title": "Example usage:",
35221         "content": "curl https://{domain}/api/whatsapp/accounts/{id}/applications -v -u {name}:{password} -X GET",
35222         "type": "json"
35223       }
35224     ],
35225     "name": "getApplications",
35226     "group": "Whatsapp_Accounts",
35227     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35228     "version": "0.0.0",
35229     "filename": "server/api/whatsappAccount/index.js",
35230     "groupTitle": "Whatsapp_Accounts"
35231   },
35232   {
35233     "type": "get",
35234     "url": "/api/whatsapp/accounts/{id}/dispositions",
35235     "title": "Gets account dispositions",
35236     "examples": [
35237       {
35238         "title": "Example usage:",
35239         "content": "curl https://{domain}/api/whatsapp/accounts/{id}/dispositions -v -u {name}:{password} -X GET",
35240         "type": "json"
35241       }
35242     ],
35243     "name": "getDispositions",
35244     "group": "Whatsapp_Accounts",
35245     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35246     "version": "0.0.0",
35247     "filename": "server/api/whatsappAccount/index.js",
35248     "groupTitle": "Whatsapp_Accounts"
35249   },
35250   {
35251     "type": "post",
35252     "url": "/api/whatsapp/accounts/{id}/notify",
35253     "title": "Notify new message",
35254     "examples": [
35255       {
35256         "title": "Example usage:",
35257         "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",
35258         "type": "json"
35259       }
35260     ],
35261     "name": "notify",
35262     "group": "Whatsapp_Accounts",
35263     "description": "<p>Motion 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>",
35264     "version": "0.0.0",
35265     "filename": "server/api/whatsappAccount/index.js",
35266     "groupTitle": "Whatsapp_Accounts"
35267   },
35268   {
35269     "type": "put",
35270     "url": "/api/whatsapp/messages/{id}/reject",
35271     "title": "Rejects message",
35272     "examples": [
35273       {
35274         "title": "Example usage:",
35275         "content": "curl https://{domain}/api/whatsapp/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
35276         "type": "json"
35277       }
35278     ],
35279     "name": "rejectMessage",
35280     "group": "Whatsapp_Accounts",
35281     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35282     "version": "0.0.0",
35283     "filename": "server/api/whatsappMessage/index.js",
35284     "groupTitle": "Whatsapp_Accounts"
35285   },
35286   {
35287     "type": "post",
35288     "url": "/api/whatsapp/accounts/{id}/send",
35289     "title": "Send new whatsapp message",
35290     "examples": [
35291       {
35292         "title": "Example usage:",
35293         "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",
35294         "type": "json"
35295       }
35296     ],
35297     "name": "sendWhatsapp",
35298     "group": "Whatsapp_Accounts",
35299     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35300     "version": "0.0.0",
35301     "filename": "server/api/whatsappAccount/index.js",
35302     "groupTitle": "Whatsapp_Accounts"
35303   },
35304   {
35305     "type": "post",
35306     "url": "/api/whatsapp/messages/{id}/status",
35307     "title": "Receive message status",
35308     "examples": [
35309       {
35310         "title": "Example usage:",
35311         "content": "curl https://{domain}/api/whatsapp/messages/{id}/status \\ \n -H 'Content-Type: application/json' -v -X POST",
35312         "type": "json"
35313       }
35314     ],
35315     "name": "statusMessage",
35316     "group": "Whatsapp_Accounts",
35317     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35318     "version": "0.0.0",
35319     "filename": "server/api/whatsappMessage/index.js",
35320     "groupTitle": "Whatsapp_Accounts"
35321   },
35322   {
35323     "type": "put",
35324     "url": "/api/whatsapp/accounts/{id}",
35325     "title": "Update an existing Account",
35326     "examples": [
35327       {
35328         "title": "Example usage:",
35329         "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",
35330         "type": "json"
35331       }
35332     ],
35333     "name": "updateAccounts",
35334     "group": "Whatsapp_Accounts",
35335     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35336     "version": "0.0.0",
35337     "filename": "server/api/whatsappAccount/index.js",
35338     "groupTitle": "Whatsapp_Accounts"
35339   },
35340   {
35341     "type": "post",
35342     "url": "/api/whatsapp/applications",
35343     "title": "Creates a new Application",
35344     "examples": [
35345       {
35346         "title": "Example usage:",
35347         "content": "curl https://{domain}/api/whatsapp/applications -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
35348         "type": "json"
35349       }
35350     ],
35351     "name": "CreateApplications",
35352     "group": "Whatsapp_Applications",
35353     "parameter": {
35354       "fields": {
35355         "Body": [
35356           {
35357             "group": "Body",
35358             "type": "Integer",
35359             "optional": false,
35360             "field": "priority",
35361             "description": ""
35362           },
35363           {
35364             "group": "Body",
35365             "type": "String",
35366             "optional": false,
35367             "field": "app",
35368             "description": ""
35369           },
35370           {
35371             "group": "Body",
35372             "type": "Text",
35373             "optional": true,
35374             "field": "appdata",
35375             "description": ""
35376           },
35377           {
35378             "group": "Body",
35379             "type": "String",
35380             "optional": true,
35381             "field": "description",
35382             "description": ""
35383           },
35384           {
35385             "group": "Body",
35386             "type": "String",
35387             "optional": true,
35388             "field": "interval",
35389             "description": ""
35390           }
35391         ]
35392       }
35393     },
35394     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35395     "version": "0.0.0",
35396     "filename": "server/api/whatsappApplication/index.js",
35397     "groupTitle": "Whatsapp_Applications"
35398   },
35399   {
35400     "type": "delete",
35401     "url": "/api/whatsapp/applications/{id}",
35402     "title": "Deletes a Application",
35403     "examples": [
35404       {
35405         "title": "Example usage:",
35406         "content": "curl https://{domain}/api/whatsapp/applications/{id} -v -u {name}:{password} -X DELETE",
35407         "type": "json"
35408       }
35409     ],
35410     "name": "DeleteApplications",
35411     "group": "Whatsapp_Applications",
35412     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35413     "version": "0.0.0",
35414     "filename": "server/api/whatsappApplication/index.js",
35415     "groupTitle": "Whatsapp_Applications"
35416   },
35417   {
35418     "type": "get",
35419     "url": "/api/whatsapp/applications",
35420     "title": "Gets a list of Applications",
35421     "examples": [
35422       {
35423         "title": "Example usage:",
35424         "content": "curl https://{domain}/api/whatsapp/applications -v -u {name}:{password}",
35425         "type": "json"
35426       }
35427     ],
35428     "name": "GetApplications",
35429     "group": "Whatsapp_Applications",
35430     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
35431     "version": "0.0.0",
35432     "filename": "server/api/whatsappApplication/index.js",
35433     "groupTitle": "Whatsapp_Applications"
35434   },
35435   {
35436     "type": "get",
35437     "url": "/api/whatsapp/applications/{id}",
35438     "title": "Gets a single Application",
35439     "examples": [
35440       {
35441         "title": "Example usage:",
35442         "content": "curl https://{domain}/api/whatsapp/applications/{id} -v -u {name}:{password}",
35443         "type": "json"
35444       }
35445     ],
35446     "name": "ShowApplications",
35447     "group": "Whatsapp_Applications",
35448     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35449     "version": "0.0.0",
35450     "filename": "server/api/whatsappApplication/index.js",
35451     "groupTitle": "Whatsapp_Applications"
35452   },
35453   {
35454     "type": "put",
35455     "url": "/api/whatsapp/applications/{id}",
35456     "title": "Update an existing Application",
35457     "examples": [
35458       {
35459         "title": "Example usage:",
35460         "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",
35461         "type": "json"
35462       }
35463     ],
35464     "name": "updateApplications",
35465     "group": "Whatsapp_Applications",
35466     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35467     "version": "0.0.0",
35468     "filename": "server/api/whatsappApplication/index.js",
35469     "groupTitle": "Whatsapp_Applications"
35470   },
35471   {
35472     "type": "post",
35473     "url": "/api/whatsapp/interactions/{id}/tags",
35474     "title": "Add tags to the interaction",
35475     "examples": [
35476       {
35477         "title": "Example usage:",
35478         "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",
35479         "type": "json"
35480       }
35481     ],
35482     "name": "AddTags",
35483     "group": "Whatsapp_Interactions",
35484     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35485     "version": "0.0.0",
35486     "filename": "server/api/whatsappInteraction/index.js",
35487     "groupTitle": "Whatsapp_Interactions"
35488   },
35489   {
35490     "type": "post",
35491     "url": "/api/whatsapp/interactions",
35492     "title": "Creates a new Interaction",
35493     "examples": [
35494       {
35495         "title": "Example usage:",
35496         "content": "curl https://{domain}/api/whatsapp/interactions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
35497         "type": "json"
35498       }
35499     ],
35500     "name": "CreateInteractions",
35501     "group": "Whatsapp_Interactions",
35502     "parameter": {
35503       "fields": {
35504         "Body": [
35505           {
35506             "group": "Body",
35507             "type": "Boolean",
35508             "optional": true,
35509             "field": "closed",
35510             "description": ""
35511           },
35512           {
35513             "group": "Body",
35514             "type": "String",
35515             "optional": true,
35516             "field": "closedAt",
35517             "description": ""
35518           },
35519           {
35520             "group": "Body",
35521             "type": "String",
35522             "optional": true,
35523             "field": "disposition",
35524             "description": ""
35525           },
35526           {
35527             "group": "Body",
35528             "type": "String",
35529             "optional": true,
35530             "field": "secondDisposition",
35531             "description": ""
35532           },
35533           {
35534             "group": "Body",
35535             "type": "String",
35536             "optional": true,
35537             "field": "thirdDisposition",
35538             "description": ""
35539           },
35540           {
35541             "group": "Body",
35542             "type": "String",
35543             "optional": true,
35544             "field": "note",
35545             "description": ""
35546           },
35547           {
35548             "group": "Body",
35549             "type": "String",
35550             "optional": true,
35551             "field": "phone",
35552             "description": ""
35553           },
35554           {
35555             "group": "Body",
35556             "type": "String",
35557             "optional": true,
35558             "field": "read1stAt",
35559             "description": ""
35560           },
35561           {
35562             "group": "Body",
35563             "type": "String",
35564             "allowedValues": [
35565               "\"in\"",
35566               "\"out\""
35567             ],
35568             "optional": false,
35569             "field": "firstMsgDirection",
35570             "description": ""
35571           },
35572           {
35573             "group": "Body",
35574             "type": "String",
35575             "optional": true,
35576             "field": "lastMsgAt",
35577             "description": ""
35578           },
35579           {
35580             "group": "Body",
35581             "type": "String",
35582             "allowedValues": [
35583               "\"in\"",
35584               "\"out\""
35585             ],
35586             "optional": false,
35587             "field": "lastMsgDirection",
35588             "description": ""
35589           },
35590           {
35591             "group": "Body",
35592             "type": "Boolean",
35593             "optional": true,
35594             "field": "autoreplyExecuted",
35595             "description": ""
35596           }
35597         ]
35598       }
35599     },
35600     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35601     "version": "0.0.0",
35602     "filename": "server/api/whatsappInteraction/index.js",
35603     "groupTitle": "Whatsapp_Interactions"
35604   },
35605   {
35606     "type": "delete",
35607     "url": "/api/whatsapp/interactions/{id}",
35608     "title": "Deletes a Interaction",
35609     "examples": [
35610       {
35611         "title": "Example usage:",
35612         "content": "curl https://{domain}/api/whatsapp/interactions/{id} -v -u {name}:{password} -X DELETE",
35613         "type": "json"
35614       }
35615     ],
35616     "name": "DeleteInteractions",
35617     "group": "Whatsapp_Interactions",
35618     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35619     "version": "0.0.0",
35620     "filename": "server/api/whatsappInteraction/index.js",
35621     "groupTitle": "Whatsapp_Interactions"
35622   },
35623   {
35624     "type": "get",
35625     "url": "/api/whatsapp/interactions/describe",
35626     "title": "Gets table info about Interactions",
35627     "examples": [
35628       {
35629         "title": "Example usage:",
35630         "content": "curl https://{domain}/api/whatsapp/interactions/describe -v -u {name}:{password}",
35631         "type": "json"
35632       }
35633     ],
35634     "name": "DescribeInteractions",
35635     "group": "Whatsapp_Interactions",
35636     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35637     "version": "0.0.0",
35638     "filename": "server/api/whatsappInteraction/index.js",
35639     "groupTitle": "Whatsapp_Interactions"
35640   },
35641   {
35642     "type": "get",
35643     "url": "/api/whatsapp/interactions",
35644     "title": "Gets a list of Interactions",
35645     "examples": [
35646       {
35647         "title": "Example usage:",
35648         "content": "curl https://{domain}/api/whatsapp/interactions -v -u {name}:{password}",
35649         "type": "json"
35650       }
35651     ],
35652     "name": "GetInteractions",
35653     "group": "Whatsapp_Interactions",
35654     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
35655     "version": "0.0.0",
35656     "filename": "server/api/whatsappInteraction/index.js",
35657     "groupTitle": "Whatsapp_Interactions"
35658   },
35659   {
35660     "type": "delete",
35661     "url": "/api/whatsapp/interactions/{id}/tags",
35662     "title": "Removes tags from interaction",
35663     "examples": [
35664       {
35665         "title": "Example usage:",
35666         "content": "curl https://{domain}/api/whatsapp/interactions/{id}/tags?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
35667         "type": "json"
35668       }
35669     ],
35670     "name": "RemoveTags",
35671     "group": "Whatsapp_Interactions",
35672     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35673     "version": "0.0.0",
35674     "filename": "server/api/whatsappInteraction/index.js",
35675     "groupTitle": "Whatsapp_Interactions"
35676   },
35677   {
35678     "type": "get",
35679     "url": "/api/whatsapp/interactions/{id}",
35680     "title": "Gets a single Interaction",
35681     "examples": [
35682       {
35683         "title": "Example usage:",
35684         "content": "curl https://{domain}/api/whatsapp/interactions/{id} -v -u {name}:{password}",
35685         "type": "json"
35686       }
35687     ],
35688     "name": "ShowInteractions",
35689     "group": "Whatsapp_Interactions",
35690     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35691     "version": "0.0.0",
35692     "filename": "server/api/whatsappInteraction/index.js",
35693     "groupTitle": "Whatsapp_Interactions"
35694   },
35695   {
35696     "type": "post",
35697     "url": "/api/whatsapp/interactions/{id}/messages",
35698     "title": "Creates new messages",
35699     "examples": [
35700       {
35701         "title": "Example usage:",
35702         "content": "curl https://{domain}/api/whatsapp/interactions/{id}/messages -d '[{\"to\": \"+3901119886500\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
35703         "type": "json"
35704       }
35705     ],
35706     "name": "addMessage",
35707     "group": "Whatsapp_Interactions",
35708     "parameter": {
35709       "fields": {
35710         "Body": [
35711           {
35712             "group": "Body",
35713             "type": "Text",
35714             "optional": false,
35715             "field": "body",
35716             "description": ""
35717           },
35718           {
35719             "group": "Body",
35720             "type": "Boolean",
35721             "optional": true,
35722             "field": "read",
35723             "description": ""
35724           },
35725           {
35726             "group": "Body",
35727             "type": "String",
35728             "allowedValues": [
35729               "\"in\"",
35730               "\"out\""
35731             ],
35732             "optional": false,
35733             "field": "direction",
35734             "description": ""
35735           },
35736           {
35737             "group": "Body",
35738             "type": "String",
35739             "optional": true,
35740             "field": "messageId",
35741             "description": ""
35742           },
35743           {
35744             "group": "Body",
35745             "type": "String",
35746             "optional": true,
35747             "field": "phone",
35748             "description": ""
35749           },
35750           {
35751             "group": "Body",
35752             "type": "String",
35753             "optional": true,
35754             "field": "readAt",
35755             "description": ""
35756           },
35757           {
35758             "group": "Body",
35759             "type": "Boolean",
35760             "optional": true,
35761             "field": "secret",
35762             "description": ""
35763           },
35764           {
35765             "group": "Body",
35766             "type": "String",
35767             "optional": true,
35768             "field": "providerName",
35769             "description": ""
35770           },
35771           {
35772             "group": "Body",
35773             "type": "Text",
35774             "optional": true,
35775             "field": "providerResponse",
35776             "description": ""
35777           }
35778         ]
35779       }
35780     },
35781     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35782     "version": "0.0.0",
35783     "filename": "server/api/whatsappInteraction/index.js",
35784     "groupTitle": "Whatsapp_Interactions"
35785   },
35786   {
35787     "type": "get",
35788     "url": "/api/whatsapp/interactions/{id}/download",
35789     "title": "Gets interaction",
35790     "examples": [
35791       {
35792         "title": "Example usage:",
35793         "content": "curl https://{domain}/api/whatsapp/interactions/{id}/download -v -u {name}:{password} -X GET",
35794         "type": "json"
35795       }
35796     ],
35797     "name": "download",
35798     "group": "Whatsapp_Interactions",
35799     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35800     "version": "0.0.0",
35801     "filename": "server/api/whatsappInteraction/index.js",
35802     "groupTitle": "Whatsapp_Interactions"
35803   },
35804   {
35805     "type": "get",
35806     "url": "/api/whatsapp/interactions/{id}/messages",
35807     "title": "Gets interaction messages",
35808     "examples": [
35809       {
35810         "title": "Example usage:",
35811         "content": "curl https://{domain}/api/whatsapp/interactions/{id}/messages -v -u {name}:{password} -X GET",
35812         "type": "json"
35813       }
35814     ],
35815     "name": "getMessages",
35816     "group": "Whatsapp_Interactions",
35817     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35818     "version": "0.0.0",
35819     "filename": "server/api/whatsappInteraction/index.js",
35820     "groupTitle": "Whatsapp_Interactions"
35821   },
35822   {
35823     "type": "put",
35824     "url": "/api/whatsapp/interactions/{id}",
35825     "title": "Update an existing Interaction",
35826     "examples": [
35827       {
35828         "title": "Example usage:",
35829         "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",
35830         "type": "json"
35831       }
35832     ],
35833     "name": "updateInteractions",
35834     "group": "Whatsapp_Interactions",
35835     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35836     "version": "0.0.0",
35837     "filename": "server/api/whatsappInteraction/index.js",
35838     "groupTitle": "Whatsapp_Interactions"
35839   },
35840   {
35841     "type": "post",
35842     "url": "/api/whatsapp/messages",
35843     "title": "Creates a new Message",
35844     "examples": [
35845       {
35846         "title": "Example usage:",
35847         "content": "curl https://{domain}/api/whatsapp/messages -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
35848         "type": "json"
35849       }
35850     ],
35851     "name": "CreateMessages",
35852     "group": "Whatsapp_Messages",
35853     "parameter": {
35854       "fields": {
35855         "Body": [
35856           {
35857             "group": "Body",
35858             "type": "Text",
35859             "optional": false,
35860             "field": "body",
35861             "description": ""
35862           },
35863           {
35864             "group": "Body",
35865             "type": "Boolean",
35866             "optional": true,
35867             "field": "read",
35868             "description": ""
35869           },
35870           {
35871             "group": "Body",
35872             "type": "String",
35873             "allowedValues": [
35874               "\"in\"",
35875               "\"out\""
35876             ],
35877             "optional": false,
35878             "field": "direction",
35879             "description": ""
35880           },
35881           {
35882             "group": "Body",
35883             "type": "String",
35884             "optional": true,
35885             "field": "messageId",
35886             "description": ""
35887           },
35888           {
35889             "group": "Body",
35890             "type": "String",
35891             "optional": true,
35892             "field": "phone",
35893             "description": ""
35894           },
35895           {
35896             "group": "Body",
35897             "type": "String",
35898             "optional": true,
35899             "field": "readAt",
35900             "description": ""
35901           },
35902           {
35903             "group": "Body",
35904             "type": "Boolean",
35905             "optional": true,
35906             "field": "secret",
35907             "description": ""
35908           },
35909           {
35910             "group": "Body",
35911             "type": "String",
35912             "optional": true,
35913             "field": "providerName",
35914             "description": ""
35915           },
35916           {
35917             "group": "Body",
35918             "type": "Text",
35919             "optional": true,
35920             "field": "providerResponse",
35921             "description": ""
35922           }
35923         ]
35924       }
35925     },
35926     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35927     "version": "0.0.0",
35928     "filename": "server/api/whatsappMessage/index.js",
35929     "groupTitle": "Whatsapp_Messages"
35930   },
35931   {
35932     "type": "delete",
35933     "url": "/api/whatsapp/messages/{id}",
35934     "title": "Deletes a Message",
35935     "examples": [
35936       {
35937         "title": "Example usage:",
35938         "content": "curl https://{domain}/api/whatsapp/messages/{id} -v -u {name}:{password} -X DELETE",
35939         "type": "json"
35940       }
35941     ],
35942     "name": "DeleteMessages",
35943     "group": "Whatsapp_Messages",
35944     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35945     "version": "0.0.0",
35946     "filename": "server/api/whatsappMessage/index.js",
35947     "groupTitle": "Whatsapp_Messages"
35948   },
35949   {
35950     "type": "get",
35951     "url": "/api/whatsapp/messages/describe",
35952     "title": "Gets table info about Messages",
35953     "examples": [
35954       {
35955         "title": "Example usage:",
35956         "content": "curl https://{domain}/api/whatsapp/messages/describe -v -u {name}:{password}",
35957         "type": "json"
35958       }
35959     ],
35960     "name": "DescribeMessages",
35961     "group": "Whatsapp_Messages",
35962     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35963     "version": "0.0.0",
35964     "filename": "server/api/whatsappMessage/index.js",
35965     "groupTitle": "Whatsapp_Messages"
35966   },
35967   {
35968     "type": "get",
35969     "url": "/api/whatsapp/messages",
35970     "title": "Gets a list of Messages",
35971     "examples": [
35972       {
35973         "title": "Example usage:",
35974         "content": "curl https://{domain}/api/whatsapp/messages -v -u {name}:{password}",
35975         "type": "json"
35976       }
35977     ],
35978     "name": "GetMessages",
35979     "group": "Whatsapp_Messages",
35980     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
35981     "version": "0.0.0",
35982     "filename": "server/api/whatsappMessage/index.js",
35983     "groupTitle": "Whatsapp_Messages"
35984   },
35985   {
35986     "type": "get",
35987     "url": "/api/whatsapp/messages/{id}",
35988     "title": "Gets a single Message",
35989     "examples": [
35990       {
35991         "title": "Example usage:",
35992         "content": "curl https://{domain}/api/whatsapp/messages/{id} -v -u {name}:{password}",
35993         "type": "json"
35994       }
35995     ],
35996     "name": "ShowMessages",
35997     "group": "Whatsapp_Messages",
35998     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35999     "version": "0.0.0",
36000     "filename": "server/api/whatsappMessage/index.js",
36001     "groupTitle": "Whatsapp_Messages"
36002   },
36003   {
36004     "type": "put",
36005     "url": "/api/whatsapp/messages/{id}",
36006     "title": "Update an existing Message",
36007     "examples": [
36008       {
36009         "title": "Example usage:",
36010         "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",
36011         "type": "json"
36012       }
36013     ],
36014     "name": "updateMessages",
36015     "group": "Whatsapp_Messages",
36016     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36017     "version": "0.0.0",
36018     "filename": "server/api/whatsappMessage/index.js",
36019     "groupTitle": "Whatsapp_Messages"
36020   },
36021   {
36022     "type": "post",
36023     "url": "/api/whatsapp/reports/queue",
36024     "title": "Creates a new Whatsapp Queue Report",
36025     "examples": [
36026       {
36027         "title": "Example usage:",
36028         "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",
36029         "type": "json"
36030       }
36031     ],
36032     "name": "CreateWhatsapp_Queue_Reports",
36033     "group": "Whatsapp_Queue_Reports",
36034     "parameter": {
36035       "fields": {
36036         "Body": [
36037           {
36038             "group": "Body",
36039             "type": "String",
36040             "optional": false,
36041             "field": "uniqueid",
36042             "description": ""
36043           },
36044           {
36045             "group": "Body",
36046             "type": "String",
36047             "optional": true,
36048             "field": "from",
36049             "description": ""
36050           },
36051           {
36052             "group": "Body",
36053             "type": "String",
36054             "optional": true,
36055             "field": "joinAt",
36056             "description": ""
36057           },
36058           {
36059             "group": "Body",
36060             "type": "String",
36061             "optional": true,
36062             "field": "leaveAt",
36063             "description": ""
36064           },
36065           {
36066             "group": "Body",
36067             "type": "String",
36068             "optional": true,
36069             "field": "acceptAt",
36070             "description": ""
36071           },
36072           {
36073             "group": "Body",
36074             "type": "String",
36075             "optional": true,
36076             "field": "exitAt",
36077             "description": ""
36078           },
36079           {
36080             "group": "Body",
36081             "type": "String",
36082             "optional": true,
36083             "field": "reason",
36084             "description": ""
36085           }
36086         ]
36087       }
36088     },
36089     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36090     "version": "0.0.0",
36091     "filename": "server/api/whatsappQueueReport/index.js",
36092     "groupTitle": "Whatsapp_Queue_Reports"
36093   },
36094   {
36095     "type": "delete",
36096     "url": "/api/whatsapp/reports/queue/{id}",
36097     "title": "Deletes a Whatsapp Queue Report",
36098     "examples": [
36099       {
36100         "title": "Example usage:",
36101         "content": "curl https://{domain}/api/whatsapp/reports/queue/{id} -v -u {name}:{password} -X DELETE",
36102         "type": "json"
36103       }
36104     ],
36105     "name": "DeleteWhatsapp_Queue_Reports",
36106     "group": "Whatsapp_Queue_Reports",
36107     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36108     "version": "0.0.0",
36109     "filename": "server/api/whatsappQueueReport/index.js",
36110     "groupTitle": "Whatsapp_Queue_Reports"
36111   },
36112   {
36113     "type": "get",
36114     "url": "/api/whatsapp/reports/queue/describe",
36115     "title": "Gets table info about Whatsapp Queue Reports",
36116     "examples": [
36117       {
36118         "title": "Example usage:",
36119         "content": "curl https://{domain}/api/whatsapp/reports/queue/describe -v -u {name}:{password}",
36120         "type": "json"
36121       }
36122     ],
36123     "name": "DescribeWhatsapp_Queue_Reports",
36124     "group": "Whatsapp_Queue_Reports",
36125     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36126     "version": "0.0.0",
36127     "filename": "server/api/whatsappQueueReport/index.js",
36128     "groupTitle": "Whatsapp_Queue_Reports"
36129   },
36130   {
36131     "type": "get",
36132     "url": "/api/whatsapp/reports/queue",
36133     "title": "Gets a list of Whatsapp Queue Reports",
36134     "examples": [
36135       {
36136         "title": "Example usage:",
36137         "content": "curl https://{domain}/api/whatsapp/reports/queue -v -u {name}:{password}",
36138         "type": "json"
36139       }
36140     ],
36141     "name": "GetWhatsapp_Queue_Reports",
36142     "group": "Whatsapp_Queue_Reports",
36143     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
36144     "version": "0.0.0",
36145     "filename": "server/api/whatsappQueueReport/index.js",
36146     "groupTitle": "Whatsapp_Queue_Reports"
36147   },
36148   {
36149     "type": "get",
36150     "url": "/api/whatsapp/reports/queue/{id}",
36151     "title": "Gets a single Whatsapp Queue Report",
36152     "examples": [
36153       {
36154         "title": "Example usage:",
36155         "content": "curl https://{domain}/api/whatsapp/reports/queue/{id} -v -u {name}:{password}",
36156         "type": "json"
36157       }
36158     ],
36159     "name": "ShowWhatsapp_Queue_Reports",
36160     "group": "Whatsapp_Queue_Reports",
36161     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36162     "version": "0.0.0",
36163     "filename": "server/api/whatsappQueueReport/index.js",
36164     "groupTitle": "Whatsapp_Queue_Reports"
36165   },
36166   {
36167     "type": "put",
36168     "url": "/api/whatsapp/reports/queue/{id}",
36169     "title": "Update an existing Whatsapp Queue Report",
36170     "examples": [
36171       {
36172         "title": "Example usage:",
36173         "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",
36174         "type": "json"
36175       }
36176     ],
36177     "name": "updateWhatsapp_Queue_Reports",
36178     "group": "Whatsapp_Queue_Reports",
36179     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36180     "version": "0.0.0",
36181     "filename": "server/api/whatsappQueueReport/index.js",
36182     "groupTitle": "Whatsapp_Queue_Reports"
36183   },
36184   {
36185     "type": "post",
36186     "url": "/api/whatsapp/queues/{id}/users",
36187     "title": "Add agents to a queue",
36188     "examples": [
36189       {
36190         "title": "Example usage:",
36191         "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",
36192         "type": "json"
36193       }
36194     ],
36195     "name": "AddAgents",
36196     "group": "Whatsapp_Queues",
36197     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36198     "version": "0.0.0",
36199     "filename": "server/api/whatsappQueue/index.js",
36200     "groupTitle": "Whatsapp_Queues"
36201   },
36202   {
36203     "type": "post",
36204     "url": "/api/whatsapp/queues/{id}/teams",
36205     "title": "Add teams to a queue",
36206     "examples": [
36207       {
36208         "title": "Example usage:",
36209         "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",
36210         "type": "json"
36211       }
36212     ],
36213     "name": "AddTeams",
36214     "group": "Whatsapp_Queues",
36215     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36216     "version": "0.0.0",
36217     "filename": "server/api/whatsappQueue/index.js",
36218     "groupTitle": "Whatsapp_Queues"
36219   },
36220   {
36221     "type": "post",
36222     "url": "/api/whatsapp/queues",
36223     "title": "Creates a new Queue",
36224     "examples": [
36225       {
36226         "title": "Example usage:",
36227         "content": "curl https://{domain}/api/whatsapp/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
36228         "type": "json"
36229       }
36230     ],
36231     "name": "CreateQueues",
36232     "group": "Whatsapp_Queues",
36233     "parameter": {
36234       "fields": {
36235         "Body": [
36236           {
36237             "group": "Body",
36238             "type": "String",
36239             "optional": true,
36240             "field": "name",
36241             "description": ""
36242           },
36243           {
36244             "group": "Body",
36245             "type": "Integer",
36246             "optional": true,
36247             "field": "timeout",
36248             "description": ""
36249           },
36250           {
36251             "group": "Body",
36252             "type": "String",
36253             "allowedValues": [
36254               "\"rrmemory\"",
36255               "\"beepall\"",
36256               "\"roundrobin\""
36257             ],
36258             "optional": true,
36259             "field": "strategy",
36260             "description": ""
36261           },
36262           {
36263             "group": "Body",
36264             "type": "String",
36265             "optional": true,
36266             "field": "description",
36267             "description": ""
36268           }
36269         ]
36270       }
36271     },
36272     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36273     "version": "0.0.0",
36274     "filename": "server/api/whatsappQueue/index.js",
36275     "groupTitle": "Whatsapp_Queues"
36276   },
36277   {
36278     "type": "delete",
36279     "url": "/api/whatsapp/queues/{id}",
36280     "title": "Deletes a Queue",
36281     "examples": [
36282       {
36283         "title": "Example usage:",
36284         "content": "curl https://{domain}/api/whatsapp/queues/{id} -v -u {name}:{password} -X DELETE",
36285         "type": "json"
36286       }
36287     ],
36288     "name": "DeleteQueues",
36289     "group": "Whatsapp_Queues",
36290     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36291     "version": "0.0.0",
36292     "filename": "server/api/whatsappQueue/index.js",
36293     "groupTitle": "Whatsapp_Queues"
36294   },
36295   {
36296     "type": "get",
36297     "url": "/api/whatsapp/queues/describe",
36298     "title": "Gets table info about Queues",
36299     "examples": [
36300       {
36301         "title": "Example usage:",
36302         "content": "curl https://{domain}/api/whatsapp/queues/describe -v -u {name}:{password}",
36303         "type": "json"
36304       }
36305     ],
36306     "name": "DescribeQueues",
36307     "group": "Whatsapp_Queues",
36308     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36309     "version": "0.0.0",
36310     "filename": "server/api/whatsappQueue/index.js",
36311     "groupTitle": "Whatsapp_Queues"
36312   },
36313   {
36314     "type": "get",
36315     "url": "/api/whatsapp/queues/{id}/users",
36316     "title": "Gets queue agents",
36317     "examples": [
36318       {
36319         "title": "Example usage:",
36320         "content": "curl https://{domain}/api/whatsapp/queues/{id}/users -v -u {name}:{password} -X POST",
36321         "type": "json"
36322       }
36323     ],
36324     "name": "GetAgents",
36325     "group": "Whatsapp_Queues",
36326     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36327     "version": "0.0.0",
36328     "filename": "server/api/whatsappQueue/index.js",
36329     "groupTitle": "Whatsapp_Queues"
36330   },
36331   {
36332     "type": "get",
36333     "url": "/api/whatsapp/queues/{id}/members",
36334     "title": "GetMembers",
36335     "examples": [
36336       {
36337         "title": "Example usage:",
36338         "content": "curl https://{domain}/api/whatsapp/queues/{id}/members  -v -u {name}:{password}",
36339         "type": "json"
36340       }
36341     ],
36342     "name": "GetMembers",
36343     "group": "Whatsapp_Queues",
36344     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36345     "version": "0.0.0",
36346     "filename": "server/api/whatsappQueue/index.js",
36347     "groupTitle": "Whatsapp_Queues"
36348   },
36349   {
36350     "type": "get",
36351     "url": "/api/whatsapp/queues",
36352     "title": "Gets a list of Queues",
36353     "examples": [
36354       {
36355         "title": "Example usage:",
36356         "content": "curl https://{domain}/api/whatsapp/queues -v -u {name}:{password}",
36357         "type": "json"
36358       }
36359     ],
36360     "name": "GetQueues",
36361     "group": "Whatsapp_Queues",
36362     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
36363     "version": "0.0.0",
36364     "filename": "server/api/whatsappQueue/index.js",
36365     "groupTitle": "Whatsapp_Queues"
36366   },
36367   {
36368     "type": "get",
36369     "url": "/api/whatsapp/queues/{id}/teams",
36370     "title": "Gets queues list",
36371     "examples": [
36372       {
36373         "title": "Example usage:",
36374         "content": "curl https://{domain}/api/whatsapp/queues/{id}/teams -v -u {name}:{password}",
36375         "type": "json"
36376       }
36377     ],
36378     "name": "GetTeams",
36379     "group": "Whatsapp_Queues",
36380     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36381     "version": "0.0.0",
36382     "filename": "server/api/whatsappQueue/index.js",
36383     "groupTitle": "Whatsapp_Queues"
36384   },
36385   {
36386     "type": "delete",
36387     "url": "/api/whatsapp/queues/{id}/users",
36388     "title": "Removes agents from a queue",
36389     "examples": [
36390       {
36391         "title": "Example usage:",
36392         "content": "curl https://{domain}/api/whatsapp/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
36393         "type": "json"
36394       }
36395     ],
36396     "name": "RemoveAgents",
36397     "group": "Whatsapp_Queues",
36398     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36399     "version": "0.0.0",
36400     "filename": "server/api/whatsappQueue/index.js",
36401     "groupTitle": "Whatsapp_Queues"
36402   },
36403   {
36404     "type": "get",
36405     "url": "/api/whatsapp/queues/{id}",
36406     "title": "Gets a single Queue",
36407     "examples": [
36408       {
36409         "title": "Example usage:",
36410         "content": "curl https://{domain}/api/whatsapp/queues/{id} -v -u {name}:{password}",
36411         "type": "json"
36412       }
36413     ],
36414     "name": "ShowQueues",
36415     "group": "Whatsapp_Queues",
36416     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36417     "version": "0.0.0",
36418     "filename": "server/api/whatsappQueue/index.js",
36419     "groupTitle": "Whatsapp_Queues"
36420   },
36421   {
36422     "type": "put",
36423     "url": "/api/whatsapp/queues/{id}",
36424     "title": "Update an existing Queue",
36425     "examples": [
36426       {
36427         "title": "Example usage:",
36428         "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",
36429         "type": "json"
36430       }
36431     ],
36432     "name": "updateQueues",
36433     "group": "Whatsapp_Queues",
36434     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36435     "version": "0.0.0",
36436     "filename": "server/api/whatsappQueue/index.js",
36437     "groupTitle": "Whatsapp_Queues"
36438   },
36439   {
36440     "type": "post",
36441     "url": "/api/whatsapp/reports/transfer",
36442     "title": "Creates a new Whatsapp Transfer Report",
36443     "examples": [
36444       {
36445         "title": "Example usage:",
36446         "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",
36447         "type": "json"
36448       }
36449     ],
36450     "name": "CreateWhatsapp_Transfer_Reports",
36451     "group": "Whatsapp_Transfer_Reports",
36452     "parameter": {
36453       "fields": {
36454         "Body": [
36455           {
36456             "group": "Body",
36457             "type": "String",
36458             "optional": false,
36459             "field": "uniqueid",
36460             "description": ""
36461           },
36462           {
36463             "group": "Body",
36464             "type": "String",
36465             "allowedValues": [
36466               "\"account\"",
36467               "\"agent\"",
36468               "\"queue\""
36469             ],
36470             "optional": false,
36471             "field": "type",
36472             "description": ""
36473           },
36474           {
36475             "group": "Body",
36476             "type": "String",
36477             "optional": true,
36478             "field": "transferredAt",
36479             "description": ""
36480           }
36481         ]
36482       }
36483     },
36484     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36485     "version": "0.0.0",
36486     "filename": "server/api/whatsappTransferReport/index.js",
36487     "groupTitle": "Whatsapp_Transfer_Reports"
36488   },
36489   {
36490     "type": "delete",
36491     "url": "/api/whatsapp/reports/transfer/{id}",
36492     "title": "Deletes a Whatsapp Transfer Report",
36493     "examples": [
36494       {
36495         "title": "Example usage:",
36496         "content": "curl https://{domain}/api/whatsapp/reports/transfer/{id} -v -u {name}:{password} -X DELETE",
36497         "type": "json"
36498       }
36499     ],
36500     "name": "DeleteWhatsapp_Transfer_Reports",
36501     "group": "Whatsapp_Transfer_Reports",
36502     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36503     "version": "0.0.0",
36504     "filename": "server/api/whatsappTransferReport/index.js",
36505     "groupTitle": "Whatsapp_Transfer_Reports"
36506   },
36507   {
36508     "type": "get",
36509     "url": "/api/whatsapp/reports/transfer/describe",
36510     "title": "Gets table info about Whatsapp Transfer Reports",
36511     "examples": [
36512       {
36513         "title": "Example usage:",
36514         "content": "curl https://{domain}/api/whatsapp/reports/transfer/describe -v -u {name}:{password}",
36515         "type": "json"
36516       }
36517     ],
36518     "name": "DescribeWhatsapp_Transfer_Reports",
36519     "group": "Whatsapp_Transfer_Reports",
36520     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36521     "version": "0.0.0",
36522     "filename": "server/api/whatsappTransferReport/index.js",
36523     "groupTitle": "Whatsapp_Transfer_Reports"
36524   },
36525   {
36526     "type": "get",
36527     "url": "/api/whatsapp/reports/transfer",
36528     "title": "Gets a list of Whatsapp Transfer Reports",
36529     "examples": [
36530       {
36531         "title": "Example usage:",
36532         "content": "curl https://{domain}/api/whatsapp/reports/transfer -v -u {name}:{password}",
36533         "type": "json"
36534       }
36535     ],
36536     "name": "GetWhatsapp_Transfer_Reports",
36537     "group": "Whatsapp_Transfer_Reports",
36538     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
36539     "version": "0.0.0",
36540     "filename": "server/api/whatsappTransferReport/index.js",
36541     "groupTitle": "Whatsapp_Transfer_Reports"
36542   },
36543   {
36544     "type": "get",
36545     "url": "/api/whatsapp/reports/transfer/{id}",
36546     "title": "Gets a single Whatsapp Transfer Report",
36547     "examples": [
36548       {
36549         "title": "Example usage:",
36550         "content": "curl https://{domain}/api/whatsapp/reports/transfer/{id} -v -u {name}:{password}",
36551         "type": "json"
36552       }
36553     ],
36554     "name": "ShowWhatsapp_Transfer_Reports",
36555     "group": "Whatsapp_Transfer_Reports",
36556     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36557     "version": "0.0.0",
36558     "filename": "server/api/whatsappTransferReport/index.js",
36559     "groupTitle": "Whatsapp_Transfer_Reports"
36560   },
36561   {
36562     "type": "put",
36563     "url": "/api/whatsapp/reports/transfer/{id}",
36564     "title": "Update an existing Whatsapp Transfer Report",
36565     "examples": [
36566       {
36567         "title": "Example usage:",
36568         "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",
36569         "type": "json"
36570       }
36571     ],
36572     "name": "updateWhatsapp_Transfer_Reports",
36573     "group": "Whatsapp_Transfer_Reports",
36574     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36575     "version": "0.0.0",
36576     "filename": "server/api/whatsappTransferReport/index.js",
36577     "groupTitle": "Whatsapp_Transfer_Reports"
36578   },
36579   {
36580     "type": "post",
36581     "url": "/api/integrations/zendesk/accounts",
36582     "title": "Creates a new Zendesk Account",
36583     "examples": [
36584       {
36585         "title": "Example usage:",
36586         "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",
36587         "type": "json"
36588       }
36589     ],
36590     "name": "CreateZendesk_Accounts",
36591     "group": "Zendesk_Accounts",
36592     "parameter": {
36593       "fields": {
36594         "Body": [
36595           {
36596             "group": "Body",
36597             "type": "String",
36598             "optional": true,
36599             "field": "name",
36600             "description": ""
36601           },
36602           {
36603             "group": "Body",
36604             "type": "String",
36605             "optional": true,
36606             "field": "description",
36607             "description": ""
36608           },
36609           {
36610             "group": "Body",
36611             "type": "String",
36612             "optional": true,
36613             "field": "username",
36614             "description": ""
36615           },
36616           {
36617             "group": "Body",
36618             "type": "String",
36619             "optional": true,
36620             "field": "password",
36621             "description": ""
36622           },
36623           {
36624             "group": "Body",
36625             "type": "String",
36626             "optional": true,
36627             "field": "token",
36628             "description": ""
36629           },
36630           {
36631             "group": "Body",
36632             "type": "String",
36633             "optional": true,
36634             "field": "remoteUri",
36635             "description": ""
36636           },
36637           {
36638             "group": "Body",
36639             "type": "String",
36640             "allowedValues": [
36641               "\"password\"",
36642               "\"token\""
36643             ],
36644             "optional": true,
36645             "field": "authType",
36646             "description": ""
36647           },
36648           {
36649             "group": "Body",
36650             "type": "String",
36651             "optional": false,
36652             "field": "serverUrl",
36653             "description": ""
36654           },
36655           {
36656             "group": "Body",
36657             "type": "String",
36658             "allowedValues": [
36659               "\"integrationTab\"",
36660               "\"newTab\""
36661             ],
36662             "optional": true,
36663             "field": "type",
36664             "description": ""
36665           }
36666         ]
36667       }
36668     },
36669     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36670     "version": "0.0.0",
36671     "filename": "server/api/intZendeskAccount/index.js",
36672     "groupTitle": "Zendesk_Accounts"
36673   },
36674   {
36675     "type": "delete",
36676     "url": "/api/integrations/zendesk/accounts/{id}",
36677     "title": "Deletes a Zendesk Account",
36678     "examples": [
36679       {
36680         "title": "Example usage:",
36681         "content": "curl https://{domain}/api/integrations/zendesk/accounts/{id} -v -u {name}:{password} -X DELETE",
36682         "type": "json"
36683       }
36684     ],
36685     "name": "DeleteZendesk_Accounts",
36686     "group": "Zendesk_Accounts",
36687     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36688     "version": "0.0.0",
36689     "filename": "server/api/intZendeskAccount/index.js",
36690     "groupTitle": "Zendesk_Accounts"
36691   },
36692   {
36693     "type": "get",
36694     "url": "/api/integrations/zendesk/accounts",
36695     "title": "Gets a list of Zendesk Accounts",
36696     "examples": [
36697       {
36698         "title": "Example usage:",
36699         "content": "curl https://{domain}/api/integrations/zendesk/accounts -v -u {name}:{password}",
36700         "type": "json"
36701       }
36702     ],
36703     "name": "GetZendesk_Accounts",
36704     "group": "Zendesk_Accounts",
36705     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
36706     "version": "0.0.0",
36707     "filename": "server/api/intZendeskAccount/index.js",
36708     "groupTitle": "Zendesk_Accounts"
36709   },
36710   {
36711     "type": "get",
36712     "url": "/api/integrations/zendesk/accounts/{id}",
36713     "title": "Gets a single Zendesk Account",
36714     "examples": [
36715       {
36716         "title": "Example usage:",
36717         "content": "curl https://{domain}/api/integrations/zendesk/accounts/{id} -v -u {name}:{password}",
36718         "type": "json"
36719       }
36720     ],
36721     "name": "ShowZendesk_Accounts",
36722     "group": "Zendesk_Accounts",
36723     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36724     "version": "0.0.0",
36725     "filename": "server/api/intZendeskAccount/index.js",
36726     "groupTitle": "Zendesk_Accounts"
36727   },
36728   {
36729     "type": "post",
36730     "url": "/api/integrations/zendesk/accounts/{id}/configurations",
36731     "title": "Creates new configuration",
36732     "examples": [
36733       {
36734         "title": "Example usage:",
36735         "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",
36736         "type": "json"
36737       }
36738     ],
36739     "name": "addConfiguration",
36740     "group": "Zendesk_Accounts",
36741     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36742     "version": "0.0.0",
36743     "filename": "server/api/intZendeskAccount/index.js",
36744     "groupTitle": "Zendesk_Accounts"
36745   },
36746   {
36747     "type": "get",
36748     "url": "/api/integrations/zendesk/accounts/{id}/configurations",
36749     "title": "Gets account configurations",
36750     "examples": [
36751       {
36752         "title": "Example usage:",
36753         "content": "curl https://{domain}/api/integrations/zendesk/accounts/{id}/configurations -v -u {name}:{password} -X GET",
36754         "type": "json"
36755       }
36756     ],
36757     "name": "getConfigurations",
36758     "group": "Zendesk_Accounts",
36759     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36760     "version": "0.0.0",
36761     "filename": "server/api/intZendeskAccount/index.js",
36762     "groupTitle": "Zendesk_Accounts"
36763   },
36764   {
36765     "type": "get",
36766     "url": "/api/integrations/zendesk/accounts/{id}/fields",
36767     "title": "Gets account fields",
36768     "examples": [
36769       {
36770         "title": "Example usage:",
36771         "content": "curl https://{domain}/api/integrations/zendesk/accounts/{id}/fields -v -u {name}:{password} -X GET",
36772         "type": "json"
36773       }
36774     ],
36775     "name": "getFields",
36776     "group": "Zendesk_Accounts",
36777     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36778     "version": "0.0.0",
36779     "filename": "server/api/intZendeskAccount/index.js",
36780     "groupTitle": "Zendesk_Accounts"
36781   },
36782   {
36783     "type": "put",
36784     "url": "/api/integrations/zendesk/accounts/{id}",
36785     "title": "Update an existing Zendesk Account",
36786     "examples": [
36787       {
36788         "title": "Example usage:",
36789         "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",
36790         "type": "json"
36791       }
36792     ],
36793     "name": "updateZendesk_Accounts",
36794     "group": "Zendesk_Accounts",
36795     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36796     "version": "0.0.0",
36797     "filename": "server/api/intZendeskAccount/index.js",
36798     "groupTitle": "Zendesk_Accounts"
36799   },
36800   {
36801     "type": "post",
36802     "url": "/api/integrations/zendesk/configurations",
36803     "title": "Creates a new Zendesk Configuration",
36804     "examples": [
36805       {
36806         "title": "Example usage:",
36807         "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",
36808         "type": "json"
36809       }
36810     ],
36811     "name": "CreateZendesk_Configurations",
36812     "group": "Zendesk_Configurations",
36813     "parameter": {
36814       "fields": {
36815         "Body": [
36816           {
36817             "group": "Body",
36818             "type": "String",
36819             "optional": true,
36820             "field": "name",
36821             "description": ""
36822           },
36823           {
36824             "group": "Body",
36825             "type": "String",
36826             "optional": true,
36827             "field": "description",
36828             "description": ""
36829           }
36830         ]
36831       }
36832     },
36833     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36834     "version": "0.0.0",
36835     "filename": "server/api/intZendeskConfiguration/index.js",
36836     "groupTitle": "Zendesk_Configurations"
36837   },
36838   {
36839     "type": "delete",
36840     "url": "/api/integrations/zendesk/configurations/{id}",
36841     "title": "Deletes a Zendesk Configuration",
36842     "examples": [
36843       {
36844         "title": "Example usage:",
36845         "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id} -v -u {name}:{password} -X DELETE",
36846         "type": "json"
36847       }
36848     ],
36849     "name": "DeleteZendesk_Configurations",
36850     "group": "Zendesk_Configurations",
36851     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36852     "version": "0.0.0",
36853     "filename": "server/api/intZendeskConfiguration/index.js",
36854     "groupTitle": "Zendesk_Configurations"
36855   },
36856   {
36857     "type": "get",
36858     "url": "/api/integrations/zendesk/configurations",
36859     "title": "Gets a list of Zendesk Configurations",
36860     "examples": [
36861       {
36862         "title": "Example usage:",
36863         "content": "curl https://{domain}/api/integrations/zendesk/configurations -v -u {name}:{password}",
36864         "type": "json"
36865       }
36866     ],
36867     "name": "GetZendesk_Configurations",
36868     "group": "Zendesk_Configurations",
36869     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
36870     "version": "0.0.0",
36871     "filename": "server/api/intZendeskConfiguration/index.js",
36872     "groupTitle": "Zendesk_Configurations"
36873   },
36874   {
36875     "type": "get",
36876     "url": "/api/integrations/zendesk/configurations/{id}",
36877     "title": "Gets a single Zendesk Configuration",
36878     "examples": [
36879       {
36880         "title": "Example usage:",
36881         "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id} -v -u {name}:{password}",
36882         "type": "json"
36883       }
36884     ],
36885     "name": "ShowZendesk_Configurations",
36886     "group": "Zendesk_Configurations",
36887     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36888     "version": "0.0.0",
36889     "filename": "server/api/intZendeskConfiguration/index.js",
36890     "groupTitle": "Zendesk_Configurations"
36891   },
36892   {
36893     "type": "get",
36894     "url": "/api/integrations/zendesk/configurations/{id}/descriptions",
36895     "title": "Gets configurations descriptions",
36896     "examples": [
36897       {
36898         "title": "Example usage:",
36899         "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
36900         "type": "json"
36901       }
36902     ],
36903     "name": "getDescriptions",
36904     "group": "Zendesk_Configurations",
36905     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36906     "version": "0.0.0",
36907     "filename": "server/api/intZendeskConfiguration/index.js",
36908     "groupTitle": "Zendesk_Configurations"
36909   },
36910   {
36911     "type": "get",
36912     "url": "/api/integrations/zendesk/configurations/{id}/fields",
36913     "title": "Gets configurations fields",
36914     "examples": [
36915       {
36916         "title": "Example usage:",
36917         "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id}/fields -v -u {name}:{password} -X GET",
36918         "type": "json"
36919       }
36920     ],
36921     "name": "getFields",
36922     "group": "Zendesk_Configurations",
36923     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36924     "version": "0.0.0",
36925     "filename": "server/api/intZendeskConfiguration/index.js",
36926     "groupTitle": "Zendesk_Configurations"
36927   },
36928   {
36929     "type": "get",
36930     "url": "/api/integrations/zendesk/configurations/{id}/subjects",
36931     "title": "Gets configurations subjects",
36932     "examples": [
36933       {
36934         "title": "Example usage:",
36935         "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id}/subjects -v -u {name}:{password} -X GET",
36936         "type": "json"
36937       }
36938     ],
36939     "name": "getSubjects",
36940     "group": "Zendesk_Configurations",
36941     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36942     "version": "0.0.0",
36943     "filename": "server/api/intZendeskConfiguration/index.js",
36944     "groupTitle": "Zendesk_Configurations"
36945   },
36946   {
36947     "type": "get",
36948     "url": "/api/integrations/zendesk/configurations/{id}/tags",
36949     "title": "Gets configurations tags",
36950     "examples": [
36951       {
36952         "title": "Example usage:",
36953         "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id}/tags -v -u {name}:{password} -X GET",
36954         "type": "json"
36955       }
36956     ],
36957     "name": "getTags",
36958     "group": "Zendesk_Configurations",
36959     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36960     "version": "0.0.0",
36961     "filename": "server/api/intZendeskConfiguration/index.js",
36962     "groupTitle": "Zendesk_Configurations"
36963   },
36964   {
36965     "type": "post",
36966     "url": "/api/integrations/zendesk/configurations/{id}/tags",
36967     "title": "Sets new tags",
36968     "examples": [
36969       {
36970         "title": "Example usage:",
36971         "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",
36972         "type": "json"
36973       }
36974     ],
36975     "name": "setTags",
36976     "group": "Zendesk_Configurations",
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/intZendeskConfiguration/index.js",
36980     "groupTitle": "Zendesk_Configurations"
36981   },
36982   {
36983     "type": "put",
36984     "url": "/api/integrations/zendesk/configurations/{id}",
36985     "title": "Update an existing Zendesk Configuration",
36986     "examples": [
36987       {
36988         "title": "Example usage:",
36989         "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",
36990         "type": "json"
36991       }
36992     ],
36993     "name": "updateZendesk_Configurations",
36994     "group": "Zendesk_Configurations",
36995     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <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/intZendeskConfiguration/index.js",
36998     "groupTitle": "Zendesk_Configurations"
36999   },
37000   {
37001     "type": "post",
37002     "url": "/api/integrations/zendesk/fields",
37003     "title": "Creates a new Zendesk Field",
37004     "examples": [
37005       {
37006         "title": "Example usage:",
37007         "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",
37008         "type": "json"
37009       }
37010     ],
37011     "name": "CreateZendesk_Fields",
37012     "group": "Zendesk_Fields",
37013     "parameter": {
37014       "fields": {
37015         "Body": [
37016           {
37017             "group": "Body",
37018             "type": "String",
37019             "allowedValues": [
37020               "\"string\"",
37021               "\"variable\"",
37022               "\"customVariable\"",
37023               "\"keyValue\"",
37024               "\"picklist\""
37025             ],
37026             "optional": true,
37027             "field": "type",
37028             "description": ""
37029           },
37030           {
37031             "group": "Body",
37032             "type": "String",
37033             "optional": true,
37034             "field": "content",
37035             "description": ""
37036           },
37037           {
37038             "group": "Body",
37039             "type": "String",
37040             "optional": true,
37041             "field": "key",
37042             "description": ""
37043           },
37044           {
37045             "group": "Body",
37046             "type": "String",
37047             "allowedValues": [
37048               "\"string\"",
37049               "\"variable\"",
37050               "\"customVariable\""
37051             ],
37052             "optional": true,
37053             "field": "keyType",
37054             "description": ""
37055           },
37056           {
37057             "group": "Body",
37058             "type": "String",
37059             "optional": true,
37060             "field": "keyContent",
37061             "description": ""
37062           },
37063           {
37064             "group": "Body",
37065             "type": "String",
37066             "optional": true,
37067             "field": "idField",
37068             "description": ""
37069           },
37070           {
37071             "group": "Body",
37072             "type": "String",
37073             "optional": true,
37074             "field": "nameField",
37075             "description": ""
37076           },
37077           {
37078             "group": "Body",
37079             "type": "Boolean",
37080             "optional": true,
37081             "field": "customField",
37082             "description": ""
37083           },
37084           {
37085             "group": "Body",
37086             "type": "String",
37087             "optional": true,
37088             "field": "variableName",
37089             "description": ""
37090           }
37091         ]
37092       }
37093     },
37094     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37095     "version": "0.0.0",
37096     "filename": "server/api/intZendeskField/index.js",
37097     "groupTitle": "Zendesk_Fields"
37098   },
37099   {
37100     "type": "delete",
37101     "url": "/api/integrations/zendesk/fields/{id}",
37102     "title": "Deletes a Zendesk Field",
37103     "examples": [
37104       {
37105         "title": "Example usage:",
37106         "content": "curl https://{domain}/api/integrations/zendesk/fields/{id} -v -u {name}:{password} -X DELETE",
37107         "type": "json"
37108       }
37109     ],
37110     "name": "DeleteZendesk_Fields",
37111     "group": "Zendesk_Fields",
37112     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37113     "version": "0.0.0",
37114     "filename": "server/api/intZendeskField/index.js",
37115     "groupTitle": "Zendesk_Fields"
37116   },
37117   {
37118     "type": "get",
37119     "url": "/api/integrations/zendesk/fields",
37120     "title": "Gets a list of Zendesk Fields",
37121     "examples": [
37122       {
37123         "title": "Example usage:",
37124         "content": "curl https://{domain}/api/integrations/zendesk/fields -v -u {name}:{password}",
37125         "type": "json"
37126       }
37127     ],
37128     "name": "GetZendesk_Fields",
37129     "group": "Zendesk_Fields",
37130     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
37131     "version": "0.0.0",
37132     "filename": "server/api/intZendeskField/index.js",
37133     "groupTitle": "Zendesk_Fields"
37134   },
37135   {
37136     "type": "get",
37137     "url": "/api/integrations/zendesk/fields/{id}",
37138     "title": "Gets a single Zendesk Field",
37139     "examples": [
37140       {
37141         "title": "Example usage:",
37142         "content": "curl https://{domain}/api/integrations/zendesk/fields/{id} -v -u {name}:{password}",
37143         "type": "json"
37144       }
37145     ],
37146     "name": "ShowZendesk_Fields",
37147     "group": "Zendesk_Fields",
37148     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37149     "version": "0.0.0",
37150     "filename": "server/api/intZendeskField/index.js",
37151     "groupTitle": "Zendesk_Fields"
37152   },
37153   {
37154     "type": "put",
37155     "url": "/api/integrations/zendesk/fields/{id}",
37156     "title": "Update an existing Zendesk Field",
37157     "examples": [
37158       {
37159         "title": "Example usage:",
37160         "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",
37161         "type": "json"
37162       }
37163     ],
37164     "name": "updateZendesk_Fields",
37165     "group": "Zendesk_Fields",
37166     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37167     "version": "0.0.0",
37168     "filename": "server/api/intZendeskField/index.js",
37169     "groupTitle": "Zendesk_Fields"
37170   },
37171   {
37172     "type": "post",
37173     "url": "/api/integrations/zoho/accounts",
37174     "title": "Creates a new Zoho Account",
37175     "examples": [
37176       {
37177         "title": "Example usage:",
37178         "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",
37179         "type": "json"
37180       }
37181     ],
37182     "name": "CreateZoho_Accounts",
37183     "group": "Zoho_Accounts",
37184     "parameter": {
37185       "fields": {
37186         "Body": [
37187           {
37188             "group": "Body",
37189             "type": "String",
37190             "optional": true,
37191             "field": "name",
37192             "description": ""
37193           },
37194           {
37195             "group": "Body",
37196             "type": "String",
37197             "optional": true,
37198             "field": "description",
37199             "description": ""
37200           },
37201           {
37202             "group": "Body",
37203             "type": "String",
37204             "optional": true,
37205             "field": "host",
37206             "description": ""
37207           },
37208           {
37209             "group": "Body",
37210             "type": "String",
37211             "optional": true,
37212             "field": "zone",
37213             "description": ""
37214           },
37215           {
37216             "group": "Body",
37217             "type": "String",
37218             "optional": true,
37219             "field": "clientId",
37220             "description": ""
37221           },
37222           {
37223             "group": "Body",
37224             "type": "String",
37225             "optional": true,
37226             "field": "clientSecret",
37227             "description": ""
37228           },
37229           {
37230             "group": "Body",
37231             "type": "String",
37232             "optional": false,
37233             "field": "serverUrl",
37234             "description": ""
37235           },
37236           {
37237             "group": "Body",
37238             "type": "String",
37239             "optional": true,
37240             "field": "code",
37241             "description": ""
37242           },
37243           {
37244             "group": "Body",
37245             "type": "String",
37246             "optional": true,
37247             "field": "refreshToken",
37248             "description": ""
37249           }
37250         ]
37251       }
37252     },
37253     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37254     "version": "0.0.0",
37255     "filename": "server/api/intZohoAccount/index.js",
37256     "groupTitle": "Zoho_Accounts"
37257   },
37258   {
37259     "type": "delete",
37260     "url": "/api/integrations/zoho/accounts/{id}",
37261     "title": "Deletes a Zoho Account",
37262     "examples": [
37263       {
37264         "title": "Example usage:",
37265         "content": "curl https://{domain}/api/integrations/zoho/accounts/{id} -v -u {name}:{password} -X DELETE",
37266         "type": "json"
37267       }
37268     ],
37269     "name": "DeleteZoho_Accounts",
37270     "group": "Zoho_Accounts",
37271     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37272     "version": "0.0.0",
37273     "filename": "server/api/intZohoAccount/index.js",
37274     "groupTitle": "Zoho_Accounts"
37275   },
37276   {
37277     "type": "get",
37278     "url": "/api/integrations/zoho/accounts",
37279     "title": "Gets a list of Zoho Accounts",
37280     "examples": [
37281       {
37282         "title": "Example usage:",
37283         "content": "curl https://{domain}/api/integrations/zoho/accounts -v -u {name}:{password}",
37284         "type": "json"
37285       }
37286     ],
37287     "name": "GetZoho_Accounts",
37288     "group": "Zoho_Accounts",
37289     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
37290     "version": "0.0.0",
37291     "filename": "server/api/intZohoAccount/index.js",
37292     "groupTitle": "Zoho_Accounts"
37293   },
37294   {
37295     "type": "get",
37296     "url": "/api/integrations/zoho/accounts/{id}",
37297     "title": "Gets a single Zoho Account",
37298     "examples": [
37299       {
37300         "title": "Example usage:",
37301         "content": "curl https://{domain}/api/integrations/zoho/accounts/{id} -v -u {name}:{password}",
37302         "type": "json"
37303       }
37304     ],
37305     "name": "ShowZoho_Accounts",
37306     "group": "Zoho_Accounts",
37307     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37308     "version": "0.0.0",
37309     "filename": "server/api/intZohoAccount/index.js",
37310     "groupTitle": "Zoho_Accounts"
37311   },
37312   {
37313     "type": "post",
37314     "url": "/api/integrations/zoho/accounts/{id}/configurations",
37315     "title": "Creates new configuration",
37316     "examples": [
37317       {
37318         "title": "Example usage:",
37319         "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",
37320         "type": "json"
37321       }
37322     ],
37323     "name": "addConfiguration",
37324     "group": "Zoho_Accounts",
37325     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37326     "version": "0.0.0",
37327     "filename": "server/api/intZohoAccount/index.js",
37328     "groupTitle": "Zoho_Accounts"
37329   },
37330   {
37331     "type": "get",
37332     "url": "/api/integrations/zoho/accounts/{id}/configurations",
37333     "title": "Gets account configurations",
37334     "examples": [
37335       {
37336         "title": "Example usage:",
37337         "content": "curl https://{domain}/api/integrations/zoho/accounts/{id}/configurations -v -u {name}:{password} -X GET",
37338         "type": "json"
37339       }
37340     ],
37341     "name": "getConfigurations",
37342     "group": "Zoho_Accounts",
37343     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37344     "version": "0.0.0",
37345     "filename": "server/api/intZohoAccount/index.js",
37346     "groupTitle": "Zoho_Accounts"
37347   },
37348   {
37349     "type": "get",
37350     "url": "/api/integrations/zoho/accounts/{id}/fields",
37351     "title": "Gets account fields",
37352     "examples": [
37353       {
37354         "title": "Example usage:",
37355         "content": "curl https://{domain}/api/integrations/zoho/accounts/{id}/fields -v -u {name}:{password} -X GET",
37356         "type": "json"
37357       }
37358     ],
37359     "name": "getFields",
37360     "group": "Zoho_Accounts",
37361     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37362     "version": "0.0.0",
37363     "filename": "server/api/intZohoAccount/index.js",
37364     "groupTitle": "Zoho_Accounts"
37365   },
37366   {
37367     "type": "put",
37368     "url": "/api/integrations/zoho/accounts/{id}",
37369     "title": "Update an existing Zoho Account",
37370     "examples": [
37371       {
37372         "title": "Example usage:",
37373         "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",
37374         "type": "json"
37375       }
37376     ],
37377     "name": "updateZoho_Accounts",
37378     "group": "Zoho_Accounts",
37379     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37380     "version": "0.0.0",
37381     "filename": "server/api/intZohoAccount/index.js",
37382     "groupTitle": "Zoho_Accounts"
37383   },
37384   {
37385     "type": "post",
37386     "url": "/api/integrations/zoho/configurations",
37387     "title": "Creates a new Zoho Configuration",
37388     "examples": [
37389       {
37390         "title": "Example usage:",
37391         "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",
37392         "type": "json"
37393       }
37394     ],
37395     "name": "CreateZoho_Configurations",
37396     "group": "Zoho_Configurations",
37397     "parameter": {
37398       "fields": {
37399         "Body": [
37400           {
37401             "group": "Body",
37402             "type": "String",
37403             "optional": true,
37404             "field": "name",
37405             "description": ""
37406           },
37407           {
37408             "group": "Body",
37409             "type": "String",
37410             "allowedValues": [
37411               "\"lead\"",
37412               "\"contact\"",
37413               "\"nothing\""
37414             ],
37415             "optional": true,
37416             "field": "moduleCreate",
37417             "description": ""
37418           },
37419           {
37420             "group": "Body",
37421             "type": "String",
37422             "allowedValues": [
37423               "\"contact_lead\"",
37424               "\"contact\"",
37425               "\"lead\""
37426             ],
37427             "optional": true,
37428             "field": "moduleSearch",
37429             "description": ""
37430           },
37431           {
37432             "group": "Body",
37433             "type": "String",
37434             "optional": true,
37435             "field": "description",
37436             "description": ""
37437           }
37438         ]
37439       }
37440     },
37441     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37442     "version": "0.0.0",
37443     "filename": "server/api/intZohoConfiguration/index.js",
37444     "groupTitle": "Zoho_Configurations"
37445   },
37446   {
37447     "type": "delete",
37448     "url": "/api/integrations/zoho/configurations/{id}",
37449     "title": "Deletes a Zoho Configuration",
37450     "examples": [
37451       {
37452         "title": "Example usage:",
37453         "content": "curl https://{domain}/api/integrations/zoho/configurations/{id} -v -u {name}:{password} -X DELETE",
37454         "type": "json"
37455       }
37456     ],
37457     "name": "DeleteZoho_Configurations",
37458     "group": "Zoho_Configurations",
37459     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37460     "version": "0.0.0",
37461     "filename": "server/api/intZohoConfiguration/index.js",
37462     "groupTitle": "Zoho_Configurations"
37463   },
37464   {
37465     "type": "get",
37466     "url": "/api/integrations/zoho/configurations",
37467     "title": "Gets a list of Zoho Configurations",
37468     "examples": [
37469       {
37470         "title": "Example usage:",
37471         "content": "curl https://{domain}/api/integrations/zoho/configurations -v -u {name}:{password}",
37472         "type": "json"
37473       }
37474     ],
37475     "name": "GetZoho_Configurations",
37476     "group": "Zoho_Configurations",
37477     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
37478     "version": "0.0.0",
37479     "filename": "server/api/intZohoConfiguration/index.js",
37480     "groupTitle": "Zoho_Configurations"
37481   },
37482   {
37483     "type": "get",
37484     "url": "/api/integrations/zoho/configurations/{id}",
37485     "title": "Gets a single Zoho Configuration",
37486     "examples": [
37487       {
37488         "title": "Example usage:",
37489         "content": "curl https://{domain}/api/integrations/zoho/configurations/{id} -v -u {name}:{password}",
37490         "type": "json"
37491       }
37492     ],
37493     "name": "ShowZoho_Configurations",
37494     "group": "Zoho_Configurations",
37495     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37496     "version": "0.0.0",
37497     "filename": "server/api/intZohoConfiguration/index.js",
37498     "groupTitle": "Zoho_Configurations"
37499   },
37500   {
37501     "type": "get",
37502     "url": "/api/integrations/zoho/configurations/{id}/descriptions",
37503     "title": "Gets configurations descriptions",
37504     "examples": [
37505       {
37506         "title": "Example usage:",
37507         "content": "curl https://{domain}/api/integrations/zoho/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
37508         "type": "json"
37509       }
37510     ],
37511     "name": "getDescriptions",
37512     "group": "Zoho_Configurations",
37513     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37514     "version": "0.0.0",
37515     "filename": "server/api/intZohoConfiguration/index.js",
37516     "groupTitle": "Zoho_Configurations"
37517   },
37518   {
37519     "type": "get",
37520     "url": "/api/integrations/zoho/configurations/{id}/fields",
37521     "title": "Gets configurations fields",
37522     "examples": [
37523       {
37524         "title": "Example usage:",
37525         "content": "curl https://{domain}/api/integrations/zoho/configurations/{id}/fields -v -u {name}:{password} -X GET",
37526         "type": "json"
37527       }
37528     ],
37529     "name": "getFields",
37530     "group": "Zoho_Configurations",
37531     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37532     "version": "0.0.0",
37533     "filename": "server/api/intZohoConfiguration/index.js",
37534     "groupTitle": "Zoho_Configurations"
37535   },
37536   {
37537     "type": "get",
37538     "url": "/api/integrations/zoho/configurations/{id}/subjects",
37539     "title": "Gets configurations subjects",
37540     "examples": [
37541       {
37542         "title": "Example usage:",
37543         "content": "curl https://{domain}/api/integrations/zoho/configurations/{id}/subjects -v -u {name}:{password} -X GET",
37544         "type": "json"
37545       }
37546     ],
37547     "name": "getSubjects",
37548     "group": "Zoho_Configurations",
37549     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37550     "version": "0.0.0",
37551     "filename": "server/api/intZohoConfiguration/index.js",
37552     "groupTitle": "Zoho_Configurations"
37553   },
37554   {
37555     "type": "put",
37556     "url": "/api/integrations/zoho/configurations/{id}",
37557     "title": "Update an existing Zoho Configuration",
37558     "examples": [
37559       {
37560         "title": "Example usage:",
37561         "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",
37562         "type": "json"
37563       }
37564     ],
37565     "name": "updateZoho_Configurations",
37566     "group": "Zoho_Configurations",
37567     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37568     "version": "0.0.0",
37569     "filename": "server/api/intZohoConfiguration/index.js",
37570     "groupTitle": "Zoho_Configurations"
37571   },
37572   {
37573     "type": "post",
37574     "url": "/api/integrations/zoho/fields",
37575     "title": "Creates a new Zoho Field",
37576     "examples": [
37577       {
37578         "title": "Example usage:",
37579         "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",
37580         "type": "json"
37581       }
37582     ],
37583     "name": "CreateZoho_Fields",
37584     "group": "Zoho_Fields",
37585     "parameter": {
37586       "fields": {
37587         "Body": [
37588           {
37589             "group": "Body",
37590             "type": "String",
37591             "allowedValues": [
37592               "\"string\"",
37593               "\"variable\"",
37594               "\"customVariable\"",
37595               "\"keyValue\"",
37596               "\"picklist\""
37597             ],
37598             "optional": true,
37599             "field": "type",
37600             "description": ""
37601           },
37602           {
37603             "group": "Body",
37604             "type": "String",
37605             "optional": true,
37606             "field": "content",
37607             "description": ""
37608           },
37609           {
37610             "group": "Body",
37611             "type": "String",
37612             "optional": true,
37613             "field": "key",
37614             "description": ""
37615           },
37616           {
37617             "group": "Body",
37618             "type": "String",
37619             "allowedValues": [
37620               "\"string\"",
37621               "\"variable\"",
37622               "\"customVariable\""
37623             ],
37624             "optional": true,
37625             "field": "keyType",
37626             "description": ""
37627           },
37628           {
37629             "group": "Body",
37630             "type": "String",
37631             "optional": true,
37632             "field": "keyContent",
37633             "description": ""
37634           },
37635           {
37636             "group": "Body",
37637             "type": "String",
37638             "optional": true,
37639             "field": "idField",
37640             "description": ""
37641           },
37642           {
37643             "group": "Body",
37644             "type": "String",
37645             "optional": true,
37646             "field": "nameField",
37647             "description": ""
37648           },
37649           {
37650             "group": "Body",
37651             "type": "Boolean",
37652             "optional": true,
37653             "field": "customField",
37654             "description": ""
37655           },
37656           {
37657             "group": "Body",
37658             "type": "String",
37659             "optional": true,
37660             "field": "variableName",
37661             "description": ""
37662           }
37663         ]
37664       }
37665     },
37666     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37667     "version": "0.0.0",
37668     "filename": "server/api/intZohoField/index.js",
37669     "groupTitle": "Zoho_Fields"
37670   },
37671   {
37672     "type": "delete",
37673     "url": "/api/integrations/zoho/fields/{id}",
37674     "title": "Deletes a Zoho Field",
37675     "examples": [
37676       {
37677         "title": "Example usage:",
37678         "content": "curl https://{domain}/api/integrations/zoho/fields/{id} -v -u {name}:{password} -X DELETE",
37679         "type": "json"
37680       }
37681     ],
37682     "name": "DeleteZoho_Fields",
37683     "group": "Zoho_Fields",
37684     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37685     "version": "0.0.0",
37686     "filename": "server/api/intZohoField/index.js",
37687     "groupTitle": "Zoho_Fields"
37688   },
37689   {
37690     "type": "get",
37691     "url": "/api/integrations/zoho/fields",
37692     "title": "Gets a list of Zoho Fields",
37693     "examples": [
37694       {
37695         "title": "Example usage:",
37696         "content": "curl https://{domain}/api/integrations/zoho/fields -v -u {name}:{password}",
37697         "type": "json"
37698       }
37699     ],
37700     "name": "GetZoho_Fields",
37701     "group": "Zoho_Fields",
37702     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
37703     "version": "0.0.0",
37704     "filename": "server/api/intZohoField/index.js",
37705     "groupTitle": "Zoho_Fields"
37706   },
37707   {
37708     "type": "get",
37709     "url": "/api/integrations/zoho/fields/{id}",
37710     "title": "Gets a single Zoho Field",
37711     "examples": [
37712       {
37713         "title": "Example usage:",
37714         "content": "curl https://{domain}/api/integrations/zoho/fields/{id} -v -u {name}:{password}",
37715         "type": "json"
37716       }
37717     ],
37718     "name": "ShowZoho_Fields",
37719     "group": "Zoho_Fields",
37720     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37721     "version": "0.0.0",
37722     "filename": "server/api/intZohoField/index.js",
37723     "groupTitle": "Zoho_Fields"
37724   },
37725   {
37726     "type": "put",
37727     "url": "/api/integrations/zoho/fields/{id}",
37728     "title": "Update an existing Zoho Field",
37729     "examples": [
37730       {
37731         "title": "Example usage:",
37732         "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",
37733         "type": "json"
37734       }
37735     ],
37736     "name": "updateZoho_Fields",
37737     "group": "Zoho_Fields",
37738     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37739     "version": "0.0.0",
37740     "filename": "server/api/intZohoField/index.js",
37741     "groupTitle": "Zoho_Fields"
37742   },
37743   {
37744     "type": "post",
37745     "url": "/api/cdr",
37746     "title": "Creates a new Cdr",
37747     "examples": [
37748       {
37749         "title": "Example usage:",
37750         "content": "curl https://{domain}/api/cdr -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
37751         "type": "json"
37752       }
37753     ],
37754     "name": "CreateCdrs",
37755     "group": "cdr",
37756     "parameter": {
37757       "fields": {
37758         "Body": [
37759           {
37760             "group": "Body",
37761             "type": "String",
37762             "optional": false,
37763             "field": "calldate",
37764             "description": ""
37765           },
37766           {
37767             "group": "Body",
37768             "type": "String",
37769             "optional": true,
37770             "field": "clid",
37771             "description": ""
37772           },
37773           {
37774             "group": "Body",
37775             "type": "String",
37776             "optional": true,
37777             "field": "src",
37778             "description": ""
37779           },
37780           {
37781             "group": "Body",
37782             "type": "String",
37783             "optional": true,
37784             "field": "dst",
37785             "description": ""
37786           },
37787           {
37788             "group": "Body",
37789             "type": "String",
37790             "optional": true,
37791             "field": "dcontext",
37792             "description": ""
37793           },
37794           {
37795             "group": "Body",
37796             "type": "String",
37797             "optional": true,
37798             "field": "channel",
37799             "description": ""
37800           },
37801           {
37802             "group": "Body",
37803             "type": "String",
37804             "optional": true,
37805             "field": "dstchannel",
37806             "description": ""
37807           },
37808           {
37809             "group": "Body",
37810             "type": "String",
37811             "optional": true,
37812             "field": "lastapp",
37813             "description": ""
37814           },
37815           {
37816             "group": "Body",
37817             "type": "String",
37818             "optional": true,
37819             "field": "lastdata",
37820             "description": ""
37821           },
37822           {
37823             "group": "Body",
37824             "type": "Integer",
37825             "optional": false,
37826             "field": "duration",
37827             "description": ""
37828           },
37829           {
37830             "group": "Body",
37831             "type": "Integer",
37832             "optional": false,
37833             "field": "billsec",
37834             "description": ""
37835           },
37836           {
37837             "group": "Body",
37838             "type": "String",
37839             "optional": true,
37840             "field": "disposition",
37841             "description": ""
37842           },
37843           {
37844             "group": "Body",
37845             "type": "Integer",
37846             "optional": false,
37847             "field": "amaflags",
37848             "description": ""
37849           },
37850           {
37851             "group": "Body",
37852             "type": "String",
37853             "optional": true,
37854             "field": "accountcode",
37855             "description": ""
37856           },
37857           {
37858             "group": "Body",
37859             "type": "String",
37860             "optional": true,
37861             "field": "userfield",
37862             "description": ""
37863           },
37864           {
37865             "group": "Body",
37866             "type": "String",
37867             "optional": true,
37868             "field": "uniqueid",
37869             "description": ""
37870           },
37871           {
37872             "group": "Body",
37873             "type": "String",
37874             "optional": true,
37875             "field": "linkedid",
37876             "description": ""
37877           },
37878           {
37879             "group": "Body",
37880             "type": "String",
37881             "optional": true,
37882             "field": "sequence",
37883             "description": ""
37884           },
37885           {
37886             "group": "Body",
37887             "type": "String",
37888             "optional": true,
37889             "field": "peeraccount",
37890             "description": ""
37891           },
37892           {
37893             "group": "Body",
37894             "type": "String",
37895             "optional": true,
37896             "field": "type",
37897             "description": ""
37898           },
37899           {
37900             "group": "Body",
37901             "type": "String",
37902             "optional": true,
37903             "field": "tag",
37904             "description": ""
37905           }
37906         ]
37907       }
37908     },
37909     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37910     "version": "0.0.0",
37911     "filename": "server/api/cdr/index.js",
37912     "groupTitle": "cdr"
37913   },
37914   {
37915     "type": "delete",
37916     "url": "/api/cdr/{id}",
37917     "title": "Deletes a Cdr",
37918     "examples": [
37919       {
37920         "title": "Example usage:",
37921         "content": "curl https://{domain}/api/cdr/{id} -v -u {name}:{password} -X DELETE",
37922         "type": "json"
37923       }
37924     ],
37925     "name": "DeleteCdrs",
37926     "group": "cdr",
37927     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37928     "version": "0.0.0",
37929     "filename": "server/api/cdr/index.js",
37930     "groupTitle": "cdr"
37931   },
37932   {
37933     "type": "get",
37934     "url": "/api/cdr/describe",
37935     "title": "Gets table info about Cdrs",
37936     "examples": [
37937       {
37938         "title": "Example usage:",
37939         "content": "curl https://{domain}/api/cdr/describe -v -u {name}:{password}",
37940         "type": "json"
37941       }
37942     ],
37943     "name": "DescribeCdrs",
37944     "group": "cdr",
37945     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37946     "version": "0.0.0",
37947     "filename": "server/api/cdr/index.js",
37948     "groupTitle": "cdr"
37949   },
37950   {
37951     "type": "get",
37952     "url": "/api/cdr",
37953     "title": "Gets a list of Cdrs",
37954     "examples": [
37955       {
37956         "title": "Example usage:",
37957         "content": "curl https://{domain}/api/cdr -v -u {name}:{password}",
37958         "type": "json"
37959       }
37960     ],
37961     "name": "GetCdrs",
37962     "group": "cdr",
37963     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
37964     "version": "0.0.0",
37965     "filename": "server/api/cdr/index.js",
37966     "groupTitle": "cdr"
37967   },
37968   {
37969     "type": "get",
37970     "url": "/api/cdr/{id}",
37971     "title": "Gets a single Cdr",
37972     "examples": [
37973       {
37974         "title": "Example usage:",
37975         "content": "curl https://{domain}/api/cdr/{id} -v -u {name}:{password}",
37976         "type": "json"
37977       }
37978     ],
37979     "name": "ShowCdrs",
37980     "group": "cdr",
37981     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37982     "version": "0.0.0",
37983     "filename": "server/api/cdr/index.js",
37984     "groupTitle": "cdr"
37985   },
37986   {
37987     "type": "put",
37988     "url": "/api/cdr/{id}",
37989     "title": "Update an existing Cdr",
37990     "examples": [
37991       {
37992         "title": "Example usage:",
37993         "content": "curl https://{domain}/api/cdr/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
37994         "type": "json"
37995       }
37996     ],
37997     "name": "updateCdrs",
37998     "group": "cdr",
37999     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
38000     "version": "0.0.0",
38001     "filename": "server/api/cdr/index.js",
38002     "groupTitle": "cdr"
38003   },
38004   {
38005     "type": "post",
38006     "url": "/api/voiceQueuesLog",
38007     "title": "Creates a new VoiceQueuesLog",
38008     "examples": [
38009       {
38010         "title": "Example usage:",
38011         "content": "curl https://{domain}/api/voiceQueuesLog -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
38012         "type": "json"
38013       }
38014     ],
38015     "name": "CreateVoiceQueuesLogs",
38016     "group": "voiceQueuesLog",
38017     "parameter": {
38018       "fields": {
38019         "Body": [
38020           {
38021             "group": "Body",
38022             "type": "String",
38023             "optional": true,
38024             "field": "time",
38025             "description": ""
38026           },
38027           {
38028             "group": "Body",
38029             "type": "String",
38030             "optional": false,
38031             "field": "callid",
38032             "description": ""
38033           },
38034           {
38035             "group": "Body",
38036             "type": "String",
38037             "optional": false,
38038             "field": "queuename",
38039             "description": ""
38040           },
38041           {
38042             "group": "Body",
38043             "type": "String",
38044             "optional": false,
38045             "field": "agent",
38046             "description": ""
38047           },
38048           {
38049             "group": "Body",
38050             "type": "String",
38051             "optional": false,
38052             "field": "event",
38053             "description": ""
38054           },
38055           {
38056             "group": "Body",
38057             "type": "String",
38058             "optional": false,
38059             "field": "data",
38060             "description": ""
38061           },
38062           {
38063             "group": "Body",
38064             "type": "String",
38065             "optional": false,
38066             "field": "data1",
38067             "description": ""
38068           },
38069           {
38070             "group": "Body",
38071             "type": "String",
38072             "optional": false,
38073             "field": "data2",
38074             "description": ""
38075           },
38076           {
38077             "group": "Body",
38078             "type": "String",
38079             "optional": false,
38080             "field": "data3",
38081             "description": ""
38082           },
38083           {
38084             "group": "Body",
38085             "type": "String",
38086             "optional": false,
38087             "field": "data4",
38088             "description": ""
38089           },
38090           {
38091             "group": "Body",
38092             "type": "String",
38093             "optional": false,
38094             "field": "data5",
38095             "description": ""
38096           },
38097           {
38098             "group": "Body",
38099             "type": "String",
38100             "optional": false,
38101             "field": "dtm",
38102             "description": ""
38103           }
38104         ]
38105       }
38106     },
38107     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
38108     "version": "0.0.0",
38109     "filename": "server/api/voiceQueuesLog/index.js",
38110     "groupTitle": "voiceQueuesLog"
38111   },
38112   {
38113     "type": "delete",
38114     "url": "/api/voiceQueuesLog/{id}",
38115     "title": "Deletes a VoiceQueuesLog",
38116     "examples": [
38117       {
38118         "title": "Example usage:",
38119         "content": "curl https://{domain}/api/voiceQueuesLog/{id} -v -u {name}:{password} -X DELETE",
38120         "type": "json"
38121       }
38122     ],
38123     "name": "DeleteVoiceQueuesLogs",
38124     "group": "voiceQueuesLog",
38125     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
38126     "version": "0.0.0",
38127     "filename": "server/api/voiceQueuesLog/index.js",
38128     "groupTitle": "voiceQueuesLog"
38129   },
38130   {
38131     "type": "get",
38132     "url": "/api/voiceQueuesLog",
38133     "title": "Gets a list of VoiceQueuesLogs",
38134     "examples": [
38135       {
38136         "title": "Example usage:",
38137         "content": "curl https://{domain}/api/voiceQueuesLog -v -u {name}:{password}",
38138         "type": "json"
38139       }
38140     ],
38141     "name": "GetVoiceQueuesLogs",
38142     "group": "voiceQueuesLog",
38143     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
38144     "version": "0.0.0",
38145     "filename": "server/api/voiceQueuesLog/index.js",
38146     "groupTitle": "voiceQueuesLog"
38147   },
38148   {
38149     "type": "get",
38150     "url": "/api/voiceQueuesLog/{id}",
38151     "title": "Gets a single VoiceQueuesLog",
38152     "examples": [
38153       {
38154         "title": "Example usage:",
38155         "content": "curl https://{domain}/api/voiceQueuesLog/{id} -v -u {name}:{password}",
38156         "type": "json"
38157       }
38158     ],
38159     "name": "ShowVoiceQueuesLogs",
38160     "group": "voiceQueuesLog",
38161     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
38162     "version": "0.0.0",
38163     "filename": "server/api/voiceQueuesLog/index.js",
38164     "groupTitle": "voiceQueuesLog"
38165   },
38166   {
38167     "type": "put",
38168     "url": "/api/voiceQueuesLog/{id}",
38169     "title": "Update an existing VoiceQueuesLog",
38170     "examples": [
38171       {
38172         "title": "Example usage:",
38173         "content": "curl https://{domain}/api/voiceQueuesLog/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
38174         "type": "json"
38175       }
38176     ],
38177     "name": "updateVoiceQueuesLogs",
38178     "group": "voiceQueuesLog",
38179     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
38180     "version": "0.0.0",
38181     "filename": "server/api/voiceQueuesLog/index.js",
38182     "groupTitle": "voiceQueuesLog"
38183   }
38184 ]