apidoc/api_data.json

   1 [
   2   {
   3     "type": "delete",
   4     "url": "/api/actions/{id}",
   5     "title": "Deletes a Action",
   6     "examples": [
   7       {
   8         "title": "Example usage:",
   9         "content": "curl https://{domain}/api/actions/{id} -v -u {name}:{password} -X DELETE",
  10         "type": "json"
  11       }
  12     ],
  13     "name": "DeleteActions",
  14     "group": "Actions",
  15     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
  16     "version": "0.0.0",
  17     "filename": "server/api/action/index.js",
  18     "groupTitle": "Actions"
  19   },
  20   {
  21     "type": "put",
  22     "url": "/api/actions/{id}",
  23     "title": "Update an existing Action",
  24     "examples": [
  25       {
  26         "title": "Example usage:",
  27         "content": "curl https://{domain}/api/actions/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
  28         "type": "json"
  29       }
  30     ],
  31     "name": "updateActions",
  32     "group": "Actions",
  33     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
  34     "version": "0.0.0",
  35     "filename": "server/api/action/index.js",
  36     "groupTitle": "Actions"
  37   },
  38   {
  39     "type": "post",
  40     "url": "/api/analytics/custom_reports",
  41     "title": "Creates a new Analytic Custom Report",
  42     "examples": [
  43       {
  44         "title": "Example usage:",
  45         "content": "curl https://{domain}/api/analytics/custom_reports -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
  46         "type": "json"
  47       }
  48     ],
  49     "name": "CreateAnalytic_Custom_Reports",
  50     "group": "Analytic_Custom_Reports",
  51     "parameter": {
  52       "fields": {
  53         "Body": [
  54           {
  55             "group": "Body",
  56             "type": "String",
  57             "optional": false,
  58             "field": "name",
  59             "description": ""
  60           },
  61           {
  62             "group": "Body",
  63             "type": "String",
  64             "optional": true,
  65             "field": "description",
  66             "description": ""
  67           },
  68           {
  69             "group": "Body",
  70             "type": "String",
  71             "optional": true,
  72             "field": "parent",
  73             "description": ""
  74           },
  75           {
  76             "group": "Body",
  77             "type": "String",
  78             "optional": true,
  79             "field": "table",
  80             "description": ""
  81           },
  82           {
  83             "group": "Body",
  84             "type": "Text",
  85             "optional": true,
  86             "field": "conditions",
  87             "description": ""
  88           },
  89           {
  90             "group": "Body",
  91             "type": "Text",
  92             "optional": true,
  93             "field": "joins",
  94             "description": ""
  95           }
  96         ]
  97       }
  98     },
  99     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 100     "version": "0.0.0",
 101     "filename": "server/api/analyticCustomReport/index.js",
 102     "groupTitle": "Analytic_Custom_Reports"
 103   },
 104   {
 105     "type": "delete",
 106     "url": "/api/analytics/custom_reports/{id}",
 107     "title": "Deletes a Analytic Custom Report",
 108     "examples": [
 109       {
 110         "title": "Example usage:",
 111         "content": "curl https://{domain}/api/analytics/custom_reports/{id} -v -u {name}:{password} -X DELETE",
 112         "type": "json"
 113       }
 114     ],
 115     "name": "DeleteAnalytic_Custom_Reports",
 116     "group": "Analytic_Custom_Reports",
 117     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 118     "version": "0.0.0",
 119     "filename": "server/api/analyticCustomReport/index.js",
 120     "groupTitle": "Analytic_Custom_Reports"
 121   },
 122   {
 123     "type": "get",
 124     "url": "/api/analytics/custom_reports",
 125     "title": "Gets a list of Analytic Custom Reports",
 126     "examples": [
 127       {
 128         "title": "Example usage:",
 129         "content": "curl https://{domain}/api/analytics/custom_reports -v -u {name}:{password}",
 130         "type": "json"
 131       }
 132     ],
 133     "name": "GetAnalytic_Custom_Reports",
 134     "group": "Analytic_Custom_Reports",
 135     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/analytics/custom_reports?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/analytics/custom_reports?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/analytics/custom_reports?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/analytics/custom_reports?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/analytics/custom_reports?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
 136     "version": "0.0.0",
 137     "filename": "server/api/analyticCustomReport/index.js",
 138     "groupTitle": "Analytic_Custom_Reports"
 139   },
 140   {
 141     "type": "get",
 142     "url": "/api/analytics/custom_reports/{id}",
 143     "title": "Gets a single Analytic Custom Report",
 144     "examples": [
 145       {
 146         "title": "Example usage:",
 147         "content": "curl https://{domain}/api/analytics/custom_reports/{id} -v -u {name}:{password}",
 148         "type": "json"
 149       }
 150     ],
 151     "name": "ShowAnalytic_Custom_Reports",
 152     "group": "Analytic_Custom_Reports",
 153     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 154     "version": "0.0.0",
 155     "filename": "server/api/analyticCustomReport/index.js",
 156     "groupTitle": "Analytic_Custom_Reports"
 157   },
 158   {
 159     "type": "get",
 160     "url": "/api/analytics/custom_reports/{id}/preview",
 161     "title": "Report Preview",
 162     "examples": [
 163       {
 164         "title": "Example usage:",
 165         "content": "curl https://{domain}/api/analytics/custom_reports/{id}/preview -v -u {name}:{password} -X GET",
 166         "type": "json"
 167       }
 168     ],
 169     "name": "preview",
 170     "group": "Analytic_Custom_Reports",
 171     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 172     "version": "0.0.0",
 173     "filename": "server/api/analyticCustomReport/index.js",
 174     "groupTitle": "Analytic_Custom_Reports"
 175   },
 176   {
 177     "type": "get",
 178     "url": "/api/analytics/custom_reports/{id}/query",
 179     "title": "Report Query SQL",
 180     "examples": [
 181       {
 182         "title": "Example usage:",
 183         "content": "curl https://{domain}/api/analytics/custom_reports/{id}/query -v -u {name}:{password} -X GET",
 184         "type": "json"
 185       }
 186     ],
 187     "name": "query",
 188     "group": "Analytic_Custom_Reports",
 189     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 190     "version": "0.0.0",
 191     "filename": "server/api/analyticCustomReport/index.js",
 192     "groupTitle": "Analytic_Custom_Reports"
 193   },
 194   {
 195     "type": "get",
 196     "url": "/api/analytics/custom_reports/{id}/run",
 197     "title": "Report Run",
 198     "examples": [
 199       {
 200         "title": "Example usage:",
 201         "content": "curl https://{domain}/api/analytics/custom_reports/{id}/run -v -u {name}:{password} -X GET",
 202         "type": "json"
 203       }
 204     ],
 205     "name": "run",
 206     "group": "Analytic_Custom_Reports",
 207     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 208     "version": "0.0.0",
 209     "filename": "server/api/analyticCustomReport/index.js",
 210     "groupTitle": "Analytic_Custom_Reports"
 211   },
 212   {
 213     "type": "put",
 214     "url": "/api/analytics/custom_reports/{id}",
 215     "title": "Update an existing Analytic Custom Report",
 216     "examples": [
 217       {
 218         "title": "Example usage:",
 219         "content": "curl https://{domain}/api/analytics/custom_reports/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
 220         "type": "json"
 221       }
 222     ],
 223     "name": "updateAnalytic_Custom_Reports",
 224     "group": "Analytic_Custom_Reports",
 225     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 226     "version": "0.0.0",
 227     "filename": "server/api/analyticCustomReport/index.js",
 228     "groupTitle": "Analytic_Custom_Reports"
 229   },
 230   {
 231     "type": "post",
 232     "url": "/api/analytics/default_reports",
 233     "title": "Creates a new Analytic Default Report",
 234     "examples": [
 235       {
 236         "title": "Example usage:",
 237         "content": "curl https://{domain}/api/analytics/default_reports -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
 238         "type": "json"
 239       }
 240     ],
 241     "name": "CreateAnalytic_Default_Reports",
 242     "group": "Analytic_Default_Reports",
 243     "parameter": {
 244       "fields": {
 245         "Body": [
 246           {
 247             "group": "Body",
 248             "type": "String",
 249             "optional": false,
 250             "field": "name",
 251             "description": ""
 252           },
 253           {
 254             "group": "Body",
 255             "type": "String",
 256             "optional": true,
 257             "field": "description",
 258             "description": ""
 259           },
 260           {
 261             "group": "Body",
 262             "type": "String",
 263             "optional": true,
 264             "field": "parent",
 265             "description": ""
 266           },
 267           {
 268             "group": "Body",
 269             "type": "String",
 270             "optional": true,
 271             "field": "table",
 272             "description": ""
 273           },
 274           {
 275             "group": "Body",
 276             "type": "Text",
 277             "optional": true,
 278             "field": "conditions",
 279             "description": ""
 280           },
 281           {
 282             "group": "Body",
 283             "type": "Text",
 284             "optional": true,
 285             "field": "joins",
 286             "description": ""
 287           }
 288         ]
 289       }
 290     },
 291     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 292     "version": "0.0.0",
 293     "filename": "server/api/analyticDefaultReport/index.js",
 294     "groupTitle": "Analytic_Default_Reports"
 295   },
 296   {
 297     "type": "delete",
 298     "url": "/api/analytics/default_reports/{id}",
 299     "title": "Deletes a Analytic Default Report",
 300     "examples": [
 301       {
 302         "title": "Example usage:",
 303         "content": "curl https://{domain}/api/analytics/default_reports/{id} -v -u {name}:{password} -X DELETE",
 304         "type": "json"
 305       }
 306     ],
 307     "name": "DeleteAnalytic_Default_Reports",
 308     "group": "Analytic_Default_Reports",
 309     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 310     "version": "0.0.0",
 311     "filename": "server/api/analyticDefaultReport/index.js",
 312     "groupTitle": "Analytic_Default_Reports"
 313   },
 314   {
 315     "type": "get",
 316     "url": "/api/analytics/default_reports",
 317     "title": "Gets a list of Analytic Default Reports",
 318     "examples": [
 319       {
 320         "title": "Example usage:",
 321         "content": "curl https://{domain}/api/analytics/default_reports -v -u {name}:{password}",
 322         "type": "json"
 323       }
 324     ],
 325     "name": "GetAnalytic_Default_Reports",
 326     "group": "Analytic_Default_Reports",
 327     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/analytics/default_reports?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/analytics/default_reports?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/analytics/default_reports?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/analytics/default_reports?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/analytics/default_reports?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
 328     "version": "0.0.0",
 329     "filename": "server/api/analyticDefaultReport/index.js",
 330     "groupTitle": "Analytic_Default_Reports"
 331   },
 332   {
 333     "type": "get",
 334     "url": "/api/analytics/default_reports/{id}",
 335     "title": "Gets a single Analytic Default Report",
 336     "examples": [
 337       {
 338         "title": "Example usage:",
 339         "content": "curl https://{domain}/api/analytics/default_reports/{id} -v -u {name}:{password}",
 340         "type": "json"
 341       }
 342     ],
 343     "name": "ShowAnalytic_Default_Reports",
 344     "group": "Analytic_Default_Reports",
 345     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 346     "version": "0.0.0",
 347     "filename": "server/api/analyticDefaultReport/index.js",
 348     "groupTitle": "Analytic_Default_Reports"
 349   },
 350   {
 351     "type": "get",
 352     "url": "/api/analytics/default_reports/{id}/preview",
 353     "title": "Report Preview",
 354     "examples": [
 355       {
 356         "title": "Example usage:",
 357         "content": "curl https://{domain}/api/analytics/default_reports/{id}/preview -v -u {name}:{password} -X GET",
 358         "type": "json"
 359       }
 360     ],
 361     "name": "preview",
 362     "group": "Analytic_Default_Reports",
 363     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 364     "version": "0.0.0",
 365     "filename": "server/api/analyticDefaultReport/index.js",
 366     "groupTitle": "Analytic_Default_Reports"
 367   },
 368   {
 369     "type": "get",
 370     "url": "/api/analytics/default_reports/{id}/query",
 371     "title": "Report Query SQL",
 372     "examples": [
 373       {
 374         "title": "Example usage:",
 375         "content": "curl https://{domain}/api/analytics/default_reports/{id}/query -v -u {name}:{password} -X GET",
 376         "type": "json"
 377       }
 378     ],
 379     "name": "query",
 380     "group": "Analytic_Default_Reports",
 381     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 382     "version": "0.0.0",
 383     "filename": "server/api/analyticDefaultReport/index.js",
 384     "groupTitle": "Analytic_Default_Reports"
 385   },
 386   {
 387     "type": "get",
 388     "url": "/api/analytics/default_reports/{id}/run",
 389     "title": "Report Run",
 390     "examples": [
 391       {
 392         "title": "Example usage:",
 393         "content": "curl https://{domain}/api/analytics/default_reports/{id}/run -v -u {name}:{password} -X GET",
 394         "type": "json"
 395       }
 396     ],
 397     "name": "run",
 398     "group": "Analytic_Default_Reports",
 399     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 400     "version": "0.0.0",
 401     "filename": "server/api/analyticDefaultReport/index.js",
 402     "groupTitle": "Analytic_Default_Reports"
 403   },
 404   {
 405     "type": "put",
 406     "url": "/api/analytics/default_reports/{id}",
 407     "title": "Update an existing Analytic Default Report",
 408     "examples": [
 409       {
 410         "title": "Example usage:",
 411         "content": "curl https://{domain}/api/analytics/default_reports/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
 412         "type": "json"
 413       }
 414     ],
 415     "name": "updateAnalytic_Default_Reports",
 416     "group": "Analytic_Default_Reports",
 417     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 418     "version": "0.0.0",
 419     "filename": "server/api/analyticDefaultReport/index.js",
 420     "groupTitle": "Analytic_Default_Reports"
 421   },
 422   {
 423     "type": "post",
 424     "url": "/api/analytics/extracted_reports",
 425     "title": "Creates a new Analytic Extracted Report",
 426     "examples": [
 427       {
 428         "title": "Example usage:",
 429         "content": "curl https://{domain}/api/analytics/extracted_reports -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
 430         "type": "json"
 431       }
 432     ],
 433     "name": "CreateAnalytic_Extacted_Reports",
 434     "group": "Analytic_Extracted_Reports",
 435     "parameter": {
 436       "fields": {
 437         "Body": [
 438           {
 439             "group": "Body",
 440             "type": "String",
 441             "optional": false,
 442             "field": "name",
 443             "description": ""
 444           },
 445           {
 446             "group": "Body",
 447             "type": "String",
 448             "optional": false,
 449             "field": "basename",
 450             "description": ""
 451           },
 452           {
 453             "group": "Body",
 454             "type": "String",
 455             "allowedValues": [
 456               "\"csv\"",
 457               "\"pdf\"",
 458               "\"xlsx\""
 459             ],
 460             "optional": false,
 461             "field": "output",
 462             "description": ""
 463           },
 464           {
 465             "group": "Body",
 466             "type": "String",
 467             "optional": false,
 468             "field": "savename",
 469             "description": ""
 470           },
 471           {
 472             "group": "Body",
 473             "type": "String",
 474             "optional": true,
 475             "field": "startDate",
 476             "description": ""
 477           },
 478           {
 479             "group": "Body",
 480             "type": "String",
 481             "optional": true,
 482             "field": "endDate",
 483             "description": ""
 484           },
 485           {
 486             "group": "Body",
 487             "type": "String",
 488             "optional": true,
 489             "field": "status",
 490             "description": ""
 491           },
 492           {
 493             "group": "Body",
 494             "type": "String",
 495             "allowedValues": [
 496               "\"manual\"",
 497               "\"scheduled\""
 498             ],
 499             "optional": false,
 500             "field": "type",
 501             "description": ""
 502           },
 503           {
 504             "group": "Body",
 505             "type": "Integer",
 506             "optional": true,
 507             "field": "reportId",
 508             "description": ""
 509           },
 510           {
 511             "group": "Body",
 512             "type": "String",
 513             "optional": true,
 514             "field": "reportType",
 515             "description": ""
 516           }
 517         ]
 518       }
 519     },
 520     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 521     "version": "0.0.0",
 522     "filename": "server/api/analyticExtractedReport/index.js",
 523     "groupTitle": "Analytic_Extracted_Reports"
 524   },
 525   {
 526     "type": "delete",
 527     "url": "/api/analytics/extracted_reports/{id}",
 528     "title": "Deletes a Analytic Extracted Report",
 529     "examples": [
 530       {
 531         "title": "Example usage:",
 532         "content": "curl https://{domain}/api/analytics/extracted_reports/{id} -v -u {name}:{password} -X DELETE",
 533         "type": "json"
 534       }
 535     ],
 536     "name": "DeleteAnalytic_Extacted_Reports",
 537     "group": "Analytic_Extracted_Reports",
 538     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 539     "version": "0.0.0",
 540     "filename": "server/api/analyticExtractedReport/index.js",
 541     "groupTitle": "Analytic_Extracted_Reports"
 542   },
 543   {
 544     "type": "get",
 545     "url": "/api/analytics/extracted_reports",
 546     "title": "Gets a list of Analytic Extacted Reports",
 547     "examples": [
 548       {
 549         "title": "Example usage:",
 550         "content": "curl https://{domain}/api/analytics/extracted_reports -v -u {name}:{password}",
 551         "type": "json"
 552       }
 553     ],
 554     "name": "GetAnalytic_Extacted_Reports",
 555     "group": "Analytic_Extracted_Reports",
 556     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/analytics/extracted_reports?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/analytics/extracted_reports?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/analytics/extracted_reports?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/analytics/extracted_reports?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/analytics/extracted_reports?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
 557     "version": "0.0.0",
 558     "filename": "server/api/analyticExtractedReport/index.js",
 559     "groupTitle": "Analytic_Extracted_Reports"
 560   },
 561   {
 562     "type": "get",
 563     "url": "/api/analytics/extracted_reports/{id}",
 564     "title": "Gets a single Analytic Extracted Report",
 565     "examples": [
 566       {
 567         "title": "Example usage:",
 568         "content": "curl https://{domain}/api/analytics/extracted_reports/{id} -v -u {name}:{password}",
 569         "type": "json"
 570       }
 571     ],
 572     "name": "ShowAnalytic_Extacted_Reports",
 573     "group": "Analytic_Extracted_Reports",
 574     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 575     "version": "0.0.0",
 576     "filename": "server/api/analyticExtractedReport/index.js",
 577     "groupTitle": "Analytic_Extracted_Reports"
 578   },
 579   {
 580     "type": "get",
 581     "url": "/api/analytics/extracted_reports/{id}/download",
 582     "title": "Download Extracted Report",
 583     "examples": [
 584       {
 585         "title": "Example usage:",
 586         "content": "curl https://{domain}/api/analytics/extracted_reports/{id}/download -v -u {name}:{password} -X GET",
 587         "type": "json"
 588       }
 589     ],
 590     "name": "download",
 591     "group": "Analytic_Extracted_Reports",
 592     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 593     "version": "0.0.0",
 594     "filename": "server/api/analyticExtractedReport/index.js",
 595     "groupTitle": "Analytic_Extracted_Reports"
 596   },
 597   {
 598     "type": "put",
 599     "url": "/api/analytics/extracted_reports/{id}",
 600     "title": "Update an existing Analytic Extracted Report",
 601     "examples": [
 602       {
 603         "title": "Example usage:",
 604         "content": "curl https://{domain}/api/analytics/extracted_reports/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
 605         "type": "json"
 606       }
 607     ],
 608     "name": "updateAnalytic_Extacted_Reports",
 609     "group": "Analytic_Extracted_Reports",
 610     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 611     "version": "0.0.0",
 612     "filename": "server/api/analyticExtractedReport/index.js",
 613     "groupTitle": "Analytic_Extracted_Reports"
 614   },
 615   {
 616     "type": "post",
 617     "url": "/api/analytics/field_reports/create_many",
 618     "title": "Creates many Analytic Field Reports",
 619     "examples": [
 620       {
 621         "title": "Example usage:",
 622         "content": "curl https://{domain}/api/analytics/field_reports/create_many -d '[{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}]' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
 623         "type": "json"
 624       }
 625     ],
 626     "name": "BulkCreateAnalytic_Field_Reports",
 627     "group": "Analytic_Field_Reports",
 628     "parameter": {
 629       "fields": {
 630         "Body": [
 631           {
 632             "group": "Body",
 633             "type": "Text",
 634             "optional": true,
 635             "field": "field",
 636             "description": ""
 637           },
 638           {
 639             "group": "Body",
 640             "type": "String",
 641             "optional": true,
 642             "field": "alias",
 643             "description": ""
 644           },
 645           {
 646             "group": "Body",
 647             "type": "String",
 648             "optional": true,
 649             "field": "function",
 650             "description": ""
 651           },
 652           {
 653             "group": "Body",
 654             "type": "String",
 655             "optional": true,
 656             "field": "format",
 657             "description": ""
 658           },
 659           {
 660             "group": "Body",
 661             "type": "Boolean",
 662             "optional": true,
 663             "field": "groupBy",
 664             "description": ""
 665           },
 666           {
 667             "group": "Body",
 668             "type": "String",
 669             "optional": true,
 670             "field": "orderBy",
 671             "description": ""
 672           },
 673           {
 674             "group": "Body",
 675             "type": "Boolean",
 676             "optional": true,
 677             "field": "custom",
 678             "description": ""
 679           }
 680         ]
 681       }
 682     },
 683     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 684     "version": "0.0.0",
 685     "filename": "server/api/analyticFieldReport/index.js",
 686     "groupTitle": "Analytic_Field_Reports"
 687   },
 688   {
 689     "type": "delete",
 690     "url": "/api/analytics/field_reports/destroy_many?ids={ids}",
 691     "title": "Deletes many Analytic Field Reports",
 692     "examples": [
 693       {
 694         "title": "Example usage:",
 695         "content": "curl https://{domain}/api/analytics/field_reports/destroy_many?ids=1&ids=2&ids=3 -v -u {name}:{password} -X DELETE",
 696         "type": "json"
 697       }
 698     ],
 699     "name": "BulkDeleteAnalytic_Field_Reports",
 700     "group": "Analytic_Field_Reports",
 701     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 702     "version": "0.0.0",
 703     "filename": "server/api/analyticFieldReport/index.js",
 704     "groupTitle": "Analytic_Field_Reports"
 705   },
 706   {
 707     "type": "post",
 708     "url": "/api/analytics/field_reports",
 709     "title": "Creates a new Analytic Field Report",
 710     "examples": [
 711       {
 712         "title": "Example usage:",
 713         "content": "curl https://{domain}/api/analytics/field_reports -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
 714         "type": "json"
 715       }
 716     ],
 717     "name": "CreateAnalytic_Field_Reports",
 718     "group": "Analytic_Field_Reports",
 719     "parameter": {
 720       "fields": {
 721         "Body": [
 722           {
 723             "group": "Body",
 724             "type": "Text",
 725             "optional": true,
 726             "field": "field",
 727             "description": ""
 728           },
 729           {
 730             "group": "Body",
 731             "type": "String",
 732             "optional": true,
 733             "field": "alias",
 734             "description": ""
 735           },
 736           {
 737             "group": "Body",
 738             "type": "String",
 739             "optional": true,
 740             "field": "function",
 741             "description": ""
 742           },
 743           {
 744             "group": "Body",
 745             "type": "String",
 746             "optional": true,
 747             "field": "format",
 748             "description": ""
 749           },
 750           {
 751             "group": "Body",
 752             "type": "Boolean",
 753             "optional": true,
 754             "field": "groupBy",
 755             "description": ""
 756           },
 757           {
 758             "group": "Body",
 759             "type": "String",
 760             "optional": true,
 761             "field": "orderBy",
 762             "description": ""
 763           },
 764           {
 765             "group": "Body",
 766             "type": "Boolean",
 767             "optional": true,
 768             "field": "custom",
 769             "description": ""
 770           }
 771         ]
 772       }
 773     },
 774     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 775     "version": "0.0.0",
 776     "filename": "server/api/analyticFieldReport/index.js",
 777     "groupTitle": "Analytic_Field_Reports"
 778   },
 779   {
 780     "type": "delete",
 781     "url": "/api/analytics/field_reports/{id}",
 782     "title": "Deletes a Analytic Field Report",
 783     "examples": [
 784       {
 785         "title": "Example usage:",
 786         "content": "curl https://{domain}/api/analytics/field_reports/{id} -v -u {name}:{password} -X DELETE",
 787         "type": "json"
 788       }
 789     ],
 790     "name": "DeleteAnalytic_Field_Reports",
 791     "group": "Analytic_Field_Reports",
 792     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 793     "version": "0.0.0",
 794     "filename": "server/api/analyticFieldReport/index.js",
 795     "groupTitle": "Analytic_Field_Reports"
 796   },
 797   {
 798     "type": "get",
 799     "url": "/api/analytics/field_reports",
 800     "title": "Gets a list of Analytic Field Reports",
 801     "examples": [
 802       {
 803         "title": "Example usage:",
 804         "content": "curl https://{domain}/api/analytics/field_reports -v -u {name}:{password}",
 805         "type": "json"
 806       }
 807     ],
 808     "name": "GetAnalytic_Field_Reports",
 809     "group": "Analytic_Field_Reports",
 810     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/analytics/field_reports?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/analytics/field_reports?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/analytics/field_reports?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/analytics/field_reports?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/analytics/field_reports?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
 811     "version": "0.0.0",
 812     "filename": "server/api/analyticFieldReport/index.js",
 813     "groupTitle": "Analytic_Field_Reports"
 814   },
 815   {
 816     "type": "get",
 817     "url": "/api/analytics/field_reports/{id}",
 818     "title": "Gets a single Analytic Field Report",
 819     "examples": [
 820       {
 821         "title": "Example usage:",
 822         "content": "curl https://{domain}/api/analytics/field_reports/{id} -v -u {name}:{password}",
 823         "type": "json"
 824       }
 825     ],
 826     "name": "ShowAnalytic_Field_Reports",
 827     "group": "Analytic_Field_Reports",
 828     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 829     "version": "0.0.0",
 830     "filename": "server/api/analyticFieldReport/index.js",
 831     "groupTitle": "Analytic_Field_Reports"
 832   },
 833   {
 834     "type": "post",
 835     "url": "/api/analytics/field_reports/{id}/create_many",
 836     "title": "Rewrite fields set",
 837     "examples": [
 838       {
 839         "title": "Example usage:",
 840         "content": "curl https://{domain}/api/analytics/field_reports/{id}/create_many -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
 841         "type": "json"
 842       }
 843     ],
 844     "name": "addFields",
 845     "group": "Analytic_Field_Reports",
 846     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 847     "version": "0.0.0",
 848     "filename": "server/api/analyticFieldReport/index.js",
 849     "groupTitle": "Analytic_Field_Reports"
 850   },
 851   {
 852     "type": "put",
 853     "url": "/api/analytics/field_reports/{id}",
 854     "title": "Update an existing Analytic Field Report",
 855     "examples": [
 856       {
 857         "title": "Example usage:",
 858         "content": "curl https://{domain}/api/analytics/field_reports/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
 859         "type": "json"
 860       }
 861     ],
 862     "name": "updateAnalytic_Field_Reports",
 863     "group": "Analytic_Field_Reports",
 864     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 865     "version": "0.0.0",
 866     "filename": "server/api/analyticFieldReport/index.js",
 867     "groupTitle": "Analytic_Field_Reports"
 868   },
 869   {
 870     "type": "post",
 871     "url": "/api/analytics/metrics",
 872     "title": "Creates a new Analytic Metrics",
 873     "examples": [
 874       {
 875         "title": "Example usage:",
 876         "content": "curl https://{domain}/api/analytics/metrics -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
 877         "type": "json"
 878       }
 879     ],
 880     "name": "CreateAnalytic_Metric",
 881     "group": "Analytic_Metrics",
 882     "parameter": {
 883       "fields": {
 884         "Body": [
 885           {
 886             "group": "Body",
 887             "type": "String",
 888             "optional": false,
 889             "field": "name",
 890             "description": ""
 891           },
 892           {
 893             "group": "Body",
 894             "type": "String",
 895             "optional": true,
 896             "field": "table",
 897             "description": ""
 898           },
 899           {
 900             "group": "Body",
 901             "type": "Text",
 902             "optional": true,
 903             "field": "metric",
 904             "description": ""
 905           },
 906           {
 907             "group": "Body",
 908             "type": "String",
 909             "optional": true,
 910             "field": "description",
 911             "description": ""
 912           }
 913         ]
 914       }
 915     },
 916     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 917     "version": "0.0.0",
 918     "filename": "server/api/analyticMetric/index.js",
 919     "groupTitle": "Analytic_Metrics"
 920   },
 921   {
 922     "type": "delete",
 923     "url": "/api/analytics/metrics/{id}",
 924     "title": "Deletes a Analytic Metrics",
 925     "examples": [
 926       {
 927         "title": "Example usage:",
 928         "content": "curl https://{domain}/api/analytics/metrics/{id} -v -u {name}:{password} -X DELETE",
 929         "type": "json"
 930       }
 931     ],
 932     "name": "DeleteAnalytic_Metric",
 933     "group": "Analytic_Metrics",
 934     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 935     "version": "0.0.0",
 936     "filename": "server/api/analyticMetric/index.js",
 937     "groupTitle": "Analytic_Metrics"
 938   },
 939   {
 940     "type": "get",
 941     "url": "/api/analytics/metrics",
 942     "title": "Gets a list of Analytic Metric",
 943     "examples": [
 944       {
 945         "title": "Example usage:",
 946         "content": "curl https://{domain}/api/analytics/metrics -v -u {name}:{password}",
 947         "type": "json"
 948       }
 949     ],
 950     "name": "GetAnalytic_Metric",
 951     "group": "Analytic_Metrics",
 952     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/analytics/metrics?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/analytics/metrics?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/analytics/metrics?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/analytics/metrics?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/analytics/metrics?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
 953     "version": "0.0.0",
 954     "filename": "server/api/analyticMetric/index.js",
 955     "groupTitle": "Analytic_Metrics"
 956   },
 957   {
 958     "type": "get",
 959     "url": "/api/analytics/metrics/{id}",
 960     "title": "Gets a single Analytic Metrics",
 961     "examples": [
 962       {
 963         "title": "Example usage:",
 964         "content": "curl https://{domain}/api/analytics/metrics/{id} -v -u {name}:{password}",
 965         "type": "json"
 966       }
 967     ],
 968     "name": "ShowAnalytic_Metric",
 969     "group": "Analytic_Metrics",
 970     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 971     "version": "0.0.0",
 972     "filename": "server/api/analyticMetric/index.js",
 973     "groupTitle": "Analytic_Metrics"
 974   },
 975   {
 976     "type": "put",
 977     "url": "/api/analytics/metrics/{id}",
 978     "title": "Update an existing Analytic Metrics",
 979     "examples": [
 980       {
 981         "title": "Example usage:",
 982         "content": "curl https://{domain}/api/analytics/metrics/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
 983         "type": "json"
 984       }
 985     ],
 986     "name": "updateAnalytic_Metric",
 987     "group": "Analytic_Metrics",
 988     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 989     "version": "0.0.0",
 990     "filename": "server/api/analyticMetric/index.js",
 991     "groupTitle": "Analytic_Metrics"
 992   },
 993   {
 994     "type": "post",
 995     "url": "/api/analytics/tree_reports",
 996     "title": "Creates a new Analytic Tree Report",
 997     "examples": [
 998       {
 999         "title": "Example usage:",
1000         "content": "curl https://{domain}/api/analytics/tree_reports -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
1001         "type": "json"
1002       }
1003     ],
1004     "name": "CreateAnalytic_Tree_Reports",
1005     "group": "Analytic_Tree_Reports",
1006     "parameter": {
1007       "fields": {
1008         "Body": [
1009           {
1010             "group": "Body",
1011             "type": "Text",
1012             "optional": false,
1013             "field": "tree",
1014             "description": ""
1015           }
1016         ]
1017       }
1018     },
1019     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1020     "version": "0.0.0",
1021     "filename": "server/api/analyticTreeReport/index.js",
1022     "groupTitle": "Analytic_Tree_Reports"
1023   },
1024   {
1025     "type": "delete",
1026     "url": "/api/analytics/tree_reports/{id}",
1027     "title": "Deletes a Analytic Tree Report",
1028     "examples": [
1029       {
1030         "title": "Example usage:",
1031         "content": "curl https://{domain}/api/analytics/tree_reports/{id} -v -u {name}:{password} -X DELETE",
1032         "type": "json"
1033       }
1034     ],
1035     "name": "DeleteAnalytic_Tree_Reports",
1036     "group": "Analytic_Tree_Reports",
1037     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1038     "version": "0.0.0",
1039     "filename": "server/api/analyticTreeReport/index.js",
1040     "groupTitle": "Analytic_Tree_Reports"
1041   },
1042   {
1043     "type": "get",
1044     "url": "/api/analytics/tree_reports",
1045     "title": "Gets a list of Analytic Tree Reports",
1046     "examples": [
1047       {
1048         "title": "Example usage:",
1049         "content": "curl https://{domain}/api/analytics/tree_reports -v -u {name}:{password}",
1050         "type": "json"
1051       }
1052     ],
1053     "name": "GetAnalytic_Tree_Reports",
1054     "group": "Analytic_Tree_Reports",
1055     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/analytics/tree_reports?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/analytics/tree_reports?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/analytics/tree_reports?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/analytics/tree_reports?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/analytics/tree_reports?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
1056     "version": "0.0.0",
1057     "filename": "server/api/analyticTreeReport/index.js",
1058     "groupTitle": "Analytic_Tree_Reports"
1059   },
1060   {
1061     "type": "get",
1062     "url": "/api/analytics/tree_reports/{id}",
1063     "title": "Gets a single Analytic Tree Report",
1064     "examples": [
1065       {
1066         "title": "Example usage:",
1067         "content": "curl https://{domain}/api/analytics/tree_reports/{id} -v -u {name}:{password}",
1068         "type": "json"
1069       }
1070     ],
1071     "name": "ShowAnalytic_Tree_Reports",
1072     "group": "Analytic_Tree_Reports",
1073     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1074     "version": "0.0.0",
1075     "filename": "server/api/analyticTreeReport/index.js",
1076     "groupTitle": "Analytic_Tree_Reports"
1077   },
1078   {
1079     "type": "put",
1080     "url": "/api/analytics/tree_reports/{id}",
1081     "title": "Update an existing Analytic Tree Report",
1082     "examples": [
1083       {
1084         "title": "Example usage:",
1085         "content": "curl https://{domain}/api/analytics/tree_reports/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
1086         "type": "json"
1087       }
1088     ],
1089     "name": "updateAnalytic_Tree_Reports",
1090     "group": "Analytic_Tree_Reports",
1091     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1092     "version": "0.0.0",
1093     "filename": "server/api/analyticTreeReport/index.js",
1094     "groupTitle": "Analytic_Tree_Reports"
1095   },
1096   {
1097     "type": "post",
1098     "url": "/api/attachments/clone",
1099     "title": "Clone an existing Attachment",
1100     "examples": [
1101       {
1102         "title": "Example usage:",
1103         "content": "curl https://{domain}/api/attachments/clone -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
1104         "type": "json"
1105       }
1106     ],
1107     "name": "CloneAttachments",
1108     "group": "Attachments",
1109     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1110     "version": "0.0.0",
1111     "filename": "server/api/attachment/index.js",
1112     "groupTitle": "Attachments"
1113   },
1114   {
1115     "type": "delete",
1116     "url": "/api/attachments/{id}",
1117     "title": "Deletes a Attachment",
1118     "examples": [
1119       {
1120         "title": "Example usage:",
1121         "content": "curl https://{domain}/api/attachments/{id} -v -u {name}:{password} -X DELETE",
1122         "type": "json"
1123       }
1124     ],
1125     "name": "DeleteAttachments",
1126     "group": "Attachments",
1127     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1128     "version": "0.0.0",
1129     "filename": "server/api/attachment/index.js",
1130     "groupTitle": "Attachments"
1131   },
1132   {
1133     "type": "get",
1134     "url": "/api/attachments",
1135     "title": "Gets a list of Attachments",
1136     "examples": [
1137       {
1138         "title": "Example usage:",
1139         "content": "curl https://{domain}/api/attachments -v -u {name}:{password}",
1140         "type": "json"
1141       }
1142     ],
1143     "name": "GetAttachments",
1144     "group": "Attachments",
1145     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/attachments?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/attachments?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/attachments?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/attachments?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/attachments?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
1146     "version": "0.0.0",
1147     "filename": "server/api/attachment/index.js",
1148     "groupTitle": "Attachments"
1149   },
1150   {
1151     "type": "get",
1152     "url": "/api/attachments/{id}",
1153     "title": "Gets a single Attachment",
1154     "examples": [
1155       {
1156         "title": "Example usage:",
1157         "content": "curl https://{domain}/api/attachments/{id} -v -u {name}:{password}",
1158         "type": "json"
1159       }
1160     ],
1161     "name": "ShowAttachments",
1162     "group": "Attachments",
1163     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1164     "version": "0.0.0",
1165     "filename": "server/api/attachment/index.js",
1166     "groupTitle": "Attachments"
1167   },
1168   {
1169     "type": "post",
1170     "url": "/api/attachments",
1171     "title": "Add attachment",
1172     "examples": [
1173       {
1174         "title": "Example usage:",
1175         "content": "curl https://{domain}/api/attachments -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
1176         "type": "json"
1177       }
1178     ],
1179     "name": "create",
1180     "group": "Attachments",
1181     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1182     "version": "0.0.0",
1183     "filename": "server/api/attachment/index.js",
1184     "groupTitle": "Attachments"
1185   },
1186   {
1187     "type": "get",
1188     "url": "/api/attachments/:id/download",
1189     "title": "Download attachment",
1190     "examples": [
1191       {
1192         "title": "Example usage:",
1193         "content": "curl https://{domain}/api/attachments/:id/download -v -u {name}:{password} -X GET",
1194         "type": "json"
1195       }
1196     ],
1197     "name": "download",
1198     "group": "Attachments",
1199     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1200     "version": "0.0.0",
1201     "filename": "server/api/attachment/index.js",
1202     "groupTitle": "Attachments"
1203   },
1204   {
1205     "type": "get",
1206     "url": "/api/chat/interactions/{id}/attachment_download",
1207     "title": "Download attachment",
1208     "examples": [
1209       {
1210         "title": "Example usage:",
1211         "content": "curl https://{domain}/api/chat/interactions/{id}/attachment_download -v -u {name}:{password} -X GET",
1212         "type": "json"
1213       }
1214     ],
1215     "name": "show",
1216     "group": "Attachments",
1217     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1218     "version": "0.0.0",
1219     "filename": "server/api/chatInteraction/index.js",
1220     "groupTitle": "Attachments"
1221   },
1222   {
1223     "type": "put",
1224     "url": "/api/attachments/{id}",
1225     "title": "Update an existing Attachment",
1226     "examples": [
1227       {
1228         "title": "Example usage:",
1229         "content": "curl https://{domain}/api/attachments/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
1230         "type": "json"
1231       }
1232     ],
1233     "name": "updateAttachments",
1234     "group": "Attachments",
1235     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1236     "version": "0.0.0",
1237     "filename": "server/api/attachment/index.js",
1238     "groupTitle": "Attachments"
1239   },
1240   {
1241     "type": "post",
1242     "url": "/api/auth/local/forgot",
1243     "title": "Creates a new password reset token",
1244     "examples": [
1245       {
1246         "title": "Example usage:",
1247         "content": "curl https://{domain}/api/auth/local/forgot -d '{\"email\": \"john.doe@xcally.com\"}' \\\n -H \"Content-Type: application/json\" -X POST",
1248         "type": "json"
1249       }
1250     ],
1251     "name": "Local_Forgot_Password",
1252     "group": "Authentication",
1253     "parameter": {
1254       "fields": {
1255         "Body": [
1256           {
1257             "group": "Body",
1258             "type": "String",
1259             "optional": false,
1260             "field": "email",
1261             "description": ""
1262           }
1263         ]
1264       }
1265     },
1266     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1267     "version": "0.0.0",
1268     "filename": "server/api/authLocal/index.js",
1269     "groupTitle": "Authentication"
1270   },
1271   {
1272     "type": "post",
1273     "url": "/api/auth/local/reset/:token",
1274     "title": "Reset user password",
1275     "examples": [
1276       {
1277         "title": "Example usage:",
1278         "content": "curl https://{domain}/api/auth/local/reset/94b422c1fkdjhg766a198da6997yu6gcc963641d -d '{\"password\": \"My_newP@ssw0rd\"}' \\\n -H \"Content-Type: application/json\" -X POST",
1279         "type": "json"
1280       }
1281     ],
1282     "name": "Local_Reset_Password",
1283     "group": "Authentication",
1284     "parameter": {
1285       "fields": {
1286         "Body": [
1287           {
1288             "group": "Body",
1289             "type": "String",
1290             "optional": false,
1291             "field": "password",
1292             "description": ""
1293           }
1294         ]
1295       }
1296     },
1297     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1298     "version": "0.0.0",
1299     "filename": "server/api/authLocal/index.js",
1300     "groupTitle": "Authentication"
1301   },
1302   {
1303     "type": "post",
1304     "url": "/api/auth/local",
1305     "title": "Creates a new User token",
1306     "examples": [
1307       {
1308         "title": "Example usage:",
1309         "content": "curl https://{domain}/api/auth/local -d '{\"name\": \"john.doe\", \"password\": \"password\"}' \\\n -H \"Content-Type: application/json\" -X POST",
1310         "type": "json"
1311       }
1312     ],
1313     "name": "Local_login",
1314     "group": "Authentication",
1315     "parameter": {
1316       "fields": {
1317         "Body": [
1318           {
1319             "group": "Body",
1320             "type": "String",
1321             "optional": false,
1322             "field": "name",
1323             "description": ""
1324           },
1325           {
1326             "group": "Body",
1327             "type": "String",
1328             "optional": false,
1329             "field": "password",
1330             "description": ""
1331           }
1332         ]
1333       }
1334     },
1335     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1336     "version": "0.0.0",
1337     "filename": "server/api/authLocal/index.js",
1338     "groupTitle": "Authentication"
1339   },
1340   {
1341     "type": "post",
1342     "url": "/api/auth/google",
1343     "title": "Creates a new User token",
1344     "examples": [
1345       {
1346         "title": "Example usage:",
1347         "content": "curl https://{domain}/api/auth/google -d '{\"name\": \"john.doe\", \"password\": \"password\"}' \\\n -H \"Content-Type: application/json\" -X POST",
1348         "type": "json"
1349       }
1350     ],
1351     "name": "Local_login",
1352     "group": "Authentication",
1353     "parameter": {
1354       "fields": {
1355         "Body": [
1356           {
1357             "group": "Body",
1358             "type": "String",
1359             "optional": false,
1360             "field": "name",
1361             "description": ""
1362           },
1363           {
1364             "group": "Body",
1365             "type": "String",
1366             "optional": false,
1367             "field": "password",
1368             "description": ""
1369           }
1370         ]
1371       }
1372     },
1373     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1374     "version": "0.0.0",
1375     "filename": "server/api/authGoogle/index.js",
1376     "groupTitle": "Authentication"
1377   },
1378   {
1379     "type": "post",
1380     "url": "/api/automations",
1381     "title": "Creates a new Automation",
1382     "examples": [
1383       {
1384         "title": "Example usage:",
1385         "content": "curl https://{domain}/api/automations -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
1386         "type": "json"
1387       }
1388     ],
1389     "name": "CreateAutomations",
1390     "group": "Automations",
1391     "parameter": {
1392       "fields": {
1393         "Body": [
1394           {
1395             "group": "Body",
1396             "type": "String",
1397             "optional": false,
1398             "field": "name",
1399             "description": ""
1400           },
1401           {
1402             "group": "Body",
1403             "type": "String",
1404             "optional": true,
1405             "field": "channel",
1406             "description": ""
1407           },
1408           {
1409             "group": "Body",
1410             "type": "String",
1411             "optional": true,
1412             "field": "description",
1413             "description": ""
1414           },
1415           {
1416             "group": "Body",
1417             "type": "Boolean",
1418             "optional": true,
1419             "field": "status",
1420             "description": ""
1421           },
1422           {
1423             "group": "Body",
1424             "type": "Integer",
1425             "optional": true,
1426             "field": "timeout",
1427             "description": ""
1428           }
1429         ]
1430       }
1431     },
1432     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1433     "version": "0.0.0",
1434     "filename": "server/api/automation/index.js",
1435     "groupTitle": "Automations"
1436   },
1437   {
1438     "type": "delete",
1439     "url": "/api/automations/{id}",
1440     "title": "Deletes a Automation",
1441     "examples": [
1442       {
1443         "title": "Example usage:",
1444         "content": "curl https://{domain}/api/automations/{id} -v -u {name}:{password} -X DELETE",
1445         "type": "json"
1446       }
1447     ],
1448     "name": "DeleteAutomations",
1449     "group": "Automations",
1450     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1451     "version": "0.0.0",
1452     "filename": "server/api/automation/index.js",
1453     "groupTitle": "Automations"
1454   },
1455   {
1456     "type": "get",
1457     "url": "/api/automations",
1458     "title": "Gets a list of Automations",
1459     "examples": [
1460       {
1461         "title": "Example usage:",
1462         "content": "curl https://{domain}/api/automations -v -u {name}:{password}",
1463         "type": "json"
1464       }
1465     ],
1466     "name": "GetAutomations",
1467     "group": "Automations",
1468     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/automations?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/automations?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/automations?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/automations?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/automations?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
1469     "version": "0.0.0",
1470     "filename": "server/api/automation/index.js",
1471     "groupTitle": "Automations"
1472   },
1473   {
1474     "type": "get",
1475     "url": "/api/automations/{id}",
1476     "title": "Gets a single Automation",
1477     "examples": [
1478       {
1479         "title": "Example usage:",
1480         "content": "curl https://{domain}/api/automations/{id} -v -u {name}:{password}",
1481         "type": "json"
1482       }
1483     ],
1484     "name": "ShowAutomations",
1485     "group": "Automations",
1486     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1487     "version": "0.0.0",
1488     "filename": "server/api/automation/index.js",
1489     "groupTitle": "Automations"
1490   },
1491   {
1492     "type": "post",
1493     "url": "/api/automations/{id}/actions",
1494     "title": "Creates new actions",
1495     "examples": [
1496       {
1497         "title": "Example usage:",
1498         "content": "curl https://{domain}/api/automations/{id}/actions -d '[{\"firstName\": \"John Doe\", \"email\": \"john.doe@xcally.com\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
1499         "type": "json"
1500       }
1501     ],
1502     "name": "addActions",
1503     "group": "Automations",
1504     "parameter": {
1505       "fields": {
1506         "Body": [
1507           {
1508             "group": "Body",
1509             "type": "Virtual",
1510             "optional": true,
1511             "field": "name",
1512             "description": ""
1513           },
1514           {
1515             "group": "Body",
1516             "type": "String",
1517             "optional": false,
1518             "field": "action",
1519             "description": "<p>Allowed values: contactManager, integration, motionbar, jscripty, urlForward, browser, bot, script</p>"
1520           },
1521           {
1522             "group": "Body",
1523             "type": "String",
1524             "optional": true,
1525             "field": "data1",
1526             "description": "<p>contactManager[ListId], integration[intName(zendesk)], motionbar[Popup(0),URL(1),WinApp(2)], urlForward[GET,POST], browser[TemplateId(0),URL(1)]</p>"
1527           },
1528           {
1529             "group": "Body",
1530             "type": "String",
1531             "optional": true,
1532             "field": "data2",
1533             "description": "<p>integration[AccountId], motionbar[TemplateId,URL,WinAppPath], urlForward[URL]</p>"
1534           },
1535           {
1536             "group": "Body",
1537             "type": "String",
1538             "optional": true,
1539             "field": "data3",
1540             "description": "<p>motionbar[NULL,NULL,WinAppArguments]</p>"
1541           },
1542           {
1543             "group": "Body",
1544             "type": "String",
1545             "optional": true,
1546             "field": "data4",
1547             "description": ""
1548           },
1549           {
1550             "group": "Body",
1551             "type": "String",
1552             "optional": true,
1553             "field": "data5",
1554             "description": ""
1555           },
1556           {
1557             "group": "Body",
1558             "type": "String",
1559             "optional": true,
1560             "field": "data6",
1561             "description": ""
1562           },
1563           {
1564             "group": "Body",
1565             "type": "Text",
1566             "optional": true,
1567             "field": "data7",
1568             "description": ""
1569           }
1570         ]
1571       }
1572     },
1573     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1574     "version": "0.0.0",
1575     "filename": "server/api/automation/index.js",
1576     "groupTitle": "Automations"
1577   },
1578   {
1579     "type": "post",
1580     "url": "/api/automations/{id}/conditions",
1581     "title": "Creates new conditions",
1582     "examples": [
1583       {
1584         "title": "Example usage:",
1585         "content": "curl https://{domain}/api/automations/{id}/conditions -d '[{\"firstName\": \"John Doe\", \"email\": \"john.doe@xcally.com\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
1586         "type": "json"
1587       }
1588     ],
1589     "name": "addConditions",
1590     "group": "Automations",
1591     "parameter": {
1592       "fields": {
1593         "Body": [
1594           {
1595             "group": "Body",
1596             "type": "Virtual",
1597             "optional": true,
1598             "field": "name",
1599             "description": ""
1600           },
1601           {
1602             "group": "Body",
1603             "type": "String",
1604             "optional": false,
1605             "field": "field",
1606             "description": ""
1607           },
1608           {
1609             "group": "Body",
1610             "type": "String",
1611             "optional": false,
1612             "field": "operator",
1613             "description": ""
1614           },
1615           {
1616             "group": "Body",
1617             "type": "String",
1618             "optional": false,
1619             "field": "value",
1620             "description": ""
1621           }
1622         ]
1623       }
1624     },
1625     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1626     "version": "0.0.0",
1627     "filename": "server/api/automation/index.js",
1628     "groupTitle": "Automations"
1629   },
1630   {
1631     "type": "get",
1632     "url": "/api/automations/{id}/actions",
1633     "title": "Gets Automation Actions",
1634     "examples": [
1635       {
1636         "title": "Example usage:",
1637         "content": "curl https://{domain}/api/automations/{id}/actions -v -u {name}:{password} -X GET",
1638         "type": "json"
1639       }
1640     ],
1641     "name": "getActions",
1642     "group": "Automations",
1643     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1644     "version": "0.0.0",
1645     "filename": "server/api/automation/index.js",
1646     "groupTitle": "Automations"
1647   },
1648   {
1649     "type": "get",
1650     "url": "/api/automations/{id}/conditions",
1651     "title": "Gets Automation Conditions",
1652     "examples": [
1653       {
1654         "title": "Example usage:",
1655         "content": "curl https://{domain}/api/automations/{id}/conditions -v -u {name}:{password} -X GET",
1656         "type": "json"
1657       }
1658     ],
1659     "name": "getConditions",
1660     "group": "Automations",
1661     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1662     "version": "0.0.0",
1663     "filename": "server/api/automation/index.js",
1664     "groupTitle": "Automations"
1665   },
1666   {
1667     "type": "put",
1668     "url": "/api/automations/{id}",
1669     "title": "Update an existing Automation",
1670     "examples": [
1671       {
1672         "title": "Example usage:",
1673         "content": "curl https://{domain}/api/automations/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
1674         "type": "json"
1675       }
1676     ],
1677     "name": "updateAutomations",
1678     "group": "Automations",
1679     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1680     "version": "0.0.0",
1681     "filename": "server/api/automation/index.js",
1682     "groupTitle": "Automations"
1683   },
1684   {
1685     "type": "post",
1686     "url": "/api/canned_answers",
1687     "title": "Create a new canned answer",
1688     "examples": [
1689       {
1690         "title": "Example usage:",
1691         "content": "curl https://{domain}/api/canned_answers -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
1692         "type": "json"
1693       }
1694     ],
1695     "name": "Create",
1696     "group": "Canned_Answers",
1697     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1698     "version": "0.0.0",
1699     "filename": "server/api/cannedAnswer/index.js",
1700     "groupTitle": "Canned_Answers"
1701   },
1702   {
1703     "type": "delete",
1704     "url": "/api/canned_answers/{id}",
1705     "title": "Deletes a Canned Answer",
1706     "examples": [
1707       {
1708         "title": "Example usage:",
1709         "content": "curl https://{domain}/api/canned_answers/{id} -v -u {name}:{password} -X DELETE",
1710         "type": "json"
1711       }
1712     ],
1713     "name": "DeleteCanned_Answers",
1714     "group": "Canned_Answers",
1715     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1716     "version": "0.0.0",
1717     "filename": "server/api/cannedAnswer/index.js",
1718     "groupTitle": "Canned_Answers"
1719   },
1720   {
1721     "type": "get",
1722     "url": "/api/canned_answers",
1723     "title": "Gets a list of Canned Answers",
1724     "examples": [
1725       {
1726         "title": "Example usage:",
1727         "content": "curl https://{domain}/api/canned_answers -v -u {name}:{password}",
1728         "type": "json"
1729       }
1730     ],
1731     "name": "GetCanned_Answers",
1732     "group": "Canned_Answers",
1733     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/canned_answers?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/canned_answers?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/canned_answers?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/canned_answers?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/canned_answers?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
1734     "version": "0.0.0",
1735     "filename": "server/api/cannedAnswer/index.js",
1736     "groupTitle": "Canned_Answers"
1737   },
1738   {
1739     "type": "get",
1740     "url": "/api/canned_answers/{id}",
1741     "title": "Gets a single Canned Answer",
1742     "examples": [
1743       {
1744         "title": "Example usage:",
1745         "content": "curl https://{domain}/api/canned_answers/{id} -v -u {name}:{password}",
1746         "type": "json"
1747       }
1748     ],
1749     "name": "ShowCanned_Answers",
1750     "group": "Canned_Answers",
1751     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1752     "version": "0.0.0",
1753     "filename": "server/api/cannedAnswer/index.js",
1754     "groupTitle": "Canned_Answers"
1755   },
1756   {
1757     "type": "put",
1758     "url": "/api/canned_answers/{id}",
1759     "title": "Update an existing Canned Answer",
1760     "examples": [
1761       {
1762         "title": "Example usage:",
1763         "content": "curl https://{domain}/api/canned_answers/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
1764         "type": "json"
1765       }
1766     ],
1767     "name": "updateCanned_Answers",
1768     "group": "Canned_Answers",
1769     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1770     "version": "0.0.0",
1771     "filename": "server/api/cannedAnswer/index.js",
1772     "groupTitle": "Canned_Answers"
1773   },
1774   {
1775     "type": "get",
1776     "url": "/chat/internal/users",
1777     "title": "Gets Users Last Messages",
1778     "examples": [
1779       {
1780         "title": "Example usage:",
1781         "content": "curl https://{domain}/chat/internal/users -v -u {name}:{password}  -X GET",
1782         "type": "json"
1783       }
1784     ],
1785     "name": "getLastUsersMessages",
1786     "group": "ChatInternalMessage",
1787     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1788     "version": "0.0.0",
1789     "filename": "server/api/chatInternalMessage/index.js",
1790     "groupTitle": "ChatInternalMessage"
1791   },
1792   {
1793     "type": "delete",
1794     "url": "/api/chat/applications/{id}",
1795     "title": "Deletes a Application",
1796     "examples": [
1797       {
1798         "title": "Example usage:",
1799         "content": "curl https://{domain}/api/chat/applications/{id} -v -u {name}:{password} -X DELETE",
1800         "type": "json"
1801       }
1802     ],
1803     "name": "DeleteApplications",
1804     "group": "Chat_Applications",
1805     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1806     "version": "0.0.0",
1807     "filename": "server/api/chatApplication/index.js",
1808     "groupTitle": "Chat_Applications"
1809   },
1810   {
1811     "type": "get",
1812     "url": "/api/chat/applications/{id}",
1813     "title": "Gets a single Application",
1814     "examples": [
1815       {
1816         "title": "Example usage:",
1817         "content": "curl https://{domain}/api/chat/applications/{id} -v -u {name}:{password}",
1818         "type": "json"
1819       }
1820     ],
1821     "name": "ShowApplications",
1822     "group": "Chat_Applications",
1823     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1824     "version": "0.0.0",
1825     "filename": "server/api/chatApplication/index.js",
1826     "groupTitle": "Chat_Applications"
1827   },
1828   {
1829     "type": "put",
1830     "url": "/api/chat/applications/{id}",
1831     "title": "Update an existing Application",
1832     "examples": [
1833       {
1834         "title": "Example usage:",
1835         "content": "curl https://{domain}/api/chat/applications/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
1836         "type": "json"
1837       }
1838     ],
1839     "name": "updateApplications",
1840     "group": "Chat_Applications",
1841     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1842     "version": "0.0.0",
1843     "filename": "server/api/chatApplication/index.js",
1844     "groupTitle": "Chat_Applications"
1845   },
1846   {
1847     "type": "post",
1848     "url": "/api/chat/groups",
1849     "title": "Creates a new Group",
1850     "examples": [
1851       {
1852         "title": "Example usage:",
1853         "content": "curl https://{domain}/api/chat/groups -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
1854         "type": "json"
1855       }
1856     ],
1857     "name": "CreateGroups",
1858     "group": "Chat_Groups",
1859     "parameter": {
1860       "fields": {
1861         "Body": [
1862           {
1863             "group": "Body",
1864             "type": "String",
1865             "optional": false,
1866             "field": "name",
1867             "description": ""
1868           },
1869           {
1870             "group": "Body",
1871             "type": "String",
1872             "optional": true,
1873             "field": "description",
1874             "description": ""
1875           },
1876           {
1877             "group": "Body",
1878             "type": "Boolean",
1879             "optional": true,
1880             "field": "write",
1881             "description": ""
1882           }
1883         ]
1884       }
1885     },
1886     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1887     "version": "0.0.0",
1888     "filename": "server/api/chatGroup/index.js",
1889     "groupTitle": "Chat_Groups"
1890   },
1891   {
1892     "type": "delete",
1893     "url": "/api/chat/groups/{id}",
1894     "title": "Deletes a Group",
1895     "examples": [
1896       {
1897         "title": "Example usage:",
1898         "content": "curl https://{domain}/api/chat/groups/{id} -v -u {name}:{password} -X DELETE",
1899         "type": "json"
1900       }
1901     ],
1902     "name": "DeleteGroups",
1903     "group": "Chat_Groups",
1904     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1905     "version": "0.0.0",
1906     "filename": "server/api/chatGroup/index.js",
1907     "groupTitle": "Chat_Groups"
1908   },
1909   {
1910     "type": "get",
1911     "url": "/api/chat/groups/describe",
1912     "title": "Gets table info about Groups",
1913     "examples": [
1914       {
1915         "title": "Example usage:",
1916         "content": "curl https://{domain}/api/chat/groups/describe -v -u {name}:{password}",
1917         "type": "json"
1918       }
1919     ],
1920     "name": "DescribeGroups",
1921     "group": "Chat_Groups",
1922     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1923     "version": "0.0.0",
1924     "filename": "server/api/chatGroup/index.js",
1925     "groupTitle": "Chat_Groups"
1926   },
1927   {
1928     "type": "get",
1929     "url": "/api/chat/groups",
1930     "title": "Gets a list of Groups",
1931     "examples": [
1932       {
1933         "title": "Example usage:",
1934         "content": "curl https://{domain}/api/chat/groups -v -u {name}:{password}",
1935         "type": "json"
1936       }
1937     ],
1938     "name": "GetGroups",
1939     "group": "Chat_Groups",
1940     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/chat/groups?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/chat/groups?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/chat/groups?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/chat/groups?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/chat/groups?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
1941     "version": "0.0.0",
1942     "filename": "server/api/chatGroup/index.js",
1943     "groupTitle": "Chat_Groups"
1944   },
1945   {
1946     "type": "delete",
1947     "url": "/api/chat/groups/{id}/members",
1948     "title": "Removes members from a group",
1949     "examples": [
1950       {
1951         "title": "Example usage:",
1952         "content": "curl https://{domain}/api/chat/groups/{id}/members?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
1953         "type": "json"
1954       }
1955     ],
1956     "name": "RemoveMembers",
1957     "group": "Chat_Groups",
1958     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1959     "version": "0.0.0",
1960     "filename": "server/api/chatGroup/index.js",
1961     "groupTitle": "Chat_Groups"
1962   },
1963   {
1964     "type": "get",
1965     "url": "/api/chat/groups/{id}",
1966     "title": "Gets a single Group",
1967     "examples": [
1968       {
1969         "title": "Example usage:",
1970         "content": "curl https://{domain}/api/chat/groups/{id} -v -u {name}:{password}",
1971         "type": "json"
1972       }
1973     ],
1974     "name": "ShowGroups",
1975     "group": "Chat_Groups",
1976     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1977     "version": "0.0.0",
1978     "filename": "server/api/chatGroup/index.js",
1979     "groupTitle": "Chat_Groups"
1980   },
1981   {
1982     "type": "post",
1983     "url": "/api/chat/groups/{id}/members",
1984     "title": "Add members to chat group",
1985     "examples": [
1986       {
1987         "title": "Example usage:",
1988         "content": "curl https://{domain}/api/chat/groups/{id}/members -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
1989         "type": "json"
1990       }
1991     ],
1992     "name": "addMembers",
1993     "group": "Chat_Groups",
1994     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1995     "version": "0.0.0",
1996     "filename": "server/api/chatGroup/index.js",
1997     "groupTitle": "Chat_Groups"
1998   },
1999   {
2000     "type": "post",
2001     "url": "/api/chat/groups/{id}/messages",
2002     "title": "Creates a new group message",
2003     "examples": [
2004       {
2005         "title": "Example usage:",
2006         "content": "curl https://{domain}/api/chat/groups/{id}/messages -d '{\"body\": \"Hi operator!\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
2007         "type": "json"
2008       }
2009     ],
2010     "name": "addMessage",
2011     "group": "Chat_Groups",
2012     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2013     "version": "0.0.0",
2014     "filename": "server/api/chatGroup/index.js",
2015     "groupTitle": "Chat_Groups"
2016   },
2017   {
2018     "type": "get",
2019     "url": "/api/chat/groups/{id}/members",
2020     "title": "Gets Members",
2021     "examples": [
2022       {
2023         "title": "Example usage:",
2024         "content": "curl https://{domain}/api/chat/groups/{id}/members -v -u {name}:{password} -X GET",
2025         "type": "json"
2026       }
2027     ],
2028     "name": "getMembers",
2029     "group": "Chat_Groups",
2030     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2031     "version": "0.0.0",
2032     "filename": "server/api/chatGroup/index.js",
2033     "groupTitle": "Chat_Groups"
2034   },
2035   {
2036     "type": "get",
2037     "url": "/api/chat/groups/{id}/messages",
2038     "title": "Gets Messages",
2039     "examples": [
2040       {
2041         "title": "Example usage:",
2042         "content": "curl https://{domain}/api/chat/groups/{id}/messages -v -u {name}:{password} -X GET",
2043         "type": "json"
2044       }
2045     ],
2046     "name": "getMessages",
2047     "group": "Chat_Groups",
2048     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2049     "version": "0.0.0",
2050     "filename": "server/api/chatGroup/index.js",
2051     "groupTitle": "Chat_Groups"
2052   },
2053   {
2054     "type": "get",
2055     "url": "/api/chat/groups/{id}/unread",
2056     "title": "Get unread chat group messages",
2057     "examples": [
2058       {
2059         "title": "Example usage:",
2060         "content": "curl https://{domain}/api/chat/groups/{id}/unread -H 'Content-Type: application/json' -v -u {name}:{password} -X GET",
2061         "type": "json"
2062       }
2063     ],
2064     "name": "getUread",
2065     "group": "Chat_Groups",
2066     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2067     "version": "0.0.0",
2068     "filename": "server/api/chatGroup/index.js",
2069     "groupTitle": "Chat_Groups"
2070   },
2071   {
2072     "type": "put",
2073     "url": "/api/chat/groups/{id}",
2074     "title": "Update an existing Group",
2075     "examples": [
2076       {
2077         "title": "Example usage:",
2078         "content": "curl https://{domain}/api/chat/groups/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
2079         "type": "json"
2080       }
2081     ],
2082     "name": "updateGroups",
2083     "group": "Chat_Groups",
2084     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2085     "version": "0.0.0",
2086     "filename": "server/api/chatGroup/index.js",
2087     "groupTitle": "Chat_Groups"
2088   },
2089   {
2090     "type": "post",
2091     "url": "/api/chat/interactions/{id}/tags",
2092     "title": "Add tags to the interaction",
2093     "examples": [
2094       {
2095         "title": "Example usage:",
2096         "content": "curl https://{domain}/api/chat/interaction/{id}/tags -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
2097         "type": "json"
2098       }
2099     ],
2100     "name": "AddTags",
2101     "group": "Chat_Interactions",
2102     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2103     "version": "0.0.0",
2104     "filename": "server/api/chatInteraction/index.js",
2105     "groupTitle": "Chat_Interactions"
2106   },
2107   {
2108     "type": "post",
2109     "url": "/api/chat/interactions",
2110     "title": "Creates a new Interaction",
2111     "examples": [
2112       {
2113         "title": "Example usage:",
2114         "content": "curl https://{domain}/api/chat/interactions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
2115         "type": "json"
2116       }
2117     ],
2118     "name": "CreateInteractions",
2119     "group": "Chat_Interactions",
2120     "parameter": {
2121       "fields": {
2122         "Body": [
2123           {
2124             "group": "Body",
2125             "type": "Boolean",
2126             "optional": true,
2127             "field": "closed",
2128             "description": ""
2129           },
2130           {
2131             "group": "Body",
2132             "type": "Integer",
2133             "optional": true,
2134             "field": "ratingValue",
2135             "description": ""
2136           },
2137           {
2138             "group": "Body",
2139             "type": "String",
2140             "allowedValues": [
2141               "\"star\"",
2142               "\"thumb\""
2143             ],
2144             "optional": true,
2145             "field": "ratingType",
2146             "description": ""
2147           },
2148           {
2149             "group": "Body",
2150             "type": "Text",
2151             "optional": true,
2152             "field": "ratingMessage",
2153             "description": ""
2154           },
2155           {
2156             "group": "Body",
2157             "type": "Text",
2158             "optional": true,
2159             "field": "pathTranscript",
2160             "description": ""
2161           },
2162           {
2163             "group": "Body",
2164             "type": "String",
2165             "optional": true,
2166             "field": "mailTranscript",
2167             "description": ""
2168           },
2169           {
2170             "group": "Body",
2171             "type": "String",
2172             "optional": true,
2173             "field": "closedAt",
2174             "description": ""
2175           },
2176           {
2177             "group": "Body",
2178             "type": "String",
2179             "optional": true,
2180             "field": "disposition",
2181             "description": ""
2182           },
2183           {
2184             "group": "Body",
2185             "type": "String",
2186             "optional": true,
2187             "field": "secondDisposition",
2188             "description": ""
2189           },
2190           {
2191             "group": "Body",
2192             "type": "String",
2193             "optional": true,
2194             "field": "thirdDisposition",
2195             "description": ""
2196           },
2197           {
2198             "group": "Body",
2199             "type": "String",
2200             "optional": true,
2201             "field": "note",
2202             "description": ""
2203           },
2204           {
2205             "group": "Body",
2206             "type": "String",
2207             "optional": true,
2208             "field": "browserName",
2209             "description": ""
2210           },
2211           {
2212             "group": "Body",
2213             "type": "String",
2214             "optional": true,
2215             "field": "browserVersion",
2216             "description": ""
2217           },
2218           {
2219             "group": "Body",
2220             "type": "String",
2221             "optional": true,
2222             "field": "osName",
2223             "description": ""
2224           },
2225           {
2226             "group": "Body",
2227             "type": "String",
2228             "optional": true,
2229             "field": "osVersion",
2230             "description": ""
2231           },
2232           {
2233             "group": "Body",
2234             "type": "String",
2235             "optional": true,
2236             "field": "deviceModel",
2237             "description": ""
2238           },
2239           {
2240             "group": "Body",
2241             "type": "String",
2242             "optional": true,
2243             "field": "deviceVendor",
2244             "description": ""
2245           },
2246           {
2247             "group": "Body",
2248             "type": "String",
2249             "optional": true,
2250             "field": "deviceType",
2251             "description": ""
2252           },
2253           {
2254             "group": "Body",
2255             "type": "Text",
2256             "optional": true,
2257             "field": "referer",
2258             "description": ""
2259           },
2260           {
2261             "group": "Body",
2262             "type": "String",
2263             "optional": true,
2264             "field": "customerIp",
2265             "description": ""
2266           },
2267           {
2268             "group": "Body",
2269             "type": "Text",
2270             "optional": true,
2271             "field": "formData",
2272             "description": ""
2273           },
2274           {
2275             "group": "Body",
2276             "type": "String",
2277             "optional": true,
2278             "field": "read1stAt",
2279             "description": ""
2280           },
2281           {
2282             "group": "Body",
2283             "type": "String",
2284             "optional": true,
2285             "field": "lastMsgAt",
2286             "description": ""
2287           },
2288           {
2289             "group": "Body",
2290             "type": "String",
2291             "allowedValues": [
2292               "\"in\"",
2293               "\"out\""
2294             ],
2295             "optional": false,
2296             "field": "lastMsgDirection",
2297             "description": ""
2298           },
2299           {
2300             "group": "Body",
2301             "type": "String",
2302             "optional": true,
2303             "field": "closeReason",
2304             "description": ""
2305           },
2306           {
2307             "group": "Body",
2308             "type": "String",
2309             "optional": true,
2310             "field": "customerPort",
2311             "description": ""
2312           },
2313           {
2314             "group": "Body",
2315             "type": "Text",
2316             "optional": true,
2317             "field": "vidaooSessionId",
2318             "description": ""
2319           }
2320         ]
2321       }
2322     },
2323     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2324     "version": "0.0.0",
2325     "filename": "server/api/chatInteraction/index.js",
2326     "groupTitle": "Chat_Interactions"
2327   },
2328   {
2329     "type": "delete",
2330     "url": "/api/chat/interactions/{id}",
2331     "title": "Deletes a Interaction",
2332     "examples": [
2333       {
2334         "title": "Example usage:",
2335         "content": "curl https://{domain}/api/chat/interactions/{id} -v -u {name}:{password} -X DELETE",
2336         "type": "json"
2337       }
2338     ],
2339     "name": "DeleteInteractions",
2340     "group": "Chat_Interactions",
2341     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2342     "version": "0.0.0",
2343     "filename": "server/api/chatInteraction/index.js",
2344     "groupTitle": "Chat_Interactions"
2345   },
2346   {
2347     "type": "get",
2348     "url": "/api/chat/interactions/describe",
2349     "title": "Gets table info about Interactions",
2350     "examples": [
2351       {
2352         "title": "Example usage:",
2353         "content": "curl https://{domain}/api/chat/interactions/describe -v -u {name}:{password}",
2354         "type": "json"
2355       }
2356     ],
2357     "name": "DescribeInteractions",
2358     "group": "Chat_Interactions",
2359     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2360     "version": "0.0.0",
2361     "filename": "server/api/chatInteraction/index.js",
2362     "groupTitle": "Chat_Interactions"
2363   },
2364   {
2365     "type": "get",
2366     "url": "/api/chat/interactions",
2367     "title": "Gets a list of Interactions",
2368     "examples": [
2369       {
2370         "title": "Example usage:",
2371         "content": "curl https://{domain}/api/chat/interactions -v -u {name}:{password}",
2372         "type": "json"
2373       }
2374     ],
2375     "name": "GetInteractions",
2376     "group": "Chat_Interactions",
2377     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/chat/interactions?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/chat/interactions?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/chat/interactions?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/chat/interactions?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/chat/interactions?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
2378     "version": "0.0.0",
2379     "filename": "server/api/chatInteraction/index.js",
2380     "groupTitle": "Chat_Interactions"
2381   },
2382   {
2383     "type": "delete",
2384     "url": "/api/chat/interactions/{id}/tags",
2385     "title": "Removes tags from interaction",
2386     "examples": [
2387       {
2388         "title": "Example usage:",
2389         "content": "curl https://{domain}/api/chat/interactions/{id}/tags?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
2390         "type": "json"
2391       }
2392     ],
2393     "name": "RemoveTags",
2394     "group": "Chat_Interactions",
2395     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2396     "version": "0.0.0",
2397     "filename": "server/api/chatInteraction/index.js",
2398     "groupTitle": "Chat_Interactions"
2399   },
2400   {
2401     "type": "get",
2402     "url": "/api/chat/interactions/{id}",
2403     "title": "Gets a single Interaction",
2404     "examples": [
2405       {
2406         "title": "Example usage:",
2407         "content": "curl https://{domain}/api/chat/interactions/{id} -v -u {name}:{password}",
2408         "type": "json"
2409       }
2410     ],
2411     "name": "ShowInteractions",
2412     "group": "Chat_Interactions",
2413     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2414     "version": "0.0.0",
2415     "filename": "server/api/chatInteraction/index.js",
2416     "groupTitle": "Chat_Interactions"
2417   },
2418   {
2419     "type": "put",
2420     "url": "/api/chat/interactions/{id}/abandon",
2421     "title": "Abandon interaction",
2422     "examples": [
2423       {
2424         "title": "Example usage:",
2425         "content": "curl https://{domain}/api/chat/interactions/{id}/abandon -d '{\"channel\": \"chat\", \"...\": \"...\"}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
2426         "type": "json"
2427       }
2428     ],
2429     "name": "abandon",
2430     "group": "Chat_Interactions",
2431     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <p>This API is used to set as abandon an interaction and stop the routing.</p>",
2432     "version": "0.0.0",
2433     "filename": "server/api/chatInteraction/index.js",
2434     "groupTitle": "Chat_Interactions"
2435   },
2436   {
2437     "type": "put",
2438     "url": "/api/chat/interactions/{id}/close",
2439     "title": "Close Interaction",
2440     "examples": [
2441       {
2442         "title": "Example usage:",
2443         "content": "curl https://{domain}/api/chat/interactions/{id}/close -d '[{\"to\": \"+3901119886500\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
2444         "type": "json"
2445       }
2446     ],
2447     "name": "addMessage",
2448     "group": "Chat_Interactions",
2449     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2450     "version": "0.0.0",
2451     "filename": "server/api/chatInteraction/index.js",
2452     "groupTitle": "Chat_Interactions"
2453   },
2454   {
2455     "type": "post",
2456     "url": "/api/chat/interactions/{id}/messages",
2457     "title": "Creates new messages",
2458     "examples": [
2459       {
2460         "title": "Example usage:",
2461         "content": "curl https://{domain}/api/chat/interactions/{id}/messages -d '[{\"to\": \"+3901119886500\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
2462         "type": "json"
2463       }
2464     ],
2465     "name": "addMessage",
2466     "group": "Chat_Interactions",
2467     "parameter": {
2468       "fields": {
2469         "Body": [
2470           {
2471             "group": "Body",
2472             "type": "Text",
2473             "optional": false,
2474             "field": "body",
2475             "description": ""
2476           },
2477           {
2478             "group": "Body",
2479             "type": "Boolean",
2480             "optional": true,
2481             "field": "read",
2482             "description": ""
2483           },
2484           {
2485             "group": "Body",
2486             "type": "Boolean",
2487             "optional": true,
2488             "field": "secret",
2489             "description": ""
2490           },
2491           {
2492             "group": "Body",
2493             "type": "String",
2494             "allowedValues": [
2495               "\"in\"",
2496               "\"out\""
2497             ],
2498             "optional": false,
2499             "field": "direction",
2500             "description": ""
2501           },
2502           {
2503             "group": "Body",
2504             "type": "String",
2505             "optional": true,
2506             "field": "readAt",
2507             "description": ""
2508           },
2509           {
2510             "group": "Body",
2511             "type": "String",
2512             "optional": true,
2513             "field": "providerName",
2514             "description": ""
2515           },
2516           {
2517             "group": "Body",
2518             "type": "Text",
2519             "optional": true,
2520             "field": "providerResponse",
2521             "description": ""
2522           }
2523         ]
2524       }
2525     },
2526     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2527     "version": "0.0.0",
2528     "filename": "server/api/chatInteraction/index.js",
2529     "groupTitle": "Chat_Interactions"
2530   },
2531   {
2532     "type": "post",
2533     "url": "/api/chat/interactions/{id}/attachment_upload",
2534     "title": "Add attachment",
2535     "examples": [
2536       {
2537         "title": "Example usage:",
2538         "content": "curl https://{domain}/api/chat/interactions/{id}/attachment_upload -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
2539         "type": "json"
2540       }
2541     ],
2542     "name": "attachmentUpload",
2543     "group": "Chat_Interactions",
2544     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2545     "version": "0.0.0",
2546     "filename": "server/api/chatInteraction/index.js",
2547     "groupTitle": "Chat_Interactions"
2548   },
2549   {
2550     "type": "post",
2551     "url": "/api/chat/interactions/{id}/vidaoo",
2552     "title": "Create Vidaoo Session",
2553     "examples": [
2554       {
2555         "title": "Example usage:",
2556         "content": "curl https://{domain}/api/chat/interactions/{id}/vidaoo  -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
2557         "type": "json"
2558       }
2559     ],
2560     "name": "createVidaooSession",
2561     "group": "Chat_Interactions",
2562     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2563     "version": "0.0.0",
2564     "filename": "server/api/chatInteraction/index.js",
2565     "groupTitle": "Chat_Interactions"
2566   },
2567   {
2568     "type": "put",
2569     "url": "/api/chat/interactions/{id}/custom_update",
2570     "title": "Update interaction",
2571     "examples": [
2572       {
2573         "title": "Example usage:",
2574         "content": "curl https://{domain}/api/chat/interactions/{id}/custom_update -d '{\"channel\": \"chat\", \"...\": \"...\"}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
2575         "type": "json"
2576       }
2577     ],
2578     "name": "customUpdate",
2579     "group": "Chat_Interactions",
2580     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <p>This API is used to update an interaction.</p>",
2581     "version": "0.0.0",
2582     "filename": "server/api/chatInteraction/index.js",
2583     "groupTitle": "Chat_Interactions"
2584   },
2585   {
2586     "type": "get",
2587     "url": "/api/chat/interactions/{id}/download",
2588     "title": "Gets interaction",
2589     "examples": [
2590       {
2591         "title": "Example usage:",
2592         "content": "curl https://{domain}/api/chat/interactions/{id}/download -v -u {name}:{password} -X GET",
2593         "type": "json"
2594       }
2595     ],
2596     "name": "download",
2597     "group": "Chat_Interactions",
2598     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2599     "version": "0.0.0",
2600     "filename": "server/api/chatInteraction/index.js",
2601     "groupTitle": "Chat_Interactions"
2602   },
2603   {
2604     "type": "get",
2605     "url": "/api/chat/interactions/{id}/messages",
2606     "title": "Gets interaction messages",
2607     "examples": [
2608       {
2609         "title": "Example usage:",
2610         "content": "curl https://{domain}/api/chat/interactions/{id}/messages -v -u {name}:{password} -X GET",
2611         "type": "json"
2612       }
2613     ],
2614     "name": "getMessages",
2615     "group": "Chat_Interactions",
2616     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2617     "version": "0.0.0",
2618     "filename": "server/api/chatInteraction/index.js",
2619     "groupTitle": "Chat_Interactions"
2620   },
2621   {
2622     "type": "get",
2623     "url": "/api/chat/interactions/{id}/my_messages",
2624     "title": "Gets interaction messages",
2625     "examples": [
2626       {
2627         "title": "Example usage:",
2628         "content": "curl https://{domain}/api/chat/interactions/{id}/my_messages -v -u {name}:{password} -X GET",
2629         "type": "json"
2630       }
2631     ],
2632     "name": "getMyMessages",
2633     "group": "Chat_Interactions",
2634     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2635     "version": "0.0.0",
2636     "filename": "server/api/chatInteraction/index.js",
2637     "groupTitle": "Chat_Interactions"
2638   },
2639   {
2640     "type": "put",
2641     "url": "/api/chat/interactions/{id}",
2642     "title": "Update an existing Interaction",
2643     "examples": [
2644       {
2645         "title": "Example usage:",
2646         "content": "curl https://{domain}/api/chat/interactions/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
2647         "type": "json"
2648       }
2649     ],
2650     "name": "updateInteractions",
2651     "group": "Chat_Interactions",
2652     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2653     "version": "0.0.0",
2654     "filename": "server/api/chatInteraction/index.js",
2655     "groupTitle": "Chat_Interactions"
2656   },
2657   {
2658     "type": "post",
2659     "url": "/api/chat/internal/messages",
2660     "title": "Creates a new Message",
2661     "examples": [
2662       {
2663         "title": "Example usage:",
2664         "content": "curl https://{domain}/api/chat/internal/messages -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
2665         "type": "json"
2666       }
2667     ],
2668     "name": "CreateMessages",
2669     "group": "Chat_Internal_Messages",
2670     "parameter": {
2671       "fields": {
2672         "Body": [
2673           {
2674             "group": "Body",
2675             "type": "Text",
2676             "optional": false,
2677             "field": "body",
2678             "description": ""
2679           },
2680           {
2681             "group": "Body",
2682             "type": "Boolean",
2683             "optional": true,
2684             "field": "read",
2685             "description": ""
2686           },
2687           {
2688             "group": "Body",
2689             "type": "Integer",
2690             "optional": true,
2691             "field": "ChatInternalMessageId",
2692             "description": ""
2693           }
2694         ]
2695       }
2696     },
2697     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2698     "version": "0.0.0",
2699     "filename": "server/api/chatInternalMessage/index.js",
2700     "groupTitle": "Chat_Internal_Messages"
2701   },
2702   {
2703     "type": "delete",
2704     "url": "/api/chat/internal/messages/{id}",
2705     "title": "Deletes a Message",
2706     "examples": [
2707       {
2708         "title": "Example usage:",
2709         "content": "curl https://{domain}/api/chat/internal/messages/{id} -v -u {name}:{password} -X DELETE",
2710         "type": "json"
2711       }
2712     ],
2713     "name": "DeleteMessages",
2714     "group": "Chat_Internal_Messages",
2715     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2716     "version": "0.0.0",
2717     "filename": "server/api/chatInternalMessage/index.js",
2718     "groupTitle": "Chat_Internal_Messages"
2719   },
2720   {
2721     "type": "get",
2722     "url": "/api/chat/internal/messages/describe",
2723     "title": "Gets table info about Messages",
2724     "examples": [
2725       {
2726         "title": "Example usage:",
2727         "content": "curl https://{domain}/api/chat/internal/messages/describe -v -u {name}:{password}",
2728         "type": "json"
2729       }
2730     ],
2731     "name": "DescribeMessages",
2732     "group": "Chat_Internal_Messages",
2733     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2734     "version": "0.0.0",
2735     "filename": "server/api/chatInternalMessage/index.js",
2736     "groupTitle": "Chat_Internal_Messages"
2737   },
2738   {
2739     "type": "get",
2740     "url": "/api/chat/internal/messages",
2741     "title": "Gets a list of Messages",
2742     "examples": [
2743       {
2744         "title": "Example usage:",
2745         "content": "curl https://{domain}/api/chat/internal/messages -v -u {name}:{password}",
2746         "type": "json"
2747       }
2748     ],
2749     "name": "GetMessages",
2750     "group": "Chat_Internal_Messages",
2751     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/chat/internal/messages?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/chat/internal/messages?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/chat/internal/messages?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/chat/internal/messages?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/chat/internal/messages?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
2752     "version": "0.0.0",
2753     "filename": "server/api/chatInternalMessage/index.js",
2754     "groupTitle": "Chat_Internal_Messages"
2755   },
2756   {
2757     "type": "get",
2758     "url": "/api/chat/internal/messages/{id}",
2759     "title": "Gets a single Message",
2760     "examples": [
2761       {
2762         "title": "Example usage:",
2763         "content": "curl https://{domain}/api/chat/internal/messages/{id} -v -u {name}:{password}",
2764         "type": "json"
2765       }
2766     ],
2767     "name": "ShowMessages",
2768     "group": "Chat_Internal_Messages",
2769     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2770     "version": "0.0.0",
2771     "filename": "server/api/chatInternalMessage/index.js",
2772     "groupTitle": "Chat_Internal_Messages"
2773   },
2774   {
2775     "type": "put",
2776     "url": "/api/chat/internal/messages/{id}",
2777     "title": "Update an existing Message",
2778     "examples": [
2779       {
2780         "title": "Example usage:",
2781         "content": "curl https://{domain}/api/chat/internal/messages/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
2782         "type": "json"
2783       }
2784     ],
2785     "name": "updateMessages",
2786     "group": "Chat_Internal_Messages",
2787     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2788     "version": "0.0.0",
2789     "filename": "server/api/chatInternalMessage/index.js",
2790     "groupTitle": "Chat_Internal_Messages"
2791   },
2792   {
2793     "type": "post",
2794     "url": "/api/chat/messages",
2795     "title": "Creates a new Message",
2796     "examples": [
2797       {
2798         "title": "Example usage:",
2799         "content": "curl https://{domain}/api/chat/messages -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
2800         "type": "json"
2801       }
2802     ],
2803     "name": "CreateMessages",
2804     "group": "Chat_Messages",
2805     "parameter": {
2806       "fields": {
2807         "Body": [
2808           {
2809             "group": "Body",
2810             "type": "Text",
2811             "optional": false,
2812             "field": "body",
2813             "description": ""
2814           },
2815           {
2816             "group": "Body",
2817             "type": "Boolean",
2818             "optional": true,
2819             "field": "read",
2820             "description": ""
2821           },
2822           {
2823             "group": "Body",
2824             "type": "Boolean",
2825             "optional": true,
2826             "field": "secret",
2827             "description": ""
2828           },
2829           {
2830             "group": "Body",
2831             "type": "String",
2832             "allowedValues": [
2833               "\"in\"",
2834               "\"out\""
2835             ],
2836             "optional": false,
2837             "field": "direction",
2838             "description": ""
2839           },
2840           {
2841             "group": "Body",
2842             "type": "String",
2843             "optional": true,
2844             "field": "readAt",
2845             "description": ""
2846           },
2847           {
2848             "group": "Body",
2849             "type": "String",
2850             "optional": true,
2851             "field": "providerName",
2852             "description": ""
2853           },
2854           {
2855             "group": "Body",
2856             "type": "Text",
2857             "optional": true,
2858             "field": "providerResponse",
2859             "description": ""
2860           }
2861         ]
2862       }
2863     },
2864     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2865     "version": "0.0.0",
2866     "filename": "server/api/chatMessage/index.js",
2867     "groupTitle": "Chat_Messages"
2868   },
2869   {
2870     "type": "delete",
2871     "url": "/api/chat/messages/{id}",
2872     "title": "Deletes a Message",
2873     "examples": [
2874       {
2875         "title": "Example usage:",
2876         "content": "curl https://{domain}/api/chat/messages/{id} -v -u {name}:{password} -X DELETE",
2877         "type": "json"
2878       }
2879     ],
2880     "name": "DeleteMessages",
2881     "group": "Chat_Messages",
2882     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2883     "version": "0.0.0",
2884     "filename": "server/api/chatMessage/index.js",
2885     "groupTitle": "Chat_Messages"
2886   },
2887   {
2888     "type": "get",
2889     "url": "/api/chat/messages/describe",
2890     "title": "Gets table info about Messages",
2891     "examples": [
2892       {
2893         "title": "Example usage:",
2894         "content": "curl https://{domain}/api/chat/messages/describe -v -u {name}:{password}",
2895         "type": "json"
2896       }
2897     ],
2898     "name": "DescribeMessages",
2899     "group": "Chat_Messages",
2900     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2901     "version": "0.0.0",
2902     "filename": "server/api/chatMessage/index.js",
2903     "groupTitle": "Chat_Messages"
2904   },
2905   {
2906     "type": "get",
2907     "url": "/api/chat/messages",
2908     "title": "Gets a list of Messages",
2909     "examples": [
2910       {
2911         "title": "Example usage:",
2912         "content": "curl https://{domain}/api/chat/messages -v -u {name}:{password}",
2913         "type": "json"
2914       }
2915     ],
2916     "name": "GetMessages",
2917     "group": "Chat_Messages",
2918     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/chat/messages?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/chat/messages?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/chat/messages?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/chat/messages?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/chat/messages?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
2919     "version": "0.0.0",
2920     "filename": "server/api/chatMessage/index.js",
2921     "groupTitle": "Chat_Messages"
2922   },
2923   {
2924     "type": "get",
2925     "url": "/api/chat/messages/{id}",
2926     "title": "Gets a single Message",
2927     "examples": [
2928       {
2929         "title": "Example usage:",
2930         "content": "curl https://{domain}/api/chat/messages/{id} -v -u {name}:{password}",
2931         "type": "json"
2932       }
2933     ],
2934     "name": "ShowMessages",
2935     "group": "Chat_Messages",
2936     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2937     "version": "0.0.0",
2938     "filename": "server/api/chatMessage/index.js",
2939     "groupTitle": "Chat_Messages"
2940   },
2941   {
2942     "type": "put",
2943     "url": "/api/chat/messages/{id}",
2944     "title": "Update an existing Message",
2945     "examples": [
2946       {
2947         "title": "Example usage:",
2948         "content": "curl https://{domain}/api/chat/messages/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
2949         "type": "json"
2950       }
2951     ],
2952     "name": "updateMessages",
2953     "group": "Chat_Messages",
2954     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2955     "version": "0.0.0",
2956     "filename": "server/api/chatMessage/index.js",
2957     "groupTitle": "Chat_Messages"
2958   },
2959   {
2960     "type": "post",
2961     "url": "/api/chat/offline_messages",
2962     "title": "Creates a new OfflineMessage",
2963     "examples": [
2964       {
2965         "title": "Example usage:",
2966         "content": "curl https://{domain}/api/chat/offline_messages -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
2967         "type": "json"
2968       }
2969     ],
2970     "name": "CreateOfflineMessages",
2971     "group": "Chat_Offline_Messages",
2972     "parameter": {
2973       "fields": {
2974         "Body": [
2975           {
2976             "group": "Body",
2977             "type": "Text",
2978             "optional": false,
2979             "field": "body",
2980             "description": ""
2981           }
2982         ]
2983       }
2984     },
2985     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2986     "version": "0.0.0",
2987     "filename": "server/api/chatOfflineMessage/index.js",
2988     "groupTitle": "Chat_Offline_Messages"
2989   },
2990   {
2991     "type": "delete",
2992     "url": "/api/chat/offline_messages/{id}",
2993     "title": "Deletes a OfflineMessage",
2994     "examples": [
2995       {
2996         "title": "Example usage:",
2997         "content": "curl https://{domain}/api/chat/offline_messages/{id} -v -u {name}:{password} -X DELETE",
2998         "type": "json"
2999       }
3000     ],
3001     "name": "DeleteOfflineMessages",
3002     "group": "Chat_Offline_Messages",
3003     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3004     "version": "0.0.0",
3005     "filename": "server/api/chatOfflineMessage/index.js",
3006     "groupTitle": "Chat_Offline_Messages"
3007   },
3008   {
3009     "type": "get",
3010     "url": "/api/chat/offline_messages/describe",
3011     "title": "Gets table info about OfflineMessages",
3012     "examples": [
3013       {
3014         "title": "Example usage:",
3015         "content": "curl https://{domain}/api/chat/offline_messages/describe -v -u {name}:{password}",
3016         "type": "json"
3017       }
3018     ],
3019     "name": "DescribeOfflineMessages",
3020     "group": "Chat_Offline_Messages",
3021     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3022     "version": "0.0.0",
3023     "filename": "server/api/chatOfflineMessage/index.js",
3024     "groupTitle": "Chat_Offline_Messages"
3025   },
3026   {
3027     "type": "get",
3028     "url": "/api/chat/offline_messages",
3029     "title": "Gets a list of OfflineMessages",
3030     "examples": [
3031       {
3032         "title": "Example usage:",
3033         "content": "curl https://{domain}/api/chat/offline_messages -v -u {name}:{password}",
3034         "type": "json"
3035       }
3036     ],
3037     "name": "GetOfflineMessages",
3038     "group": "Chat_Offline_Messages",
3039     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/chat/offline_messages?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/chat/offline_messages?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/chat/offline_messages?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/chat/offline_messages?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/chat/offline_messages?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
3040     "version": "0.0.0",
3041     "filename": "server/api/chatOfflineMessage/index.js",
3042     "groupTitle": "Chat_Offline_Messages"
3043   },
3044   {
3045     "type": "get",
3046     "url": "/api/chat/offline_messages/{id}",
3047     "title": "Gets a single OfflineMessage",
3048     "examples": [
3049       {
3050         "title": "Example usage:",
3051         "content": "curl https://{domain}/api/chat/offline_messages/{id} -v -u {name}:{password}",
3052         "type": "json"
3053       }
3054     ],
3055     "name": "ShowOfflineMessages",
3056     "group": "Chat_Offline_Messages",
3057     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3058     "version": "0.0.0",
3059     "filename": "server/api/chatOfflineMessage/index.js",
3060     "groupTitle": "Chat_Offline_Messages"
3061   },
3062   {
3063     "type": "put",
3064     "url": "/api/chat/offline_messages/{id}",
3065     "title": "Update an existing OfflineMessage",
3066     "examples": [
3067       {
3068         "title": "Example usage:",
3069         "content": "curl https://{domain}/api/chat/offline_messages/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
3070         "type": "json"
3071       }
3072     ],
3073     "name": "updateOfflineMessages",
3074     "group": "Chat_Offline_Messages",
3075     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3076     "version": "0.0.0",
3077     "filename": "server/api/chatOfflineMessage/index.js",
3078     "groupTitle": "Chat_Offline_Messages"
3079   },
3080   {
3081     "type": "post",
3082     "url": "/api/chat/proactive_actions",
3083     "title": "Creates a new Proactive Action",
3084     "examples": [
3085       {
3086         "title": "Example usage:",
3087         "content": "curl https://{domain}/api/chat/proactive_actions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
3088         "type": "json"
3089       }
3090     ],
3091     "name": "CreateProactive_Actions",
3092     "group": "Chat_Proactive_Actions",
3093     "parameter": {
3094       "fields": {
3095         "Body": [
3096           {
3097             "group": "Body",
3098             "type": "String",
3099             "optional": false,
3100             "field": "name",
3101             "description": ""
3102           },
3103           {
3104             "group": "Body",
3105             "type": "String",
3106             "allowedValues": [
3107               "\"mouseOver\"",
3108               "\"timeout\""
3109             ],
3110             "optional": true,
3111             "field": "type",
3112             "description": ""
3113           },
3114           {
3115             "group": "Body",
3116             "type": "String",
3117             "optional": true,
3118             "field": "selector",
3119             "description": ""
3120           },
3121           {
3122             "group": "Body",
3123             "type": "Integer",
3124             "optional": true,
3125             "field": "timeout",
3126             "description": ""
3127           }
3128         ]
3129       }
3130     },
3131     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3132     "version": "0.0.0",
3133     "filename": "server/api/chatProactiveAction/index.js",
3134     "groupTitle": "Chat_Proactive_Actions"
3135   },
3136   {
3137     "type": "delete",
3138     "url": "/api/chat/proactive_actions/{id}",
3139     "title": "Deletes a Proactive Action",
3140     "examples": [
3141       {
3142         "title": "Example usage:",
3143         "content": "curl https://{domain}/api/chat/proactive_actions/{id} -v -u {name}:{password} -X DELETE",
3144         "type": "json"
3145       }
3146     ],
3147     "name": "DeleteProactive_Actions",
3148     "group": "Chat_Proactive_Actions",
3149     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3150     "version": "0.0.0",
3151     "filename": "server/api/chatProactiveAction/index.js",
3152     "groupTitle": "Chat_Proactive_Actions"
3153   },
3154   {
3155     "type": "get",
3156     "url": "/api/chat/proactive_actions/{id}",
3157     "title": "Gets a single Proactive Action",
3158     "examples": [
3159       {
3160         "title": "Example usage:",
3161         "content": "curl https://{domain}/api/chat/proactive_actions/{id} -v -u {name}:{password}",
3162         "type": "json"
3163       }
3164     ],
3165     "name": "ShowProactive_Actions",
3166     "group": "Chat_Proactive_Actions",
3167     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3168     "version": "0.0.0",
3169     "filename": "server/api/chatProactiveAction/index.js",
3170     "groupTitle": "Chat_Proactive_Actions"
3171   },
3172   {
3173     "type": "put",
3174     "url": "/api/chat/proactive_actions/{id}",
3175     "title": "Update an existing Proactive Action",
3176     "examples": [
3177       {
3178         "title": "Example usage:",
3179         "content": "curl https://{domain}/api/chat/proactive_actions/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
3180         "type": "json"
3181       }
3182     ],
3183     "name": "updateProactive_Actions",
3184     "group": "Chat_Proactive_Actions",
3185     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3186     "version": "0.0.0",
3187     "filename": "server/api/chatProactiveAction/index.js",
3188     "groupTitle": "Chat_Proactive_Actions"
3189   },
3190   {
3191     "type": "post",
3192     "url": "/api/chat/reports/queue",
3193     "title": "Creates a new Chat Queue Report",
3194     "examples": [
3195       {
3196         "title": "Example usage:",
3197         "content": "curl https://{domain}/api/chat/reports/queue -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
3198         "type": "json"
3199       }
3200     ],
3201     "name": "CreateChat_Queue_Reports",
3202     "group": "Chat_Queue_Reports",
3203     "parameter": {
3204       "fields": {
3205         "Body": [
3206           {
3207             "group": "Body",
3208             "type": "String",
3209             "optional": false,
3210             "field": "uniqueid",
3211             "description": ""
3212           },
3213           {
3214             "group": "Body",
3215             "type": "String",
3216             "optional": true,
3217             "field": "from",
3218             "description": ""
3219           },
3220           {
3221             "group": "Body",
3222             "type": "String",
3223             "optional": true,
3224             "field": "joinAt",
3225             "description": ""
3226           },
3227           {
3228             "group": "Body",
3229             "type": "String",
3230             "optional": true,
3231             "field": "leaveAt",
3232             "description": ""
3233           },
3234           {
3235             "group": "Body",
3236             "type": "String",
3237             "optional": true,
3238             "field": "acceptAt",
3239             "description": ""
3240           },
3241           {
3242             "group": "Body",
3243             "type": "String",
3244             "optional": true,
3245             "field": "exitAt",
3246             "description": ""
3247           },
3248           {
3249             "group": "Body",
3250             "type": "String",
3251             "optional": true,
3252             "field": "reason",
3253             "description": ""
3254           }
3255         ]
3256       }
3257     },
3258     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3259     "version": "0.0.0",
3260     "filename": "server/api/chatQueueReport/index.js",
3261     "groupTitle": "Chat_Queue_Reports"
3262   },
3263   {
3264     "type": "delete",
3265     "url": "/api/chat/reports/queue/{id}",
3266     "title": "Deletes a Chat Queue Report",
3267     "examples": [
3268       {
3269         "title": "Example usage:",
3270         "content": "curl https://{domain}/api/chat/reports/queue/{id} -v -u {name}:{password} -X DELETE",
3271         "type": "json"
3272       }
3273     ],
3274     "name": "DeleteChat_Queue_Reports",
3275     "group": "Chat_Queue_Reports",
3276     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3277     "version": "0.0.0",
3278     "filename": "server/api/chatQueueReport/index.js",
3279     "groupTitle": "Chat_Queue_Reports"
3280   },
3281   {
3282     "type": "get",
3283     "url": "/api/chat/reports/queue/describe",
3284     "title": "Gets table info about Chat Queue Reports",
3285     "examples": [
3286       {
3287         "title": "Example usage:",
3288         "content": "curl https://{domain}/api/chat/reports/queue/describe -v -u {name}:{password}",
3289         "type": "json"
3290       }
3291     ],
3292     "name": "DescribeChat_Queue_Reports",
3293     "group": "Chat_Queue_Reports",
3294     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3295     "version": "0.0.0",
3296     "filename": "server/api/chatQueueReport/index.js",
3297     "groupTitle": "Chat_Queue_Reports"
3298   },
3299   {
3300     "type": "get",
3301     "url": "/api/chat/reports/queue",
3302     "title": "Gets a list of Chat Queue Reports",
3303     "examples": [
3304       {
3305         "title": "Example usage:",
3306         "content": "curl https://{domain}/api/chat/reports/queue -v -u {name}:{password}",
3307         "type": "json"
3308       }
3309     ],
3310     "name": "GetChat_Queue_Reports",
3311     "group": "Chat_Queue_Reports",
3312     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/chat/reports/queue?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/chat/reports/queue?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/chat/reports/queue?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/chat/reports/queue?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/chat/reports/queue?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
3313     "version": "0.0.0",
3314     "filename": "server/api/chatQueueReport/index.js",
3315     "groupTitle": "Chat_Queue_Reports"
3316   },
3317   {
3318     "type": "get",
3319     "url": "/api/chat/reports/queue/{id}",
3320     "title": "Gets a single Chat Queue Report",
3321     "examples": [
3322       {
3323         "title": "Example usage:",
3324         "content": "curl https://{domain}/api/chat/reports/queue/{id} -v -u {name}:{password}",
3325         "type": "json"
3326       }
3327     ],
3328     "name": "ShowChat_Queue_Reports",
3329     "group": "Chat_Queue_Reports",
3330     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3331     "version": "0.0.0",
3332     "filename": "server/api/chatQueueReport/index.js",
3333     "groupTitle": "Chat_Queue_Reports"
3334   },
3335   {
3336     "type": "put",
3337     "url": "/api/chat/reports/queue/{id}",
3338     "title": "Update an existing Chat Queue Report",
3339     "examples": [
3340       {
3341         "title": "Example usage:",
3342         "content": "curl https://{domain}/api/chat/reports/queue/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
3343         "type": "json"
3344       }
3345     ],
3346     "name": "updateChat_Queue_Reports",
3347     "group": "Chat_Queue_Reports",
3348     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3349     "version": "0.0.0",
3350     "filename": "server/api/chatQueueReport/index.js",
3351     "groupTitle": "Chat_Queue_Reports"
3352   },
3353   {
3354     "type": "post",
3355     "url": "/api/chat/queues/{id}/users",
3356     "title": "Add agents to a queue",
3357     "examples": [
3358       {
3359         "title": "Example usage:",
3360         "content": "curl https://{domain}/api/chat/queues/{id}/users -d '{\"ids\": [1,2], \"penalty\": 2}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
3361         "type": "json"
3362       }
3363     ],
3364     "name": "AddAgents",
3365     "group": "Chat_Queues",
3366     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3367     "version": "0.0.0",
3368     "filename": "server/api/chatQueue/index.js",
3369     "groupTitle": "Chat_Queues"
3370   },
3371   {
3372     "type": "post",
3373     "url": "/api/chat/queues/{id}/teams",
3374     "title": "Add teams to a queue",
3375     "examples": [
3376       {
3377         "title": "Example usage:",
3378         "content": "curl https://{domain}/api/chat/queues/{id}/teams -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
3379         "type": "json"
3380       }
3381     ],
3382     "name": "AddTeams",
3383     "group": "Chat_Queues",
3384     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3385     "version": "0.0.0",
3386     "filename": "server/api/chatQueue/index.js",
3387     "groupTitle": "Chat_Queues"
3388   },
3389   {
3390     "type": "post",
3391     "url": "/api/chat/queues",
3392     "title": "Creates a new Queue",
3393     "examples": [
3394       {
3395         "title": "Example usage:",
3396         "content": "curl https://{domain}/api/chat/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
3397         "type": "json"
3398       }
3399     ],
3400     "name": "CreateQueues",
3401     "group": "Chat_Queues",
3402     "parameter": {
3403       "fields": {
3404         "Body": [
3405           {
3406             "group": "Body",
3407             "type": "String",
3408             "optional": false,
3409             "field": "name",
3410             "description": ""
3411           },
3412           {
3413             "group": "Body",
3414             "type": "String",
3415             "optional": true,
3416             "field": "description",
3417             "description": ""
3418           },
3419           {
3420             "group": "Body",
3421             "type": "Integer",
3422             "optional": true,
3423             "field": "timeout",
3424             "description": ""
3425           },
3426           {
3427             "group": "Body",
3428             "type": "String",
3429             "allowedValues": [
3430               "\"rrmemory\"",
3431               "\"beepall\"",
3432               "\"roundrobin\""
3433             ],
3434             "optional": true,
3435             "field": "strategy",
3436             "description": ""
3437           }
3438         ]
3439       }
3440     },
3441     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3442     "version": "0.0.0",
3443     "filename": "server/api/chatQueue/index.js",
3444     "groupTitle": "Chat_Queues"
3445   },
3446   {
3447     "type": "delete",
3448     "url": "/api/chat/queues/{id}",
3449     "title": "Deletes a Queue",
3450     "examples": [
3451       {
3452         "title": "Example usage:",
3453         "content": "curl https://{domain}/api/chat/queues/{id} -v -u {name}:{password} -X DELETE",
3454         "type": "json"
3455       }
3456     ],
3457     "name": "DeleteQueues",
3458     "group": "Chat_Queues",
3459     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3460     "version": "0.0.0",
3461     "filename": "server/api/chatQueue/index.js",
3462     "groupTitle": "Chat_Queues"
3463   },
3464   {
3465     "type": "get",
3466     "url": "/api/chat/queues/describe",
3467     "title": "Gets table info about Queues",
3468     "examples": [
3469       {
3470         "title": "Example usage:",
3471         "content": "curl https://{domain}/api/chat/queues/describe -v -u {name}:{password}",
3472         "type": "json"
3473       }
3474     ],
3475     "name": "DescribeQueues",
3476     "group": "Chat_Queues",
3477     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3478     "version": "0.0.0",
3479     "filename": "server/api/chatQueue/index.js",
3480     "groupTitle": "Chat_Queues"
3481   },
3482   {
3483     "type": "get",
3484     "url": "/api/chat/queues/{id}/users",
3485     "title": "Gets queue agents",
3486     "examples": [
3487       {
3488         "title": "Example usage:",
3489         "content": "curl https://{domain}/api/chat/queues/{id}/users -v -u {name}:{password} -X POST",
3490         "type": "json"
3491       }
3492     ],
3493     "name": "GetAgents",
3494     "group": "Chat_Queues",
3495     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3496     "version": "0.0.0",
3497     "filename": "server/api/chatQueue/index.js",
3498     "groupTitle": "Chat_Queues"
3499   },
3500   {
3501     "type": "get",
3502     "url": "/api/chat/queues/{id}/members",
3503     "title": "GetMembers",
3504     "examples": [
3505       {
3506         "title": "Example usage:",
3507         "content": "curl https://{domain}/api/chat/queues/{id}/members  -v -u {name}:{password}",
3508         "type": "json"
3509       }
3510     ],
3511     "name": "GetMembers",
3512     "group": "Chat_Queues",
3513     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3514     "version": "0.0.0",
3515     "filename": "server/api/chatQueue/index.js",
3516     "groupTitle": "Chat_Queues"
3517   },
3518   {
3519     "type": "get",
3520     "url": "/api/chat/queues",
3521     "title": "Gets a list of Queues",
3522     "examples": [
3523       {
3524         "title": "Example usage:",
3525         "content": "curl https://{domain}/api/chat/queues -v -u {name}:{password}",
3526         "type": "json"
3527       }
3528     ],
3529     "name": "GetQueues",
3530     "group": "Chat_Queues",
3531     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/chat/queues?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/chat/queues?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/chat/queues?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/chat/queues?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/chat/queues?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
3532     "version": "0.0.0",
3533     "filename": "server/api/chatQueue/index.js",
3534     "groupTitle": "Chat_Queues"
3535   },
3536   {
3537     "type": "get",
3538     "url": "/api/chat/queues/{id}/teams",
3539     "title": "Gets queues list",
3540     "examples": [
3541       {
3542         "title": "Example usage:",
3543         "content": "curl https://{domain}/api/chat/queues/{id}/teams -v -u {name}:{password}",
3544         "type": "json"
3545       }
3546     ],
3547     "name": "GetTeams",
3548     "group": "Chat_Queues",
3549     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3550     "version": "0.0.0",
3551     "filename": "server/api/chatQueue/index.js",
3552     "groupTitle": "Chat_Queues"
3553   },
3554   {
3555     "type": "delete",
3556     "url": "/api/chat/queues/{id}/users",
3557     "title": "Removes agents from a queue",
3558     "examples": [
3559       {
3560         "title": "Example usage:",
3561         "content": "curl https://{domain}/api/chat/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
3562         "type": "json"
3563       }
3564     ],
3565     "name": "RemoveAgents",
3566     "group": "Chat_Queues",
3567     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3568     "version": "0.0.0",
3569     "filename": "server/api/chatQueue/index.js",
3570     "groupTitle": "Chat_Queues"
3571   },
3572   {
3573     "type": "get",
3574     "url": "/api/chat/queues/{id}",
3575     "title": "Gets a single Queue",
3576     "examples": [
3577       {
3578         "title": "Example usage:",
3579         "content": "curl https://{domain}/api/chat/queues/{id} -v -u {name}:{password}",
3580         "type": "json"
3581       }
3582     ],
3583     "name": "ShowQueues",
3584     "group": "Chat_Queues",
3585     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3586     "version": "0.0.0",
3587     "filename": "server/api/chatQueue/index.js",
3588     "groupTitle": "Chat_Queues"
3589   },
3590   {
3591     "type": "put",
3592     "url": "/api/chat/queues/{id}",
3593     "title": "Update an existing Queue",
3594     "examples": [
3595       {
3596         "title": "Example usage:",
3597         "content": "curl https://{domain}/api/chat/queues/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
3598         "type": "json"
3599       }
3600     ],
3601     "name": "updateQueues",
3602     "group": "Chat_Queues",
3603     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3604     "version": "0.0.0",
3605     "filename": "server/api/chatQueue/index.js",
3606     "groupTitle": "Chat_Queues"
3607   },
3608   {
3609     "type": "post",
3610     "url": "/api/chat/reports/transfer",
3611     "title": "Creates a new Chat Transfer Report",
3612     "examples": [
3613       {
3614         "title": "Example usage:",
3615         "content": "curl https://{domain}/api/chat/reports/transfer -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
3616         "type": "json"
3617       }
3618     ],
3619     "name": "CreateChat_Transfer_Reports",
3620     "group": "Chat_Transfer_Reports",
3621     "parameter": {
3622       "fields": {
3623         "Body": [
3624           {
3625             "group": "Body",
3626             "type": "String",
3627             "optional": false,
3628             "field": "uniqueid",
3629             "description": ""
3630           },
3631           {
3632             "group": "Body",
3633             "type": "String",
3634             "allowedValues": [
3635               "\"account\"",
3636               "\"agent\"",
3637               "\"queue\""
3638             ],
3639             "optional": false,
3640             "field": "type",
3641             "description": ""
3642           },
3643           {
3644             "group": "Body",
3645             "type": "String",
3646             "optional": false,
3647             "field": "transferredAt",
3648             "description": ""
3649           }
3650         ]
3651       }
3652     },
3653     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3654     "version": "0.0.0",
3655     "filename": "server/api/chatTransferReport/index.js",
3656     "groupTitle": "Chat_Transfer_Reports"
3657   },
3658   {
3659     "type": "delete",
3660     "url": "/api/chat/reports/transfer/{id}",
3661     "title": "Deletes a Chat Transfer Report",
3662     "examples": [
3663       {
3664         "title": "Example usage:",
3665         "content": "curl https://{domain}/api/chat/reports/transfer/{id} -v -u {name}:{password} -X DELETE",
3666         "type": "json"
3667       }
3668     ],
3669     "name": "DeleteChat_Transfer_Reports",
3670     "group": "Chat_Transfer_Reports",
3671     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3672     "version": "0.0.0",
3673     "filename": "server/api/chatTransferReport/index.js",
3674     "groupTitle": "Chat_Transfer_Reports"
3675   },
3676   {
3677     "type": "get",
3678     "url": "/api/chat/reports/transfer/describe",
3679     "title": "Gets table info about Chat Transfer Reports",
3680     "examples": [
3681       {
3682         "title": "Example usage:",
3683         "content": "curl https://{domain}/api/chat/reports/transfer/describe -v -u {name}:{password}",
3684         "type": "json"
3685       }
3686     ],
3687     "name": "DescribeChat_Transfer_Reports",
3688     "group": "Chat_Transfer_Reports",
3689     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3690     "version": "0.0.0",
3691     "filename": "server/api/chatTransferReport/index.js",
3692     "groupTitle": "Chat_Transfer_Reports"
3693   },
3694   {
3695     "type": "get",
3696     "url": "/api/chat/reports/transfer",
3697     "title": "Gets a list of Chat Transfer Reports",
3698     "examples": [
3699       {
3700         "title": "Example usage:",
3701         "content": "curl https://{domain}/api/chat/reports/transfer -v -u {name}:{password}",
3702         "type": "json"
3703       }
3704     ],
3705     "name": "GetChat_Transfer_Reports",
3706     "group": "Chat_Transfer_Reports",
3707     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/chat/reports/transfer?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/chat/reports/transfer?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/chat/reports/transfer?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/chat/reports/transfer?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/chat/reports/transfer?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
3708     "version": "0.0.0",
3709     "filename": "server/api/chatTransferReport/index.js",
3710     "groupTitle": "Chat_Transfer_Reports"
3711   },
3712   {
3713     "type": "get",
3714     "url": "/api/chat/reports/transfer/{id}",
3715     "title": "Gets a single Chat Transfer Report",
3716     "examples": [
3717       {
3718         "title": "Example usage:",
3719         "content": "curl https://{domain}/api/chat/reports/transfer/{id} -v -u {name}:{password}",
3720         "type": "json"
3721       }
3722     ],
3723     "name": "ShowChat_Transfer_Reports",
3724     "group": "Chat_Transfer_Reports",
3725     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3726     "version": "0.0.0",
3727     "filename": "server/api/chatTransferReport/index.js",
3728     "groupTitle": "Chat_Transfer_Reports"
3729   },
3730   {
3731     "type": "put",
3732     "url": "/api/chat/reports/transfer/{id}",
3733     "title": "Update an existing Chat Transfer Report",
3734     "examples": [
3735       {
3736         "title": "Example usage:",
3737         "content": "curl https://{domain}/api/chat/reports/transfer/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
3738         "type": "json"
3739       }
3740     ],
3741     "name": "updateChat_Transfer_Reports",
3742     "group": "Chat_Transfer_Reports",
3743     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3744     "version": "0.0.0",
3745     "filename": "server/api/chatTransferReport/index.js",
3746     "groupTitle": "Chat_Transfer_Reports"
3747   },
3748   {
3749     "type": "post",
3750     "url": "/api/chat/websites/{id}/users",
3751     "title": "Add agents to a website",
3752     "examples": [
3753       {
3754         "title": "Example usage:",
3755         "content": "curl https://{domain}/api/chat/websites/{id}/users -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
3756         "type": "json"
3757       }
3758     ],
3759     "name": "AddAgents",
3760     "group": "Chat_Websites",
3761     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3762     "version": "0.0.0",
3763     "filename": "server/api/chatWebsite/index.js",
3764     "groupTitle": "Chat_Websites"
3765   },
3766   {
3767     "type": "post",
3768     "url": "/api/chat/websites",
3769     "title": "Creates a new Website",
3770     "examples": [
3771       {
3772         "title": "Example usage:",
3773         "content": "curl https://{domain}/api/chat/websites -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
3774         "type": "json"
3775       }
3776     ],
3777     "name": "CreateWebsites",
3778     "group": "Chat_Websites",
3779     "parameter": {
3780       "fields": {
3781         "Body": [
3782           {
3783             "group": "Body",
3784             "type": "String",
3785             "optional": false,
3786             "field": "name",
3787             "description": ""
3788           },
3789           {
3790             "group": "Body",
3791             "type": "String",
3792             "optional": false,
3793             "field": "address",
3794             "description": ""
3795           },
3796           {
3797             "group": "Body",
3798             "type": "String",
3799             "optional": true,
3800             "field": "description",
3801             "description": ""
3802           },
3803           {
3804             "group": "Body",
3805             "type": "String",
3806             "optional": true,
3807             "field": "mapKey",
3808             "description": ""
3809           },
3810           {
3811             "group": "Body",
3812             "type": "String",
3813             "optional": true,
3814             "field": "mapKeyOffline",
3815             "description": ""
3816           },
3817           {
3818             "group": "Body",
3819             "type": "String",
3820             "optional": false,
3821             "field": "key",
3822             "description": ""
3823           },
3824           {
3825             "group": "Body",
3826             "type": "String",
3827             "optional": true,
3828             "field": "agentAlias",
3829             "description": ""
3830           },
3831           {
3832             "group": "Body",
3833             "type": "String",
3834             "optional": true,
3835             "field": "customerAlias",
3836             "description": ""
3837           },
3838           {
3839             "group": "Body",
3840             "type": "String",
3841             "optional": false,
3842             "field": "color",
3843             "description": ""
3844           },
3845           {
3846             "group": "Body",
3847             "type": "String",
3848             "optional": false,
3849             "field": "color_button",
3850             "description": ""
3851           },
3852           {
3853             "group": "Body",
3854             "type": "String",
3855             "optional": false,
3856             "field": "textColor",
3857             "description": ""
3858           },
3859           {
3860             "group": "Body",
3861             "type": "Integer",
3862             "optional": true,
3863             "field": "fontSize",
3864             "description": ""
3865           },
3866           {
3867             "group": "Body",
3868             "type": "String",
3869             "optional": true,
3870             "field": "remote",
3871             "description": ""
3872           },
3873           {
3874             "group": "Body",
3875             "type": "Boolean",
3876             "optional": true,
3877             "field": "animation",
3878             "description": ""
3879           },
3880           {
3881             "group": "Body",
3882             "type": "String",
3883             "allowedValues": [
3884               "\"rounded\"",
3885               "\"squared\""
3886             ],
3887             "optional": true,
3888             "field": "header_shape",
3889             "description": ""
3890           },
3891           {
3892             "group": "Body",
3893             "type": "String",
3894             "optional": true,
3895             "field": "header_online",
3896             "description": ""
3897           },
3898           {
3899             "group": "Body",
3900             "type": "String",
3901             "optional": true,
3902             "field": "start_chat_button",
3903             "description": ""
3904           },
3905           {
3906             "group": "Body",
3907             "type": "String",
3908             "optional": true,
3909             "field": "offline_chat_button",
3910             "description": ""
3911           },
3912           {
3913             "group": "Body",
3914             "type": "String",
3915             "optional": true,
3916             "field": "header_offline",
3917             "description": ""
3918           },
3919           {
3920             "group": "Body",
3921             "type": "Boolean",
3922             "optional": true,
3923             "field": "download_transcript",
3924             "description": ""
3925           },
3926           {
3927             "group": "Body",
3928             "type": "Integer",
3929             "optional": true,
3930             "field": "timeout",
3931             "description": ""
3932           },
3933           {
3934             "group": "Body",
3935             "type": "String",
3936             "optional": true,
3937             "field": "whiteLabel",
3938             "description": ""
3939           },
3940           {
3941             "group": "Body",
3942             "type": "Boolean",
3943             "optional": true,
3944             "field": "defaultWhiteLabel",
3945             "description": ""
3946           },
3947           {
3948             "group": "Body",
3949             "type": "Text",
3950             "optional": true,
3951             "field": "sitepic",
3952             "description": ""
3953           },
3954           {
3955             "group": "Body",
3956             "type": "String",
3957             "optional": true,
3958             "field": "closingQuestion",
3959             "description": ""
3960           },
3961           {
3962             "group": "Body",
3963             "type": "String",
3964             "optional": true,
3965             "field": "formSubmitSuccessMessage",
3966             "description": ""
3967           },
3968           {
3969             "group": "Body",
3970             "type": "String",
3971             "optional": true,
3972             "field": "formSubmitFailureMessage",
3973             "description": ""
3974           },
3975           {
3976             "group": "Body",
3977             "type": "String",
3978             "optional": true,
3979             "field": "noteTitle",
3980             "description": ""
3981           },
3982           {
3983             "group": "Body",
3984             "type": "String",
3985             "optional": true,
3986             "field": "placeholderMessage",
3987             "description": ""
3988           },
3989           {
3990             "group": "Body",
3991             "type": "String",
3992             "optional": true,
3993             "field": "closingMessage",
3994             "description": ""
3995           },
3996           {
3997             "group": "Body",
3998             "type": "String",
3999             "optional": true,
4000             "field": "closingMessageButton",
4001             "description": ""
4002           },
4003           {
4004             "group": "Body",
4005             "type": "String",
4006             "optional": true,
4007             "field": "skipMessageButton",
4008             "description": ""
4009           },
4010           {
4011             "group": "Body",
4012             "type": "Boolean",
4013             "optional": true,
4014             "field": "conditionAgreement",
4015             "description": ""
4016           },
4017           {
4018             "group": "Body",
4019             "type": "Boolean",
4020             "optional": true,
4021             "field": "enableRating",
4022             "description": ""
4023           },
4024           {
4025             "group": "Body",
4026             "type": "Boolean",
4027             "optional": true,
4028             "field": "enableFeedback",
4029             "description": ""
4030           },
4031           {
4032             "group": "Body",
4033             "type": "Boolean",
4034             "optional": true,
4035             "field": "enableSendButton",
4036             "description": ""
4037           },
4038           {
4039             "group": "Body",
4040             "type": "String",
4041             "optional": true,
4042             "field": "feedbackTitle",
4043             "description": ""
4044           },
4045           {
4046             "group": "Body",
4047             "type": "String",
4048             "allowedValues": [
4049               "\"star\"",
4050               "\"thumb\""
4051             ],
4052             "optional": true,
4053             "field": "ratingType",
4054             "description": ""
4055           },
4056           {
4057             "group": "Body",
4058             "type": "Integer",
4059             "optional": true,
4060             "field": "ratingStarsNumber",
4061             "description": ""
4062           },
4063           {
4064             "group": "Body",
4065             "type": "Text",
4066             "optional": true,
4067             "field": "onlineForm",
4068             "description": ""
4069           },
4070           {
4071             "group": "Body",
4072             "type": "Text",
4073             "optional": true,
4074             "field": "offlineForm",
4075             "description": ""
4076           },
4077           {
4078             "group": "Body",
4079             "type": "String",
4080             "optional": true,
4081             "field": "token",
4082             "description": ""
4083           },
4084           {
4085             "group": "Body",
4086             "type": "Boolean",
4087             "optional": true,
4088             "field": "autoclose",
4089             "description": ""
4090           },
4091           {
4092             "group": "Body",
4093             "type": "Boolean",
4094             "optional": true,
4095             "field": "enableCustomerWriting",
4096             "description": ""
4097           },
4098           {
4099             "group": "Body",
4100             "type": "Boolean",
4101             "optional": true,
4102             "field": "forwardTranscript",
4103             "description": ""
4104           },
4105           {
4106             "group": "Body",
4107             "type": "String",
4108             "optional": true,
4109             "field": "forwardTranscriptMessage",
4110             "description": ""
4111           },
4112           {
4113             "group": "Body",
4114             "type": "Boolean",
4115             "optional": true,
4116             "field": "forwardOffline",
4117             "description": ""
4118           },
4119           {
4120             "group": "Body",
4121             "type": "String",
4122             "optional": true,
4123             "field": "forwardOfflineAddress",
4124             "description": ""
4125           },
4126           {
4127             "group": "Body",
4128             "type": "String",
4129             "optional": true,
4130             "field": "waitingTitle",
4131             "description": ""
4132           },
4133           {
4134             "group": "Body",
4135             "type": "String",
4136             "optional": true,
4137             "field": "waitingMessage",
4138             "description": ""
4139           },
4140           {
4141             "group": "Body",
4142             "type": "String",
4143             "optional": true,
4144             "field": "offlineMessageSubject",
4145             "description": ""
4146           },
4147           {
4148             "group": "Body",
4149             "type": "String",
4150             "optional": true,
4151             "field": "offlineMessageBody",
4152             "description": ""
4153           },
4154           {
4155             "group": "Body",
4156             "type": "Boolean",
4157             "optional": true,
4158             "field": "enableUnmanagedNote",
4159             "description": ""
4160           },
4161           {
4162             "group": "Body",
4163             "type": "String",
4164             "optional": true,
4165             "field": "unmanagedMessage",
4166             "description": ""
4167           },
4168           {
4169             "group": "Body",
4170             "type": "String",
4171             "optional": true,
4172             "field": "skipUnmanaged",
4173             "description": ""
4174           },
4175           {
4176             "group": "Body",
4177             "type": "String",
4178             "optional": true,
4179             "field": "sendUnmanaged",
4180             "description": ""
4181           },
4182           {
4183             "group": "Body",
4184             "type": "Boolean",
4185             "optional": true,
4186             "field": "enableCustomerAttachment",
4187             "description": ""
4188           },
4189           {
4190             "group": "Body",
4191             "type": "Boolean",
4192             "optional": true,
4193             "field": "enableCustomerCheckmarks",
4194             "description": ""
4195           },
4196           {
4197             "group": "Body",
4198             "type": "Text",
4199             "optional": true,
4200             "field": "agentAvatar",
4201             "description": ""
4202           },
4203           {
4204             "group": "Body",
4205             "type": "Boolean",
4206             "optional": true,
4207             "field": "showAgentAvatar",
4208             "description": ""
4209           },
4210           {
4211             "group": "Body",
4212             "type": "String",
4213             "optional": true,
4214             "field": "timezone",
4215             "description": ""
4216           },
4217           {
4218             "group": "Body",
4219             "type": "Text",
4220             "optional": true,
4221             "field": "notificationTemplate",
4222             "description": ""
4223           },
4224           {
4225             "group": "Body",
4226             "type": "Boolean",
4227             "optional": true,
4228             "field": "notificationSound",
4229             "description": ""
4230           },
4231           {
4232             "group": "Body",
4233             "type": "Boolean",
4234             "optional": true,
4235             "field": "notificationShake",
4236             "description": ""
4237           },
4238           {
4239             "group": "Body",
4240             "type": "Boolean",
4241             "optional": true,
4242             "field": "hideWhenOffline",
4243             "description": ""
4244           },
4245           {
4246             "group": "Body",
4247             "type": "String",
4248             "optional": true,
4249             "field": "agentIdentifier",
4250             "description": ""
4251           },
4252           {
4253             "group": "Body",
4254             "type": "Integer",
4255             "optional": true,
4256             "field": "waitForTheAssignedAgent",
4257             "description": ""
4258           },
4259           {
4260             "group": "Body",
4261             "type": "String",
4262             "optional": true,
4263             "field": "alignment",
4264             "description": ""
4265           },
4266           {
4267             "group": "Body",
4268             "type": "Integer",
4269             "optional": true,
4270             "field": "verticalAlignment",
4271             "description": ""
4272           },
4273           {
4274             "group": "Body",
4275             "type": "String",
4276             "optional": true,
4277             "field": "messagesAlignment",
4278             "description": ""
4279           },
4280           {
4281             "group": "Body",
4282             "type": "String",
4283             "optional": true,
4284             "field": "defaultTitle",
4285             "description": ""
4286           },
4287           {
4288             "group": "Body",
4289             "type": "Text",
4290             "optional": true,
4291             "field": "customerAvatar",
4292             "description": ""
4293           },
4294           {
4295             "group": "Body",
4296             "type": "Boolean",
4297             "optional": true,
4298             "field": "showCustomerAvatar",
4299             "description": ""
4300           },
4301           {
4302             "group": "Body",
4303             "type": "Integer",
4304             "optional": true,
4305             "field": "messageFontSize",
4306             "description": ""
4307           },
4308           {
4309             "group": "Body",
4310             "type": "String",
4311             "optional": false,
4312             "field": "backgroundColor",
4313             "description": ""
4314           },
4315           {
4316             "group": "Body",
4317             "type": "Boolean",
4318             "optional": true,
4319             "field": "queueTransfer",
4320             "description": ""
4321           },
4322           {
4323             "group": "Body",
4324             "type": "Integer",
4325             "optional": true,
4326             "field": "queueTransferTimeout",
4327             "description": ""
4328           },
4329           {
4330             "group": "Body",
4331             "type": "Boolean",
4332             "optional": true,
4333             "field": "agentTransfer",
4334             "description": ""
4335           },
4336           {
4337             "group": "Body",
4338             "type": "Integer",
4339             "optional": true,
4340             "field": "agentTransferTimeout",
4341             "description": ""
4342           },
4343           {
4344             "group": "Body",
4345             "type": "String",
4346             "optional": true,
4347             "field": "systemAlias",
4348             "description": ""
4349           },
4350           {
4351             "group": "Body",
4352             "type": "Text",
4353             "optional": true,
4354             "field": "systemAvatar",
4355             "description": ""
4356           },
4357           {
4358             "group": "Body",
4359             "type": "Integer",
4360             "optional": true,
4361             "field": "mandatoryDispositionPauseId",
4362             "description": "<p>Status to put when mandatory disposition is enabled</p>"
4363           },
4364           {
4365             "group": "Body",
4366             "type": "Boolean",
4367             "optional": true,
4368             "field": "mandatoryDisposition",
4369             "description": "<p>Enabled/disables mandatory dispo on a queue</p>"
4370           },
4371           {
4372             "group": "Body",
4373             "type": "Boolean",
4374             "optional": true,
4375             "field": "vidaooEscalation",
4376             "description": ""
4377           },
4378           {
4379             "group": "Body",
4380             "type": "String",
4381             "optional": true,
4382             "field": "vidaooApiKey",
4383             "description": ""
4384           },
4385           {
4386             "group": "Body",
4387             "type": "String",
4388             "optional": false,
4389             "field": "vidaooTopic",
4390             "description": ""
4391           },
4392           {
4393             "group": "Body",
4394             "type": "String",
4395             "optional": true,
4396             "field": "vidaooNote",
4397             "description": ""
4398           },
4399           {
4400             "group": "Body",
4401             "type": "Text",
4402             "optional": true,
4403             "field": "vidaooMetadata",
4404             "description": ""
4405           },
4406           {
4407             "group": "Body",
4408             "type": "Boolean",
4409             "optional": true,
4410             "field": "openNewInteraction",
4411             "description": ""
4412           },
4413           {
4414             "group": "Body",
4415             "type": "Text",
4416             "optional": true,
4417             "field": "subjectOffline",
4418             "description": ""
4419           }
4420         ]
4421       }
4422     },
4423     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4424     "version": "0.0.0",
4425     "filename": "server/api/chatWebsite/index.js",
4426     "groupTitle": "Chat_Websites"
4427   },
4428   {
4429     "type": "delete",
4430     "url": "/api/chat/websites/{id}",
4431     "title": "Deletes a Website",
4432     "examples": [
4433       {
4434         "title": "Example usage:",
4435         "content": "curl https://{domain}/api/chat/websites/{id} -v -u {name}:{password} -X DELETE",
4436         "type": "json"
4437       }
4438     ],
4439     "name": "DeleteWebsites",
4440     "group": "Chat_Websites",
4441     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4442     "version": "0.0.0",
4443     "filename": "server/api/chatWebsite/index.js",
4444     "groupTitle": "Chat_Websites"
4445   },
4446   {
4447     "type": "get",
4448     "url": "/api/chat/websites/describe",
4449     "title": "Gets table info about Websites",
4450     "examples": [
4451       {
4452         "title": "Example usage:",
4453         "content": "curl https://{domain}/api/chat/websites/describe -v -u {name}:{password}",
4454         "type": "json"
4455       }
4456     ],
4457     "name": "DescribeWebsites",
4458     "group": "Chat_Websites",
4459     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4460     "version": "0.0.0",
4461     "filename": "server/api/chatWebsite/index.js",
4462     "groupTitle": "Chat_Websites"
4463   },
4464   {
4465     "type": "get",
4466     "url": "/api/chat/websites/{id}/users",
4467     "title": "Gets agents from website",
4468     "examples": [
4469       {
4470         "title": "Example usage:",
4471         "content": "curl https://{domain}/api/chat/websites/{id}/users -v -u {name}:{password} -X GET",
4472         "type": "json"
4473       }
4474     ],
4475     "name": "GetAgents",
4476     "group": "Chat_Websites",
4477     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4478     "version": "0.0.0",
4479     "filename": "server/api/chatWebsite/index.js",
4480     "groupTitle": "Chat_Websites"
4481   },
4482   {
4483     "type": "get",
4484     "url": "/api/chat/websites",
4485     "title": "Gets a list of Websites",
4486     "examples": [
4487       {
4488         "title": "Example usage:",
4489         "content": "curl https://{domain}/api/chat/websites -v -u {name}:{password}",
4490         "type": "json"
4491       }
4492     ],
4493     "name": "GetWebsites",
4494     "group": "Chat_Websites",
4495     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
4496     "version": "0.0.0",
4497     "filename": "server/api/chatWebsite/index.js",
4498     "groupTitle": "Chat_Websites"
4499   },
4500   {
4501     "type": "delete",
4502     "url": "/api/chat/websites/{id}/users",
4503     "title": "Removes agents from a website",
4504     "examples": [
4505       {
4506         "title": "Example usage:",
4507         "content": "curl https://{domain}/api/chat/websites/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
4508         "type": "json"
4509       }
4510     ],
4511     "name": "RemoveAgents",
4512     "group": "Chat_Websites",
4513     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4514     "version": "0.0.0",
4515     "filename": "server/api/chatWebsite/index.js",
4516     "groupTitle": "Chat_Websites"
4517   },
4518   {
4519     "type": "delete",
4520     "url": "/api/chat/websites/{id}/canned_answers",
4521     "title": "Removes canned answers from account",
4522     "examples": [
4523       {
4524         "title": "Example usage:",
4525         "content": "curl https://{domain}/api/chat/websites/{id}/canned_answers?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
4526         "type": "json"
4527       }
4528     ],
4529     "name": "RemoveAnswers",
4530     "group": "Chat_Websites",
4531     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4532     "version": "0.0.0",
4533     "filename": "server/api/chatWebsite/index.js",
4534     "groupTitle": "Chat_Websites"
4535   },
4536   {
4537     "type": "delete",
4538     "url": "/api/chat/websites/{id}/dispositions",
4539     "title": "Removes canned answers from account",
4540     "examples": [
4541       {
4542         "title": "Example usage:",
4543         "content": "curl https://{domain}/api/chat/websites/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
4544         "type": "json"
4545       }
4546     ],
4547     "name": "RemoveDispositions",
4548     "group": "Chat_Websites",
4549     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4550     "version": "0.0.0",
4551     "filename": "server/api/chatWebsite/index.js",
4552     "groupTitle": "Chat_Websites"
4553   },
4554   {
4555     "type": "get",
4556     "url": "/api/chat/websites/{id}",
4557     "title": "Gets a single Website",
4558     "examples": [
4559       {
4560         "title": "Example usage:",
4561         "content": "curl https://{domain}/api/chat/websites/{id} -v -u {name}:{password}",
4562         "type": "json"
4563       }
4564     ],
4565     "name": "ShowWebsites",
4566     "group": "Chat_Websites",
4567     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4568     "version": "0.0.0",
4569     "filename": "server/api/chatWebsite/index.js",
4570     "groupTitle": "Chat_Websites"
4571   },
4572   {
4573     "type": "put",
4574     "url": "/api/chat/messages/{id}/accept",
4575     "title": "Accepts message",
4576     "examples": [
4577       {
4578         "title": "Example usage:",
4579         "content": "curl https://{domain}/api/chat/messages/{id}/accept \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
4580         "type": "json"
4581       }
4582     ],
4583     "name": "acceptMessage",
4584     "group": "Chat_Websites",
4585     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4586     "version": "0.0.0",
4587     "filename": "server/api/chatMessage/index.js",
4588     "groupTitle": "Chat_Websites"
4589   },
4590   {
4591     "type": "post",
4592     "url": "/api/chat/websites/{id}/canned_answers",
4593     "title": "Creates new canned answer",
4594     "examples": [
4595       {
4596         "title": "Example usage:",
4597         "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",
4598         "type": "json"
4599       }
4600     ],
4601     "name": "addAnswer",
4602     "group": "Chat_Websites",
4603     "parameter": {
4604       "fields": {
4605         "Body": [
4606           {
4607             "group": "Body",
4608             "type": "String",
4609             "optional": false,
4610             "field": "key",
4611             "description": ""
4612           },
4613           {
4614             "group": "Body",
4615             "type": "Text",
4616             "optional": false,
4617             "field": "value",
4618             "description": ""
4619           },
4620           {
4621             "group": "Body",
4622             "type": "String",
4623             "optional": true,
4624             "field": "description",
4625             "description": ""
4626           },
4627           {
4628             "group": "Body",
4629             "type": "Virtual",
4630             "optional": true,
4631             "field": "name",
4632             "description": ""
4633           }
4634         ]
4635       }
4636     },
4637     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4638     "version": "0.0.0",
4639     "filename": "server/api/chatWebsite/index.js",
4640     "groupTitle": "Chat_Websites"
4641   },
4642   {
4643     "type": "post",
4644     "url": "/api/chat/websites/{id}/applications",
4645     "title": "Creates new applications",
4646     "examples": [
4647       {
4648         "title": "Example usage:",
4649         "content": "curl https://{domain}/api/chat/websites/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
4650         "type": "json"
4651       }
4652     ],
4653     "name": "addApplications",
4654     "group": "Chat_Websites",
4655     "parameter": {
4656       "fields": {
4657         "Body": [
4658           {
4659             "group": "Body",
4660             "type": "Integer",
4661             "optional": false,
4662             "field": "priority",
4663             "description": ""
4664           },
4665           {
4666             "group": "Body",
4667             "type": "String",
4668             "optional": false,
4669             "field": "app",
4670             "description": ""
4671           },
4672           {
4673             "group": "Body",
4674             "type": "Text",
4675             "optional": true,
4676             "field": "appdata",
4677             "description": ""
4678           },
4679           {
4680             "group": "Body",
4681             "type": "String",
4682             "optional": true,
4683             "field": "description",
4684             "description": ""
4685           },
4686           {
4687             "group": "Body",
4688             "type": "String",
4689             "optional": true,
4690             "field": "interval",
4691             "description": ""
4692           }
4693         ]
4694       }
4695     },
4696     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4697     "version": "0.0.0",
4698     "filename": "server/api/chatWebsite/index.js",
4699     "groupTitle": "Chat_Websites"
4700   },
4701   {
4702     "type": "post",
4703     "url": "/api/chat/websites/{id}/avatar",
4704     "title": "Add avatar",
4705     "examples": [
4706       {
4707         "title": "Example usage:",
4708         "content": "curl https://{domain}/api/chat/websites/{id}/avatar -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
4709         "type": "json"
4710       }
4711     ],
4712     "name": "addAvatar",
4713     "group": "Chat_Websites",
4714     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4715     "version": "0.0.0",
4716     "filename": "server/api/chatWebsite/index.js",
4717     "groupTitle": "Chat_Websites"
4718   },
4719   {
4720     "type": "post",
4721     "url": "/api/chat/websites/{id}/customer_avatar",
4722     "title": "Add customer avatar",
4723     "examples": [
4724       {
4725         "title": "Example usage:",
4726         "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",
4727         "type": "json"
4728       }
4729     ],
4730     "name": "addCustomerAvatar",
4731     "group": "Chat_Websites",
4732     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4733     "version": "0.0.0",
4734     "filename": "server/api/chatWebsite/index.js",
4735     "groupTitle": "Chat_Websites"
4736   },
4737   {
4738     "type": "post",
4739     "url": "/api/chat/websites/{id}/dispositions",
4740     "title": "Creates new disposition",
4741     "examples": [
4742       {
4743         "title": "Example usage:",
4744         "content": "curl https://{domain}/api/chat/websites/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
4745         "type": "json"
4746       }
4747     ],
4748     "name": "addDisposition",
4749     "group": "Chat_Websites",
4750     "parameter": {
4751       "fields": {
4752         "Body": [
4753           {
4754             "group": "Body",
4755             "type": "String",
4756             "optional": false,
4757             "field": "name",
4758             "description": ""
4759           },
4760           {
4761             "group": "Body",
4762             "type": "String",
4763             "allowedValues": [
4764               "\"first\"",
4765               "\"second\"",
4766               "\"third\""
4767             ],
4768             "optional": false,
4769             "field": "level",
4770             "description": ""
4771           },
4772           {
4773             "group": "Body",
4774             "type": "String",
4775             "optional": true,
4776             "field": "description",
4777             "description": ""
4778           }
4779         ]
4780       }
4781     },
4782     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4783     "version": "0.0.0",
4784     "filename": "server/api/chatWebsite/index.js",
4785     "groupTitle": "Chat_Websites"
4786   },
4787   {
4788     "type": "post",
4789     "url": "/api/chat/accounts/{id}/interactions",
4790     "title": "Creates new interactions",
4791     "examples": [
4792       {
4793         "title": "Example usage:",
4794         "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",
4795         "type": "json"
4796       }
4797     ],
4798     "name": "addInteraction",
4799     "group": "Chat_Websites",
4800     "parameter": {
4801       "fields": {
4802         "Body": [
4803           {
4804             "group": "Body",
4805             "type": "Boolean",
4806             "optional": true,
4807             "field": "closed",
4808             "description": ""
4809           },
4810           {
4811             "group": "Body",
4812             "type": "Integer",
4813             "optional": true,
4814             "field": "ratingValue",
4815             "description": ""
4816           },
4817           {
4818             "group": "Body",
4819             "type": "String",
4820             "allowedValues": [
4821               "\"star\"",
4822               "\"thumb\""
4823             ],
4824             "optional": true,
4825             "field": "ratingType",
4826             "description": ""
4827           },
4828           {
4829             "group": "Body",
4830             "type": "Text",
4831             "optional": true,
4832             "field": "ratingMessage",
4833             "description": ""
4834           },
4835           {
4836             "group": "Body",
4837             "type": "Text",
4838             "optional": true,
4839             "field": "pathTranscript",
4840             "description": ""
4841           },
4842           {
4843             "group": "Body",
4844             "type": "String",
4845             "optional": true,
4846             "field": "mailTranscript",
4847             "description": ""
4848           },
4849           {
4850             "group": "Body",
4851             "type": "String",
4852             "optional": true,
4853             "field": "closedAt",
4854             "description": ""
4855           },
4856           {
4857             "group": "Body",
4858             "type": "String",
4859             "optional": true,
4860             "field": "disposition",
4861             "description": ""
4862           },
4863           {
4864             "group": "Body",
4865             "type": "String",
4866             "optional": true,
4867             "field": "secondDisposition",
4868             "description": ""
4869           },
4870           {
4871             "group": "Body",
4872             "type": "String",
4873             "optional": true,
4874             "field": "thirdDisposition",
4875             "description": ""
4876           },
4877           {
4878             "group": "Body",
4879             "type": "String",
4880             "optional": true,
4881             "field": "note",
4882             "description": ""
4883           },
4884           {
4885             "group": "Body",
4886             "type": "String",
4887             "optional": true,
4888             "field": "browserName",
4889             "description": ""
4890           },
4891           {
4892             "group": "Body",
4893             "type": "String",
4894             "optional": true,
4895             "field": "browserVersion",
4896             "description": ""
4897           },
4898           {
4899             "group": "Body",
4900             "type": "String",
4901             "optional": true,
4902             "field": "osName",
4903             "description": ""
4904           },
4905           {
4906             "group": "Body",
4907             "type": "String",
4908             "optional": true,
4909             "field": "osVersion",
4910             "description": ""
4911           },
4912           {
4913             "group": "Body",
4914             "type": "String",
4915             "optional": true,
4916             "field": "deviceModel",
4917             "description": ""
4918           },
4919           {
4920             "group": "Body",
4921             "type": "String",
4922             "optional": true,
4923             "field": "deviceVendor",
4924             "description": ""
4925           },
4926           {
4927             "group": "Body",
4928             "type": "String",
4929             "optional": true,
4930             "field": "deviceType",
4931             "description": ""
4932           },
4933           {
4934             "group": "Body",
4935             "type": "Text",
4936             "optional": true,
4937             "field": "referer",
4938             "description": ""
4939           },
4940           {
4941             "group": "Body",
4942             "type": "String",
4943             "optional": true,
4944             "field": "customerIp",
4945             "description": ""
4946           },
4947           {
4948             "group": "Body",
4949             "type": "Text",
4950             "optional": true,
4951             "field": "formData",
4952             "description": ""
4953           },
4954           {
4955             "group": "Body",
4956             "type": "String",
4957             "optional": true,
4958             "field": "read1stAt",
4959             "description": ""
4960           },
4961           {
4962             "group": "Body",
4963             "type": "String",
4964             "optional": true,
4965             "field": "lastMsgAt",
4966             "description": ""
4967           },
4968           {
4969             "group": "Body",
4970             "type": "String",
4971             "allowedValues": [
4972               "\"in\"",
4973               "\"out\""
4974             ],
4975             "optional": false,
4976             "field": "lastMsgDirection",
4977             "description": ""
4978           },
4979           {
4980             "group": "Body",
4981             "type": "String",
4982             "optional": true,
4983             "field": "closeReason",
4984             "description": ""
4985           },
4986           {
4987             "group": "Body",
4988             "type": "String",
4989             "optional": true,
4990             "field": "customerPort",
4991             "description": ""
4992           },
4993           {
4994             "group": "Body",
4995             "type": "Text",
4996             "optional": true,
4997             "field": "vidaooSessionId",
4998             "description": ""
4999           }
5000         ]
5001       }
5002     },
5003     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5004     "version": "0.0.0",
5005     "filename": "server/api/chatWebsite/index.js",
5006     "groupTitle": "Chat_Websites"
5007   },
5008   {
5009     "type": "post",
5010     "url": "/api/chat/websites/{id}/logo",
5011     "title": "Add logo",
5012     "examples": [
5013       {
5014         "title": "Example usage:",
5015         "content": "curl https://{domain}/api/chat/websites/{id}/logo -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
5016         "type": "json"
5017       }
5018     ],
5019     "name": "addLogo",
5020     "group": "Chat_Websites",
5021     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5022     "version": "0.0.0",
5023     "filename": "server/api/chatWebsite/index.js",
5024     "groupTitle": "Chat_Websites"
5025   },
5026   {
5027     "type": "post",
5028     "url": "/api/chat/websites/{id}/proactive_actions",
5029     "title": "Creates new Proactive Actions",
5030     "examples": [
5031       {
5032         "title": "Example usage:",
5033         "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",
5034         "type": "json"
5035       }
5036     ],
5037     "name": "addProactiveActions",
5038     "group": "Chat_Websites",
5039     "parameter": {
5040       "fields": {
5041         "Body": [
5042           {
5043             "group": "Body",
5044             "type": "String",
5045             "optional": false,
5046             "field": "name",
5047             "description": ""
5048           },
5049           {
5050             "group": "Body",
5051             "type": "String",
5052             "allowedValues": [
5053               "\"mouseOver\"",
5054               "\"timeout\""
5055             ],
5056             "optional": true,
5057             "field": "type",
5058             "description": ""
5059           },
5060           {
5061             "group": "Body",
5062             "type": "String",
5063             "optional": true,
5064             "field": "selector",
5065             "description": ""
5066           },
5067           {
5068             "group": "Body",
5069             "type": "Integer",
5070             "optional": true,
5071             "field": "timeout",
5072             "description": ""
5073           }
5074         ]
5075       }
5076     },
5077     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5078     "version": "0.0.0",
5079     "filename": "server/api/chatWebsite/index.js",
5080     "groupTitle": "Chat_Websites"
5081   },
5082   {
5083     "type": "post",
5084     "url": "/api/chat/websites/{id}/system_avatar",
5085     "title": "Add system avatar",
5086     "examples": [
5087       {
5088         "title": "Example usage:",
5089         "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",
5090         "type": "json"
5091       }
5092     ],
5093     "name": "addSystemAvatar",
5094     "group": "Chat_Websites",
5095     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5096     "version": "0.0.0",
5097     "filename": "server/api/chatWebsite/index.js",
5098     "groupTitle": "Chat_Websites"
5099   },
5100   {
5101     "type": "get",
5102     "url": "/api/chat/websites/{id}/canned_answers",
5103     "title": "Gets account canned answers",
5104     "examples": [
5105       {
5106         "title": "Example usage:",
5107         "content": "curl https://{domain}/api/chat/websites/{id}/canned_answers -v -u {name}:{password} -X GET",
5108         "type": "json"
5109       }
5110     ],
5111     "name": "getAnswers",
5112     "group": "Chat_Websites",
5113     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5114     "version": "0.0.0",
5115     "filename": "server/api/chatWebsite/index.js",
5116     "groupTitle": "Chat_Websites"
5117   },
5118   {
5119     "type": "get",
5120     "url": "/api/chat/websites/{id}/applications",
5121     "title": "Gets Website Applications",
5122     "examples": [
5123       {
5124         "title": "Example usage:",
5125         "content": "curl https://{domain}/api/chat/websites/{id}/applications -v -u {name}:{password} -X GET",
5126         "type": "json"
5127       }
5128     ],
5129     "name": "getApplications",
5130     "group": "Chat_Websites",
5131     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5132     "version": "0.0.0",
5133     "filename": "server/api/chatWebsite/index.js",
5134     "groupTitle": "Chat_Websites"
5135   },
5136   {
5137     "type": "get",
5138     "url": "/api/chat/websites/{id}/avatar",
5139     "title": "Get avatar",
5140     "examples": [
5141       {
5142         "title": "Example usage:",
5143         "content": "curl https://{domain}/api/chat/websites/{id}/avatar -v -u {name}:{password} -X GET",
5144         "type": "json"
5145       }
5146     ],
5147     "name": "getAvatar",
5148     "group": "Chat_Websites",
5149     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5150     "version": "0.0.0",
5151     "filename": "server/api/chatWebsite/index.js",
5152     "groupTitle": "Chat_Websites"
5153   },
5154   {
5155     "type": "get",
5156     "url": "/api/chat/websites/{id}/customer_avatar",
5157     "title": "Get Customer Avatar",
5158     "examples": [
5159       {
5160         "title": "Example usage:",
5161         "content": "curl https://{domain}/api/chat/websites/{id}/customer_avatar -v -u {name}:{password} -X GET",
5162         "type": "json"
5163       }
5164     ],
5165     "name": "getCustomerAvatar",
5166     "group": "Chat_Websites",
5167     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5168     "version": "0.0.0",
5169     "filename": "server/api/chatWebsite/index.js",
5170     "groupTitle": "Chat_Websites"
5171   },
5172   {
5173     "type": "get",
5174     "url": "/api/chat/websites/{id}/dispositions",
5175     "title": "Gets account dispositions",
5176     "examples": [
5177       {
5178         "title": "Example usage:",
5179         "content": "curl https://{domain}/api/chat/websites/{id}/dispositions -v -u {name}:{password} -X GET",
5180         "type": "json"
5181       }
5182     ],
5183     "name": "getDispositions",
5184     "group": "Chat_Websites",
5185     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5186     "version": "0.0.0",
5187     "filename": "server/api/chatWebsite/index.js",
5188     "groupTitle": "Chat_Websites"
5189   },
5190   {
5191     "type": "get",
5192     "url": "/api/chat/websites/{id}/fields",
5193     "title": "Gets Website Fields",
5194     "examples": [
5195       {
5196         "title": "Example usage:",
5197         "content": "curl https://{domain}/api/chat/websites/{id}/fields -v -u {name}:{password} -X GET",
5198         "type": "json"
5199       }
5200     ],
5201     "name": "getFields",
5202     "group": "Chat_Websites",
5203     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5204     "version": "0.0.0",
5205     "filename": "server/api/chatWebsite/index.js",
5206     "groupTitle": "Chat_Websites"
5207   },
5208   {
5209     "type": "get",
5210     "url": "/api/chat/websites/{id}/interactions",
5211     "title": "Gets Website Interactions",
5212     "examples": [
5213       {
5214         "title": "Example usage:",
5215         "content": "curl https://{domain}/api/chat/websites/{id}/interactions -v -u {name}:{password} -X GET",
5216         "type": "json"
5217       }
5218     ],
5219     "name": "getInteraction",
5220     "group": "Chat_Websites",
5221     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5222     "version": "0.0.0",
5223     "filename": "server/api/chatWebsite/index.js",
5224     "groupTitle": "Chat_Websites"
5225   },
5226   {
5227     "type": "get",
5228     "url": "/api/chat/websites/{id}/logo",
5229     "title": "Get logo",
5230     "examples": [
5231       {
5232         "title": "Example usage:",
5233         "content": "curl https://{domain}/api/chat/websites/{id}/logo -v -u {name}:{password} -X GET",
5234         "type": "json"
5235       }
5236     ],
5237     "name": "getLogo",
5238     "group": "Chat_Websites",
5239     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5240     "version": "0.0.0",
5241     "filename": "server/api/chatWebsite/index.js",
5242     "groupTitle": "Chat_Websites"
5243   },
5244   {
5245     "type": "get",
5246     "url": "/api/chat/websites/{id}/offline_messages",
5247     "title": "Gets Website Offline Messages",
5248     "examples": [
5249       {
5250         "title": "Example usage:",
5251         "content": "curl https://{domain}/api/chat/websites/{id}/offline_messages -v -u {name}:{password} -X GET",
5252         "type": "json"
5253       }
5254     ],
5255     "name": "getOfflineMessages",
5256     "group": "Chat_Websites",
5257     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5258     "version": "0.0.0",
5259     "filename": "server/api/chatWebsite/index.js",
5260     "groupTitle": "Chat_Websites"
5261   },
5262   {
5263     "type": "get",
5264     "url": "/api/chat/websites/{id}/proactive_actions",
5265     "title": "Gets Website Proactive Actions",
5266     "examples": [
5267       {
5268         "title": "Example usage:",
5269         "content": "curl https://{domain}/api/chat/websites/{id}/proactive_actions -v -u {name}:{password} -X GET",
5270         "type": "json"
5271       }
5272     ],
5273     "name": "getProactiveActions",
5274     "group": "Chat_Websites",
5275     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5276     "version": "0.0.0",
5277     "filename": "server/api/chatWebsite/index.js",
5278     "groupTitle": "Chat_Websites"
5279   },
5280   {
5281     "type": "get",
5282     "url": "/api/chat/websites/{id}/snippet",
5283     "title": "Gets Website Snippet",
5284     "examples": [
5285       {
5286         "title": "Example usage:",
5287         "content": "curl https://{domain}/api/chat/websites/{id}/snippet -v -u {name}:{password} -X GET",
5288         "type": "json"
5289       }
5290     ],
5291     "name": "getSnippet",
5292     "group": "Chat_Websites",
5293     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5294     "version": "0.0.0",
5295     "filename": "server/api/chatWebsite/index.js",
5296     "groupTitle": "Chat_Websites"
5297   },
5298   {
5299     "type": "get",
5300     "url": "/api/chat/websites/{id}/system_avatar",
5301     "title": "Get System Avatar",
5302     "examples": [
5303       {
5304         "title": "Example usage:",
5305         "content": "curl https://{domain}/api/chat/websites/{id}/system_avatar -v -u {name}:{password} -X GET",
5306         "type": "json"
5307       }
5308     ],
5309     "name": "getSystemAvatar",
5310     "group": "Chat_Websites",
5311     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5312     "version": "0.0.0",
5313     "filename": "server/api/chatWebsite/index.js",
5314     "groupTitle": "Chat_Websites"
5315   },
5316   {
5317     "type": "post",
5318     "url": "/api/chat/websites/{id}/notify",
5319     "title": "Notify new message",
5320     "examples": [
5321       {
5322         "title": "Example usage:",
5323         "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",
5324         "type": "json"
5325       }
5326     ],
5327     "name": "notify",
5328     "group": "Chat_Websites",
5329     "description": "<p>Motion 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>",
5330     "version": "0.0.0",
5331     "filename": "server/api/chatWebsite/index.js",
5332     "groupTitle": "Chat_Websites"
5333   },
5334   {
5335     "type": "post",
5336     "url": "/api/chat/websites/{id}/offline",
5337     "title": "Offline message",
5338     "examples": [
5339       {
5340         "title": "Example usage:",
5341         "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",
5342         "type": "json"
5343       }
5344     ],
5345     "name": "offline",
5346     "group": "Chat_Websites",
5347     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5348     "version": "0.0.0",
5349     "filename": "server/api/chatWebsite/index.js",
5350     "groupTitle": "Chat_Websites"
5351   },
5352   {
5353     "type": "put",
5354     "url": "/api/chat/messages/{id}/reject",
5355     "title": "Rejects message",
5356     "examples": [
5357       {
5358         "title": "Example usage:",
5359         "content": "curl https://{domain}/api/chat/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
5360         "type": "json"
5361       }
5362     ],
5363     "name": "rejectMessage",
5364     "group": "Chat_Websites",
5365     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5366     "version": "0.0.0",
5367     "filename": "server/api/chatMessage/index.js",
5368     "groupTitle": "Chat_Websites"
5369   },
5370   {
5371     "type": "put",
5372     "url": "/api/chat/websites/{id}",
5373     "title": "Update an existing Website",
5374     "examples": [
5375       {
5376         "title": "Example usage:",
5377         "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",
5378         "type": "json"
5379       }
5380     ],
5381     "name": "updateWebsites",
5382     "group": "Chat_Websites",
5383     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5384     "version": "0.0.0",
5385     "filename": "server/api/chatWebsite/index.js",
5386     "groupTitle": "Chat_Websites"
5387   },
5388   {
5389     "type": "post",
5390     "url": "/api/cloudProviders",
5391     "title": "Creates a new CloudProvider",
5392     "examples": [
5393       {
5394         "title": "Example usage:",
5395         "content": "curl https://{domain}/api/cloudProviders -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
5396         "type": "json"
5397       }
5398     ],
5399     "name": "CreateCloudProviders",
5400     "group": "CloudProviders",
5401     "parameter": {
5402       "fields": {
5403         "Body": [
5404           {
5405             "group": "Body",
5406             "type": "String",
5407             "optional": false,
5408             "field": "name",
5409             "description": ""
5410           },
5411           {
5412             "group": "Body",
5413             "type": "String",
5414             "allowedValues": [
5415               "\"AmazonAWS\"",
5416               "\"Google\""
5417             ],
5418             "optional": false,
5419             "field": "service",
5420             "description": ""
5421           },
5422           {
5423             "group": "Body",
5424             "type": "String",
5425             "optional": true,
5426             "field": "data1",
5427             "description": ""
5428           },
5429           {
5430             "group": "Body",
5431             "type": "String",
5432             "optional": true,
5433             "field": "data2",
5434             "description": ""
5435           }
5436         ]
5437       }
5438     },
5439     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5440     "version": "0.0.0",
5441     "filename": "server/api/cloudProvider/index.js",
5442     "groupTitle": "CloudProviders"
5443   },
5444   {
5445     "type": "delete",
5446     "url": "/api/cloudProviders/{id}",
5447     "title": "Deletes a CloudProvider",
5448     "examples": [
5449       {
5450         "title": "Example usage:",
5451         "content": "curl https://{domain}/api/cloudProviders/{id} -v -u {name}:{password} -X DELETE",
5452         "type": "json"
5453       }
5454     ],
5455     "name": "DeleteCloudProviders",
5456     "group": "CloudProviders",
5457     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5458     "version": "0.0.0",
5459     "filename": "server/api/cloudProvider/index.js",
5460     "groupTitle": "CloudProviders"
5461   },
5462   {
5463     "type": "get",
5464     "url": "/api/cloudProviders",
5465     "title": "Gets a list of CloudProviders",
5466     "examples": [
5467       {
5468         "title": "Example usage:",
5469         "content": "curl https://{domain}/api/cloudProviders -v -u {name}:{password}",
5470         "type": "json"
5471       }
5472     ],
5473     "name": "GetCloudProviders",
5474     "group": "CloudProviders",
5475     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
5476     "version": "0.0.0",
5477     "filename": "server/api/cloudProvider/index.js",
5478     "groupTitle": "CloudProviders"
5479   },
5480   {
5481     "type": "get",
5482     "url": "/api/cloudProviders/{id}",
5483     "title": "Gets a single CloudProvider",
5484     "examples": [
5485       {
5486         "title": "Example usage:",
5487         "content": "curl https://{domain}/api/cloudProviders/{id} -v -u {name}:{password}",
5488         "type": "json"
5489       }
5490     ],
5491     "name": "ShowCloudProviders",
5492     "group": "CloudProviders",
5493     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5494     "version": "0.0.0",
5495     "filename": "server/api/cloudProvider/index.js",
5496     "groupTitle": "CloudProviders"
5497   },
5498   {
5499     "type": "put",
5500     "url": "/api/cloudProviders/{id}",
5501     "title": "Update an existing CloudProvider",
5502     "examples": [
5503       {
5504         "title": "Example usage:",
5505         "content": "curl https://{domain}/api/cloudProviders/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
5506         "type": "json"
5507       }
5508     ],
5509     "name": "updateCloudProviders",
5510     "group": "CloudProviders",
5511     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5512     "version": "0.0.0",
5513     "filename": "server/api/cloudProvider/index.js",
5514     "groupTitle": "CloudProviders"
5515   },
5516   {
5517     "type": "post",
5518     "url": "/api/cm_contact_has_items",
5519     "title": "Creates a new CmContactHasItem",
5520     "examples": [
5521       {
5522         "title": "Example usage:",
5523         "content": "curl https://{domain}/api/cm_contact_has_items -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
5524         "type": "json"
5525       }
5526     ],
5527     "name": "CreateCmContactHasItems",
5528     "group": "CmContactHasItems",
5529     "parameter": {
5530       "fields": {
5531         "Body": [
5532           {
5533             "group": "Body",
5534             "type": "Integer",
5535             "optional": true,
5536             "field": "CmContactId",
5537             "description": ""
5538           },
5539           {
5540             "group": "Body",
5541             "type": "String",
5542             "optional": true,
5543             "field": "item",
5544             "description": ""
5545           },
5546           {
5547             "group": "Body",
5548             "type": "Integer",
5549             "optional": true,
5550             "field": "ItemTypeId",
5551             "description": ""
5552           },
5553           {
5554             "group": "Body",
5555             "type": "String",
5556             "optional": true,
5557             "field": "ItemClass",
5558             "description": ""
5559           },
5560           {
5561             "group": "Body",
5562             "type": "Integer",
5563             "optional": true,
5564             "field": "OrderBy",
5565             "description": ""
5566           },
5567           {
5568             "group": "Body",
5569             "type": "String",
5570             "optional": true,
5571             "field": "description",
5572             "description": ""
5573           }
5574         ]
5575       }
5576     },
5577     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5578     "version": "0.0.0",
5579     "filename": "server/api/cmContactHasItem/index.js",
5580     "groupTitle": "CmContactHasItems"
5581   },
5582   {
5583     "type": "delete",
5584     "url": "/api/cm_contact_has_items/{id}",
5585     "title": "Deletes a CmContactHasItem",
5586     "examples": [
5587       {
5588         "title": "Example usage:",
5589         "content": "curl https://{domain}/api/cm_contact_has_items/{id} -v -u {name}:{password} -X DELETE",
5590         "type": "json"
5591       }
5592     ],
5593     "name": "DeleteCmContactHasItems",
5594     "group": "CmContactHasItems",
5595     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5596     "version": "0.0.0",
5597     "filename": "server/api/cmContactHasItem/index.js",
5598     "groupTitle": "CmContactHasItems"
5599   },
5600   {
5601     "type": "get",
5602     "url": "/api/cm_contact_has_items",
5603     "title": "Gets a list of CmContactHasItems",
5604     "examples": [
5605       {
5606         "title": "Example usage:",
5607         "content": "curl https://{domain}/api/cm_contact_has_items -v -u {name}:{password}",
5608         "type": "json"
5609       }
5610     ],
5611     "name": "GetCmContactHasItems",
5612     "group": "CmContactHasItems",
5613     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/cm_contact_has_items?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/cm_contact_has_items?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/cm_contact_has_items?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/cm_contact_has_items?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/cm_contact_has_items?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
5614     "version": "0.0.0",
5615     "filename": "server/api/cmContactHasItem/index.js",
5616     "groupTitle": "CmContactHasItems"
5617   },
5618   {
5619     "type": "get",
5620     "url": "/api/cm_contact_has_items/{id}",
5621     "title": "Gets a single CmContactHasItem",
5622     "examples": [
5623       {
5624         "title": "Example usage:",
5625         "content": "curl https://{domain}/api/cm_contact_has_items/{id} -v -u {name}:{password}",
5626         "type": "json"
5627       }
5628     ],
5629     "name": "ShowCmContactHasItems",
5630     "group": "CmContactHasItems",
5631     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5632     "version": "0.0.0",
5633     "filename": "server/api/cmContactHasItem/index.js",
5634     "groupTitle": "CmContactHasItems"
5635   },
5636   {
5637     "type": "put",
5638     "url": "/api/cm_contact_has_items/{id}",
5639     "title": "Update an existing CmContactHasItem",
5640     "examples": [
5641       {
5642         "title": "Example usage:",
5643         "content": "curl https://{domain}/api/cm_contact_has_items/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
5644         "type": "json"
5645       }
5646     ],
5647     "name": "updateCmContactHasItems",
5648     "group": "CmContactHasItems",
5649     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5650     "version": "0.0.0",
5651     "filename": "server/api/cmContactHasItem/index.js",
5652     "groupTitle": "CmContactHasItems"
5653   },
5654   {
5655     "type": "post",
5656     "url": "/api/cm_contact_has_phones",
5657     "title": "Creates a new CmContactHasPhone",
5658     "examples": [
5659       {
5660         "title": "Example usage:",
5661         "content": "curl https://{domain}/api/cm_contact_has_phones -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
5662         "type": "json"
5663       }
5664     ],
5665     "name": "CreateCmContactHasPhones",
5666     "group": "CmContactHasPhones",
5667     "parameter": {
5668       "fields": {
5669         "Body": [
5670           {
5671             "group": "Body",
5672             "type": "Integer",
5673             "optional": true,
5674             "field": "CmContactId",
5675             "description": ""
5676           },
5677           {
5678             "group": "Body",
5679             "type": "String",
5680             "optional": true,
5681             "field": "phone",
5682             "description": ""
5683           }
5684         ]
5685       }
5686     },
5687     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5688     "version": "0.0.0",
5689     "filename": "server/api/cmContactHasPhone/index.js",
5690     "groupTitle": "CmContactHasPhones"
5691   },
5692   {
5693     "type": "delete",
5694     "url": "/api/cm_contact_has_phones/{id}",
5695     "title": "Deletes a CmContactHasPhone",
5696     "examples": [
5697       {
5698         "title": "Example usage:",
5699         "content": "curl https://{domain}/api/cm_contact_has_phones/{id} -v -u {name}:{password} -X DELETE",
5700         "type": "json"
5701       }
5702     ],
5703     "name": "DeleteCmContactHasPhones",
5704     "group": "CmContactHasPhones",
5705     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5706     "version": "0.0.0",
5707     "filename": "server/api/cmContactHasPhone/index.js",
5708     "groupTitle": "CmContactHasPhones"
5709   },
5710   {
5711     "type": "get",
5712     "url": "/api/cm_contact_has_phones",
5713     "title": "Gets a list of CmContactHasPhones",
5714     "examples": [
5715       {
5716         "title": "Example usage:",
5717         "content": "curl https://{domain}/api/cm_contact_has_phones -v -u {name}:{password}",
5718         "type": "json"
5719       }
5720     ],
5721     "name": "GetCmContactHasPhones",
5722     "group": "CmContactHasPhones",
5723     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/cm_contact_has_phones?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/cm_contact_has_phones?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/cm_contact_has_phones?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/cm_contact_has_phones?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/cm_contact_has_phones?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
5724     "version": "0.0.0",
5725     "filename": "server/api/cmContactHasPhone/index.js",
5726     "groupTitle": "CmContactHasPhones"
5727   },
5728   {
5729     "type": "get",
5730     "url": "/api/cm_contact_has_phones/{id}",
5731     "title": "Gets a single CmContactHasPhone",
5732     "examples": [
5733       {
5734         "title": "Example usage:",
5735         "content": "curl https://{domain}/api/cm_contact_has_phones/{id} -v -u {name}:{password}",
5736         "type": "json"
5737       }
5738     ],
5739     "name": "ShowCmContactHasPhones",
5740     "group": "CmContactHasPhones",
5741     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5742     "version": "0.0.0",
5743     "filename": "server/api/cmContactHasPhone/index.js",
5744     "groupTitle": "CmContactHasPhones"
5745   },
5746   {
5747     "type": "put",
5748     "url": "/api/cm_contact_has_phones/{id}",
5749     "title": "Update an existing CmContactHasPhone",
5750     "examples": [
5751       {
5752         "title": "Example usage:",
5753         "content": "curl https://{domain}/api/cm_contact_has_phones/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
5754         "type": "json"
5755       }
5756     ],
5757     "name": "updateCmContactHasPhones",
5758     "group": "CmContactHasPhones",
5759     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5760     "version": "0.0.0",
5761     "filename": "server/api/cmContactHasPhone/index.js",
5762     "groupTitle": "CmContactHasPhones"
5763   },
5764   {
5765     "type": "post",
5766     "url": "/api/cm_hopper_additional_phones",
5767     "title": "Creates a new CmHopperAdditionalPhone",
5768     "examples": [
5769       {
5770         "title": "Example usage:",
5771         "content": "curl https://{domain}/api/cm_hopper_additional_phones -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
5772         "type": "json"
5773       }
5774     ],
5775     "name": "CreateCmHopperAdditionalPhones",
5776     "group": "CmHopperAdditionalPhones",
5777     "parameter": {
5778       "fields": {
5779         "Body": [
5780           {
5781             "group": "Body",
5782             "type": "Integer",
5783             "optional": true,
5784             "field": "CmHopperId",
5785             "description": ""
5786           },
5787           {
5788             "group": "Body",
5789             "type": "String",
5790             "optional": false,
5791             "field": "phone",
5792             "description": ""
5793           },
5794           {
5795             "group": "Body",
5796             "type": "Integer",
5797             "optional": true,
5798             "field": "OrderBy",
5799             "description": ""
5800           },
5801           {
5802             "group": "Body",
5803             "type": "String",
5804             "optional": true,
5805             "field": "scheduledat",
5806             "description": ""
5807           },
5808           {
5809             "group": "Body",
5810             "type": "Integer",
5811             "optional": true,
5812             "field": "countbusyretry",
5813             "description": ""
5814           },
5815           {
5816             "group": "Body",
5817             "type": "Integer",
5818             "optional": true,
5819             "field": "countcongestionretry",
5820             "description": ""
5821           },
5822           {
5823             "group": "Body",
5824             "type": "Integer",
5825             "optional": true,
5826             "field": "countnoanswerretry",
5827             "description": ""
5828           },
5829           {
5830             "group": "Body",
5831             "type": "Integer",
5832             "optional": true,
5833             "field": "countnosuchnumberretry",
5834             "description": ""
5835           },
5836           {
5837             "group": "Body",
5838             "type": "Integer",
5839             "optional": true,
5840             "field": "countdropretry",
5841             "description": ""
5842           },
5843           {
5844             "group": "Body",
5845             "type": "Integer",
5846             "optional": true,
5847             "field": "countabandonedretry",
5848             "description": ""
5849           },
5850           {
5851             "group": "Body",
5852             "type": "Integer",
5853             "optional": true,
5854             "field": "countmachineretry",
5855             "description": ""
5856           },
5857           {
5858             "group": "Body",
5859             "type": "Integer",
5860             "optional": true,
5861             "field": "countagentrejectretry",
5862             "description": ""
5863           }
5864         ]
5865       }
5866     },
5867     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5868     "version": "0.0.0",
5869     "filename": "server/api/cmHopperAdditionalPhone/index.js",
5870     "groupTitle": "CmHopperAdditionalPhones"
5871   },
5872   {
5873     "type": "delete",
5874     "url": "/api/cm_hopper_additional_phones/{id}",
5875     "title": "Deletes a CmHopperAdditionalPhone",
5876     "examples": [
5877       {
5878         "title": "Example usage:",
5879         "content": "curl https://{domain}/api/cm_hopper_additional_phones/{id} -v -u {name}:{password} -X DELETE",
5880         "type": "json"
5881       }
5882     ],
5883     "name": "DeleteCmHopperAdditionalPhones",
5884     "group": "CmHopperAdditionalPhones",
5885     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5886     "version": "0.0.0",
5887     "filename": "server/api/cmHopperAdditionalPhone/index.js",
5888     "groupTitle": "CmHopperAdditionalPhones"
5889   },
5890   {
5891     "type": "get",
5892     "url": "/api/cm_hopper_additional_phones",
5893     "title": "Gets a list of CmHopperAdditionalPhones",
5894     "examples": [
5895       {
5896         "title": "Example usage:",
5897         "content": "curl https://{domain}/api/cm_hopper_additional_phones -v -u {name}:{password}",
5898         "type": "json"
5899       }
5900     ],
5901     "name": "GetCmHopperAdditionalPhones",
5902     "group": "CmHopperAdditionalPhones",
5903     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/cm_hopper_additional_phones?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/cm_hopper_additional_phones?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/cm_hopper_additional_phones?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/cm_hopper_additional_phones?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/cm_hopper_additional_phones?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
5904     "version": "0.0.0",
5905     "filename": "server/api/cmHopperAdditionalPhone/index.js",
5906     "groupTitle": "CmHopperAdditionalPhones"
5907   },
5908   {
5909     "type": "get",
5910     "url": "/api/cm_hopper_additional_phones/{id}",
5911     "title": "Gets a single CmHopperAdditionalPhone",
5912     "examples": [
5913       {
5914         "title": "Example usage:",
5915         "content": "curl https://{domain}/api/cm_hopper_additional_phones/{id} -v -u {name}:{password}",
5916         "type": "json"
5917       }
5918     ],
5919     "name": "ShowCmHopperAdditionalPhones",
5920     "group": "CmHopperAdditionalPhones",
5921     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5922     "version": "0.0.0",
5923     "filename": "server/api/cmHopperAdditionalPhone/index.js",
5924     "groupTitle": "CmHopperAdditionalPhones"
5925   },
5926   {
5927     "type": "put",
5928     "url": "/api/cm_hopper_additional_phones/{id}",
5929     "title": "Update an existing CmHopperAdditionalPhone",
5930     "examples": [
5931       {
5932         "title": "Example usage:",
5933         "content": "curl https://{domain}/api/cm_hopper_additional_phones/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
5934         "type": "json"
5935       }
5936     ],
5937     "name": "updateCmHopperAdditionalPhones",
5938     "group": "CmHopperAdditionalPhones",
5939     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5940     "version": "0.0.0",
5941     "filename": "server/api/cmHopperAdditionalPhone/index.js",
5942     "groupTitle": "CmHopperAdditionalPhones"
5943   },
5944   {
5945     "type": "post",
5946     "url": "/api/cm/companies",
5947     "title": "Creates a new Company",
5948     "examples": [
5949       {
5950         "title": "Example usage:",
5951         "content": "curl https://{domain}/api/cm/companies -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
5952         "type": "json"
5953       }
5954     ],
5955     "name": "CreateCompanies",
5956     "group": "Cm_Companies",
5957     "parameter": {
5958       "fields": {
5959         "Body": [
5960           {
5961             "group": "Body",
5962             "type": "String",
5963             "optional": false,
5964             "field": "name",
5965             "description": ""
5966           },
5967           {
5968             "group": "Body",
5969             "type": "String",
5970             "optional": true,
5971             "field": "vat",
5972             "description": ""
5973           },
5974           {
5975             "group": "Body",
5976             "type": "String",
5977             "optional": true,
5978             "field": "companyId",
5979             "description": ""
5980           },
5981           {
5982             "group": "Body",
5983             "type": "String",
5984             "optional": true,
5985             "field": "website",
5986             "description": ""
5987           },
5988           {
5989             "group": "Body",
5990             "type": "String",
5991             "optional": true,
5992             "field": "phone",
5993             "description": ""
5994           },
5995           {
5996             "group": "Body",
5997             "type": "String",
5998             "optional": true,
5999             "field": "fax",
6000             "description": ""
6001           },
6002           {
6003             "group": "Body",
6004             "type": "String",
6005             "optional": true,
6006             "field": "type",
6007             "description": ""
6008           },
6009           {
6010             "group": "Body",
6011             "type": "String",
6012             "optional": true,
6013             "field": "street",
6014             "description": ""
6015           },
6016           {
6017             "group": "Body",
6018             "type": "String",
6019             "optional": true,
6020             "field": "postalCode",
6021             "description": ""
6022           },
6023           {
6024             "group": "Body",
6025             "type": "String",
6026             "optional": true,
6027             "field": "city",
6028             "description": ""
6029           },
6030           {
6031             "group": "Body",
6032             "type": "String",
6033             "optional": true,
6034             "field": "country",
6035             "description": ""
6036           },
6037           {
6038             "group": "Body",
6039             "type": "String",
6040             "optional": true,
6041             "field": "email",
6042             "description": ""
6043           },
6044           {
6045             "group": "Body",
6046             "type": "String",
6047             "optional": true,
6048             "field": "emailDomain",
6049             "description": ""
6050           },
6051           {
6052             "group": "Body",
6053             "type": "String",
6054             "optional": true,
6055             "field": "sStreet",
6056             "description": ""
6057           },
6058           {
6059             "group": "Body",
6060             "type": "String",
6061             "optional": true,
6062             "field": "sPostalCode",
6063             "description": ""
6064           },
6065           {
6066             "group": "Body",
6067             "type": "String",
6068             "optional": true,
6069             "field": "sCity",
6070             "description": ""
6071           },
6072           {
6073             "group": "Body",
6074             "type": "String",
6075             "optional": true,
6076             "field": "sCountry",
6077             "description": ""
6078           },
6079           {
6080             "group": "Body",
6081             "type": "String",
6082             "optional": true,
6083             "field": "description",
6084             "description": ""
6085           }
6086         ]
6087       }
6088     },
6089     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6090     "version": "0.0.0",
6091     "filename": "server/api/cmCompany/index.js",
6092     "groupTitle": "Cm_Companies"
6093   },
6094   {
6095     "type": "delete",
6096     "url": "/api/cm/companies/{id}",
6097     "title": "Deletes a Company",
6098     "examples": [
6099       {
6100         "title": "Example usage:",
6101         "content": "curl https://{domain}/api/cm/companies/{id} -v -u {name}:{password} -X DELETE",
6102         "type": "json"
6103       }
6104     ],
6105     "name": "DeleteCompanies",
6106     "group": "Cm_Companies",
6107     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6108     "version": "0.0.0",
6109     "filename": "server/api/cmCompany/index.js",
6110     "groupTitle": "Cm_Companies"
6111   },
6112   {
6113     "type": "get",
6114     "url": "/api/cm/companies/describe",
6115     "title": "Gets table info about Companies",
6116     "examples": [
6117       {
6118         "title": "Example usage:",
6119         "content": "curl https://{domain}/api/cm/companies/describe -v -u {name}:{password}",
6120         "type": "json"
6121       }
6122     ],
6123     "name": "DescribeCompanies",
6124     "group": "Cm_Companies",
6125     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6126     "version": "0.0.0",
6127     "filename": "server/api/cmCompany/index.js",
6128     "groupTitle": "Cm_Companies"
6129   },
6130   {
6131     "type": "get",
6132     "url": "/api/cm/companies",
6133     "title": "Gets a list of Companies",
6134     "examples": [
6135       {
6136         "title": "Example usage:",
6137         "content": "curl https://{domain}/api/cm/companies -v -u {name}:{password}",
6138         "type": "json"
6139       }
6140     ],
6141     "name": "GetCompanies",
6142     "group": "Cm_Companies",
6143     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
6144     "version": "0.0.0",
6145     "filename": "server/api/cmCompany/index.js",
6146     "groupTitle": "Cm_Companies"
6147   },
6148   {
6149     "type": "get",
6150     "url": "/api/cm/companies/{id}",
6151     "title": "Gets a single Company",
6152     "examples": [
6153       {
6154         "title": "Example usage:",
6155         "content": "curl https://{domain}/api/cm/companies/{id} -v -u {name}:{password}",
6156         "type": "json"
6157       }
6158     ],
6159     "name": "ShowCompanies",
6160     "group": "Cm_Companies",
6161     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6162     "version": "0.0.0",
6163     "filename": "server/api/cmCompany/index.js",
6164     "groupTitle": "Cm_Companies"
6165   },
6166   {
6167     "type": "post",
6168     "url": "/api/cm/companies/{id}/contacts",
6169     "title": "Creates new contacts",
6170     "examples": [
6171       {
6172         "title": "Example usage:",
6173         "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",
6174         "type": "json"
6175       }
6176     ],
6177     "name": "addContacts",
6178     "group": "Cm_Companies",
6179     "parameter": {
6180       "fields": {
6181         "Body": [
6182           {
6183             "group": "Body",
6184             "type": "String",
6185             "optional": false,
6186             "field": "firstName",
6187             "description": ""
6188           },
6189           {
6190             "group": "Body",
6191             "type": "String",
6192             "optional": true,
6193             "field": "lastName",
6194             "description": ""
6195           },
6196           {
6197             "group": "Body",
6198             "type": "String",
6199             "optional": true,
6200             "field": "street",
6201             "description": ""
6202           },
6203           {
6204             "group": "Body",
6205             "type": "String",
6206             "optional": true,
6207             "field": "postalCode",
6208             "description": ""
6209           },
6210           {
6211             "group": "Body",
6212             "type": "String",
6213             "optional": true,
6214             "field": "city",
6215             "description": ""
6216           },
6217           {
6218             "group": "Body",
6219             "type": "String",
6220             "optional": true,
6221             "field": "country",
6222             "description": ""
6223           },
6224           {
6225             "group": "Body",
6226             "type": "String",
6227             "optional": true,
6228             "field": "dateOfBirth",
6229             "description": ""
6230           },
6231           {
6232             "group": "Body",
6233             "type": "Text",
6234             "optional": true,
6235             "field": "description",
6236             "description": ""
6237           },
6238           {
6239             "group": "Body",
6240             "type": "String",
6241             "optional": true,
6242             "field": "phone",
6243             "description": ""
6244           },
6245           {
6246             "group": "Body",
6247             "type": "String",
6248             "optional": true,
6249             "field": "mobile",
6250             "description": ""
6251           },
6252           {
6253             "group": "Body",
6254             "type": "String",
6255             "optional": true,
6256             "field": "fax",
6257             "description": ""
6258           },
6259           {
6260             "group": "Body",
6261             "type": "String",
6262             "optional": true,
6263             "field": "email",
6264             "description": ""
6265           },
6266           {
6267             "group": "Body",
6268             "type": "String",
6269             "optional": true,
6270             "field": "url",
6271             "description": ""
6272           },
6273           {
6274             "group": "Body",
6275             "type": "String",
6276             "optional": true,
6277             "field": "facebook",
6278             "description": ""
6279           },
6280           {
6281             "group": "Body",
6282             "type": "String",
6283             "optional": true,
6284             "field": "fb_data",
6285             "description": ""
6286           },
6287           {
6288             "group": "Body",
6289             "type": "String",
6290             "optional": true,
6291             "field": "twitter",
6292             "description": ""
6293           },
6294           {
6295             "group": "Body",
6296             "type": "String",
6297             "optional": true,
6298             "field": "skype",
6299             "description": ""
6300           },
6301           {
6302             "group": "Body",
6303             "type": "String",
6304             "optional": true,
6305             "field": "teams",
6306             "description": ""
6307           },
6308           {
6309             "group": "Body",
6310             "type": "String",
6311             "optional": true,
6312             "field": "viber",
6313             "description": ""
6314           },
6315           {
6316             "group": "Body",
6317             "type": "String",
6318             "optional": true,
6319             "field": "line",
6320             "description": ""
6321           },
6322           {
6323             "group": "Body",
6324             "type": "String",
6325             "optional": true,
6326             "field": "wechat",
6327             "description": ""
6328           },
6329           {
6330             "group": "Body",
6331             "type": "String",
6332             "optional": true,
6333             "field": "telegram",
6334             "description": ""
6335           },
6336           {
6337             "group": "Body",
6338             "type": "Integer",
6339             "optional": true,
6340             "field": "UserId",
6341             "description": ""
6342           },
6343           {
6344             "group": "Body",
6345             "type": "Integer",
6346             "optional": true,
6347             "field": "priority",
6348             "description": ""
6349           },
6350           {
6351             "group": "Body",
6352             "type": "String",
6353             "optional": true,
6354             "field": "scheduledat",
6355             "description": ""
6356           }
6357         ]
6358       }
6359     },
6360     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6361     "version": "0.0.0",
6362     "filename": "server/api/cmCompany/index.js",
6363     "groupTitle": "Cm_Companies"
6364   },
6365   {
6366     "type": "get",
6367     "url": "/api/cm/companies/{id}/contacts",
6368     "title": "Gets List Contacts",
6369     "examples": [
6370       {
6371         "title": "Example usage:",
6372         "content": "curl https://{domain}/api/fax/companies/{id}/contacts -v -u {name}:{password} -X GET",
6373         "type": "json"
6374       }
6375     ],
6376     "name": "getContacts",
6377     "group": "Cm_Companies",
6378     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6379     "version": "0.0.0",
6380     "filename": "server/api/cmCompany/index.js",
6381     "groupTitle": "Cm_Companies"
6382   },
6383   {
6384     "type": "put",
6385     "url": "/api/cm/companies/{id}",
6386     "title": "Update an existing Company",
6387     "examples": [
6388       {
6389         "title": "Example usage:",
6390         "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",
6391         "type": "json"
6392       }
6393     ],
6394     "name": "updateCompanies",
6395     "group": "Cm_Companies",
6396     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6397     "version": "0.0.0",
6398     "filename": "server/api/cmCompany/index.js",
6399     "groupTitle": "Cm_Companies"
6400   },
6401   {
6402     "type": "delete",
6403     "url": "/api/cm/contacts/{id}",
6404     "title": "Deletes a Contact",
6405     "examples": [
6406       {
6407         "title": "Example usage:",
6408         "content": "curl https://{domain}/api/cm/contacts/{id} -v -u {name}:{password} -X DELETE",
6409         "type": "json"
6410       }
6411     ],
6412     "name": "DeleteContacts",
6413     "group": "Cm_Contacts",
6414     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6415     "version": "0.0.0",
6416     "filename": "server/api/cmContact/index.js",
6417     "groupTitle": "Cm_Contacts"
6418   },
6419   {
6420     "type": "get",
6421     "url": "/api/cm/contacts/describe",
6422     "title": "Gets table info about Contacts",
6423     "examples": [
6424       {
6425         "title": "Example usage:",
6426         "content": "curl https://{domain}/api/cm/contacts/describe -v -u {name}:{password}",
6427         "type": "json"
6428       }
6429     ],
6430     "name": "DescribeContacts",
6431     "group": "Cm_Contacts",
6432     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6433     "version": "0.0.0",
6434     "filename": "server/api/cmContact/index.js",
6435     "groupTitle": "Cm_Contacts"
6436   },
6437   {
6438     "type": "get",
6439     "url": "/api/cm/contacts",
6440     "title": "Gets a list of Contacts",
6441     "examples": [
6442       {
6443         "title": "Example usage:",
6444         "content": "curl https://{domain}/api/cm/contacts -v -u {name}:{password}",
6445         "type": "json"
6446       }
6447     ],
6448     "name": "GetContacts",
6449     "group": "Cm_Contacts",
6450     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
6451     "version": "0.0.0",
6452     "filename": "server/api/cmContact/index.js",
6453     "groupTitle": "Cm_Contacts"
6454   },
6455   {
6456     "type": "get",
6457     "url": "/api/cm/contacts/{id}/finals",
6458     "title": "Gets contact hopper finals",
6459     "examples": [
6460       {
6461         "title": "Example usage:",
6462         "content": "curl https://{domain}/api/cm/contacts/{id}/hopper_finals -v -u {name}:{password}  -X GET",
6463         "type": "json"
6464       }
6465     ],
6466     "name": "GetHopperFinals",
6467     "group": "Cm_Contacts",
6468     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6469     "version": "0.0.0",
6470     "filename": "server/api/cmContact/index.js",
6471     "groupTitle": "Cm_Contacts"
6472   },
6473   {
6474     "type": "get",
6475     "url": "/api/cm/contacts/{id}/hopper_histories",
6476     "title": "Gets contact hopper histories",
6477     "examples": [
6478       {
6479         "title": "Example usage:",
6480         "content": "curl https://{domain}/api/cm/contacts/{id}/hopper_histories -v -u {name}:{password} -X GET",
6481         "type": "json"
6482       }
6483     ],
6484     "name": "GetHopperHistories",
6485     "group": "Cm_Contacts",
6486     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6487     "version": "0.0.0",
6488     "filename": "server/api/cmContact/index.js",
6489     "groupTitle": "Cm_Contacts"
6490   },
6491   {
6492     "type": "get",
6493     "url": "/api/cm/contacts/{id}/hoppers",
6494     "title": "Gets contact hoppers",
6495     "examples": [
6496       {
6497         "title": "Example usage:",
6498         "content": "curl https://{domain}/api/cm/contacts/{id}/hoppers -v -u {name}:{password} -X GET",
6499         "type": "json"
6500       }
6501     ],
6502     "name": "GetHoppers",
6503     "group": "Cm_Contacts",
6504     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6505     "version": "0.0.0",
6506     "filename": "server/api/cmContact/index.js",
6507     "groupTitle": "Cm_Contacts"
6508   },
6509   {
6510     "type": "post",
6511     "url": "/api/cm/contacts/create_many",
6512     "title": "Create Contacts",
6513     "examples": [
6514       {
6515         "title": "Example usage:",
6516         "content": "curl https://{domain}/api/cm/contacts/create_many -d '[{\"firstName\": \"John\", \"lastName\": \"doe\", \"...\": \"...\"}]' -v -u {name}:{password} -X POST",
6517         "type": "json"
6518       }
6519     ],
6520     "name": "bulkCreate",
6521     "group": "Cm_Contacts",
6522     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6523     "version": "0.0.0",
6524     "filename": "server/api/cmContact/index.js",
6525     "groupTitle": "Cm_Contacts"
6526   },
6527   {
6528     "type": "post",
6529     "url": "/api/cm/contacts",
6530     "title": "Create Contact",
6531     "examples": [
6532       {
6533         "title": "Example usage:",
6534         "content": "curl https://{domain}/api/cm/contacts -d '{\"firstName\": \"John\", \"lastName\": \"doe\", \"...\": \"...\"}' -v -u {name}:{password} -X POST",
6535         "type": "json"
6536       }
6537     ],
6538     "name": "create",
6539     "group": "Cm_Contacts",
6540     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6541     "version": "0.0.0",
6542     "filename": "server/api/cmContact/index.js",
6543     "groupTitle": "Cm_Contacts"
6544   },
6545   {
6546     "type": "get",
6547     "url": "/api/cm/contacts/{id}/journey",
6548     "title": "Gets customer journey",
6549     "examples": [
6550       {
6551         "title": "Example usage:",
6552         "content": "curl https://{domain}/api/cm/contacts/{id}/journey -v -u {name}:{password}  -X GET",
6553         "type": "json"
6554       }
6555     ],
6556     "name": "getJourney",
6557     "group": "Cm_Contacts",
6558     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6559     "version": "0.0.0",
6560     "filename": "server/api/cmContact/index.js",
6561     "groupTitle": "Cm_Contacts"
6562   },
6563   {
6564     "type": "get",
6565     "url": "/api/cm/contacts/{id}/jscripty_sessions",
6566     "title": "Gets contact hopper blacks",
6567     "examples": [
6568       {
6569         "title": "Example usage:",
6570         "content": "curl https://{domain}/api/cm/contacts/{id}/hopper_black -v -u {name}:{password}  -X GET",
6571         "type": "json"
6572       }
6573     ],
6574     "name": "getJscriptySessions",
6575     "group": "Cm_Contacts",
6576     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6577     "version": "0.0.0",
6578     "filename": "server/api/cmContact/index.js",
6579     "groupTitle": "Cm_Contacts"
6580   },
6581   {
6582     "type": "get",
6583     "url": "/api/cm/contacts/{id}/tags",
6584     "title": "Gets configurations tags",
6585     "examples": [
6586       {
6587         "title": "Example usage:",
6588         "content": "curl https://{domain}/api/cm/contacts/{id}/tags -v -u {name}:{password} -X GET",
6589         "type": "json"
6590       }
6591     ],
6592     "name": "getTags",
6593     "group": "Cm_Contacts",
6594     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6595     "version": "0.0.0",
6596     "filename": "server/api/cmContact/index.js",
6597     "groupTitle": "Cm_Contacts"
6598   },
6599   {
6600     "type": "post",
6601     "url": "/api/cm/contacts/merge",
6602     "title": "Merge Contact",
6603     "examples": [
6604       {
6605         "title": "Example usage:",
6606         "content": "curl https://{domain}/api/cm/contacts/merge -d '{\"from\": 1, \"to\": 2}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
6607         "type": "json"
6608       }
6609     ],
6610     "name": "merge",
6611     "group": "Cm_Contacts",
6612     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6613     "version": "0.0.0",
6614     "filename": "server/api/cmContact/index.js",
6615     "groupTitle": "Cm_Contacts"
6616   },
6617   {
6618     "type": "post",
6619     "url": "/api/cm/contacts/{id}/tags",
6620     "title": "Sets new tags",
6621     "examples": [
6622       {
6623         "title": "Example usage:",
6624         "content": "curl https://{domain}/api/cm/contacts/{id}/tags -d '{\"ids\": [1,12]}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
6625         "type": "json"
6626       }
6627     ],
6628     "name": "setTags",
6629     "group": "Cm_Contacts",
6630     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6631     "version": "0.0.0",
6632     "filename": "server/api/cmContact/index.js",
6633     "groupTitle": "Cm_Contacts"
6634   },
6635   {
6636     "type": "get",
6637     "url": "/api/cm/contacts/{id}",
6638     "title": "Gets a single Contact",
6639     "examples": [
6640       {
6641         "title": "Example usage:",
6642         "content": "curl https://{domain}/api/cm/contacts/{id} -v -u {name}:{password} -X GET",
6643         "type": "json"
6644       }
6645     ],
6646     "name": "show",
6647     "group": "Cm_Contacts",
6648     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6649     "version": "0.0.0",
6650     "filename": "server/api/cmContact/index.js",
6651     "groupTitle": "Cm_Contacts"
6652   },
6653   {
6654     "type": "put",
6655     "url": "/api/cm/contacts/{id}",
6656     "title": "Update a single Contact",
6657     "examples": [
6658       {
6659         "title": "Example usage:",
6660         "content": "curl https://{domain}/api/cm/contacts/{id} -d '{\"firstName\": \"John\", \"lastName\": \"Doe\"}' -v -u {name}:{password} -X PUT",
6661         "type": "json"
6662       }
6663     ],
6664     "name": "update",
6665     "group": "Cm_Contacts",
6666     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6667     "version": "0.0.0",
6668     "filename": "server/api/cmContact/index.js",
6669     "groupTitle": "Cm_Contacts"
6670   },
6671   {
6672     "type": "delete",
6673     "url": "/api/cm/custom_fields/{id}",
6674     "title": "Deletes a Custom Field",
6675     "examples": [
6676       {
6677         "title": "Example usage:",
6678         "content": "curl https://{domain}/api/cm/custom_fields/{id} -v -u {name}:{password} -X DELETE",
6679         "type": "json"
6680       }
6681     ],
6682     "name": "DeleteCustom_Fields",
6683     "group": "Cm_Custom_Fields",
6684     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6685     "version": "0.0.0",
6686     "filename": "server/api/cmCustomField/index.js",
6687     "groupTitle": "Cm_Custom_Fields"
6688   },
6689   {
6690     "type": "get",
6691     "url": "/api/cm/custom_fields",
6692     "title": "Gets a list of Custom Fields",
6693     "examples": [
6694       {
6695         "title": "Example usage:",
6696         "content": "curl https://{domain}/api/cm/custom_fields -v -u {name}:{password}",
6697         "type": "json"
6698       }
6699     ],
6700     "name": "GetCustom_Fields",
6701     "group": "Cm_Custom_Fields",
6702     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
6703     "version": "0.0.0",
6704     "filename": "server/api/cmCustomField/index.js",
6705     "groupTitle": "Cm_Custom_Fields"
6706   },
6707   {
6708     "type": "get",
6709     "url": "/api/cm/custom_fields/{id}",
6710     "title": "Gets a single Custom Field",
6711     "examples": [
6712       {
6713         "title": "Example usage:",
6714         "content": "curl https://{domain}/api/cm/custom_fields/{id} -v -u {name}:{password}",
6715         "type": "json"
6716       }
6717     ],
6718     "name": "ShowCustom_Fields",
6719     "group": "Cm_Custom_Fields",
6720     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6721     "version": "0.0.0",
6722     "filename": "server/api/cmCustomField/index.js",
6723     "groupTitle": "Cm_Custom_Fields"
6724   },
6725   {
6726     "type": "put",
6727     "url": "/api/cm/custom_fields/{id}",
6728     "title": "Update an existing Custom Field",
6729     "examples": [
6730       {
6731         "title": "Example usage:",
6732         "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",
6733         "type": "json"
6734       }
6735     ],
6736     "name": "updateCustom_Fields",
6737     "group": "Cm_Custom_Fields",
6738     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6739     "version": "0.0.0",
6740     "filename": "server/api/cmCustomField/index.js",
6741     "groupTitle": "Cm_Custom_Fields"
6742   },
6743   {
6744     "type": "post",
6745     "url": "/api/cm/hopper",
6746     "title": "Creates a new Hopper",
6747     "examples": [
6748       {
6749         "title": "Example usage:",
6750         "content": "curl https://{domain}/api/cm/hopper -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
6751         "type": "json"
6752       }
6753     ],
6754     "name": "CreateHopper",
6755     "group": "Cm_Hopper",
6756     "parameter": {
6757       "fields": {
6758         "Body": [
6759           {
6760             "group": "Body",
6761             "type": "String",
6762             "optional": false,
6763             "field": "phone",
6764             "description": ""
6765           },
6766           {
6767             "group": "Body",
6768             "type": "Boolean",
6769             "optional": true,
6770             "field": "active",
6771             "description": ""
6772           },
6773           {
6774             "group": "Body",
6775             "type": "String",
6776             "optional": true,
6777             "field": "scheduledat",
6778             "description": ""
6779           },
6780           {
6781             "group": "Body",
6782             "type": "Integer",
6783             "optional": true,
6784             "field": "countbusyretry",
6785             "description": ""
6786           },
6787           {
6788             "group": "Body",
6789             "type": "Integer",
6790             "optional": true,
6791             "field": "countcongestionretry",
6792             "description": ""
6793           },
6794           {
6795             "group": "Body",
6796             "type": "Integer",
6797             "optional": true,
6798             "field": "countnoanswerretry",
6799             "description": ""
6800           },
6801           {
6802             "group": "Body",
6803             "type": "Boolean",
6804             "optional": true,
6805             "field": "callback",
6806             "description": ""
6807           },
6808           {
6809             "group": "Body",
6810             "type": "String",
6811             "optional": true,
6812             "field": "callbackuniqueid",
6813             "description": ""
6814           },
6815           {
6816             "group": "Body",
6817             "type": "String",
6818             "optional": true,
6819             "field": "callbackat",
6820             "description": ""
6821           },
6822           {
6823             "group": "Body",
6824             "type": "Integer",
6825             "optional": true,
6826             "field": "priority",
6827             "description": ""
6828           },
6829           {
6830             "group": "Body",
6831             "type": "Boolean",
6832             "optional": true,
6833             "field": "recallme",
6834             "description": ""
6835           },
6836           {
6837             "group": "Body",
6838             "type": "Integer",
6839             "optional": true,
6840             "field": "ContactId",
6841             "description": ""
6842           },
6843           {
6844             "group": "Body",
6845             "type": "Integer",
6846             "optional": true,
6847             "field": "ListId",
6848             "description": ""
6849           },
6850           {
6851             "group": "Body",
6852             "type": "Integer",
6853             "optional": true,
6854             "field": "UserId",
6855             "description": ""
6856           },
6857           {
6858             "group": "Body",
6859             "type": "Integer",
6860             "optional": true,
6861             "field": "VoiceQueueId",
6862             "description": ""
6863           },
6864           {
6865             "group": "Body",
6866             "type": "Integer",
6867             "optional": true,
6868             "field": "CampaignId",
6869             "description": ""
6870           },
6871           {
6872             "group": "Body",
6873             "type": "Integer",
6874             "optional": true,
6875             "field": "countnosuchnumberretry",
6876             "description": ""
6877           },
6878           {
6879             "group": "Body",
6880             "type": "Integer",
6881             "optional": true,
6882             "field": "countdropretry",
6883             "description": ""
6884           },
6885           {
6886             "group": "Body",
6887             "type": "Integer",
6888             "optional": true,
6889             "field": "countabandonedretry",
6890             "description": ""
6891           },
6892           {
6893             "group": "Body",
6894             "type": "Integer",
6895             "optional": true,
6896             "field": "countmachineretry",
6897             "description": ""
6898           },
6899           {
6900             "group": "Body",
6901             "type": "Integer",
6902             "optional": true,
6903             "field": "countagentrejectretry",
6904             "description": ""
6905           }
6906         ]
6907       }
6908     },
6909     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6910     "version": "0.0.0",
6911     "filename": "server/api/cmHopper/index.js",
6912     "groupTitle": "Cm_Hopper"
6913   },
6914   {
6915     "type": "get",
6916     "url": "/api/cm/hopper/describe",
6917     "title": "Gets table info about Hopper",
6918     "examples": [
6919       {
6920         "title": "Example usage:",
6921         "content": "curl https://{domain}/api/cm/hopper/describe -v -u {name}:{password}",
6922         "type": "json"
6923       }
6924     ],
6925     "name": "DescribeHopper",
6926     "group": "Cm_Hopper",
6927     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6928     "version": "0.0.0",
6929     "filename": "server/api/cmHopper/index.js",
6930     "groupTitle": "Cm_Hopper"
6931   },
6932   {
6933     "type": "get",
6934     "url": "/api/cm/hopper",
6935     "title": "Gets a list of Hopper",
6936     "examples": [
6937       {
6938         "title": "Example usage:",
6939         "content": "curl https://{domain}/api/cm/hopper -v -u {name}:{password}",
6940         "type": "json"
6941       }
6942     ],
6943     "name": "GetHopper",
6944     "group": "Cm_Hopper",
6945     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
6946     "version": "0.0.0",
6947     "filename": "server/api/cmHopper/index.js",
6948     "groupTitle": "Cm_Hopper"
6949   },
6950   {
6951     "type": "get",
6952     "url": "/api/cm/hopper/{id}",
6953     "title": "Gets a single Hopper",
6954     "examples": [
6955       {
6956         "title": "Example usage:",
6957         "content": "curl https://{domain}/api/cm/hopper/{id} -v -u {name}:{password}",
6958         "type": "json"
6959       }
6960     ],
6961     "name": "ShowHopper",
6962     "group": "Cm_Hopper",
6963     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6964     "version": "0.0.0",
6965     "filename": "server/api/cmHopper/index.js",
6966     "groupTitle": "Cm_Hopper"
6967   },
6968   {
6969     "type": "delete",
6970     "url": "/api/cm/hopper_black/{id}",
6971     "title": "Deletes a Hopper Black",
6972     "examples": [
6973       {
6974         "title": "Example usage:",
6975         "content": "curl https://{domain}/api/cm/hopper_black/{id} -v -u {name}:{password} -X DELETE",
6976         "type": "json"
6977       }
6978     ],
6979     "name": "DeleteHopper_Black",
6980     "group": "Cm_Hopper_Black",
6981     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6982     "version": "0.0.0",
6983     "filename": "server/api/cmHopperBlack/index.js",
6984     "groupTitle": "Cm_Hopper_Black"
6985   },
6986   {
6987     "type": "get",
6988     "url": "/api/cm/hopper_black/describe",
6989     "title": "Gets table info about Hopper Black",
6990     "examples": [
6991       {
6992         "title": "Example usage:",
6993         "content": "curl https://{domain}/api/cm/hopper_black/describe -v -u {name}:{password}",
6994         "type": "json"
6995       }
6996     ],
6997     "name": "DescribeHopper_Black",
6998     "group": "Cm_Hopper_Black",
6999     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7000     "version": "0.0.0",
7001     "filename": "server/api/cmHopperBlack/index.js",
7002     "groupTitle": "Cm_Hopper_Black"
7003   },
7004   {
7005     "type": "get",
7006     "url": "/api/cm/hopper_black",
7007     "title": "Gets a list of Hopper Black",
7008     "examples": [
7009       {
7010         "title": "Example usage:",
7011         "content": "curl https://{domain}/api/cm/hopper_black -v -u {name}:{password}",
7012         "type": "json"
7013       }
7014     ],
7015     "name": "GetHopper_Black",
7016     "group": "Cm_Hopper_Black",
7017     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
7018     "version": "0.0.0",
7019     "filename": "server/api/cmHopperBlack/index.js",
7020     "groupTitle": "Cm_Hopper_Black"
7021   },
7022   {
7023     "type": "get",
7024     "url": "/api/cm/hopper_black/{id}",
7025     "title": "Gets a single Hopper Black",
7026     "examples": [
7027       {
7028         "title": "Example usage:",
7029         "content": "curl https://{domain}/api/cm/hopper_black/{id} -v -u {name}:{password}",
7030         "type": "json"
7031       }
7032     ],
7033     "name": "ShowHopper_Black",
7034     "group": "Cm_Hopper_Black",
7035     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7036     "version": "0.0.0",
7037     "filename": "server/api/cmHopperBlack/index.js",
7038     "groupTitle": "Cm_Hopper_Black"
7039   },
7040   {
7041     "type": "put",
7042     "url": "/api/cm/hopper_black/{id}",
7043     "title": "Update an existing Hopper Black",
7044     "examples": [
7045       {
7046         "title": "Example usage:",
7047         "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",
7048         "type": "json"
7049       }
7050     ],
7051     "name": "updateHopper_Black",
7052     "group": "Cm_Hopper_Black",
7053     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7054     "version": "0.0.0",
7055     "filename": "server/api/cmHopperBlack/index.js",
7056     "groupTitle": "Cm_Hopper_Black"
7057   },
7058   {
7059     "type": "post",
7060     "url": "/api/cm/hopper_final/checkContactHopper",
7061     "title": "Check if contact is in hopper",
7062     "examples": [
7063       {
7064         "title": "Example usage:",
7065         "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",
7066         "type": "json"
7067       }
7068     ],
7069     "name": "/checkContactHopper",
7070     "group": "Cm_Hopper_Final",
7071     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7072     "version": "0.0.0",
7073     "filename": "server/api/cmHopperFinal/index.js",
7074     "groupTitle": "Cm_Hopper_Final"
7075   },
7076   {
7077     "type": "get",
7078     "url": "/api/cm/hopper_final/describe",
7079     "title": "Gets table info about HopperFinal",
7080     "examples": [
7081       {
7082         "title": "Example usage:",
7083         "content": "curl https://{domain}/api/cm/hopper_final/describe -v -u {name}:{password}",
7084         "type": "json"
7085       }
7086     ],
7087     "name": "DescribeHopperFinal",
7088     "group": "Cm_Hopper_Final",
7089     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7090     "version": "0.0.0",
7091     "filename": "server/api/cmHopperFinal/index.js",
7092     "groupTitle": "Cm_Hopper_Final"
7093   },
7094   {
7095     "type": "get",
7096     "url": "/api/cm/hopper_final",
7097     "title": "Gets a list of HopperFinal",
7098     "examples": [
7099       {
7100         "title": "Example usage:",
7101         "content": "curl https://{domain}/api/cm/hopper_final -v -u {name}:{password}",
7102         "type": "json"
7103       }
7104     ],
7105     "name": "GetHopperFinal",
7106     "group": "Cm_Hopper_Final",
7107     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
7108     "version": "0.0.0",
7109     "filename": "server/api/cmHopperFinal/index.js",
7110     "groupTitle": "Cm_Hopper_Final"
7111   },
7112   {
7113     "type": "get",
7114     "url": "/api/cm/hopper_final/{id}",
7115     "title": "Gets a single HopperFinal",
7116     "examples": [
7117       {
7118         "title": "Example usage:",
7119         "content": "curl https://{domain}/api/cm/hopper_final/{id} -v -u {name}:{password}",
7120         "type": "json"
7121       }
7122     ],
7123     "name": "ShowHopperFinal",
7124     "group": "Cm_Hopper_Final",
7125     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7126     "version": "0.0.0",
7127     "filename": "server/api/cmHopperFinal/index.js",
7128     "groupTitle": "Cm_Hopper_Final"
7129   },
7130   {
7131     "type": "get",
7132     "url": "/api/cm/hopper_final/campaign/countAttributes/{id}",
7133     "title": "Return number contacts for attributes",
7134     "examples": [
7135       {
7136         "title": "Example usage:",
7137         "content": "curl https://{domain}/api/hopper_final/campaign/countAttributes/{id} -d '{\"disposition\": \"OK\"}' -v -u {name}:{password} -X GET",
7138         "type": "json"
7139       }
7140     ],
7141     "name": "countContactsIvrCampaignHopperFinal",
7142     "group": "Cm_Hopper_Final",
7143     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7144     "version": "0.0.0",
7145     "filename": "server/api/cmHopperFinal/index.js",
7146     "groupTitle": "Cm_Hopper_Final"
7147   },
7148   {
7149     "type": "get",
7150     "url": "/api/cm/hopper_final/voice/queue/countAttributes/{id}",
7151     "title": "Return number contacts for attributes",
7152     "examples": [
7153       {
7154         "title": "Example usage:",
7155         "content": "curl https://{domain}/api/hopper_final/voice/queue/countAttributes/{id} -d '{\"disposition\": \"OK\"}' -v -u {name}:{password} -X GET",
7156         "type": "json"
7157       }
7158     ],
7159     "name": "countContactsQueueCampaignHopperFinal",
7160     "group": "Cm_Hopper_Final",
7161     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7162     "version": "0.0.0",
7163     "filename": "server/api/cmHopperFinal/index.js",
7164     "groupTitle": "Cm_Hopper_Final"
7165   },
7166   {
7167     "type": "post",
7168     "url": "/api/cm/hopper_final/campaign/{id}",
7169     "title": "Move contacts in hopper",
7170     "examples": [
7171       {
7172         "title": "Example usage:",
7173         "content": "curl https://{domain}/api/hopper_final/campaign/moveContacts/{id} -d '{\"state\": \"state\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
7174         "type": "json"
7175       }
7176     ],
7177     "name": "moveContactsIvrCampaignHopperFinal",
7178     "group": "Cm_Hopper_Final",
7179     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7180     "version": "0.0.0",
7181     "filename": "server/api/cmHopperFinal/index.js",
7182     "groupTitle": "Cm_Hopper_Final"
7183   },
7184   {
7185     "type": "post",
7186     "url": "/api/cm/hopper_final/voice/queue/{id}",
7187     "title": "Move contacts in hopper",
7188     "examples": [
7189       {
7190         "title": "Example usage:",
7191         "content": "curl https://{domain}/api/hopper_final/voice/queue/moveContacts/{id} -d '{\"state\": \"state\"}' -H 'Content-Type: application/json' -v -u {name}:{password}",
7192         "type": "json"
7193       }
7194     ],
7195     "name": "moveContactsQueueCampaignHopperFinal",
7196     "group": "Cm_Hopper_Final",
7197     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7198     "version": "0.0.0",
7199     "filename": "server/api/cmHopperFinal/index.js",
7200     "groupTitle": "Cm_Hopper_Final"
7201   },
7202   {
7203     "type": "put",
7204     "url": "/api/cm/hopper_final/{id}",
7205     "title": "Update a single hopper final",
7206     "examples": [
7207       {
7208         "title": "Example usage:",
7209         "content": "curl https://{domain}/api/hopper_final/{id} -d '{\"disposition\": \"OK\"}' -v -u {name}:{password} -X PUT",
7210         "type": "json"
7211       }
7212     ],
7213     "name": "update",
7214     "group": "Cm_Hopper_Final",
7215     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7216     "version": "0.0.0",
7217     "filename": "server/api/cmHopperFinal/index.js",
7218     "groupTitle": "Cm_Hopper_Final"
7219   },
7220   {
7221     "type": "post",
7222     "url": "/api/cm/hopper_history",
7223     "title": "Creates a new HopperHistory",
7224     "examples": [
7225       {
7226         "title": "Example usage:",
7227         "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",
7228         "type": "json"
7229       }
7230     ],
7231     "name": "CreateHopperHistory",
7232     "group": "Cm_Hopper_History",
7233     "parameter": {
7234       "fields": {
7235         "Body": [
7236           {
7237             "group": "Body",
7238             "type": "Integer",
7239             "optional": true,
7240             "field": "state",
7241             "description": ""
7242           },
7243           {
7244             "group": "Body",
7245             "type": "String",
7246             "optional": true,
7247             "field": "statedesc",
7248             "description": ""
7249           },
7250           {
7251             "group": "Body",
7252             "type": "String",
7253             "optional": true,
7254             "field": "scheduledat",
7255             "description": ""
7256           },
7257           {
7258             "group": "Body",
7259             "type": "Integer",
7260             "optional": true,
7261             "field": "countbusyretry",
7262             "description": ""
7263           },
7264           {
7265             "group": "Body",
7266             "type": "Integer",
7267             "optional": true,
7268             "field": "countcongestionretry",
7269             "description": ""
7270           },
7271           {
7272             "group": "Body",
7273             "type": "Integer",
7274             "optional": true,
7275             "field": "countnoanswerretry",
7276             "description": ""
7277           },
7278           {
7279             "group": "Body",
7280             "type": "Integer",
7281             "optional": true,
7282             "field": "countglobal",
7283             "description": ""
7284           },
7285           {
7286             "group": "Body",
7287             "type": "String",
7288             "optional": true,
7289             "field": "uniqueid",
7290             "description": ""
7291           },
7292           {
7293             "group": "Body",
7294             "type": "String",
7295             "optional": true,
7296             "field": "originatecalleridnum",
7297             "description": ""
7298           },
7299           {
7300             "group": "Body",
7301             "type": "String",
7302             "optional": true,
7303             "field": "originatecalleridname",
7304             "description": ""
7305           },
7306           {
7307             "group": "Body",
7308             "type": "String",
7309             "optional": true,
7310             "field": "calleridnum",
7311             "description": ""
7312           },
7313           {
7314             "group": "Body",
7315             "type": "String",
7316             "optional": true,
7317             "field": "calleridname",
7318             "description": ""
7319           },
7320           {
7321             "group": "Body",
7322             "type": "String",
7323             "optional": true,
7324             "field": "starttime",
7325             "description": ""
7326           },
7327           {
7328             "group": "Body",
7329             "type": "String",
7330             "optional": true,
7331             "field": "responsetime",
7332             "description": ""
7333           },
7334           {
7335             "group": "Body",
7336             "type": "String",
7337             "optional": true,
7338             "field": "answertime",
7339             "description": ""
7340           },
7341           {
7342             "group": "Body",
7343             "type": "String",
7344             "optional": true,
7345             "field": "droptime",
7346             "description": ""
7347           },
7348           {
7349             "group": "Body",
7350             "type": "String",
7351             "optional": true,
7352             "field": "endtime",
7353             "description": ""
7354           },
7355           {
7356             "group": "Body",
7357             "type": "Integer",
7358             "optional": true,
7359             "field": "ringtime",
7360             "description": ""
7361           },
7362           {
7363             "group": "Body",
7364             "type": "Integer",
7365             "optional": true,
7366             "field": "holdtime",
7367             "description": ""
7368           },
7369           {
7370             "group": "Body",
7371             "type": "Integer",
7372             "optional": true,
7373             "field": "talktime",
7374             "description": ""
7375           },
7376           {
7377             "group": "Body",
7378             "type": "Integer",
7379             "optional": true,
7380             "field": "followuptime",
7381             "description": ""
7382           },
7383           {
7384             "group": "Body",
7385             "type": "String",
7386             "optional": true,
7387             "field": "dropreason",
7388             "description": ""
7389           },
7390           {
7391             "group": "Body",
7392             "type": "String",
7393             "optional": true,
7394             "field": "campaign",
7395             "description": ""
7396           },
7397           {
7398             "group": "Body",
7399             "type": "String",
7400             "optional": true,
7401             "field": "campaigntype",
7402             "description": ""
7403           },
7404           {
7405             "group": "Body",
7406             "type": "String",
7407             "optional": true,
7408             "field": "membername",
7409             "description": ""
7410           },
7411           {
7412             "group": "Body",
7413             "type": "String",
7414             "optional": true,
7415             "field": "reason",
7416             "description": ""
7417           },
7418           {
7419             "group": "Body",
7420             "type": "Boolean",
7421             "optional": true,
7422             "field": "amd",
7423             "description": ""
7424           },
7425           {
7426             "group": "Body",
7427             "type": "Boolean",
7428             "optional": true,
7429             "field": "fax",
7430             "description": ""
7431           },
7432           {
7433             "group": "Body",
7434             "type": "Boolean",
7435             "optional": true,
7436             "field": "callback",
7437             "description": ""
7438           },
7439           {
7440             "group": "Body",
7441             "type": "String",
7442             "optional": true,
7443             "field": "callbackuniqueid",
7444             "description": ""
7445           },
7446           {
7447             "group": "Body",
7448             "type": "String",
7449             "optional": true,
7450             "field": "callbackat",
7451             "description": ""
7452           },
7453           {
7454             "group": "Body",
7455             "type": "Boolean",
7456             "optional": true,
7457             "field": "recallme",
7458             "description": ""
7459           },
7460           {
7461             "group": "Body",
7462             "type": "String",
7463             "optional": true,
7464             "field": "editedat",
7465             "description": ""
7466           },
7467           {
7468             "group": "Body",
7469             "type": "Boolean",
7470             "optional": true,
7471             "field": "edited",
7472             "description": ""
7473           },
7474           {
7475             "group": "Body",
7476             "type": "Integer",
7477             "optional": true,
7478             "field": "countnosuchnumberretry",
7479             "description": ""
7480           },
7481           {
7482             "group": "Body",
7483             "type": "Integer",
7484             "optional": true,
7485             "field": "countdropretry",
7486             "description": ""
7487           },
7488           {
7489             "group": "Body",
7490             "type": "Integer",
7491             "optional": true,
7492             "field": "countabandonedretry",
7493             "description": ""
7494           },
7495           {
7496             "group": "Body",
7497             "type": "Integer",
7498             "optional": true,
7499             "field": "countmachineretry",
7500             "description": ""
7501           },
7502           {
7503             "group": "Body",
7504             "type": "Integer",
7505             "optional": true,
7506             "field": "countagentrejectretry",
7507             "description": ""
7508           }
7509         ]
7510       }
7511     },
7512     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7513     "version": "0.0.0",
7514     "filename": "server/api/cmHopperHistory/index.js",
7515     "groupTitle": "Cm_Hopper_History"
7516   },
7517   {
7518     "type": "get",
7519     "url": "/api/cm/hopper_history/describe",
7520     "title": "Gets table info about HopperHistory",
7521     "examples": [
7522       {
7523         "title": "Example usage:",
7524         "content": "curl https://{domain}/api/cm/hopper_history/describe -v -u {name}:{password}",
7525         "type": "json"
7526       }
7527     ],
7528     "name": "DescribeHopperHistory",
7529     "group": "Cm_Hopper_History",
7530     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7531     "version": "0.0.0",
7532     "filename": "server/api/cmHopperHistory/index.js",
7533     "groupTitle": "Cm_Hopper_History"
7534   },
7535   {
7536     "type": "get",
7537     "url": "/api/cm/hopper_history",
7538     "title": "Gets a list of HopperHistory",
7539     "examples": [
7540       {
7541         "title": "Example usage:",
7542         "content": "curl https://{domain}/api/cm/hopper_history -v -u {name}:{password}",
7543         "type": "json"
7544       }
7545     ],
7546     "name": "GetHopperHistory",
7547     "group": "Cm_Hopper_History",
7548     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
7549     "version": "0.0.0",
7550     "filename": "server/api/cmHopperHistory/index.js",
7551     "groupTitle": "Cm_Hopper_History"
7552   },
7553   {
7554     "type": "get",
7555     "url": "/api/cm/hopper_history/{id}",
7556     "title": "Gets a single HopperHistory",
7557     "examples": [
7558       {
7559         "title": "Example usage:",
7560         "content": "curl https://{domain}/api/cm/hopper_history/{id} -v -u {name}:{password}",
7561         "type": "json"
7562       }
7563     ],
7564     "name": "ShowHopperHistory",
7565     "group": "Cm_Hopper_History",
7566     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7567     "version": "0.0.0",
7568     "filename": "server/api/cmHopperHistory/index.js",
7569     "groupTitle": "Cm_Hopper_History"
7570   },
7571   {
7572     "type": "put",
7573     "url": "/api/cm/hopper_history/{id}",
7574     "title": "Update a single hopper history",
7575     "examples": [
7576       {
7577         "title": "Example usage:",
7578         "content": "curl https://{domain}/api/hopper_history/{id} -d '{\"disposition\": \"OK\"}' -v -u {name}:{password} -X PUT",
7579         "type": "json"
7580       }
7581     ],
7582     "name": "update",
7583     "group": "Cm_Hopper_History",
7584     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7585     "version": "0.0.0",
7586     "filename": "server/api/cmHopperHistory/index.js",
7587     "groupTitle": "Cm_Hopper_History"
7588   },
7589   {
7590     "type": "delete",
7591     "url": "/api/cm/hopper/{id}",
7592     "title": "Delete Hopper",
7593     "examples": [
7594       {
7595         "title": "Example usage:",
7596         "content": "curl https://{domain}/api/cm/hopper/{id} -v -u {name}:{password} -X DELETE",
7597         "type": "json"
7598       }
7599     ],
7600     "name": "destroy",
7601     "group": "Cm_Hopper",
7602     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7603     "version": "0.0.0",
7604     "filename": "server/api/cmHopper/index.js",
7605     "groupTitle": "Cm_Hopper"
7606   },
7607   {
7608     "type": "get",
7609     "url": "/api/cm/hopper/opencontacts",
7610     "title": "Gets Open Contacts",
7611     "examples": [
7612       {
7613         "title": "Example usage:",
7614         "content": "curl https://{domain}/api/cm/hopper/opencontacts -v -u {name}:{password} -X GET",
7615         "type": "json"
7616       }
7617     ],
7618     "name": "getOpenContacts",
7619     "group": "Cm_Hopper",
7620     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7621     "version": "0.0.0",
7622     "filename": "server/api/cmHopper/index.js",
7623     "groupTitle": "Cm_Hopper"
7624   },
7625   {
7626     "type": "post",
7627     "url": "/api/cm/hopper/preview",
7628     "title": "Gets Preview Dialer Contacts",
7629     "examples": [
7630       {
7631         "title": "Example usage:",
7632         "content": "curl https://{domain}/api/cm/hopper/preview -d '{\"hopperIds\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X GET",
7633         "type": "json"
7634       }
7635     ],
7636     "name": "getPreview",
7637     "group": "Cm_Hopper",
7638     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7639     "version": "0.0.0",
7640     "filename": "server/api/cmHopper/index.js",
7641     "groupTitle": "Cm_Hopper"
7642   },
7643   {
7644     "type": "put",
7645     "url": "/api/cm/hopper/{id}",
7646     "title": "Update an existing Hopper",
7647     "examples": [
7648       {
7649         "title": "Example usage:",
7650         "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",
7651         "type": "json"
7652       }
7653     ],
7654     "name": "updateHopper",
7655     "group": "Cm_Hopper",
7656     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7657     "version": "0.0.0",
7658     "filename": "server/api/cmHopper/index.js",
7659     "groupTitle": "Cm_Hopper"
7660   },
7661   {
7662     "type": "post",
7663     "url": "/api/cm/lists",
7664     "title": "Creates a new List",
7665     "examples": [
7666       {
7667         "title": "Example usage:",
7668         "content": "curl https://{domain}/api/cm/lists -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
7669         "type": "json"
7670       }
7671     ],
7672     "name": "CreateLists",
7673     "group": "Cm_Lists",
7674     "parameter": {
7675       "fields": {
7676         "Body": [
7677           {
7678             "group": "Body",
7679             "type": "String",
7680             "optional": false,
7681             "field": "name",
7682             "description": ""
7683           },
7684           {
7685             "group": "Body",
7686             "type": "String",
7687             "optional": true,
7688             "field": "description",
7689             "description": ""
7690           },
7691           {
7692             "group": "Body",
7693             "type": "String",
7694             "optional": true,
7695             "field": "dialPrefix",
7696             "description": ""
7697           }
7698         ]
7699       }
7700     },
7701     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7702     "version": "0.0.0",
7703     "filename": "server/api/cmList/index.js",
7704     "groupTitle": "Cm_Lists"
7705   },
7706   {
7707     "type": "delete",
7708     "url": "/api/cm/lists/{id}",
7709     "title": "Deletes a List",
7710     "examples": [
7711       {
7712         "title": "Example usage:",
7713         "content": "curl https://{domain}/api/cm/lists/{id} -v -u {name}:{password} -X DELETE",
7714         "type": "json"
7715       }
7716     ],
7717     "name": "DeleteLists",
7718     "group": "Cm_Lists",
7719     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7720     "version": "0.0.0",
7721     "filename": "server/api/cmList/index.js",
7722     "groupTitle": "Cm_Lists"
7723   },
7724   {
7725     "type": "get",
7726     "url": "/api/cm/lists/describe",
7727     "title": "Gets table info about Lists",
7728     "examples": [
7729       {
7730         "title": "Example usage:",
7731         "content": "curl https://{domain}/api/cm/lists/describe -v -u {name}:{password}",
7732         "type": "json"
7733       }
7734     ],
7735     "name": "DescribeLists",
7736     "group": "Cm_Lists",
7737     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7738     "version": "0.0.0",
7739     "filename": "server/api/cmList/index.js",
7740     "groupTitle": "Cm_Lists"
7741   },
7742   {
7743     "type": "get",
7744     "url": "/api/cm/lists/{id}/users",
7745     "title": "Gets agents from list",
7746     "examples": [
7747       {
7748         "title": "Example usage:",
7749         "content": "curl https://{domain}/api/cm/lists/{id}/users -v -u {name}:{password} -X GET",
7750         "type": "json"
7751       }
7752     ],
7753     "name": "GetAgents",
7754     "group": "Cm_Lists",
7755     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7756     "version": "0.0.0",
7757     "filename": "server/api/cmList/index.js",
7758     "groupTitle": "Cm_Lists"
7759   },
7760   {
7761     "type": "get",
7762     "url": "/api/cm/lists",
7763     "title": "Gets a list of Lists",
7764     "examples": [
7765       {
7766         "title": "Example usage:",
7767         "content": "curl https://{domain}/api/cm/lists -v -u {name}:{password}",
7768         "type": "json"
7769       }
7770     ],
7771     "name": "GetLists",
7772     "group": "Cm_Lists",
7773     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
7774     "version": "0.0.0",
7775     "filename": "server/api/cmList/index.js",
7776     "groupTitle": "Cm_Lists"
7777   },
7778   {
7779     "type": "delete",
7780     "url": "/api/cm/lists/{id}/users",
7781     "title": "Removes agents from a list",
7782     "examples": [
7783       {
7784         "title": "Example usage:",
7785         "content": "curl https://{domain}/api/cm/lists/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
7786         "type": "json"
7787       }
7788     ],
7789     "name": "RemoveAgents",
7790     "group": "Cm_Lists",
7791     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7792     "version": "0.0.0",
7793     "filename": "server/api/cmList/index.js",
7794     "groupTitle": "Cm_Lists"
7795   },
7796   {
7797     "type": "delete",
7798     "url": "/api/cm/lists/{id}/dispositions",
7799     "title": "Removes dispositions from account",
7800     "examples": [
7801       {
7802         "title": "Example usage:",
7803         "content": "curl https://{domain}/api/cm/lists/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
7804         "type": "json"
7805       }
7806     ],
7807     "name": "RemoveDispositions",
7808     "group": "Cm_Lists",
7809     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7810     "version": "0.0.0",
7811     "filename": "server/api/cmList/index.js",
7812     "groupTitle": "Cm_Lists"
7813   },
7814   {
7815     "type": "get",
7816     "url": "/api/cm/lists/{id}",
7817     "title": "Gets a single List",
7818     "examples": [
7819       {
7820         "title": "Example usage:",
7821         "content": "curl https://{domain}/api/cm/lists/{id} -v -u {name}:{password}",
7822         "type": "json"
7823       }
7824     ],
7825     "name": "ShowLists",
7826     "group": "Cm_Lists",
7827     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7828     "version": "0.0.0",
7829     "filename": "server/api/cmList/index.js",
7830     "groupTitle": "Cm_Lists"
7831   },
7832   {
7833     "type": "post",
7834     "url": "/api/cm/lists/{id}/users",
7835     "title": "Adds agents to a list",
7836     "examples": [
7837       {
7838         "title": "Example usage:",
7839         "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",
7840         "type": "json"
7841       }
7842     ],
7843     "name": "addAgents",
7844     "group": "Cm_Lists",
7845     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7846     "version": "0.0.0",
7847     "filename": "server/api/cmList/index.js",
7848     "groupTitle": "Cm_Lists"
7849   },
7850   {
7851     "type": "post",
7852     "url": "/api/cm/lists/{id}/contacts",
7853     "title": "Creates new contacts",
7854     "examples": [
7855       {
7856         "title": "Example usage:",
7857         "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",
7858         "type": "json"
7859       }
7860     ],
7861     "name": "addContacts",
7862     "group": "Cm_Lists",
7863     "parameter": {
7864       "fields": {
7865         "Body": [
7866           {
7867             "group": "Body",
7868             "type": "String",
7869             "optional": false,
7870             "field": "firstName",
7871             "description": ""
7872           },
7873           {
7874             "group": "Body",
7875             "type": "String",
7876             "optional": true,
7877             "field": "lastName",
7878             "description": ""
7879           },
7880           {
7881             "group": "Body",
7882             "type": "String",
7883             "optional": true,
7884             "field": "street",
7885             "description": ""
7886           },
7887           {
7888             "group": "Body",
7889             "type": "String",
7890             "optional": true,
7891             "field": "postalCode",
7892             "description": ""
7893           },
7894           {
7895             "group": "Body",
7896             "type": "String",
7897             "optional": true,
7898             "field": "city",
7899             "description": ""
7900           },
7901           {
7902             "group": "Body",
7903             "type": "String",
7904             "optional": true,
7905             "field": "country",
7906             "description": ""
7907           },
7908           {
7909             "group": "Body",
7910             "type": "String",
7911             "optional": true,
7912             "field": "dateOfBirth",
7913             "description": ""
7914           },
7915           {
7916             "group": "Body",
7917             "type": "Text",
7918             "optional": true,
7919             "field": "description",
7920             "description": ""
7921           },
7922           {
7923             "group": "Body",
7924             "type": "String",
7925             "optional": true,
7926             "field": "phone",
7927             "description": ""
7928           },
7929           {
7930             "group": "Body",
7931             "type": "String",
7932             "optional": true,
7933             "field": "mobile",
7934             "description": ""
7935           },
7936           {
7937             "group": "Body",
7938             "type": "String",
7939             "optional": true,
7940             "field": "fax",
7941             "description": ""
7942           },
7943           {
7944             "group": "Body",
7945             "type": "String",
7946             "optional": true,
7947             "field": "email",
7948             "description": ""
7949           },
7950           {
7951             "group": "Body",
7952             "type": "String",
7953             "optional": true,
7954             "field": "url",
7955             "description": ""
7956           },
7957           {
7958             "group": "Body",
7959             "type": "String",
7960             "optional": true,
7961             "field": "facebook",
7962             "description": ""
7963           },
7964           {
7965             "group": "Body",
7966             "type": "String",
7967             "optional": true,
7968             "field": "fb_data",
7969             "description": ""
7970           },
7971           {
7972             "group": "Body",
7973             "type": "String",
7974             "optional": true,
7975             "field": "twitter",
7976             "description": ""
7977           },
7978           {
7979             "group": "Body",
7980             "type": "String",
7981             "optional": true,
7982             "field": "skype",
7983             "description": ""
7984           },
7985           {
7986             "group": "Body",
7987             "type": "String",
7988             "optional": true,
7989             "field": "teams",
7990             "description": ""
7991           },
7992           {
7993             "group": "Body",
7994             "type": "String",
7995             "optional": true,
7996             "field": "viber",
7997             "description": ""
7998           },
7999           {
8000             "group": "Body",
8001             "type": "String",
8002             "optional": true,
8003             "field": "line",
8004             "description": ""
8005           },
8006           {
8007             "group": "Body",
8008             "type": "String",
8009             "optional": true,
8010             "field": "wechat",
8011             "description": ""
8012           },
8013           {
8014             "group": "Body",
8015             "type": "String",
8016             "optional": true,
8017             "field": "telegram",
8018             "description": ""
8019           },
8020           {
8021             "group": "Body",
8022             "type": "Integer",
8023             "optional": true,
8024             "field": "UserId",
8025             "description": ""
8026           },
8027           {
8028             "group": "Body",
8029             "type": "Integer",
8030             "optional": true,
8031             "field": "priority",
8032             "description": ""
8033           },
8034           {
8035             "group": "Body",
8036             "type": "String",
8037             "optional": true,
8038             "field": "scheduledat",
8039             "description": ""
8040           }
8041         ]
8042       }
8043     },
8044     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8045     "version": "0.0.0",
8046     "filename": "server/api/cmList/index.js",
8047     "groupTitle": "Cm_Lists"
8048   },
8049   {
8050     "type": "post",
8051     "url": "/api/cm/lists/{id}/fields",
8052     "title": "Creates a new custom field",
8053     "examples": [
8054       {
8055         "title": "Example usage:",
8056         "content": "curl https://{domain}/api/cm/lists/{id}/fields -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
8057         "type": "json"
8058       }
8059     ],
8060     "name": "addCustomField",
8061     "group": "Cm_Lists",
8062     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8063     "version": "0.0.0",
8064     "filename": "server/api/cmList/index.js",
8065     "groupTitle": "Cm_Lists"
8066   },
8067   {
8068     "type": "post",
8069     "url": "/api/cm/lists/{id}/dispositions",
8070     "title": "Creates new disposition",
8071     "examples": [
8072       {
8073         "title": "Example usage:",
8074         "content": "curl https://{domain}/api/cm/lists/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
8075         "type": "json"
8076       }
8077     ],
8078     "name": "addDisposition",
8079     "group": "Cm_Lists",
8080     "parameter": {
8081       "fields": {
8082         "Body": [
8083           {
8084             "group": "Body",
8085             "type": "String",
8086             "optional": false,
8087             "field": "name",
8088             "description": ""
8089           },
8090           {
8091             "group": "Body",
8092             "type": "String",
8093             "allowedValues": [
8094               "\"first\"",
8095               "\"second\"",
8096               "\"third\""
8097             ],
8098             "optional": false,
8099             "field": "level",
8100             "description": ""
8101           },
8102           {
8103             "group": "Body",
8104             "type": "String",
8105             "optional": true,
8106             "field": "description",
8107             "description": ""
8108           }
8109         ]
8110       }
8111     },
8112     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8113     "version": "0.0.0",
8114     "filename": "server/api/cmList/index.js",
8115     "groupTitle": "Cm_Lists"
8116   },
8117   {
8118     "type": "get",
8119     "url": "/api/cm/lists/{id}/contacts",
8120     "title": "Gets List Contacts",
8121     "examples": [
8122       {
8123         "title": "Example usage:",
8124         "content": "curl https://{domain}/api/cm/lists/{id}/contacts -v -u {name}:{password} -X GET",
8125         "type": "json"
8126       }
8127     ],
8128     "name": "getContacts",
8129     "group": "Cm_Lists",
8130     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8131     "version": "0.0.0",
8132     "filename": "server/api/cmList/index.js",
8133     "groupTitle": "Cm_Lists"
8134   },
8135   {
8136     "type": "get",
8137     "url": "/api/cm/lists/{id}/fields",
8138     "title": "Gets Custom Fields",
8139     "examples": [
8140       {
8141         "title": "Example usage:",
8142         "content": "curl https://{domain}/api/cm/lists/{id}/fields -v -u {name}:{password} -X GET",
8143         "type": "json"
8144       }
8145     ],
8146     "name": "getCustomFields",
8147     "group": "Cm_Lists",
8148     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8149     "version": "0.0.0",
8150     "filename": "server/api/cmList/index.js",
8151     "groupTitle": "Cm_Lists"
8152   },
8153   {
8154     "type": "get",
8155     "url": "/api/cm/lists/{id}/dispositions",
8156     "title": "Gets list dispositions",
8157     "examples": [
8158       {
8159         "title": "Example usage:",
8160         "content": "curl https://{domain}/api/cm/lists/{id}/dispositions -v -u {name}:{password} -X GET",
8161         "type": "json"
8162       }
8163     ],
8164     "name": "getDispositions",
8165     "group": "Cm_Lists",
8166     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8167     "version": "0.0.0",
8168     "filename": "server/api/cmList/index.js",
8169     "groupTitle": "Cm_Lists"
8170   },
8171   {
8172     "type": "get",
8173     "url": "/api/cm/lists/{id}/contacts/csv",
8174     "title": "Gets CSV List Contacts",
8175     "examples": [
8176       {
8177         "title": "Example usage:",
8178         "content": "curl https://{domain}/api/cm/lists/{id}/contacts/csv -v -u {name}:{password} -X GET",
8179         "type": "json"
8180       }
8181     ],
8182     "name": "grunt",
8183     "group": "Cm_Lists",
8184     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8185     "version": "0.0.0",
8186     "filename": "server/api/cmList/index.js",
8187     "groupTitle": "Cm_Lists"
8188   },
8189   {
8190     "type": "put",
8191     "url": "/api/cm/lists/{id}",
8192     "title": "Update an existing List",
8193     "examples": [
8194       {
8195         "title": "Example usage:",
8196         "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",
8197         "type": "json"
8198       }
8199     ],
8200     "name": "updateLists",
8201     "group": "Cm_Lists",
8202     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8203     "version": "0.0.0",
8204     "filename": "server/api/cmList/index.js",
8205     "groupTitle": "Cm_Lists"
8206   },
8207   {
8208     "type": "post",
8209     "url": "/api/cm/contacts/upload/:id",
8210     "title": "Import new contacts by csv",
8211     "examples": [
8212       {
8213         "title": "Example usage:",
8214         "content": "curl https://{domain}/api/cm/contacts/upload/:id -v -u {name}:{password} -X POST",
8215         "type": "json"
8216       }
8217     ],
8218     "name": "import",
8219     "group": "Cm_contacts",
8220     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8221     "version": "0.0.0",
8222     "filename": "server/api/cmContact/index.js",
8223     "groupTitle": "Cm_contacts"
8224   },
8225   {
8226     "type": "post",
8227     "url": "/api/cm/contacts/upload",
8228     "title": "Upload csv",
8229     "examples": [
8230       {
8231         "title": "Example usage:",
8232         "content": "curl https://{domain}/api/cm/contacts/upload -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
8233         "type": "json"
8234       }
8235     ],
8236     "name": "upload",
8237     "group": "Cm_contacts",
8238     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8239     "version": "0.0.0",
8240     "filename": "server/api/cmContact/index.js",
8241     "groupTitle": "Cm_contacts"
8242   },
8243   {
8244     "type": "post",
8245     "url": "/api/cm/contacts/csv",
8246     "title": "Create new contacts by csv",
8247     "examples": [
8248       {
8249         "title": "Example usage:",
8250         "content": "curl https://{domain}/api/cm/contacts/csv -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
8251         "type": "json"
8252       }
8253     ],
8254     "name": "uploadCsv",
8255     "group": "Cm_contacts",
8256     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8257     "version": "0.0.0",
8258     "filename": "server/api/cmContact/index.js",
8259     "groupTitle": "Cm_contacts"
8260   },
8261   {
8262     "type": "delete",
8263     "url": "/api/conditions/{id}",
8264     "title": "Deletes a Condition",
8265     "examples": [
8266       {
8267         "title": "Example usage:",
8268         "content": "curl https://{domain}/api/conditions/{id} -v -u {name}:{password} -X DELETE",
8269         "type": "json"
8270       }
8271     ],
8272     "name": "DeleteConditions",
8273     "group": "Conditions",
8274     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8275     "version": "0.0.0",
8276     "filename": "server/api/condition/index.js",
8277     "groupTitle": "Conditions"
8278   },
8279   {
8280     "type": "put",
8281     "url": "/api/conditions/{id}",
8282     "title": "Update an existing Condition",
8283     "examples": [
8284       {
8285         "title": "Example usage:",
8286         "content": "curl https://{domain}/api/conditions/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
8287         "type": "json"
8288       }
8289     ],
8290     "name": "updateConditions",
8291     "group": "Conditions",
8292     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8293     "version": "0.0.0",
8294     "filename": "server/api/condition/index.js",
8295     "groupTitle": "Conditions"
8296   },
8297   {
8298     "type": "post",
8299     "url": "/api/contact_item_types",
8300     "title": "Creates a new ContactItemType",
8301     "examples": [
8302       {
8303         "title": "Example usage:",
8304         "content": "curl https://{domain}/api/contact_item_types -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
8305         "type": "json"
8306       }
8307     ],
8308     "name": "CreateContactItemTypes",
8309     "group": "ContactItemType",
8310     "parameter": {
8311       "fields": {
8312         "Body": [
8313           {
8314             "group": "Body",
8315             "type": "String",
8316             "optional": false,
8317             "field": "name",
8318             "description": ""
8319           },
8320           {
8321             "group": "Body",
8322             "type": "Integer",
8323             "optional": true,
8324             "field": "OrderBy",
8325             "description": ""
8326           },
8327           {
8328             "group": "Body",
8329             "type": "String",
8330             "optional": true,
8331             "field": "rgbBackgroundColor",
8332             "description": ""
8333           }
8334         ]
8335       }
8336     },
8337     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8338     "version": "0.0.0",
8339     "filename": "server/api/contactItemType/index.js",
8340     "groupTitle": "ContactItemType"
8341   },
8342   {
8343     "type": "delete",
8344     "url": "/api/contact_item_types/{id}",
8345     "title": "Deletes a ContactItemType",
8346     "examples": [
8347       {
8348         "title": "Example usage:",
8349         "content": "curl https://{domain}/api/contact_item_types/{id} -v -u {name}:{password} -X DELETE",
8350         "type": "json"
8351       }
8352     ],
8353     "name": "DeleteContactItemTypes",
8354     "group": "ContactItemType",
8355     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8356     "version": "0.0.0",
8357     "filename": "server/api/contactItemType/index.js",
8358     "groupTitle": "ContactItemType"
8359   },
8360   {
8361     "type": "get",
8362     "url": "/api/contact_item_types",
8363     "title": "Gets a list of ContactItemTypes",
8364     "examples": [
8365       {
8366         "title": "Example usage:",
8367         "content": "curl https://{domain}/api/contact_item_types -v -u {name}:{password}",
8368         "type": "json"
8369       }
8370     ],
8371     "name": "GetContactItemTypes",
8372     "group": "ContactItemType",
8373     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/contact_item_types?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/contact_item_types?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/contact_item_types?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/contact_item_types?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/contact_item_types?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
8374     "version": "0.0.0",
8375     "filename": "server/api/contactItemType/index.js",
8376     "groupTitle": "ContactItemType"
8377   },
8378   {
8379     "type": "get",
8380     "url": "/api/contact_item_types/{id}",
8381     "title": "Gets a single ContactItemType",
8382     "examples": [
8383       {
8384         "title": "Example usage:",
8385         "content": "curl https://{domain}/api/contact_item_types/{id} -v -u {name}:{password}",
8386         "type": "json"
8387       }
8388     ],
8389     "name": "ShowContactItemTypes",
8390     "group": "ContactItemType",
8391     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8392     "version": "0.0.0",
8393     "filename": "server/api/contactItemType/index.js",
8394     "groupTitle": "ContactItemType"
8395   },
8396   {
8397     "type": "put",
8398     "url": "/api/contact_item_types/{id}",
8399     "title": "Update an existing ContactItemType",
8400     "examples": [
8401       {
8402         "title": "Example usage:",
8403         "content": "curl https://{domain}/api/contact_item_types/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
8404         "type": "json"
8405       }
8406     ],
8407     "name": "updateContactItemTypes",
8408     "group": "ContactItemType",
8409     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8410     "version": "0.0.0",
8411     "filename": "server/api/contactItemType/index.js",
8412     "groupTitle": "ContactItemType"
8413   },
8414   {
8415     "type": "post",
8416     "url": "/api/cm/custom_field",
8417     "title": "Create a new custom field",
8418     "examples": [
8419       {
8420         "title": "Example usage:",
8421         "content": "curl https://{domain}/api/cm/custom_field  -d '{\"name\": \"mycf\", \"type\": \"text\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
8422         "type": "json"
8423       }
8424     ],
8425     "name": "CreateCustomField",
8426     "group": "Custom_Fields",
8427     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8428     "version": "0.0.0",
8429     "filename": "server/api/cmCustomField/index.js",
8430     "groupTitle": "Custom_Fields"
8431   },
8432   {
8433     "type": "post",
8434     "url": "/api/dashboards/items",
8435     "title": "Create dasboard item",
8436     "examples": [
8437       {
8438         "title": "Example usage:",
8439         "content": "curl https://{domain}/api/dashboards/items \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
8440         "type": "json"
8441       }
8442     ],
8443     "name": "Create",
8444     "group": "Dashboard_Items",
8445     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8446     "version": "0.0.0",
8447     "filename": "server/api/dashboardItem/index.js",
8448     "groupTitle": "Dashboard_Items"
8449   },
8450   {
8451     "type": "delete",
8452     "url": "/api/dashboards/items/{id}",
8453     "title": "Deletes a Dashboard Item",
8454     "examples": [
8455       {
8456         "title": "Example usage:",
8457         "content": "curl https://{domain}/api/dashboards/items/{id} -v -u {name}:{password} -X DELETE",
8458         "type": "json"
8459       }
8460     ],
8461     "name": "DeleteDashboard_Items",
8462     "group": "Dashboard_Items",
8463     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8464     "version": "0.0.0",
8465     "filename": "server/api/dashboardItem/index.js",
8466     "groupTitle": "Dashboard_Items"
8467   },
8468   {
8469     "type": "get",
8470     "url": "/api/dashboards/items/{id}",
8471     "title": "Gets a single Dashboard Item",
8472     "examples": [
8473       {
8474         "title": "Example usage:",
8475         "content": "curl https://{domain}/api/dashboards/items/{id} -v -u {name}:{password}",
8476         "type": "json"
8477       }
8478     ],
8479     "name": "ShowDashboard_Items",
8480     "group": "Dashboard_Items",
8481     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8482     "version": "0.0.0",
8483     "filename": "server/api/dashboardItem/index.js",
8484     "groupTitle": "Dashboard_Items"
8485   },
8486   {
8487     "type": "put",
8488     "url": "/api/dashboards/items/{id}",
8489     "title": "Update an existing item",
8490     "examples": [
8491       {
8492         "title": "Example usage:",
8493         "content": "curl https://{domain}/api/dashboards/items/{id} -v -u {name}:{password} -X PUT",
8494         "type": "json"
8495       }
8496     ],
8497     "name": "Update",
8498     "group": "Dashboard_Items",
8499     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8500     "version": "0.0.0",
8501     "filename": "server/api/dashboardItem/index.js",
8502     "groupTitle": "Dashboard_Items"
8503   },
8504   {
8505     "type": "post",
8506     "url": "/api/dashboards/clone",
8507     "title": "Clone an existing Dashboard",
8508     "examples": [
8509       {
8510         "title": "Example usage:",
8511         "content": "curl https://{domain}/api/dashboards/clone -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
8512         "type": "json"
8513       }
8514     ],
8515     "name": "CloneDashboards",
8516     "group": "Dashboards",
8517     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8518     "version": "0.0.0",
8519     "filename": "server/api/dashboard/index.js",
8520     "groupTitle": "Dashboards"
8521   },
8522   {
8523     "type": "post",
8524     "url": "/api/dashboards",
8525     "title": "Creates a new Dashboard",
8526     "examples": [
8527       {
8528         "title": "Example usage:",
8529         "content": "curl https://{domain}/api/dashboards -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
8530         "type": "json"
8531       }
8532     ],
8533     "name": "CreateDashboards",
8534     "group": "Dashboards",
8535     "parameter": {
8536       "fields": {
8537         "Body": [
8538           {
8539             "group": "Body",
8540             "type": "String",
8541             "optional": false,
8542             "field": "name",
8543             "description": ""
8544           },
8545           {
8546             "group": "Body",
8547             "type": "String",
8548             "optional": true,
8549             "field": "description",
8550             "description": ""
8551           }
8552         ]
8553       }
8554     },
8555     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8556     "version": "0.0.0",
8557     "filename": "server/api/dashboard/index.js",
8558     "groupTitle": "Dashboards"
8559   },
8560   {
8561     "type": "delete",
8562     "url": "/api/dashboards/{id}",
8563     "title": "Deletes a Dashboard",
8564     "examples": [
8565       {
8566         "title": "Example usage:",
8567         "content": "curl https://{domain}/api/dashboards/{id} -v -u {name}:{password} -X DELETE",
8568         "type": "json"
8569       }
8570     ],
8571     "name": "DeleteDashboards",
8572     "group": "Dashboards",
8573     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8574     "version": "0.0.0",
8575     "filename": "server/api/dashboard/index.js",
8576     "groupTitle": "Dashboards"
8577   },
8578   {
8579     "type": "get",
8580     "url": "/api/dashboards",
8581     "title": "Gets a list of Dashboards",
8582     "examples": [
8583       {
8584         "title": "Example usage:",
8585         "content": "curl https://{domain}/api/dashboards -v -u {name}:{password}",
8586         "type": "json"
8587       }
8588     ],
8589     "name": "GetDashboards",
8590     "group": "Dashboards",
8591     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
8592     "version": "0.0.0",
8593     "filename": "server/api/dashboard/index.js",
8594     "groupTitle": "Dashboards"
8595   },
8596   {
8597     "type": "get",
8598     "url": "/api/dashboards/{id}",
8599     "title": "Gets a single Dashboard",
8600     "examples": [
8601       {
8602         "title": "Example usage:",
8603         "content": "curl https://{domain}/api/dashboards/{id} -v -u {name}:{password}",
8604         "type": "json"
8605       }
8606     ],
8607     "name": "ShowDashboards",
8608     "group": "Dashboards",
8609     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8610     "version": "0.0.0",
8611     "filename": "server/api/dashboard/index.js",
8612     "groupTitle": "Dashboards"
8613   },
8614   {
8615     "type": "post",
8616     "url": "/api/dashboards/{id}/items",
8617     "title": "Creates new item",
8618     "examples": [
8619       {
8620         "title": "Example usage:",
8621         "content": "curl https://{domain}/api/dashboards/{id}/items -d '{\"type\": \"counter\", \"...\": \"...\"}]' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
8622         "type": "json"
8623       }
8624     ],
8625     "name": "addItem",
8626     "group": "Dashboards",
8627     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8628     "version": "0.0.0",
8629     "filename": "server/api/dashboard/index.js",
8630     "groupTitle": "Dashboards"
8631   },
8632   {
8633     "type": "get",
8634     "url": "/api/dashboards/{id}/items",
8635     "title": "Gets items",
8636     "examples": [
8637       {
8638         "title": "Example usage:",
8639         "content": "curl https://{domain}/api/dashboards/{id}/items -v -u {name}:{password} -X GET",
8640         "type": "json"
8641       }
8642     ],
8643     "name": "getItems",
8644     "group": "Dashboards",
8645     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8646     "version": "0.0.0",
8647     "filename": "server/api/dashboard/index.js",
8648     "groupTitle": "Dashboards"
8649   },
8650   {
8651     "type": "put",
8652     "url": "/api/dashboards/{id}",
8653     "title": "Update an existing Dashboard",
8654     "examples": [
8655       {
8656         "title": "Example usage:",
8657         "content": "curl https://{domain}/api/dashboards/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
8658         "type": "json"
8659       }
8660     ],
8661     "name": "updateDashboards",
8662     "group": "Dashboards",
8663     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8664     "version": "0.0.0",
8665     "filename": "server/api/dashboard/index.js",
8666     "groupTitle": "Dashboards"
8667   },
8668   {
8669     "type": "post",
8670     "url": "/api/integrations/desk/accounts",
8671     "title": "Creates a new Desk Account",
8672     "examples": [
8673       {
8674         "title": "Example usage:",
8675         "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",
8676         "type": "json"
8677       }
8678     ],
8679     "name": "CreateDesk_Accounts",
8680     "group": "Desk_Accounts",
8681     "parameter": {
8682       "fields": {
8683         "Body": [
8684           {
8685             "group": "Body",
8686             "type": "String",
8687             "optional": true,
8688             "field": "name",
8689             "description": ""
8690           },
8691           {
8692             "group": "Body",
8693             "type": "String",
8694             "optional": true,
8695             "field": "description",
8696             "description": ""
8697           },
8698           {
8699             "group": "Body",
8700             "type": "String",
8701             "optional": true,
8702             "field": "username",
8703             "description": ""
8704           },
8705           {
8706             "group": "Body",
8707             "type": "String",
8708             "optional": true,
8709             "field": "remoteUri",
8710             "description": ""
8711           },
8712           {
8713             "group": "Body",
8714             "type": "String",
8715             "allowedValues": [
8716               "\"basic\""
8717             ],
8718             "optional": true,
8719             "field": "authType",
8720             "description": ""
8721           },
8722           {
8723             "group": "Body",
8724             "type": "String",
8725             "optional": true,
8726             "field": "password",
8727             "description": ""
8728           },
8729           {
8730             "group": "Body",
8731             "type": "String",
8732             "optional": true,
8733             "field": "consumerKey",
8734             "description": ""
8735           },
8736           {
8737             "group": "Body",
8738             "type": "String",
8739             "optional": true,
8740             "field": "consumerSecret",
8741             "description": ""
8742           },
8743           {
8744             "group": "Body",
8745             "type": "String",
8746             "optional": true,
8747             "field": "token",
8748             "description": ""
8749           },
8750           {
8751             "group": "Body",
8752             "type": "String",
8753             "optional": true,
8754             "field": "tokenSecret",
8755             "description": ""
8756           },
8757           {
8758             "group": "Body",
8759             "type": "String",
8760             "optional": false,
8761             "field": "serverUrl",
8762             "description": ""
8763           },
8764           {
8765             "group": "Body",
8766             "type": "String",
8767             "allowedValues": [
8768               "\"integrationTab\"",
8769               "\"newTab\""
8770             ],
8771             "optional": true,
8772             "field": "type",
8773             "description": ""
8774           }
8775         ]
8776       }
8777     },
8778     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8779     "version": "0.0.0",
8780     "filename": "server/api/intDeskAccount/index.js",
8781     "groupTitle": "Desk_Accounts"
8782   },
8783   {
8784     "type": "delete",
8785     "url": "/api/integrations/desk/accounts/{id}",
8786     "title": "Deletes a Desk Account",
8787     "examples": [
8788       {
8789         "title": "Example usage:",
8790         "content": "curl https://{domain}/api/integrations/desk/accounts/{id} -v -u {name}:{password} -X DELETE",
8791         "type": "json"
8792       }
8793     ],
8794     "name": "DeleteDesk_Accounts",
8795     "group": "Desk_Accounts",
8796     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8797     "version": "0.0.0",
8798     "filename": "server/api/intDeskAccount/index.js",
8799     "groupTitle": "Desk_Accounts"
8800   },
8801   {
8802     "type": "get",
8803     "url": "/api/integrations/desk/accounts",
8804     "title": "Gets a list of Desk Accounts",
8805     "examples": [
8806       {
8807         "title": "Example usage:",
8808         "content": "curl https://{domain}/api/integrations/desk/accounts -v -u {name}:{password}",
8809         "type": "json"
8810       }
8811     ],
8812     "name": "GetDesk_Accounts",
8813     "group": "Desk_Accounts",
8814     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
8815     "version": "0.0.0",
8816     "filename": "server/api/intDeskAccount/index.js",
8817     "groupTitle": "Desk_Accounts"
8818   },
8819   {
8820     "type": "get",
8821     "url": "/api/integrations/desk/accounts/{id}",
8822     "title": "Gets a single Desk Account",
8823     "examples": [
8824       {
8825         "title": "Example usage:",
8826         "content": "curl https://{domain}/api/integrations/desk/accounts/{id} -v -u {name}:{password}",
8827         "type": "json"
8828       }
8829     ],
8830     "name": "ShowDesk_Accounts",
8831     "group": "Desk_Accounts",
8832     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8833     "version": "0.0.0",
8834     "filename": "server/api/intDeskAccount/index.js",
8835     "groupTitle": "Desk_Accounts"
8836   },
8837   {
8838     "type": "post",
8839     "url": "/api/integrations/desk/accounts/{id}/configurations",
8840     "title": "Creates new configuration",
8841     "examples": [
8842       {
8843         "title": "Example usage:",
8844         "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",
8845         "type": "json"
8846       }
8847     ],
8848     "name": "addConfiguration",
8849     "group": "Desk_Accounts",
8850     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8851     "version": "0.0.0",
8852     "filename": "server/api/intDeskAccount/index.js",
8853     "groupTitle": "Desk_Accounts"
8854   },
8855   {
8856     "type": "get",
8857     "url": "/api/integrations/desk/accounts/{id}/configurations",
8858     "title": "Gets account configurations",
8859     "examples": [
8860       {
8861         "title": "Example usage:",
8862         "content": "curl https://{domain}/api/integrations/desk/accounts/{id}/configurations -v -u {name}:{password} -X GET",
8863         "type": "json"
8864       }
8865     ],
8866     "name": "getConfigurations",
8867     "group": "Desk_Accounts",
8868     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8869     "version": "0.0.0",
8870     "filename": "server/api/intDeskAccount/index.js",
8871     "groupTitle": "Desk_Accounts"
8872   },
8873   {
8874     "type": "get",
8875     "url": "/api/integrations/desk/accounts/{id}/fields",
8876     "title": "Gets account fields",
8877     "examples": [
8878       {
8879         "title": "Example usage:",
8880         "content": "curl https://{domain}/api/integrations/desk/accounts/{id}/fields -v -u {name}:{password} -X GET",
8881         "type": "json"
8882       }
8883     ],
8884     "name": "getFields",
8885     "group": "Desk_Accounts",
8886     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8887     "version": "0.0.0",
8888     "filename": "server/api/intDeskAccount/index.js",
8889     "groupTitle": "Desk_Accounts"
8890   },
8891   {
8892     "type": "put",
8893     "url": "/api/integrations/desk/accounts/{id}",
8894     "title": "Update an existing Desk Account",
8895     "examples": [
8896       {
8897         "title": "Example usage:",
8898         "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",
8899         "type": "json"
8900       }
8901     ],
8902     "name": "updateDesk_Accounts",
8903     "group": "Desk_Accounts",
8904     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8905     "version": "0.0.0",
8906     "filename": "server/api/intDeskAccount/index.js",
8907     "groupTitle": "Desk_Accounts"
8908   },
8909   {
8910     "type": "post",
8911     "url": "/api/integrations/desk/configurations",
8912     "title": "Creates a new Desk Configuration",
8913     "examples": [
8914       {
8915         "title": "Example usage:",
8916         "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",
8917         "type": "json"
8918       }
8919     ],
8920     "name": "CreateDesk_Configurations",
8921     "group": "Desk_Configurations",
8922     "parameter": {
8923       "fields": {
8924         "Body": [
8925           {
8926             "group": "Body",
8927             "type": "String",
8928             "optional": true,
8929             "field": "name",
8930             "description": ""
8931           },
8932           {
8933             "group": "Body",
8934             "type": "String",
8935             "optional": true,
8936             "field": "description",
8937             "description": ""
8938           }
8939         ]
8940       }
8941     },
8942     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8943     "version": "0.0.0",
8944     "filename": "server/api/intDeskConfiguration/index.js",
8945     "groupTitle": "Desk_Configurations"
8946   },
8947   {
8948     "type": "delete",
8949     "url": "/api/integrations/desk/configurations/{id}",
8950     "title": "Deletes a Desk Configuration",
8951     "examples": [
8952       {
8953         "title": "Example usage:",
8954         "content": "curl https://{domain}/api/integrations/desk/configurations/{id} -v -u {name}:{password} -X DELETE",
8955         "type": "json"
8956       }
8957     ],
8958     "name": "DeleteDesk_Configurations",
8959     "group": "Desk_Configurations",
8960     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8961     "version": "0.0.0",
8962     "filename": "server/api/intDeskConfiguration/index.js",
8963     "groupTitle": "Desk_Configurations"
8964   },
8965   {
8966     "type": "get",
8967     "url": "/api/integrations/desk/configurations",
8968     "title": "Gets a list of Desk Configurations",
8969     "examples": [
8970       {
8971         "title": "Example usage:",
8972         "content": "curl https://{domain}/api/integrations/desk/configurations -v -u {name}:{password}",
8973         "type": "json"
8974       }
8975     ],
8976     "name": "GetDesk_Configurations",
8977     "group": "Desk_Configurations",
8978     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
8979     "version": "0.0.0",
8980     "filename": "server/api/intDeskConfiguration/index.js",
8981     "groupTitle": "Desk_Configurations"
8982   },
8983   {
8984     "type": "get",
8985     "url": "/api/integrations/desk/configurations/{id}",
8986     "title": "Gets a single Desk Configuration",
8987     "examples": [
8988       {
8989         "title": "Example usage:",
8990         "content": "curl https://{domain}/api/integrations/desk/configurations/{id} -v -u {name}:{password}",
8991         "type": "json"
8992       }
8993     ],
8994     "name": "ShowDesk_Configurations",
8995     "group": "Desk_Configurations",
8996     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8997     "version": "0.0.0",
8998     "filename": "server/api/intDeskConfiguration/index.js",
8999     "groupTitle": "Desk_Configurations"
9000   },
9001   {
9002     "type": "get",
9003     "url": "/api/integrations/desk/configurations/{id}/descriptions",
9004     "title": "Gets configurations descriptions",
9005     "examples": [
9006       {
9007         "title": "Example usage:",
9008         "content": "curl https://{domain}/api/integrations/desk/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
9009         "type": "json"
9010       }
9011     ],
9012     "name": "getDescriptions",
9013     "group": "Desk_Configurations",
9014     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9015     "version": "0.0.0",
9016     "filename": "server/api/intDeskConfiguration/index.js",
9017     "groupTitle": "Desk_Configurations"
9018   },
9019   {
9020     "type": "get",
9021     "url": "/api/integrations/desk/configurations/{id}/fields",
9022     "title": "Gets configurations fields",
9023     "examples": [
9024       {
9025         "title": "Example usage:",
9026         "content": "curl https://{domain}/api/integrations/desk/configurations/{id}/fields -v -u {name}:{password} -X GET",
9027         "type": "json"
9028       }
9029     ],
9030     "name": "getFields",
9031     "group": "Desk_Configurations",
9032     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9033     "version": "0.0.0",
9034     "filename": "server/api/intDeskConfiguration/index.js",
9035     "groupTitle": "Desk_Configurations"
9036   },
9037   {
9038     "type": "get",
9039     "url": "/api/integrations/desk/configurations/{id}/subjects",
9040     "title": "Gets configurations subjects",
9041     "examples": [
9042       {
9043         "title": "Example usage:",
9044         "content": "curl https://{domain}/api/integrations/desk/configurations/{id}/subjects -v -u {name}:{password} -X GET",
9045         "type": "json"
9046       }
9047     ],
9048     "name": "getSubjects",
9049     "group": "Desk_Configurations",
9050     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9051     "version": "0.0.0",
9052     "filename": "server/api/intDeskConfiguration/index.js",
9053     "groupTitle": "Desk_Configurations"
9054   },
9055   {
9056     "type": "get",
9057     "url": "/api/integrations/desk/configurations/{id}/tags",
9058     "title": "Gets configurations tags",
9059     "examples": [
9060       {
9061         "title": "Example usage:",
9062         "content": "curl https://{domain}/api/integrations/desk/configurations/{id}/tags -v -u {name}:{password} -X GET",
9063         "type": "json"
9064       }
9065     ],
9066     "name": "getTags",
9067     "group": "Desk_Configurations",
9068     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9069     "version": "0.0.0",
9070     "filename": "server/api/intDeskConfiguration/index.js",
9071     "groupTitle": "Desk_Configurations"
9072   },
9073   {
9074     "type": "post",
9075     "url": "/api/integrations/desk/configurations/{id}/tags",
9076     "title": "Sets new tags",
9077     "examples": [
9078       {
9079         "title": "Example usage:",
9080         "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",
9081         "type": "json"
9082       }
9083     ],
9084     "name": "setTags",
9085     "group": "Desk_Configurations",
9086     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9087     "version": "0.0.0",
9088     "filename": "server/api/intDeskConfiguration/index.js",
9089     "groupTitle": "Desk_Configurations"
9090   },
9091   {
9092     "type": "put",
9093     "url": "/api/integrations/desk/configurations/{id}",
9094     "title": "Update an existing Desk Configuration",
9095     "examples": [
9096       {
9097         "title": "Example usage:",
9098         "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",
9099         "type": "json"
9100       }
9101     ],
9102     "name": "updateDesk_Configurations",
9103     "group": "Desk_Configurations",
9104     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9105     "version": "0.0.0",
9106     "filename": "server/api/intDeskConfiguration/index.js",
9107     "groupTitle": "Desk_Configurations"
9108   },
9109   {
9110     "type": "post",
9111     "url": "/api/integrations/desk/fields",
9112     "title": "Creates a new Desk Field",
9113     "examples": [
9114       {
9115         "title": "Example usage:",
9116         "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",
9117         "type": "json"
9118       }
9119     ],
9120     "name": "CreateDesk_Fields",
9121     "group": "Desk_Fields",
9122     "parameter": {
9123       "fields": {
9124         "Body": [
9125           {
9126             "group": "Body",
9127             "type": "String",
9128             "allowedValues": [
9129               "\"string\"",
9130               "\"variable\"",
9131               "\"customVariable\"",
9132               "\"keyValue\"",
9133               "\"picklist\""
9134             ],
9135             "optional": true,
9136             "field": "type",
9137             "description": ""
9138           },
9139           {
9140             "group": "Body",
9141             "type": "String",
9142             "optional": true,
9143             "field": "content",
9144             "description": ""
9145           },
9146           {
9147             "group": "Body",
9148             "type": "String",
9149             "optional": true,
9150             "field": "key",
9151             "description": ""
9152           },
9153           {
9154             "group": "Body",
9155             "type": "String",
9156             "allowedValues": [
9157               "\"string\"",
9158               "\"variable\"",
9159               "\"customVariable\""
9160             ],
9161             "optional": true,
9162             "field": "keyType",
9163             "description": ""
9164           },
9165           {
9166             "group": "Body",
9167             "type": "String",
9168             "optional": true,
9169             "field": "keyContent",
9170             "description": ""
9171           },
9172           {
9173             "group": "Body",
9174             "type": "String",
9175             "optional": true,
9176             "field": "idField",
9177             "description": ""
9178           },
9179           {
9180             "group": "Body",
9181             "type": "String",
9182             "optional": true,
9183             "field": "nameField",
9184             "description": ""
9185           },
9186           {
9187             "group": "Body",
9188             "type": "Boolean",
9189             "optional": true,
9190             "field": "customField",
9191             "description": ""
9192           },
9193           {
9194             "group": "Body",
9195             "type": "String",
9196             "optional": true,
9197             "field": "variableName",
9198             "description": ""
9199           }
9200         ]
9201       }
9202     },
9203     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9204     "version": "0.0.0",
9205     "filename": "server/api/intDeskField/index.js",
9206     "groupTitle": "Desk_Fields"
9207   },
9208   {
9209     "type": "delete",
9210     "url": "/api/integrations/desk/fields/{id}",
9211     "title": "Deletes a Desk Field",
9212     "examples": [
9213       {
9214         "title": "Example usage:",
9215         "content": "curl https://{domain}/api/integrations/desk/fields/{id} -v -u {name}:{password} -X DELETE",
9216         "type": "json"
9217       }
9218     ],
9219     "name": "DeleteDesk_Fields",
9220     "group": "Desk_Fields",
9221     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9222     "version": "0.0.0",
9223     "filename": "server/api/intDeskField/index.js",
9224     "groupTitle": "Desk_Fields"
9225   },
9226   {
9227     "type": "get",
9228     "url": "/api/integrations/desk/fields",
9229     "title": "Gets a list of Desk Fields",
9230     "examples": [
9231       {
9232         "title": "Example usage:",
9233         "content": "curl https://{domain}/api/integrations/desk/fields -v -u {name}:{password}",
9234         "type": "json"
9235       }
9236     ],
9237     "name": "GetDesk_Fields",
9238     "group": "Desk_Fields",
9239     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
9240     "version": "0.0.0",
9241     "filename": "server/api/intDeskField/index.js",
9242     "groupTitle": "Desk_Fields"
9243   },
9244   {
9245     "type": "get",
9246     "url": "/api/integrations/desk/fields/{id}",
9247     "title": "Gets a single Desk Field",
9248     "examples": [
9249       {
9250         "title": "Example usage:",
9251         "content": "curl https://{domain}/api/integrations/desk/fields/{id} -v -u {name}:{password}",
9252         "type": "json"
9253       }
9254     ],
9255     "name": "ShowDesk_Fields",
9256     "group": "Desk_Fields",
9257     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9258     "version": "0.0.0",
9259     "filename": "server/api/intDeskField/index.js",
9260     "groupTitle": "Desk_Fields"
9261   },
9262   {
9263     "type": "put",
9264     "url": "/api/integrations/desk/fields/{id}",
9265     "title": "Update an existing Desk Field",
9266     "examples": [
9267       {
9268         "title": "Example usage:",
9269         "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",
9270         "type": "json"
9271       }
9272     ],
9273     "name": "updateDesk_Fields",
9274     "group": "Desk_Fields",
9275     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9276     "version": "0.0.0",
9277     "filename": "server/api/intDeskField/index.js",
9278     "groupTitle": "Desk_Fields"
9279   },
9280   {
9281     "type": "post",
9282     "url": "/api/dispositions",
9283     "title": "Creates a new Disposition",
9284     "examples": [
9285       {
9286         "title": "Example usage:",
9287         "content": "curl https://{domain}/api/dispositions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
9288         "type": "json"
9289       }
9290     ],
9291     "name": "CreateDispositions",
9292     "group": "Dispositions",
9293     "parameter": {
9294       "fields": {
9295         "Body": [
9296           {
9297             "group": "Body",
9298             "type": "String",
9299             "optional": false,
9300             "field": "name",
9301             "description": ""
9302           },
9303           {
9304             "group": "Body",
9305             "type": "String",
9306             "allowedValues": [
9307               "\"first\"",
9308               "\"second\"",
9309               "\"third\""
9310             ],
9311             "optional": false,
9312             "field": "level",
9313             "description": ""
9314           },
9315           {
9316             "group": "Body",
9317             "type": "String",
9318             "optional": true,
9319             "field": "description",
9320             "description": ""
9321           }
9322         ]
9323       }
9324     },
9325     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9326     "version": "0.0.0",
9327     "filename": "server/api/disposition/index.js",
9328     "groupTitle": "Dispositions"
9329   },
9330   {
9331     "type": "delete",
9332     "url": "/api/dispositions/{id}",
9333     "title": "Deletes a Disposition",
9334     "examples": [
9335       {
9336         "title": "Example usage:",
9337         "content": "curl https://{domain}/api/dispositions/{id} -v -u {name}:{password} -X DELETE",
9338         "type": "json"
9339       }
9340     ],
9341     "name": "DeleteDispositions",
9342     "group": "Dispositions",
9343     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9344     "version": "0.0.0",
9345     "filename": "server/api/disposition/index.js",
9346     "groupTitle": "Dispositions"
9347   },
9348   {
9349     "type": "get",
9350     "url": "/api/dispositions",
9351     "title": "Gets a list of Dispositions",
9352     "examples": [
9353       {
9354         "title": "Example usage:",
9355         "content": "curl https://{domain}/api/dispositions -v -u {name}:{password}",
9356         "type": "json"
9357       }
9358     ],
9359     "name": "GetDispositions",
9360     "group": "Dispositions",
9361     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
9362     "version": "0.0.0",
9363     "filename": "server/api/disposition/index.js",
9364     "groupTitle": "Dispositions"
9365   },
9366   {
9367     "type": "get",
9368     "url": "/api/dispositions/{id}",
9369     "title": "Gets a single Disposition",
9370     "examples": [
9371       {
9372         "title": "Example usage:",
9373         "content": "curl https://{domain}/api/dispositions/{id} -v -u {name}:{password}",
9374         "type": "json"
9375       }
9376     ],
9377     "name": "ShowDispositions",
9378     "group": "Dispositions",
9379     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9380     "version": "0.0.0",
9381     "filename": "server/api/disposition/index.js",
9382     "groupTitle": "Dispositions"
9383   },
9384   {
9385     "type": "put",
9386     "url": "/api/dispositions/{id}",
9387     "title": "Update an existing Disposition",
9388     "examples": [
9389       {
9390         "title": "Example usage:",
9391         "content": "curl https://{domain}/api/dispositions/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
9392         "type": "json"
9393       }
9394     ],
9395     "name": "updateDispositions",
9396     "group": "Dispositions",
9397     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9398     "version": "0.0.0",
9399     "filename": "server/api/disposition/index.js",
9400     "groupTitle": "Dispositions"
9401   },
9402   {
9403     "type": "post",
9404     "url": "/api/integrations/dynamics365/accounts",
9405     "title": "Creates a new Dynamics365 Account",
9406     "examples": [
9407       {
9408         "title": "Example usage:",
9409         "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",
9410         "type": "json"
9411       }
9412     ],
9413     "name": "CreateDynamics365_Accounts",
9414     "group": "Dynamics365_Accounts",
9415     "parameter": {
9416       "fields": {
9417         "Body": [
9418           {
9419             "group": "Body",
9420             "type": "String",
9421             "optional": true,
9422             "field": "name",
9423             "description": ""
9424           },
9425           {
9426             "group": "Body",
9427             "type": "String",
9428             "optional": true,
9429             "field": "username",
9430             "description": ""
9431           },
9432           {
9433             "group": "Body",
9434             "type": "String",
9435             "optional": true,
9436             "field": "password",
9437             "description": ""
9438           },
9439           {
9440             "group": "Body",
9441             "type": "String",
9442             "optional": true,
9443             "field": "remoteUri",
9444             "description": ""
9445           },
9446           {
9447             "group": "Body",
9448             "type": "String",
9449             "optional": true,
9450             "field": "tenantId",
9451             "description": ""
9452           },
9453           {
9454             "group": "Body",
9455             "type": "String",
9456             "optional": true,
9457             "field": "clientId",
9458             "description": ""
9459           },
9460           {
9461             "group": "Body",
9462             "type": "String",
9463             "optional": true,
9464             "field": "clientSecret",
9465             "description": ""
9466           },
9467           {
9468             "group": "Body",
9469             "type": "String",
9470             "optional": false,
9471             "field": "serverUrl",
9472             "description": ""
9473           },
9474           {
9475             "group": "Body",
9476             "type": "String",
9477             "optional": true,
9478             "field": "description",
9479             "description": ""
9480           }
9481         ]
9482       }
9483     },
9484     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9485     "version": "0.0.0",
9486     "filename": "server/api/intDynamics365Account/index.js",
9487     "groupTitle": "Dynamics365_Accounts"
9488   },
9489   {
9490     "type": "delete",
9491     "url": "/api/integrations/dynamics365/accounts/{id}",
9492     "title": "Deletes a Dynamics365 Account",
9493     "examples": [
9494       {
9495         "title": "Example usage:",
9496         "content": "curl https://{domain}/api/integrations/dynamics365/accounts/{id} -v -u {name}:{password} -X DELETE",
9497         "type": "json"
9498       }
9499     ],
9500     "name": "DeleteDynamics365_Accounts",
9501     "group": "Dynamics365_Accounts",
9502     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9503     "version": "0.0.0",
9504     "filename": "server/api/intDynamics365Account/index.js",
9505     "groupTitle": "Dynamics365_Accounts"
9506   },
9507   {
9508     "type": "get",
9509     "url": "/api/integrations/dynamics365/accounts",
9510     "title": "Gets a list of Dynamics365 Accounts",
9511     "examples": [
9512       {
9513         "title": "Example usage:",
9514         "content": "curl https://{domain}/api/integrations/dynamics365/accounts -v -u {name}:{password}",
9515         "type": "json"
9516       }
9517     ],
9518     "name": "GetDynamics365_Accounts",
9519     "group": "Dynamics365_Accounts",
9520     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
9521     "version": "0.0.0",
9522     "filename": "server/api/intDynamics365Account/index.js",
9523     "groupTitle": "Dynamics365_Accounts"
9524   },
9525   {
9526     "type": "get",
9527     "url": "/api/integrations/dynamics365/accounts/{id}",
9528     "title": "Gets a single Dynamics365 Account",
9529     "examples": [
9530       {
9531         "title": "Example usage:",
9532         "content": "curl https://{domain}/api/integrations/dynamics365/accounts/{id} -v -u {name}:{password}",
9533         "type": "json"
9534       }
9535     ],
9536     "name": "ShowDynamics365_Accounts",
9537     "group": "Dynamics365_Accounts",
9538     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9539     "version": "0.0.0",
9540     "filename": "server/api/intDynamics365Account/index.js",
9541     "groupTitle": "Dynamics365_Accounts"
9542   },
9543   {
9544     "type": "post",
9545     "url": "/api/integrations/dynamics365/accounts/{id}/configurations",
9546     "title": "Creates new configuration",
9547     "examples": [
9548       {
9549         "title": "Example usage:",
9550         "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",
9551         "type": "json"
9552       }
9553     ],
9554     "name": "addConfiguration",
9555     "group": "Dynamics365_Accounts",
9556     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9557     "version": "0.0.0",
9558     "filename": "server/api/intDynamics365Account/index.js",
9559     "groupTitle": "Dynamics365_Accounts"
9560   },
9561   {
9562     "type": "get",
9563     "url": "/api/integrations/dynamics365/accounts/{id}/configurations",
9564     "title": "Gets account configurations",
9565     "examples": [
9566       {
9567         "title": "Example usage:",
9568         "content": "curl https://{domain}/api/integrations/dynamics365/accounts/{id}/configurations -v -u {name}:{password} -X GET",
9569         "type": "json"
9570       }
9571     ],
9572     "name": "getConfigurations",
9573     "group": "Dynamics365_Accounts",
9574     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9575     "version": "0.0.0",
9576     "filename": "server/api/intDynamics365Account/index.js",
9577     "groupTitle": "Dynamics365_Accounts"
9578   },
9579   {
9580     "type": "get",
9581     "url": "/api/integrations/dynamics365/accounts/{id}/fields",
9582     "title": "Gets account fields",
9583     "examples": [
9584       {
9585         "title": "Example usage:",
9586         "content": "curl https://{domain}/api/integrations/dynamics365/accounts/{id}/fields -v -u {name}:{password} -X GET",
9587         "type": "json"
9588       }
9589     ],
9590     "name": "getFields",
9591     "group": "Dynamics365_Accounts",
9592     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9593     "version": "0.0.0",
9594     "filename": "server/api/intDynamics365Account/index.js",
9595     "groupTitle": "Dynamics365_Accounts"
9596   },
9597   {
9598     "type": "put",
9599     "url": "/api/integrations/dynamics365/accounts/{id}",
9600     "title": "Update an existing Dynamics365 Account",
9601     "examples": [
9602       {
9603         "title": "Example usage:",
9604         "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",
9605         "type": "json"
9606       }
9607     ],
9608     "name": "updateDynamics365_Accounts",
9609     "group": "Dynamics365_Accounts",
9610     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9611     "version": "0.0.0",
9612     "filename": "server/api/intDynamics365Account/index.js",
9613     "groupTitle": "Dynamics365_Accounts"
9614   },
9615   {
9616     "type": "post",
9617     "url": "/api/integrations/dynamics365/configurations",
9618     "title": "Creates a new Dynamics365 Configuration",
9619     "examples": [
9620       {
9621         "title": "Example usage:",
9622         "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",
9623         "type": "json"
9624       }
9625     ],
9626     "name": "CreateDynamics365_Configurations",
9627     "group": "Dynamics365_Configurations",
9628     "parameter": {
9629       "fields": {
9630         "Body": [
9631           {
9632             "group": "Body",
9633             "type": "String",
9634             "optional": true,
9635             "field": "name",
9636             "description": ""
9637           },
9638           {
9639             "group": "Body",
9640             "type": "String",
9641             "optional": true,
9642             "field": "description",
9643             "description": ""
9644           },
9645           {
9646             "group": "Body",
9647             "type": "String",
9648             "allowedValues": [
9649               "\"incident\"",
9650               "\"phonecall\""
9651             ],
9652             "optional": true,
9653             "field": "ticketType",
9654             "description": ""
9655           }
9656         ]
9657       }
9658     },
9659     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9660     "version": "0.0.0",
9661     "filename": "server/api/intDynamics365Configuration/index.js",
9662     "groupTitle": "Dynamics365_Configurations"
9663   },
9664   {
9665     "type": "delete",
9666     "url": "/api/integrations/dynamics365/configurations/{id}",
9667     "title": "Deletes a Dynamics365 Configuration",
9668     "examples": [
9669       {
9670         "title": "Example usage:",
9671         "content": "curl https://{domain}/api/integrations/dynamics365/configurations/{id} -v -u {name}:{password} -X DELETE",
9672         "type": "json"
9673       }
9674     ],
9675     "name": "DeleteDynamics365_Configurations",
9676     "group": "Dynamics365_Configurations",
9677     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9678     "version": "0.0.0",
9679     "filename": "server/api/intDynamics365Configuration/index.js",
9680     "groupTitle": "Dynamics365_Configurations"
9681   },
9682   {
9683     "type": "get",
9684     "url": "/api/integrations/dynamics365/configurations",
9685     "title": "Gets a list of Dynamics365 Configurations",
9686     "examples": [
9687       {
9688         "title": "Example usage:",
9689         "content": "curl https://{domain}/api/integrations/dynamics365/configurations -v -u {name}:{password}",
9690         "type": "json"
9691       }
9692     ],
9693     "name": "GetDynamics365_Configurations",
9694     "group": "Dynamics365_Configurations",
9695     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
9696     "version": "0.0.0",
9697     "filename": "server/api/intDynamics365Configuration/index.js",
9698     "groupTitle": "Dynamics365_Configurations"
9699   },
9700   {
9701     "type": "get",
9702     "url": "/api/integrations/dynamics365/configurations/{id}",
9703     "title": "Gets a single Dynamics365 Configuration",
9704     "examples": [
9705       {
9706         "title": "Example usage:",
9707         "content": "curl https://{domain}/api/integrations/dynamics365/configurations/{id} -v -u {name}:{password}",
9708         "type": "json"
9709       }
9710     ],
9711     "name": "ShowDynamics365_Configurations",
9712     "group": "Dynamics365_Configurations",
9713     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9714     "version": "0.0.0",
9715     "filename": "server/api/intDynamics365Configuration/index.js",
9716     "groupTitle": "Dynamics365_Configurations"
9717   },
9718   {
9719     "type": "get",
9720     "url": "/api/integrations/dynamics365/configurations/{id}/descriptions",
9721     "title": "Gets configurations descriptions",
9722     "examples": [
9723       {
9724         "title": "Example usage:",
9725         "content": "curl https://{domain}/api/integrations/dynamics365/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
9726         "type": "json"
9727       }
9728     ],
9729     "name": "getDescriptions",
9730     "group": "Dynamics365_Configurations",
9731     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9732     "version": "0.0.0",
9733     "filename": "server/api/intDynamics365Configuration/index.js",
9734     "groupTitle": "Dynamics365_Configurations"
9735   },
9736   {
9737     "type": "get",
9738     "url": "/api/integrations/dynamics365/configurations/{id}/fields",
9739     "title": "Gets configurations fields",
9740     "examples": [
9741       {
9742         "title": "Example usage:",
9743         "content": "curl https://{domain}/api/integrations/zoho/configurations/{id}/fields -v -u {name}:{password} -X GET",
9744         "type": "json"
9745       }
9746     ],
9747     "name": "getFields",
9748     "group": "Dynamics365_Configurations",
9749     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9750     "version": "0.0.0",
9751     "filename": "server/api/intDynamics365Configuration/index.js",
9752     "groupTitle": "Dynamics365_Configurations"
9753   },
9754   {
9755     "type": "get",
9756     "url": "/api/integrations/zoho/configurations/{id}/subjects",
9757     "title": "Gets configurations subjects",
9758     "examples": [
9759       {
9760         "title": "Example usage:",
9761         "content": "curl https://{domain}/api/integrations/dynamics365/configurations/{id}/subjects -v -u {name}:{password} -X GET",
9762         "type": "json"
9763       }
9764     ],
9765     "name": "getSubjects",
9766     "group": "Dynamics365_Configurations",
9767     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9768     "version": "0.0.0",
9769     "filename": "server/api/intDynamics365Configuration/index.js",
9770     "groupTitle": "Dynamics365_Configurations"
9771   },
9772   {
9773     "type": "put",
9774     "url": "/api/integrations/dynamics365/configurations/{id}",
9775     "title": "Update an existing Dynamics365 Configuration",
9776     "examples": [
9777       {
9778         "title": "Example usage:",
9779         "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",
9780         "type": "json"
9781       }
9782     ],
9783     "name": "updateDynamics365_Configurations",
9784     "group": "Dynamics365_Configurations",
9785     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9786     "version": "0.0.0",
9787     "filename": "server/api/intDynamics365Configuration/index.js",
9788     "groupTitle": "Dynamics365_Configurations"
9789   },
9790   {
9791     "type": "post",
9792     "url": "/api/integrations/dynamics365/fields",
9793     "title": "Creates a new Dynamics365 Field",
9794     "examples": [
9795       {
9796         "title": "Example usage:",
9797         "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",
9798         "type": "json"
9799       }
9800     ],
9801     "name": "CreateDynamics365_Fields",
9802     "group": "Dynamics365_Fields",
9803     "parameter": {
9804       "fields": {
9805         "Body": [
9806           {
9807             "group": "Body",
9808             "type": "String",
9809             "allowedValues": [
9810               "\"string\"",
9811               "\"variable\"",
9812               "\"customVariable\"",
9813               "\"keyValue\"",
9814               "\"picklist\""
9815             ],
9816             "optional": true,
9817             "field": "type",
9818             "description": ""
9819           },
9820           {
9821             "group": "Body",
9822             "type": "String",
9823             "optional": true,
9824             "field": "content",
9825             "description": ""
9826           },
9827           {
9828             "group": "Body",
9829             "type": "String",
9830             "optional": true,
9831             "field": "key",
9832             "description": ""
9833           },
9834           {
9835             "group": "Body",
9836             "type": "String",
9837             "allowedValues": [
9838               "\"string\"",
9839               "\"variable\"",
9840               "\"customVariable\""
9841             ],
9842             "optional": true,
9843             "field": "keyType",
9844             "description": ""
9845           },
9846           {
9847             "group": "Body",
9848             "type": "String",
9849             "optional": true,
9850             "field": "keyContent",
9851             "description": ""
9852           },
9853           {
9854             "group": "Body",
9855             "type": "String",
9856             "optional": true,
9857             "field": "idField",
9858             "description": ""
9859           },
9860           {
9861             "group": "Body",
9862             "type": "String",
9863             "optional": true,
9864             "field": "nameField",
9865             "description": ""
9866           },
9867           {
9868             "group": "Body",
9869             "type": "Boolean",
9870             "optional": true,
9871             "field": "customField",
9872             "description": ""
9873           },
9874           {
9875             "group": "Body",
9876             "type": "String",
9877             "optional": true,
9878             "field": "variableName",
9879             "description": ""
9880           }
9881         ]
9882       }
9883     },
9884     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9885     "version": "0.0.0",
9886     "filename": "server/api/intDynamics365Field/index.js",
9887     "groupTitle": "Dynamics365_Fields"
9888   },
9889   {
9890     "type": "delete",
9891     "url": "/api/integrations/dynamics365/fields/{id}",
9892     "title": "Deletes a Dynamics365 Field",
9893     "examples": [
9894       {
9895         "title": "Example usage:",
9896         "content": "curl https://{domain}/api/integrations/dynamics365/fields/{id} -v -u {name}:{password} -X DELETE",
9897         "type": "json"
9898       }
9899     ],
9900     "name": "DeleteDynamics365_Fields",
9901     "group": "Dynamics365_Fields",
9902     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9903     "version": "0.0.0",
9904     "filename": "server/api/intDynamics365Field/index.js",
9905     "groupTitle": "Dynamics365_Fields"
9906   },
9907   {
9908     "type": "get",
9909     "url": "/api/integrations/dynamics365/fields",
9910     "title": "Gets a list of Dynamics365 Fields",
9911     "examples": [
9912       {
9913         "title": "Example usage:",
9914         "content": "curl https://{domain}/api/integrations/dynamics365/fields -v -u {name}:{password}",
9915         "type": "json"
9916       }
9917     ],
9918     "name": "GetDynamics365_Fields",
9919     "group": "Dynamics365_Fields",
9920     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
9921     "version": "0.0.0",
9922     "filename": "server/api/intDynamics365Field/index.js",
9923     "groupTitle": "Dynamics365_Fields"
9924   },
9925   {
9926     "type": "get",
9927     "url": "/api/integrations/dynamics365/fields/{id}",
9928     "title": "Gets a single Dynamics365 Field",
9929     "examples": [
9930       {
9931         "title": "Example usage:",
9932         "content": "curl https://{domain}/api/integrations/dynamics365/fields/{id} -v -u {name}:{password}",
9933         "type": "json"
9934       }
9935     ],
9936     "name": "ShowDynamics365_Fields",
9937     "group": "Dynamics365_Fields",
9938     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9939     "version": "0.0.0",
9940     "filename": "server/api/intDynamics365Field/index.js",
9941     "groupTitle": "Dynamics365_Fields"
9942   },
9943   {
9944     "type": "put",
9945     "url": "/api/integrations/dynamics365/fields/{id}",
9946     "title": "Update an existing Dynamics365 Field",
9947     "examples": [
9948       {
9949         "title": "Example usage:",
9950         "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",
9951         "type": "json"
9952       }
9953     ],
9954     "name": "updateDynamics365_Fields",
9955     "group": "Dynamics365_Fields",
9956     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9957     "version": "0.0.0",
9958     "filename": "server/api/intDynamics365Field/index.js",
9959     "groupTitle": "Dynamics365_Fields"
9960   },
9961   {
9962     "type": "post",
9963     "url": "/api/fax/accounts/{id}/users",
9964     "title": "Add agents to a fax account",
9965     "examples": [
9966       {
9967         "title": "Example usage:",
9968         "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",
9969         "type": "json"
9970       }
9971     ],
9972     "name": "AddAgents",
9973     "group": "Fax_Accounts",
9974     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9975     "version": "0.0.0",
9976     "filename": "server/api/faxAccount/index.js",
9977     "groupTitle": "Fax_Accounts"
9978   },
9979   {
9980     "type": "post",
9981     "url": "/api/fax/accounts",
9982     "title": "Creates a new Account",
9983     "examples": [
9984       {
9985         "title": "Example usage:",
9986         "content": "curl https://{domain}/api/fax/accounts -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
9987         "type": "json"
9988       }
9989     ],
9990     "name": "CreateAccounts",
9991     "group": "Fax_Accounts",
9992     "parameter": {
9993       "fields": {
9994         "Body": [
9995           {
9996             "group": "Body",
9997             "type": "String",
9998             "optional": false,
9999             "field": "name",
10000             "description": ""
10001           },
10002           {
10003             "group": "Body",
10004             "type": "String",
10005             "optional": true,
10006             "field": "description",
10007             "description": ""
10008           },
10009           {
10010             "group": "Body",
10011             "type": "String",
10012             "allowedValues": [
10013               "\"yes\"",
10014               "\"no\""
10015             ],
10016             "optional": true,
10017             "field": "ecm",
10018             "description": ""
10019           },
10020           {
10021             "group": "Body",
10022             "type": "String",
10023             "optional": true,
10024             "field": "headerinfo",
10025             "description": ""
10026           },
10027           {
10028             "group": "Body",
10029             "type": "String",
10030             "optional": true,
10031             "field": "localstationid",
10032             "description": ""
10033           },
10034           {
10035             "group": "Body",
10036             "type": "String",
10037             "allowedValues": [
10038               "\"2400\"",
10039               "\"4800\"",
10040               "\"7200\"",
10041               "\"9600\"",
10042               "\"12000\"",
10043               "\"14400\""
10044             ],
10045             "optional": true,
10046             "field": "minrate",
10047             "description": ""
10048           },
10049           {
10050             "group": "Body",
10051             "type": "String",
10052             "allowedValues": [
10053               "\"2400\"",
10054               "\"4800\"",
10055               "\"7200\"",
10056               "\"9600\"",
10057               "\"12000\"",
10058               "\"14400\""
10059             ],
10060             "optional": true,
10061             "field": "maxrate",
10062             "description": ""
10063           },
10064           {
10065             "group": "Body",
10066             "type": "String",
10067             "optional": true,
10068             "field": "modem",
10069             "description": ""
10070           },
10071           {
10072             "group": "Body",
10073             "type": "String",
10074             "optional": true,
10075             "field": "gateway",
10076             "description": ""
10077           },
10078           {
10079             "group": "Body",
10080             "type": "String",
10081             "optional": true,
10082             "field": "faxdetect",
10083             "description": ""
10084           },
10085           {
10086             "group": "Body",
10087             "type": "Integer",
10088             "optional": true,
10089             "field": "t38timeout",
10090             "description": ""
10091           },
10092           {
10093             "group": "Body",
10094             "type": "String",
10095             "allowedValues": [
10096               "\"SIP\"",
10097               "\"IAX\"",
10098               "\"DADHI\"",
10099               "\"KHOMP\""
10100             ],
10101             "optional": true,
10102             "field": "tech",
10103             "description": ""
10104           },
10105           {
10106             "group": "Body",
10107             "type": "String",
10108             "optional": false,
10109             "field": "key",
10110             "description": ""
10111           },
10112           {
10113             "group": "Body",
10114             "type": "Text",
10115             "optional": true,
10116             "field": "notificationTemplate",
10117             "description": ""
10118           },
10119           {
10120             "group": "Body",
10121             "type": "Boolean",
10122             "optional": true,
10123             "field": "notificationSound",
10124             "description": ""
10125           },
10126           {
10127             "group": "Body",
10128             "type": "Boolean",
10129             "optional": true,
10130             "field": "notificationShake",
10131             "description": ""
10132           },
10133           {
10134             "group": "Body",
10135             "type": "Integer",
10136             "optional": true,
10137             "field": "waitForTheAssignedAgent",
10138             "description": ""
10139           },
10140           {
10141             "group": "Body",
10142             "type": "Boolean",
10143             "optional": true,
10144             "field": "queueTransfer",
10145             "description": ""
10146           },
10147           {
10148             "group": "Body",
10149             "type": "Integer",
10150             "optional": true,
10151             "field": "queueTransferTimeout",
10152             "description": ""
10153           },
10154           {
10155             "group": "Body",
10156             "type": "Boolean",
10157             "optional": true,
10158             "field": "agentTransfer",
10159             "description": ""
10160           },
10161           {
10162             "group": "Body",
10163             "type": "Integer",
10164             "optional": true,
10165             "field": "agentTransferTimeout",
10166             "description": ""
10167           },
10168           {
10169             "group": "Body",
10170             "type": "Integer",
10171             "optional": true,
10172             "field": "mandatoryDispositionPauseId",
10173             "description": "<p>Status to put when mandatory disposition is enabled</p>"
10174           },
10175           {
10176             "group": "Body",
10177             "type": "Boolean",
10178             "optional": true,
10179             "field": "mandatoryDisposition",
10180             "description": "<p>Enabled/disables mandatory dispo on a queue</p>"
10181           }
10182         ]
10183       }
10184     },
10185     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10186     "version": "0.0.0",
10187     "filename": "server/api/faxAccount/index.js",
10188     "groupTitle": "Fax_Accounts"
10189   },
10190   {
10191     "type": "delete",
10192     "url": "/api/fax/accounts/{id}",
10193     "title": "Deletes a Account",
10194     "examples": [
10195       {
10196         "title": "Example usage:",
10197         "content": "curl https://{domain}/api/fax/accounts/{id} -v -u {name}:{password} -X DELETE",
10198         "type": "json"
10199       }
10200     ],
10201     "name": "DeleteAccounts",
10202     "group": "Fax_Accounts",
10203     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10204     "version": "0.0.0",
10205     "filename": "server/api/faxAccount/index.js",
10206     "groupTitle": "Fax_Accounts"
10207   },
10208   {
10209     "type": "get",
10210     "url": "/api/fax/accounts/describe",
10211     "title": "Gets table info about Accounts",
10212     "examples": [
10213       {
10214         "title": "Example usage:",
10215         "content": "curl https://{domain}/api/fax/accounts/describe -v -u {name}:{password}",
10216         "type": "json"
10217       }
10218     ],
10219     "name": "DescribeAccounts",
10220     "group": "Fax_Accounts",
10221     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10222     "version": "0.0.0",
10223     "filename": "server/api/faxAccount/index.js",
10224     "groupTitle": "Fax_Accounts"
10225   },
10226   {
10227     "type": "get",
10228     "url": "/api/fax/accounts",
10229     "title": "Gets a list of Accounts",
10230     "examples": [
10231       {
10232         "title": "Example usage:",
10233         "content": "curl https://{domain}/api/fax/accounts -v -u {name}:{password}",
10234         "type": "json"
10235       }
10236     ],
10237     "name": "GetAccounts",
10238     "group": "Fax_Accounts",
10239     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
10240     "version": "0.0.0",
10241     "filename": "server/api/faxAccount/index.js",
10242     "groupTitle": "Fax_Accounts"
10243   },
10244   {
10245     "type": "get",
10246     "url": "/api/fax/accounts/{id}/users",
10247     "title": "Gets agents from fax account",
10248     "examples": [
10249       {
10250         "title": "Example usage:",
10251         "content": "curl https://{domain}/api/fax/accounts/{id}/users -v -u {name}:{password} -X GET",
10252         "type": "json"
10253       }
10254     ],
10255     "name": "GetAgents",
10256     "group": "Fax_Accounts",
10257     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10258     "version": "0.0.0",
10259     "filename": "server/api/faxAccount/index.js",
10260     "groupTitle": "Fax_Accounts"
10261   },
10262   {
10263     "type": "delete",
10264     "url": "/api/fax/accounts/{id}/users",
10265     "title": "Removes agents from a fax account",
10266     "examples": [
10267       {
10268         "title": "Example usage:",
10269         "content": "curl https://{domain}/api/fax/accounts/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
10270         "type": "json"
10271       }
10272     ],
10273     "name": "RemoveAgents",
10274     "group": "Fax_Accounts",
10275     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10276     "version": "0.0.0",
10277     "filename": "server/api/faxAccount/index.js",
10278     "groupTitle": "Fax_Accounts"
10279   },
10280   {
10281     "type": "delete",
10282     "url": "/api/fax/accounts/{id}/canned_answers",
10283     "title": "Removes canned answers from account",
10284     "examples": [
10285       {
10286         "title": "Example usage:",
10287         "content": "curl https://{domain}/api/fax/accounts/{id}/canned_answers?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
10288         "type": "json"
10289       }
10290     ],
10291     "name": "RemoveAnswers",
10292     "group": "Fax_Accounts",
10293     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10294     "version": "0.0.0",
10295     "filename": "server/api/faxAccount/index.js",
10296     "groupTitle": "Fax_Accounts"
10297   },
10298   {
10299     "type": "delete",
10300     "url": "/api/fax/accounts/{id}/dispositions",
10301     "title": "Removes dispositions from account",
10302     "examples": [
10303       {
10304         "title": "Example usage:",
10305         "content": "curl https://{domain}/api/fax/accounts/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
10306         "type": "json"
10307       }
10308     ],
10309     "name": "RemoveDispositions",
10310     "group": "Fax_Accounts",
10311     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10312     "version": "0.0.0",
10313     "filename": "server/api/faxAccount/index.js",
10314     "groupTitle": "Fax_Accounts"
10315   },
10316   {
10317     "type": "get",
10318     "url": "/api/fax/accounts/{id}",
10319     "title": "Gets a single Account",
10320     "examples": [
10321       {
10322         "title": "Example usage:",
10323         "content": "curl https://{domain}/api/fax/accounts/{id} -v -u {name}:{password}",
10324         "type": "json"
10325       }
10326     ],
10327     "name": "ShowAccounts",
10328     "group": "Fax_Accounts",
10329     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10330     "version": "0.0.0",
10331     "filename": "server/api/faxAccount/index.js",
10332     "groupTitle": "Fax_Accounts"
10333   },
10334   {
10335     "type": "post",
10336     "url": "/api/fax/accounts/{id}/canned_answers",
10337     "title": "Creates new canned answer",
10338     "examples": [
10339       {
10340         "title": "Example usage:",
10341         "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",
10342         "type": "json"
10343       }
10344     ],
10345     "name": "addAnswer",
10346     "group": "Fax_Accounts",
10347     "parameter": {
10348       "fields": {
10349         "Body": [
10350           {
10351             "group": "Body",
10352             "type": "String",
10353             "optional": false,
10354             "field": "key",
10355             "description": ""
10356           },
10357           {
10358             "group": "Body",
10359             "type": "Text",
10360             "optional": false,
10361             "field": "value",
10362             "description": ""
10363           },
10364           {
10365             "group": "Body",
10366             "type": "String",
10367             "optional": true,
10368             "field": "description",
10369             "description": ""
10370           },
10371           {
10372             "group": "Body",
10373             "type": "Virtual",
10374             "optional": true,
10375             "field": "name",
10376             "description": ""
10377           }
10378         ]
10379       }
10380     },
10381     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10382     "version": "0.0.0",
10383     "filename": "server/api/faxAccount/index.js",
10384     "groupTitle": "Fax_Accounts"
10385   },
10386   {
10387     "type": "post",
10388     "url": "/api/fax/accounts/addaccountapplications",
10389     "title": "Creates new account and applications",
10390     "examples": [
10391       {
10392         "title": "Example usage:",
10393         "content": "curl https://{domain}/api/fax/accounts/addaccountapplications -d '[{\"name\": \"name\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
10394         "type": "json"
10395       }
10396     ],
10397     "name": "addApplications",
10398     "group": "Fax_Accounts",
10399     "parameter": {
10400       "fields": {
10401         "Body": [
10402           {
10403             "group": "Body",
10404             "type": "Integer",
10405             "optional": false,
10406             "field": "priority",
10407             "description": ""
10408           },
10409           {
10410             "group": "Body",
10411             "type": "String",
10412             "optional": false,
10413             "field": "app",
10414             "description": ""
10415           },
10416           {
10417             "group": "Body",
10418             "type": "Text",
10419             "optional": true,
10420             "field": "appdata",
10421             "description": ""
10422           },
10423           {
10424             "group": "Body",
10425             "type": "String",
10426             "optional": true,
10427             "field": "description",
10428             "description": ""
10429           },
10430           {
10431             "group": "Body",
10432             "type": "String",
10433             "optional": true,
10434             "field": "interval",
10435             "description": ""
10436           }
10437         ]
10438       }
10439     },
10440     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10441     "version": "0.0.0",
10442     "filename": "server/api/faxAccount/index.js",
10443     "groupTitle": "Fax_Accounts"
10444   },
10445   {
10446     "type": "post",
10447     "url": "/api/fax/accounts/{id}/applications",
10448     "title": "Creates new applications",
10449     "examples": [
10450       {
10451         "title": "Example usage:",
10452         "content": "curl https://{domain}/api/fax/accounts/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
10453         "type": "json"
10454       }
10455     ],
10456     "name": "addApplications",
10457     "group": "Fax_Accounts",
10458     "parameter": {
10459       "fields": {
10460         "Body": [
10461           {
10462             "group": "Body",
10463             "type": "Integer",
10464             "optional": false,
10465             "field": "priority",
10466             "description": ""
10467           },
10468           {
10469             "group": "Body",
10470             "type": "String",
10471             "optional": false,
10472             "field": "app",
10473             "description": ""
10474           },
10475           {
10476             "group": "Body",
10477             "type": "Text",
10478             "optional": true,
10479             "field": "appdata",
10480             "description": ""
10481           },
10482           {
10483             "group": "Body",
10484             "type": "String",
10485             "optional": true,
10486             "field": "description",
10487             "description": ""
10488           },
10489           {
10490             "group": "Body",
10491             "type": "String",
10492             "optional": true,
10493             "field": "interval",
10494             "description": ""
10495           }
10496         ]
10497       }
10498     },
10499     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10500     "version": "0.0.0",
10501     "filename": "server/api/faxAccount/index.js",
10502     "groupTitle": "Fax_Accounts"
10503   },
10504   {
10505     "type": "post",
10506     "url": "/api/fax/accounts/{id}/dispositions",
10507     "title": "Creates new disposition",
10508     "examples": [
10509       {
10510         "title": "Example usage:",
10511         "content": "curl https://{domain}/api/fax/accounts/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
10512         "type": "json"
10513       }
10514     ],
10515     "name": "addDisposition",
10516     "group": "Fax_Accounts",
10517     "parameter": {
10518       "fields": {
10519         "Body": [
10520           {
10521             "group": "Body",
10522             "type": "String",
10523             "optional": false,
10524             "field": "name",
10525             "description": ""
10526           },
10527           {
10528             "group": "Body",
10529             "type": "String",
10530             "allowedValues": [
10531               "\"first\"",
10532               "\"second\"",
10533               "\"third\""
10534             ],
10535             "optional": false,
10536             "field": "level",
10537             "description": ""
10538           },
10539           {
10540             "group": "Body",
10541             "type": "String",
10542             "optional": true,
10543             "field": "description",
10544             "description": ""
10545           }
10546         ]
10547       }
10548     },
10549     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10550     "version": "0.0.0",
10551     "filename": "server/api/faxAccount/index.js",
10552     "groupTitle": "Fax_Accounts"
10553   },
10554   {
10555     "type": "post",
10556     "url": "/api/fax/accounts/{id}/interactions",
10557     "title": "Creates new interactions",
10558     "examples": [
10559       {
10560         "title": "Example usage:",
10561         "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",
10562         "type": "json"
10563       }
10564     ],
10565     "name": "addInteraction",
10566     "group": "Fax_Accounts",
10567     "parameter": {
10568       "fields": {
10569         "Body": [
10570           {
10571             "group": "Body",
10572             "type": "Boolean",
10573             "optional": true,
10574             "field": "closed",
10575             "description": ""
10576           },
10577           {
10578             "group": "Body",
10579             "type": "String",
10580             "optional": true,
10581             "field": "closedAt",
10582             "description": ""
10583           },
10584           {
10585             "group": "Body",
10586             "type": "String",
10587             "optional": true,
10588             "field": "disposition",
10589             "description": ""
10590           },
10591           {
10592             "group": "Body",
10593             "type": "String",
10594             "optional": true,
10595             "field": "secondDisposition",
10596             "description": ""
10597           },
10598           {
10599             "group": "Body",
10600             "type": "String",
10601             "optional": true,
10602             "field": "thirdDisposition",
10603             "description": ""
10604           },
10605           {
10606             "group": "Body",
10607             "type": "String",
10608             "optional": true,
10609             "field": "note",
10610             "description": ""
10611           },
10612           {
10613             "group": "Body",
10614             "type": "String",
10615             "optional": true,
10616             "field": "read1stAt",
10617             "description": ""
10618           },
10619           {
10620             "group": "Body",
10621             "type": "String",
10622             "optional": true,
10623             "field": "fax",
10624             "description": ""
10625           },
10626           {
10627             "group": "Body",
10628             "type": "String",
10629             "allowedValues": [
10630               "\"in\"",
10631               "\"out\""
10632             ],
10633             "optional": false,
10634             "field": "firstMsgDirection",
10635             "description": ""
10636           },
10637           {
10638             "group": "Body",
10639             "type": "String",
10640             "optional": true,
10641             "field": "lastMsgAt",
10642             "description": ""
10643           },
10644           {
10645             "group": "Body",
10646             "type": "String",
10647             "allowedValues": [
10648               "\"in\"",
10649               "\"out\""
10650             ],
10651             "optional": false,
10652             "field": "lastMsgDirection",
10653             "description": ""
10654           }
10655         ]
10656       }
10657     },
10658     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10659     "version": "0.0.0",
10660     "filename": "server/api/faxAccount/index.js",
10661     "groupTitle": "Fax_Accounts"
10662   },
10663   {
10664     "type": "get",
10665     "url": "/api/fax/accounts/{id}/canned_answers",
10666     "title": "Gets account canned answers",
10667     "examples": [
10668       {
10669         "title": "Example usage:",
10670         "content": "curl https://{domain}/api/fax/accounts/{id}/canned_answers -v -u {name}:{password} -X GET",
10671         "type": "json"
10672       }
10673     ],
10674     "name": "getAnswers",
10675     "group": "Fax_Accounts",
10676     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10677     "version": "0.0.0",
10678     "filename": "server/api/faxAccount/index.js",
10679     "groupTitle": "Fax_Accounts"
10680   },
10681   {
10682     "type": "get",
10683     "url": "/api/fax/accounts/{id}/applications",
10684     "title": "Gets account pplications",
10685     "examples": [
10686       {
10687         "title": "Example usage:",
10688         "content": "curl https://{domain}/api/fax/accounts/{id}/applications -v -u {name}:{password} -X GET",
10689         "type": "json"
10690       }
10691     ],
10692     "name": "getApplications",
10693     "group": "Fax_Accounts",
10694     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10695     "version": "0.0.0",
10696     "filename": "server/api/faxAccount/index.js",
10697     "groupTitle": "Fax_Accounts"
10698   },
10699   {
10700     "type": "get",
10701     "url": "/api/fax/accounts/{id}/dispositions",
10702     "title": "Gets account dispositions",
10703     "examples": [
10704       {
10705         "title": "Example usage:",
10706         "content": "curl https://{domain}/api/fax/accounts/{id}/dispositions -v -u {name}:{password} -X GET",
10707         "type": "json"
10708       }
10709     ],
10710     "name": "getDispositions",
10711     "group": "Fax_Accounts",
10712     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10713     "version": "0.0.0",
10714     "filename": "server/api/faxAccount/index.js",
10715     "groupTitle": "Fax_Accounts"
10716   },
10717   {
10718     "type": "get",
10719     "url": "/api/fax/accounts/{id}/interactions",
10720     "title": "Gets account interactions",
10721     "examples": [
10722       {
10723         "title": "Example usage:",
10724         "content": "curl https://{domain}/api/fax/accounts/{id}/interactions -v -u {name}:{password} -X GET",
10725         "type": "json"
10726       }
10727     ],
10728     "name": "getInteraction",
10729     "group": "Fax_Accounts",
10730     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10731     "version": "0.0.0",
10732     "filename": "server/api/faxAccount/index.js",
10733     "groupTitle": "Fax_Accounts"
10734   },
10735   {
10736     "type": "get",
10737     "url": "/api/fax/accounts/{id}/messages",
10738     "title": "Gets account messages",
10739     "examples": [
10740       {
10741         "title": "Example usage:",
10742         "content": "curl https://{domain}/api/fax/accounts/{id}/messages -v -u {name}:{password} -X GET",
10743         "type": "json"
10744       }
10745     ],
10746     "name": "getMessages",
10747     "group": "Fax_Accounts",
10748     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10749     "version": "0.0.0",
10750     "filename": "server/api/faxAccount/index.js",
10751     "groupTitle": "Fax_Accounts"
10752   },
10753   {
10754     "type": "post",
10755     "url": "/api/fax/accounts/{id}/send",
10756     "title": "Send new fax",
10757     "examples": [
10758       {
10759         "title": "Example usage:",
10760         "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",
10761         "type": "json"
10762       }
10763     ],
10764     "name": "sendFax",
10765     "group": "Fax_Accounts",
10766     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10767     "version": "0.0.0",
10768     "filename": "server/api/faxAccount/index.js",
10769     "groupTitle": "Fax_Accounts"
10770   },
10771   {
10772     "type": "put",
10773     "url": "/api/fax/accounts/{id}",
10774     "title": "Update an existing Account",
10775     "examples": [
10776       {
10777         "title": "Example usage:",
10778         "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",
10779         "type": "json"
10780       }
10781     ],
10782     "name": "updateAccounts",
10783     "group": "Fax_Accounts",
10784     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10785     "version": "0.0.0",
10786     "filename": "server/api/faxAccount/index.js",
10787     "groupTitle": "Fax_Accounts"
10788   },
10789   {
10790     "type": "post",
10791     "url": "/api/fax/accounts/updateaccountapplications",
10792     "title": "Update account and applications",
10793     "examples": [
10794       {
10795         "title": "Example usage:",
10796         "content": "curl https://{domain}/api/fax/accounts/updateaccountapplications -d '[{\"name\": \"name\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
10797         "type": "json"
10798       }
10799     ],
10800     "name": "updateApplications",
10801     "group": "Fax_Accounts",
10802     "parameter": {
10803       "fields": {
10804         "Body": [
10805           {
10806             "group": "Body",
10807             "type": "Integer",
10808             "optional": false,
10809             "field": "priority",
10810             "description": ""
10811           },
10812           {
10813             "group": "Body",
10814             "type": "String",
10815             "optional": false,
10816             "field": "app",
10817             "description": ""
10818           },
10819           {
10820             "group": "Body",
10821             "type": "Text",
10822             "optional": true,
10823             "field": "appdata",
10824             "description": ""
10825           },
10826           {
10827             "group": "Body",
10828             "type": "String",
10829             "optional": true,
10830             "field": "description",
10831             "description": ""
10832           },
10833           {
10834             "group": "Body",
10835             "type": "String",
10836             "optional": true,
10837             "field": "interval",
10838             "description": ""
10839           }
10840         ]
10841       }
10842     },
10843     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10844     "version": "0.0.0",
10845     "filename": "server/api/faxAccount/index.js",
10846     "groupTitle": "Fax_Accounts"
10847   },
10848   {
10849     "type": "post",
10850     "url": "/api/fax/applications",
10851     "title": "Creates a new Application",
10852     "examples": [
10853       {
10854         "title": "Example usage:",
10855         "content": "curl https://{domain}/api/fax/applications -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
10856         "type": "json"
10857       }
10858     ],
10859     "name": "CreateApplications",
10860     "group": "Fax_Applications",
10861     "parameter": {
10862       "fields": {
10863         "Body": [
10864           {
10865             "group": "Body",
10866             "type": "Integer",
10867             "optional": false,
10868             "field": "priority",
10869             "description": ""
10870           },
10871           {
10872             "group": "Body",
10873             "type": "String",
10874             "optional": false,
10875             "field": "app",
10876             "description": ""
10877           },
10878           {
10879             "group": "Body",
10880             "type": "Text",
10881             "optional": true,
10882             "field": "appdata",
10883             "description": ""
10884           },
10885           {
10886             "group": "Body",
10887             "type": "String",
10888             "optional": true,
10889             "field": "description",
10890             "description": ""
10891           },
10892           {
10893             "group": "Body",
10894             "type": "String",
10895             "optional": true,
10896             "field": "interval",
10897             "description": ""
10898           }
10899         ]
10900       }
10901     },
10902     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10903     "version": "0.0.0",
10904     "filename": "server/api/faxApplication/index.js",
10905     "groupTitle": "Fax_Applications"
10906   },
10907   {
10908     "type": "delete",
10909     "url": "/api/fax/applications/{id}",
10910     "title": "Deletes a Application",
10911     "examples": [
10912       {
10913         "title": "Example usage:",
10914         "content": "curl https://{domain}/api/fax/applications/{id} -v -u {name}:{password} -X DELETE",
10915         "type": "json"
10916       }
10917     ],
10918     "name": "DeleteApplications",
10919     "group": "Fax_Applications",
10920     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10921     "version": "0.0.0",
10922     "filename": "server/api/faxApplication/index.js",
10923     "groupTitle": "Fax_Applications"
10924   },
10925   {
10926     "type": "get",
10927     "url": "/api/fax/applications",
10928     "title": "Gets a list of Applications",
10929     "examples": [
10930       {
10931         "title": "Example usage:",
10932         "content": "curl https://{domain}/api/fax/applications -v -u {name}:{password}",
10933         "type": "json"
10934       }
10935     ],
10936     "name": "GetApplications",
10937     "group": "Fax_Applications",
10938     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
10939     "version": "0.0.0",
10940     "filename": "server/api/faxApplication/index.js",
10941     "groupTitle": "Fax_Applications"
10942   },
10943   {
10944     "type": "get",
10945     "url": "/api/fax/applications/{id}",
10946     "title": "Gets a single Application",
10947     "examples": [
10948       {
10949         "title": "Example usage:",
10950         "content": "curl https://{domain}/api/fax/applications/{id} -v -u {name}:{password}",
10951         "type": "json"
10952       }
10953     ],
10954     "name": "ShowApplications",
10955     "group": "Fax_Applications",
10956     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10957     "version": "0.0.0",
10958     "filename": "server/api/faxApplication/index.js",
10959     "groupTitle": "Fax_Applications"
10960   },
10961   {
10962     "type": "put",
10963     "url": "/api/fax/applications/{id}",
10964     "title": "Update an existing Application",
10965     "examples": [
10966       {
10967         "title": "Example usage:",
10968         "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",
10969         "type": "json"
10970       }
10971     ],
10972     "name": "updateApplications",
10973     "group": "Fax_Applications",
10974     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10975     "version": "0.0.0",
10976     "filename": "server/api/faxApplication/index.js",
10977     "groupTitle": "Fax_Applications"
10978   },
10979   {
10980     "type": "post",
10981     "url": "/api/fax/interactions/{id}/tags",
10982     "title": "Add tags to the interaction",
10983     "examples": [
10984       {
10985         "title": "Example usage:",
10986         "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",
10987         "type": "json"
10988       }
10989     ],
10990     "name": "AddTags",
10991     "group": "Fax_Interactions",
10992     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10993     "version": "0.0.0",
10994     "filename": "server/api/faxInteraction/index.js",
10995     "groupTitle": "Fax_Interactions"
10996   },
10997   {
10998     "type": "post",
10999     "url": "/api/fax/interactions",
11000     "title": "Creates a new Interaction",
11001     "examples": [
11002       {
11003         "title": "Example usage:",
11004         "content": "curl https://{domain}/api/fax/interactions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
11005         "type": "json"
11006       }
11007     ],
11008     "name": "CreateInteractions",
11009     "group": "Fax_Interactions",
11010     "parameter": {
11011       "fields": {
11012         "Body": [
11013           {
11014             "group": "Body",
11015             "type": "Boolean",
11016             "optional": true,
11017             "field": "closed",
11018             "description": ""
11019           },
11020           {
11021             "group": "Body",
11022             "type": "String",
11023             "optional": true,
11024             "field": "closedAt",
11025             "description": ""
11026           },
11027           {
11028             "group": "Body",
11029             "type": "String",
11030             "optional": true,
11031             "field": "disposition",
11032             "description": ""
11033           },
11034           {
11035             "group": "Body",
11036             "type": "String",
11037             "optional": true,
11038             "field": "secondDisposition",
11039             "description": ""
11040           },
11041           {
11042             "group": "Body",
11043             "type": "String",
11044             "optional": true,
11045             "field": "thirdDisposition",
11046             "description": ""
11047           },
11048           {
11049             "group": "Body",
11050             "type": "String",
11051             "optional": true,
11052             "field": "note",
11053             "description": ""
11054           },
11055           {
11056             "group": "Body",
11057             "type": "String",
11058             "optional": true,
11059             "field": "read1stAt",
11060             "description": ""
11061           },
11062           {
11063             "group": "Body",
11064             "type": "String",
11065             "optional": true,
11066             "field": "fax",
11067             "description": ""
11068           },
11069           {
11070             "group": "Body",
11071             "type": "String",
11072             "allowedValues": [
11073               "\"in\"",
11074               "\"out\""
11075             ],
11076             "optional": false,
11077             "field": "firstMsgDirection",
11078             "description": ""
11079           },
11080           {
11081             "group": "Body",
11082             "type": "String",
11083             "optional": true,
11084             "field": "lastMsgAt",
11085             "description": ""
11086           },
11087           {
11088             "group": "Body",
11089             "type": "String",
11090             "allowedValues": [
11091               "\"in\"",
11092               "\"out\""
11093             ],
11094             "optional": false,
11095             "field": "lastMsgDirection",
11096             "description": ""
11097           }
11098         ]
11099       }
11100     },
11101     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11102     "version": "0.0.0",
11103     "filename": "server/api/faxInteraction/index.js",
11104     "groupTitle": "Fax_Interactions"
11105   },
11106   {
11107     "type": "delete",
11108     "url": "/api/fax/interactions/{id}",
11109     "title": "Deletes a Interaction",
11110     "examples": [
11111       {
11112         "title": "Example usage:",
11113         "content": "curl https://{domain}/api/fax/interactions/{id} -v -u {name}:{password} -X DELETE",
11114         "type": "json"
11115       }
11116     ],
11117     "name": "DeleteInteractions",
11118     "group": "Fax_Interactions",
11119     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11120     "version": "0.0.0",
11121     "filename": "server/api/faxInteraction/index.js",
11122     "groupTitle": "Fax_Interactions"
11123   },
11124   {
11125     "type": "get",
11126     "url": "/api/fax/interactions/describe",
11127     "title": "Gets table info about Interactions",
11128     "examples": [
11129       {
11130         "title": "Example usage:",
11131         "content": "curl https://{domain}/api/fax/interactions/describe -v -u {name}:{password}",
11132         "type": "json"
11133       }
11134     ],
11135     "name": "DescribeInteractions",
11136     "group": "Fax_Interactions",
11137     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11138     "version": "0.0.0",
11139     "filename": "server/api/faxInteraction/index.js",
11140     "groupTitle": "Fax_Interactions"
11141   },
11142   {
11143     "type": "get",
11144     "url": "/api/fax/interactions",
11145     "title": "Gets a list of Interactions",
11146     "examples": [
11147       {
11148         "title": "Example usage:",
11149         "content": "curl https://{domain}/api/fax/interactions -v -u {name}:{password}",
11150         "type": "json"
11151       }
11152     ],
11153     "name": "GetInteractions",
11154     "group": "Fax_Interactions",
11155     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
11156     "version": "0.0.0",
11157     "filename": "server/api/faxInteraction/index.js",
11158     "groupTitle": "Fax_Interactions"
11159   },
11160   {
11161     "type": "delete",
11162     "url": "/api/fax/interactions/{id}/tags",
11163     "title": "Removes tags from interaction",
11164     "examples": [
11165       {
11166         "title": "Example usage:",
11167         "content": "curl https://{domain}/api/fax/interactions/{id}/tags?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
11168         "type": "json"
11169       }
11170     ],
11171     "name": "RemoveTags",
11172     "group": "Fax_Interactions",
11173     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11174     "version": "0.0.0",
11175     "filename": "server/api/faxInteraction/index.js",
11176     "groupTitle": "Fax_Interactions"
11177   },
11178   {
11179     "type": "get",
11180     "url": "/api/fax/interactions/{id}",
11181     "title": "Gets a single Interaction",
11182     "examples": [
11183       {
11184         "title": "Example usage:",
11185         "content": "curl https://{domain}/api/fax/interactions/{id} -v -u {name}:{password}",
11186         "type": "json"
11187       }
11188     ],
11189     "name": "ShowInteractions",
11190     "group": "Fax_Interactions",
11191     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11192     "version": "0.0.0",
11193     "filename": "server/api/faxInteraction/index.js",
11194     "groupTitle": "Fax_Interactions"
11195   },
11196   {
11197     "type": "post",
11198     "url": "/api/fax/interactions/{id}/messages",
11199     "title": "Creates new messages",
11200     "examples": [
11201       {
11202         "title": "Example usage:",
11203         "content": "curl https://{domain}/api/fax/interactions/{id}/messages -d '[{\"to\": \"+3901119886500\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
11204         "type": "json"
11205       }
11206     ],
11207     "name": "addMessage",
11208     "group": "Fax_Interactions",
11209     "parameter": {
11210       "fields": {
11211         "Body": [
11212           {
11213             "group": "Body",
11214             "type": "Text",
11215             "optional": false,
11216             "field": "body",
11217             "description": ""
11218           },
11219           {
11220             "group": "Body",
11221             "type": "Boolean",
11222             "optional": true,
11223             "field": "read",
11224             "description": ""
11225           },
11226           {
11227             "group": "Body",
11228             "type": "String",
11229             "allowedValues": [
11230               "\"in\"",
11231               "\"out\""
11232             ],
11233             "optional": false,
11234             "field": "direction",
11235             "description": ""
11236           },
11237           {
11238             "group": "Body",
11239             "type": "Text",
11240             "optional": true,
11241             "field": "failMessage",
11242             "description": ""
11243           },
11244           {
11245             "group": "Body",
11246             "type": "String",
11247             "optional": true,
11248             "field": "readAt",
11249             "description": ""
11250           }
11251         ]
11252       }
11253     },
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/faxInteraction/index.js",
11257     "groupTitle": "Fax_Interactions"
11258   },
11259   {
11260     "type": "get",
11261     "url": "/api/fax/interactions/{id}/download",
11262     "title": "Get interactions",
11263     "examples": [
11264       {
11265         "title": "Example usage:",
11266         "content": "curl https://{domain}/api/fax/interactions/{id}/download -v -u {name}:{password} -X GET",
11267         "type": "json"
11268       }
11269     ],
11270     "name": "download",
11271     "group": "Fax_Interactions",
11272     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11273     "version": "0.0.0",
11274     "filename": "server/api/faxInteraction/index.js",
11275     "groupTitle": "Fax_Interactions"
11276   },
11277   {
11278     "type": "get",
11279     "url": "/api/fax/interactions/{id}/messages",
11280     "title": "Gets interaction messages",
11281     "examples": [
11282       {
11283         "title": "Example usage:",
11284         "content": "curl https://{domain}/api/fax/interactions/{id}/messages -v -u {name}:{password} -X GET",
11285         "type": "json"
11286       }
11287     ],
11288     "name": "getMessages",
11289     "group": "Fax_Interactions",
11290     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11291     "version": "0.0.0",
11292     "filename": "server/api/faxInteraction/index.js",
11293     "groupTitle": "Fax_Interactions"
11294   },
11295   {
11296     "type": "put",
11297     "url": "/api/fax/interactions/{id}",
11298     "title": "Update an existing Interaction",
11299     "examples": [
11300       {
11301         "title": "Example usage:",
11302         "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",
11303         "type": "json"
11304       }
11305     ],
11306     "name": "updateInteractions",
11307     "group": "Fax_Interactions",
11308     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11309     "version": "0.0.0",
11310     "filename": "server/api/faxInteraction/index.js",
11311     "groupTitle": "Fax_Interactions"
11312   },
11313   {
11314     "type": "get",
11315     "url": "/api/fax/messages/{id}/download",
11316     "title": "Get message",
11317     "examples": [
11318       {
11319         "title": "Example usage:",
11320         "content": "curl https://{domain}/api/fax/messages/{id}/download -v -u {name}:{password} -X GET",
11321         "type": "json"
11322       }
11323     ],
11324     "name": "download",
11325     "group": "Fax_Message",
11326     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11327     "version": "0.0.0",
11328     "filename": "server/api/faxMessage/index.js",
11329     "groupTitle": "Fax_Message"
11330   },
11331   {
11332     "type": "delete",
11333     "url": "/api/fax/messages/{id}",
11334     "title": "Deletes a Message",
11335     "examples": [
11336       {
11337         "title": "Example usage:",
11338         "content": "curl https://{domain}/api/fax/messages/{id} -v -u {name}:{password} -X DELETE",
11339         "type": "json"
11340       }
11341     ],
11342     "name": "DeleteMessages",
11343     "group": "Fax_Messages",
11344     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11345     "version": "0.0.0",
11346     "filename": "server/api/faxMessage/index.js",
11347     "groupTitle": "Fax_Messages"
11348   },
11349   {
11350     "type": "get",
11351     "url": "/api/fax/messages/describe",
11352     "title": "Gets table info about Messages",
11353     "examples": [
11354       {
11355         "title": "Example usage:",
11356         "content": "curl https://{domain}/api/fax/messages/describe -v -u {name}:{password}",
11357         "type": "json"
11358       }
11359     ],
11360     "name": "DescribeMessages",
11361     "group": "Fax_Messages",
11362     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11363     "version": "0.0.0",
11364     "filename": "server/api/faxMessage/index.js",
11365     "groupTitle": "Fax_Messages"
11366   },
11367   {
11368     "type": "get",
11369     "url": "/api/fax/messages",
11370     "title": "Gets a list of Messages",
11371     "examples": [
11372       {
11373         "title": "Example usage:",
11374         "content": "curl https://{domain}/api/fax/messages -v -u {name}:{password}",
11375         "type": "json"
11376       }
11377     ],
11378     "name": "GetMessages",
11379     "group": "Fax_Messages",
11380     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
11381     "version": "0.0.0",
11382     "filename": "server/api/faxMessage/index.js",
11383     "groupTitle": "Fax_Messages"
11384   },
11385   {
11386     "type": "get",
11387     "url": "/api/fax/messages/{id}",
11388     "title": "Gets a single Message",
11389     "examples": [
11390       {
11391         "title": "Example usage:",
11392         "content": "curl https://{domain}/api/fax/messages/{id} -v -u {name}:{password}",
11393         "type": "json"
11394       }
11395     ],
11396     "name": "ShowMessages",
11397     "group": "Fax_Messages",
11398     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11399     "version": "0.0.0",
11400     "filename": "server/api/faxMessage/index.js",
11401     "groupTitle": "Fax_Messages"
11402   },
11403   {
11404     "type": "put",
11405     "url": "/api/fax/messages/{id}/accept",
11406     "title": "Accepts message",
11407     "examples": [
11408       {
11409         "title": "Example usage:",
11410         "content": "curl https://{domain}/api/fax/messages/{id}/accept \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
11411         "type": "json"
11412       }
11413     ],
11414     "name": "acceptMessage",
11415     "group": "Fax_Messages",
11416     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11417     "version": "0.0.0",
11418     "filename": "server/api/faxMessage/index.js",
11419     "groupTitle": "Fax_Messages"
11420   },
11421   {
11422     "type": "post",
11423     "url": "/api/fax/messages",
11424     "title": "Create message and send Fax",
11425     "examples": [
11426       {
11427         "title": "Example usage:",
11428         "content": "curl https://{domain}/api/fax/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
11429         "type": "json"
11430       }
11431     ],
11432     "name": "rejectMessage",
11433     "group": "Fax_Messages",
11434     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11435     "version": "0.0.0",
11436     "filename": "server/api/faxMessage/index.js",
11437     "groupTitle": "Fax_Messages"
11438   },
11439   {
11440     "type": "put",
11441     "url": "/api/fax/messages/{id}/reject",
11442     "title": "Rejects message",
11443     "examples": [
11444       {
11445         "title": "Example usage:",
11446         "content": "curl https://{domain}/api/fax/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
11447         "type": "json"
11448       }
11449     ],
11450     "name": "rejectMessage",
11451     "group": "Fax_Messages",
11452     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11453     "version": "0.0.0",
11454     "filename": "server/api/faxMessage/index.js",
11455     "groupTitle": "Fax_Messages"
11456   },
11457   {
11458     "type": "put",
11459     "url": "/api/fax/messages/{id}",
11460     "title": "Update an existing Message",
11461     "examples": [
11462       {
11463         "title": "Example usage:",
11464         "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",
11465         "type": "json"
11466       }
11467     ],
11468     "name": "updateMessages",
11469     "group": "Fax_Messages",
11470     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11471     "version": "0.0.0",
11472     "filename": "server/api/faxMessage/index.js",
11473     "groupTitle": "Fax_Messages"
11474   },
11475   {
11476     "type": "post",
11477     "url": "/api/fax/reports/queue",
11478     "title": "Creates a new Fax Queue Report",
11479     "examples": [
11480       {
11481         "title": "Example usage:",
11482         "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",
11483         "type": "json"
11484       }
11485     ],
11486     "name": "CreateFax_Queue_Reports",
11487     "group": "Fax_Queue_Reports",
11488     "parameter": {
11489       "fields": {
11490         "Body": [
11491           {
11492             "group": "Body",
11493             "type": "String",
11494             "optional": false,
11495             "field": "uniqueid",
11496             "description": ""
11497           },
11498           {
11499             "group": "Body",
11500             "type": "String",
11501             "optional": true,
11502             "field": "from",
11503             "description": ""
11504           },
11505           {
11506             "group": "Body",
11507             "type": "String",
11508             "optional": true,
11509             "field": "joinAt",
11510             "description": ""
11511           },
11512           {
11513             "group": "Body",
11514             "type": "String",
11515             "optional": true,
11516             "field": "leaveAt",
11517             "description": ""
11518           },
11519           {
11520             "group": "Body",
11521             "type": "String",
11522             "optional": true,
11523             "field": "acceptAt",
11524             "description": ""
11525           },
11526           {
11527             "group": "Body",
11528             "type": "String",
11529             "optional": true,
11530             "field": "exitAt",
11531             "description": ""
11532           },
11533           {
11534             "group": "Body",
11535             "type": "String",
11536             "optional": true,
11537             "field": "reason",
11538             "description": ""
11539           }
11540         ]
11541       }
11542     },
11543     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11544     "version": "0.0.0",
11545     "filename": "server/api/faxQueueReport/index.js",
11546     "groupTitle": "Fax_Queue_Reports"
11547   },
11548   {
11549     "type": "delete",
11550     "url": "/api/fax/reports/queue/{id}",
11551     "title": "Deletes a Fax Queue Report",
11552     "examples": [
11553       {
11554         "title": "Example usage:",
11555         "content": "curl https://{domain}/api/fax/reports/queue/{id} -v -u {name}:{password} -X DELETE",
11556         "type": "json"
11557       }
11558     ],
11559     "name": "DeleteFax_Queue_Reports",
11560     "group": "Fax_Queue_Reports",
11561     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11562     "version": "0.0.0",
11563     "filename": "server/api/faxQueueReport/index.js",
11564     "groupTitle": "Fax_Queue_Reports"
11565   },
11566   {
11567     "type": "get",
11568     "url": "/api/fax/reports/queue/describe",
11569     "title": "Gets table info about Fax Queue Reports",
11570     "examples": [
11571       {
11572         "title": "Example usage:",
11573         "content": "curl https://{domain}/api/fax/reports/queue/describe -v -u {name}:{password}",
11574         "type": "json"
11575       }
11576     ],
11577     "name": "DescribeFax_Queue_Reports",
11578     "group": "Fax_Queue_Reports",
11579     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11580     "version": "0.0.0",
11581     "filename": "server/api/faxQueueReport/index.js",
11582     "groupTitle": "Fax_Queue_Reports"
11583   },
11584   {
11585     "type": "get",
11586     "url": "/api/fax/reports/queue",
11587     "title": "Gets a list of Fax Queue Reports",
11588     "examples": [
11589       {
11590         "title": "Example usage:",
11591         "content": "curl https://{domain}/api/fax/reports/queue -v -u {name}:{password}",
11592         "type": "json"
11593       }
11594     ],
11595     "name": "GetFax_Queue_Reports",
11596     "group": "Fax_Queue_Reports",
11597     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
11598     "version": "0.0.0",
11599     "filename": "server/api/faxQueueReport/index.js",
11600     "groupTitle": "Fax_Queue_Reports"
11601   },
11602   {
11603     "type": "get",
11604     "url": "/api/fax/reports/queue/{id}",
11605     "title": "Gets a single Fax Queue Report",
11606     "examples": [
11607       {
11608         "title": "Example usage:",
11609         "content": "curl https://{domain}/api/fax/reports/queue/{id} -v -u {name}:{password}",
11610         "type": "json"
11611       }
11612     ],
11613     "name": "ShowFax_Queue_Reports",
11614     "group": "Fax_Queue_Reports",
11615     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11616     "version": "0.0.0",
11617     "filename": "server/api/faxQueueReport/index.js",
11618     "groupTitle": "Fax_Queue_Reports"
11619   },
11620   {
11621     "type": "put",
11622     "url": "/api/fax/reports/queue/{id}",
11623     "title": "Update an existing Fax Queue Report",
11624     "examples": [
11625       {
11626         "title": "Example usage:",
11627         "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",
11628         "type": "json"
11629       }
11630     ],
11631     "name": "updateFax_Queue_Reports",
11632     "group": "Fax_Queue_Reports",
11633     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11634     "version": "0.0.0",
11635     "filename": "server/api/faxQueueReport/index.js",
11636     "groupTitle": "Fax_Queue_Reports"
11637   },
11638   {
11639     "type": "post",
11640     "url": "/api/fax/queues/{id}/users",
11641     "title": "Add agents to a queue",
11642     "examples": [
11643       {
11644         "title": "Example usage:",
11645         "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",
11646         "type": "json"
11647       }
11648     ],
11649     "name": "AddAgents",
11650     "group": "Fax_Queues",
11651     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11652     "version": "0.0.0",
11653     "filename": "server/api/faxQueue/index.js",
11654     "groupTitle": "Fax_Queues"
11655   },
11656   {
11657     "type": "post",
11658     "url": "/api/fax/queues/{id}/teams",
11659     "title": "Add teams to a queue",
11660     "examples": [
11661       {
11662         "title": "Example usage:",
11663         "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",
11664         "type": "json"
11665       }
11666     ],
11667     "name": "AddTeams",
11668     "group": "Fax_Queues",
11669     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11670     "version": "0.0.0",
11671     "filename": "server/api/faxQueue/index.js",
11672     "groupTitle": "Fax_Queues"
11673   },
11674   {
11675     "type": "post",
11676     "url": "/api/fax/queues",
11677     "title": "Creates a new Queue",
11678     "examples": [
11679       {
11680         "title": "Example usage:",
11681         "content": "curl https://{domain}/api/fax/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
11682         "type": "json"
11683       }
11684     ],
11685     "name": "CreateQueues",
11686     "group": "Fax_Queues",
11687     "parameter": {
11688       "fields": {
11689         "Body": [
11690           {
11691             "group": "Body",
11692             "type": "String",
11693             "optional": false,
11694             "field": "name",
11695             "description": ""
11696           },
11697           {
11698             "group": "Body",
11699             "type": "String",
11700             "optional": true,
11701             "field": "description",
11702             "description": ""
11703           },
11704           {
11705             "group": "Body",
11706             "type": "Integer",
11707             "optional": false,
11708             "field": "timeout",
11709             "description": ""
11710           },
11711           {
11712             "group": "Body",
11713             "type": "String",
11714             "allowedValues": [
11715               "\"rrmemory\"",
11716               "\"beepall\"",
11717               "\"roundrobin\""
11718             ],
11719             "optional": false,
11720             "field": "strategy",
11721             "description": ""
11722           },
11723           {
11724             "group": "Body",
11725             "type": "Integer",
11726             "optional": true,
11727             "field": "lastAgent",
11728             "description": ""
11729           }
11730         ]
11731       }
11732     },
11733     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11734     "version": "0.0.0",
11735     "filename": "server/api/faxQueue/index.js",
11736     "groupTitle": "Fax_Queues"
11737   },
11738   {
11739     "type": "delete",
11740     "url": "/api/fax/queues/{id}",
11741     "title": "Deletes a Queue",
11742     "examples": [
11743       {
11744         "title": "Example usage:",
11745         "content": "curl https://{domain}/api/fax/queues/{id} -v -u {name}:{password} -X DELETE",
11746         "type": "json"
11747       }
11748     ],
11749     "name": "DeleteQueues",
11750     "group": "Fax_Queues",
11751     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11752     "version": "0.0.0",
11753     "filename": "server/api/faxQueue/index.js",
11754     "groupTitle": "Fax_Queues"
11755   },
11756   {
11757     "type": "get",
11758     "url": "/api/fax/queues/describe",
11759     "title": "Gets table info about Queues",
11760     "examples": [
11761       {
11762         "title": "Example usage:",
11763         "content": "curl https://{domain}/api/fax/queues/describe -v -u {name}:{password}",
11764         "type": "json"
11765       }
11766     ],
11767     "name": "DescribeQueues",
11768     "group": "Fax_Queues",
11769     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11770     "version": "0.0.0",
11771     "filename": "server/api/faxQueue/index.js",
11772     "groupTitle": "Fax_Queues"
11773   },
11774   {
11775     "type": "get",
11776     "url": "/api/fax/queues/{id}/users",
11777     "title": "Gets queue agents",
11778     "examples": [
11779       {
11780         "title": "Example usage:",
11781         "content": "curl https://{domain}/api/fax/queues/{id}/users -v -u {name}:{password} -X POST",
11782         "type": "json"
11783       }
11784     ],
11785     "name": "GetAgents",
11786     "group": "Fax_Queues",
11787     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11788     "version": "0.0.0",
11789     "filename": "server/api/faxQueue/index.js",
11790     "groupTitle": "Fax_Queues"
11791   },
11792   {
11793     "type": "get",
11794     "url": "/api/fax/queues/{id}/members",
11795     "title": "GetMembers",
11796     "examples": [
11797       {
11798         "title": "Example usage:",
11799         "content": "curl https://{domain}/api/fax/queues/{id}/members  -v -u {name}:{password}",
11800         "type": "json"
11801       }
11802     ],
11803     "name": "GetMembers",
11804     "group": "Fax_Queues",
11805     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11806     "version": "0.0.0",
11807     "filename": "server/api/faxQueue/index.js",
11808     "groupTitle": "Fax_Queues"
11809   },
11810   {
11811     "type": "get",
11812     "url": "/api/fax/queues",
11813     "title": "Gets a list of Queues",
11814     "examples": [
11815       {
11816         "title": "Example usage:",
11817         "content": "curl https://{domain}/api/fax/queues -v -u {name}:{password}",
11818         "type": "json"
11819       }
11820     ],
11821     "name": "GetQueues",
11822     "group": "Fax_Queues",
11823     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
11824     "version": "0.0.0",
11825     "filename": "server/api/faxQueue/index.js",
11826     "groupTitle": "Fax_Queues"
11827   },
11828   {
11829     "type": "get",
11830     "url": "/api/fax/queues/{id}/teams",
11831     "title": "Gets queues list",
11832     "examples": [
11833       {
11834         "title": "Example usage:",
11835         "content": "curl https://{domain}/api/fax/queues/{id}/teams -v -u {name}:{password}",
11836         "type": "json"
11837       }
11838     ],
11839     "name": "GetTeams",
11840     "group": "Fax_Queues",
11841     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11842     "version": "0.0.0",
11843     "filename": "server/api/faxQueue/index.js",
11844     "groupTitle": "Fax_Queues"
11845   },
11846   {
11847     "type": "delete",
11848     "url": "/api/fax/queues/{id}/users",
11849     "title": "Removes agents from a queue",
11850     "examples": [
11851       {
11852         "title": "Example usage:",
11853         "content": "curl https://{domain}/api/fax/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
11854         "type": "json"
11855       }
11856     ],
11857     "name": "RemoveAgents",
11858     "group": "Fax_Queues",
11859     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11860     "version": "0.0.0",
11861     "filename": "server/api/faxQueue/index.js",
11862     "groupTitle": "Fax_Queues"
11863   },
11864   {
11865     "type": "get",
11866     "url": "/api/fax/queues/{id}",
11867     "title": "Gets a single Queue",
11868     "examples": [
11869       {
11870         "title": "Example usage:",
11871         "content": "curl https://{domain}/api/fax/queues/{id} -v -u {name}:{password}",
11872         "type": "json"
11873       }
11874     ],
11875     "name": "ShowQueues",
11876     "group": "Fax_Queues",
11877     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11878     "version": "0.0.0",
11879     "filename": "server/api/faxQueue/index.js",
11880     "groupTitle": "Fax_Queues"
11881   },
11882   {
11883     "type": "put",
11884     "url": "/api/fax/queues/{id}",
11885     "title": "Update an existing Queue",
11886     "examples": [
11887       {
11888         "title": "Example usage:",
11889         "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",
11890         "type": "json"
11891       }
11892     ],
11893     "name": "updateQueues",
11894     "group": "Fax_Queues",
11895     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11896     "version": "0.0.0",
11897     "filename": "server/api/faxQueue/index.js",
11898     "groupTitle": "Fax_Queues"
11899   },
11900   {
11901     "type": "post",
11902     "url": "/api/fax/reports/transfer",
11903     "title": "Creates a new Fax Transfer Report",
11904     "examples": [
11905       {
11906         "title": "Example usage:",
11907         "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",
11908         "type": "json"
11909       }
11910     ],
11911     "name": "CreateFax_Transfer_Reports",
11912     "group": "Fax_Transfer_Reports",
11913     "parameter": {
11914       "fields": {
11915         "Body": [
11916           {
11917             "group": "Body",
11918             "type": "String",
11919             "optional": false,
11920             "field": "uniqueid",
11921             "description": ""
11922           },
11923           {
11924             "group": "Body",
11925             "type": "String",
11926             "allowedValues": [
11927               "\"account\"",
11928               "\"agent\"",
11929               "\"queue\""
11930             ],
11931             "optional": false,
11932             "field": "type",
11933             "description": ""
11934           },
11935           {
11936             "group": "Body",
11937             "type": "String",
11938             "optional": false,
11939             "field": "transferredAt",
11940             "description": ""
11941           }
11942         ]
11943       }
11944     },
11945     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11946     "version": "0.0.0",
11947     "filename": "server/api/faxTransferReport/index.js",
11948     "groupTitle": "Fax_Transfer_Reports"
11949   },
11950   {
11951     "type": "delete",
11952     "url": "/api/fax/reports/transfer/{id}",
11953     "title": "Deletes a Fax Transfer Report",
11954     "examples": [
11955       {
11956         "title": "Example usage:",
11957         "content": "curl https://{domain}/api/fax/reports/transfer/{id} -v -u {name}:{password} -X DELETE",
11958         "type": "json"
11959       }
11960     ],
11961     "name": "DeleteFax_Transfer_Reports",
11962     "group": "Fax_Transfer_Reports",
11963     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11964     "version": "0.0.0",
11965     "filename": "server/api/faxTransferReport/index.js",
11966     "groupTitle": "Fax_Transfer_Reports"
11967   },
11968   {
11969     "type": "get",
11970     "url": "/api/fax/reports/transfer/describe",
11971     "title": "Gets table info about Fax Transfer Reports",
11972     "examples": [
11973       {
11974         "title": "Example usage:",
11975         "content": "curl https://{domain}/api/fax/reports/transfer/describe -v -u {name}:{password}",
11976         "type": "json"
11977       }
11978     ],
11979     "name": "DescribeFax_Transfer_Reports",
11980     "group": "Fax_Transfer_Reports",
11981     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11982     "version": "0.0.0",
11983     "filename": "server/api/faxTransferReport/index.js",
11984     "groupTitle": "Fax_Transfer_Reports"
11985   },
11986   {
11987     "type": "get",
11988     "url": "/api/fax/reports/transfer",
11989     "title": "Gets a list of Fax Transfer Reports",
11990     "examples": [
11991       {
11992         "title": "Example usage:",
11993         "content": "curl https://{domain}/api/fax/reports/transfer -v -u {name}:{password}",
11994         "type": "json"
11995       }
11996     ],
11997     "name": "GetFax_Transfer_Reports",
11998     "group": "Fax_Transfer_Reports",
11999     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
12000     "version": "0.0.0",
12001     "filename": "server/api/faxTransferReport/index.js",
12002     "groupTitle": "Fax_Transfer_Reports"
12003   },
12004   {
12005     "type": "get",
12006     "url": "/api/fax/reports/transfer/{id}",
12007     "title": "Gets a single Fax Transfer Report",
12008     "examples": [
12009       {
12010         "title": "Example usage:",
12011         "content": "curl https://{domain}/api/fax/reports/transfer/{id} -v -u {name}:{password}",
12012         "type": "json"
12013       }
12014     ],
12015     "name": "ShowFax_Transfer_Reports",
12016     "group": "Fax_Transfer_Reports",
12017     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12018     "version": "0.0.0",
12019     "filename": "server/api/faxTransferReport/index.js",
12020     "groupTitle": "Fax_Transfer_Reports"
12021   },
12022   {
12023     "type": "put",
12024     "url": "/api/fax/reports/transfer/{id}",
12025     "title": "Update an existing Fax Transfer Report",
12026     "examples": [
12027       {
12028         "title": "Example usage:",
12029         "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",
12030         "type": "json"
12031       }
12032     ],
12033     "name": "updateFax_Transfer_Reports",
12034     "group": "Fax_Transfer_Reports",
12035     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12036     "version": "0.0.0",
12037     "filename": "server/api/faxTransferReport/index.js",
12038     "groupTitle": "Fax_Transfer_Reports"
12039   },
12040   {
12041     "type": "post",
12042     "url": "/api/integrations/freshdesk/accounts",
12043     "title": "Creates a new Freshdesk Account",
12044     "examples": [
12045       {
12046         "title": "Example usage:",
12047         "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",
12048         "type": "json"
12049       }
12050     ],
12051     "name": "CreateFreshdesk_Accounts",
12052     "group": "Freshdesk_Accounts",
12053     "parameter": {
12054       "fields": {
12055         "Body": [
12056           {
12057             "group": "Body",
12058             "type": "String",
12059             "optional": true,
12060             "field": "name",
12061             "description": ""
12062           },
12063           {
12064             "group": "Body",
12065             "type": "String",
12066             "optional": true,
12067             "field": "description",
12068             "description": ""
12069           },
12070           {
12071             "group": "Body",
12072             "type": "String",
12073             "optional": true,
12074             "field": "username",
12075             "description": ""
12076           },
12077           {
12078             "group": "Body",
12079             "type": "String",
12080             "optional": true,
12081             "field": "apiKey",
12082             "description": ""
12083           },
12084           {
12085             "group": "Body",
12086             "type": "String",
12087             "optional": true,
12088             "field": "remoteUri",
12089             "description": ""
12090           },
12091           {
12092             "group": "Body",
12093             "type": "String",
12094             "optional": false,
12095             "field": "serverUrl",
12096             "description": ""
12097           }
12098         ]
12099       }
12100     },
12101     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12102     "version": "0.0.0",
12103     "filename": "server/api/intFreshdeskAccount/index.js",
12104     "groupTitle": "Freshdesk_Accounts"
12105   },
12106   {
12107     "type": "delete",
12108     "url": "/api/integrations/freshdesk/accounts/{id}",
12109     "title": "Deletes a Freshdesk Account",
12110     "examples": [
12111       {
12112         "title": "Example usage:",
12113         "content": "curl https://{domain}/api/integrations/freshdesk/accounts/{id} -v -u {name}:{password} -X DELETE",
12114         "type": "json"
12115       }
12116     ],
12117     "name": "DeleteFreshdesk_Accounts",
12118     "group": "Freshdesk_Accounts",
12119     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12120     "version": "0.0.0",
12121     "filename": "server/api/intFreshdeskAccount/index.js",
12122     "groupTitle": "Freshdesk_Accounts"
12123   },
12124   {
12125     "type": "get",
12126     "url": "/api/integrations/freshdesk/accounts",
12127     "title": "Gets a list of Freshdesk Accounts",
12128     "examples": [
12129       {
12130         "title": "Example usage:",
12131         "content": "curl https://{domain}/api/integrations/freshdesk/accounts -v -u {name}:{password}",
12132         "type": "json"
12133       }
12134     ],
12135     "name": "GetFreshdesk_Accounts",
12136     "group": "Freshdesk_Accounts",
12137     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
12138     "version": "0.0.0",
12139     "filename": "server/api/intFreshdeskAccount/index.js",
12140     "groupTitle": "Freshdesk_Accounts"
12141   },
12142   {
12143     "type": "get",
12144     "url": "/api/integrations/freshdesk/accounts/{id}",
12145     "title": "Gets a single Freshdesk Account",
12146     "examples": [
12147       {
12148         "title": "Example usage:",
12149         "content": "curl https://{domain}/api/integrations/freshdesk/accounts/{id} -v -u {name}:{password}",
12150         "type": "json"
12151       }
12152     ],
12153     "name": "ShowFreshdesk_Accounts",
12154     "group": "Freshdesk_Accounts",
12155     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12156     "version": "0.0.0",
12157     "filename": "server/api/intFreshdeskAccount/index.js",
12158     "groupTitle": "Freshdesk_Accounts"
12159   },
12160   {
12161     "type": "post",
12162     "url": "/api/integrations/freshdesk/accounts/{id}/configurations",
12163     "title": "Creates new configuration",
12164     "examples": [
12165       {
12166         "title": "Example usage:",
12167         "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",
12168         "type": "json"
12169       }
12170     ],
12171     "name": "addConfiguration",
12172     "group": "Freshdesk_Accounts",
12173     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12174     "version": "0.0.0",
12175     "filename": "server/api/intFreshdeskAccount/index.js",
12176     "groupTitle": "Freshdesk_Accounts"
12177   },
12178   {
12179     "type": "get",
12180     "url": "/api/integrations/freshdesk/accounts/{id}/configurations",
12181     "title": "Gets account configurations",
12182     "examples": [
12183       {
12184         "title": "Example usage:",
12185         "content": "curl https://{domain}/api/integrations/freshdesk/accounts/{id}/configurations -v -u {name}:{password} -X GET",
12186         "type": "json"
12187       }
12188     ],
12189     "name": "getConfigurations",
12190     "group": "Freshdesk_Accounts",
12191     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12192     "version": "0.0.0",
12193     "filename": "server/api/intFreshdeskAccount/index.js",
12194     "groupTitle": "Freshdesk_Accounts"
12195   },
12196   {
12197     "type": "get",
12198     "url": "/api/integrations/freshdesk/accounts/{id}/fields",
12199     "title": "Gets account fields",
12200     "examples": [
12201       {
12202         "title": "Example usage:",
12203         "content": "curl https://{domain}/api/integrations/freshdesk/accounts/{id}/fields -v -u {name}:{password} -X GET",
12204         "type": "json"
12205       }
12206     ],
12207     "name": "getFields",
12208     "group": "Freshdesk_Accounts",
12209     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12210     "version": "0.0.0",
12211     "filename": "server/api/intFreshdeskAccount/index.js",
12212     "groupTitle": "Freshdesk_Accounts"
12213   },
12214   {
12215     "type": "put",
12216     "url": "/api/integrations/freshdesk/accounts/{id}",
12217     "title": "Update an existing Freshdesk Account",
12218     "examples": [
12219       {
12220         "title": "Example usage:",
12221         "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",
12222         "type": "json"
12223       }
12224     ],
12225     "name": "updateFreshdesk_Accounts",
12226     "group": "Freshdesk_Accounts",
12227     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12228     "version": "0.0.0",
12229     "filename": "server/api/intFreshdeskAccount/index.js",
12230     "groupTitle": "Freshdesk_Accounts"
12231   },
12232   {
12233     "type": "post",
12234     "url": "/api/integrations/freshdesk/configurations",
12235     "title": "Creates a new Freshdesk Configuration",
12236     "examples": [
12237       {
12238         "title": "Example usage:",
12239         "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",
12240         "type": "json"
12241       }
12242     ],
12243     "name": "CreateFreshdesk_Configurations",
12244     "group": "Freshdesk_Configurations",
12245     "parameter": {
12246       "fields": {
12247         "Body": [
12248           {
12249             "group": "Body",
12250             "type": "String",
12251             "optional": true,
12252             "field": "name",
12253             "description": ""
12254           },
12255           {
12256             "group": "Body",
12257             "type": "String",
12258             "optional": true,
12259             "field": "description",
12260             "description": ""
12261           }
12262         ]
12263       }
12264     },
12265     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12266     "version": "0.0.0",
12267     "filename": "server/api/intFreshdeskConfiguration/index.js",
12268     "groupTitle": "Freshdesk_Configurations"
12269   },
12270   {
12271     "type": "delete",
12272     "url": "/api/integrations/freshdesk/configurations/{id}",
12273     "title": "Deletes a Freshdesk Configuration",
12274     "examples": [
12275       {
12276         "title": "Example usage:",
12277         "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id} -v -u {name}:{password} -X DELETE",
12278         "type": "json"
12279       }
12280     ],
12281     "name": "DeleteFreshdesk_Configurations",
12282     "group": "Freshdesk_Configurations",
12283     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12284     "version": "0.0.0",
12285     "filename": "server/api/intFreshdeskConfiguration/index.js",
12286     "groupTitle": "Freshdesk_Configurations"
12287   },
12288   {
12289     "type": "get",
12290     "url": "/api/integrations/freshdesk/configurations",
12291     "title": "Gets a list of Freshdesk Configurations",
12292     "examples": [
12293       {
12294         "title": "Example usage:",
12295         "content": "curl https://{domain}/api/integrations/freshdesk/configurations -v -u {name}:{password}",
12296         "type": "json"
12297       }
12298     ],
12299     "name": "GetFreshdesk_Configurations",
12300     "group": "Freshdesk_Configurations",
12301     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
12302     "version": "0.0.0",
12303     "filename": "server/api/intFreshdeskConfiguration/index.js",
12304     "groupTitle": "Freshdesk_Configurations"
12305   },
12306   {
12307     "type": "get",
12308     "url": "/api/integrations/freshdesk/configurations/{id}",
12309     "title": "Gets a single Freshdesk Configuration",
12310     "examples": [
12311       {
12312         "title": "Example usage:",
12313         "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id} -v -u {name}:{password}",
12314         "type": "json"
12315       }
12316     ],
12317     "name": "ShowFreshdesk_Configurations",
12318     "group": "Freshdesk_Configurations",
12319     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12320     "version": "0.0.0",
12321     "filename": "server/api/intFreshdeskConfiguration/index.js",
12322     "groupTitle": "Freshdesk_Configurations"
12323   },
12324   {
12325     "type": "get",
12326     "url": "/api/integrations/freshdesk/configurations/{id}/descriptions",
12327     "title": "Gets configurations descriptions",
12328     "examples": [
12329       {
12330         "title": "Example usage:",
12331         "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
12332         "type": "json"
12333       }
12334     ],
12335     "name": "getDescriptions",
12336     "group": "Freshdesk_Configurations",
12337     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12338     "version": "0.0.0",
12339     "filename": "server/api/intFreshdeskConfiguration/index.js",
12340     "groupTitle": "Freshdesk_Configurations"
12341   },
12342   {
12343     "type": "get",
12344     "url": "/api/integrations/freshdesk/configurations/{id}/fields",
12345     "title": "Gets configurations fields",
12346     "examples": [
12347       {
12348         "title": "Example usage:",
12349         "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id}/fields -v -u {name}:{password} -X GET",
12350         "type": "json"
12351       }
12352     ],
12353     "name": "getFields",
12354     "group": "Freshdesk_Configurations",
12355     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12356     "version": "0.0.0",
12357     "filename": "server/api/intFreshdeskConfiguration/index.js",
12358     "groupTitle": "Freshdesk_Configurations"
12359   },
12360   {
12361     "type": "get",
12362     "url": "/api/integrations/freshdesk/configurations/{id}/subjects",
12363     "title": "Gets configurations subjects",
12364     "examples": [
12365       {
12366         "title": "Example usage:",
12367         "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id}/subjects -v -u {name}:{password} -X GET",
12368         "type": "json"
12369       }
12370     ],
12371     "name": "getSubjects",
12372     "group": "Freshdesk_Configurations",
12373     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12374     "version": "0.0.0",
12375     "filename": "server/api/intFreshdeskConfiguration/index.js",
12376     "groupTitle": "Freshdesk_Configurations"
12377   },
12378   {
12379     "type": "get",
12380     "url": "/api/integrations/freshdesk/configurations/{id}/tags",
12381     "title": "Gets configurations tags",
12382     "examples": [
12383       {
12384         "title": "Example usage:",
12385         "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id}/tags -v -u {name}:{password} -X GET",
12386         "type": "json"
12387       }
12388     ],
12389     "name": "getTags",
12390     "group": "Freshdesk_Configurations",
12391     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12392     "version": "0.0.0",
12393     "filename": "server/api/intFreshdeskConfiguration/index.js",
12394     "groupTitle": "Freshdesk_Configurations"
12395   },
12396   {
12397     "type": "post",
12398     "url": "/api/integrations/freshdesk/configurations/{id}/tags",
12399     "title": "Sets new tags",
12400     "examples": [
12401       {
12402         "title": "Example usage:",
12403         "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",
12404         "type": "json"
12405       }
12406     ],
12407     "name": "setTags",
12408     "group": "Freshdesk_Configurations",
12409     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12410     "version": "0.0.0",
12411     "filename": "server/api/intFreshdeskConfiguration/index.js",
12412     "groupTitle": "Freshdesk_Configurations"
12413   },
12414   {
12415     "type": "put",
12416     "url": "/api/integrations/freshdesk/configurations/{id}",
12417     "title": "Update an existing Freshdesk Configuration",
12418     "examples": [
12419       {
12420         "title": "Example usage:",
12421         "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",
12422         "type": "json"
12423       }
12424     ],
12425     "name": "updateFreshdesk_Configurations",
12426     "group": "Freshdesk_Configurations",
12427     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12428     "version": "0.0.0",
12429     "filename": "server/api/intFreshdeskConfiguration/index.js",
12430     "groupTitle": "Freshdesk_Configurations"
12431   },
12432   {
12433     "type": "post",
12434     "url": "/api/integrations/freshdesk/fields",
12435     "title": "Creates a new Freshdesk Field",
12436     "examples": [
12437       {
12438         "title": "Example usage:",
12439         "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",
12440         "type": "json"
12441       }
12442     ],
12443     "name": "CreateFreshdesk_Fields",
12444     "group": "Freshdesk_Fields",
12445     "parameter": {
12446       "fields": {
12447         "Body": [
12448           {
12449             "group": "Body",
12450             "type": "String",
12451             "allowedValues": [
12452               "\"string\"",
12453               "\"variable\"",
12454               "\"customVariable\"",
12455               "\"keyValue\"",
12456               "\"picklist\""
12457             ],
12458             "optional": true,
12459             "field": "type",
12460             "description": ""
12461           },
12462           {
12463             "group": "Body",
12464             "type": "String",
12465             "optional": true,
12466             "field": "content",
12467             "description": ""
12468           },
12469           {
12470             "group": "Body",
12471             "type": "String",
12472             "optional": true,
12473             "field": "key",
12474             "description": ""
12475           },
12476           {
12477             "group": "Body",
12478             "type": "String",
12479             "allowedValues": [
12480               "\"string\"",
12481               "\"variable\"",
12482               "\"customVariable\""
12483             ],
12484             "optional": true,
12485             "field": "keyType",
12486             "description": ""
12487           },
12488           {
12489             "group": "Body",
12490             "type": "String",
12491             "optional": true,
12492             "field": "keyContent",
12493             "description": ""
12494           },
12495           {
12496             "group": "Body",
12497             "type": "String",
12498             "optional": true,
12499             "field": "idField",
12500             "description": ""
12501           },
12502           {
12503             "group": "Body",
12504             "type": "String",
12505             "optional": true,
12506             "field": "nameField",
12507             "description": ""
12508           },
12509           {
12510             "group": "Body",
12511             "type": "Boolean",
12512             "optional": true,
12513             "field": "customField",
12514             "description": ""
12515           },
12516           {
12517             "group": "Body",
12518             "type": "String",
12519             "optional": true,
12520             "field": "variableName",
12521             "description": ""
12522           }
12523         ]
12524       }
12525     },
12526     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12527     "version": "0.0.0",
12528     "filename": "server/api/intFreshdeskField/index.js",
12529     "groupTitle": "Freshdesk_Fields"
12530   },
12531   {
12532     "type": "delete",
12533     "url": "/api/integrations/freshdesk/fields/{id}",
12534     "title": "Deletes a Freshdesk Field",
12535     "examples": [
12536       {
12537         "title": "Example usage:",
12538         "content": "curl https://{domain}/api/integrations/freshdesk/fields/{id} -v -u {name}:{password} -X DELETE",
12539         "type": "json"
12540       }
12541     ],
12542     "name": "DeleteFreshdesk_Fields",
12543     "group": "Freshdesk_Fields",
12544     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12545     "version": "0.0.0",
12546     "filename": "server/api/intFreshdeskField/index.js",
12547     "groupTitle": "Freshdesk_Fields"
12548   },
12549   {
12550     "type": "get",
12551     "url": "/api/integrations/freshdesk/fields",
12552     "title": "Gets a list of Freshdesk Fields",
12553     "examples": [
12554       {
12555         "title": "Example usage:",
12556         "content": "curl https://{domain}/api/integrations/freshdesk/fields -v -u {name}:{password}",
12557         "type": "json"
12558       }
12559     ],
12560     "name": "GetFreshdesk_Fields",
12561     "group": "Freshdesk_Fields",
12562     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
12563     "version": "0.0.0",
12564     "filename": "server/api/intFreshdeskField/index.js",
12565     "groupTitle": "Freshdesk_Fields"
12566   },
12567   {
12568     "type": "get",
12569     "url": "/api/integrations/freshdesk/fields/{id}",
12570     "title": "Gets a single Freshdesk Field",
12571     "examples": [
12572       {
12573         "title": "Example usage:",
12574         "content": "curl https://{domain}/api/integrations/freshdesk/fields/{id} -v -u {name}:{password}",
12575         "type": "json"
12576       }
12577     ],
12578     "name": "ShowFreshdesk_Fields",
12579     "group": "Freshdesk_Fields",
12580     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12581     "version": "0.0.0",
12582     "filename": "server/api/intFreshdeskField/index.js",
12583     "groupTitle": "Freshdesk_Fields"
12584   },
12585   {
12586     "type": "put",
12587     "url": "/api/integrations/freshdesk/fields/{id}",
12588     "title": "Update an existing Freshdesk Field",
12589     "examples": [
12590       {
12591         "title": "Example usage:",
12592         "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",
12593         "type": "json"
12594       }
12595     ],
12596     "name": "updateFreshdesk_Fields",
12597     "group": "Freshdesk_Fields",
12598     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12599     "version": "0.0.0",
12600     "filename": "server/api/intFreshdeskField/index.js",
12601     "groupTitle": "Freshdesk_Fields"
12602   },
12603   {
12604     "type": "post",
12605     "url": "/api/integrations/freshsales/accounts",
12606     "title": "Creates a new Freshsales Account",
12607     "examples": [
12608       {
12609         "title": "Example usage:",
12610         "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",
12611         "type": "json"
12612       }
12613     ],
12614     "name": "CreateFreshsales_Accounts",
12615     "group": "Freshsales_Accounts",
12616     "parameter": {
12617       "fields": {
12618         "Body": [
12619           {
12620             "group": "Body",
12621             "type": "String",
12622             "optional": true,
12623             "field": "name",
12624             "description": ""
12625           },
12626           {
12627             "group": "Body",
12628             "type": "String",
12629             "optional": true,
12630             "field": "description",
12631             "description": ""
12632           },
12633           {
12634             "group": "Body",
12635             "type": "String",
12636             "optional": true,
12637             "field": "username",
12638             "description": ""
12639           },
12640           {
12641             "group": "Body",
12642             "type": "String",
12643             "optional": true,
12644             "field": "apiKey",
12645             "description": ""
12646           },
12647           {
12648             "group": "Body",
12649             "type": "String",
12650             "optional": true,
12651             "field": "remoteUri",
12652             "description": ""
12653           },
12654           {
12655             "group": "Body",
12656             "type": "String",
12657             "optional": false,
12658             "field": "serverUrl",
12659             "description": ""
12660           }
12661         ]
12662       }
12663     },
12664     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12665     "version": "0.0.0",
12666     "filename": "server/api/intFreshsalesAccount/index.js",
12667     "groupTitle": "Freshsales_Accounts"
12668   },
12669   {
12670     "type": "delete",
12671     "url": "/api/integrations/freshsales/accounts/{id}",
12672     "title": "Deletes a Freshsales Account",
12673     "examples": [
12674       {
12675         "title": "Example usage:",
12676         "content": "curl https://{domain}/api/integrations/freshsales/accounts/{id} -v -u {name}:{password} -X DELETE",
12677         "type": "json"
12678       }
12679     ],
12680     "name": "DeleteFreshsales_Accounts",
12681     "group": "Freshsales_Accounts",
12682     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12683     "version": "0.0.0",
12684     "filename": "server/api/intFreshsalesAccount/index.js",
12685     "groupTitle": "Freshsales_Accounts"
12686   },
12687   {
12688     "type": "get",
12689     "url": "/api/integrations/freshsales/accounts",
12690     "title": "Gets a list of Freshsales Accounts",
12691     "examples": [
12692       {
12693         "title": "Example usage:",
12694         "content": "curl https://{domain}/api/integrations/freshsales/accounts -v -u {name}:{password}",
12695         "type": "json"
12696       }
12697     ],
12698     "name": "GetFreshsales_Accounts",
12699     "group": "Freshsales_Accounts",
12700     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
12701     "version": "0.0.0",
12702     "filename": "server/api/intFreshsalesAccount/index.js",
12703     "groupTitle": "Freshsales_Accounts"
12704   },
12705   {
12706     "type": "get",
12707     "url": "/api/integrations/freshsales/accounts/{id}",
12708     "title": "Gets a single Freshsales Account",
12709     "examples": [
12710       {
12711         "title": "Example usage:",
12712         "content": "curl https://{domain}/api/integrations/freshsales/accounts/{id} -v -u {name}:{password}",
12713         "type": "json"
12714       }
12715     ],
12716     "name": "ShowFreshsales_Accounts",
12717     "group": "Freshsales_Accounts",
12718     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12719     "version": "0.0.0",
12720     "filename": "server/api/intFreshsalesAccount/index.js",
12721     "groupTitle": "Freshsales_Accounts"
12722   },
12723   {
12724     "type": "post",
12725     "url": "/api/integrations/freshsales/accounts/{id}/configurations",
12726     "title": "Creates new configuration",
12727     "examples": [
12728       {
12729         "title": "Example usage:",
12730         "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",
12731         "type": "json"
12732       }
12733     ],
12734     "name": "addConfiguration",
12735     "group": "Freshsales_Accounts",
12736     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12737     "version": "0.0.0",
12738     "filename": "server/api/intFreshsalesAccount/index.js",
12739     "groupTitle": "Freshsales_Accounts"
12740   },
12741   {
12742     "type": "get",
12743     "url": "/api/integrations/freshsales/accounts/{id}/configurations",
12744     "title": "Gets account configurations",
12745     "examples": [
12746       {
12747         "title": "Example usage:",
12748         "content": "curl https://{domain}/api/integrations/freshsales/accounts/{id}/configurations -v -u {name}:{password} -X GET",
12749         "type": "json"
12750       }
12751     ],
12752     "name": "getConfigurations",
12753     "group": "Freshsales_Accounts",
12754     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12755     "version": "0.0.0",
12756     "filename": "server/api/intFreshsalesAccount/index.js",
12757     "groupTitle": "Freshsales_Accounts"
12758   },
12759   {
12760     "type": "get",
12761     "url": "/api/integrations/freshsales/accounts/{id}/fields",
12762     "title": "Gets account fields",
12763     "examples": [
12764       {
12765         "title": "Example usage:",
12766         "content": "curl https://{domain}/api/integrations/freshsales/accounts/{id}/fields -v -u {name}:{password} -X GET",
12767         "type": "json"
12768       }
12769     ],
12770     "name": "getFields",
12771     "group": "Freshsales_Accounts",
12772     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12773     "version": "0.0.0",
12774     "filename": "server/api/intFreshsalesAccount/index.js",
12775     "groupTitle": "Freshsales_Accounts"
12776   },
12777   {
12778     "type": "put",
12779     "url": "/api/integrations/freshsales/accounts/{id}",
12780     "title": "Update an existing Freshsales Account",
12781     "examples": [
12782       {
12783         "title": "Example usage:",
12784         "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",
12785         "type": "json"
12786       }
12787     ],
12788     "name": "updateFreshsales_Accounts",
12789     "group": "Freshsales_Accounts",
12790     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12791     "version": "0.0.0",
12792     "filename": "server/api/intFreshsalesAccount/index.js",
12793     "groupTitle": "Freshsales_Accounts"
12794   },
12795   {
12796     "type": "post",
12797     "url": "/api/integrations/freshsales/configurations",
12798     "title": "Creates a new Freshsales Configuration",
12799     "examples": [
12800       {
12801         "title": "Example usage:",
12802         "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",
12803         "type": "json"
12804       }
12805     ],
12806     "name": "CreateFreshsales_Configurations",
12807     "group": "Freshsales_Configurations",
12808     "parameter": {
12809       "fields": {
12810         "Body": [
12811           {
12812             "group": "Body",
12813             "type": "String",
12814             "optional": true,
12815             "field": "name",
12816             "description": ""
12817           },
12818           {
12819             "group": "Body",
12820             "type": "String",
12821             "optional": true,
12822             "field": "description",
12823             "description": ""
12824           }
12825         ]
12826       }
12827     },
12828     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12829     "version": "0.0.0",
12830     "filename": "server/api/intFreshsalesConfiguration/index.js",
12831     "groupTitle": "Freshsales_Configurations"
12832   },
12833   {
12834     "type": "delete",
12835     "url": "/api/integrations/freshsales/configurations/{id}",
12836     "title": "Deletes a Freshsales Configuration",
12837     "examples": [
12838       {
12839         "title": "Example usage:",
12840         "content": "curl https://{domain}/api/integrations/freshsales/configurations/{id} -v -u {name}:{password} -X DELETE",
12841         "type": "json"
12842       }
12843     ],
12844     "name": "DeleteFreshsales_Configurations",
12845     "group": "Freshsales_Configurations",
12846     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12847     "version": "0.0.0",
12848     "filename": "server/api/intFreshsalesConfiguration/index.js",
12849     "groupTitle": "Freshsales_Configurations"
12850   },
12851   {
12852     "type": "get",
12853     "url": "/api/integrations/freshsales/configurations",
12854     "title": "Gets a list of Freshsales Configurations",
12855     "examples": [
12856       {
12857         "title": "Example usage:",
12858         "content": "curl https://{domain}/api/integrations/freshsales/configurations -v -u {name}:{password}",
12859         "type": "json"
12860       }
12861     ],
12862     "name": "GetFreshsales_Configurations",
12863     "group": "Freshsales_Configurations",
12864     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
12865     "version": "0.0.0",
12866     "filename": "server/api/intFreshsalesConfiguration/index.js",
12867     "groupTitle": "Freshsales_Configurations"
12868   },
12869   {
12870     "type": "get",
12871     "url": "/api/integrations/freshsales/configurations/{id}",
12872     "title": "Gets a single Freshsales Configuration",
12873     "examples": [
12874       {
12875         "title": "Example usage:",
12876         "content": "curl https://{domain}/api/integrations/freshsales/configurations/{id} -v -u {name}:{password}",
12877         "type": "json"
12878       }
12879     ],
12880     "name": "ShowFreshsales_Configurations",
12881     "group": "Freshsales_Configurations",
12882     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12883     "version": "0.0.0",
12884     "filename": "server/api/intFreshsalesConfiguration/index.js",
12885     "groupTitle": "Freshsales_Configurations"
12886   },
12887   {
12888     "type": "get",
12889     "url": "/api/integrations/freshsales/configurations/{id}/descriptions",
12890     "title": "Gets configurations descriptions",
12891     "examples": [
12892       {
12893         "title": "Example usage:",
12894         "content": "curl https://{domain}/api/integrations/freshsales/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
12895         "type": "json"
12896       }
12897     ],
12898     "name": "getDescriptions",
12899     "group": "Freshsales_Configurations",
12900     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12901     "version": "0.0.0",
12902     "filename": "server/api/intFreshsalesConfiguration/index.js",
12903     "groupTitle": "Freshsales_Configurations"
12904   },
12905   {
12906     "type": "get",
12907     "url": "/api/integrations/freshsales/configurations/{id}/fields",
12908     "title": "Gets configurations fields",
12909     "examples": [
12910       {
12911         "title": "Example usage:",
12912         "content": "curl https://{domain}/api/integrations/freshsales/configurations/{id}/fields -v -u {name}:{password} -X GET",
12913         "type": "json"
12914       }
12915     ],
12916     "name": "getFields",
12917     "group": "Freshsales_Configurations",
12918     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12919     "version": "0.0.0",
12920     "filename": "server/api/intFreshsalesConfiguration/index.js",
12921     "groupTitle": "Freshsales_Configurations"
12922   },
12923   {
12924     "type": "get",
12925     "url": "/api/integrations/freshsales/configurations/{id}/subjects",
12926     "title": "Gets configurations subjects",
12927     "examples": [
12928       {
12929         "title": "Example usage:",
12930         "content": "curl https://{domain}/api/integrations/freshsales/configurations/{id}/subjects -v -u {name}:{password} -X GET",
12931         "type": "json"
12932       }
12933     ],
12934     "name": "getSubjects",
12935     "group": "Freshsales_Configurations",
12936     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12937     "version": "0.0.0",
12938     "filename": "server/api/intFreshsalesConfiguration/index.js",
12939     "groupTitle": "Freshsales_Configurations"
12940   },
12941   {
12942     "type": "put",
12943     "url": "/api/integrations/freshsales/configurations/{id}",
12944     "title": "Update an existing Freshsales Configuration",
12945     "examples": [
12946       {
12947         "title": "Example usage:",
12948         "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",
12949         "type": "json"
12950       }
12951     ],
12952     "name": "updateFreshsales_Configurations",
12953     "group": "Freshsales_Configurations",
12954     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12955     "version": "0.0.0",
12956     "filename": "server/api/intFreshsalesConfiguration/index.js",
12957     "groupTitle": "Freshsales_Configurations"
12958   },
12959   {
12960     "type": "post",
12961     "url": "/api/integrations/freshsales/fields",
12962     "title": "Creates a new Freshsales Field",
12963     "examples": [
12964       {
12965         "title": "Example usage:",
12966         "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",
12967         "type": "json"
12968       }
12969     ],
12970     "name": "CreateFreshsales_Fields",
12971     "group": "Freshsales_Fields",
12972     "parameter": {
12973       "fields": {
12974         "Body": [
12975           {
12976             "group": "Body",
12977             "type": "String",
12978             "allowedValues": [
12979               "\"string\"",
12980               "\"variable\"",
12981               "\"customVariable\"",
12982               "\"keyValue\"",
12983               "\"picklist\""
12984             ],
12985             "optional": true,
12986             "field": "type",
12987             "description": ""
12988           },
12989           {
12990             "group": "Body",
12991             "type": "String",
12992             "optional": true,
12993             "field": "content",
12994             "description": ""
12995           },
12996           {
12997             "group": "Body",
12998             "type": "String",
12999             "optional": true,
13000             "field": "key",
13001             "description": ""
13002           },
13003           {
13004             "group": "Body",
13005             "type": "String",
13006             "allowedValues": [
13007               "\"string\"",
13008               "\"variable\"",
13009               "\"customVariable\""
13010             ],
13011             "optional": true,
13012             "field": "keyType",
13013             "description": ""
13014           },
13015           {
13016             "group": "Body",
13017             "type": "String",
13018             "optional": true,
13019             "field": "keyContent",
13020             "description": ""
13021           },
13022           {
13023             "group": "Body",
13024             "type": "String",
13025             "optional": true,
13026             "field": "idField",
13027             "description": ""
13028           },
13029           {
13030             "group": "Body",
13031             "type": "String",
13032             "optional": true,
13033             "field": "nameField",
13034             "description": ""
13035           },
13036           {
13037             "group": "Body",
13038             "type": "Boolean",
13039             "optional": true,
13040             "field": "customField",
13041             "description": ""
13042           },
13043           {
13044             "group": "Body",
13045             "type": "String",
13046             "optional": true,
13047             "field": "variableName",
13048             "description": ""
13049           }
13050         ]
13051       }
13052     },
13053     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13054     "version": "0.0.0",
13055     "filename": "server/api/intFreshsalesField/index.js",
13056     "groupTitle": "Freshsales_Fields"
13057   },
13058   {
13059     "type": "delete",
13060     "url": "/api/integrations/freshsales/fields/{id}",
13061     "title": "Deletes a Freshsales Field",
13062     "examples": [
13063       {
13064         "title": "Example usage:",
13065         "content": "curl https://{domain}/api/integrations/freshsales/fields/{id} -v -u {name}:{password} -X DELETE",
13066         "type": "json"
13067       }
13068     ],
13069     "name": "DeleteFreshsales_Fields",
13070     "group": "Freshsales_Fields",
13071     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13072     "version": "0.0.0",
13073     "filename": "server/api/intFreshsalesField/index.js",
13074     "groupTitle": "Freshsales_Fields"
13075   },
13076   {
13077     "type": "get",
13078     "url": "/api/integrations/freshsales/fields",
13079     "title": "Gets a list of Freshsales Fields",
13080     "examples": [
13081       {
13082         "title": "Example usage:",
13083         "content": "curl https://{domain}/api/integrations/freshsales/fields -v -u {name}:{password}",
13084         "type": "json"
13085       }
13086     ],
13087     "name": "GetFreshsales_Fields",
13088     "group": "Freshsales_Fields",
13089     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
13090     "version": "0.0.0",
13091     "filename": "server/api/intFreshsalesField/index.js",
13092     "groupTitle": "Freshsales_Fields"
13093   },
13094   {
13095     "type": "get",
13096     "url": "/api/integrations/freshsales/fields/{id}",
13097     "title": "Gets a single Freshsales Field",
13098     "examples": [
13099       {
13100         "title": "Example usage:",
13101         "content": "curl https://{domain}/api/integrations/freshsales/fields/{id} -v -u {name}:{password}",
13102         "type": "json"
13103       }
13104     ],
13105     "name": "ShowFreshsales_Fields",
13106     "group": "Freshsales_Fields",
13107     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13108     "version": "0.0.0",
13109     "filename": "server/api/intFreshsalesField/index.js",
13110     "groupTitle": "Freshsales_Fields"
13111   },
13112   {
13113     "type": "put",
13114     "url": "/api/integrations/freshsales/fields/{id}",
13115     "title": "Update an existing Freshsales Field",
13116     "examples": [
13117       {
13118         "title": "Example usage:",
13119         "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",
13120         "type": "json"
13121       }
13122     ],
13123     "name": "updateFreshsales_Fields",
13124     "group": "Freshsales_Fields",
13125     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13126     "version": "0.0.0",
13127     "filename": "server/api/intFreshsalesField/index.js",
13128     "groupTitle": "Freshsales_Fields"
13129   },
13130   {
13131     "type": "post",
13132     "url": "/api/campaigns/{id}/blacklists",
13133     "title": "Add blacklists to an IVR campaign",
13134     "examples": [
13135       {
13136         "title": "Example usage:",
13137         "content": "curl https://{domain}/api/campaigns/{id}/blacklists -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
13138         "type": "json"
13139       }
13140     ],
13141     "name": "AddBlackLists",
13142     "group": "IVR_Campaigns",
13143     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13144     "version": "0.0.0",
13145     "filename": "server/api/campaign/index.js",
13146     "groupTitle": "IVR_Campaigns"
13147   },
13148   {
13149     "type": "post",
13150     "url": "/api/campaigns/{id}/lists",
13151     "title": "Add lists to an IVR campaign",
13152     "examples": [
13153       {
13154         "title": "Example usage:",
13155         "content": "curl https://{domain}/api/campaigns/{id}/lists -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
13156         "type": "json"
13157       }
13158     ],
13159     "name": "AddLists",
13160     "group": "IVR_Campaigns",
13161     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13162     "version": "0.0.0",
13163     "filename": "server/api/campaign/index.js",
13164     "groupTitle": "IVR_Campaigns"
13165   },
13166   {
13167     "type": "post",
13168     "url": "/api/campaigns/clone",
13169     "title": "Clone an existing IVR Campaign",
13170     "examples": [
13171       {
13172         "title": "Example usage:",
13173         "content": "curl https://{domain}/api/campaigns/clone -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
13174         "type": "json"
13175       }
13176     ],
13177     "name": "CloneIVR_Campaigns",
13178     "group": "IVR_Campaigns",
13179     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13180     "version": "0.0.0",
13181     "filename": "server/api/campaign/index.js",
13182     "groupTitle": "IVR_Campaigns"
13183   },
13184   {
13185     "type": "post",
13186     "url": "/api/campaigns",
13187     "title": "Creates a new IVR Campaign",
13188     "examples": [
13189       {
13190         "title": "Example usage:",
13191         "content": "curl https://{domain}/api/campaigns -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
13192         "type": "json"
13193       }
13194     ],
13195     "name": "CreateIVR_Campaigns",
13196     "group": "IVR_Campaigns",
13197     "parameter": {
13198       "fields": {
13199         "Body": [
13200           {
13201             "group": "Body",
13202             "type": "String",
13203             "optional": false,
13204             "field": "name",
13205             "description": ""
13206           },
13207           {
13208             "group": "Body",
13209             "type": "String",
13210             "allowedValues": [
13211               "\"ivr\""
13212             ],
13213             "optional": false,
13214             "field": "type",
13215             "description": ""
13216           },
13217           {
13218             "group": "Body",
13219             "type": "String",
13220             "optional": true,
13221             "field": "description",
13222             "description": ""
13223           },
13224           {
13225             "group": "Body",
13226             "type": "Boolean",
13227             "optional": true,
13228             "field": "active",
13229             "description": "<p>Active/Disactive Campaign</p>"
13230           },
13231           {
13232             "group": "Body",
13233             "type": "Integer",
13234             "optional": true,
13235             "field": "limitCalls",
13236             "description": "<p>Max 200 calls.</p>"
13237           },
13238           {
13239             "group": "Body",
13240             "type": "String",
13241             "optional": true,
13242             "field": "dialOriginateCallerIdName",
13243             "description": ""
13244           },
13245           {
13246             "group": "Body",
13247             "type": "String",
13248             "optional": true,
13249             "field": "dialOriginateCallerIdNumber",
13250             "description": ""
13251           },
13252           {
13253             "group": "Body",
13254             "type": "Integer",
13255             "optional": true,
13256             "field": "dialOriginateTimeout",
13257             "description": "<p>Originate Timeout Seconds (min:1, max:999)</p>"
13258           },
13259           {
13260             "group": "Body",
13261             "type": "Integer",
13262             "optional": true,
13263             "field": "dialCongestionMaxRetry",
13264             "description": "<p>#Congestion Retry (min:1, max:999)</p>"
13265           },
13266           {
13267             "group": "Body",
13268             "type": "Integer",
13269             "optional": true,
13270             "field": "dialCongestionRetryFrequency",
13271             "description": "<p>Congestion Retry Frequency Minutes (min:1, max:99999)</p>"
13272           },
13273           {
13274             "group": "Body",
13275             "type": "Integer",
13276             "optional": true,
13277             "field": "dialBusyMaxRetry",
13278             "description": "<p>#Busy Retry (min:1, max:999)</p>"
13279           },
13280           {
13281             "group": "Body",
13282             "type": "Integer",
13283             "optional": true,
13284             "field": "dialBusyRetryFrequency",
13285             "description": "<p>Busy Retry Frequency Minutes (min:1, max:99999)</p>"
13286           },
13287           {
13288             "group": "Body",
13289             "type": "Integer",
13290             "optional": true,
13291             "field": "dialNoAnswerMaxRetry",
13292             "description": "<p>#NoAnswer Retry (min:1, max:999)</p>"
13293           },
13294           {
13295             "group": "Body",
13296             "type": "Integer",
13297             "optional": true,
13298             "field": "dialNoAnswerRetryFrequency",
13299             "description": "<p>NoAnswer Retry Frequency Minutes (min:1, max:99999)</p>"
13300           },
13301           {
13302             "group": "Body",
13303             "type": "Integer",
13304             "optional": true,
13305             "field": "dialGlobalMaxRetry",
13306             "description": "<p>#Global Max Retry (min:1, max:999)</p>"
13307           },
13308           {
13309             "group": "Body",
13310             "type": "String",
13311             "optional": true,
13312             "field": "dialTimezone",
13313             "description": ""
13314           },
13315           {
13316             "group": "Body",
13317             "type": "String",
13318             "optional": true,
13319             "field": "dialGlobalInterval",
13320             "description": ""
13321           },
13322           {
13323             "group": "Body",
13324             "type": "String",
13325             "allowedValues": [
13326               "\"always\"",
13327               "\"never\"",
13328               "\"onlyIfOpen\""
13329             ],
13330             "optional": true,
13331             "field": "dialCheckDuplicateType",
13332             "description": ""
13333           },
13334           {
13335             "group": "Body",
13336             "type": "Boolean",
13337             "optional": true,
13338             "field": "dialAMDActive",
13339             "description": "<p>Active/Disactive AMD</p>"
13340           },
13341           {
13342             "group": "Body",
13343             "type": "Integer",
13344             "optional": true,
13345             "field": "dialAMDInitialSilence",
13346             "description": "<p>#AMD Initial Silence</p>"
13347           },
13348           {
13349             "group": "Body",
13350             "type": "Integer",
13351             "optional": true,
13352             "field": "dialAMDGreeting",
13353             "description": "<p>#AMD Greeting</p>"
13354           },
13355           {
13356             "group": "Body",
13357             "type": "Integer",
13358             "optional": true,
13359             "field": "dialAMDAfterGreetingSilence",
13360             "description": "<p>#AMD After Greeting Silence</p>"
13361           },
13362           {
13363             "group": "Body",
13364             "type": "Integer",
13365             "optional": true,
13366             "field": "dialAMDTotalAnalysisTime",
13367             "description": "<p>#AMD Total Analysis Time</p>"
13368           },
13369           {
13370             "group": "Body",
13371             "type": "Integer",
13372             "optional": true,
13373             "field": "dialAMDMinWordLength",
13374             "description": "<p>#AMD Min Word Length</p>"
13375           },
13376           {
13377             "group": "Body",
13378             "type": "Integer",
13379             "optional": true,
13380             "field": "dialAMDBetweenWordsSilence",
13381             "description": "<p>#AMD Between Words Silence</p>"
13382           },
13383           {
13384             "group": "Body",
13385             "type": "Integer",
13386             "optional": true,
13387             "field": "dialAMDMaximumNumberOfWords",
13388             "description": "<p>#AMD Maximum Number Of Words</p>"
13389           },
13390           {
13391             "group": "Body",
13392             "type": "Integer",
13393             "optional": true,
13394             "field": "dialAMDSilenceThreshold",
13395             "description": "<p>#AMD Silence Threshold (min:0, max:32767)</p>"
13396           },
13397           {
13398             "group": "Body",
13399             "type": "Integer",
13400             "optional": true,
13401             "field": "dialAMDMaximumWordLength",
13402             "description": "<p>#AMD Maximum Word Length</p>"
13403           },
13404           {
13405             "group": "Body",
13406             "type": "String",
13407             "allowedValues": [
13408               "\"DESC\"",
13409               "\"ASC\""
13410             ],
13411             "optional": true,
13412             "field": "dialOrderByScheduledAt",
13413             "description": ""
13414           },
13415           {
13416             "group": "Body",
13417             "type": "String",
13418             "optional": true,
13419             "field": "dialPrefix",
13420             "description": ""
13421           },
13422           {
13423             "group": "Body",
13424             "type": "Integer",
13425             "optional": true,
13426             "field": "dialRandomLastDigitCallerIdNumber",
13427             "description": "<p>Random Last Digit (min:1, max:15)</p>"
13428           },
13429           {
13430             "group": "Body",
13431             "type": "Integer",
13432             "optional": true,
13433             "field": "dialCutDigit",
13434             "description": "<p>Cut Digit (min:1, max:15)</p>"
13435           },
13436           {
13437             "group": "Body",
13438             "type": "Integer",
13439             "optional": true,
13440             "field": "dialNoSuchNumberMaxRetry",
13441             "description": "<p>#NoSuchNumber Retry (min:1, max:999)</p>"
13442           },
13443           {
13444             "group": "Body",
13445             "type": "Integer",
13446             "optional": true,
13447             "field": "dialNoSuchNumberRetryFrequency",
13448             "description": "<p>NoSuchNumber Retry Frequency Minutes (min:1, max:99999)</p>"
13449           },
13450           {
13451             "group": "Body",
13452             "type": "Integer",
13453             "optional": true,
13454             "field": "dialDropMaxRetry",
13455             "description": "<p>#Drop Retry (min:1, max:999)</p>"
13456           },
13457           {
13458             "group": "Body",
13459             "type": "Integer",
13460             "optional": true,
13461             "field": "dialDropRetryFrequency",
13462             "description": "<p>Drop Retry Frequency Minutes (min:1, max:99999)</p>"
13463           },
13464           {
13465             "group": "Body",
13466             "type": "Integer",
13467             "optional": true,
13468             "field": "dialAbandonedMaxRetry",
13469             "description": "<p>#Abandoned Retry (min:1, max:999)</p>"
13470           },
13471           {
13472             "group": "Body",
13473             "type": "Integer",
13474             "optional": true,
13475             "field": "dialAbandonedRetryFrequency",
13476             "description": "<p>Abandoned Retry Frequency Minutes (min:1, max:99999)</p>"
13477           },
13478           {
13479             "group": "Body",
13480             "type": "Integer",
13481             "optional": true,
13482             "field": "dialMachineMaxRetry",
13483             "description": "<p>#Machine Retry (min:1, max:999)</p>"
13484           },
13485           {
13486             "group": "Body",
13487             "type": "Integer",
13488             "optional": true,
13489             "field": "dialMachineRetryFrequency",
13490             "description": "<p>Machine Retry Frequency Minutes (min:1, max:99999)</p>"
13491           },
13492           {
13493             "group": "Body",
13494             "type": "Integer",
13495             "optional": true,
13496             "field": "dialAgentRejectMaxRetry",
13497             "description": "<p>#AgentReject Retry (min:1, max:999)</p>"
13498           },
13499           {
13500             "group": "Body",
13501             "type": "Integer",
13502             "optional": true,
13503             "field": "dialAgentRejectRetryFrequency",
13504             "description": "<p>AgentReject Retry Frequency Minutes (min:1, max:99999)</p>"
13505           }
13506         ]
13507       }
13508     },
13509     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13510     "version": "0.0.0",
13511     "filename": "server/api/campaign/index.js",
13512     "groupTitle": "IVR_Campaigns"
13513   },
13514   {
13515     "type": "delete",
13516     "url": "/api/campaigns/{id}",
13517     "title": "Deletes a IVR Campaign",
13518     "examples": [
13519       {
13520         "title": "Example usage:",
13521         "content": "curl https://{domain}/api/campaigns/{id} -v -u {name}:{password} -X DELETE",
13522         "type": "json"
13523       }
13524     ],
13525     "name": "DeleteIVR_Campaigns",
13526     "group": "IVR_Campaigns",
13527     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13528     "version": "0.0.0",
13529     "filename": "server/api/campaign/index.js",
13530     "groupTitle": "IVR_Campaigns"
13531   },
13532   {
13533     "type": "get",
13534     "url": "/api/campaigns/{id}/blacklists",
13535     "title": "Get IVR campaign blacklists",
13536     "examples": [
13537       {
13538         "title": "Example usage:",
13539         "content": "curl https://{domain}/api/campaigns/{id}/blacklists -v -u {name}:{password} -X GET",
13540         "type": "json"
13541       }
13542     ],
13543     "name": "GetBlackLists",
13544     "group": "IVR_Campaigns",
13545     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13546     "version": "0.0.0",
13547     "filename": "server/api/campaign/index.js",
13548     "groupTitle": "IVR_Campaigns"
13549   },
13550   {
13551     "type": "get",
13552     "url": "/api/campaigns/{id}/finals",
13553     "title": "Gets IVR campaign hopper finals",
13554     "examples": [
13555       {
13556         "title": "Example usage:",
13557         "content": "curl https://{domain}/api/campaigns/{id}/hopper_finals -v -u {name}:{password}  -X GET",
13558         "type": "json"
13559       }
13560     ],
13561     "name": "GetHopperFinals",
13562     "group": "IVR_Campaigns",
13563     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13564     "version": "0.0.0",
13565     "filename": "server/api/campaign/index.js",
13566     "groupTitle": "IVR_Campaigns"
13567   },
13568   {
13569     "type": "get",
13570     "url": "/api/campaigns/{id}/hopper_histories",
13571     "title": "Gets IVR campaign hopper histories",
13572     "examples": [
13573       {
13574         "title": "Example usage:",
13575         "content": "curl https://{domain}/api/campaigns/{id}/hopper_histories -v -u {name}:{password} -X GET",
13576         "type": "json"
13577       }
13578     ],
13579     "name": "GetHopperHistories",
13580     "group": "IVR_Campaigns",
13581     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13582     "version": "0.0.0",
13583     "filename": "server/api/campaign/index.js",
13584     "groupTitle": "IVR_Campaigns"
13585   },
13586   {
13587     "type": "get",
13588     "url": "/api/campaigns/{id}/hoppers",
13589     "title": "Gets IVR campaign hoppers",
13590     "examples": [
13591       {
13592         "title": "Example usage:",
13593         "content": "curl https://{domain}/api/campaigns/{id}/hoppers -v -u {name}:{password} -X GET",
13594         "type": "json"
13595       }
13596     ],
13597     "name": "GetHoppers",
13598     "group": "IVR_Campaigns",
13599     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13600     "version": "0.0.0",
13601     "filename": "server/api/campaign/index.js",
13602     "groupTitle": "IVR_Campaigns"
13603   },
13604   {
13605     "type": "get",
13606     "url": "/api/campaigns",
13607     "title": "Gets a list of IVR Campaigns",
13608     "examples": [
13609       {
13610         "title": "Example usage:",
13611         "content": "curl https://{domain}/api/campaigns -v -u {name}:{password}",
13612         "type": "json"
13613       }
13614     ],
13615     "name": "GetIVR_Campaigns",
13616     "group": "IVR_Campaigns",
13617     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
13618     "version": "0.0.0",
13619     "filename": "server/api/campaign/index.js",
13620     "groupTitle": "IVR_Campaigns"
13621   },
13622   {
13623     "type": "get",
13624     "url": "/api/campaigns/{id}/lists",
13625     "title": "Get IVR campaign lists",
13626     "examples": [
13627       {
13628         "title": "Example usage:",
13629         "content": "curl https://{domain}/api/campaigns/{id}/lists -v -u {name}:{password} -X GET",
13630         "type": "json"
13631       }
13632     ],
13633     "name": "GetLists",
13634     "group": "IVR_Campaigns",
13635     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13636     "version": "0.0.0",
13637     "filename": "server/api/campaign/index.js",
13638     "groupTitle": "IVR_Campaigns"
13639   },
13640   {
13641     "type": "delete",
13642     "url": "/api/campaigns/{id}/blacklists",
13643     "title": "Remove blacklists from an IVR Campaign",
13644     "examples": [
13645       {
13646         "title": "Example usage:",
13647         "content": "curl https://{domain}/api/campaigns/{id}/blacklists?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
13648         "type": "json"
13649       }
13650     ],
13651     "name": "RemoveBlackLists",
13652     "group": "IVR_Campaigns",
13653     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13654     "version": "0.0.0",
13655     "filename": "server/api/campaign/index.js",
13656     "groupTitle": "IVR_Campaigns"
13657   },
13658   {
13659     "type": "delete",
13660     "url": "/api/campaigns/{id}/lists",
13661     "title": "Remove lists from an IVR Campaign",
13662     "examples": [
13663       {
13664         "title": "Example usage:",
13665         "content": "curl https://{domain}/api/campaigns/{id}/lists?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
13666         "type": "json"
13667       }
13668     ],
13669     "name": "RemoveLists",
13670     "group": "IVR_Campaigns",
13671     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13672     "version": "0.0.0",
13673     "filename": "server/api/campaign/index.js",
13674     "groupTitle": "IVR_Campaigns"
13675   },
13676   {
13677     "type": "get",
13678     "url": "/api/campaigns/{id}",
13679     "title": "Gets a single IVR Campaign",
13680     "examples": [
13681       {
13682         "title": "Example usage:",
13683         "content": "curl https://{domain}/api/campaigns/{id} -v -u {name}:{password}",
13684         "type": "json"
13685       }
13686     ],
13687     "name": "ShowIVR_Campaigns",
13688     "group": "IVR_Campaigns",
13689     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13690     "version": "0.0.0",
13691     "filename": "server/api/campaign/index.js",
13692     "groupTitle": "IVR_Campaigns"
13693   },
13694   {
13695     "type": "get",
13696     "url": "/api/campaigns/{id}/blacks",
13697     "title": "Gets IVR campaign hopper blacks",
13698     "examples": [
13699       {
13700         "title": "Example usage:",
13701         "content": "curl https://{domain}/api/campaigns/{id}/hopper_black -v -u {name}:{password}  -X GET",
13702         "type": "json"
13703       }
13704     ],
13705     "name": "getHopperBlacks",
13706     "group": "IVR_Campaigns",
13707     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13708     "version": "0.0.0",
13709     "filename": "server/api/campaign/index.js",
13710     "groupTitle": "IVR_Campaigns"
13711   },
13712   {
13713     "type": "put",
13714     "url": "/api/campaigns/{id}",
13715     "title": "Update an existing IVR Campaign",
13716     "examples": [
13717       {
13718         "title": "Example usage:",
13719         "content": "curl https://{domain}/api/campaigns/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
13720         "type": "json"
13721       }
13722     ],
13723     "name": "updateIVR_Campaigns",
13724     "group": "IVR_Campaigns",
13725     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13726     "version": "0.0.0",
13727     "filename": "server/api/campaign/index.js",
13728     "groupTitle": "IVR_Campaigns"
13729   },
13730   {
13731     "type": "post",
13732     "url": "/api/integrations/reports",
13733     "title": "Creates a new Integration Report",
13734     "examples": [
13735       {
13736         "title": "Example usage:",
13737         "content": "curl https://{domain}/api/integrations/reports -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
13738         "type": "json"
13739       }
13740     ],
13741     "name": "CreateIntegration_Reports",
13742     "group": "Integration_Reports",
13743     "parameter": {
13744       "fields": {
13745         "Body": [
13746           {
13747             "group": "Body",
13748             "type": "String",
13749             "optional": true,
13750             "field": "integration",
13751             "description": ""
13752           },
13753           {
13754             "group": "Body",
13755             "type": "String",
13756             "optional": true,
13757             "field": "eventChannel",
13758             "description": ""
13759           },
13760           {
13761             "group": "Body",
13762             "type": "String",
13763             "optional": true,
13764             "field": "exitStatus",
13765             "description": ""
13766           },
13767           {
13768             "group": "Body",
13769             "type": "String",
13770             "optional": true,
13771             "field": "ticketId",
13772             "description": ""
13773           },
13774           {
13775             "group": "Body",
13776             "type": "Integer",
13777             "optional": true,
13778             "field": "integrationId",
13779             "description": ""
13780           },
13781           {
13782             "group": "Body",
13783             "type": "String",
13784             "optional": true,
13785             "field": "contacts",
13786             "description": ""
13787           },
13788           {
13789             "group": "Body",
13790             "type": "String",
13791             "optional": true,
13792             "field": "uniqueid",
13793             "description": ""
13794           },
13795           {
13796             "group": "Body",
13797             "type": "String",
13798             "optional": true,
13799             "field": "calleridnum",
13800             "description": ""
13801           },
13802           {
13803             "group": "Body",
13804             "type": "String",
13805             "optional": true,
13806             "field": "calleridname",
13807             "description": ""
13808           },
13809           {
13810             "group": "Body",
13811             "type": "String",
13812             "optional": true,
13813             "field": "queue",
13814             "description": ""
13815           },
13816           {
13817             "group": "Body",
13818             "type": "String",
13819             "optional": true,
13820             "field": "interface",
13821             "description": ""
13822           },
13823           {
13824             "group": "Body",
13825             "type": "String",
13826             "optional": true,
13827             "field": "membername",
13828             "description": ""
13829           },
13830           {
13831             "group": "Body",
13832             "type": "String",
13833             "optional": true,
13834             "field": "agentcalledAt",
13835             "description": ""
13836           },
13837           {
13838             "group": "Body",
13839             "type": "String",
13840             "optional": true,
13841             "field": "agentconnectAt",
13842             "description": ""
13843           },
13844           {
13845             "group": "Body",
13846             "type": "Integer",
13847             "optional": true,
13848             "field": "holdtime",
13849             "description": ""
13850           },
13851           {
13852             "group": "Body",
13853             "type": "Boolean",
13854             "optional": true,
13855             "field": "agentcomplete",
13856             "description": ""
13857           },
13858           {
13859             "group": "Body",
13860             "type": "String",
13861             "optional": true,
13862             "field": "agentcompleteAt",
13863             "description": ""
13864           },
13865           {
13866             "group": "Body",
13867             "type": "Integer",
13868             "optional": true,
13869             "field": "talktime",
13870             "description": ""
13871           },
13872           {
13873             "group": "Body",
13874             "type": "Boolean",
13875             "optional": true,
13876             "field": "agentacw",
13877             "description": ""
13878           },
13879           {
13880             "group": "Body",
13881             "type": "Integer",
13882             "optional": true,
13883             "field": "acwtime",
13884             "description": ""
13885           },
13886           {
13887             "group": "Body",
13888             "type": "String",
13889             "optional": true,
13890             "field": "reason",
13891             "description": ""
13892           },
13893           {
13894             "group": "Body",
13895             "type": "Boolean",
13896             "optional": true,
13897             "field": "agentringnoanswer",
13898             "description": ""
13899           },
13900           {
13901             "group": "Body",
13902             "type": "String",
13903             "optional": true,
13904             "field": "agentringnoanswerAt",
13905             "description": ""
13906           },
13907           {
13908             "group": "Body",
13909             "type": "Boolean",
13910             "optional": true,
13911             "field": "agentdump",
13912             "description": ""
13913           },
13914           {
13915             "group": "Body",
13916             "type": "String",
13917             "optional": true,
13918             "field": "agentdumpAt",
13919             "description": ""
13920           },
13921           {
13922             "group": "Body",
13923             "type": "String",
13924             "optional": true,
13925             "field": "lastevent",
13926             "description": ""
13927           },
13928           {
13929             "group": "Body",
13930             "type": "String",
13931             "optional": true,
13932             "field": "channel",
13933             "description": ""
13934           },
13935           {
13936             "group": "Body",
13937             "type": "Integer",
13938             "optional": true,
13939             "field": "channelstate",
13940             "description": ""
13941           },
13942           {
13943             "group": "Body",
13944             "type": "String",
13945             "optional": true,
13946             "field": "channelstatedesc",
13947             "description": ""
13948           },
13949           {
13950             "group": "Body",
13951             "type": "String",
13952             "optional": true,
13953             "field": "connectedlinenum",
13954             "description": ""
13955           },
13956           {
13957             "group": "Body",
13958             "type": "String",
13959             "optional": true,
13960             "field": "connectedlinename",
13961             "description": ""
13962           },
13963           {
13964             "group": "Body",
13965             "type": "String",
13966             "optional": true,
13967             "field": "language",
13968             "description": ""
13969           },
13970           {
13971             "group": "Body",
13972             "type": "String",
13973             "optional": true,
13974             "field": "accountcode",
13975             "description": ""
13976           },
13977           {
13978             "group": "Body",
13979             "type": "String",
13980             "optional": true,
13981             "field": "context",
13982             "description": ""
13983           },
13984           {
13985             "group": "Body",
13986             "type": "String",
13987             "optional": true,
13988             "field": "exten",
13989             "description": ""
13990           },
13991           {
13992             "group": "Body",
13993             "type": "String",
13994             "optional": true,
13995             "field": "priority",
13996             "description": ""
13997           },
13998           {
13999             "group": "Body",
14000             "type": "String",
14001             "optional": true,
14002             "field": "destchannel",
14003             "description": ""
14004           },
14005           {
14006             "group": "Body",
14007             "type": "Integer",
14008             "optional": true,
14009             "field": "destchannelstate",
14010             "description": ""
14011           },
14012           {
14013             "group": "Body",
14014             "type": "String",
14015             "optional": true,
14016             "field": "destchannelstatedesc",
14017             "description": ""
14018           },
14019           {
14020             "group": "Body",
14021             "type": "String",
14022             "optional": true,
14023             "field": "destcalleridnum",
14024             "description": ""
14025           },
14026           {
14027             "group": "Body",
14028             "type": "String",
14029             "optional": true,
14030             "field": "destcalleridname",
14031             "description": ""
14032           },
14033           {
14034             "group": "Body",
14035             "type": "String",
14036             "optional": true,
14037             "field": "destconnectedlinenum",
14038             "description": ""
14039           },
14040           {
14041             "group": "Body",
14042             "type": "String",
14043             "optional": true,
14044             "field": "destconnectedlinename",
14045             "description": ""
14046           },
14047           {
14048             "group": "Body",
14049             "type": "String",
14050             "optional": true,
14051             "field": "destlanguage",
14052             "description": ""
14053           },
14054           {
14055             "group": "Body",
14056             "type": "String",
14057             "optional": true,
14058             "field": "destaccountcode",
14059             "description": ""
14060           },
14061           {
14062             "group": "Body",
14063             "type": "String",
14064             "optional": true,
14065             "field": "destcontext",
14066             "description": ""
14067           },
14068           {
14069             "group": "Body",
14070             "type": "String",
14071             "optional": true,
14072             "field": "destexten",
14073             "description": ""
14074           },
14075           {
14076             "group": "Body",
14077             "type": "String",
14078             "optional": true,
14079             "field": "destpriority",
14080             "description": ""
14081           },
14082           {
14083             "group": "Body",
14084             "type": "String",
14085             "optional": true,
14086             "field": "destuniqueid",
14087             "description": ""
14088           },
14089           {
14090             "group": "Body",
14091             "type": "String",
14092             "optional": true,
14093             "field": "messageId",
14094             "description": ""
14095           },
14096           {
14097             "group": "Body",
14098             "type": "String",
14099             "optional": true,
14100             "field": "inReplyTo",
14101             "description": ""
14102           },
14103           {
14104             "group": "Body",
14105             "type": "String",
14106             "optional": true,
14107             "field": "subject",
14108             "description": ""
14109           },
14110           {
14111             "group": "Body",
14112             "type": "String",
14113             "optional": true,
14114             "field": "from",
14115             "description": ""
14116           },
14117           {
14118             "group": "Body",
14119             "type": "String",
14120             "optional": true,
14121             "field": "to",
14122             "description": ""
14123           },
14124           {
14125             "group": "Body",
14126             "type": "String",
14127             "optional": true,
14128             "field": "cc",
14129             "description": ""
14130           },
14131           {
14132             "group": "Body",
14133             "type": "Text",
14134             "optional": true,
14135             "field": "attachment",
14136             "description": ""
14137           },
14138           {
14139             "group": "Body",
14140             "type": "Text",
14141             "optional": true,
14142             "field": "html",
14143             "description": ""
14144           },
14145           {
14146             "group": "Body",
14147             "type": "Text",
14148             "optional": true,
14149             "field": "text",
14150             "description": ""
14151           },
14152           {
14153             "group": "Body",
14154             "type": "String",
14155             "allowedValues": [
14156               "\"SENT\"",
14157               "\"SENDING\"",
14158               "\"RECEIVED\"",
14159               "\"FAILED\""
14160             ],
14161             "optional": true,
14162             "field": "status",
14163             "description": ""
14164           },
14165           {
14166             "group": "Body",
14167             "type": "String",
14168             "optional": true,
14169             "field": "url",
14170             "description": ""
14171           },
14172           {
14173             "group": "Body",
14174             "type": "String",
14175             "optional": true,
14176             "field": "app",
14177             "description": ""
14178           },
14179           {
14180             "group": "Body",
14181             "type": "String",
14182             "optional": true,
14183             "field": "appdata",
14184             "description": ""
14185           },
14186           {
14187             "group": "Body",
14188             "type": "Integer",
14189             "optional": true,
14190             "field": "projectId",
14191             "description": ""
14192           }
14193         ]
14194       }
14195     },
14196     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14197     "version": "0.0.0",
14198     "filename": "server/api/integrationReport/index.js",
14199     "groupTitle": "Integration_Reports"
14200   },
14201   {
14202     "type": "delete",
14203     "url": "/api/integrations/reports/{id}",
14204     "title": "Deletes a Integration Report",
14205     "examples": [
14206       {
14207         "title": "Example usage:",
14208         "content": "curl https://{domain}/api/integrations/reports/{id} -v -u {name}:{password} -X DELETE",
14209         "type": "json"
14210       }
14211     ],
14212     "name": "DeleteIntegration_Reports",
14213     "group": "Integration_Reports",
14214     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14215     "version": "0.0.0",
14216     "filename": "server/api/integrationReport/index.js",
14217     "groupTitle": "Integration_Reports"
14218   },
14219   {
14220     "type": "get",
14221     "url": "/api/integrations/reports/describe",
14222     "title": "Gets table info about Integration Reports",
14223     "examples": [
14224       {
14225         "title": "Example usage:",
14226         "content": "curl https://{domain}/api/integrations/reports/describe -v -u {name}:{password}",
14227         "type": "json"
14228       }
14229     ],
14230     "name": "DescribeIntegration_Reports",
14231     "group": "Integration_Reports",
14232     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14233     "version": "0.0.0",
14234     "filename": "server/api/integrationReport/index.js",
14235     "groupTitle": "Integration_Reports"
14236   },
14237   {
14238     "type": "get",
14239     "url": "/api/integrations/reports",
14240     "title": "Gets a list of Integration Reports",
14241     "examples": [
14242       {
14243         "title": "Example usage:",
14244         "content": "curl https://{domain}/api/integrations/reports -v -u {name}:{password}",
14245         "type": "json"
14246       }
14247     ],
14248     "name": "GetIntegration_Reports",
14249     "group": "Integration_Reports",
14250     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/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>",
14251     "version": "0.0.0",
14252     "filename": "server/api/integrationReport/index.js",
14253     "groupTitle": "Integration_Reports"
14254   },
14255   {
14256     "type": "get",
14257     "url": "/api/integrations/reports/{id}",
14258     "title": "Gets a single Integration Report",
14259     "examples": [
14260       {
14261         "title": "Example usage:",
14262         "content": "curl https://{domain}/api/integrations/reports/{id} -v -u {name}:{password}",
14263         "type": "json"
14264       }
14265     ],
14266     "name": "ShowIntegration_Reports",
14267     "group": "Integration_Reports",
14268     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14269     "version": "0.0.0",
14270     "filename": "server/api/integrationReport/index.js",
14271     "groupTitle": "Integration_Reports"
14272   },
14273   {
14274     "type": "put",
14275     "url": "/api/integrations/reports/{id}",
14276     "title": "Update an existing Integration Report",
14277     "examples": [
14278       {
14279         "title": "Example usage:",
14280         "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",
14281         "type": "json"
14282       }
14283     ],
14284     "name": "updateIntegration_Reports",
14285     "group": "Integration_Reports",
14286     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14287     "version": "0.0.0",
14288     "filename": "server/api/integrationReport/index.js",
14289     "groupTitle": "Integration_Reports"
14290   },
14291   {
14292     "type": "post",
14293     "url": "/api/intervals",
14294     "title": "Creates a new Interval",
14295     "examples": [
14296       {
14297         "title": "Example usage:",
14298         "content": "curl https://{domain}/api/intervals -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
14299         "type": "json"
14300       }
14301     ],
14302     "name": "CreateIntervals",
14303     "group": "Intervals",
14304     "parameter": {
14305       "fields": {
14306         "Body": [
14307           {
14308             "group": "Body",
14309             "type": "String",
14310             "optional": true,
14311             "field": "name",
14312             "description": ""
14313           },
14314           {
14315             "group": "Body",
14316             "type": "String",
14317             "optional": true,
14318             "field": "description",
14319             "description": ""
14320           },
14321           {
14322             "group": "Body",
14323             "type": "String",
14324             "optional": true,
14325             "field": "interval",
14326             "description": ""
14327           }
14328         ]
14329       }
14330     },
14331     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14332     "version": "0.0.0",
14333     "filename": "server/api/interval/index.js",
14334     "groupTitle": "Intervals"
14335   },
14336   {
14337     "type": "delete",
14338     "url": "/api/intervals/{id}",
14339     "title": "Deletes a Interval",
14340     "examples": [
14341       {
14342         "title": "Example usage:",
14343         "content": "curl https://{domain}/api/intervals/{id} -v -u {name}:{password} -X DELETE",
14344         "type": "json"
14345       }
14346     ],
14347     "name": "DeleteIntervals",
14348     "group": "Intervals",
14349     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14350     "version": "0.0.0",
14351     "filename": "server/api/interval/index.js",
14352     "groupTitle": "Intervals"
14353   },
14354   {
14355     "type": "get",
14356     "url": "/api/intervals",
14357     "title": "Gets a list of Intervals",
14358     "examples": [
14359       {
14360         "title": "Example usage:",
14361         "content": "curl https://{domain}/api/intervals -v -u {name}:{password}",
14362         "type": "json"
14363       }
14364     ],
14365     "name": "GetIntervals",
14366     "group": "Intervals",
14367     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
14368     "version": "0.0.0",
14369     "filename": "server/api/interval/index.js",
14370     "groupTitle": "Intervals"
14371   },
14372   {
14373     "type": "get",
14374     "url": "/api/intervals/{id}",
14375     "title": "Gets a single Interval",
14376     "examples": [
14377       {
14378         "title": "Example usage:",
14379         "content": "curl https://{domain}/api/intervals/{id} -v -u {name}:{password}",
14380         "type": "json"
14381       }
14382     ],
14383     "name": "ShowIntervals",
14384     "group": "Intervals",
14385     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14386     "version": "0.0.0",
14387     "filename": "server/api/interval/index.js",
14388     "groupTitle": "Intervals"
14389   },
14390   {
14391     "type": "post",
14392     "url": "/api/intervals/{id}/sub_intervals",
14393     "title": "Creates a new sub interval",
14394     "examples": [
14395       {
14396         "title": "Example usage:",
14397         "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",
14398         "type": "json"
14399       }
14400     ],
14401     "name": "addInterval",
14402     "group": "Intervals",
14403     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14404     "version": "0.0.0",
14405     "filename": "server/api/interval/index.js",
14406     "groupTitle": "Intervals"
14407   },
14408   {
14409     "type": "post",
14410     "url": "/api/intervals/{id}/sub_intervals/create_many",
14411     "title": "Create new sub intervals set",
14412     "examples": [
14413       {
14414         "title": "Example usage:",
14415         "content": "curl https://{domain}/api/intervals/{id}/sub_intervals -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
14416         "type": "json"
14417       }
14418     ],
14419     "name": "addIntervals",
14420     "group": "Intervals",
14421     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14422     "version": "0.0.0",
14423     "filename": "server/api/interval/index.js",
14424     "groupTitle": "Intervals"
14425   },
14426   {
14427     "type": "get",
14428     "url": "/api/intervals/{id}/sub_intervals",
14429     "title": "Get sub intervals set",
14430     "examples": [
14431       {
14432         "title": "Example usage:",
14433         "content": "curl https://{domain}/api/intervals/{id}/sub_intervals -v -u {name}:{password} -X GET",
14434         "type": "json"
14435       }
14436     ],
14437     "name": "getIntervals",
14438     "group": "Intervals",
14439     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14440     "version": "0.0.0",
14441     "filename": "server/api/interval/index.js",
14442     "groupTitle": "Intervals"
14443   },
14444   {
14445     "type": "put",
14446     "url": "/api/intervals/{id}",
14447     "title": "Update an existing Interval",
14448     "examples": [
14449       {
14450         "title": "Example usage:",
14451         "content": "curl https://{domain}/api/intervals/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
14452         "type": "json"
14453       }
14454     ],
14455     "name": "updateIntervals",
14456     "group": "Intervals",
14457     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14458     "version": "0.0.0",
14459     "filename": "server/api/interval/index.js",
14460     "groupTitle": "Intervals"
14461   },
14462   {
14463     "type": "post",
14464     "url": "/api/jira",
14465     "title": "Creates a new issue",
14466     "examples": [
14467       {
14468         "title": "Example usage:",
14469         "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}",
14470         "type": "json"
14471       }
14472     ],
14473     "name": "Creates_Issue",
14474     "group": "Issue",
14475     "parameter": {
14476       "fields": {
14477         "Body": [
14478           {
14479             "group": "Body",
14480             "type": "String",
14481             "allowedValues": [
14482               "\"Bug\""
14483             ],
14484             "optional": true,
14485             "field": "issuetype",
14486             "description": ""
14487           },
14488           {
14489             "group": "Body",
14490             "type": "String",
14491             "optional": false,
14492             "field": "summary",
14493             "description": ""
14494           },
14495           {
14496             "group": "Body",
14497             "type": "String",
14498             "optional": false,
14499             "field": "description",
14500             "description": ""
14501           }
14502         ]
14503       }
14504     },
14505     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14506     "version": "0.0.0",
14507     "filename": "server/api/jira/index.js",
14508     "groupTitle": "Issue"
14509   },
14510   {
14511     "type": "post",
14512     "url": "/api/jscripty/answers/reports",
14513     "title": "Creates a new Report",
14514     "examples": [
14515       {
14516         "title": "Example usage:",
14517         "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",
14518         "type": "json"
14519       }
14520     ],
14521     "name": "CreateReports",
14522     "group": "JscriptyAnswerReport",
14523     "parameter": {
14524       "fields": {
14525         "Body": [
14526           {
14527             "group": "Body",
14528             "type": "Text",
14529             "optional": true,
14530             "field": "question",
14531             "description": ""
14532           },
14533           {
14534             "group": "Body",
14535             "type": "Text",
14536             "optional": true,
14537             "field": "answer",
14538             "description": ""
14539           },
14540           {
14541             "group": "Body",
14542             "type": "String",
14543             "optional": true,
14544             "field": "membername",
14545             "description": ""
14546           },
14547           {
14548             "group": "Body",
14549             "type": "String",
14550             "optional": true,
14551             "field": "projectname",
14552             "description": ""
14553           },
14554           {
14555             "group": "Body",
14556             "type": "String",
14557             "optional": true,
14558             "field": "queue",
14559             "description": ""
14560           },
14561           {
14562             "group": "Body",
14563             "type": "String",
14564             "optional": true,
14565             "field": "uniqueid",
14566             "description": ""
14567           },
14568           {
14569             "group": "Body",
14570             "type": "String",
14571             "optional": true,
14572             "field": "calleridname",
14573             "description": ""
14574           },
14575           {
14576             "group": "Body",
14577             "type": "String",
14578             "optional": true,
14579             "field": "calleridnum",
14580             "description": ""
14581           },
14582           {
14583             "group": "Body",
14584             "type": "String",
14585             "optional": true,
14586             "field": "questionId",
14587             "description": ""
14588           }
14589         ]
14590       }
14591     },
14592     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14593     "version": "0.0.0",
14594     "filename": "server/api/jscriptyAnswerReport/index.js",
14595     "groupTitle": "JscriptyAnswerReport"
14596   },
14597   {
14598     "type": "delete",
14599     "url": "/api/jscripty/answers/reports/{id}",
14600     "title": "Deletes a Report",
14601     "examples": [
14602       {
14603         "title": "Example usage:",
14604         "content": "curl https://{domain}/api/jscripty/answers/reports/{id} -v -u {name}:{password} -X DELETE",
14605         "type": "json"
14606       }
14607     ],
14608     "name": "DeleteReports",
14609     "group": "JscriptyAnswerReport",
14610     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14611     "version": "0.0.0",
14612     "filename": "server/api/jscriptyAnswerReport/index.js",
14613     "groupTitle": "JscriptyAnswerReport"
14614   },
14615   {
14616     "type": "get",
14617     "url": "/api/jscripty/answers/reports/describe",
14618     "title": "Gets table info about Reports",
14619     "examples": [
14620       {
14621         "title": "Example usage:",
14622         "content": "curl https://{domain}/api/jscripty/answers/reports/describe -v -u {name}:{password}",
14623         "type": "json"
14624       }
14625     ],
14626     "name": "DescribeReports",
14627     "group": "JscriptyAnswerReport",
14628     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14629     "version": "0.0.0",
14630     "filename": "server/api/jscriptyAnswerReport/index.js",
14631     "groupTitle": "JscriptyAnswerReport"
14632   },
14633   {
14634     "type": "get",
14635     "url": "/api/jscripty/answers/reports",
14636     "title": "Gets a list of Reports",
14637     "examples": [
14638       {
14639         "title": "Example usage:",
14640         "content": "curl https://{domain}/api/jscripty/answers/reports -v -u {name}:{password}",
14641         "type": "json"
14642       }
14643     ],
14644     "name": "GetReports",
14645     "group": "JscriptyAnswerReport",
14646     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
14647     "version": "0.0.0",
14648     "filename": "server/api/jscriptyAnswerReport/index.js",
14649     "groupTitle": "JscriptyAnswerReport"
14650   },
14651   {
14652     "type": "get",
14653     "url": "/api/jscripty/answers/reports/{id}",
14654     "title": "Gets a single Report",
14655     "examples": [
14656       {
14657         "title": "Example usage:",
14658         "content": "curl https://{domain}/api/jscripty/answers/reports/{id} -v -u {name}:{password}",
14659         "type": "json"
14660       }
14661     ],
14662     "name": "ShowReports",
14663     "group": "JscriptyAnswerReport",
14664     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14665     "version": "0.0.0",
14666     "filename": "server/api/jscriptyAnswerReport/index.js",
14667     "groupTitle": "JscriptyAnswerReport"
14668   },
14669   {
14670     "type": "put",
14671     "url": "/api/jscripty/answers/reports/{id}",
14672     "title": "Update an existing Report",
14673     "examples": [
14674       {
14675         "title": "Example usage:",
14676         "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",
14677         "type": "json"
14678       }
14679     ],
14680     "name": "updateReports",
14681     "group": "JscriptyAnswerReport",
14682     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14683     "version": "0.0.0",
14684     "filename": "server/api/jscriptyAnswerReport/index.js",
14685     "groupTitle": "JscriptyAnswerReport"
14686   },
14687   {
14688     "type": "post",
14689     "url": "/api/jscripty/questions/reports",
14690     "title": "Creates a new Report",
14691     "examples": [
14692       {
14693         "title": "Example usage:",
14694         "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",
14695         "type": "json"
14696       }
14697     ],
14698     "name": "CreateReports",
14699     "group": "JscriptyQuestionReport",
14700     "parameter": {
14701       "fields": {
14702         "Body": [
14703           {
14704             "group": "Body",
14705             "type": "Text",
14706             "optional": true,
14707             "field": "question",
14708             "description": ""
14709           },
14710           {
14711             "group": "Body",
14712             "type": "Text",
14713             "optional": true,
14714             "field": "answer",
14715             "description": ""
14716           },
14717           {
14718             "group": "Body",
14719             "type": "String",
14720             "optional": true,
14721             "field": "membername",
14722             "description": ""
14723           },
14724           {
14725             "group": "Body",
14726             "type": "String",
14727             "optional": true,
14728             "field": "projectname",
14729             "description": ""
14730           },
14731           {
14732             "group": "Body",
14733             "type": "String",
14734             "optional": true,
14735             "field": "queue",
14736             "description": ""
14737           },
14738           {
14739             "group": "Body",
14740             "type": "String",
14741             "optional": true,
14742             "field": "uniqueid",
14743             "description": ""
14744           },
14745           {
14746             "group": "Body",
14747             "type": "String",
14748             "optional": true,
14749             "field": "calleridname",
14750             "description": ""
14751           },
14752           {
14753             "group": "Body",
14754             "type": "String",
14755             "optional": true,
14756             "field": "calleridnum",
14757             "description": ""
14758           },
14759           {
14760             "group": "Body",
14761             "type": "String",
14762             "optional": true,
14763             "field": "questionId",
14764             "description": ""
14765           }
14766         ]
14767       }
14768     },
14769     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14770     "version": "0.0.0",
14771     "filename": "server/api/jscriptyQuestionReport/index.js",
14772     "groupTitle": "JscriptyQuestionReport"
14773   },
14774   {
14775     "type": "delete",
14776     "url": "/api/jscripty/questions/reports/{id}",
14777     "title": "Deletes a Report",
14778     "examples": [
14779       {
14780         "title": "Example usage:",
14781         "content": "curl https://{domain}/api/jscripty/questions/reports/{id} -v -u {name}:{password} -X DELETE",
14782         "type": "json"
14783       }
14784     ],
14785     "name": "DeleteReports",
14786     "group": "JscriptyQuestionReport",
14787     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14788     "version": "0.0.0",
14789     "filename": "server/api/jscriptyQuestionReport/index.js",
14790     "groupTitle": "JscriptyQuestionReport"
14791   },
14792   {
14793     "type": "get",
14794     "url": "/api/jscripty/questions/reports/describe",
14795     "title": "Gets table info about Reports",
14796     "examples": [
14797       {
14798         "title": "Example usage:",
14799         "content": "curl https://{domain}/api/jscripty/questions/reports/describe -v -u {name}:{password}",
14800         "type": "json"
14801       }
14802     ],
14803     "name": "DescribeReports",
14804     "group": "JscriptyQuestionReport",
14805     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14806     "version": "0.0.0",
14807     "filename": "server/api/jscriptyQuestionReport/index.js",
14808     "groupTitle": "JscriptyQuestionReport"
14809   },
14810   {
14811     "type": "get",
14812     "url": "/api/jscripty/questions/reports",
14813     "title": "Gets a list of Reports",
14814     "examples": [
14815       {
14816         "title": "Example usage:",
14817         "content": "curl https://{domain}/api/jscripty/questions/reports -v -u {name}:{password}",
14818         "type": "json"
14819       }
14820     ],
14821     "name": "GetReports",
14822     "group": "JscriptyQuestionReport",
14823     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
14824     "version": "0.0.0",
14825     "filename": "server/api/jscriptyQuestionReport/index.js",
14826     "groupTitle": "JscriptyQuestionReport"
14827   },
14828   {
14829     "type": "get",
14830     "url": "/api/jscripty/questions/reports/{id}",
14831     "title": "Gets a single Report",
14832     "examples": [
14833       {
14834         "title": "Example usage:",
14835         "content": "curl https://{domain}/api/jscripty/questions/reports/{id} -v -u {name}:{password}",
14836         "type": "json"
14837       }
14838     ],
14839     "name": "ShowReports",
14840     "group": "JscriptyQuestionReport",
14841     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14842     "version": "0.0.0",
14843     "filename": "server/api/jscriptyQuestionReport/index.js",
14844     "groupTitle": "JscriptyQuestionReport"
14845   },
14846   {
14847     "type": "put",
14848     "url": "/api/jscripty/questions/reports/{id}",
14849     "title": "Update an existing Report",
14850     "examples": [
14851       {
14852         "title": "Example usage:",
14853         "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",
14854         "type": "json"
14855       }
14856     ],
14857     "name": "updateReports",
14858     "group": "JscriptyQuestionReport",
14859     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14860     "version": "0.0.0",
14861     "filename": "server/api/jscriptyQuestionReport/index.js",
14862     "groupTitle": "JscriptyQuestionReport"
14863   },
14864   {
14865     "type": "post",
14866     "url": "/api/jscripty/sessions/reports",
14867     "title": "Creates a new Report",
14868     "examples": [
14869       {
14870         "title": "Example usage:",
14871         "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",
14872         "type": "json"
14873       }
14874     ],
14875     "name": "CreateReports",
14876     "group": "JscriptySessionReport",
14877     "parameter": {
14878       "fields": {
14879         "Body": [
14880           {
14881             "group": "Body",
14882             "type": "String",
14883             "optional": true,
14884             "field": "starttime",
14885             "description": ""
14886           },
14887           {
14888             "group": "Body",
14889             "type": "String",
14890             "optional": true,
14891             "field": "endtime",
14892             "description": ""
14893           },
14894           {
14895             "group": "Body",
14896             "type": "String",
14897             "optional": true,
14898             "field": "membername",
14899             "description": ""
14900           },
14901           {
14902             "group": "Body",
14903             "type": "String",
14904             "optional": true,
14905             "field": "projectname",
14906             "description": ""
14907           },
14908           {
14909             "group": "Body",
14910             "type": "String",
14911             "optional": true,
14912             "field": "queue",
14913             "description": ""
14914           },
14915           {
14916             "group": "Body",
14917             "type": "String",
14918             "optional": true,
14919             "field": "uniqueid",
14920             "description": ""
14921           },
14922           {
14923             "group": "Body",
14924             "type": "String",
14925             "optional": true,
14926             "field": "calleridname",
14927             "description": ""
14928           },
14929           {
14930             "group": "Body",
14931             "type": "String",
14932             "optional": true,
14933             "field": "calleridnum",
14934             "description": ""
14935           },
14936           {
14937             "group": "Body",
14938             "type": "Boolean",
14939             "optional": true,
14940             "field": "completed",
14941             "description": ""
14942           }
14943         ]
14944       }
14945     },
14946     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14947     "version": "0.0.0",
14948     "filename": "server/api/jscriptySessionReport/index.js",
14949     "groupTitle": "JscriptySessionReport"
14950   },
14951   {
14952     "type": "delete",
14953     "url": "/api/jscripty/sessions/reports/{id}",
14954     "title": "Deletes a Report",
14955     "examples": [
14956       {
14957         "title": "Example usage:",
14958         "content": "curl https://{domain}/api/jscripty/sessions/reports/{id} -v -u {name}:{password} -X DELETE",
14959         "type": "json"
14960       }
14961     ],
14962     "name": "DeleteReports",
14963     "group": "JscriptySessionReport",
14964     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14965     "version": "0.0.0",
14966     "filename": "server/api/jscriptySessionReport/index.js",
14967     "groupTitle": "JscriptySessionReport"
14968   },
14969   {
14970     "type": "get",
14971     "url": "/api/jscripty/sessions/reports/describe",
14972     "title": "Gets table info about Reports",
14973     "examples": [
14974       {
14975         "title": "Example usage:",
14976         "content": "curl https://{domain}/api/jscripty/sessions/reports/describe -v -u {name}:{password}",
14977         "type": "json"
14978       }
14979     ],
14980     "name": "DescribeReports",
14981     "group": "JscriptySessionReport",
14982     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14983     "version": "0.0.0",
14984     "filename": "server/api/jscriptySessionReport/index.js",
14985     "groupTitle": "JscriptySessionReport"
14986   },
14987   {
14988     "type": "get",
14989     "url": "/api/jscripty/sessions/reports",
14990     "title": "Gets a list of Reports",
14991     "examples": [
14992       {
14993         "title": "Example usage:",
14994         "content": "curl https://{domain}/api/jscripty/sessions/reports -v -u {name}:{password}",
14995         "type": "json"
14996       }
14997     ],
14998     "name": "GetReports",
14999     "group": "JscriptySessionReport",
15000     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
15001     "version": "0.0.0",
15002     "filename": "server/api/jscriptySessionReport/index.js",
15003     "groupTitle": "JscriptySessionReport"
15004   },
15005   {
15006     "type": "get",
15007     "url": "/api/jscripty/sessions/reports/{id}",
15008     "title": "Gets a single Report",
15009     "examples": [
15010       {
15011         "title": "Example usage:",
15012         "content": "curl https://{domain}/api/jscripty/sessions/reports/{id} -v -u {name}:{password}",
15013         "type": "json"
15014       }
15015     ],
15016     "name": "ShowReports",
15017     "group": "JscriptySessionReport",
15018     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15019     "version": "0.0.0",
15020     "filename": "server/api/jscriptySessionReport/index.js",
15021     "groupTitle": "JscriptySessionReport"
15022   },
15023   {
15024     "type": "get",
15025     "url": "/api/jscripty/sessions/reports/{id}/questions",
15026     "title": "Gets Jscripty Session questions",
15027     "examples": [
15028       {
15029         "title": "Example usage:",
15030         "content": "curl https://{domain}/api/jscripty/sessions/reports/{id}/questions -v -u {name}:{password}  -X GET",
15031         "type": "json"
15032       }
15033     ],
15034     "name": "getQuestions",
15035     "group": "JscriptySessionReport",
15036     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15037     "version": "0.0.0",
15038     "filename": "server/api/jscriptySessionReport/index.js",
15039     "groupTitle": "JscriptySessionReport"
15040   },
15041   {
15042     "type": "put",
15043     "url": "/api/jscripty/sessions/reports/{id}",
15044     "title": "Update an existing Report",
15045     "examples": [
15046       {
15047         "title": "Example usage:",
15048         "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",
15049         "type": "json"
15050       }
15051     ],
15052     "name": "updateReports",
15053     "group": "JscriptySessionReport",
15054     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15055     "version": "0.0.0",
15056     "filename": "server/api/jscriptySessionReport/index.js",
15057     "groupTitle": "JscriptySessionReport"
15058   },
15059   {
15060     "type": "post",
15061     "url": "/api/jscripty/projects/clone",
15062     "title": "Clone an existing Project",
15063     "examples": [
15064       {
15065         "title": "Example usage:",
15066         "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",
15067         "type": "json"
15068       }
15069     ],
15070     "name": "CloneProjects",
15071     "group": "Jscripty_Projects",
15072     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15073     "version": "0.0.0",
15074     "filename": "server/api/jscriptyProject/index.js",
15075     "groupTitle": "Jscripty_Projects"
15076   },
15077   {
15078     "type": "post",
15079     "url": "/api/jscripty/projects",
15080     "title": "Creates a new Project",
15081     "examples": [
15082       {
15083         "title": "Example usage:",
15084         "content": "curl https://{domain}/api/jscripty/projects -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
15085         "type": "json"
15086       }
15087     ],
15088     "name": "CreateProjects",
15089     "group": "Jscripty_Projects",
15090     "parameter": {
15091       "fields": {
15092         "Body": [
15093           {
15094             "group": "Body",
15095             "type": "String",
15096             "optional": true,
15097             "field": "name",
15098             "description": ""
15099           },
15100           {
15101             "group": "Body",
15102             "type": "String",
15103             "optional": true,
15104             "field": "description",
15105             "description": ""
15106           },
15107           {
15108             "group": "Body",
15109             "type": "Text",
15110             "optional": true,
15111             "field": "formData",
15112             "description": ""
15113           },
15114           {
15115             "group": "Body",
15116             "type": "Boolean",
15117             "optional": true,
15118             "field": "enableUncompleteSave",
15119             "description": ""
15120           },
15121           {
15122             "group": "Body",
15123             "type": "Boolean",
15124             "optional": true,
15125             "field": "sendUnpauseOnSubmit",
15126             "description": ""
15127           }
15128         ]
15129       }
15130     },
15131     "description": "<p>Motion will return a HTTP status code <code>201</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/jscriptyProject/index.js",
15134     "groupTitle": "Jscripty_Projects"
15135   },
15136   {
15137     "type": "delete",
15138     "url": "/api/jscripty/projects/{id}",
15139     "title": "Deletes a Project",
15140     "examples": [
15141       {
15142         "title": "Example usage:",
15143         "content": "curl https://{domain}/api/jscripty/projects/{id} -v -u {name}:{password} -X DELETE",
15144         "type": "json"
15145       }
15146     ],
15147     "name": "DeleteProjects",
15148     "group": "Jscripty_Projects",
15149     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15150     "version": "0.0.0",
15151     "filename": "server/api/jscriptyProject/index.js",
15152     "groupTitle": "Jscripty_Projects"
15153   },
15154   {
15155     "type": "get",
15156     "url": "/api/jscripty/projects",
15157     "title": "Gets a list of Projects",
15158     "examples": [
15159       {
15160         "title": "Example usage:",
15161         "content": "curl https://{domain}/api/jscripty/projects -v -u {name}:{password}",
15162         "type": "json"
15163       }
15164     ],
15165     "name": "GetProjects",
15166     "group": "Jscripty_Projects",
15167     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
15168     "version": "0.0.0",
15169     "filename": "server/api/jscriptyProject/index.js",
15170     "groupTitle": "Jscripty_Projects"
15171   },
15172   {
15173     "type": "get",
15174     "url": "/api/jscripty/projects/{id}",
15175     "title": "Gets a single Project",
15176     "examples": [
15177       {
15178         "title": "Example usage:",
15179         "content": "curl https://{domain}/api/jscripty/projects/{id} -v -u {name}:{password}",
15180         "type": "json"
15181       }
15182     ],
15183     "name": "ShowProjects",
15184     "group": "Jscripty_Projects",
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/jscriptyProject/index.js",
15188     "groupTitle": "Jscripty_Projects"
15189   },
15190   {
15191     "type": "get",
15192     "url": "/api/jscripty/projects/{id}/answers",
15193     "title": "Gets jscripty project answers",
15194     "examples": [
15195       {
15196         "title": "Example usage:",
15197         "content": "curl https://{domain}/api/jscripty/projects/{id}/answers -v -u {name}:{password}  -X GET",
15198         "type": "json"
15199       }
15200     ],
15201     "name": "getAnswers",
15202     "group": "Jscripty_Projects",
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/jscriptyProject/index.js",
15206     "groupTitle": "Jscripty_Projects"
15207   },
15208   {
15209     "type": "get",
15210     "url": "/api/jscripty/projects/{id}/sessions",
15211     "title": "Gets jscripty project sessions",
15212     "examples": [
15213       {
15214         "title": "Example usage:",
15215         "content": "curl https://{domain}/api/jscripty/projects/{id}/sessions -v -u {name}:{password}  -X GET",
15216         "type": "json"
15217       }
15218     ],
15219     "name": "getSessions",
15220     "group": "Jscripty_Projects",
15221     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <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/jscriptyProject/index.js",
15224     "groupTitle": "Jscripty_Projects"
15225   },
15226   {
15227     "type": "get",
15228     "url": "/api/jscripty/projects/{id}/summary",
15229     "title": "Gets jscripty project summary",
15230     "examples": [
15231       {
15232         "title": "Example usage:",
15233         "content": "curl https://{domain}/api/jscripty/projects/{id}/summary -v -u {name}:{password}  -X GET",
15234         "type": "json"
15235       }
15236     ],
15237     "name": "getSummary",
15238     "group": "Jscripty_Projects",
15239     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <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/jscriptyProject/index.js",
15242     "groupTitle": "Jscripty_Projects"
15243   },
15244   {
15245     "type": "put",
15246     "url": "/api/jscripty/projects/{id}",
15247     "title": "Update an existing Project",
15248     "examples": [
15249       {
15250         "title": "Example usage:",
15251         "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",
15252         "type": "json"
15253       }
15254     ],
15255     "name": "updateProjects",
15256     "group": "Jscripty_Projects",
15257     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <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/jscriptyProject/index.js",
15260     "groupTitle": "Jscripty_Projects"
15261   },
15262   {
15263     "type": "get",
15264     "url": "/api/license",
15265     "title": "Gets License Info",
15266     "examples": [
15267       {
15268         "title": "Example usage:",
15269         "content": "curl https://{domain}/api/license -v -u {name}:{password} -X GET",
15270         "type": "json"
15271       }
15272     ],
15273     "name": "index",
15274     "group": "License",
15275     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <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/license/index.js",
15278     "groupTitle": "License"
15279   },
15280   {
15281     "type": "put",
15282     "url": "/api/license/{id}",
15283     "title": "Update License Info",
15284     "examples": [
15285       {
15286         "title": "Example usage:",
15287         "content": "curl https://{domain}/api/license/{id} -v -u {name}:{password} -X PUT",
15288         "type": "json"
15289       }
15290     ],
15291     "name": "update",
15292     "group": "License",
15293     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <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/license/index.js",
15296     "groupTitle": "License"
15297   },
15298   {
15299     "type": "post",
15300     "url": "/api/mail/accounts/{id}/users",
15301     "title": "Add agents to a mail account",
15302     "examples": [
15303       {
15304         "title": "Example usage:",
15305         "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",
15306         "type": "json"
15307       }
15308     ],
15309     "name": "AddAgents",
15310     "group": "Mail_Accounts",
15311     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</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}/in_servers",
15319     "title": "Creates a new IMAP server",
15320     "examples": [
15321       {
15322         "title": "Example usage:",
15323         "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",
15324         "type": "json"
15325       }
15326     ],
15327     "name": "AddImap",
15328     "group": "Mail_Accounts",
15329     "parameter": {
15330       "fields": {
15331         "Body": [
15332           {
15333             "group": "Body",
15334             "type": "String",
15335             "optional": true,
15336             "field": "description",
15337             "description": ""
15338           },
15339           {
15340             "group": "Body",
15341             "type": "String",
15342             "optional": true,
15343             "field": "host",
15344             "description": ""
15345           },
15346           {
15347             "group": "Body",
15348             "type": "Boolean",
15349             "optional": true,
15350             "field": "authentication",
15351             "description": ""
15352           },
15353           {
15354             "group": "Body",
15355             "type": "String",
15356             "optional": true,
15357             "field": "user",
15358             "description": ""
15359           },
15360           {
15361             "group": "Body",
15362             "type": "String",
15363             "optional": true,
15364             "field": "password",
15365             "description": ""
15366           },
15367           {
15368             "group": "Body",
15369             "type": "Integer",
15370             "optional": true,
15371             "field": "port",
15372             "description": ""
15373           },
15374           {
15375             "group": "Body",
15376             "type": "Boolean",
15377             "optional": true,
15378             "field": "tls",
15379             "description": ""
15380           },
15381           {
15382             "group": "Body",
15383             "type": "String",
15384             "optional": true,
15385             "field": "mailbox",
15386             "description": ""
15387           },
15388           {
15389             "group": "Body",
15390             "type": "Integer",
15391             "optional": true,
15392             "field": "connTimeout",
15393             "description": ""
15394           },
15395           {
15396             "group": "Body",
15397             "type": "Integer",
15398             "optional": true,
15399             "field": "authTimeout",
15400             "description": ""
15401           },
15402           {
15403             "group": "Body",
15404             "type": "String",
15405             "optional": true,
15406             "field": "service",
15407             "description": ""
15408           }
15409         ]
15410       }
15411     },
15412     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15413     "version": "0.0.0",
15414     "filename": "server/api/mailAccount/index.js",
15415     "groupTitle": "Mail_Accounts"
15416   },
15417   {
15418     "type": "post",
15419     "url": "/api/mail/accounts/{id}/out_servers",
15420     "title": "Creates a new SMTP server",
15421     "examples": [
15422       {
15423         "title": "Example usage:",
15424         "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",
15425         "type": "json"
15426       }
15427     ],
15428     "name": "AddSmtp",
15429     "group": "Mail_Accounts",
15430     "parameter": {
15431       "fields": {
15432         "Body": [
15433           {
15434             "group": "Body",
15435             "type": "String",
15436             "optional": true,
15437             "field": "description",
15438             "description": ""
15439           },
15440           {
15441             "group": "Body",
15442             "type": "String",
15443             "optional": true,
15444             "field": "host",
15445             "description": ""
15446           },
15447           {
15448             "group": "Body",
15449             "type": "String",
15450             "optional": true,
15451             "field": "user",
15452             "description": ""
15453           },
15454           {
15455             "group": "Body",
15456             "type": "String",
15457             "optional": true,
15458             "field": "pass",
15459             "description": ""
15460           },
15461           {
15462             "group": "Body",
15463             "type": "Integer",
15464             "optional": true,
15465             "field": "port",
15466             "description": ""
15467           },
15468           {
15469             "group": "Body",
15470             "type": "Boolean",
15471             "optional": true,
15472             "field": "secure",
15473             "description": ""
15474           },
15475           {
15476             "group": "Body",
15477             "type": "String",
15478             "optional": true,
15479             "field": "service",
15480             "description": ""
15481           },
15482           {
15483             "group": "Body",
15484             "type": "Boolean",
15485             "optional": true,
15486             "field": "authentication",
15487             "description": ""
15488           }
15489         ]
15490       }
15491     },
15492     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15493     "version": "0.0.0",
15494     "filename": "server/api/mailAccount/index.js",
15495     "groupTitle": "Mail_Accounts"
15496   },
15497   {
15498     "type": "delete",
15499     "url": "/api/mail/accounts/{id}",
15500     "title": "Deletes a mail account",
15501     "examples": [
15502       {
15503         "title": "Example usage:",
15504         "content": "curl https://{domain}/api/mail/accounts/{id} -v -u {name}:{password} -X DELETE",
15505         "type": "json"
15506       }
15507     ],
15508     "name": "DeleteMailAccounts",
15509     "group": "Mail_Accounts",
15510     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15511     "version": "0.0.0",
15512     "filename": "server/api/mailAccount/index.js",
15513     "groupTitle": "Mail_Accounts"
15514   },
15515   {
15516     "type": "get",
15517     "url": "/api/mail/accounts/describe",
15518     "title": "Gets table info about Accounts",
15519     "examples": [
15520       {
15521         "title": "Example usage:",
15522         "content": "curl https://{domain}/api/mail/accounts/describe -v -u {name}:{password}",
15523         "type": "json"
15524       }
15525     ],
15526     "name": "DescribeAccounts",
15527     "group": "Mail_Accounts",
15528     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15529     "version": "0.0.0",
15530     "filename": "server/api/mailAccount/index.js",
15531     "groupTitle": "Mail_Accounts"
15532   },
15533   {
15534     "type": "get",
15535     "url": "/api/mail/accounts",
15536     "title": "Gets a list of Accounts",
15537     "examples": [
15538       {
15539         "title": "Example usage:",
15540         "content": "curl https://{domain}/api/mail/accounts -v -u {name}:{password}",
15541         "type": "json"
15542       }
15543     ],
15544     "name": "GetAccounts",
15545     "group": "Mail_Accounts",
15546     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
15547     "version": "0.0.0",
15548     "filename": "server/api/mailAccount/index.js",
15549     "groupTitle": "Mail_Accounts"
15550   },
15551   {
15552     "type": "get",
15553     "url": "/api/mail/accounts/{id}/users",
15554     "title": "Gets agents from mail account",
15555     "examples": [
15556       {
15557         "title": "Example usage:",
15558         "content": "curl https://{domain}/api/mail/accounts/{id}/users -v -u {name}:{password} -X GET",
15559         "type": "json"
15560       }
15561     ],
15562     "name": "GetAgents",
15563     "group": "Mail_Accounts",
15564     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15565     "version": "0.0.0",
15566     "filename": "server/api/mailAccount/index.js",
15567     "groupTitle": "Mail_Accounts"
15568   },
15569   {
15570     "type": "get",
15571     "url": "/api/mail/accounts/{id}/in_servers",
15572     "title": "Gets account IMAP server",
15573     "examples": [
15574       {
15575         "title": "Example usage:",
15576         "content": "curl https://{domain}/api/mail/accounts/{id}/in_servers -v -u {name}:{password} -X GET",
15577         "type": "json"
15578       }
15579     ],
15580     "name": "GetImap",
15581     "group": "Mail_Accounts",
15582     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15583     "version": "0.0.0",
15584     "filename": "server/api/mailAccount/index.js",
15585     "groupTitle": "Mail_Accounts"
15586   },
15587   {
15588     "type": "get",
15589     "url": "/api/mail/accounts/{id}/out_servers",
15590     "title": "Gets account SMTP server",
15591     "examples": [
15592       {
15593         "title": "Example usage:",
15594         "content": "curl https://{domain}/api/mail/accounts/{id}/out_servers -v -u {name}:{password} -X GET",
15595         "type": "json"
15596       }
15597     ],
15598     "name": "GetSmtp",
15599     "group": "Mail_Accounts",
15600     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15601     "version": "0.0.0",
15602     "filename": "server/api/mailAccount/index.js",
15603     "groupTitle": "Mail_Accounts"
15604   },
15605   {
15606     "type": "delete",
15607     "url": "/api/mail/accounts/{id}/users",
15608     "title": "Removes agents from a mail account",
15609     "examples": [
15610       {
15611         "title": "Example usage:",
15612         "content": "curl https://{domain}/api/mail/accounts/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
15613         "type": "json"
15614       }
15615     ],
15616     "name": "RemoveAgents",
15617     "group": "Mail_Accounts",
15618     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15619     "version": "0.0.0",
15620     "filename": "server/api/mailAccount/index.js",
15621     "groupTitle": "Mail_Accounts"
15622   },
15623   {
15624     "type": "delete",
15625     "url": "/api/mail/accounts/{id}/canned_answers",
15626     "title": "Removes canned answers from account",
15627     "examples": [
15628       {
15629         "title": "Example usage:",
15630         "content": "curl https://{domain}/api/mail/accounts/{id}/canned_answers?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
15631         "type": "json"
15632       }
15633     ],
15634     "name": "RemoveAnswers",
15635     "group": "Mail_Accounts",
15636     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15637     "version": "0.0.0",
15638     "filename": "server/api/mailAccount/index.js",
15639     "groupTitle": "Mail_Accounts"
15640   },
15641   {
15642     "type": "delete",
15643     "url": "/api/mail/accounts/{id}/dispositions",
15644     "title": "Removes dispositions from account",
15645     "examples": [
15646       {
15647         "title": "Example usage:",
15648         "content": "curl https://{domain}/api/mail/accounts/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
15649         "type": "json"
15650       }
15651     ],
15652     "name": "RemoveDispositions",
15653     "group": "Mail_Accounts",
15654     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15655     "version": "0.0.0",
15656     "filename": "server/api/mailAccount/index.js",
15657     "groupTitle": "Mail_Accounts"
15658   },
15659   {
15660     "type": "delete",
15661     "url": "/api/mail/accounts/{id}/in_servers",
15662     "title": "Removes IMAP server from an account",
15663     "examples": [
15664       {
15665         "title": "Example usage:",
15666         "content": "curl https://{domain}/api/mail/accounts/{id}/in_servers -v -u {name}:{password} -X DELETE",
15667         "type": "json"
15668       }
15669     ],
15670     "name": "RemoveImmap",
15671     "group": "Mail_Accounts",
15672     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15673     "version": "0.0.0",
15674     "filename": "server/api/mailAccount/index.js",
15675     "groupTitle": "Mail_Accounts"
15676   },
15677   {
15678     "type": "delete",
15679     "url": "/api/mail/accounts/{id}/out_servers",
15680     "title": "Removes SMTP server from an account",
15681     "examples": [
15682       {
15683         "title": "Example usage:",
15684         "content": "curl https://{domain}/api/mail/accounts/{id}/out_servers -v -u {name}:{password} -X DELETE",
15685         "type": "json"
15686       }
15687     ],
15688     "name": "RemoveSmtp",
15689     "group": "Mail_Accounts",
15690     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15691     "version": "0.0.0",
15692     "filename": "server/api/mailAccount/index.js",
15693     "groupTitle": "Mail_Accounts"
15694   },
15695   {
15696     "type": "get",
15697     "url": "/api/mail/accounts/{id}",
15698     "title": "Gets a single Account",
15699     "examples": [
15700       {
15701         "title": "Example usage:",
15702         "content": "curl https://{domain}/api/mail/accounts/{id} -v -u {name}:{password}",
15703         "type": "json"
15704       }
15705     ],
15706     "name": "ShowAccounts",
15707     "group": "Mail_Accounts",
15708     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15709     "version": "0.0.0",
15710     "filename": "server/api/mailAccount/index.js",
15711     "groupTitle": "Mail_Accounts"
15712   },
15713   {
15714     "type": "post",
15715     "url": "/api/mail/accounts/{id}/canned_answers",
15716     "title": "Creates new canned answer",
15717     "examples": [
15718       {
15719         "title": "Example usage:",
15720         "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",
15721         "type": "json"
15722       }
15723     ],
15724     "name": "addAnswer",
15725     "group": "Mail_Accounts",
15726     "parameter": {
15727       "fields": {
15728         "Body": [
15729           {
15730             "group": "Body",
15731             "type": "String",
15732             "optional": false,
15733             "field": "key",
15734             "description": ""
15735           },
15736           {
15737             "group": "Body",
15738             "type": "Text",
15739             "optional": false,
15740             "field": "value",
15741             "description": ""
15742           },
15743           {
15744             "group": "Body",
15745             "type": "String",
15746             "optional": true,
15747             "field": "description",
15748             "description": ""
15749           },
15750           {
15751             "group": "Body",
15752             "type": "Virtual",
15753             "optional": true,
15754             "field": "name",
15755             "description": ""
15756           }
15757         ]
15758       }
15759     },
15760     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15761     "version": "0.0.0",
15762     "filename": "server/api/mailAccount/index.js",
15763     "groupTitle": "Mail_Accounts"
15764   },
15765   {
15766     "type": "post",
15767     "url": "/api/mail/accounts/{id}/applications",
15768     "title": "Creates new applications",
15769     "examples": [
15770       {
15771         "title": "Example usage:",
15772         "content": "curl https://{domain}/api/mail/accounts/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
15773         "type": "json"
15774       }
15775     ],
15776     "name": "addApplications",
15777     "group": "Mail_Accounts",
15778     "parameter": {
15779       "fields": {
15780         "Body": [
15781           {
15782             "group": "Body",
15783             "type": "Integer",
15784             "optional": false,
15785             "field": "priority",
15786             "description": ""
15787           },
15788           {
15789             "group": "Body",
15790             "type": "String",
15791             "optional": false,
15792             "field": "app",
15793             "description": ""
15794           },
15795           {
15796             "group": "Body",
15797             "type": "Text",
15798             "optional": true,
15799             "field": "appdata",
15800             "description": ""
15801           },
15802           {
15803             "group": "Body",
15804             "type": "String",
15805             "optional": true,
15806             "field": "description",
15807             "description": ""
15808           },
15809           {
15810             "group": "Body",
15811             "type": "String",
15812             "optional": true,
15813             "field": "interval",
15814             "description": ""
15815           }
15816         ]
15817       }
15818     },
15819     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15820     "version": "0.0.0",
15821     "filename": "server/api/mailAccount/index.js",
15822     "groupTitle": "Mail_Accounts"
15823   },
15824   {
15825     "type": "post",
15826     "url": "/api/mail/accounts/{id}/dispositions",
15827     "title": "Creates new disposition",
15828     "examples": [
15829       {
15830         "title": "Example usage:",
15831         "content": "curl https://{domain}/api/mail/accounts/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
15832         "type": "json"
15833       }
15834     ],
15835     "name": "addDisposition",
15836     "group": "Mail_Accounts",
15837     "parameter": {
15838       "fields": {
15839         "Body": [
15840           {
15841             "group": "Body",
15842             "type": "String",
15843             "optional": false,
15844             "field": "name",
15845             "description": ""
15846           },
15847           {
15848             "group": "Body",
15849             "type": "String",
15850             "allowedValues": [
15851               "\"first\"",
15852               "\"second\"",
15853               "\"third\""
15854             ],
15855             "optional": false,
15856             "field": "level",
15857             "description": ""
15858           },
15859           {
15860             "group": "Body",
15861             "type": "String",
15862             "optional": true,
15863             "field": "description",
15864             "description": ""
15865           }
15866         ]
15867       }
15868     },
15869     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15870     "version": "0.0.0",
15871     "filename": "server/api/mailAccount/index.js",
15872     "groupTitle": "Mail_Accounts"
15873   },
15874   {
15875     "type": "post",
15876     "url": "/api/mail/accounts/{id}/interactions",
15877     "title": "Creates new interactions",
15878     "examples": [
15879       {
15880         "title": "Example usage:",
15881         "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",
15882         "type": "json"
15883       }
15884     ],
15885     "name": "addInteraction",
15886     "group": "Mail_Accounts",
15887     "parameter": {
15888       "fields": {
15889         "Body": [
15890           {
15891             "group": "Body",
15892             "type": "Boolean",
15893             "optional": true,
15894             "field": "closed",
15895             "description": ""
15896           },
15897           {
15898             "group": "Body",
15899             "type": "String",
15900             "optional": true,
15901             "field": "closedAt",
15902             "description": ""
15903           },
15904           {
15905             "group": "Body",
15906             "type": "String",
15907             "optional": true,
15908             "field": "disposition",
15909             "description": ""
15910           },
15911           {
15912             "group": "Body",
15913             "type": "String",
15914             "optional": true,
15915             "field": "secondDisposition",
15916             "description": ""
15917           },
15918           {
15919             "group": "Body",
15920             "type": "String",
15921             "optional": true,
15922             "field": "thirdDisposition",
15923             "description": ""
15924           },
15925           {
15926             "group": "Body",
15927             "type": "String",
15928             "optional": true,
15929             "field": "note",
15930             "description": ""
15931           },
15932           {
15933             "group": "Body",
15934             "type": "String",
15935             "optional": true,
15936             "field": "inReplyTo",
15937             "description": ""
15938           },
15939           {
15940             "group": "Body",
15941             "type": "String",
15942             "optional": true,
15943             "field": "to",
15944             "description": ""
15945           },
15946           {
15947             "group": "Body",
15948             "type": "Text",
15949             "optional": true,
15950             "field": "cc",
15951             "description": ""
15952           },
15953           {
15954             "group": "Body",
15955             "type": "Text",
15956             "optional": true,
15957             "field": "subject",
15958             "description": ""
15959           },
15960           {
15961             "group": "Body",
15962             "type": "Boolean",
15963             "optional": true,
15964             "field": "attach",
15965             "description": ""
15966           },
15967           {
15968             "group": "Body",
15969             "type": "String",
15970             "optional": true,
15971             "field": "read1stAt",
15972             "description": ""
15973           },
15974           {
15975             "group": "Body",
15976             "type": "String",
15977             "optional": true,
15978             "field": "substatus",
15979             "description": ""
15980           },
15981           {
15982             "group": "Body",
15983             "type": "String",
15984             "optional": true,
15985             "field": "substatusAt",
15986             "description": ""
15987           },
15988           {
15989             "group": "Body",
15990             "type": "String",
15991             "allowedValues": [
15992               "\"in\"",
15993               "\"out\""
15994             ],
15995             "optional": false,
15996             "field": "firstMsgDirection",
15997             "description": ""
15998           },
15999           {
16000             "group": "Body",
16001             "type": "String",
16002             "optional": true,
16003             "field": "lastMsgAt",
16004             "description": ""
16005           },
16006           {
16007             "group": "Body",
16008             "type": "String",
16009             "allowedValues": [
16010               "\"in\"",
16011               "\"out\""
16012             ],
16013             "optional": false,
16014             "field": "lastMsgDirection",
16015             "description": ""
16016           }
16017         ]
16018       }
16019     },
16020     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16021     "version": "0.0.0",
16022     "filename": "server/api/mailAccount/index.js",
16023     "groupTitle": "Mail_Accounts"
16024   },
16025   {
16026     "type": "post",
16027     "url": "/api/mail/accounts",
16028     "title": "Create a mail account",
16029     "examples": [
16030       {
16031         "title": "Example usage:",
16032         "content": "curl https://{domain}/api/mail/accounts \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
16033         "type": "json"
16034       }
16035     ],
16036     "name": "create",
16037     "group": "Mail_Accounts",
16038     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16039     "version": "0.0.0",
16040     "filename": "server/api/mailAccount/index.js",
16041     "groupTitle": "Mail_Accounts"
16042   },
16043   {
16044     "type": "get",
16045     "url": "/api/mail/accounts/{id}/canned_answers",
16046     "title": "Gets account canned answers",
16047     "examples": [
16048       {
16049         "title": "Example usage:",
16050         "content": "curl https://{domain}/api/mail/accounts/{id}/canned_answers -v -u {name}:{password} -X GET",
16051         "type": "json"
16052       }
16053     ],
16054     "name": "getAnswers",
16055     "group": "Mail_Accounts",
16056     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16057     "version": "0.0.0",
16058     "filename": "server/api/mailAccount/index.js",
16059     "groupTitle": "Mail_Accounts"
16060   },
16061   {
16062     "type": "get",
16063     "url": "/api/mail/accounts/{id}/applications",
16064     "title": "Gets account applications",
16065     "examples": [
16066       {
16067         "title": "Example usage:",
16068         "content": "curl https://{domain}/api/mail/accounts/{id}/applications -v -u {name}:{password} -X GET",
16069         "type": "json"
16070       }
16071     ],
16072     "name": "getApplications",
16073     "group": "Mail_Accounts",
16074     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16075     "version": "0.0.0",
16076     "filename": "server/api/mailAccount/index.js",
16077     "groupTitle": "Mail_Accounts"
16078   },
16079   {
16080     "type": "get",
16081     "url": "/api/mail/accounts/{id}/dispositions",
16082     "title": "Gets account dispositions",
16083     "examples": [
16084       {
16085         "title": "Example usage:",
16086         "content": "curl https://{domain}/api/mail/accounts/{id}/dispositions -v -u {name}:{password} -X GET",
16087         "type": "json"
16088       }
16089     ],
16090     "name": "getDispositions",
16091     "group": "Mail_Accounts",
16092     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16093     "version": "0.0.0",
16094     "filename": "server/api/mailAccount/index.js",
16095     "groupTitle": "Mail_Accounts"
16096   },
16097   {
16098     "type": "get",
16099     "url": "/api/mail/accounts/{id}/interactions",
16100     "title": "Gets account interactions",
16101     "examples": [
16102       {
16103         "title": "Example usage:",
16104         "content": "curl https://{domain}/api/mail/accounts/{id}/interactions -v -u {name}:{password} -X GET",
16105         "type": "json"
16106       }
16107     ],
16108     "name": "getInteraction",
16109     "group": "Mail_Accounts",
16110     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16111     "version": "0.0.0",
16112     "filename": "server/api/mailAccount/index.js",
16113     "groupTitle": "Mail_Accounts"
16114   },
16115   {
16116     "type": "get",
16117     "url": "/api/mail/accounts/{id}/messages",
16118     "title": "Gets account messages",
16119     "examples": [
16120       {
16121         "title": "Example usage:",
16122         "content": "curl https://{domain}/api/mail/accounts/{id}/messages -v -u {name}:{password} -X GET",
16123         "type": "json"
16124       }
16125     ],
16126     "name": "getMessages",
16127     "group": "Mail_Accounts",
16128     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16129     "version": "0.0.0",
16130     "filename": "server/api/mailAccount/index.js",
16131     "groupTitle": "Mail_Accounts"
16132   },
16133   {
16134     "type": "post",
16135     "url": "/api/mail/accounts/{id}/send",
16136     "title": "Send new mail",
16137     "examples": [
16138       {
16139         "title": "Example usage:",
16140         "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",
16141         "type": "json"
16142       }
16143     ],
16144     "name": "sendMail",
16145     "group": "Mail_Accounts",
16146     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16147     "version": "0.0.0",
16148     "filename": "server/api/mailAccount/index.js",
16149     "groupTitle": "Mail_Accounts"
16150   },
16151   {
16152     "type": "put",
16153     "url": "/api/mail/accounts/{id}",
16154     "title": "Update an existing Account",
16155     "examples": [
16156       {
16157         "title": "Example usage:",
16158         "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",
16159         "type": "json"
16160       }
16161     ],
16162     "name": "updateAccounts",
16163     "group": "Mail_Accounts",
16164     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16165     "version": "0.0.0",
16166     "filename": "server/api/mailAccount/index.js",
16167     "groupTitle": "Mail_Accounts"
16168   },
16169   {
16170     "type": "get",
16171     "url": "/api/mail/accounts/{id}/verify",
16172     "title": "Verify mail account",
16173     "examples": [
16174       {
16175         "title": "Example usage:",
16176         "content": "curl https://{domain}/api/mail/accounts/{id}/verify -v -u {name}:{password} -X GET",
16177         "type": "json"
16178       }
16179     ],
16180     "name": "verifySmtp",
16181     "group": "Mail_Accounts",
16182     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16183     "version": "0.0.0",
16184     "filename": "server/api/mailAccount/index.js",
16185     "groupTitle": "Mail_Accounts"
16186   },
16187   {
16188     "type": "delete",
16189     "url": "/api/mail/applications/{id}",
16190     "title": "Deletes a Application",
16191     "examples": [
16192       {
16193         "title": "Example usage:",
16194         "content": "curl https://{domain}/api/mail/applications/{id} -v -u {name}:{password} -X DELETE",
16195         "type": "json"
16196       }
16197     ],
16198     "name": "DeleteApplications",
16199     "group": "Mail_Applications",
16200     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16201     "version": "0.0.0",
16202     "filename": "server/api/mailApplication/index.js",
16203     "groupTitle": "Mail_Applications"
16204   },
16205   {
16206     "type": "get",
16207     "url": "/api/mail/applications/{id}",
16208     "title": "Gets a single Application",
16209     "examples": [
16210       {
16211         "title": "Example usage:",
16212         "content": "curl https://{domain}/api/mail/applications/{id} -v -u {name}:{password}",
16213         "type": "json"
16214       }
16215     ],
16216     "name": "ShowApplications",
16217     "group": "Mail_Applications",
16218     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16219     "version": "0.0.0",
16220     "filename": "server/api/mailApplication/index.js",
16221     "groupTitle": "Mail_Applications"
16222   },
16223   {
16224     "type": "put",
16225     "url": "/api/mail/applications/{id}",
16226     "title": "Update an existing Application",
16227     "examples": [
16228       {
16229         "title": "Example usage:",
16230         "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",
16231         "type": "json"
16232       }
16233     ],
16234     "name": "updateApplications",
16235     "group": "Mail_Applications",
16236     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16237     "version": "0.0.0",
16238     "filename": "server/api/mailApplication/index.js",
16239     "groupTitle": "Mail_Applications"
16240   },
16241   {
16242     "type": "post",
16243     "url": "/api/mail/interactions/{id}/tags",
16244     "title": "Add tags to the interaction",
16245     "examples": [
16246       {
16247         "title": "Example usage:",
16248         "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",
16249         "type": "json"
16250       }
16251     ],
16252     "name": "AddTags",
16253     "group": "Mail_Interactions",
16254     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16255     "version": "0.0.0",
16256     "filename": "server/api/mailInteraction/index.js",
16257     "groupTitle": "Mail_Interactions"
16258   },
16259   {
16260     "type": "post",
16261     "url": "/api/mail/interactions",
16262     "title": "Creates a new Interaction",
16263     "examples": [
16264       {
16265         "title": "Example usage:",
16266         "content": "curl https://{domain}/api/mail/interactions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
16267         "type": "json"
16268       }
16269     ],
16270     "name": "CreateInteractions",
16271     "group": "Mail_Interactions",
16272     "parameter": {
16273       "fields": {
16274         "Body": [
16275           {
16276             "group": "Body",
16277             "type": "Boolean",
16278             "optional": true,
16279             "field": "closed",
16280             "description": ""
16281           },
16282           {
16283             "group": "Body",
16284             "type": "String",
16285             "optional": true,
16286             "field": "closedAt",
16287             "description": ""
16288           },
16289           {
16290             "group": "Body",
16291             "type": "String",
16292             "optional": true,
16293             "field": "disposition",
16294             "description": ""
16295           },
16296           {
16297             "group": "Body",
16298             "type": "String",
16299             "optional": true,
16300             "field": "secondDisposition",
16301             "description": ""
16302           },
16303           {
16304             "group": "Body",
16305             "type": "String",
16306             "optional": true,
16307             "field": "thirdDisposition",
16308             "description": ""
16309           },
16310           {
16311             "group": "Body",
16312             "type": "String",
16313             "optional": true,
16314             "field": "note",
16315             "description": ""
16316           },
16317           {
16318             "group": "Body",
16319             "type": "String",
16320             "optional": true,
16321             "field": "inReplyTo",
16322             "description": ""
16323           },
16324           {
16325             "group": "Body",
16326             "type": "String",
16327             "optional": true,
16328             "field": "to",
16329             "description": ""
16330           },
16331           {
16332             "group": "Body",
16333             "type": "Text",
16334             "optional": true,
16335             "field": "cc",
16336             "description": ""
16337           },
16338           {
16339             "group": "Body",
16340             "type": "Text",
16341             "optional": true,
16342             "field": "subject",
16343             "description": ""
16344           },
16345           {
16346             "group": "Body",
16347             "type": "Boolean",
16348             "optional": true,
16349             "field": "attach",
16350             "description": ""
16351           },
16352           {
16353             "group": "Body",
16354             "type": "String",
16355             "optional": true,
16356             "field": "read1stAt",
16357             "description": ""
16358           },
16359           {
16360             "group": "Body",
16361             "type": "String",
16362             "optional": true,
16363             "field": "substatus",
16364             "description": ""
16365           },
16366           {
16367             "group": "Body",
16368             "type": "String",
16369             "optional": true,
16370             "field": "substatusAt",
16371             "description": ""
16372           },
16373           {
16374             "group": "Body",
16375             "type": "String",
16376             "allowedValues": [
16377               "\"in\"",
16378               "\"out\""
16379             ],
16380             "optional": false,
16381             "field": "firstMsgDirection",
16382             "description": ""
16383           },
16384           {
16385             "group": "Body",
16386             "type": "String",
16387             "optional": true,
16388             "field": "lastMsgAt",
16389             "description": ""
16390           },
16391           {
16392             "group": "Body",
16393             "type": "String",
16394             "allowedValues": [
16395               "\"in\"",
16396               "\"out\""
16397             ],
16398             "optional": false,
16399             "field": "lastMsgDirection",
16400             "description": ""
16401           }
16402         ]
16403       }
16404     },
16405     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16406     "version": "0.0.0",
16407     "filename": "server/api/mailInteraction/index.js",
16408     "groupTitle": "Mail_Interactions"
16409   },
16410   {
16411     "type": "delete",
16412     "url": "/api/mail/interactions/{id}",
16413     "title": "Deletes a Interaction",
16414     "examples": [
16415       {
16416         "title": "Example usage:",
16417         "content": "curl https://{domain}/api/mail/interactions/{id} -v -u {name}:{password} -X DELETE",
16418         "type": "json"
16419       }
16420     ],
16421     "name": "DeleteInteractions",
16422     "group": "Mail_Interactions",
16423     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16424     "version": "0.0.0",
16425     "filename": "server/api/mailInteraction/index.js",
16426     "groupTitle": "Mail_Interactions"
16427   },
16428   {
16429     "type": "get",
16430     "url": "/api/mail/interactions/describe",
16431     "title": "Gets table info about Interactions",
16432     "examples": [
16433       {
16434         "title": "Example usage:",
16435         "content": "curl https://{domain}/api/mail/interactions/describe -v -u {name}:{password}",
16436         "type": "json"
16437       }
16438     ],
16439     "name": "DescribeInteractions",
16440     "group": "Mail_Interactions",
16441     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16442     "version": "0.0.0",
16443     "filename": "server/api/mailInteraction/index.js",
16444     "groupTitle": "Mail_Interactions"
16445   },
16446   {
16447     "type": "get",
16448     "url": "/api/mail/interactions",
16449     "title": "Gets a list of Interactions",
16450     "examples": [
16451       {
16452         "title": "Example usage:",
16453         "content": "curl https://{domain}/api/mail/interactions -v -u {name}:{password}",
16454         "type": "json"
16455       }
16456     ],
16457     "name": "GetInteractions",
16458     "group": "Mail_Interactions",
16459     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
16460     "version": "0.0.0",
16461     "filename": "server/api/mailInteraction/index.js",
16462     "groupTitle": "Mail_Interactions"
16463   },
16464   {
16465     "type": "delete",
16466     "url": "/api/mail/interactions/{id}/tags",
16467     "title": "Removes tags from interaction",
16468     "examples": [
16469       {
16470         "title": "Example usage:",
16471         "content": "curl https://{domain}/api/mail/interactions/{id}/tags?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
16472         "type": "json"
16473       }
16474     ],
16475     "name": "RemoveTags",
16476     "group": "Mail_Interactions",
16477     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16478     "version": "0.0.0",
16479     "filename": "server/api/mailInteraction/index.js",
16480     "groupTitle": "Mail_Interactions"
16481   },
16482   {
16483     "type": "get",
16484     "url": "/api/mail/interactions/{id}",
16485     "title": "Gets a single Interaction",
16486     "examples": [
16487       {
16488         "title": "Example usage:",
16489         "content": "curl https://{domain}/api/mail/interactions/{id} -v -u {name}:{password}",
16490         "type": "json"
16491       }
16492     ],
16493     "name": "ShowInteractions",
16494     "group": "Mail_Interactions",
16495     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16496     "version": "0.0.0",
16497     "filename": "server/api/mailInteraction/index.js",
16498     "groupTitle": "Mail_Interactions"
16499   },
16500   {
16501     "type": "post",
16502     "url": "/api/mail/interactions/{id}/messages",
16503     "title": "Creates new message",
16504     "examples": [
16505       {
16506         "title": "Example usage:",
16507         "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",
16508         "type": "json"
16509       }
16510     ],
16511     "name": "addMessage",
16512     "group": "Mail_Interactions",
16513     "parameter": {
16514       "fields": {
16515         "Body": [
16516           {
16517             "group": "Body",
16518             "type": "Text",
16519             "optional": false,
16520             "field": "body",
16521             "description": ""
16522           },
16523           {
16524             "group": "Body",
16525             "type": "Text",
16526             "optional": true,
16527             "field": "plainBody",
16528             "description": ""
16529           },
16530           {
16531             "group": "Body",
16532             "type": "Boolean",
16533             "optional": true,
16534             "field": "read",
16535             "description": ""
16536           },
16537           {
16538             "group": "Body",
16539             "type": "String",
16540             "allowedValues": [
16541               "\"in\"",
16542               "\"out\""
16543             ],
16544             "optional": false,
16545             "field": "direction",
16546             "description": ""
16547           },
16548           {
16549             "group": "Body",
16550             "type": "String",
16551             "optional": true,
16552             "field": "messageId",
16553             "description": ""
16554           },
16555           {
16556             "group": "Body",
16557             "type": "String",
16558             "optional": true,
16559             "field": "from",
16560             "description": ""
16561           },
16562           {
16563             "group": "Body",
16564             "type": "Text",
16565             "optional": true,
16566             "field": "to",
16567             "description": ""
16568           },
16569           {
16570             "group": "Body",
16571             "type": "Text",
16572             "optional": true,
16573             "field": "cc",
16574             "description": ""
16575           },
16576           {
16577             "group": "Body",
16578             "type": "Text",
16579             "optional": true,
16580             "field": "bcc",
16581             "description": ""
16582           },
16583           {
16584             "group": "Body",
16585             "type": "Text",
16586             "optional": true,
16587             "field": "subject",
16588             "description": ""
16589           },
16590           {
16591             "group": "Body",
16592             "type": "String",
16593             "optional": true,
16594             "field": "sentAt",
16595             "description": ""
16596           },
16597           {
16598             "group": "Body",
16599             "type": "Integer",
16600             "optional": true,
16601             "field": "attach",
16602             "description": ""
16603           },
16604           {
16605             "group": "Body",
16606             "type": "Boolean",
16607             "optional": true,
16608             "field": "secret",
16609             "description": ""
16610           },
16611           {
16612             "group": "Body",
16613             "type": "String",
16614             "optional": true,
16615             "field": "readAt",
16616             "description": ""
16617           },
16618           {
16619             "group": "Body",
16620             "type": "Text",
16621             "optional": true,
16622             "field": "originTo",
16623             "description": ""
16624           },
16625           {
16626             "group": "Body",
16627             "type": "Text",
16628             "optional": true,
16629             "field": "originCc",
16630             "description": ""
16631           },
16632           {
16633             "group": "Body",
16634             "type": "String",
16635             "allowedValues": [
16636               "\"Email\"",
16637               "\"Chat\""
16638             ],
16639             "optional": false,
16640             "field": "originChannel",
16641             "description": ""
16642           }
16643         ]
16644       }
16645     },
16646     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16647     "version": "0.0.0",
16648     "filename": "server/api/mailInteraction/index.js",
16649     "groupTitle": "Mail_Interactions"
16650   },
16651   {
16652     "type": "get",
16653     "url": "/api/mail/interactions/{id}/download",
16654     "title": "Gets interaction",
16655     "examples": [
16656       {
16657         "title": "Example usage:",
16658         "content": "curl https://{domain}/api/mail/interactions/{id}/download -v -u {name}:{password} -X GET",
16659         "type": "json"
16660       }
16661     ],
16662     "name": "download",
16663     "group": "Mail_Interactions",
16664     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16665     "version": "0.0.0",
16666     "filename": "server/api/mailInteraction/index.js",
16667     "groupTitle": "Mail_Interactions"
16668   },
16669   {
16670     "type": "get",
16671     "url": "/api/mail/interactions/{id}/messages",
16672     "title": "Gets interaction messages",
16673     "examples": [
16674       {
16675         "title": "Example usage:",
16676         "content": "curl https://{domain}/api/mail/interactions/{id}/messages -v -u {name}:{password} -X GET",
16677         "type": "json"
16678       }
16679     ],
16680     "name": "getMessages",
16681     "group": "Mail_Interactions",
16682     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16683     "version": "0.0.0",
16684     "filename": "server/api/mailInteraction/index.js",
16685     "groupTitle": "Mail_Interactions"
16686   },
16687   {
16688     "type": "put",
16689     "url": "/api/mail/interactions/{id}",
16690     "title": "Update an existing Interaction",
16691     "examples": [
16692       {
16693         "title": "Example usage:",
16694         "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",
16695         "type": "json"
16696       }
16697     ],
16698     "name": "updateInteractions",
16699     "group": "Mail_Interactions",
16700     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16701     "version": "0.0.0",
16702     "filename": "server/api/mailInteraction/index.js",
16703     "groupTitle": "Mail_Interactions"
16704   },
16705   {
16706     "type": "delete",
16707     "url": "/api/mail/messages/{id}",
16708     "title": "Deletes a Message",
16709     "examples": [
16710       {
16711         "title": "Example usage:",
16712         "content": "curl https://{domain}/api/mail/messages/{id} -v -u {name}:{password} -X DELETE",
16713         "type": "json"
16714       }
16715     ],
16716     "name": "DeleteMessages",
16717     "group": "Mail_Messages",
16718     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16719     "version": "0.0.0",
16720     "filename": "server/api/mailMessage/index.js",
16721     "groupTitle": "Mail_Messages"
16722   },
16723   {
16724     "type": "get",
16725     "url": "/api/mail/messages/describe",
16726     "title": "Gets table info about Messages",
16727     "examples": [
16728       {
16729         "title": "Example usage:",
16730         "content": "curl https://{domain}/api/mail/messages/describe -v -u {name}:{password}",
16731         "type": "json"
16732       }
16733     ],
16734     "name": "DescribeMessages",
16735     "group": "Mail_Messages",
16736     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16737     "version": "0.0.0",
16738     "filename": "server/api/mailMessage/index.js",
16739     "groupTitle": "Mail_Messages"
16740   },
16741   {
16742     "type": "get",
16743     "url": "/api/mail/messages",
16744     "title": "Gets a list of Messages",
16745     "examples": [
16746       {
16747         "title": "Example usage:",
16748         "content": "curl https://{domain}/api/mail/messages -v -u {name}:{password}",
16749         "type": "json"
16750       }
16751     ],
16752     "name": "GetMessages",
16753     "group": "Mail_Messages",
16754     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
16755     "version": "0.0.0",
16756     "filename": "server/api/mailMessage/index.js",
16757     "groupTitle": "Mail_Messages"
16758   },
16759   {
16760     "type": "get",
16761     "url": "/api/mail/messages/{id}",
16762     "title": "Gets a single Message",
16763     "examples": [
16764       {
16765         "title": "Example usage:",
16766         "content": "curl https://{domain}/api/mail/messages/{id} -v -u {name}:{password}",
16767         "type": "json"
16768       }
16769     ],
16770     "name": "ShowMessages",
16771     "group": "Mail_Messages",
16772     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16773     "version": "0.0.0",
16774     "filename": "server/api/mailMessage/index.js",
16775     "groupTitle": "Mail_Messages"
16776   },
16777   {
16778     "type": "put",
16779     "url": "/api/mail/messages/{id}/accept",
16780     "title": "Accepts message",
16781     "examples": [
16782       {
16783         "title": "Example usage:",
16784         "content": "curl https://{domain}/api/mail/messages/{id}/accept \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
16785         "type": "json"
16786       }
16787     ],
16788     "name": "acceptMessage",
16789     "group": "Mail_Messages",
16790     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16791     "version": "0.0.0",
16792     "filename": "server/api/mailMessage/index.js",
16793     "groupTitle": "Mail_Messages"
16794   },
16795   {
16796     "type": "post",
16797     "url": "/api/mail/messages",
16798     "title": "Create a message",
16799     "examples": [
16800       {
16801         "title": "Example usage:",
16802         "content": "curl https://{domain}/api/mail/messages \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
16803         "type": "json"
16804       }
16805     ],
16806     "name": "createMessage",
16807     "group": "Mail_Messages",
16808     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16809     "version": "0.0.0",
16810     "filename": "server/api/mailMessage/index.js",
16811     "groupTitle": "Mail_Messages"
16812   },
16813   {
16814     "type": "get",
16815     "url": "/api/mail/messages/{id}/download",
16816     "title": "Gets message",
16817     "examples": [
16818       {
16819         "title": "Example usage:",
16820         "content": "curl https://{domain}/api/mail/messages/{id}/download -v -u {name}:{password} -X GET",
16821         "type": "json"
16822       }
16823     ],
16824     "name": "download",
16825     "group": "Mail_Messages",
16826     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16827     "version": "0.0.0",
16828     "filename": "server/api/mailMessage/index.js",
16829     "groupTitle": "Mail_Messages"
16830   },
16831   {
16832     "type": "put",
16833     "url": "/api/mail/messages/{id}/reject",
16834     "title": "Rejects message",
16835     "examples": [
16836       {
16837         "title": "Example usage:",
16838         "content": "curl https://{domain}/api/mail/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
16839         "type": "json"
16840       }
16841     ],
16842     "name": "rejectMessage",
16843     "group": "Mail_Messages",
16844     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16845     "version": "0.0.0",
16846     "filename": "server/api/mailMessage/index.js",
16847     "groupTitle": "Mail_Messages"
16848   },
16849   {
16850     "type": "put",
16851     "url": "/api/mail/messages/{id}",
16852     "title": "Update an existing Message",
16853     "examples": [
16854       {
16855         "title": "Example usage:",
16856         "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",
16857         "type": "json"
16858       }
16859     ],
16860     "name": "updateMessages",
16861     "group": "Mail_Messages",
16862     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16863     "version": "0.0.0",
16864     "filename": "server/api/mailMessage/index.js",
16865     "groupTitle": "Mail_Messages"
16866   },
16867   {
16868     "type": "post",
16869     "url": "/api/mail/reports/queue",
16870     "title": "Creates a new Mail Queue Report",
16871     "examples": [
16872       {
16873         "title": "Example usage:",
16874         "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",
16875         "type": "json"
16876       }
16877     ],
16878     "name": "CreateMail_Queue_Reports",
16879     "group": "Mail_Queue_Reports",
16880     "parameter": {
16881       "fields": {
16882         "Body": [
16883           {
16884             "group": "Body",
16885             "type": "String",
16886             "optional": false,
16887             "field": "uniqueid",
16888             "description": ""
16889           },
16890           {
16891             "group": "Body",
16892             "type": "String",
16893             "optional": true,
16894             "field": "from",
16895             "description": ""
16896           },
16897           {
16898             "group": "Body",
16899             "type": "String",
16900             "optional": true,
16901             "field": "joinAt",
16902             "description": ""
16903           },
16904           {
16905             "group": "Body",
16906             "type": "String",
16907             "optional": true,
16908             "field": "leaveAt",
16909             "description": ""
16910           },
16911           {
16912             "group": "Body",
16913             "type": "String",
16914             "optional": true,
16915             "field": "acceptAt",
16916             "description": ""
16917           },
16918           {
16919             "group": "Body",
16920             "type": "String",
16921             "optional": true,
16922             "field": "exitAt",
16923             "description": ""
16924           },
16925           {
16926             "group": "Body",
16927             "type": "String",
16928             "optional": true,
16929             "field": "reason",
16930             "description": ""
16931           }
16932         ]
16933       }
16934     },
16935     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16936     "version": "0.0.0",
16937     "filename": "server/api/mailQueueReport/index.js",
16938     "groupTitle": "Mail_Queue_Reports"
16939   },
16940   {
16941     "type": "delete",
16942     "url": "/api/mail/reports/queue/{id}",
16943     "title": "Deletes a Mail Queue Report",
16944     "examples": [
16945       {
16946         "title": "Example usage:",
16947         "content": "curl https://{domain}/api/mail/reports/queue/{id} -v -u {name}:{password} -X DELETE",
16948         "type": "json"
16949       }
16950     ],
16951     "name": "DeleteMail_Queue_Reports",
16952     "group": "Mail_Queue_Reports",
16953     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16954     "version": "0.0.0",
16955     "filename": "server/api/mailQueueReport/index.js",
16956     "groupTitle": "Mail_Queue_Reports"
16957   },
16958   {
16959     "type": "get",
16960     "url": "/api/mail/reports/queue/describe",
16961     "title": "Gets table info about Mail Queue Reports",
16962     "examples": [
16963       {
16964         "title": "Example usage:",
16965         "content": "curl https://{domain}/api/mail/reports/queue/describe -v -u {name}:{password}",
16966         "type": "json"
16967       }
16968     ],
16969     "name": "DescribeMail_Queue_Reports",
16970     "group": "Mail_Queue_Reports",
16971     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16972     "version": "0.0.0",
16973     "filename": "server/api/mailQueueReport/index.js",
16974     "groupTitle": "Mail_Queue_Reports"
16975   },
16976   {
16977     "type": "get",
16978     "url": "/api/mail/reports/queue",
16979     "title": "Gets a list of Mail Queue Reports",
16980     "examples": [
16981       {
16982         "title": "Example usage:",
16983         "content": "curl https://{domain}/api/mail/reports/queue -v -u {name}:{password}",
16984         "type": "json"
16985       }
16986     ],
16987     "name": "GetMail_Queue_Reports",
16988     "group": "Mail_Queue_Reports",
16989     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
16990     "version": "0.0.0",
16991     "filename": "server/api/mailQueueReport/index.js",
16992     "groupTitle": "Mail_Queue_Reports"
16993   },
16994   {
16995     "type": "get",
16996     "url": "/api/mail/reports/queue/{id}",
16997     "title": "Gets a single Mail Queue Report",
16998     "examples": [
16999       {
17000         "title": "Example usage:",
17001         "content": "curl https://{domain}/api/mail/reports/queue/{id} -v -u {name}:{password}",
17002         "type": "json"
17003       }
17004     ],
17005     "name": "ShowMail_Queue_Reports",
17006     "group": "Mail_Queue_Reports",
17007     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17008     "version": "0.0.0",
17009     "filename": "server/api/mailQueueReport/index.js",
17010     "groupTitle": "Mail_Queue_Reports"
17011   },
17012   {
17013     "type": "put",
17014     "url": "/api/mail/reports/queue/{id}",
17015     "title": "Update an existing Mail Queue Report",
17016     "examples": [
17017       {
17018         "title": "Example usage:",
17019         "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",
17020         "type": "json"
17021       }
17022     ],
17023     "name": "updateMail_Queue_Reports",
17024     "group": "Mail_Queue_Reports",
17025     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17026     "version": "0.0.0",
17027     "filename": "server/api/mailQueueReport/index.js",
17028     "groupTitle": "Mail_Queue_Reports"
17029   },
17030   {
17031     "type": "post",
17032     "url": "/api/mail/queues/{id}/users",
17033     "title": "Add agents to a queue",
17034     "examples": [
17035       {
17036         "title": "Example usage:",
17037         "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",
17038         "type": "json"
17039       }
17040     ],
17041     "name": "AddAgents",
17042     "group": "Mail_Queues",
17043     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17044     "version": "0.0.0",
17045     "filename": "server/api/mailQueue/index.js",
17046     "groupTitle": "Mail_Queues"
17047   },
17048   {
17049     "type": "post",
17050     "url": "/api/mail/queues/{id}/teams",
17051     "title": "Add teams to a queue",
17052     "examples": [
17053       {
17054         "title": "Example usage:",
17055         "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",
17056         "type": "json"
17057       }
17058     ],
17059     "name": "AddTeams",
17060     "group": "Mail_Queues",
17061     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17062     "version": "0.0.0",
17063     "filename": "server/api/mailQueue/index.js",
17064     "groupTitle": "Mail_Queues"
17065   },
17066   {
17067     "type": "post",
17068     "url": "/api/mail/queues",
17069     "title": "Creates a new Queue",
17070     "examples": [
17071       {
17072         "title": "Example usage:",
17073         "content": "curl https://{domain}/api/mail/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
17074         "type": "json"
17075       }
17076     ],
17077     "name": "CreateQueues",
17078     "group": "Mail_Queues",
17079     "parameter": {
17080       "fields": {
17081         "Body": [
17082           {
17083             "group": "Body",
17084             "type": "String",
17085             "optional": true,
17086             "field": "name",
17087             "description": ""
17088           },
17089           {
17090             "group": "Body",
17091             "type": "String",
17092             "optional": true,
17093             "field": "description",
17094             "description": ""
17095           },
17096           {
17097             "group": "Body",
17098             "type": "Integer",
17099             "optional": true,
17100             "field": "timeout",
17101             "description": ""
17102           },
17103           {
17104             "group": "Body",
17105             "type": "String",
17106             "allowedValues": [
17107               "\"rrmemory\"",
17108               "\"beepall\"",
17109               "\"roundrobin\""
17110             ],
17111             "optional": true,
17112             "field": "strategy",
17113             "description": ""
17114           }
17115         ]
17116       }
17117     },
17118     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17119     "version": "0.0.0",
17120     "filename": "server/api/mailQueue/index.js",
17121     "groupTitle": "Mail_Queues"
17122   },
17123   {
17124     "type": "delete",
17125     "url": "/api/mail/queues/{id}",
17126     "title": "Deletes a Queue",
17127     "examples": [
17128       {
17129         "title": "Example usage:",
17130         "content": "curl https://{domain}/api/mail/queues/{id} -v -u {name}:{password} -X DELETE",
17131         "type": "json"
17132       }
17133     ],
17134     "name": "DeleteQueues",
17135     "group": "Mail_Queues",
17136     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17137     "version": "0.0.0",
17138     "filename": "server/api/mailQueue/index.js",
17139     "groupTitle": "Mail_Queues"
17140   },
17141   {
17142     "type": "get",
17143     "url": "/api/mail/queues/describe",
17144     "title": "Gets table info about Queues",
17145     "examples": [
17146       {
17147         "title": "Example usage:",
17148         "content": "curl https://{domain}/api/mail/queues/describe -v -u {name}:{password}",
17149         "type": "json"
17150       }
17151     ],
17152     "name": "DescribeQueues",
17153     "group": "Mail_Queues",
17154     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17155     "version": "0.0.0",
17156     "filename": "server/api/mailQueue/index.js",
17157     "groupTitle": "Mail_Queues"
17158   },
17159   {
17160     "type": "get",
17161     "url": "/api/mail/queues/{id}/users",
17162     "title": "Gets queue agents",
17163     "examples": [
17164       {
17165         "title": "Example usage:",
17166         "content": "curl https://{domain}/api/mail/queues/{id}/users -v -u {name}:{password} -X POST",
17167         "type": "json"
17168       }
17169     ],
17170     "name": "GetAgents",
17171     "group": "Mail_Queues",
17172     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17173     "version": "0.0.0",
17174     "filename": "server/api/mailQueue/index.js",
17175     "groupTitle": "Mail_Queues"
17176   },
17177   {
17178     "type": "get",
17179     "url": "/api/mail/queues/{id}/members",
17180     "title": "GetMembers",
17181     "examples": [
17182       {
17183         "title": "Example usage:",
17184         "content": "curl https://{domain}/api/mail/queues/{id}/members  -v -u {name}:{password}",
17185         "type": "json"
17186       }
17187     ],
17188     "name": "GetMembers",
17189     "group": "Mail_Queues",
17190     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17191     "version": "0.0.0",
17192     "filename": "server/api/mailQueue/index.js",
17193     "groupTitle": "Mail_Queues"
17194   },
17195   {
17196     "type": "get",
17197     "url": "/api/mail/queues",
17198     "title": "Gets a list of Queues",
17199     "examples": [
17200       {
17201         "title": "Example usage:",
17202         "content": "curl https://{domain}/api/mail/queues -v -u {name}:{password}",
17203         "type": "json"
17204       }
17205     ],
17206     "name": "GetQueues",
17207     "group": "Mail_Queues",
17208     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
17209     "version": "0.0.0",
17210     "filename": "server/api/mailQueue/index.js",
17211     "groupTitle": "Mail_Queues"
17212   },
17213   {
17214     "type": "get",
17215     "url": "/api/mail/queues/{id}/teams",
17216     "title": "Gets queues list",
17217     "examples": [
17218       {
17219         "title": "Example usage:",
17220         "content": "curl https://{domain}/api/mail/queues/{id}/teams -v -u {name}:{password}",
17221         "type": "json"
17222       }
17223     ],
17224     "name": "GetTeams",
17225     "group": "Mail_Queues",
17226     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17227     "version": "0.0.0",
17228     "filename": "server/api/mailQueue/index.js",
17229     "groupTitle": "Mail_Queues"
17230   },
17231   {
17232     "type": "delete",
17233     "url": "/api/mail/queues/{id}/users",
17234     "title": "Removes agents from a queue",
17235     "examples": [
17236       {
17237         "title": "Example usage:",
17238         "content": "curl https://{domain}/api/mail/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
17239         "type": "json"
17240       }
17241     ],
17242     "name": "RemoveAgents",
17243     "group": "Mail_Queues",
17244     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17245     "version": "0.0.0",
17246     "filename": "server/api/mailQueue/index.js",
17247     "groupTitle": "Mail_Queues"
17248   },
17249   {
17250     "type": "get",
17251     "url": "/api/mail/queues/{id}",
17252     "title": "Gets a single Queue",
17253     "examples": [
17254       {
17255         "title": "Example usage:",
17256         "content": "curl https://{domain}/api/mail/queues/{id} -v -u {name}:{password}",
17257         "type": "json"
17258       }
17259     ],
17260     "name": "ShowQueues",
17261     "group": "Mail_Queues",
17262     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17263     "version": "0.0.0",
17264     "filename": "server/api/mailQueue/index.js",
17265     "groupTitle": "Mail_Queues"
17266   },
17267   {
17268     "type": "put",
17269     "url": "/api/mail/queues/{id}",
17270     "title": "Update an existing Queue",
17271     "examples": [
17272       {
17273         "title": "Example usage:",
17274         "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",
17275         "type": "json"
17276       }
17277     ],
17278     "name": "updateQueues",
17279     "group": "Mail_Queues",
17280     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17281     "version": "0.0.0",
17282     "filename": "server/api/mailQueue/index.js",
17283     "groupTitle": "Mail_Queues"
17284   },
17285   {
17286     "type": "post",
17287     "url": "/api/mail/out_servers",
17288     "title": "Creates a new SMTP",
17289     "examples": [
17290       {
17291         "title": "Example usage:",
17292         "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",
17293         "type": "json"
17294       }
17295     ],
17296     "name": "CreateSMTPs",
17297     "group": "Mail_SMTP",
17298     "parameter": {
17299       "fields": {
17300         "Body": [
17301           {
17302             "group": "Body",
17303             "type": "String",
17304             "optional": true,
17305             "field": "description",
17306             "description": ""
17307           },
17308           {
17309             "group": "Body",
17310             "type": "String",
17311             "optional": true,
17312             "field": "host",
17313             "description": ""
17314           },
17315           {
17316             "group": "Body",
17317             "type": "String",
17318             "optional": true,
17319             "field": "user",
17320             "description": ""
17321           },
17322           {
17323             "group": "Body",
17324             "type": "String",
17325             "optional": true,
17326             "field": "pass",
17327             "description": ""
17328           },
17329           {
17330             "group": "Body",
17331             "type": "Integer",
17332             "optional": true,
17333             "field": "port",
17334             "description": ""
17335           },
17336           {
17337             "group": "Body",
17338             "type": "Boolean",
17339             "optional": true,
17340             "field": "secure",
17341             "description": ""
17342           },
17343           {
17344             "group": "Body",
17345             "type": "String",
17346             "optional": true,
17347             "field": "service",
17348             "description": ""
17349           },
17350           {
17351             "group": "Body",
17352             "type": "Boolean",
17353             "optional": true,
17354             "field": "authentication",
17355             "description": ""
17356           }
17357         ]
17358       }
17359     },
17360     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17361     "version": "0.0.0",
17362     "filename": "server/api/mailServerOut/index.js",
17363     "groupTitle": "Mail_SMTP"
17364   },
17365   {
17366     "type": "delete",
17367     "url": "/api/mail/out_servers/{id}",
17368     "title": "Deletes a SMTP",
17369     "examples": [
17370       {
17371         "title": "Example usage:",
17372         "content": "curl https://{domain}/api/mail/out_servers/{id} -v -u {name}:{password} -X DELETE",
17373         "type": "json"
17374       }
17375     ],
17376     "name": "DeleteSMTPs",
17377     "group": "Mail_SMTP",
17378     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17379     "version": "0.0.0",
17380     "filename": "server/api/mailServerOut/index.js",
17381     "groupTitle": "Mail_SMTP"
17382   },
17383   {
17384     "type": "get",
17385     "url": "/api/mail/out_servers",
17386     "title": "Gets a list of SMTPs",
17387     "examples": [
17388       {
17389         "title": "Example usage:",
17390         "content": "curl https://{domain}/api/mail/out_servers -v -u {name}:{password}",
17391         "type": "json"
17392       }
17393     ],
17394     "name": "GetSMTPs",
17395     "group": "Mail_SMTP",
17396     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
17397     "version": "0.0.0",
17398     "filename": "server/api/mailServerOut/index.js",
17399     "groupTitle": "Mail_SMTP"
17400   },
17401   {
17402     "type": "get",
17403     "url": "/api/mail/out_servers/{id}",
17404     "title": "Gets a single SMTP",
17405     "examples": [
17406       {
17407         "title": "Example usage:",
17408         "content": "curl https://{domain}/api/mail/out_servers/{id} -v -u {name}:{password}",
17409         "type": "json"
17410       }
17411     ],
17412     "name": "ShowSMTPs",
17413     "group": "Mail_SMTP",
17414     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17415     "version": "0.0.0",
17416     "filename": "server/api/mailServerOut/index.js",
17417     "groupTitle": "Mail_SMTP"
17418   },
17419   {
17420     "type": "put",
17421     "url": "/api/mail/out_servers/{id}",
17422     "title": "Update an existing SMTP",
17423     "examples": [
17424       {
17425         "title": "Example usage:",
17426         "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",
17427         "type": "json"
17428       }
17429     ],
17430     "name": "updateSMTPs",
17431     "group": "Mail_SMTP",
17432     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17433     "version": "0.0.0",
17434     "filename": "server/api/mailServerOut/index.js",
17435     "groupTitle": "Mail_SMTP"
17436   },
17437   {
17438     "type": "post",
17439     "url": "/api/mail/substatuses",
17440     "title": "Creates a new Queue",
17441     "examples": [
17442       {
17443         "title": "Example usage:",
17444         "content": "curl https://{domain}/api/mail/substatuses -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
17445         "type": "json"
17446       }
17447     ],
17448     "name": "CreateSubstatuses",
17449     "group": "Mail_Substatuses",
17450     "parameter": {
17451       "fields": {
17452         "Body": [
17453           {
17454             "group": "Body",
17455             "type": "String",
17456             "optional": false,
17457             "field": "name",
17458             "description": ""
17459           },
17460           {
17461             "group": "Body",
17462             "type": "String",
17463             "optional": true,
17464             "field": "description",
17465             "description": ""
17466           }
17467         ]
17468       }
17469     },
17470     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17471     "version": "0.0.0",
17472     "filename": "server/api/mailSubstatus/index.js",
17473     "groupTitle": "Mail_Substatuses"
17474   },
17475   {
17476     "type": "delete",
17477     "url": "/api/mail/substatuses/{id}",
17478     "title": "Deletes a Queue",
17479     "examples": [
17480       {
17481         "title": "Example usage:",
17482         "content": "curl https://{domain}/api/mail/substatuses/{id} -v -u {name}:{password} -X DELETE",
17483         "type": "json"
17484       }
17485     ],
17486     "name": "DeleteSubstatuses",
17487     "group": "Mail_Substatuses",
17488     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17489     "version": "0.0.0",
17490     "filename": "server/api/mailSubstatus/index.js",
17491     "groupTitle": "Mail_Substatuses"
17492   },
17493   {
17494     "type": "get",
17495     "url": "/api/mail/substatuses/describe",
17496     "title": "Gets table info about Substatuses",
17497     "examples": [
17498       {
17499         "title": "Example usage:",
17500         "content": "curl https://{domain}/api/mail/substatuses/describe -v -u {name}:{password}",
17501         "type": "json"
17502       }
17503     ],
17504     "name": "DescribeSubstatuses",
17505     "group": "Mail_Substatuses",
17506     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17507     "version": "0.0.0",
17508     "filename": "server/api/mailSubstatus/index.js",
17509     "groupTitle": "Mail_Substatuses"
17510   },
17511   {
17512     "type": "get",
17513     "url": "/api/mail/substatuses",
17514     "title": "Gets a list of Substatuses",
17515     "examples": [
17516       {
17517         "title": "Example usage:",
17518         "content": "curl https://{domain}/api/mail/substatuses -v -u {name}:{password}",
17519         "type": "json"
17520       }
17521     ],
17522     "name": "GetSubstatuses",
17523     "group": "Mail_Substatuses",
17524     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
17525     "version": "0.0.0",
17526     "filename": "server/api/mailSubstatus/index.js",
17527     "groupTitle": "Mail_Substatuses"
17528   },
17529   {
17530     "type": "get",
17531     "url": "/api/mail/substatuses/{id}",
17532     "title": "Gets a single Queue",
17533     "examples": [
17534       {
17535         "title": "Example usage:",
17536         "content": "curl https://{domain}/api/mail/substatuses/{id} -v -u {name}:{password}",
17537         "type": "json"
17538       }
17539     ],
17540     "name": "ShowSubstatuses",
17541     "group": "Mail_Substatuses",
17542     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17543     "version": "0.0.0",
17544     "filename": "server/api/mailSubstatus/index.js",
17545     "groupTitle": "Mail_Substatuses"
17546   },
17547   {
17548     "type": "put",
17549     "url": "/api/mail/substatuses/{id}",
17550     "title": "Update an existing Queue",
17551     "examples": [
17552       {
17553         "title": "Example usage:",
17554         "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",
17555         "type": "json"
17556       }
17557     ],
17558     "name": "updateSubstatuses",
17559     "group": "Mail_Substatuses",
17560     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17561     "version": "0.0.0",
17562     "filename": "server/api/mailSubstatus/index.js",
17563     "groupTitle": "Mail_Substatuses"
17564   },
17565   {
17566     "type": "post",
17567     "url": "/api/mail/reports/transfer",
17568     "title": "Creates a new Mail Transfer Report",
17569     "examples": [
17570       {
17571         "title": "Example usage:",
17572         "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",
17573         "type": "json"
17574       }
17575     ],
17576     "name": "CreateMail_Transfer_Reports",
17577     "group": "Mail_Transfer_Reports",
17578     "parameter": {
17579       "fields": {
17580         "Body": [
17581           {
17582             "group": "Body",
17583             "type": "String",
17584             "optional": false,
17585             "field": "uniqueid",
17586             "description": ""
17587           },
17588           {
17589             "group": "Body",
17590             "type": "String",
17591             "allowedValues": [
17592               "\"account\"",
17593               "\"agent\"",
17594               "\"queue\""
17595             ],
17596             "optional": false,
17597             "field": "type",
17598             "description": ""
17599           },
17600           {
17601             "group": "Body",
17602             "type": "String",
17603             "optional": false,
17604             "field": "transferredAt",
17605             "description": ""
17606           }
17607         ]
17608       }
17609     },
17610     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17611     "version": "0.0.0",
17612     "filename": "server/api/mailTransferReport/index.js",
17613     "groupTitle": "Mail_Transfer_Reports"
17614   },
17615   {
17616     "type": "delete",
17617     "url": "/api/mail/reports/transfer/{id}",
17618     "title": "Deletes a Mail Transfer Report",
17619     "examples": [
17620       {
17621         "title": "Example usage:",
17622         "content": "curl https://{domain}/api/mail/reports/transfer/{id} -v -u {name}:{password} -X DELETE",
17623         "type": "json"
17624       }
17625     ],
17626     "name": "DeleteMail_Transfer_Reports",
17627     "group": "Mail_Transfer_Reports",
17628     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17629     "version": "0.0.0",
17630     "filename": "server/api/mailTransferReport/index.js",
17631     "groupTitle": "Mail_Transfer_Reports"
17632   },
17633   {
17634     "type": "get",
17635     "url": "/api/mail/reports/transfer/describe",
17636     "title": "Gets table info about Mail Transfer Reports",
17637     "examples": [
17638       {
17639         "title": "Example usage:",
17640         "content": "curl https://{domain}/api/mail/reports/transfer/describe -v -u {name}:{password}",
17641         "type": "json"
17642       }
17643     ],
17644     "name": "DescribeMail_Transfer_Reports",
17645     "group": "Mail_Transfer_Reports",
17646     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17647     "version": "0.0.0",
17648     "filename": "server/api/mailTransferReport/index.js",
17649     "groupTitle": "Mail_Transfer_Reports"
17650   },
17651   {
17652     "type": "get",
17653     "url": "/api/mail/reports/transfer",
17654     "title": "Gets a list of Mail Transfer Reports",
17655     "examples": [
17656       {
17657         "title": "Example usage:",
17658         "content": "curl https://{domain}/api/mail/reports/transfer -v -u {name}:{password}",
17659         "type": "json"
17660       }
17661     ],
17662     "name": "GetMail_Transfer_Reports",
17663     "group": "Mail_Transfer_Reports",
17664     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
17665     "version": "0.0.0",
17666     "filename": "server/api/mailTransferReport/index.js",
17667     "groupTitle": "Mail_Transfer_Reports"
17668   },
17669   {
17670     "type": "get",
17671     "url": "/api/mail/reports/transfer/{id}",
17672     "title": "Gets a single Mail Transfer Report",
17673     "examples": [
17674       {
17675         "title": "Example usage:",
17676         "content": "curl https://{domain}/api/mail/reports/transfer/{id} -v -u {name}:{password}",
17677         "type": "json"
17678       }
17679     ],
17680     "name": "ShowMail_Transfer_Reports",
17681     "group": "Mail_Transfer_Reports",
17682     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17683     "version": "0.0.0",
17684     "filename": "server/api/mailTransferReport/index.js",
17685     "groupTitle": "Mail_Transfer_Reports"
17686   },
17687   {
17688     "type": "put",
17689     "url": "/api/mail/reports/transfer/{id}",
17690     "title": "Update an existing Mail Transfer Report",
17691     "examples": [
17692       {
17693         "title": "Example usage:",
17694         "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",
17695         "type": "json"
17696       }
17697     ],
17698     "name": "updateMail_Transfer_Reports",
17699     "group": "Mail_Transfer_Reports",
17700     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17701     "version": "0.0.0",
17702     "filename": "server/api/mailTransferReport/index.js",
17703     "groupTitle": "Mail_Transfer_Reports"
17704   },
17705   {
17706     "type": "get",
17707     "url": "/api/members/reports/describe",
17708     "title": "Gets table info about Member Reports",
17709     "examples": [
17710       {
17711         "title": "Example usage:",
17712         "content": "curl https://{domain}/api/members/reports/describe -v -u {name}:{password}",
17713         "type": "json"
17714       }
17715     ],
17716     "name": "DescribeMember_Reports",
17717     "group": "Member_Reports",
17718     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17719     "version": "0.0.0",
17720     "filename": "server/api/memberReport/index.js",
17721     "groupTitle": "Member_Reports"
17722   },
17723   {
17724     "type": "get",
17725     "url": "/api/members/reports",
17726     "title": "Gets a list of Member Reports",
17727     "examples": [
17728       {
17729         "title": "Example usage:",
17730         "content": "curl https://{domain}/api/members/reports -v -u {name}:{password}",
17731         "type": "json"
17732       }
17733     ],
17734     "name": "GetMember_Reports",
17735     "group": "Member_Reports",
17736     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
17737     "version": "0.0.0",
17738     "filename": "server/api/memberReport/index.js",
17739     "groupTitle": "Member_Reports"
17740   },
17741   {
17742     "type": "get",
17743     "url": "/api/members/reports/{id}",
17744     "title": "Gets a single Member Report",
17745     "examples": [
17746       {
17747         "title": "Example usage:",
17748         "content": "curl https://{domain}/api/members/reports/{id} -v -u {name}:{password}",
17749         "type": "json"
17750       }
17751     ],
17752     "name": "ShowMember_Reports",
17753     "group": "Member_Reports",
17754     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17755     "version": "0.0.0",
17756     "filename": "server/api/memberReport/index.js",
17757     "groupTitle": "Member_Reports"
17758   },
17759   {
17760     "type": "get",
17761     "url": "/api/migrations",
17762     "title": "Gets a list of Migrations",
17763     "examples": [
17764       {
17765         "title": "Example usage:",
17766         "content": "curl https://{domain}/api/migrations -v -u {name}:{password}",
17767         "type": "json"
17768       }
17769     ],
17770     "name": "GetMigrations",
17771     "group": "Migrations",
17772     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
17773     "version": "0.0.0",
17774     "filename": "server/api/migration/index.js",
17775     "groupTitle": "Migrations"
17776   },
17777   {
17778     "type": "post",
17779     "url": "/api/voice/networks",
17780     "title": "Create a new network",
17781     "examples": [
17782       {
17783         "title": "Example usage:",
17784         "content": "curl https://{domain}/api/voice/networks -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
17785         "type": "json"
17786       }
17787     ],
17788     "name": "Create",
17789     "group": "Networks",
17790     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17791     "version": "0.0.0",
17792     "filename": "server/api/network/index.js",
17793     "groupTitle": "Networks"
17794   },
17795   {
17796     "type": "delete",
17797     "url": "/api/voice/networks/{id}",
17798     "title": "Deletes a network",
17799     "examples": [
17800       {
17801         "title": "Example usage:",
17802         "content": "curl https://{domain}/api/voice/networks/{id} -v -u {name}:{password} -X DELETE",
17803         "type": "json"
17804       }
17805     ],
17806     "name": "Delete",
17807     "group": "Networks",
17808     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17809     "version": "0.0.0",
17810     "filename": "server/api/network/index.js",
17811     "groupTitle": "Networks"
17812   },
17813   {
17814     "type": "get",
17815     "url": "/api/networks",
17816     "title": "Gets a list of Networks",
17817     "examples": [
17818       {
17819         "title": "Example usage:",
17820         "content": "curl https://{domain}/api/networks -v -u {name}:{password}",
17821         "type": "json"
17822       }
17823     ],
17824     "name": "GetNetworks",
17825     "group": "Networks",
17826     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
17827     "version": "0.0.0",
17828     "filename": "server/api/network/index.js",
17829     "groupTitle": "Networks"
17830   },
17831   {
17832     "type": "get",
17833     "url": "/api/networks/{id}",
17834     "title": "Gets a single Network",
17835     "examples": [
17836       {
17837         "title": "Example usage:",
17838         "content": "curl https://{domain}/api/networks/{id} -v -u {name}:{password}",
17839         "type": "json"
17840       }
17841     ],
17842     "name": "ShowNetworks",
17843     "group": "Networks",
17844     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17845     "version": "0.0.0",
17846     "filename": "server/api/network/index.js",
17847     "groupTitle": "Networks"
17848   },
17849   {
17850     "type": "put",
17851     "url": "/api/voice/networks/{id}",
17852     "title": "Update an existing network",
17853     "examples": [
17854       {
17855         "title": "Example usage:",
17856         "content": "curl https://{domain}/api/voice/networks/{id} -v -u {name}:{password} -X PUT",
17857         "type": "json"
17858       }
17859     ],
17860     "name": "Update",
17861     "group": "Networks",
17862     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17863     "version": "0.0.0",
17864     "filename": "server/api/network/index.js",
17865     "groupTitle": "Networks"
17866   },
17867   {
17868     "type": "post",
17869     "url": "/api/openchannel/accounts/{id}/users",
17870     "title": "Add agents to a openchannel account",
17871     "examples": [
17872       {
17873         "title": "Example usage:",
17874         "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",
17875         "type": "json"
17876       }
17877     ],
17878     "name": "AddAgents",
17879     "group": "Openchannel_Accounts",
17880     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17881     "version": "0.0.0",
17882     "filename": "server/api/openchannelAccount/index.js",
17883     "groupTitle": "Openchannel_Accounts"
17884   },
17885   {
17886     "type": "post",
17887     "url": "/api/openchannel/accounts",
17888     "title": "Creates a new Account",
17889     "examples": [
17890       {
17891         "title": "Example usage:",
17892         "content": "curl https://{domain}/api/openchannel/accounts -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
17893         "type": "json"
17894       }
17895     ],
17896     "name": "CreateAccounts",
17897     "group": "Openchannel_Accounts",
17898     "parameter": {
17899       "fields": {
17900         "Body": [
17901           {
17902             "group": "Body",
17903             "type": "String",
17904             "optional": false,
17905             "field": "name",
17906             "description": ""
17907           },
17908           {
17909             "group": "Body",
17910             "type": "String",
17911             "optional": true,
17912             "field": "description",
17913             "description": ""
17914           },
17915           {
17916             "group": "Body",
17917             "type": "String",
17918             "optional": true,
17919             "field": "token",
17920             "description": ""
17921           },
17922           {
17923             "group": "Body",
17924             "type": "String",
17925             "optional": true,
17926             "field": "replyUri",
17927             "description": ""
17928           },
17929           {
17930             "group": "Body",
17931             "type": "String",
17932             "optional": false,
17933             "field": "key",
17934             "description": ""
17935           },
17936           {
17937             "group": "Body",
17938             "type": "Text",
17939             "optional": true,
17940             "field": "notificationTemplate",
17941             "description": ""
17942           },
17943           {
17944             "group": "Body",
17945             "type": "Boolean",
17946             "optional": true,
17947             "field": "notificationSound",
17948             "description": ""
17949           },
17950           {
17951             "group": "Body",
17952             "type": "Boolean",
17953             "optional": true,
17954             "field": "notificationShake",
17955             "description": ""
17956           },
17957           {
17958             "group": "Body",
17959             "type": "Integer",
17960             "optional": true,
17961             "field": "waitForTheAssignedAgent",
17962             "description": ""
17963           },
17964           {
17965             "group": "Body",
17966             "type": "String",
17967             "optional": true,
17968             "field": "mapKey",
17969             "description": ""
17970           },
17971           {
17972             "group": "Body",
17973             "type": "Boolean",
17974             "optional": true,
17975             "field": "queueTransfer",
17976             "description": ""
17977           },
17978           {
17979             "group": "Body",
17980             "type": "Integer",
17981             "optional": true,
17982             "field": "queueTransferTimeout",
17983             "description": ""
17984           },
17985           {
17986             "group": "Body",
17987             "type": "Boolean",
17988             "optional": true,
17989             "field": "agentTransfer",
17990             "description": ""
17991           },
17992           {
17993             "group": "Body",
17994             "type": "Integer",
17995             "optional": true,
17996             "field": "agentTransferTimeout",
17997             "description": ""
17998           },
17999           {
18000             "group": "Body",
18001             "type": "Integer",
18002             "optional": true,
18003             "field": "mandatoryDispositionPauseId",
18004             "description": "<p>Status to put when mandatory disposition is enabled</p>"
18005           },
18006           {
18007             "group": "Body",
18008             "type": "Boolean",
18009             "optional": true,
18010             "field": "mandatoryDisposition",
18011             "description": "<p>Enabled/disables mandatory dispo on a queue</p>"
18012           }
18013         ]
18014       }
18015     },
18016     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18017     "version": "0.0.0",
18018     "filename": "server/api/openchannelAccount/index.js",
18019     "groupTitle": "Openchannel_Accounts"
18020   },
18021   {
18022     "type": "delete",
18023     "url": "/api/openchannel/accounts/{id}",
18024     "title": "Deletes a Account",
18025     "examples": [
18026       {
18027         "title": "Example usage:",
18028         "content": "curl https://{domain}/api/openchannel/accounts/{id} -v -u {name}:{password} -X DELETE",
18029         "type": "json"
18030       }
18031     ],
18032     "name": "DeleteAccounts",
18033     "group": "Openchannel_Accounts",
18034     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18035     "version": "0.0.0",
18036     "filename": "server/api/openchannelAccount/index.js",
18037     "groupTitle": "Openchannel_Accounts"
18038   },
18039   {
18040     "type": "get",
18041     "url": "/api/openchannel/accounts/describe",
18042     "title": "Gets table info about Accounts",
18043     "examples": [
18044       {
18045         "title": "Example usage:",
18046         "content": "curl https://{domain}/api/openchannel/accounts/describe -v -u {name}:{password}",
18047         "type": "json"
18048       }
18049     ],
18050     "name": "DescribeAccounts",
18051     "group": "Openchannel_Accounts",
18052     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18053     "version": "0.0.0",
18054     "filename": "server/api/openchannelAccount/index.js",
18055     "groupTitle": "Openchannel_Accounts"
18056   },
18057   {
18058     "type": "get",
18059     "url": "/api/openchannel/accounts",
18060     "title": "Gets a list of Accounts",
18061     "examples": [
18062       {
18063         "title": "Example usage:",
18064         "content": "curl https://{domain}/api/openchannel/accounts -v -u {name}:{password}",
18065         "type": "json"
18066       }
18067     ],
18068     "name": "GetAccounts",
18069     "group": "Openchannel_Accounts",
18070     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
18071     "version": "0.0.0",
18072     "filename": "server/api/openchannelAccount/index.js",
18073     "groupTitle": "Openchannel_Accounts"
18074   },
18075   {
18076     "type": "get",
18077     "url": "/api/openchannel/accounts/{id}/users",
18078     "title": "Gets agents from openchannel account",
18079     "examples": [
18080       {
18081         "title": "Example usage:",
18082         "content": "curl https://{domain}/api/openchannel/accounts/{id}/users -v -u {name}:{password} -X GET",
18083         "type": "json"
18084       }
18085     ],
18086     "name": "GetAgents",
18087     "group": "Openchannel_Accounts",
18088     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18089     "version": "0.0.0",
18090     "filename": "server/api/openchannelAccount/index.js",
18091     "groupTitle": "Openchannel_Accounts"
18092   },
18093   {
18094     "type": "delete",
18095     "url": "/api/openchannel/accounts/{id}/users",
18096     "title": "Removes agents from a openchannel account",
18097     "examples": [
18098       {
18099         "title": "Example usage:",
18100         "content": "curl https://{domain}/api/openchannel/accounts/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
18101         "type": "json"
18102       }
18103     ],
18104     "name": "RemoveAgents",
18105     "group": "Openchannel_Accounts",
18106     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18107     "version": "0.0.0",
18108     "filename": "server/api/openchannelAccount/index.js",
18109     "groupTitle": "Openchannel_Accounts"
18110   },
18111   {
18112     "type": "delete",
18113     "url": "/api/openchannel/accounts/{id}/canned_answers",
18114     "title": "Removes canned answers from account",
18115     "examples": [
18116       {
18117         "title": "Example usage:",
18118         "content": "curl https://{domain}/api/openchannel/accounts/{id}/canned_answers?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
18119         "type": "json"
18120       }
18121     ],
18122     "name": "RemoveAnswers",
18123     "group": "Openchannel_Accounts",
18124     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18125     "version": "0.0.0",
18126     "filename": "server/api/openchannelAccount/index.js",
18127     "groupTitle": "Openchannel_Accounts"
18128   },
18129   {
18130     "type": "delete",
18131     "url": "/api/openchannel/accounts/{id}/dispositions",
18132     "title": "Removes dispositions from account",
18133     "examples": [
18134       {
18135         "title": "Example usage:",
18136         "content": "curl https://{domain}/api/openchannel/accounts/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
18137         "type": "json"
18138       }
18139     ],
18140     "name": "RemoveDispositions",
18141     "group": "Openchannel_Accounts",
18142     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18143     "version": "0.0.0",
18144     "filename": "server/api/openchannelAccount/index.js",
18145     "groupTitle": "Openchannel_Accounts"
18146   },
18147   {
18148     "type": "get",
18149     "url": "/api/openchannel/accounts/{id}",
18150     "title": "Gets a single Account",
18151     "examples": [
18152       {
18153         "title": "Example usage:",
18154         "content": "curl https://{domain}/api/openchannel/accounts/{id} -v -u {name}:{password}",
18155         "type": "json"
18156       }
18157     ],
18158     "name": "ShowAccounts",
18159     "group": "Openchannel_Accounts",
18160     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18161     "version": "0.0.0",
18162     "filename": "server/api/openchannelAccount/index.js",
18163     "groupTitle": "Openchannel_Accounts"
18164   },
18165   {
18166     "type": "post",
18167     "url": "/api/openchannel/accounts/{id}/canned_answers",
18168     "title": "Creates new canned answer",
18169     "examples": [
18170       {
18171         "title": "Example usage:",
18172         "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",
18173         "type": "json"
18174       }
18175     ],
18176     "name": "addAnswer",
18177     "group": "Openchannel_Accounts",
18178     "parameter": {
18179       "fields": {
18180         "Body": [
18181           {
18182             "group": "Body",
18183             "type": "String",
18184             "optional": false,
18185             "field": "key",
18186             "description": ""
18187           },
18188           {
18189             "group": "Body",
18190             "type": "Text",
18191             "optional": false,
18192             "field": "value",
18193             "description": ""
18194           },
18195           {
18196             "group": "Body",
18197             "type": "String",
18198             "optional": true,
18199             "field": "description",
18200             "description": ""
18201           },
18202           {
18203             "group": "Body",
18204             "type": "Virtual",
18205             "optional": true,
18206             "field": "name",
18207             "description": ""
18208           }
18209         ]
18210       }
18211     },
18212     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18213     "version": "0.0.0",
18214     "filename": "server/api/openchannelAccount/index.js",
18215     "groupTitle": "Openchannel_Accounts"
18216   },
18217   {
18218     "type": "post",
18219     "url": "/api/openchannel/accounts/{id}/applications",
18220     "title": "Creates new applications",
18221     "examples": [
18222       {
18223         "title": "Example usage:",
18224         "content": "curl https://{domain}/api/openchannel/accounts/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
18225         "type": "json"
18226       }
18227     ],
18228     "name": "addApplications",
18229     "group": "Openchannel_Accounts",
18230     "parameter": {
18231       "fields": {
18232         "Body": [
18233           {
18234             "group": "Body",
18235             "type": "Integer",
18236             "optional": false,
18237             "field": "priority",
18238             "description": ""
18239           },
18240           {
18241             "group": "Body",
18242             "type": "String",
18243             "optional": false,
18244             "field": "app",
18245             "description": ""
18246           },
18247           {
18248             "group": "Body",
18249             "type": "Text",
18250             "optional": true,
18251             "field": "appdata",
18252             "description": ""
18253           },
18254           {
18255             "group": "Body",
18256             "type": "String",
18257             "optional": true,
18258             "field": "description",
18259             "description": ""
18260           },
18261           {
18262             "group": "Body",
18263             "type": "String",
18264             "optional": true,
18265             "field": "interval",
18266             "description": ""
18267           }
18268         ]
18269       }
18270     },
18271     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18272     "version": "0.0.0",
18273     "filename": "server/api/openchannelAccount/index.js",
18274     "groupTitle": "Openchannel_Accounts"
18275   },
18276   {
18277     "type": "post",
18278     "url": "/api/openchannel/accounts/{id}/dispositions",
18279     "title": "Creates new disposition",
18280     "examples": [
18281       {
18282         "title": "Example usage:",
18283         "content": "curl https://{domain}/api/openchannel/accounts/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
18284         "type": "json"
18285       }
18286     ],
18287     "name": "addDisposition",
18288     "group": "Openchannel_Accounts",
18289     "parameter": {
18290       "fields": {
18291         "Body": [
18292           {
18293             "group": "Body",
18294             "type": "String",
18295             "optional": false,
18296             "field": "name",
18297             "description": ""
18298           },
18299           {
18300             "group": "Body",
18301             "type": "String",
18302             "allowedValues": [
18303               "\"first\"",
18304               "\"second\"",
18305               "\"third\""
18306             ],
18307             "optional": false,
18308             "field": "level",
18309             "description": ""
18310           },
18311           {
18312             "group": "Body",
18313             "type": "String",
18314             "optional": true,
18315             "field": "description",
18316             "description": ""
18317           }
18318         ]
18319       }
18320     },
18321     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18322     "version": "0.0.0",
18323     "filename": "server/api/openchannelAccount/index.js",
18324     "groupTitle": "Openchannel_Accounts"
18325   },
18326   {
18327     "type": "get",
18328     "url": "/api/openchannel/accounts/{id}/canned_answers",
18329     "title": "Gets account canned answers",
18330     "examples": [
18331       {
18332         "title": "Example usage:",
18333         "content": "curl https://{domain}/api/openchannel/accounts/{id}/canned_answers -v -u {name}:{password} -X GET",
18334         "type": "json"
18335       }
18336     ],
18337     "name": "getAnswers",
18338     "group": "Openchannel_Accounts",
18339     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18340     "version": "0.0.0",
18341     "filename": "server/api/openchannelAccount/index.js",
18342     "groupTitle": "Openchannel_Accounts"
18343   },
18344   {
18345     "type": "get",
18346     "url": "/api/openchannel/accounts/{id}/applications",
18347     "title": "Gets account applications",
18348     "examples": [
18349       {
18350         "title": "Example usage:",
18351         "content": "curl https://{domain}/api/openchannel/accounts/{id}/applications -v -u {name}:{password} -X GET",
18352         "type": "json"
18353       }
18354     ],
18355     "name": "getApplications",
18356     "group": "Openchannel_Accounts",
18357     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18358     "version": "0.0.0",
18359     "filename": "server/api/openchannelAccount/index.js",
18360     "groupTitle": "Openchannel_Accounts"
18361   },
18362   {
18363     "type": "get",
18364     "url": "/api/openchannel/accounts/{id}/dispositions",
18365     "title": "Gets account dispositions",
18366     "examples": [
18367       {
18368         "title": "Example usage:",
18369         "content": "curl https://{domain}/api/openchannel/accounts/{id}/dispositions -v -u {name}:{password} -X GET",
18370         "type": "json"
18371       }
18372     ],
18373     "name": "getDispositions",
18374     "group": "Openchannel_Accounts",
18375     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18376     "version": "0.0.0",
18377     "filename": "server/api/openchannelAccount/index.js",
18378     "groupTitle": "Openchannel_Accounts"
18379   },
18380   {
18381     "type": "get",
18382     "url": "/api/openchannel/accounts/{id}/interactions",
18383     "title": "Gets Openchannel Account Interactions",
18384     "examples": [
18385       {
18386         "title": "Example usage:",
18387         "content": "curl https://{domain}/api/openchannel/accounts/{id}/interactions -v -u {name}:{password} -X GET",
18388         "type": "json"
18389       }
18390     ],
18391     "name": "getInteractions",
18392     "group": "Openchannel_Accounts",
18393     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18394     "version": "0.0.0",
18395     "filename": "server/api/openchannelAccount/index.js",
18396     "groupTitle": "Openchannel_Accounts"
18397   },
18398   {
18399     "type": "post",
18400     "url": "/api/openchannel/accounts/{id}/notify",
18401     "title": "Notify new message",
18402     "examples": [
18403       {
18404         "title": "Example usage:",
18405         "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",
18406         "type": "json"
18407       }
18408     ],
18409     "name": "notify",
18410     "group": "Openchannel_Accounts",
18411     "description": "<p>Motion 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>",
18412     "version": "0.0.0",
18413     "filename": "server/api/openchannelAccount/index.js",
18414     "groupTitle": "Openchannel_Accounts"
18415   },
18416   {
18417     "type": "post",
18418     "url": "/api/openchannel/accounts/{id}/send",
18419     "title": "Send new openchannel message",
18420     "examples": [
18421       {
18422         "title": "Example usage:",
18423         "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",
18424         "type": "json"
18425       }
18426     ],
18427     "name": "sendOpenchannel",
18428     "group": "Openchannel_Accounts",
18429     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18430     "version": "0.0.0",
18431     "filename": "server/api/openchannelAccount/index.js",
18432     "groupTitle": "Openchannel_Accounts"
18433   },
18434   {
18435     "type": "put",
18436     "url": "/api/openchannel/accounts/{id}",
18437     "title": "Update an existing Account",
18438     "examples": [
18439       {
18440         "title": "Example usage:",
18441         "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",
18442         "type": "json"
18443       }
18444     ],
18445     "name": "updateAccounts",
18446     "group": "Openchannel_Accounts",
18447     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18448     "version": "0.0.0",
18449     "filename": "server/api/openchannelAccount/index.js",
18450     "groupTitle": "Openchannel_Accounts"
18451   },
18452   {
18453     "type": "post",
18454     "url": "/api/openchannel/applications",
18455     "title": "Creates a new Application",
18456     "examples": [
18457       {
18458         "title": "Example usage:",
18459         "content": "curl https://{domain}/api/openchannel/applications -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
18460         "type": "json"
18461       }
18462     ],
18463     "name": "CreateApplications",
18464     "group": "Openchannel_Applications",
18465     "parameter": {
18466       "fields": {
18467         "Body": [
18468           {
18469             "group": "Body",
18470             "type": "Integer",
18471             "optional": false,
18472             "field": "priority",
18473             "description": ""
18474           },
18475           {
18476             "group": "Body",
18477             "type": "String",
18478             "optional": false,
18479             "field": "app",
18480             "description": ""
18481           },
18482           {
18483             "group": "Body",
18484             "type": "Text",
18485             "optional": true,
18486             "field": "appdata",
18487             "description": ""
18488           },
18489           {
18490             "group": "Body",
18491             "type": "String",
18492             "optional": true,
18493             "field": "description",
18494             "description": ""
18495           },
18496           {
18497             "group": "Body",
18498             "type": "String",
18499             "optional": true,
18500             "field": "interval",
18501             "description": ""
18502           }
18503         ]
18504       }
18505     },
18506     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18507     "version": "0.0.0",
18508     "filename": "server/api/openchannelApplication/index.js",
18509     "groupTitle": "Openchannel_Applications"
18510   },
18511   {
18512     "type": "delete",
18513     "url": "/api/openchannel/applications/{id}",
18514     "title": "Deletes a Application",
18515     "examples": [
18516       {
18517         "title": "Example usage:",
18518         "content": "curl https://{domain}/api/openchannel/applications/{id} -v -u {name}:{password} -X DELETE",
18519         "type": "json"
18520       }
18521     ],
18522     "name": "DeleteApplications",
18523     "group": "Openchannel_Applications",
18524     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18525     "version": "0.0.0",
18526     "filename": "server/api/openchannelApplication/index.js",
18527     "groupTitle": "Openchannel_Applications"
18528   },
18529   {
18530     "type": "get",
18531     "url": "/api/openchannel/applications",
18532     "title": "Gets a list of Applications",
18533     "examples": [
18534       {
18535         "title": "Example usage:",
18536         "content": "curl https://{domain}/api/openchannel/applications -v -u {name}:{password}",
18537         "type": "json"
18538       }
18539     ],
18540     "name": "GetApplications",
18541     "group": "Openchannel_Applications",
18542     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
18543     "version": "0.0.0",
18544     "filename": "server/api/openchannelApplication/index.js",
18545     "groupTitle": "Openchannel_Applications"
18546   },
18547   {
18548     "type": "get",
18549     "url": "/api/openchannel/applications/{id}",
18550     "title": "Gets a single Application",
18551     "examples": [
18552       {
18553         "title": "Example usage:",
18554         "content": "curl https://{domain}/api/openchannel/applications/{id} -v -u {name}:{password}",
18555         "type": "json"
18556       }
18557     ],
18558     "name": "ShowApplications",
18559     "group": "Openchannel_Applications",
18560     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18561     "version": "0.0.0",
18562     "filename": "server/api/openchannelApplication/index.js",
18563     "groupTitle": "Openchannel_Applications"
18564   },
18565   {
18566     "type": "put",
18567     "url": "/api/openchannel/applications/{id}",
18568     "title": "Update an existing Application",
18569     "examples": [
18570       {
18571         "title": "Example usage:",
18572         "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",
18573         "type": "json"
18574       }
18575     ],
18576     "name": "updateApplications",
18577     "group": "Openchannel_Applications",
18578     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18579     "version": "0.0.0",
18580     "filename": "server/api/openchannelApplication/index.js",
18581     "groupTitle": "Openchannel_Applications"
18582   },
18583   {
18584     "type": "post",
18585     "url": "/api/openchannel/interactions/{id}/tags",
18586     "title": "Add tags to the interaction",
18587     "examples": [
18588       {
18589         "title": "Example usage:",
18590         "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",
18591         "type": "json"
18592       }
18593     ],
18594     "name": "AddTags",
18595     "group": "Openchannel_Interactions",
18596     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18597     "version": "0.0.0",
18598     "filename": "server/api/openchannelInteraction/index.js",
18599     "groupTitle": "Openchannel_Interactions"
18600   },
18601   {
18602     "type": "post",
18603     "url": "/api/openchannel/interactions",
18604     "title": "Creates a new Interaction",
18605     "examples": [
18606       {
18607         "title": "Example usage:",
18608         "content": "curl https://{domain}/api/openchannel/interactions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
18609         "type": "json"
18610       }
18611     ],
18612     "name": "CreateInteractions",
18613     "group": "Openchannel_Interactions",
18614     "parameter": {
18615       "fields": {
18616         "Body": [
18617           {
18618             "group": "Body",
18619             "type": "Boolean",
18620             "optional": true,
18621             "field": "closed",
18622             "description": ""
18623           },
18624           {
18625             "group": "Body",
18626             "type": "String",
18627             "optional": true,
18628             "field": "closedAt",
18629             "description": ""
18630           },
18631           {
18632             "group": "Body",
18633             "type": "String",
18634             "optional": true,
18635             "field": "disposition",
18636             "description": ""
18637           },
18638           {
18639             "group": "Body",
18640             "type": "String",
18641             "optional": true,
18642             "field": "secondDisposition",
18643             "description": ""
18644           },
18645           {
18646             "group": "Body",
18647             "type": "String",
18648             "optional": true,
18649             "field": "thirdDisposition",
18650             "description": ""
18651           },
18652           {
18653             "group": "Body",
18654             "type": "String",
18655             "optional": true,
18656             "field": "note",
18657             "description": ""
18658           },
18659           {
18660             "group": "Body",
18661             "type": "String",
18662             "optional": true,
18663             "field": "read1stAt",
18664             "description": ""
18665           },
18666           {
18667             "group": "Body",
18668             "type": "String",
18669             "optional": true,
18670             "field": "threadId",
18671             "description": ""
18672           },
18673           {
18674             "group": "Body",
18675             "type": "String",
18676             "optional": true,
18677             "field": "externalUrl",
18678             "description": ""
18679           },
18680           {
18681             "group": "Body",
18682             "type": "String",
18683             "optional": true,
18684             "field": "lastMsgAt",
18685             "description": ""
18686           },
18687           {
18688             "group": "Body",
18689             "type": "String",
18690             "allowedValues": [
18691               "\"in\"",
18692               "\"out\""
18693             ],
18694             "optional": false,
18695             "field": "lastMsgDirection",
18696             "description": ""
18697           },
18698           {
18699             "group": "Body",
18700             "type": "String",
18701             "optional": true,
18702             "field": "from",
18703             "description": ""
18704           }
18705         ]
18706       }
18707     },
18708     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18709     "version": "0.0.0",
18710     "filename": "server/api/openchannelInteraction/index.js",
18711     "groupTitle": "Openchannel_Interactions"
18712   },
18713   {
18714     "type": "delete",
18715     "url": "/api/openchannel/interactions/{id}",
18716     "title": "Deletes a Interaction",
18717     "examples": [
18718       {
18719         "title": "Example usage:",
18720         "content": "curl https://{domain}/api/openchannel/interactions/{id} -v -u {name}:{password} -X DELETE",
18721         "type": "json"
18722       }
18723     ],
18724     "name": "DeleteInteractions",
18725     "group": "Openchannel_Interactions",
18726     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18727     "version": "0.0.0",
18728     "filename": "server/api/openchannelInteraction/index.js",
18729     "groupTitle": "Openchannel_Interactions"
18730   },
18731   {
18732     "type": "get",
18733     "url": "/api/openchannel/interactions/describe",
18734     "title": "Gets table info about Interactions",
18735     "examples": [
18736       {
18737         "title": "Example usage:",
18738         "content": "curl https://{domain}/api/openchannel/interactions/describe -v -u {name}:{password}",
18739         "type": "json"
18740       }
18741     ],
18742     "name": "DescribeInteractions",
18743     "group": "Openchannel_Interactions",
18744     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18745     "version": "0.0.0",
18746     "filename": "server/api/openchannelInteraction/index.js",
18747     "groupTitle": "Openchannel_Interactions"
18748   },
18749   {
18750     "type": "get",
18751     "url": "/api/openchannel/interactions",
18752     "title": "Gets a list of Interactions",
18753     "examples": [
18754       {
18755         "title": "Example usage:",
18756         "content": "curl https://{domain}/api/openchannel/interactions -v -u {name}:{password}",
18757         "type": "json"
18758       }
18759     ],
18760     "name": "GetInteractions",
18761     "group": "Openchannel_Interactions",
18762     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
18763     "version": "0.0.0",
18764     "filename": "server/api/openchannelInteraction/index.js",
18765     "groupTitle": "Openchannel_Interactions"
18766   },
18767   {
18768     "type": "delete",
18769     "url": "/api/openchannel/interactions/{id}/tags",
18770     "title": "Removes tags from interaction",
18771     "examples": [
18772       {
18773         "title": "Example usage:",
18774         "content": "curl https://{domain}/api/openchannel/interactions/{id}/tags?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
18775         "type": "json"
18776       }
18777     ],
18778     "name": "RemoveTags",
18779     "group": "Openchannel_Interactions",
18780     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18781     "version": "0.0.0",
18782     "filename": "server/api/openchannelInteraction/index.js",
18783     "groupTitle": "Openchannel_Interactions"
18784   },
18785   {
18786     "type": "get",
18787     "url": "/api/openchannel/interactions/{id}",
18788     "title": "Gets a single Interaction",
18789     "examples": [
18790       {
18791         "title": "Example usage:",
18792         "content": "curl https://{domain}/api/openchannel/interactions/{id} -v -u {name}:{password}",
18793         "type": "json"
18794       }
18795     ],
18796     "name": "ShowInteractions",
18797     "group": "Openchannel_Interactions",
18798     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18799     "version": "0.0.0",
18800     "filename": "server/api/openchannelInteraction/index.js",
18801     "groupTitle": "Openchannel_Interactions"
18802   },
18803   {
18804     "type": "post",
18805     "url": "/api/openchannel/interactions/{id}/messages",
18806     "title": "Creates new messages",
18807     "examples": [
18808       {
18809         "title": "Example usage:",
18810         "content": "curl https://{domain}/api/openchannel/interactions/{id}/messages -d '[{\"to\": \"+3901119886500\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
18811         "type": "json"
18812       }
18813     ],
18814     "name": "addMessage",
18815     "group": "Openchannel_Interactions",
18816     "parameter": {
18817       "fields": {
18818         "Body": [
18819           {
18820             "group": "Body",
18821             "type": "Text",
18822             "optional": false,
18823             "field": "body",
18824             "description": ""
18825           },
18826           {
18827             "group": "Body",
18828             "type": "Boolean",
18829             "optional": true,
18830             "field": "read",
18831             "description": ""
18832           },
18833           {
18834             "group": "Body",
18835             "type": "Boolean",
18836             "optional": true,
18837             "field": "secret",
18838             "description": ""
18839           },
18840           {
18841             "group": "Body",
18842             "type": "String",
18843             "allowedValues": [
18844               "\"in\"",
18845               "\"out\""
18846             ],
18847             "optional": false,
18848             "field": "direction",
18849             "description": ""
18850           },
18851           {
18852             "group": "Body",
18853             "type": "String",
18854             "optional": true,
18855             "field": "readAt",
18856             "description": ""
18857           },
18858           {
18859             "group": "Body",
18860             "type": "String",
18861             "optional": true,
18862             "field": "providerName",
18863             "description": ""
18864           },
18865           {
18866             "group": "Body",
18867             "type": "Text",
18868             "optional": true,
18869             "field": "providerResponse",
18870             "description": ""
18871           }
18872         ]
18873       }
18874     },
18875     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18876     "version": "0.0.0",
18877     "filename": "server/api/openchannelInteraction/index.js",
18878     "groupTitle": "Openchannel_Interactions"
18879   },
18880   {
18881     "type": "get",
18882     "url": "/api/openchannel/interactions/{id}/download",
18883     "title": "Gets interaction",
18884     "examples": [
18885       {
18886         "title": "Example usage:",
18887         "content": "curl https://{domain}/api/openchannel/interactions/{id}/download -v -u {name}:{password} -X GET",
18888         "type": "json"
18889       }
18890     ],
18891     "name": "download",
18892     "group": "Openchannel_Interactions",
18893     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18894     "version": "0.0.0",
18895     "filename": "server/api/openchannelInteraction/index.js",
18896     "groupTitle": "Openchannel_Interactions"
18897   },
18898   {
18899     "type": "get",
18900     "url": "/api/openchannel/interactions/{id}/messages",
18901     "title": "Gets interaction messages",
18902     "examples": [
18903       {
18904         "title": "Example usage:",
18905         "content": "curl https://{domain}/api/openchannel/interactions/{id}/messages -v -u {name}:{password} -X GET",
18906         "type": "json"
18907       }
18908     ],
18909     "name": "getMessages",
18910     "group": "Openchannel_Interactions",
18911     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18912     "version": "0.0.0",
18913     "filename": "server/api/openchannelInteraction/index.js",
18914     "groupTitle": "Openchannel_Interactions"
18915   },
18916   {
18917     "type": "put",
18918     "url": "/api/openchannel/interactions/{id}",
18919     "title": "Update an existing Interaction",
18920     "examples": [
18921       {
18922         "title": "Example usage:",
18923         "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",
18924         "type": "json"
18925       }
18926     ],
18927     "name": "updateInteractions",
18928     "group": "Openchannel_Interactions",
18929     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18930     "version": "0.0.0",
18931     "filename": "server/api/openchannelInteraction/index.js",
18932     "groupTitle": "Openchannel_Interactions"
18933   },
18934   {
18935     "type": "post",
18936     "url": "/api/openchannel/messages",
18937     "title": "Creates a new Message",
18938     "examples": [
18939       {
18940         "title": "Example usage:",
18941         "content": "curl https://{domain}/api/openchannel/messages -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
18942         "type": "json"
18943       }
18944     ],
18945     "name": "CreateMessages",
18946     "group": "Openchannel_Messages",
18947     "parameter": {
18948       "fields": {
18949         "Body": [
18950           {
18951             "group": "Body",
18952             "type": "Text",
18953             "optional": false,
18954             "field": "body",
18955             "description": ""
18956           },
18957           {
18958             "group": "Body",
18959             "type": "Boolean",
18960             "optional": true,
18961             "field": "read",
18962             "description": ""
18963           },
18964           {
18965             "group": "Body",
18966             "type": "Boolean",
18967             "optional": true,
18968             "field": "secret",
18969             "description": ""
18970           },
18971           {
18972             "group": "Body",
18973             "type": "String",
18974             "allowedValues": [
18975               "\"in\"",
18976               "\"out\""
18977             ],
18978             "optional": false,
18979             "field": "direction",
18980             "description": ""
18981           },
18982           {
18983             "group": "Body",
18984             "type": "String",
18985             "optional": true,
18986             "field": "readAt",
18987             "description": ""
18988           },
18989           {
18990             "group": "Body",
18991             "type": "String",
18992             "optional": true,
18993             "field": "providerName",
18994             "description": ""
18995           },
18996           {
18997             "group": "Body",
18998             "type": "Text",
18999             "optional": true,
19000             "field": "providerResponse",
19001             "description": ""
19002           }
19003         ]
19004       }
19005     },
19006     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19007     "version": "0.0.0",
19008     "filename": "server/api/openchannelMessage/index.js",
19009     "groupTitle": "Openchannel_Messages"
19010   },
19011   {
19012     "type": "delete",
19013     "url": "/api/openchannel/messages/{id}",
19014     "title": "Deletes a Message",
19015     "examples": [
19016       {
19017         "title": "Example usage:",
19018         "content": "curl https://{domain}/api/openchannel/messages/{id} -v -u {name}:{password} -X DELETE",
19019         "type": "json"
19020       }
19021     ],
19022     "name": "DeleteMessages",
19023     "group": "Openchannel_Messages",
19024     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19025     "version": "0.0.0",
19026     "filename": "server/api/openchannelMessage/index.js",
19027     "groupTitle": "Openchannel_Messages"
19028   },
19029   {
19030     "type": "get",
19031     "url": "/api/openchannel/messages/describe",
19032     "title": "Gets table info about Messages",
19033     "examples": [
19034       {
19035         "title": "Example usage:",
19036         "content": "curl https://{domain}/api/openchannel/messages/describe -v -u {name}:{password}",
19037         "type": "json"
19038       }
19039     ],
19040     "name": "DescribeMessages",
19041     "group": "Openchannel_Messages",
19042     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19043     "version": "0.0.0",
19044     "filename": "server/api/openchannelMessage/index.js",
19045     "groupTitle": "Openchannel_Messages"
19046   },
19047   {
19048     "type": "get",
19049     "url": "/api/openchannel/messages",
19050     "title": "Gets a list of Messages",
19051     "examples": [
19052       {
19053         "title": "Example usage:",
19054         "content": "curl https://{domain}/api/openchannel/messages -v -u {name}:{password}",
19055         "type": "json"
19056       }
19057     ],
19058     "name": "GetMessages",
19059     "group": "Openchannel_Messages",
19060     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
19061     "version": "0.0.0",
19062     "filename": "server/api/openchannelMessage/index.js",
19063     "groupTitle": "Openchannel_Messages"
19064   },
19065   {
19066     "type": "get",
19067     "url": "/api/openchannel/messages/{id}",
19068     "title": "Gets a single Message",
19069     "examples": [
19070       {
19071         "title": "Example usage:",
19072         "content": "curl https://{domain}/api/openchannel/messages/{id} -v -u {name}:{password}",
19073         "type": "json"
19074       }
19075     ],
19076     "name": "ShowMessages",
19077     "group": "Openchannel_Messages",
19078     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19079     "version": "0.0.0",
19080     "filename": "server/api/openchannelMessage/index.js",
19081     "groupTitle": "Openchannel_Messages"
19082   },
19083   {
19084     "type": "put",
19085     "url": "/api/openchannel/messages/{id}/accept",
19086     "title": "Accepts message",
19087     "examples": [
19088       {
19089         "title": "Example usage:",
19090         "content": "curl https://{domain}/api/openchannel/messages/{id}/accept \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
19091         "type": "json"
19092       }
19093     ],
19094     "name": "acceptMessage",
19095     "group": "Openchannel_Messages",
19096     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19097     "version": "0.0.0",
19098     "filename": "server/api/openchannelMessage/index.js",
19099     "groupTitle": "Openchannel_Messages"
19100   },
19101   {
19102     "type": "put",
19103     "url": "/api/openchannel/messages/{id}/reject",
19104     "title": "Rejects message",
19105     "examples": [
19106       {
19107         "title": "Example usage:",
19108         "content": "curl https://{domain}/api/openchannel/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
19109         "type": "json"
19110       }
19111     ],
19112     "name": "rejectMessage",
19113     "group": "Openchannel_Messages",
19114     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19115     "version": "0.0.0",
19116     "filename": "server/api/openchannelMessage/index.js",
19117     "groupTitle": "Openchannel_Messages"
19118   },
19119   {
19120     "type": "put",
19121     "url": "/api/openchannel/messages/{id}",
19122     "title": "Update an existing Message",
19123     "examples": [
19124       {
19125         "title": "Example usage:",
19126         "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",
19127         "type": "json"
19128       }
19129     ],
19130     "name": "updateMessages",
19131     "group": "Openchannel_Messages",
19132     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19133     "version": "0.0.0",
19134     "filename": "server/api/openchannelMessage/index.js",
19135     "groupTitle": "Openchannel_Messages"
19136   },
19137   {
19138     "type": "post",
19139     "url": "/api/openchannel/reports/queue",
19140     "title": "Creates a new Openchannel Queue Report",
19141     "examples": [
19142       {
19143         "title": "Example usage:",
19144         "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",
19145         "type": "json"
19146       }
19147     ],
19148     "name": "CreateOpenchannel_Queue_Reports",
19149     "group": "Openchannel_Queue_Reports",
19150     "parameter": {
19151       "fields": {
19152         "Body": [
19153           {
19154             "group": "Body",
19155             "type": "String",
19156             "optional": false,
19157             "field": "uniqueid",
19158             "description": ""
19159           },
19160           {
19161             "group": "Body",
19162             "type": "String",
19163             "optional": true,
19164             "field": "from",
19165             "description": ""
19166           },
19167           {
19168             "group": "Body",
19169             "type": "String",
19170             "optional": true,
19171             "field": "joinAt",
19172             "description": ""
19173           },
19174           {
19175             "group": "Body",
19176             "type": "String",
19177             "optional": true,
19178             "field": "leaveAt",
19179             "description": ""
19180           },
19181           {
19182             "group": "Body",
19183             "type": "String",
19184             "optional": true,
19185             "field": "acceptAt",
19186             "description": ""
19187           },
19188           {
19189             "group": "Body",
19190             "type": "String",
19191             "optional": true,
19192             "field": "exitAt",
19193             "description": ""
19194           },
19195           {
19196             "group": "Body",
19197             "type": "String",
19198             "optional": true,
19199             "field": "reason",
19200             "description": ""
19201           }
19202         ]
19203       }
19204     },
19205     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19206     "version": "0.0.0",
19207     "filename": "server/api/openchannelQueueReport/index.js",
19208     "groupTitle": "Openchannel_Queue_Reports"
19209   },
19210   {
19211     "type": "delete",
19212     "url": "/api/openchannel/reports/queue/{id}",
19213     "title": "Deletes a Openchannel Queue Report",
19214     "examples": [
19215       {
19216         "title": "Example usage:",
19217         "content": "curl https://{domain}/api/openchannel/reports/queue/{id} -v -u {name}:{password} -X DELETE",
19218         "type": "json"
19219       }
19220     ],
19221     "name": "DeleteOpenchannel_Queue_Reports",
19222     "group": "Openchannel_Queue_Reports",
19223     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19224     "version": "0.0.0",
19225     "filename": "server/api/openchannelQueueReport/index.js",
19226     "groupTitle": "Openchannel_Queue_Reports"
19227   },
19228   {
19229     "type": "get",
19230     "url": "/api/openchannel/reports/queue/describe",
19231     "title": "Gets table info about Openchannel Queue Reports",
19232     "examples": [
19233       {
19234         "title": "Example usage:",
19235         "content": "curl https://{domain}/api/openchannel/reports/queue/describe -v -u {name}:{password}",
19236         "type": "json"
19237       }
19238     ],
19239     "name": "DescribeOpenchannel_Queue_Reports",
19240     "group": "Openchannel_Queue_Reports",
19241     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19242     "version": "0.0.0",
19243     "filename": "server/api/openchannelQueueReport/index.js",
19244     "groupTitle": "Openchannel_Queue_Reports"
19245   },
19246   {
19247     "type": "get",
19248     "url": "/api/openchannel/reports/queue",
19249     "title": "Gets a list of Openchannel Queue Reports",
19250     "examples": [
19251       {
19252         "title": "Example usage:",
19253         "content": "curl https://{domain}/api/openchannel/reports/queue -v -u {name}:{password}",
19254         "type": "json"
19255       }
19256     ],
19257     "name": "GetOpenchannel_Queue_Reports",
19258     "group": "Openchannel_Queue_Reports",
19259     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
19260     "version": "0.0.0",
19261     "filename": "server/api/openchannelQueueReport/index.js",
19262     "groupTitle": "Openchannel_Queue_Reports"
19263   },
19264   {
19265     "type": "get",
19266     "url": "/api/openchannel/reports/queue/{id}",
19267     "title": "Gets a single Openchannel Queue Report",
19268     "examples": [
19269       {
19270         "title": "Example usage:",
19271         "content": "curl https://{domain}/api/openchannel/reports/queue/{id} -v -u {name}:{password}",
19272         "type": "json"
19273       }
19274     ],
19275     "name": "ShowOpenchannel_Queue_Reports",
19276     "group": "Openchannel_Queue_Reports",
19277     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19278     "version": "0.0.0",
19279     "filename": "server/api/openchannelQueueReport/index.js",
19280     "groupTitle": "Openchannel_Queue_Reports"
19281   },
19282   {
19283     "type": "put",
19284     "url": "/api/openchannel/reports/queue/{id}",
19285     "title": "Update an existing Openchannel Queue Report",
19286     "examples": [
19287       {
19288         "title": "Example usage:",
19289         "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",
19290         "type": "json"
19291       }
19292     ],
19293     "name": "updateOpenchannel_Queue_Reports",
19294     "group": "Openchannel_Queue_Reports",
19295     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19296     "version": "0.0.0",
19297     "filename": "server/api/openchannelQueueReport/index.js",
19298     "groupTitle": "Openchannel_Queue_Reports"
19299   },
19300   {
19301     "type": "post",
19302     "url": "/api/openchannel/queues/{id}/users",
19303     "title": "Add agents to a queue",
19304     "examples": [
19305       {
19306         "title": "Example usage:",
19307         "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",
19308         "type": "json"
19309       }
19310     ],
19311     "name": "AddAgents",
19312     "group": "Openchannel_Queues",
19313     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19314     "version": "0.0.0",
19315     "filename": "server/api/openchannelQueue/index.js",
19316     "groupTitle": "Openchannel_Queues"
19317   },
19318   {
19319     "type": "post",
19320     "url": "/api/openchannel/queues/{id}/teams",
19321     "title": "Add teams to a queue",
19322     "examples": [
19323       {
19324         "title": "Example usage:",
19325         "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",
19326         "type": "json"
19327       }
19328     ],
19329     "name": "AddTeams",
19330     "group": "Openchannel_Queues",
19331     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19332     "version": "0.0.0",
19333     "filename": "server/api/openchannelQueue/index.js",
19334     "groupTitle": "Openchannel_Queues"
19335   },
19336   {
19337     "type": "post",
19338     "url": "/api/openchannel/queues",
19339     "title": "Creates a new Queue",
19340     "examples": [
19341       {
19342         "title": "Example usage:",
19343         "content": "curl https://{domain}/api/openchannel/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
19344         "type": "json"
19345       }
19346     ],
19347     "name": "CreateQueues",
19348     "group": "Openchannel_Queues",
19349     "parameter": {
19350       "fields": {
19351         "Body": [
19352           {
19353             "group": "Body",
19354             "type": "String",
19355             "optional": true,
19356             "field": "name",
19357             "description": ""
19358           },
19359           {
19360             "group": "Body",
19361             "type": "String",
19362             "optional": true,
19363             "field": "description",
19364             "description": ""
19365           },
19366           {
19367             "group": "Body",
19368             "type": "Integer",
19369             "optional": true,
19370             "field": "timeout",
19371             "description": ""
19372           },
19373           {
19374             "group": "Body",
19375             "type": "String",
19376             "allowedValues": [
19377               "\"rrmemory\"",
19378               "\"beepall\"",
19379               "\"roundrobin\""
19380             ],
19381             "optional": true,
19382             "field": "strategy",
19383             "description": ""
19384           }
19385         ]
19386       }
19387     },
19388     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19389     "version": "0.0.0",
19390     "filename": "server/api/openchannelQueue/index.js",
19391     "groupTitle": "Openchannel_Queues"
19392   },
19393   {
19394     "type": "delete",
19395     "url": "/api/openchannel/queues/{id}",
19396     "title": "Deletes a Queue",
19397     "examples": [
19398       {
19399         "title": "Example usage:",
19400         "content": "curl https://{domain}/api/openchannel/queues/{id} -v -u {name}:{password} -X DELETE",
19401         "type": "json"
19402       }
19403     ],
19404     "name": "DeleteQueues",
19405     "group": "Openchannel_Queues",
19406     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <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/openchannelQueue/index.js",
19409     "groupTitle": "Openchannel_Queues"
19410   },
19411   {
19412     "type": "get",
19413     "url": "/api/openchannel/queues/describe",
19414     "title": "Gets table info about Queues",
19415     "examples": [
19416       {
19417         "title": "Example usage:",
19418         "content": "curl https://{domain}/api/openchannel/queues/describe -v -u {name}:{password}",
19419         "type": "json"
19420       }
19421     ],
19422     "name": "DescribeQueues",
19423     "group": "Openchannel_Queues",
19424     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19425     "version": "0.0.0",
19426     "filename": "server/api/openchannelQueue/index.js",
19427     "groupTitle": "Openchannel_Queues"
19428   },
19429   {
19430     "type": "get",
19431     "url": "/api/openchannel/queues/{id}/users",
19432     "title": "Gets queue agents",
19433     "examples": [
19434       {
19435         "title": "Example usage:",
19436         "content": "curl https://{domain}/api/openchannel/queues/{id}/users -v -u {name}:{password} -X POST",
19437         "type": "json"
19438       }
19439     ],
19440     "name": "GetAgents",
19441     "group": "Openchannel_Queues",
19442     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19443     "version": "0.0.0",
19444     "filename": "server/api/openchannelQueue/index.js",
19445     "groupTitle": "Openchannel_Queues"
19446   },
19447   {
19448     "type": "get",
19449     "url": "/api/openchannel/queues/{id}/members",
19450     "title": "GetMembers",
19451     "examples": [
19452       {
19453         "title": "Example usage:",
19454         "content": "curl https://{domain}/api/openchannel/queues/{id}/members  -v -u {name}:{password}",
19455         "type": "json"
19456       }
19457     ],
19458     "name": "GetMembers",
19459     "group": "Openchannel_Queues",
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/openchannelQueue/index.js",
19463     "groupTitle": "Openchannel_Queues"
19464   },
19465   {
19466     "type": "get",
19467     "url": "/api/openchannel/queues",
19468     "title": "Gets a list of Queues",
19469     "examples": [
19470       {
19471         "title": "Example usage:",
19472         "content": "curl https://{domain}/api/openchannel/queues -v -u {name}:{password}",
19473         "type": "json"
19474       }
19475     ],
19476     "name": "GetQueues",
19477     "group": "Openchannel_Queues",
19478     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
19479     "version": "0.0.0",
19480     "filename": "server/api/openchannelQueue/index.js",
19481     "groupTitle": "Openchannel_Queues"
19482   },
19483   {
19484     "type": "get",
19485     "url": "/api/openchannel/queues/{id}/teams",
19486     "title": "Gets queues list",
19487     "examples": [
19488       {
19489         "title": "Example usage:",
19490         "content": "curl https://{domain}/api/openchannel/queues/{id}/teams -v -u {name}:{password}",
19491         "type": "json"
19492       }
19493     ],
19494     "name": "GetTeams",
19495     "group": "Openchannel_Queues",
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/openchannelQueue/index.js",
19499     "groupTitle": "Openchannel_Queues"
19500   },
19501   {
19502     "type": "delete",
19503     "url": "/api/openchannel/queues/{id}/users",
19504     "title": "Removes agents from a queue",
19505     "examples": [
19506       {
19507         "title": "Example usage:",
19508         "content": "curl https://{domain}/api/openchannel/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
19509         "type": "json"
19510       }
19511     ],
19512     "name": "RemoveAgents",
19513     "group": "Openchannel_Queues",
19514     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <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/openchannelQueue/index.js",
19517     "groupTitle": "Openchannel_Queues"
19518   },
19519   {
19520     "type": "get",
19521     "url": "/api/openchannel/queues/{id}",
19522     "title": "Gets a single Queue",
19523     "examples": [
19524       {
19525         "title": "Example usage:",
19526         "content": "curl https://{domain}/api/openchannel/queues/{id} -v -u {name}:{password}",
19527         "type": "json"
19528       }
19529     ],
19530     "name": "ShowQueues",
19531     "group": "Openchannel_Queues",
19532     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19533     "version": "0.0.0",
19534     "filename": "server/api/openchannelQueue/index.js",
19535     "groupTitle": "Openchannel_Queues"
19536   },
19537   {
19538     "type": "put",
19539     "url": "/api/openchannel/queues/{id}",
19540     "title": "Update an existing Queue",
19541     "examples": [
19542       {
19543         "title": "Example usage:",
19544         "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",
19545         "type": "json"
19546       }
19547     ],
19548     "name": "updateQueues",
19549     "group": "Openchannel_Queues",
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/openchannelQueue/index.js",
19553     "groupTitle": "Openchannel_Queues"
19554   },
19555   {
19556     "type": "post",
19557     "url": "/api/openchannel/reports/transfer",
19558     "title": "Creates a new Openchannel Transfer Report",
19559     "examples": [
19560       {
19561         "title": "Example usage:",
19562         "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",
19563         "type": "json"
19564       }
19565     ],
19566     "name": "CreateOpenchannel_Transfer_Reports",
19567     "group": "Openchannel_Transfer_Reports",
19568     "parameter": {
19569       "fields": {
19570         "Body": [
19571           {
19572             "group": "Body",
19573             "type": "String",
19574             "optional": false,
19575             "field": "uniqueid",
19576             "description": ""
19577           },
19578           {
19579             "group": "Body",
19580             "type": "String",
19581             "allowedValues": [
19582               "\"account\"",
19583               "\"agent\"",
19584               "\"queue\""
19585             ],
19586             "optional": false,
19587             "field": "type",
19588             "description": ""
19589           },
19590           {
19591             "group": "Body",
19592             "type": "String",
19593             "optional": false,
19594             "field": "transferredAt",
19595             "description": ""
19596           }
19597         ]
19598       }
19599     },
19600     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19601     "version": "0.0.0",
19602     "filename": "server/api/openchannelTransferReport/index.js",
19603     "groupTitle": "Openchannel_Transfer_Reports"
19604   },
19605   {
19606     "type": "delete",
19607     "url": "/api/openchannel/reports/transfer/{id}",
19608     "title": "Deletes a Openchannel Transfer Report",
19609     "examples": [
19610       {
19611         "title": "Example usage:",
19612         "content": "curl https://{domain}/api/openchannel/reports/transfer/{id} -v -u {name}:{password} -X DELETE",
19613         "type": "json"
19614       }
19615     ],
19616     "name": "DeleteOpenchannel_Transfer_Reports",
19617     "group": "Openchannel_Transfer_Reports",
19618     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19619     "version": "0.0.0",
19620     "filename": "server/api/openchannelTransferReport/index.js",
19621     "groupTitle": "Openchannel_Transfer_Reports"
19622   },
19623   {
19624     "type": "get",
19625     "url": "/api/openchannel/reports/transfer/describe",
19626     "title": "Gets table info about Openchannel Transfer Reports",
19627     "examples": [
19628       {
19629         "title": "Example usage:",
19630         "content": "curl https://{domain}/api/openchannel/reports/transfer/describe -v -u {name}:{password}",
19631         "type": "json"
19632       }
19633     ],
19634     "name": "DescribeOpenchannel_Transfer_Reports",
19635     "group": "Openchannel_Transfer_Reports",
19636     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19637     "version": "0.0.0",
19638     "filename": "server/api/openchannelTransferReport/index.js",
19639     "groupTitle": "Openchannel_Transfer_Reports"
19640   },
19641   {
19642     "type": "get",
19643     "url": "/api/openchannel/reports/transfer",
19644     "title": "Gets a list of Openchannel Transfer Reports",
19645     "examples": [
19646       {
19647         "title": "Example usage:",
19648         "content": "curl https://{domain}/api/openchannel/reports/transfer -v -u {name}:{password}",
19649         "type": "json"
19650       }
19651     ],
19652     "name": "GetOpenchannel_Transfer_Reports",
19653     "group": "Openchannel_Transfer_Reports",
19654     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
19655     "version": "0.0.0",
19656     "filename": "server/api/openchannelTransferReport/index.js",
19657     "groupTitle": "Openchannel_Transfer_Reports"
19658   },
19659   {
19660     "type": "get",
19661     "url": "/api/openchannel/reports/transfer/{id}",
19662     "title": "Gets a single Openchannel Transfer Report",
19663     "examples": [
19664       {
19665         "title": "Example usage:",
19666         "content": "curl https://{domain}/api/openchannel/reports/transfer/{id} -v -u {name}:{password}",
19667         "type": "json"
19668       }
19669     ],
19670     "name": "ShowOpenchannel_Transfer_Reports",
19671     "group": "Openchannel_Transfer_Reports",
19672     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19673     "version": "0.0.0",
19674     "filename": "server/api/openchannelTransferReport/index.js",
19675     "groupTitle": "Openchannel_Transfer_Reports"
19676   },
19677   {
19678     "type": "put",
19679     "url": "/api/openchannel/reports/transfer/{id}",
19680     "title": "Update an existing Openchannel Transfer Report",
19681     "examples": [
19682       {
19683         "title": "Example usage:",
19684         "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",
19685         "type": "json"
19686       }
19687     ],
19688     "name": "updateOpenchannel_Transfer_Reports",
19689     "group": "Openchannel_Transfer_Reports",
19690     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19691     "version": "0.0.0",
19692     "filename": "server/api/openchannelTransferReport/index.js",
19693     "groupTitle": "Openchannel_Transfer_Reports"
19694   },
19695   {
19696     "type": "post",
19697     "url": "/api/pauses",
19698     "title": "Creates a new Pause",
19699     "examples": [
19700       {
19701         "title": "Example usage:",
19702         "content": "curl https://{domain}/api/pauses -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
19703         "type": "json"
19704       }
19705     ],
19706     "name": "CreatePauses",
19707     "group": "Pauses",
19708     "parameter": {
19709       "fields": {
19710         "Body": [
19711           {
19712             "group": "Body",
19713             "type": "String",
19714             "optional": false,
19715             "field": "name",
19716             "description": ""
19717           },
19718           {
19719             "group": "Body",
19720             "type": "String",
19721             "optional": true,
19722             "field": "description",
19723             "description": ""
19724           }
19725         ]
19726       }
19727     },
19728     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19729     "version": "0.0.0",
19730     "filename": "server/api/pause/index.js",
19731     "groupTitle": "Pauses"
19732   },
19733   {
19734     "type": "delete",
19735     "url": "/api/pauses/{id}",
19736     "title": "Deletes a Pause",
19737     "examples": [
19738       {
19739         "title": "Example usage:",
19740         "content": "curl https://{domain}/api/pauses/{id} -v -u {name}:{password} -X DELETE",
19741         "type": "json"
19742       }
19743     ],
19744     "name": "DeletePauses",
19745     "group": "Pauses",
19746     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19747     "version": "0.0.0",
19748     "filename": "server/api/pause/index.js",
19749     "groupTitle": "Pauses"
19750   },
19751   {
19752     "type": "get",
19753     "url": "/api/pauses",
19754     "title": "Gets a list of Pauses",
19755     "examples": [
19756       {
19757         "title": "Example usage:",
19758         "content": "curl https://{domain}/api/pauses -v -u {name}:{password}",
19759         "type": "json"
19760       }
19761     ],
19762     "name": "GetPauses",
19763     "group": "Pauses",
19764     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
19765     "version": "0.0.0",
19766     "filename": "server/api/pause/index.js",
19767     "groupTitle": "Pauses"
19768   },
19769   {
19770     "type": "get",
19771     "url": "/api/pauses/{id}",
19772     "title": "Gets a single Pause",
19773     "examples": [
19774       {
19775         "title": "Example usage:",
19776         "content": "curl https://{domain}/api/pauses/{id} -v -u {name}:{password}",
19777         "type": "json"
19778       }
19779     ],
19780     "name": "ShowPauses",
19781     "group": "Pauses",
19782     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19783     "version": "0.0.0",
19784     "filename": "server/api/pause/index.js",
19785     "groupTitle": "Pauses"
19786   },
19787   {
19788     "type": "put",
19789     "url": "/api/pauses/{id}",
19790     "title": "Update an existing Pause",
19791     "examples": [
19792       {
19793         "title": "Example usage:",
19794         "content": "curl https://{domain}/api/pauses/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
19795         "type": "json"
19796       }
19797     ],
19798     "name": "updatePauses",
19799     "group": "Pauses",
19800     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19801     "version": "0.0.0",
19802     "filename": "server/api/pause/index.js",
19803     "groupTitle": "Pauses"
19804   },
19805   {
19806     "type": "get",
19807     "url": "/api/plugins",
19808     "title": "Gets a list of Plugins",
19809     "examples": [
19810       {
19811         "title": "Example usage:",
19812         "content": "curl https://{domain}/api/plugins -v -u {name}:{password}",
19813         "type": "json"
19814       }
19815     ],
19816     "name": "GetPlugins",
19817     "group": "Plugins",
19818     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
19819     "version": "0.0.0",
19820     "filename": "server/api/plugin/index.js",
19821     "groupTitle": "Plugins"
19822   },
19823   {
19824     "type": "get",
19825     "url": "/api/plugins/{id}",
19826     "title": "Gets a single Plugin",
19827     "examples": [
19828       {
19829         "title": "Example usage:",
19830         "content": "curl https://{domain}/api/plugins/{id} -v -u {name}:{password}",
19831         "type": "json"
19832       }
19833     ],
19834     "name": "ShowPlugins",
19835     "group": "Plugins",
19836     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19837     "version": "0.0.0",
19838     "filename": "server/api/plugin/index.js",
19839     "groupTitle": "Plugins"
19840   },
19841   {
19842     "type": "delete",
19843     "url": "/api/plugins/{id}",
19844     "title": "Delete a plugin",
19845     "examples": [
19846       {
19847         "title": "Example usage:",
19848         "content": "curl https://{domain}/api/plugins/{id} -v -u {name}:{password} -X DELETE",
19849         "type": "json"
19850       }
19851     ],
19852     "name": "destroyPlugin",
19853     "group": "Plugins",
19854     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19855     "version": "0.0.0",
19856     "filename": "server/api/plugin/index.js",
19857     "groupTitle": "Plugins"
19858   },
19859   {
19860     "type": "get",
19861     "url": "/api/plugins/{id}/download",
19862     "title": "Download plugin source code",
19863     "examples": [
19864       {
19865         "title": "Example usage:",
19866         "content": "curl https://{domain}/api/plugins/{id}/download -v -u {name}:{password} -X GET",
19867         "type": "json"
19868       }
19869     ],
19870     "name": "download",
19871     "group": "Plugins",
19872     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19873     "version": "0.0.0",
19874     "filename": "server/api/plugin/index.js",
19875     "groupTitle": "Plugins"
19876   },
19877   {
19878     "type": "put",
19879     "url": "/api/plugins/{id}",
19880     "title": "Update an existing plugin",
19881     "examples": [
19882       {
19883         "title": "Example usage:",
19884         "content": "curl https://{domain}/api/plugins/{id} -v -u {name}:{password} -X PUT",
19885         "type": "json"
19886       }
19887     ],
19888     "name": "updatePlugin",
19889     "group": "Plugins",
19890     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19891     "version": "0.0.0",
19892     "filename": "server/api/plugin/index.js",
19893     "groupTitle": "Plugins"
19894   },
19895   {
19896     "type": "post",
19897     "url": "/api/plugins",
19898     "title": "Upload new plugin",
19899     "examples": [
19900       {
19901         "title": "Example usage:",
19902         "content": "curl https://{domain}/api/plugins -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
19903         "type": "json"
19904       }
19905     ],
19906     "name": "uploadPlugin",
19907     "group": "Plugins",
19908     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19909     "version": "0.0.0",
19910     "filename": "server/api/plugin/index.js",
19911     "groupTitle": "Plugins"
19912   },
19913   {
19914     "type": "get",
19915     "url": "/api/plugins/webhook?hostname={host}&port={port}&encoding={encoding}&json={json}&path={path}",
19916     "title": "Redirect a plugin request to the specified path",
19917     "examples": [
19918       {
19919         "title": "Example usage:",
19920         "content": "curl https://{domain}/api/plugins/webhook?port={port}&path={path} -v -u {name}:{password} -X GET",
19921         "type": "json"
19922       }
19923     ],
19924     "name": "webhookPlugin",
19925     "group": "Plugins",
19926     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19927     "version": "0.0.0",
19928     "filename": "server/api/plugin/index.js",
19929     "groupTitle": "Plugins"
19930   },
19931   {
19932     "type": "post",
19933     "url": "/api/plugins/webhook?hostname={host}&port={port}&encoding={encoding}&json={json}&path={path}",
19934     "title": "Redirect a plugin request to the specified path",
19935     "examples": [
19936       {
19937         "title": "Example usage:",
19938         "content": "curl https://{domain}/api/plugins/webhook?port={port}&path={path} -H 'Content-Type: application/json' -X POST",
19939         "type": "json"
19940       }
19941     ],
19942     "name": "webhookPlugin",
19943     "group": "Plugins",
19944     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19945     "version": "0.0.0",
19946     "filename": "server/api/plugin/index.js",
19947     "groupTitle": "Plugins"
19948   },
19949   {
19950     "type": "delete",
19951     "url": "/api/pm2/{id}",
19952     "title": "Deletes an existing process",
19953     "examples": [
19954       {
19955         "title": "Example usage:",
19956         "content": "curl https://{domain}/api/pm2/{id} -v -u {name}:{password} -X DELETE",
19957         "type": "json"
19958       }
19959     ],
19960     "name": "DeletePm2Process",
19961     "group": "Pm2",
19962     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19963     "version": "0.0.0",
19964     "filename": "server/api/pm2/index.js",
19965     "groupTitle": "Pm2"
19966   },
19967   {
19968     "type": "get",
19969     "url": "/api/pm2/{id}",
19970     "title": "Gets a single pm2 process",
19971     "examples": [
19972       {
19973         "title": "Example usage:",
19974         "content": "curl https://{domain}/api/pm2/{id} -v -u {name}:{password}",
19975         "type": "json"
19976       }
19977     ],
19978     "name": "GetPm2Process",
19979     "group": "Pm2",
19980     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19981     "version": "0.0.0",
19982     "filename": "server/api/pm2/index.js",
19983     "groupTitle": "Pm2"
19984   },
19985   {
19986     "type": "get",
19987     "url": "/api/pm2",
19988     "title": "Gets pm2 processes",
19989     "examples": [
19990       {
19991         "title": "Example usage:",
19992         "content": "curl https://{domain}/api/pm2 -v -u {name}:{password}",
19993         "type": "json"
19994       }
19995     ],
19996     "name": "GetPm2Processes",
19997     "group": "Pm2",
19998     "description": "<p>Motion returns the pm2 processes list.</p>",
19999     "version": "0.0.0",
20000     "filename": "server/api/pm2/index.js",
20001     "groupTitle": "Pm2"
20002   },
20003   {
20004     "type": "post",
20005     "url": "/api/pm2",
20006     "title": "Start a single pm2 process",
20007     "examples": [
20008       {
20009         "title": "Example usage:",
20010         "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",
20011         "type": "json"
20012       }
20013     ],
20014     "name": "StartPm2Process",
20015     "group": "Pm2",
20016     "parameter": {
20017       "fields": {
20018         "Body": [
20019           {
20020             "group": "Body",
20021             "type": "String",
20022             "optional": false,
20023             "field": "name",
20024             "description": ""
20025           },
20026           {
20027             "group": "Body",
20028             "type": "String",
20029             "optional": false,
20030             "field": "script",
20031             "description": ""
20032           }
20033         ]
20034       }
20035     },
20036     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20037     "version": "0.0.0",
20038     "filename": "server/api/pm2/index.js",
20039     "groupTitle": "Pm2"
20040   },
20041   {
20042     "type": "put",
20043     "url": "/api/pm2/{id}",
20044     "title": "Update an existing process",
20045     "examples": [
20046       {
20047         "title": "Example usage:",
20048         "content": "curl https://{domain}/api/pm2/{id} -d '{\"status\": \"online\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
20049         "type": "json"
20050       }
20051     ],
20052     "name": "UpdatePm2Process",
20053     "group": "Pm2",
20054     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20055     "version": "0.0.0",
20056     "filename": "server/api/pm2/index.js",
20057     "groupTitle": "Pm2"
20058   },
20059   {
20060     "type": "get",
20061     "url": "/api/rpc/campaigns/",
20062     "title": "Gets a list of campaigns",
20063     "examples": [
20064       {
20065         "title": "Example usage:",
20066         "content": "curl https://{domain}/api/rpc/campaigns -v -u {name}:{password}",
20067         "type": "json"
20068       }
20069     ],
20070     "name": "Campaigns",
20071     "group": "RPC_Realtime",
20072     "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>",
20073     "version": "0.0.0",
20074     "filename": "server/api/rpc/index.js",
20075     "groupTitle": "RPC_Realtime"
20076   },
20077   {
20078     "type": "get",
20079     "url": "/api/rpc/fax/accounts",
20080     "title": "Gets a list of FaxAccounts",
20081     "examples": [
20082       {
20083         "title": "Example usage:",
20084         "content": "curl https://{domain}/api/rpc/fax/accounts -v -u {name}:{password}",
20085         "type": "json"
20086       }
20087     ],
20088     "name": "FaxAccounts",
20089     "group": "RPC_Realtime",
20090     "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>",
20091     "version": "0.0.0",
20092     "filename": "server/api/rpc/index.js",
20093     "groupTitle": "RPC_Realtime"
20094   },
20095   {
20096     "type": "put",
20097     "url": "/api/rpc/agents/:id/capacity",
20098     "title": "Sets agent capacity",
20099     "examples": [
20100       {
20101         "title": "Example usage:",
20102         "content": "curl https://{domain}/api/rpc/agents/:id/capacity -v -u {name}:{password}",
20103         "type": "json"
20104       }
20105     ],
20106     "name": "RTAgentCapacity",
20107     "group": "RPC_Realtime",
20108     "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>",
20109     "version": "0.0.0",
20110     "filename": "server/api/rpc/index.js",
20111     "groupTitle": "RPC_Realtime"
20112   },
20113   {
20114     "type": "get",
20115     "url": "/api/rpc/agents",
20116     "title": "Gets a list of RTAgents",
20117     "examples": [
20118       {
20119         "title": "Example usage:",
20120         "content": "curl https://{domain}/api/rpc/agents -v -u {name}:{password}",
20121         "type": "json"
20122       }
20123     ],
20124     "name": "RTAgents",
20125     "group": "RPC_Realtime",
20126     "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>",
20127     "version": "0.0.0",
20128     "filename": "server/api/rpc/index.js",
20129     "groupTitle": "RPC_Realtime"
20130   },
20131   {
20132     "type": "get",
20133     "url": "/api/rpc/chat/queues",
20134     "title": "Gets a list of RTChatQueues",
20135     "examples": [
20136       {
20137         "title": "Example usage:",
20138         "content": "curl https://{domain}/api/rpc/chat/queues -v -u {name}:{password}",
20139         "type": "json"
20140       }
20141     ],
20142     "name": "RTChatQueues",
20143     "group": "RPC_Realtime",
20144     "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>",
20145     "version": "0.0.0",
20146     "filename": "server/api/rpc/index.js",
20147     "groupTitle": "RPC_Realtime"
20148   },
20149   {
20150     "type": "get",
20151     "url": "/api/rpc/fax/queues",
20152     "title": "Gets a list of RTFaxQueues",
20153     "examples": [
20154       {
20155         "title": "Example usage:",
20156         "content": "curl https://{domain}/api/rpc/fax/queues -v -u {name}:{password}",
20157         "type": "json"
20158       }
20159     ],
20160     "name": "RTFaxQueues",
20161     "group": "RPC_Realtime",
20162     "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>",
20163     "version": "0.0.0",
20164     "filename": "server/api/rpc/index.js",
20165     "groupTitle": "RPC_Realtime"
20166   },
20167   {
20168     "type": "get",
20169     "url": "/api/rpc/mail/accounts",
20170     "title": "Gets a list of RTMailAccounts",
20171     "examples": [
20172       {
20173         "title": "Example usage:",
20174         "content": "curl https://{domain}/api/rpc/mail/accounts -v -u {name}:{password}",
20175         "type": "json"
20176       }
20177     ],
20178     "name": "RTMailAccounts",
20179     "group": "RPC_Realtime",
20180     "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>",
20181     "version": "0.0.0",
20182     "filename": "server/api/rpc/index.js",
20183     "groupTitle": "RPC_Realtime"
20184   },
20185   {
20186     "type": "get",
20187     "url": "/api/rpc/mail/queues",
20188     "title": "Gets a list of RTMailQueues",
20189     "examples": [
20190       {
20191         "title": "Example usage:",
20192         "content": "curl https://{domain}/api/rpc/mail/queues -v -u {name}:{password}",
20193         "type": "json"
20194       }
20195     ],
20196     "name": "RTMailQueues",
20197     "group": "RPC_Realtime",
20198     "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>",
20199     "version": "0.0.0",
20200     "filename": "server/api/rpc/index.js",
20201     "groupTitle": "RPC_Realtime"
20202   },
20203   {
20204     "type": "get",
20205     "url": "/api/rpc/openchannel/queues",
20206     "title": "Gets a list of RTOpenchannelQueues",
20207     "examples": [
20208       {
20209         "title": "Example usage:",
20210         "content": "curl https://{domain}/api/rpc/openchannel/queues -v -u {name}:{password}",
20211         "type": "json"
20212       }
20213     ],
20214     "name": "RTOpenchannelQueues",
20215     "group": "RPC_Realtime",
20216     "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>",
20217     "version": "0.0.0",
20218     "filename": "server/api/rpc/index.js",
20219     "groupTitle": "RPC_Realtime"
20220   },
20221   {
20222     "type": "get",
20223     "url": "/api/rpc/outbound/channels",
20224     "title": "Gets a list of RTOutboundChannels",
20225     "examples": [
20226       {
20227         "title": "Example usage:",
20228         "content": "curl https://{domain}/api/rpc/outbound/channels -v -u {name}:{password}",
20229         "type": "json"
20230       }
20231     ],
20232     "name": "RTOutboundChannels",
20233     "group": "RPC_Realtime",
20234     "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>",
20235     "version": "0.0.0",
20236     "filename": "server/api/rpc/index.js",
20237     "groupTitle": "RPC_Realtime"
20238   },
20239   {
20240     "type": "get",
20241     "url": "/api/rpc/sms/queues",
20242     "title": "Gets a list of RTSmsQueues",
20243     "examples": [
20244       {
20245         "title": "Example usage:",
20246         "content": "curl https://{domain}/api/rpc/sms/queues -v -u {name}:{password}",
20247         "type": "json"
20248       }
20249     ],
20250     "name": "RTSmsQueues",
20251     "group": "RPC_Realtime",
20252     "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>",
20253     "version": "0.0.0",
20254     "filename": "server/api/rpc/index.js",
20255     "groupTitle": "RPC_Realtime"
20256   },
20257   {
20258     "type": "get",
20259     "url": "/api/rpc/telephones",
20260     "title": "Gets a list of RTTelephones",
20261     "examples": [
20262       {
20263         "title": "Example usage:",
20264         "content": "curl https://{domain}/api/rpc/telephones -v -u {name}:{password}",
20265         "type": "json"
20266       }
20267     ],
20268     "name": "RTTelephones",
20269     "group": "RPC_Realtime",
20270     "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>",
20271     "version": "0.0.0",
20272     "filename": "server/api/rpc/index.js",
20273     "groupTitle": "RPC_Realtime"
20274   },
20275   {
20276     "type": "get",
20277     "url": "/api/rpc/trunks",
20278     "title": "Gets a list of RTTrunks",
20279     "examples": [
20280       {
20281         "title": "Example usage:",
20282         "content": "curl https://{domain}/api/rpc/trunks -v -u {name}:{password}",
20283         "type": "json"
20284       }
20285     ],
20286     "name": "RTTrunks",
20287     "group": "RPC_Realtime",
20288     "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>",
20289     "version": "0.0.0",
20290     "filename": "server/api/rpc/index.js",
20291     "groupTitle": "RPC_Realtime"
20292   },
20293   {
20294     "type": "get",
20295     "url": "/api/rpc/voice/channels",
20296     "title": "Gets a list of RTVoiceChannelMixMonitor",
20297     "examples": [
20298       {
20299         "title": "Example usage:",
20300         "content": "curl https://{domain}/api/rpc/voice/channels/{uniqueid}/mixmonitor -v -u {name}:{password}",
20301         "type": "json"
20302       }
20303     ],
20304     "name": "RTVoiceChannelMixMonitor",
20305     "group": "RPC_Realtime",
20306     "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>",
20307     "version": "0.0.0",
20308     "filename": "server/api/rpc/index.js",
20309     "groupTitle": "RPC_Realtime"
20310   },
20311   {
20312     "type": "get",
20313     "url": "/api/rpc/voice/channels",
20314     "title": "Gets a list of RTVoiceChannelStopMixMonitor",
20315     "examples": [
20316       {
20317         "title": "Example usage:",
20318         "content": "curl https://{domain}/api/rpc/voice/channels/{uniqueid}/stopmixmonitor -v -u {name}:{password}",
20319         "type": "json"
20320       }
20321     ],
20322     "name": "RTVoiceChannelStopMixMonitor",
20323     "group": "RPC_Realtime",
20324     "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>",
20325     "version": "0.0.0",
20326     "filename": "server/api/rpc/index.js",
20327     "groupTitle": "RPC_Realtime"
20328   },
20329   {
20330     "type": "get",
20331     "url": "/api/rpc/voice/channels",
20332     "title": "Gets a list of RTVoiceChannels",
20333     "examples": [
20334       {
20335         "title": "Example usage:",
20336         "content": "curl https://{domain}/api/rpc/voice/channels -v -u {name}:{password}",
20337         "type": "json"
20338       }
20339     ],
20340     "name": "RTVoiceChannels",
20341     "group": "RPC_Realtime",
20342     "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>",
20343     "version": "0.0.0",
20344     "filename": "server/api/rpc/index.js",
20345     "groupTitle": "RPC_Realtime"
20346   },
20347   {
20348     "type": "get",
20349     "url": "/api/rpc/voice/queues/channels/{uniqueid}",
20350     "title": "Gets a single RTVoiceQueueChannel",
20351     "examples": [
20352       {
20353         "title": "Example usage:",
20354         "content": "curl https://{domain}/api/rpc/voice/queues/channels/{uniqueid} -v -u {name}:{password}",
20355         "type": "json"
20356       }
20357     ],
20358     "name": "RTVoiceQueueChannel",
20359     "group": "RPC_Realtime",
20360     "description": "<p>Motion will return a specific realtime voice queue channel.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20361     "version": "0.0.0",
20362     "filename": "server/api/rpc/index.js",
20363     "groupTitle": "RPC_Realtime"
20364   },
20365   {
20366     "type": "get",
20367     "url": "/api/rpc/voice/queues/channels/{uniqueid}/hangup",
20368     "title": "Hangup a single RTVoiceQueueChannel",
20369     "examples": [
20370       {
20371         "title": "Example usage:",
20372         "content": "curl https://{domain}/api/rpc/voice/queues/channels/{uniqueid}/hangup -v -u {name}:{password}",
20373         "type": "json"
20374       }
20375     ],
20376     "name": "RTVoiceQueueChannelHangup",
20377     "group": "RPC_Realtime",
20378     "description": "<p>Motion will hangup a specific realtime voice queue channel.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20379     "version": "0.0.0",
20380     "filename": "server/api/rpc/index.js",
20381     "groupTitle": "RPC_Realtime"
20382   },
20383   {
20384     "type": "get",
20385     "url": "/api/rpc/voice/queues/channels/{uniqueid}/redirect/{exten}",
20386     "title": "Hangup a single RTVoiceQueueChannel",
20387     "examples": [
20388       {
20389         "title": "Example usage:",
20390         "content": "curl https://{domain}/api/rpc/voice/queues/channels/{uniqueid}/redirect/{exten} -v -u {name}:{password}",
20391         "type": "json"
20392       }
20393     ],
20394     "name": "RTVoiceQueueChannelRedirect",
20395     "group": "RPC_Realtime",
20396     "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>",
20397     "version": "0.0.0",
20398     "filename": "server/api/rpc/index.js",
20399     "groupTitle": "RPC_Realtime"
20400   },
20401   {
20402     "type": "get",
20403     "url": "/api/rpc/voice/queues/preview/{id}",
20404     "title": "Gets a single preview contact",
20405     "examples": [
20406       {
20407         "title": "Example usage:",
20408         "content": "curl https://{domain}/api/rpc/voice/queues/preview/{id} -v -u {name}:{password}",
20409         "type": "json"
20410       }
20411     ],
20412     "name": "RTVoiceQueuePreview",
20413     "group": "RPC_Realtime",
20414     "description": "<p>Motion will return a specific preview contact.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20415     "version": "0.0.0",
20416     "filename": "server/api/rpc/index.js",
20417     "groupTitle": "RPC_Realtime"
20418   },
20419   {
20420     "type": "get",
20421     "url": "/api/rpc/voice/queues",
20422     "title": "Gets a list of RTVoiceQueues",
20423     "examples": [
20424       {
20425         "title": "Example usage:",
20426         "content": "curl https://{domain}/api/rpc/voice/queues -v -u {name}:{password}",
20427         "type": "json"
20428       }
20429     ],
20430     "name": "RTVoiceQueues",
20431     "group": "RPC_Realtime",
20432     "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>",
20433     "version": "0.0.0",
20434     "filename": "server/api/rpc/index.js",
20435     "groupTitle": "RPC_Realtime"
20436   },
20437   {
20438     "type": "get",
20439     "url": "/api/rpc/outbound",
20440     "title": "Gets a list of RTOutbound",
20441     "examples": [
20442       {
20443         "title": "Example usage:",
20444         "content": "curl https://{domain}/api/rpc/outbound -v -u {name}:{password}",
20445         "type": "json"
20446       }
20447     ],
20448     "name": "RTVoiceQueues",
20449     "group": "RPC_Realtime",
20450     "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>",
20451     "version": "0.0.0",
20452     "filename": "server/api/rpc/index.js",
20453     "groupTitle": "RPC_Realtime"
20454   },
20455   {
20456     "type": "get",
20457     "url": "/api/rpc/voice/queues/channels",
20458     "title": "Gets a list of RTVoiceQueuesChannels",
20459     "examples": [
20460       {
20461         "title": "Example usage:",
20462         "content": "curl https://{domain}/api/rpc/voice/queues/channels -v -u {name}:{password}",
20463         "type": "json"
20464       }
20465     ],
20466     "name": "RTVoiceQueuesChannels",
20467     "group": "RPC_Realtime",
20468     "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>",
20469     "version": "0.0.0",
20470     "filename": "server/api/rpc/index.js",
20471     "groupTitle": "RPC_Realtime"
20472   },
20473   {
20474     "type": "get",
20475     "url": "/api/rpc/chat/queues/{id}",
20476     "title": "Gets a single RTChatQueue",
20477     "examples": [
20478       {
20479         "title": "Example usage:",
20480         "content": "curl https://{domain}/api/rpc/chat/queues/{id} -v -u {name}:{password}",
20481         "type": "json"
20482       }
20483     ],
20484     "name": "ShowRTChatQueues",
20485     "group": "RPC_Realtime",
20486     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20487     "version": "0.0.0",
20488     "filename": "server/api/rpc/index.js",
20489     "groupTitle": "RPC_Realtime"
20490   },
20491   {
20492     "type": "get",
20493     "url": "/api/rpc/fax/queues/{id}",
20494     "title": "Gets a single RTFaxQueue",
20495     "examples": [
20496       {
20497         "title": "Example usage:",
20498         "content": "curl https://{domain}/api/rpc/fax/queues/{id} -v -u {name}:{password}",
20499         "type": "json"
20500       }
20501     ],
20502     "name": "ShowRTFaxQueues",
20503     "group": "RPC_Realtime",
20504     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20505     "version": "0.0.0",
20506     "filename": "server/api/rpc/index.js",
20507     "groupTitle": "RPC_Realtime"
20508   },
20509   {
20510     "type": "get",
20511     "url": "/api/rpc/mail/queues/{id}",
20512     "title": "Gets a single RTMailQueue",
20513     "examples": [
20514       {
20515         "title": "Example usage:",
20516         "content": "curl https://{domain}/api/rpc/mail/queues/{id} -v -u {name}:{password}",
20517         "type": "json"
20518       }
20519     ],
20520     "name": "ShowRTMailQueues",
20521     "group": "RPC_Realtime",
20522     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20523     "version": "0.0.0",
20524     "filename": "server/api/rpc/index.js",
20525     "groupTitle": "RPC_Realtime"
20526   },
20527   {
20528     "type": "get",
20529     "url": "/api/rpc/openchannel/queues/{id}",
20530     "title": "Gets a single RTOpenchannelQueue",
20531     "examples": [
20532       {
20533         "title": "Example usage:",
20534         "content": "curl https://{domain}/api/rpc/openchannel/queues/{id} -v -u {name}:{password}",
20535         "type": "json"
20536       }
20537     ],
20538     "name": "ShowRTOpenchannelQueues",
20539     "group": "RPC_Realtime",
20540     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20541     "version": "0.0.0",
20542     "filename": "server/api/rpc/index.js",
20543     "groupTitle": "RPC_Realtime"
20544   },
20545   {
20546     "type": "get",
20547     "url": "/api/rpc/sms/queues/{id}",
20548     "title": "Gets a single RTSmsQueue",
20549     "examples": [
20550       {
20551         "title": "Example usage:",
20552         "content": "curl https://{domain}/api/rpc/sms/queues/{id} -v -u {name}:{password}",
20553         "type": "json"
20554       }
20555     ],
20556     "name": "ShowRTSmsQueues",
20557     "group": "RPC_Realtime",
20558     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20559     "version": "0.0.0",
20560     "filename": "server/api/rpc/index.js",
20561     "groupTitle": "RPC_Realtime"
20562   },
20563   {
20564     "type": "get",
20565     "url": "/api/rpc/voice/queues/{id}",
20566     "title": "Gets a single RTVoiceQueue",
20567     "examples": [
20568       {
20569         "title": "Example usage:",
20570         "content": "curl https://{domain}/api/rpc/voice/queues/{id} -v -u {name}:{password}",
20571         "type": "json"
20572       }
20573     ],
20574     "name": "ShowRTVoiceQueues",
20575     "group": "RPC_Realtime",
20576     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20577     "version": "0.0.0",
20578     "filename": "server/api/rpc/index.js",
20579     "groupTitle": "RPC_Realtime"
20580   },
20581   {
20582     "type": "put",
20583     "url": "/api/rpc/voice/{id}/queues",
20584     "title": "Updates a single VoiceQueue",
20585     "examples": [
20586       {
20587         "title": "Example usage:",
20588         "content": "curl https://{domain}/api/rpc/voice/queues/{id} -v -u {name}:{password}",
20589         "type": "json"
20590       }
20591     ],
20592     "name": "UpdateVoiceQueues",
20593     "group": "RPC_Realtime",
20594     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20595     "version": "0.0.0",
20596     "filename": "server/api/rpc/index.js",
20597     "groupTitle": "RPC_Realtime"
20598   },
20599   {
20600     "type": "post",
20601     "url": "/api/rpc/agents/:id/notify",
20602     "title": "Notify message to a specific agent",
20603     "examples": [
20604       {
20605         "title": "Example usage:",
20606         "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",
20607         "type": "json"
20608       }
20609     ],
20610     "name": "agentNotify",
20611     "group": "RPC_Realtime",
20612     "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>",
20613     "version": "0.0.0",
20614     "filename": "server/api/rpc/index.js",
20615     "groupTitle": "RPC_Realtime"
20616   },
20617   {
20618     "type": "post",
20619     "url": "/api/rpc/chat/queues/:id/notify",
20620     "title": "Notify message to a specific queue",
20621     "examples": [
20622       {
20623         "title": "Example usage:",
20624         "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",
20625         "type": "json"
20626       }
20627     ],
20628     "name": "chatQueueNotify",
20629     "group": "RPC_Realtime",
20630     "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>",
20631     "version": "0.0.0",
20632     "filename": "server/api/rpc/index.js",
20633     "groupTitle": "RPC_Realtime"
20634   },
20635   {
20636     "type": "get",
20637     "url": "/api/rpc/chat/queues/waitinginteractions",
20638     "title": "Gets a list of chatQueuesWaitingInteractions",
20639     "examples": [
20640       {
20641         "title": "Example usage:",
20642         "content": "curl https://{domain}/api/rpc/chat/queues/waitinginteractions -v -u {name}:{password}",
20643         "type": "json"
20644       }
20645     ],
20646     "name": "chatQueuesWaitingInteractions",
20647     "group": "RPC_Realtime",
20648     "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>",
20649     "version": "0.0.0",
20650     "filename": "server/api/rpc/index.js",
20651     "groupTitle": "RPC_Realtime"
20652   },
20653   {
20654     "type": "post",
20655     "url": "/api/rpc/fax/queues/:id/notify",
20656     "title": "Notify message to a specific queue",
20657     "examples": [
20658       {
20659         "title": "Example usage:",
20660         "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",
20661         "type": "json"
20662       }
20663     ],
20664     "name": "faxQueueNotify",
20665     "group": "RPC_Realtime",
20666     "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>",
20667     "version": "0.0.0",
20668     "filename": "server/api/rpc/index.js",
20669     "groupTitle": "RPC_Realtime"
20670   },
20671   {
20672     "type": "get",
20673     "url": "/api/rpc/fax/queues/waitinginteractions",
20674     "title": "Gets a list of faxQueuesWaitingInteractions",
20675     "examples": [
20676       {
20677         "title": "Example usage:",
20678         "content": "curl https://{domain}/api/rpc/fax/queues/waitinginteractions -v -u {name}:{password}",
20679         "type": "json"
20680       }
20681     ],
20682     "name": "faxQueuesWaitingInteractions",
20683     "group": "RPC_Realtime",
20684     "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>",
20685     "version": "0.0.0",
20686     "filename": "server/api/rpc/index.js",
20687     "groupTitle": "RPC_Realtime"
20688   },
20689   {
20690     "type": "post",
20691     "url": "/api/rpc/mail/queues/:id/notify",
20692     "title": "Notify message to a specific queue",
20693     "examples": [
20694       {
20695         "title": "Example usage:",
20696         "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",
20697         "type": "json"
20698       }
20699     ],
20700     "name": "mailQueueNotify",
20701     "group": "RPC_Realtime",
20702     "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>",
20703     "version": "0.0.0",
20704     "filename": "server/api/rpc/index.js",
20705     "groupTitle": "RPC_Realtime"
20706   },
20707   {
20708     "type": "get",
20709     "url": "/api/rpc/mail/queues/waitinginteractions",
20710     "title": "Gets a list of mailQueuesWaitingInteractions",
20711     "examples": [
20712       {
20713         "title": "Example usage:",
20714         "content": "curl https://{domain}/api/rpc/mail/queues/waitinginteractions -v -u {name}:{password}",
20715         "type": "json"
20716       }
20717     ],
20718     "name": "mailQueuesWaitingInteractions",
20719     "group": "RPC_Realtime",
20720     "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>",
20721     "version": "0.0.0",
20722     "filename": "server/api/rpc/index.js",
20723     "groupTitle": "RPC_Realtime"
20724   },
20725   {
20726     "type": "post",
20727     "url": "/api/rpc/openchannel/queues/:id/notify",
20728     "title": "Notify message to a specific queue",
20729     "examples": [
20730       {
20731         "title": "Example usage:",
20732         "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",
20733         "type": "json"
20734       }
20735     ],
20736     "name": "openchannelQueueNotify",
20737     "group": "RPC_Realtime",
20738     "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>",
20739     "version": "0.0.0",
20740     "filename": "server/api/rpc/index.js",
20741     "groupTitle": "RPC_Realtime"
20742   },
20743   {
20744     "type": "get",
20745     "url": "/api/rpc/openchannel/queues/:id/waitinginteractions",
20746     "title": "Gets a list of openchannelQueuesIdWaitingInteractions",
20747     "examples": [
20748       {
20749         "title": "Example usage:",
20750         "content": "curl https://{domain}/api/rpc/openchannel/queues/:id/waitinginteractions -v -u {name}:{password}",
20751         "type": "json"
20752       }
20753     ],
20754     "name": "openchannelQueuesIdWaitingInteractions",
20755     "group": "RPC_Realtime",
20756     "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>",
20757     "version": "0.0.0",
20758     "filename": "server/api/rpc/index.js",
20759     "groupTitle": "RPC_Realtime"
20760   },
20761   {
20762     "type": "get",
20763     "url": "/api/rpc/openchannel/queues/waitinginteractions",
20764     "title": "Gets a list of openchannelQueuesWaitingInteractions",
20765     "examples": [
20766       {
20767         "title": "Example usage:",
20768         "content": "curl https://{domain}/api/rpc/openchannel/queues/waitinginteractions -v -u {name}:{password}",
20769         "type": "json"
20770       }
20771     ],
20772     "name": "openchannelQueuesWaitingInteractions",
20773     "group": "RPC_Realtime",
20774     "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>",
20775     "version": "0.0.0",
20776     "filename": "server/api/rpc/index.js",
20777     "groupTitle": "RPC_Realtime"
20778   },
20779   {
20780     "type": "post",
20781     "url": "/api/rpc/sms/queues/:id/notify",
20782     "title": "Notify message to a specific queue",
20783     "examples": [
20784       {
20785         "title": "Example usage:",
20786         "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",
20787         "type": "json"
20788       }
20789     ],
20790     "name": "smsQueueNotify",
20791     "group": "RPC_Realtime",
20792     "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>",
20793     "version": "0.0.0",
20794     "filename": "server/api/rpc/index.js",
20795     "groupTitle": "RPC_Realtime"
20796   },
20797   {
20798     "type": "get",
20799     "url": "/api/rpc/sms/queues/waitinginteractions",
20800     "title": "Gets a list of smsQueuesWaitingInteractions",
20801     "examples": [
20802       {
20803         "title": "Example usage:",
20804         "content": "curl https://{domain}/api/rpc/sms/queues/waitinginteractions -v -u {name}:{password}",
20805         "type": "json"
20806       }
20807     ],
20808     "name": "smsQueuesWaitingInteractions",
20809     "group": "RPC_Realtime",
20810     "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>",
20811     "version": "0.0.0",
20812     "filename": "server/api/rpc/index.js",
20813     "groupTitle": "RPC_Realtime"
20814   },
20815   {
20816     "type": "post",
20817     "url": "/api/integrations/salesforce/accounts",
20818     "title": "Creates a new Salesforce Account",
20819     "examples": [
20820       {
20821         "title": "Example usage:",
20822         "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",
20823         "type": "json"
20824       }
20825     ],
20826     "name": "CreateSalesforce_Accounts",
20827     "group": "Salesforce_Accounts",
20828     "parameter": {
20829       "fields": {
20830         "Body": [
20831           {
20832             "group": "Body",
20833             "type": "String",
20834             "optional": true,
20835             "field": "name",
20836             "description": ""
20837           },
20838           {
20839             "group": "Body",
20840             "type": "String",
20841             "optional": true,
20842             "field": "description",
20843             "description": ""
20844           },
20845           {
20846             "group": "Body",
20847             "type": "String",
20848             "optional": true,
20849             "field": "username",
20850             "description": ""
20851           },
20852           {
20853             "group": "Body",
20854             "type": "String",
20855             "optional": true,
20856             "field": "remoteUri",
20857             "description": ""
20858           },
20859           {
20860             "group": "Body",
20861             "type": "String",
20862             "optional": true,
20863             "field": "password",
20864             "description": ""
20865           },
20866           {
20867             "group": "Body",
20868             "type": "String",
20869             "optional": true,
20870             "field": "clientId",
20871             "description": ""
20872           },
20873           {
20874             "group": "Body",
20875             "type": "String",
20876             "optional": true,
20877             "field": "clientSecret",
20878             "description": ""
20879           },
20880           {
20881             "group": "Body",
20882             "type": "String",
20883             "optional": true,
20884             "field": "securityToken",
20885             "description": ""
20886           },
20887           {
20888             "group": "Body",
20889             "type": "String",
20890             "optional": false,
20891             "field": "serverUrl",
20892             "description": ""
20893           },
20894           {
20895             "group": "Body",
20896             "type": "String",
20897             "allowedValues": [
20898               "\"integrationTab\"",
20899               "\"newTab\""
20900             ],
20901             "optional": true,
20902             "field": "type",
20903             "description": ""
20904           }
20905         ]
20906       }
20907     },
20908     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20909     "version": "0.0.0",
20910     "filename": "server/api/intSalesforceAccount/index.js",
20911     "groupTitle": "Salesforce_Accounts"
20912   },
20913   {
20914     "type": "delete",
20915     "url": "/api/integrations/salesforce/accounts/{id}",
20916     "title": "Deletes a Salesforce Account",
20917     "examples": [
20918       {
20919         "title": "Example usage:",
20920         "content": "curl https://{domain}/api/integrations/salesforce/accounts/{id} -v -u {name}:{password} -X DELETE",
20921         "type": "json"
20922       }
20923     ],
20924     "name": "DeleteSalesforce_Accounts",
20925     "group": "Salesforce_Accounts",
20926     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20927     "version": "0.0.0",
20928     "filename": "server/api/intSalesforceAccount/index.js",
20929     "groupTitle": "Salesforce_Accounts"
20930   },
20931   {
20932     "type": "get",
20933     "url": "/api/integrations/salesforce/accounts",
20934     "title": "Gets a list of Salesforce Accounts",
20935     "examples": [
20936       {
20937         "title": "Example usage:",
20938         "content": "curl https://{domain}/api/integrations/salesforce/accounts -v -u {name}:{password}",
20939         "type": "json"
20940       }
20941     ],
20942     "name": "GetSalesforce_Accounts",
20943     "group": "Salesforce_Accounts",
20944     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
20945     "version": "0.0.0",
20946     "filename": "server/api/intSalesforceAccount/index.js",
20947     "groupTitle": "Salesforce_Accounts"
20948   },
20949   {
20950     "type": "get",
20951     "url": "/api/integrations/salesforce/accounts/{id}",
20952     "title": "Gets a single Salesforce Account",
20953     "examples": [
20954       {
20955         "title": "Example usage:",
20956         "content": "curl https://{domain}/api/integrations/salesforce/accounts/{id} -v -u {name}:{password}",
20957         "type": "json"
20958       }
20959     ],
20960     "name": "ShowSalesforce_Accounts",
20961     "group": "Salesforce_Accounts",
20962     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20963     "version": "0.0.0",
20964     "filename": "server/api/intSalesforceAccount/index.js",
20965     "groupTitle": "Salesforce_Accounts"
20966   },
20967   {
20968     "type": "post",
20969     "url": "/api/integrations/salesforce/accounts/{id}/configurations",
20970     "title": "Creates new configuration",
20971     "examples": [
20972       {
20973         "title": "Example usage:",
20974         "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",
20975         "type": "json"
20976       }
20977     ],
20978     "name": "addConfiguration",
20979     "group": "Salesforce_Accounts",
20980     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20981     "version": "0.0.0",
20982     "filename": "server/api/intSalesforceAccount/index.js",
20983     "groupTitle": "Salesforce_Accounts"
20984   },
20985   {
20986     "type": "get",
20987     "url": "/api/integrations/salesforce/accounts/{id}/configurations",
20988     "title": "Gets account configurations",
20989     "examples": [
20990       {
20991         "title": "Example usage:",
20992         "content": "curl https://{domain}/api/integrations/salesforce/accounts/{id}/configurations -v -u {name}:{password} -X GET",
20993         "type": "json"
20994       }
20995     ],
20996     "name": "getConfigurations",
20997     "group": "Salesforce_Accounts",
20998     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20999     "version": "0.0.0",
21000     "filename": "server/api/intSalesforceAccount/index.js",
21001     "groupTitle": "Salesforce_Accounts"
21002   },
21003   {
21004     "type": "get",
21005     "url": "/api/integrations/salesforce/accounts/{id}/fields",
21006     "title": "Gets account fields",
21007     "examples": [
21008       {
21009         "title": "Example usage:",
21010         "content": "curl https://{domain}/api/integrations/salesforce/accounts/{id}/fields -v -u {name}:{password} -X GET",
21011         "type": "json"
21012       }
21013     ],
21014     "name": "getFields",
21015     "group": "Salesforce_Accounts",
21016     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21017     "version": "0.0.0",
21018     "filename": "server/api/intSalesforceAccount/index.js",
21019     "groupTitle": "Salesforce_Accounts"
21020   },
21021   {
21022     "type": "put",
21023     "url": "/api/integrations/salesforce/accounts/{id}",
21024     "title": "Update an existing Salesforce Account",
21025     "examples": [
21026       {
21027         "title": "Example usage:",
21028         "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",
21029         "type": "json"
21030       }
21031     ],
21032     "name": "updateSalesforce_Accounts",
21033     "group": "Salesforce_Accounts",
21034     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21035     "version": "0.0.0",
21036     "filename": "server/api/intSalesforceAccount/index.js",
21037     "groupTitle": "Salesforce_Accounts"
21038   },
21039   {
21040     "type": "post",
21041     "url": "/api/integrations/salesforce/configurations",
21042     "title": "Creates a new Salesforce Configuration",
21043     "examples": [
21044       {
21045         "title": "Example usage:",
21046         "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",
21047         "type": "json"
21048       }
21049     ],
21050     "name": "CreateSalesforce_Configurations",
21051     "group": "Salesforce_Configurations",
21052     "parameter": {
21053       "fields": {
21054         "Body": [
21055           {
21056             "group": "Body",
21057             "type": "String",
21058             "optional": true,
21059             "field": "name",
21060             "description": ""
21061           },
21062           {
21063             "group": "Body",
21064             "type": "String",
21065             "optional": true,
21066             "field": "description",
21067             "description": ""
21068           },
21069           {
21070             "group": "Body",
21071             "type": "String",
21072             "allowedValues": [
21073               "\"Task\"",
21074               "\"Case\""
21075             ],
21076             "optional": true,
21077             "field": "ticketType",
21078             "description": ""
21079           },
21080           {
21081             "group": "Body",
21082             "type": "String",
21083             "allowedValues": [
21084               "\"contact_lead\"",
21085               "\"contact\"",
21086               "\"lead\"",
21087               "\"account_contact_lead\"",
21088               "\"account\""
21089             ],
21090             "optional": true,
21091             "field": "moduleSearch",
21092             "description": ""
21093           },
21094           {
21095             "group": "Body",
21096             "type": "String",
21097             "allowedValues": [
21098               "\"nothing\"",
21099               "\"contact\"",
21100               "\"lead\"",
21101               "\"account\""
21102             ],
21103             "optional": true,
21104             "field": "moduleCreate",
21105             "description": ""
21106           },
21107           {
21108             "group": "Body",
21109             "type": "String",
21110             "optional": true,
21111             "field": "leadId",
21112             "description": ""
21113           },
21114           {
21115             "group": "Body",
21116             "type": "String",
21117             "optional": true,
21118             "field": "additionalSearchAccount",
21119             "description": ""
21120           },
21121           {
21122             "group": "Body",
21123             "type": "String",
21124             "optional": true,
21125             "field": "additionalSearchContact",
21126             "description": ""
21127           },
21128           {
21129             "group": "Body",
21130             "type": "String",
21131             "optional": true,
21132             "field": "additionalSearchLead",
21133             "description": ""
21134           }
21135         ]
21136       }
21137     },
21138     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21139     "version": "0.0.0",
21140     "filename": "server/api/intSalesforceConfiguration/index.js",
21141     "groupTitle": "Salesforce_Configurations"
21142   },
21143   {
21144     "type": "delete",
21145     "url": "/api/integrations/salesforce/configurations/{id}",
21146     "title": "Deletes a Salesforce Configuration",
21147     "examples": [
21148       {
21149         "title": "Example usage:",
21150         "content": "curl https://{domain}/api/integrations/salesforce/configurations/{id} -v -u {name}:{password} -X DELETE",
21151         "type": "json"
21152       }
21153     ],
21154     "name": "DeleteSalesforce_Configurations",
21155     "group": "Salesforce_Configurations",
21156     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21157     "version": "0.0.0",
21158     "filename": "server/api/intSalesforceConfiguration/index.js",
21159     "groupTitle": "Salesforce_Configurations"
21160   },
21161   {
21162     "type": "get",
21163     "url": "/api/integrations/salesforce/configurations",
21164     "title": "Gets a list of Salesforce Configurations",
21165     "examples": [
21166       {
21167         "title": "Example usage:",
21168         "content": "curl https://{domain}/api/integrations/salesforce/configurations -v -u {name}:{password}",
21169         "type": "json"
21170       }
21171     ],
21172     "name": "GetSalesforce_Configurations",
21173     "group": "Salesforce_Configurations",
21174     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
21175     "version": "0.0.0",
21176     "filename": "server/api/intSalesforceConfiguration/index.js",
21177     "groupTitle": "Salesforce_Configurations"
21178   },
21179   {
21180     "type": "get",
21181     "url": "/api/integrations/salesforce/configurations/{id}",
21182     "title": "Gets a single Salesforce Configuration",
21183     "examples": [
21184       {
21185         "title": "Example usage:",
21186         "content": "curl https://{domain}/api/integrations/salesforce/configurations/{id} -v -u {name}:{password}",
21187         "type": "json"
21188       }
21189     ],
21190     "name": "ShowSalesforce_Configurations",
21191     "group": "Salesforce_Configurations",
21192     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21193     "version": "0.0.0",
21194     "filename": "server/api/intSalesforceConfiguration/index.js",
21195     "groupTitle": "Salesforce_Configurations"
21196   },
21197   {
21198     "type": "get",
21199     "url": "/api/integrations/salesforce/configurations/{id}/descriptions",
21200     "title": "Gets configurations descriptions",
21201     "examples": [
21202       {
21203         "title": "Example usage:",
21204         "content": "curl https://{domain}/api/integrations/salesforce/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
21205         "type": "json"
21206       }
21207     ],
21208     "name": "getDescriptions",
21209     "group": "Salesforce_Configurations",
21210     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21211     "version": "0.0.0",
21212     "filename": "server/api/intSalesforceConfiguration/index.js",
21213     "groupTitle": "Salesforce_Configurations"
21214   },
21215   {
21216     "type": "get",
21217     "url": "/api/integrations/salesforce/configurations/{id}/fields",
21218     "title": "Gets configurations fields",
21219     "examples": [
21220       {
21221         "title": "Example usage:",
21222         "content": "curl https://{domain}/api/integrations/salesforce/configurations/{id}/fields -v -u {name}:{password} -X GET",
21223         "type": "json"
21224       }
21225     ],
21226     "name": "getFields",
21227     "group": "Salesforce_Configurations",
21228     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21229     "version": "0.0.0",
21230     "filename": "server/api/intSalesforceConfiguration/index.js",
21231     "groupTitle": "Salesforce_Configurations"
21232   },
21233   {
21234     "type": "get",
21235     "url": "/api/integrations/salesforce/configurations/{id}/subjects",
21236     "title": "Gets configurations subjects",
21237     "examples": [
21238       {
21239         "title": "Example usage:",
21240         "content": "curl https://{domain}/api/integrations/salesforce/configurations/{id}/subjects -v -u {name}:{password} -X GET",
21241         "type": "json"
21242       }
21243     ],
21244     "name": "getSubjects",
21245     "group": "Salesforce_Configurations",
21246     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <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/intSalesforceConfiguration/index.js",
21249     "groupTitle": "Salesforce_Configurations"
21250   },
21251   {
21252     "type": "put",
21253     "url": "/api/integrations/salesforce/configurations/{id}",
21254     "title": "Update an existing Salesforce Configuration",
21255     "examples": [
21256       {
21257         "title": "Example usage:",
21258         "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",
21259         "type": "json"
21260       }
21261     ],
21262     "name": "updateSalesforce_Configurations",
21263     "group": "Salesforce_Configurations",
21264     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21265     "version": "0.0.0",
21266     "filename": "server/api/intSalesforceConfiguration/index.js",
21267     "groupTitle": "Salesforce_Configurations"
21268   },
21269   {
21270     "type": "post",
21271     "url": "/api/integrations/salesforce/fields",
21272     "title": "Creates a new Salesforce Field",
21273     "examples": [
21274       {
21275         "title": "Example usage:",
21276         "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",
21277         "type": "json"
21278       }
21279     ],
21280     "name": "CreateSalesforce_Fields",
21281     "group": "Salesforce_Fields",
21282     "parameter": {
21283       "fields": {
21284         "Body": [
21285           {
21286             "group": "Body",
21287             "type": "String",
21288             "allowedValues": [
21289               "\"string\"",
21290               "\"variable\"",
21291               "\"customVariable\"",
21292               "\"keyValue\"",
21293               "\"picklist\""
21294             ],
21295             "optional": true,
21296             "field": "type",
21297             "description": ""
21298           },
21299           {
21300             "group": "Body",
21301             "type": "String",
21302             "optional": true,
21303             "field": "content",
21304             "description": ""
21305           },
21306           {
21307             "group": "Body",
21308             "type": "String",
21309             "optional": true,
21310             "field": "key",
21311             "description": ""
21312           },
21313           {
21314             "group": "Body",
21315             "type": "String",
21316             "allowedValues": [
21317               "\"string\"",
21318               "\"variable\"",
21319               "\"customVariable\""
21320             ],
21321             "optional": true,
21322             "field": "keyType",
21323             "description": ""
21324           },
21325           {
21326             "group": "Body",
21327             "type": "String",
21328             "optional": true,
21329             "field": "keyContent",
21330             "description": ""
21331           },
21332           {
21333             "group": "Body",
21334             "type": "String",
21335             "optional": true,
21336             "field": "idField",
21337             "description": ""
21338           },
21339           {
21340             "group": "Body",
21341             "type": "String",
21342             "optional": true,
21343             "field": "variableName",
21344             "description": ""
21345           }
21346         ]
21347       }
21348     },
21349     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21350     "version": "0.0.0",
21351     "filename": "server/api/intSalesforceField/index.js",
21352     "groupTitle": "Salesforce_Fields"
21353   },
21354   {
21355     "type": "delete",
21356     "url": "/api/integrations/salesforce/fields/{id}",
21357     "title": "Deletes a Salesforce Field",
21358     "examples": [
21359       {
21360         "title": "Example usage:",
21361         "content": "curl https://{domain}/api/integrations/salesforce/fields/{id} -v -u {name}:{password} -X DELETE",
21362         "type": "json"
21363       }
21364     ],
21365     "name": "DeleteSalesforce_Fields",
21366     "group": "Salesforce_Fields",
21367     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21368     "version": "0.0.0",
21369     "filename": "server/api/intSalesforceField/index.js",
21370     "groupTitle": "Salesforce_Fields"
21371   },
21372   {
21373     "type": "get",
21374     "url": "/api/integrations/salesforce/fields",
21375     "title": "Gets a list of Salesforce Fields",
21376     "examples": [
21377       {
21378         "title": "Example usage:",
21379         "content": "curl https://{domain}/api/integrations/salesforce/fields -v -u {name}:{password}",
21380         "type": "json"
21381       }
21382     ],
21383     "name": "GetSalesforce_Fields",
21384     "group": "Salesforce_Fields",
21385     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
21386     "version": "0.0.0",
21387     "filename": "server/api/intSalesforceField/index.js",
21388     "groupTitle": "Salesforce_Fields"
21389   },
21390   {
21391     "type": "get",
21392     "url": "/api/integrations/salesforce/fields/{id}",
21393     "title": "Gets a single Salesforce Field",
21394     "examples": [
21395       {
21396         "title": "Example usage:",
21397         "content": "curl https://{domain}/api/integrations/salesforce/fields/{id} -v -u {name}:{password}",
21398         "type": "json"
21399       }
21400     ],
21401     "name": "ShowSalesforce_Fields",
21402     "group": "Salesforce_Fields",
21403     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21404     "version": "0.0.0",
21405     "filename": "server/api/intSalesforceField/index.js",
21406     "groupTitle": "Salesforce_Fields"
21407   },
21408   {
21409     "type": "put",
21410     "url": "/api/integrations/salesforce/fields/{id}",
21411     "title": "Update an existing Salesforce Field",
21412     "examples": [
21413       {
21414         "title": "Example usage:",
21415         "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",
21416         "type": "json"
21417       }
21418     ],
21419     "name": "updateSalesforce_Fields",
21420     "group": "Salesforce_Fields",
21421     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21422     "version": "0.0.0",
21423     "filename": "server/api/intSalesforceField/index.js",
21424     "groupTitle": "Salesforce_Fields"
21425   },
21426   {
21427     "type": "post",
21428     "url": "/api/schedules",
21429     "title": "Creates a new Schedule",
21430     "examples": [
21431       {
21432         "title": "Example usage:",
21433         "content": "curl https://{domain}/api/schedules -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
21434         "type": "json"
21435       }
21436     ],
21437     "name": "CreateSchedules",
21438     "group": "Schedules",
21439     "parameter": {
21440       "fields": {
21441         "Body": [
21442           {
21443             "group": "Body",
21444             "type": "String",
21445             "optional": false,
21446             "field": "name",
21447             "description": ""
21448           },
21449           {
21450             "group": "Body",
21451             "type": "String",
21452             "optional": true,
21453             "field": "description",
21454             "description": ""
21455           },
21456           {
21457             "group": "Body",
21458             "type": "Boolean",
21459             "optional": false,
21460             "field": "active",
21461             "description": ""
21462           },
21463           {
21464             "group": "Body",
21465             "type": "String",
21466             "optional": false,
21467             "field": "cron",
21468             "description": ""
21469           },
21470           {
21471             "group": "Body",
21472             "type": "String",
21473             "optional": false,
21474             "field": "startAt",
21475             "description": ""
21476           },
21477           {
21478             "group": "Body",
21479             "type": "String",
21480             "optional": false,
21481             "field": "endAt",
21482             "description": ""
21483           },
21484           {
21485             "group": "Body",
21486             "type": "Integer",
21487             "optional": false,
21488             "field": "subtractNumber",
21489             "description": ""
21490           },
21491           {
21492             "group": "Body",
21493             "type": "String",
21494             "allowedValues": [
21495               "\"years\"",
21496               "\"quarters\"",
21497               "\"months\"",
21498               "\"weeks\"",
21499               "\"days\"",
21500               "\"hours\"",
21501               "\"minutes\""
21502             ],
21503             "optional": false,
21504             "field": "subtractUnit",
21505             "description": ""
21506           },
21507           {
21508             "group": "Body",
21509             "type": "String",
21510             "allowedValues": [
21511               "\"csv\"",
21512               "\"pdf\"",
21513               "\"xlsx\""
21514             ],
21515             "optional": false,
21516             "field": "output",
21517             "description": ""
21518           },
21519           {
21520             "group": "Body",
21521             "type": "String",
21522             "allowedValues": [
21523               "\"custom\"",
21524               "\"default\""
21525             ],
21526             "optional": false,
21527             "field": "type",
21528             "description": ""
21529           },
21530           {
21531             "group": "Body",
21532             "type": "Boolean",
21533             "optional": true,
21534             "field": "sendMail",
21535             "description": ""
21536           },
21537           {
21538             "group": "Body",
21539             "type": "String",
21540             "optional": true,
21541             "field": "email",
21542             "description": ""
21543           },
21544           {
21545             "group": "Body",
21546             "type": "Text",
21547             "optional": true,
21548             "field": "cc",
21549             "description": ""
21550           },
21551           {
21552             "group": "Body",
21553             "type": "Text",
21554             "optional": true,
21555             "field": "bcc",
21556             "description": ""
21557           },
21558           {
21559             "group": "Body",
21560             "type": "Boolean",
21561             "optional": true,
21562             "field": "sendIfEmpty",
21563             "description": ""
21564           }
21565         ]
21566       }
21567     },
21568     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21569     "version": "0.0.0",
21570     "filename": "server/api/schedule/index.js",
21571     "groupTitle": "Schedules"
21572   },
21573   {
21574     "type": "delete",
21575     "url": "/api/schedules/{id}",
21576     "title": "Deletes a Schedule",
21577     "examples": [
21578       {
21579         "title": "Example usage:",
21580         "content": "curl https://{domain}/api/schedules/{id} -v -u {name}:{password} -X DELETE",
21581         "type": "json"
21582       }
21583     ],
21584     "name": "DeleteSchedules",
21585     "group": "Schedules",
21586     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21587     "version": "0.0.0",
21588     "filename": "server/api/schedule/index.js",
21589     "groupTitle": "Schedules"
21590   },
21591   {
21592     "type": "get",
21593     "url": "/api/schedules",
21594     "title": "Gets a list of Schedules",
21595     "examples": [
21596       {
21597         "title": "Example usage:",
21598         "content": "curl https://{domain}/api/schedules -v -u {name}:{password}",
21599         "type": "json"
21600       }
21601     ],
21602     "name": "GetSchedules",
21603     "group": "Schedules",
21604     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
21605     "version": "0.0.0",
21606     "filename": "server/api/schedule/index.js",
21607     "groupTitle": "Schedules"
21608   },
21609   {
21610     "type": "get",
21611     "url": "/api/schedules/{id}",
21612     "title": "Gets a single Schedule",
21613     "examples": [
21614       {
21615         "title": "Example usage:",
21616         "content": "curl https://{domain}/api/schedules/{id} -v -u {name}:{password}",
21617         "type": "json"
21618       }
21619     ],
21620     "name": "ShowSchedules",
21621     "group": "Schedules",
21622     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21623     "version": "0.0.0",
21624     "filename": "server/api/schedule/index.js",
21625     "groupTitle": "Schedules"
21626   },
21627   {
21628     "type": "get",
21629     "url": "/api/schedules/{id}/run",
21630     "title": "Run Scheduler",
21631     "examples": [
21632       {
21633         "title": "Example usage:",
21634         "content": "curl https://{domain}/api/schedules/{id}/run -v -u {name}:{password} -X GET",
21635         "type": "json"
21636       }
21637     ],
21638     "name": "run",
21639     "group": "Schedules",
21640     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21641     "version": "0.0.0",
21642     "filename": "server/api/schedule/index.js",
21643     "groupTitle": "Schedules"
21644   },
21645   {
21646     "type": "put",
21647     "url": "/api/schedules/{id}",
21648     "title": "Update an existing Schedule",
21649     "examples": [
21650       {
21651         "title": "Example usage:",
21652         "content": "curl https://{domain}/api/schedules/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
21653         "type": "json"
21654       }
21655     ],
21656     "name": "updateSchedules",
21657     "group": "Schedules",
21658     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21659     "version": "0.0.0",
21660     "filename": "server/api/schedule/index.js",
21661     "groupTitle": "Schedules"
21662   },
21663   {
21664     "type": "post",
21665     "url": "/api/screen/recordings",
21666     "title": "Creates a new Recording",
21667     "examples": [
21668       {
21669         "title": "Example usage:",
21670         "content": "curl https://{domain}/api/screen/recordings -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
21671         "type": "json"
21672       }
21673     ],
21674     "name": "CreateRecordings",
21675     "group": "Screen_Recordings",
21676     "parameter": {
21677       "fields": {
21678         "Body": [
21679           {
21680             "group": "Body",
21681             "type": "Virtual",
21682             "optional": true,
21683             "field": "format",
21684             "description": ""
21685           },
21686           {
21687             "group": "Body",
21688             "type": "String",
21689             "optional": true,
21690             "field": "interactionid",
21691             "description": ""
21692           },
21693           {
21694             "group": "Body",
21695             "type": "String",
21696             "optional": true,
21697             "field": "channel",
21698             "description": ""
21699           },
21700           {
21701             "group": "Body",
21702             "type": "String",
21703             "optional": true,
21704             "field": "value",
21705             "description": ""
21706           },
21707           {
21708             "group": "Body",
21709             "type": "Integer",
21710             "optional": true,
21711             "field": "rating",
21712             "description": ""
21713           },
21714           {
21715             "group": "Body",
21716             "type": "Integer",
21717             "optional": true,
21718             "field": "duration",
21719             "description": ""
21720           },
21721           {
21722             "group": "Body",
21723             "type": "String",
21724             "optional": true,
21725             "field": "startedAt",
21726             "description": ""
21727           },
21728           {
21729             "group": "Body",
21730             "type": "String",
21731             "optional": true,
21732             "field": "closedAt",
21733             "description": ""
21734           },
21735           {
21736             "group": "Body",
21737             "type": "String",
21738             "optional": true,
21739             "field": "createdAt",
21740             "description": ""
21741           },
21742           {
21743             "group": "Body",
21744             "type": "String",
21745             "optional": true,
21746             "field": "updatedAt",
21747             "description": ""
21748           }
21749         ]
21750       }
21751     },
21752     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21753     "version": "0.0.0",
21754     "filename": "server/api/screenRecording/index.js",
21755     "groupTitle": "Screen_Recordings"
21756   },
21757   {
21758     "type": "get",
21759     "url": "/api/screen/recordings/describe",
21760     "title": "Gets table info about Recordings",
21761     "examples": [
21762       {
21763         "title": "Example usage:",
21764         "content": "curl https://{domain}/api/screen/recordings/describe -v -u {name}:{password}",
21765         "type": "json"
21766       }
21767     ],
21768     "name": "DescribeRecordings",
21769     "group": "Screen_Recordings",
21770     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21771     "version": "0.0.0",
21772     "filename": "server/api/screenRecording/index.js",
21773     "groupTitle": "Screen_Recordings"
21774   },
21775   {
21776     "type": "get",
21777     "url": "/api/screen/recordings",
21778     "title": "Gets a list of Recordings",
21779     "examples": [
21780       {
21781         "title": "Example usage:",
21782         "content": "curl https://{domain}/api/screen/recordings -v -u {name}:{password}",
21783         "type": "json"
21784       }
21785     ],
21786     "name": "GetRecordings",
21787     "group": "Screen_Recordings",
21788     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
21789     "version": "0.0.0",
21790     "filename": "server/api/screenRecording/index.js",
21791     "groupTitle": "Screen_Recordings"
21792   },
21793   {
21794     "type": "get",
21795     "url": "/api/screen/recordings/{id}",
21796     "title": "Gets a single Recording",
21797     "examples": [
21798       {
21799         "title": "Example usage:",
21800         "content": "curl https://{domain}/api/screen/recordings/{id} -v -u {name}:{password}",
21801         "type": "json"
21802       }
21803     ],
21804     "name": "ShowRecordings",
21805     "group": "Screen_Recordings",
21806     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21807     "version": "0.0.0",
21808     "filename": "server/api/screenRecording/index.js",
21809     "groupTitle": "Screen_Recordings"
21810   },
21811   {
21812     "type": "delete",
21813     "url": "/api/screen/recordings/{id}",
21814     "title": "Delete screen recording",
21815     "examples": [
21816       {
21817         "title": "Example usage:",
21818         "content": "curl https://{domain}/api/screen/recordings/{id} -v -u {name}:{password} -X DELETE",
21819         "type": "json"
21820       }
21821     ],
21822     "name": "destroy",
21823     "group": "Screen_Recordings",
21824     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21825     "version": "0.0.0",
21826     "filename": "server/api/screenRecording/index.js",
21827     "groupTitle": "Screen_Recordings"
21828   },
21829   {
21830     "type": "get",
21831     "url": "/api/screen/recordings/{id}/download",
21832     "title": "Download Recording",
21833     "examples": [
21834       {
21835         "title": "Example usage:",
21836         "content": "curl https://{domain}/api/screen/recordings/{id}/download -v -u {name}:{password} -X GET",
21837         "type": "json"
21838       }
21839     ],
21840     "name": "download",
21841     "group": "Screen_Recordings",
21842     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21843     "version": "0.0.0",
21844     "filename": "server/api/screenRecording/index.js",
21845     "groupTitle": "Screen_Recordings"
21846   },
21847   {
21848     "type": "put",
21849     "url": "/api/screen/recordings/{id}",
21850     "title": "Update an existing Recording",
21851     "examples": [
21852       {
21853         "title": "Example usage:",
21854         "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",
21855         "type": "json"
21856       }
21857     ],
21858     "name": "updateRecordings",
21859     "group": "Screen_Recordings",
21860     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21861     "version": "0.0.0",
21862     "filename": "server/api/screenRecording/index.js",
21863     "groupTitle": "Screen_Recordings"
21864   },
21865   {
21866     "type": "post",
21867     "url": "/api/integrations/servicenow/accounts",
21868     "title": "Creates a new Servicenow Account",
21869     "examples": [
21870       {
21871         "title": "Example usage:",
21872         "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",
21873         "type": "json"
21874       }
21875     ],
21876     "name": "CreateServicenow_Accounts",
21877     "group": "Servicenow_Accounts",
21878     "parameter": {
21879       "fields": {
21880         "Body": [
21881           {
21882             "group": "Body",
21883             "type": "String",
21884             "optional": true,
21885             "field": "name",
21886             "description": ""
21887           },
21888           {
21889             "group": "Body",
21890             "type": "String",
21891             "optional": true,
21892             "field": "description",
21893             "description": ""
21894           },
21895           {
21896             "group": "Body",
21897             "type": "String",
21898             "optional": true,
21899             "field": "username",
21900             "description": ""
21901           },
21902           {
21903             "group": "Body",
21904             "type": "String",
21905             "optional": true,
21906             "field": "password",
21907             "description": ""
21908           },
21909           {
21910             "group": "Body",
21911             "type": "String",
21912             "optional": true,
21913             "field": "email",
21914             "description": ""
21915           },
21916           {
21917             "group": "Body",
21918             "type": "String",
21919             "optional": true,
21920             "field": "remoteUri",
21921             "description": ""
21922           },
21923           {
21924             "group": "Body",
21925             "type": "String",
21926             "optional": false,
21927             "field": "serverUrl",
21928             "description": ""
21929           }
21930         ]
21931       }
21932     },
21933     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21934     "version": "0.0.0",
21935     "filename": "server/api/intServicenowAccount/index.js",
21936     "groupTitle": "Servicenow_Accounts"
21937   },
21938   {
21939     "type": "delete",
21940     "url": "/api/integrations/servicenow/accounts/{id}",
21941     "title": "Deletes a Servicenow Account",
21942     "examples": [
21943       {
21944         "title": "Example usage:",
21945         "content": "curl https://{domain}/api/integrations/servicenow/accounts/{id} -v -u {name}:{password} -X DELETE",
21946         "type": "json"
21947       }
21948     ],
21949     "name": "DeleteServicenow_Accounts",
21950     "group": "Servicenow_Accounts",
21951     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21952     "version": "0.0.0",
21953     "filename": "server/api/intServicenowAccount/index.js",
21954     "groupTitle": "Servicenow_Accounts"
21955   },
21956   {
21957     "type": "get",
21958     "url": "/api/integrations/servicenow/accounts",
21959     "title": "Gets a list of Servicenow Accounts",
21960     "examples": [
21961       {
21962         "title": "Example usage:",
21963         "content": "curl https://{domain}/api/integrations/servicenow/accounts -v -u {name}:{password}",
21964         "type": "json"
21965       }
21966     ],
21967     "name": "GetServicenow_Accounts",
21968     "group": "Servicenow_Accounts",
21969     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
21970     "version": "0.0.0",
21971     "filename": "server/api/intServicenowAccount/index.js",
21972     "groupTitle": "Servicenow_Accounts"
21973   },
21974   {
21975     "type": "get",
21976     "url": "/api/integrations/servicenow/accounts/{id}",
21977     "title": "Gets a single Servicenow Account",
21978     "examples": [
21979       {
21980         "title": "Example usage:",
21981         "content": "curl https://{domain}/api/integrations/servicenow/accounts/{id} -v -u {name}:{password}",
21982         "type": "json"
21983       }
21984     ],
21985     "name": "ShowServicenow_Accounts",
21986     "group": "Servicenow_Accounts",
21987     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21988     "version": "0.0.0",
21989     "filename": "server/api/intServicenowAccount/index.js",
21990     "groupTitle": "Servicenow_Accounts"
21991   },
21992   {
21993     "type": "post",
21994     "url": "/api/integrations/servicenow/accounts/{id}/configurations",
21995     "title": "Creates new configuration",
21996     "examples": [
21997       {
21998         "title": "Example usage:",
21999         "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",
22000         "type": "json"
22001       }
22002     ],
22003     "name": "addConfiguration",
22004     "group": "Servicenow_Accounts",
22005     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22006     "version": "0.0.0",
22007     "filename": "server/api/intServicenowAccount/index.js",
22008     "groupTitle": "Servicenow_Accounts"
22009   },
22010   {
22011     "type": "get",
22012     "url": "/api/integrations/servicenow/accounts/{id}/configurations",
22013     "title": "Gets account configurations",
22014     "examples": [
22015       {
22016         "title": "Example usage:",
22017         "content": "curl https://{domain}/api/integrations/servicenow/accounts/{id}/configurations -v -u {name}:{password} -X GET",
22018         "type": "json"
22019       }
22020     ],
22021     "name": "getConfigurations",
22022     "group": "Servicenow_Accounts",
22023     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22024     "version": "0.0.0",
22025     "filename": "server/api/intServicenowAccount/index.js",
22026     "groupTitle": "Servicenow_Accounts"
22027   },
22028   {
22029     "type": "get",
22030     "url": "/api/integrations/servicenow/accounts/{id}/fields",
22031     "title": "Gets account fields",
22032     "examples": [
22033       {
22034         "title": "Example usage:",
22035         "content": "curl https://{domain}/api/integrations/servicenow/accounts/{id}/fields -v -u {name}:{password} -X GET",
22036         "type": "json"
22037       }
22038     ],
22039     "name": "getFields",
22040     "group": "Servicenow_Accounts",
22041     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22042     "version": "0.0.0",
22043     "filename": "server/api/intServicenowAccount/index.js",
22044     "groupTitle": "Servicenow_Accounts"
22045   },
22046   {
22047     "type": "put",
22048     "url": "/api/integrations/servicenow/accounts/{id}",
22049     "title": "Update an existing Servicenow Account",
22050     "examples": [
22051       {
22052         "title": "Example usage:",
22053         "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",
22054         "type": "json"
22055       }
22056     ],
22057     "name": "updateServicenow_Accounts",
22058     "group": "Servicenow_Accounts",
22059     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22060     "version": "0.0.0",
22061     "filename": "server/api/intServicenowAccount/index.js",
22062     "groupTitle": "Servicenow_Accounts"
22063   },
22064   {
22065     "type": "post",
22066     "url": "/api/integrations/servicenow/configurations",
22067     "title": "Creates a new Servicenow Configuration",
22068     "examples": [
22069       {
22070         "title": "Example usage:",
22071         "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",
22072         "type": "json"
22073       }
22074     ],
22075     "name": "CreateServicenow_Configurations",
22076     "group": "Servicenow_Configurations",
22077     "parameter": {
22078       "fields": {
22079         "Body": [
22080           {
22081             "group": "Body",
22082             "type": "String",
22083             "optional": true,
22084             "field": "name",
22085             "description": ""
22086           },
22087           {
22088             "group": "Body",
22089             "type": "String",
22090             "optional": true,
22091             "field": "description",
22092             "description": ""
22093           }
22094         ]
22095       }
22096     },
22097     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22098     "version": "0.0.0",
22099     "filename": "server/api/intServicenowConfiguration/index.js",
22100     "groupTitle": "Servicenow_Configurations"
22101   },
22102   {
22103     "type": "delete",
22104     "url": "/api/integrations/servicenow/configurations/{id}",
22105     "title": "Deletes a Servicenow Configuration",
22106     "examples": [
22107       {
22108         "title": "Example usage:",
22109         "content": "curl https://{domain}/api/integrations/servicenow/configurations/{id} -v -u {name}:{password} -X DELETE",
22110         "type": "json"
22111       }
22112     ],
22113     "name": "DeleteServicenow_Configurations",
22114     "group": "Servicenow_Configurations",
22115     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22116     "version": "0.0.0",
22117     "filename": "server/api/intServicenowConfiguration/index.js",
22118     "groupTitle": "Servicenow_Configurations"
22119   },
22120   {
22121     "type": "get",
22122     "url": "/api/integrations/servicenow/configurations",
22123     "title": "Gets a list of Servicenow Configurations",
22124     "examples": [
22125       {
22126         "title": "Example usage:",
22127         "content": "curl https://{domain}/api/integrations/servicenow/configurations -v -u {name}:{password}",
22128         "type": "json"
22129       }
22130     ],
22131     "name": "GetServicenow_Configurations",
22132     "group": "Servicenow_Configurations",
22133     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
22134     "version": "0.0.0",
22135     "filename": "server/api/intServicenowConfiguration/index.js",
22136     "groupTitle": "Servicenow_Configurations"
22137   },
22138   {
22139     "type": "get",
22140     "url": "/api/integrations/servicenow/configurations/{id}",
22141     "title": "Gets a single Servicenow Configuration",
22142     "examples": [
22143       {
22144         "title": "Example usage:",
22145         "content": "curl https://{domain}/api/integrations/servicenow/configurations/{id} -v -u {name}:{password}",
22146         "type": "json"
22147       }
22148     ],
22149     "name": "ShowServicenow_Configurations",
22150     "group": "Servicenow_Configurations",
22151     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22152     "version": "0.0.0",
22153     "filename": "server/api/intServicenowConfiguration/index.js",
22154     "groupTitle": "Servicenow_Configurations"
22155   },
22156   {
22157     "type": "get",
22158     "url": "/api/integrations/servicenow/configurations/{id}/descriptions",
22159     "title": "Gets configurations descriptions",
22160     "examples": [
22161       {
22162         "title": "Example usage:",
22163         "content": "curl https://{domain}/api/integrations/servicenow/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
22164         "type": "json"
22165       }
22166     ],
22167     "name": "getDescriptions",
22168     "group": "Servicenow_Configurations",
22169     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22170     "version": "0.0.0",
22171     "filename": "server/api/intServicenowConfiguration/index.js",
22172     "groupTitle": "Servicenow_Configurations"
22173   },
22174   {
22175     "type": "get",
22176     "url": "/api/integrations/servicenow/configurations/{id}/fields",
22177     "title": "Gets configurations fields",
22178     "examples": [
22179       {
22180         "title": "Example usage:",
22181         "content": "curl https://{domain}/api/integrations/servicenow/configurations/{id}/fields -v -u {name}:{password} -X GET",
22182         "type": "json"
22183       }
22184     ],
22185     "name": "getFields",
22186     "group": "Servicenow_Configurations",
22187     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22188     "version": "0.0.0",
22189     "filename": "server/api/intServicenowConfiguration/index.js",
22190     "groupTitle": "Servicenow_Configurations"
22191   },
22192   {
22193     "type": "get",
22194     "url": "/api/integrations/servicenow/configurations/{id}/subjects",
22195     "title": "Gets configurations subjects",
22196     "examples": [
22197       {
22198         "title": "Example usage:",
22199         "content": "curl https://{domain}/api/integrations/servicenow/configurations/{id}/subjects -v -u {name}:{password} -X GET",
22200         "type": "json"
22201       }
22202     ],
22203     "name": "getSubjects",
22204     "group": "Servicenow_Configurations",
22205     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22206     "version": "0.0.0",
22207     "filename": "server/api/intServicenowConfiguration/index.js",
22208     "groupTitle": "Servicenow_Configurations"
22209   },
22210   {
22211     "type": "put",
22212     "url": "/api/integrations/servicenow/configurations/{id}",
22213     "title": "Update an existing Servicenow Configuration",
22214     "examples": [
22215       {
22216         "title": "Example usage:",
22217         "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",
22218         "type": "json"
22219       }
22220     ],
22221     "name": "updateServicenow_Configurations",
22222     "group": "Servicenow_Configurations",
22223     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22224     "version": "0.0.0",
22225     "filename": "server/api/intServicenowConfiguration/index.js",
22226     "groupTitle": "Servicenow_Configurations"
22227   },
22228   {
22229     "type": "post",
22230     "url": "/api/integrations/servicenow/fields",
22231     "title": "Creates a new Servicenow Field",
22232     "examples": [
22233       {
22234         "title": "Example usage:",
22235         "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",
22236         "type": "json"
22237       }
22238     ],
22239     "name": "CreateServicenow_Fields",
22240     "group": "Servicenow_Fields",
22241     "parameter": {
22242       "fields": {
22243         "Body": [
22244           {
22245             "group": "Body",
22246             "type": "String",
22247             "allowedValues": [
22248               "\"string\"",
22249               "\"variable\"",
22250               "\"customVariable\"",
22251               "\"keyValue\"",
22252               "\"picklist\""
22253             ],
22254             "optional": true,
22255             "field": "type",
22256             "description": ""
22257           },
22258           {
22259             "group": "Body",
22260             "type": "String",
22261             "optional": true,
22262             "field": "content",
22263             "description": ""
22264           },
22265           {
22266             "group": "Body",
22267             "type": "String",
22268             "optional": true,
22269             "field": "key",
22270             "description": ""
22271           },
22272           {
22273             "group": "Body",
22274             "type": "String",
22275             "allowedValues": [
22276               "\"string\"",
22277               "\"variable\"",
22278               "\"customVariable\""
22279             ],
22280             "optional": true,
22281             "field": "keyType",
22282             "description": ""
22283           },
22284           {
22285             "group": "Body",
22286             "type": "String",
22287             "optional": true,
22288             "field": "keyContent",
22289             "description": ""
22290           },
22291           {
22292             "group": "Body",
22293             "type": "String",
22294             "optional": true,
22295             "field": "idField",
22296             "description": ""
22297           },
22298           {
22299             "group": "Body",
22300             "type": "String",
22301             "optional": true,
22302             "field": "nameField",
22303             "description": ""
22304           },
22305           {
22306             "group": "Body",
22307             "type": "Boolean",
22308             "optional": true,
22309             "field": "customField",
22310             "description": ""
22311           },
22312           {
22313             "group": "Body",
22314             "type": "String",
22315             "optional": true,
22316             "field": "variableName",
22317             "description": ""
22318           }
22319         ]
22320       }
22321     },
22322     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22323     "version": "0.0.0",
22324     "filename": "server/api/intServicenowField/index.js",
22325     "groupTitle": "Servicenow_Fields"
22326   },
22327   {
22328     "type": "delete",
22329     "url": "/api/integrations/servicenow/fields/{id}",
22330     "title": "Deletes a Servicenow Field",
22331     "examples": [
22332       {
22333         "title": "Example usage:",
22334         "content": "curl https://{domain}/api/integrations/servicenow/fields/{id} -v -u {name}:{password} -X DELETE",
22335         "type": "json"
22336       }
22337     ],
22338     "name": "DeleteServicenow_Fields",
22339     "group": "Servicenow_Fields",
22340     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22341     "version": "0.0.0",
22342     "filename": "server/api/intServicenowField/index.js",
22343     "groupTitle": "Servicenow_Fields"
22344   },
22345   {
22346     "type": "get",
22347     "url": "/api/integrations/servicenow/fields",
22348     "title": "Gets a list of Servicenow Fields",
22349     "examples": [
22350       {
22351         "title": "Example usage:",
22352         "content": "curl https://{domain}/api/integrations/servicenow/fields -v -u {name}:{password}",
22353         "type": "json"
22354       }
22355     ],
22356     "name": "GetServicenow_Fields",
22357     "group": "Servicenow_Fields",
22358     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
22359     "version": "0.0.0",
22360     "filename": "server/api/intServicenowField/index.js",
22361     "groupTitle": "Servicenow_Fields"
22362   },
22363   {
22364     "type": "get",
22365     "url": "/api/integrations/servicenow/fields/{id}",
22366     "title": "Gets a single Servicenow Field",
22367     "examples": [
22368       {
22369         "title": "Example usage:",
22370         "content": "curl https://{domain}/api/integrations/servicenow/fields/{id} -v -u {name}:{password}",
22371         "type": "json"
22372       }
22373     ],
22374     "name": "ShowServicenow_Fields",
22375     "group": "Servicenow_Fields",
22376     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22377     "version": "0.0.0",
22378     "filename": "server/api/intServicenowField/index.js",
22379     "groupTitle": "Servicenow_Fields"
22380   },
22381   {
22382     "type": "put",
22383     "url": "/api/integrations/servicenow/fields/{id}",
22384     "title": "Update an existing Servicenow Field",
22385     "examples": [
22386       {
22387         "title": "Example usage:",
22388         "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",
22389         "type": "json"
22390       }
22391     ],
22392     "name": "updateServicenow_Fields",
22393     "group": "Servicenow_Fields",
22394     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22395     "version": "0.0.0",
22396     "filename": "server/api/intServicenowField/index.js",
22397     "groupTitle": "Servicenow_Fields"
22398   },
22399   {
22400     "type": "get",
22401     "url": "/api/settings",
22402     "title": "Gets a list of Settings",
22403     "examples": [
22404       {
22405         "title": "Example usage:",
22406         "content": "curl https://{domain}/api/settings -v -u {name}:{password}",
22407         "type": "json"
22408       }
22409     ],
22410     "name": "GetSettings",
22411     "group": "Settings",
22412     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
22413     "version": "0.0.0",
22414     "filename": "server/api/setting/index.js",
22415     "groupTitle": "Settings"
22416   },
22417   {
22418     "type": "get",
22419     "url": "/api/settings/{id}",
22420     "title": "Gets a single Setting",
22421     "examples": [
22422       {
22423         "title": "Example usage:",
22424         "content": "curl https://{domain}/api/settings/{id} -v -u {name}:{password}",
22425         "type": "json"
22426       }
22427     ],
22428     "name": "ShowSettings",
22429     "group": "Settings",
22430     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22431     "version": "0.0.0",
22432     "filename": "server/api/setting/index.js",
22433     "groupTitle": "Settings"
22434   },
22435   {
22436     "type": "post",
22437     "url": "/api/settings/{id}/favicon",
22438     "title": "Add Favicon",
22439     "examples": [
22440       {
22441         "title": "Example usage:",
22442         "content": "curl https://{domain}/api/settings/{id}/favicon -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
22443         "type": "json"
22444       }
22445     ],
22446     "name": "addFavicon",
22447     "group": "Settings",
22448     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22449     "version": "0.0.0",
22450     "filename": "server/api/setting/index.js",
22451     "groupTitle": "Settings"
22452   },
22453   {
22454     "type": "post",
22455     "url": "/api/settings/{id}/logo",
22456     "title": "Add logo",
22457     "examples": [
22458       {
22459         "title": "Example usage:",
22460         "content": "curl https://{domain}/api/settings/{id}/logo -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
22461         "type": "json"
22462       }
22463     ],
22464     "name": "addLogo",
22465     "group": "Settings",
22466     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22467     "version": "0.0.0",
22468     "filename": "server/api/setting/index.js",
22469     "groupTitle": "Settings"
22470   },
22471   {
22472     "type": "post",
22473     "url": "/api/settings/{id}/logo_login",
22474     "title": "Add logo login",
22475     "examples": [
22476       {
22477         "title": "Example usage:",
22478         "content": "curl https://{domain}/api/settings/{id}/logo_login -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
22479         "type": "json"
22480       }
22481     ],
22482     "name": "addLogoLogin",
22483     "group": "Settings",
22484     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22485     "version": "0.0.0",
22486     "filename": "server/api/setting/index.js",
22487     "groupTitle": "Settings"
22488   },
22489   {
22490     "type": "post",
22491     "url": "/api/settings/{id}/preferred",
22492     "title": "Add Preferred",
22493     "examples": [
22494       {
22495         "title": "Example usage:",
22496         "content": "curl https://{domain}/api/settings/{id}/preferred -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
22497         "type": "json"
22498       }
22499     ],
22500     "name": "addPreferred",
22501     "group": "Settings",
22502     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22503     "version": "0.0.0",
22504     "filename": "server/api/setting/index.js",
22505     "groupTitle": "Settings"
22506   },
22507   {
22508     "type": "get",
22509     "url": "/api/settings/now",
22510     "title": "Get Server Current Date",
22511     "examples": [
22512       {
22513         "title": "Example usage:",
22514         "content": "curl https://{domain}/api/settings/now -v -X GET",
22515         "type": "json"
22516       }
22517     ],
22518     "name": "getDate",
22519     "group": "Settings",
22520     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22521     "version": "0.0.0",
22522     "filename": "server/api/setting/index.js",
22523     "groupTitle": "Settings"
22524   },
22525   {
22526     "type": "get",
22527     "url": "/api/settings/{id}/favicon",
22528     "title": "Get Favicon",
22529     "examples": [
22530       {
22531         "title": "Example usage:",
22532         "content": "curl https://{domain}/api/settings/{id}/favicon -v -X GET",
22533         "type": "json"
22534       }
22535     ],
22536     "name": "getFavicon",
22537     "group": "Settings",
22538     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22539     "version": "0.0.0",
22540     "filename": "server/api/setting/index.js",
22541     "groupTitle": "Settings"
22542   },
22543   {
22544     "type": "get",
22545     "url": "/api/settings/{id}/gdpr",
22546     "title": "Get gdpr settings",
22547     "examples": [
22548       {
22549         "title": "Example usage:",
22550         "content": "curl https://{domain}/api/settings/{id}/gdpr -v -u {name}:{password} -X GET",
22551         "type": "json"
22552       }
22553     ],
22554     "name": "getGdpr",
22555     "group": "Settings",
22556     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22557     "version": "0.0.0",
22558     "filename": "server/api/setting/index.js",
22559     "groupTitle": "Settings"
22560   },
22561   {
22562     "type": "get",
22563     "url": "/api/settings/{id}/logo",
22564     "title": "Get logo",
22565     "examples": [
22566       {
22567         "title": "Example usage:",
22568         "content": "curl https://{domain}/api/settings/{id}/logo -v -X GET",
22569         "type": "json"
22570       }
22571     ],
22572     "name": "getLogo",
22573     "group": "Settings",
22574     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22575     "version": "0.0.0",
22576     "filename": "server/api/setting/index.js",
22577     "groupTitle": "Settings"
22578   },
22579   {
22580     "type": "get",
22581     "url": "/api/settings/{id}/logo_login",
22582     "title": "Get logo login",
22583     "examples": [
22584       {
22585         "title": "Example usage:",
22586         "content": "curl https://{domain}/api/settings/{id}/logo_login -v -X GET",
22587         "type": "json"
22588       }
22589     ],
22590     "name": "getLogoLogin",
22591     "group": "Settings",
22592     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22593     "version": "0.0.0",
22594     "filename": "server/api/setting/index.js",
22595     "groupTitle": "Settings"
22596   },
22597   {
22598     "type": "get",
22599     "url": "/api/settings/{id}/preferred",
22600     "title": "Get Preferred",
22601     "examples": [
22602       {
22603         "title": "Example usage:",
22604         "content": "curl https://{domain}/api/settings/{id}/preferred -v -X GET",
22605         "type": "json"
22606       }
22607     ],
22608     "name": "getPreferred",
22609     "group": "Settings",
22610     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22611     "version": "0.0.0",
22612     "filename": "server/api/setting/index.js",
22613     "groupTitle": "Settings"
22614   },
22615   {
22616     "type": "put",
22617     "url": "/api/settings/{id}",
22618     "title": "Update an existing Setting",
22619     "examples": [
22620       {
22621         "title": "Example usage:",
22622         "content": "curl https://{domain}/api/settings/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
22623         "type": "json"
22624       }
22625     ],
22626     "name": "updateSettings",
22627     "group": "Settings",
22628     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22629     "version": "0.0.0",
22630     "filename": "server/api/setting/index.js",
22631     "groupTitle": "Settings"
22632   },
22633   {
22634     "type": "post",
22635     "url": "/api/sms/accounts/{id}/users",
22636     "title": "Add agents to a sms account",
22637     "examples": [
22638       {
22639         "title": "Example usage:",
22640         "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",
22641         "type": "json"
22642       }
22643     ],
22644     "name": "AddAgents",
22645     "group": "Sms_Accounts",
22646     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22647     "version": "0.0.0",
22648     "filename": "server/api/smsAccount/index.js",
22649     "groupTitle": "Sms_Accounts"
22650   },
22651   {
22652     "type": "post",
22653     "url": "/api/sms/accounts",
22654     "title": "Creates a new Account",
22655     "examples": [
22656       {
22657         "title": "Example usage:",
22658         "content": "curl https://{domain}/api/sms/accounts -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
22659         "type": "json"
22660       }
22661     ],
22662     "name": "CreateAccounts",
22663     "group": "Sms_Accounts",
22664     "parameter": {
22665       "fields": {
22666         "Body": [
22667           {
22668             "group": "Body",
22669             "type": "String",
22670             "optional": false,
22671             "field": "name",
22672             "description": ""
22673           },
22674           {
22675             "group": "Body",
22676             "type": "String",
22677             "optional": false,
22678             "field": "key",
22679             "description": ""
22680           },
22681           {
22682             "group": "Body",
22683             "type": "String",
22684             "optional": false,
22685             "field": "remote",
22686             "description": ""
22687           },
22688           {
22689             "group": "Body",
22690             "type": "String",
22691             "optional": true,
22692             "field": "token",
22693             "description": ""
22694           },
22695           {
22696             "group": "Body",
22697             "type": "String",
22698             "optional": true,
22699             "field": "phone",
22700             "description": ""
22701           },
22702           {
22703             "group": "Body",
22704             "type": "String",
22705             "allowedValues": [
22706               "\"twilio\"",
22707               "\"skebby\"",
22708               "\"connectel\"",
22709               "\"clicksend\"",
22710               "\"plivo\"",
22711               "\"clickatell\"",
22712               "\"bandwidth\"",
22713               "\"csc\"",
22714               "\"infobip\"",
22715               "\"intelepeer\""
22716             ],
22717             "optional": true,
22718             "field": "type",
22719             "description": ""
22720           },
22721           {
22722             "group": "Body",
22723             "type": "String",
22724             "optional": true,
22725             "field": "accountSid",
22726             "description": ""
22727           },
22728           {
22729             "group": "Body",
22730             "type": "String",
22731             "optional": true,
22732             "field": "authId",
22733             "description": ""
22734           },
22735           {
22736             "group": "Body",
22737             "type": "String",
22738             "optional": true,
22739             "field": "authToken",
22740             "description": ""
22741           },
22742           {
22743             "group": "Body",
22744             "type": "String",
22745             "allowedValues": [
22746               "\"SI\"",
22747               "\"TI\"",
22748               "\"GP\""
22749             ],
22750             "optional": true,
22751             "field": "smsMethod",
22752             "description": ""
22753           },
22754           {
22755             "group": "Body",
22756             "type": "String",
22757             "optional": true,
22758             "field": "username",
22759             "description": ""
22760           },
22761           {
22762             "group": "Body",
22763             "type": "String",
22764             "optional": true,
22765             "field": "password",
22766             "description": ""
22767           },
22768           {
22769             "group": "Body",
22770             "type": "String",
22771             "optional": true,
22772             "field": "apiKey",
22773             "description": ""
22774           },
22775           {
22776             "group": "Body",
22777             "type": "String",
22778             "optional": true,
22779             "field": "applicationId",
22780             "description": ""
22781           },
22782           {
22783             "group": "Body",
22784             "type": "String",
22785             "optional": true,
22786             "field": "accountId",
22787             "description": ""
22788           },
22789           {
22790             "group": "Body",
22791             "type": "String",
22792             "optional": true,
22793             "field": "senderString",
22794             "description": ""
22795           },
22796           {
22797             "group": "Body",
22798             "type": "Boolean",
22799             "optional": true,
22800             "field": "deliveryReport",
22801             "description": ""
22802           },
22803           {
22804             "group": "Body",
22805             "type": "String",
22806             "optional": true,
22807             "field": "description",
22808             "description": ""
22809           },
22810           {
22811             "group": "Body",
22812             "type": "Text",
22813             "optional": true,
22814             "field": "notificationTemplate",
22815             "description": ""
22816           },
22817           {
22818             "group": "Body",
22819             "type": "Boolean",
22820             "optional": true,
22821             "field": "notificationSound",
22822             "description": ""
22823           },
22824           {
22825             "group": "Body",
22826             "type": "Boolean",
22827             "optional": true,
22828             "field": "notificationShake",
22829             "description": ""
22830           },
22831           {
22832             "group": "Body",
22833             "type": "Integer",
22834             "optional": true,
22835             "field": "waitForTheAssignedAgent",
22836             "description": ""
22837           },
22838           {
22839             "group": "Body",
22840             "type": "Boolean",
22841             "optional": true,
22842             "field": "queueTransfer",
22843             "description": ""
22844           },
22845           {
22846             "group": "Body",
22847             "type": "Integer",
22848             "optional": true,
22849             "field": "queueTransferTimeout",
22850             "description": ""
22851           },
22852           {
22853             "group": "Body",
22854             "type": "Boolean",
22855             "optional": true,
22856             "field": "agentTransfer",
22857             "description": ""
22858           },
22859           {
22860             "group": "Body",
22861             "type": "Integer",
22862             "optional": true,
22863             "field": "agentTransferTimeout",
22864             "description": ""
22865           },
22866           {
22867             "group": "Body",
22868             "type": "String",
22869             "optional": true,
22870             "field": "baseUrl",
22871             "description": ""
22872           },
22873           {
22874             "group": "Body",
22875             "type": "Integer",
22876             "optional": true,
22877             "field": "mandatoryDispositionPauseId",
22878             "description": "<p>Status to put when mandatory disposition is enabled</p>"
22879           },
22880           {
22881             "group": "Body",
22882             "type": "Boolean",
22883             "optional": true,
22884             "field": "mandatoryDisposition",
22885             "description": "<p>Enabled/disables mandatory dispo on a queue</p>"
22886           }
22887         ]
22888       }
22889     },
22890     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22891     "version": "0.0.0",
22892     "filename": "server/api/smsAccount/index.js",
22893     "groupTitle": "Sms_Accounts"
22894   },
22895   {
22896     "type": "delete",
22897     "url": "/api/sms/accounts/{id}",
22898     "title": "Deletes a Account",
22899     "examples": [
22900       {
22901         "title": "Example usage:",
22902         "content": "curl https://{domain}/api/sms/accounts/{id} -v -u {name}:{password} -X DELETE",
22903         "type": "json"
22904       }
22905     ],
22906     "name": "DeleteAccounts",
22907     "group": "Sms_Accounts",
22908     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22909     "version": "0.0.0",
22910     "filename": "server/api/smsAccount/index.js",
22911     "groupTitle": "Sms_Accounts"
22912   },
22913   {
22914     "type": "get",
22915     "url": "/api/sms/accounts/describe",
22916     "title": "Gets table info about Accounts",
22917     "examples": [
22918       {
22919         "title": "Example usage:",
22920         "content": "curl https://{domain}/api/sms/accounts/describe -v -u {name}:{password}",
22921         "type": "json"
22922       }
22923     ],
22924     "name": "DescribeAccounts",
22925     "group": "Sms_Accounts",
22926     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22927     "version": "0.0.0",
22928     "filename": "server/api/smsAccount/index.js",
22929     "groupTitle": "Sms_Accounts"
22930   },
22931   {
22932     "type": "get",
22933     "url": "/api/sms/accounts",
22934     "title": "Gets a list of Accounts",
22935     "examples": [
22936       {
22937         "title": "Example usage:",
22938         "content": "curl https://{domain}/api/sms/accounts -v -u {name}:{password}",
22939         "type": "json"
22940       }
22941     ],
22942     "name": "GetAccounts",
22943     "group": "Sms_Accounts",
22944     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
22945     "version": "0.0.0",
22946     "filename": "server/api/smsAccount/index.js",
22947     "groupTitle": "Sms_Accounts"
22948   },
22949   {
22950     "type": "get",
22951     "url": "/api/sms/accounts/{id}/users",
22952     "title": "Gets agents from sms account",
22953     "examples": [
22954       {
22955         "title": "Example usage:",
22956         "content": "curl https://{domain}/api/sms/accounts/{id}/users -v -u {name}:{password} -X GET",
22957         "type": "json"
22958       }
22959     ],
22960     "name": "GetAgents",
22961     "group": "Sms_Accounts",
22962     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22963     "version": "0.0.0",
22964     "filename": "server/api/smsAccount/index.js",
22965     "groupTitle": "Sms_Accounts"
22966   },
22967   {
22968     "type": "delete",
22969     "url": "/api/sms/accounts/{id}/users",
22970     "title": "Removes agents from a sms account",
22971     "examples": [
22972       {
22973         "title": "Example usage:",
22974         "content": "curl https://{domain}/api/sms/accounts/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
22975         "type": "json"
22976       }
22977     ],
22978     "name": "RemoveAgents",
22979     "group": "Sms_Accounts",
22980     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22981     "version": "0.0.0",
22982     "filename": "server/api/smsAccount/index.js",
22983     "groupTitle": "Sms_Accounts"
22984   },
22985   {
22986     "type": "delete",
22987     "url": "/api/sms/accounts/{id}/canned_answers",
22988     "title": "Removes canned answers from account",
22989     "examples": [
22990       {
22991         "title": "Example usage:",
22992         "content": "curl https://{domain}/api/sms/accounts/{id}/canned_answers?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
22993         "type": "json"
22994       }
22995     ],
22996     "name": "RemoveAnswers",
22997     "group": "Sms_Accounts",
22998     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22999     "version": "0.0.0",
23000     "filename": "server/api/smsAccount/index.js",
23001     "groupTitle": "Sms_Accounts"
23002   },
23003   {
23004     "type": "delete",
23005     "url": "/api/sms/accounts/{id}/dispositions",
23006     "title": "Removes dispositions from account",
23007     "examples": [
23008       {
23009         "title": "Example usage:",
23010         "content": "curl https://{domain}/api/sms/accounts/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
23011         "type": "json"
23012       }
23013     ],
23014     "name": "RemoveDispositions",
23015     "group": "Sms_Accounts",
23016     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23017     "version": "0.0.0",
23018     "filename": "server/api/smsAccount/index.js",
23019     "groupTitle": "Sms_Accounts"
23020   },
23021   {
23022     "type": "get",
23023     "url": "/api/sms/accounts/{id}",
23024     "title": "Gets a single Account",
23025     "examples": [
23026       {
23027         "title": "Example usage:",
23028         "content": "curl https://{domain}/api/sms/accounts/{id} -v -u {name}:{password}",
23029         "type": "json"
23030       }
23031     ],
23032     "name": "ShowAccounts",
23033     "group": "Sms_Accounts",
23034     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23035     "version": "0.0.0",
23036     "filename": "server/api/smsAccount/index.js",
23037     "groupTitle": "Sms_Accounts"
23038   },
23039   {
23040     "type": "put",
23041     "url": "/api/sms/messages/{id}/accept",
23042     "title": "Accepts message",
23043     "examples": [
23044       {
23045         "title": "Example usage:",
23046         "content": "curl https://{domain}/api/sms/messages/{id}/accept \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
23047         "type": "json"
23048       }
23049     ],
23050     "name": "acceptMessage",
23051     "group": "Sms_Accounts",
23052     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23053     "version": "0.0.0",
23054     "filename": "server/api/smsMessage/index.js",
23055     "groupTitle": "Sms_Accounts"
23056   },
23057   {
23058     "type": "post",
23059     "url": "/api/sms/accounts/{id}/canned_answers",
23060     "title": "Creates new canned answer",
23061     "examples": [
23062       {
23063         "title": "Example usage:",
23064         "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",
23065         "type": "json"
23066       }
23067     ],
23068     "name": "addAnswer",
23069     "group": "Sms_Accounts",
23070     "parameter": {
23071       "fields": {
23072         "Body": [
23073           {
23074             "group": "Body",
23075             "type": "String",
23076             "optional": false,
23077             "field": "key",
23078             "description": ""
23079           },
23080           {
23081             "group": "Body",
23082             "type": "Text",
23083             "optional": false,
23084             "field": "value",
23085             "description": ""
23086           },
23087           {
23088             "group": "Body",
23089             "type": "String",
23090             "optional": true,
23091             "field": "description",
23092             "description": ""
23093           },
23094           {
23095             "group": "Body",
23096             "type": "Virtual",
23097             "optional": true,
23098             "field": "name",
23099             "description": ""
23100           }
23101         ]
23102       }
23103     },
23104     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23105     "version": "0.0.0",
23106     "filename": "server/api/smsAccount/index.js",
23107     "groupTitle": "Sms_Accounts"
23108   },
23109   {
23110     "type": "post",
23111     "url": "/api/sms/accounts/{id}/applications",
23112     "title": "Creates new applications",
23113     "examples": [
23114       {
23115         "title": "Example usage:",
23116         "content": "curl https://{domain}/api/sms/accounts/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
23117         "type": "json"
23118       }
23119     ],
23120     "name": "addApplications",
23121     "group": "Sms_Accounts",
23122     "parameter": {
23123       "fields": {
23124         "Body": [
23125           {
23126             "group": "Body",
23127             "type": "Integer",
23128             "optional": false,
23129             "field": "priority",
23130             "description": ""
23131           },
23132           {
23133             "group": "Body",
23134             "type": "String",
23135             "optional": false,
23136             "field": "app",
23137             "description": ""
23138           },
23139           {
23140             "group": "Body",
23141             "type": "Text",
23142             "optional": true,
23143             "field": "appdata",
23144             "description": ""
23145           },
23146           {
23147             "group": "Body",
23148             "type": "String",
23149             "optional": true,
23150             "field": "description",
23151             "description": ""
23152           },
23153           {
23154             "group": "Body",
23155             "type": "String",
23156             "optional": true,
23157             "field": "interval",
23158             "description": ""
23159           }
23160         ]
23161       }
23162     },
23163     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23164     "version": "0.0.0",
23165     "filename": "server/api/smsAccount/index.js",
23166     "groupTitle": "Sms_Accounts"
23167   },
23168   {
23169     "type": "post",
23170     "url": "/api/sms/accounts/{id}/dispositions",
23171     "title": "Creates new disposition",
23172     "examples": [
23173       {
23174         "title": "Example usage:",
23175         "content": "curl https://{domain}/api/sms/accounts/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
23176         "type": "json"
23177       }
23178     ],
23179     "name": "addDisposition",
23180     "group": "Sms_Accounts",
23181     "parameter": {
23182       "fields": {
23183         "Body": [
23184           {
23185             "group": "Body",
23186             "type": "String",
23187             "optional": false,
23188             "field": "name",
23189             "description": ""
23190           },
23191           {
23192             "group": "Body",
23193             "type": "String",
23194             "allowedValues": [
23195               "\"first\"",
23196               "\"second\"",
23197               "\"third\""
23198             ],
23199             "optional": false,
23200             "field": "level",
23201             "description": ""
23202           },
23203           {
23204             "group": "Body",
23205             "type": "String",
23206             "optional": true,
23207             "field": "description",
23208             "description": ""
23209           }
23210         ]
23211       }
23212     },
23213     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23214     "version": "0.0.0",
23215     "filename": "server/api/smsAccount/index.js",
23216     "groupTitle": "Sms_Accounts"
23217   },
23218   {
23219     "type": "get",
23220     "url": "/api/sms/accounts/{id}/canned_answers",
23221     "title": "Gets account canned answers",
23222     "examples": [
23223       {
23224         "title": "Example usage:",
23225         "content": "curl https://{domain}/api/sms/accounts/{id}/canned_answers -v -u {name}:{password} -X GET",
23226         "type": "json"
23227       }
23228     ],
23229     "name": "getAnswers",
23230     "group": "Sms_Accounts",
23231     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23232     "version": "0.0.0",
23233     "filename": "server/api/smsAccount/index.js",
23234     "groupTitle": "Sms_Accounts"
23235   },
23236   {
23237     "type": "get",
23238     "url": "/api/sms/accounts/{id}/applications",
23239     "title": "Gets account applications",
23240     "examples": [
23241       {
23242         "title": "Example usage:",
23243         "content": "curl https://{domain}/api/sms/accounts/{id}/applications -v -u {name}:{password} -X GET",
23244         "type": "json"
23245       }
23246     ],
23247     "name": "getApplications",
23248     "group": "Sms_Accounts",
23249     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23250     "version": "0.0.0",
23251     "filename": "server/api/smsAccount/index.js",
23252     "groupTitle": "Sms_Accounts"
23253   },
23254   {
23255     "type": "get",
23256     "url": "/api/sms/accounts/{id}/dispositions",
23257     "title": "Gets account dispositions",
23258     "examples": [
23259       {
23260         "title": "Example usage:",
23261         "content": "curl https://{domain}/api/sms/accounts/{id}/dispositions -v -u {name}:{password} -X GET",
23262         "type": "json"
23263       }
23264     ],
23265     "name": "getDispositions",
23266     "group": "Sms_Accounts",
23267     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23268     "version": "0.0.0",
23269     "filename": "server/api/smsAccount/index.js",
23270     "groupTitle": "Sms_Accounts"
23271   },
23272   {
23273     "type": "get",
23274     "url": "/api/sms/accounts/{id}/interactions",
23275     "title": "Gets Sms Account interactions",
23276     "examples": [
23277       {
23278         "title": "Example usage:",
23279         "content": "curl https://{domain}/api/sms/accounts/{id}/interactions -v -u {name}:{password} -X GET",
23280         "type": "json"
23281       }
23282     ],
23283     "name": "getInteractions",
23284     "group": "Sms_Accounts",
23285     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23286     "version": "0.0.0",
23287     "filename": "server/api/smsAccount/index.js",
23288     "groupTitle": "Sms_Accounts"
23289   },
23290   {
23291     "type": "post",
23292     "url": "/api/sms/accounts/{id}/notify",
23293     "title": "Notify new message",
23294     "examples": [
23295       {
23296         "title": "Example usage:",
23297         "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",
23298         "type": "json"
23299       }
23300     ],
23301     "name": "notify",
23302     "group": "Sms_Accounts",
23303     "description": "<p>Motion 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>",
23304     "version": "0.0.0",
23305     "filename": "server/api/smsAccount/index.js",
23306     "groupTitle": "Sms_Accounts"
23307   },
23308   {
23309     "type": "put",
23310     "url": "/api/sms/messages/{id}/reject",
23311     "title": "Rejects message",
23312     "examples": [
23313       {
23314         "title": "Example usage:",
23315         "content": "curl https://{domain}/api/sms/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
23316         "type": "json"
23317       }
23318     ],
23319     "name": "rejectMessage",
23320     "group": "Sms_Accounts",
23321     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23322     "version": "0.0.0",
23323     "filename": "server/api/smsMessage/index.js",
23324     "groupTitle": "Sms_Accounts"
23325   },
23326   {
23327     "type": "post",
23328     "url": "/api/sms/accounts/{id}/send",
23329     "title": "Send new sms message",
23330     "examples": [
23331       {
23332         "title": "Example usage:",
23333         "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",
23334         "type": "json"
23335       }
23336     ],
23337     "name": "sendSms",
23338     "group": "Sms_Accounts",
23339     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23340     "version": "0.0.0",
23341     "filename": "server/api/smsAccount/index.js",
23342     "groupTitle": "Sms_Accounts"
23343   },
23344   {
23345     "type": "post",
23346     "url": "/api/sms/messages/{id}/status",
23347     "title": "Receive message status",
23348     "examples": [
23349       {
23350         "title": "Example usage:",
23351         "content": "curl https://{domain}/api/sms/messages/{id}/status \\ \n -H 'Content-Type: application/json' -v -X POST",
23352         "type": "json"
23353       }
23354     ],
23355     "name": "statusMessage",
23356     "group": "Sms_Accounts",
23357     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23358     "version": "0.0.0",
23359     "filename": "server/api/smsMessage/index.js",
23360     "groupTitle": "Sms_Accounts"
23361   },
23362   {
23363     "type": "post",
23364     "url": "/api/sms/accounts/{id}/status",
23365     "title": "Receive message status",
23366     "examples": [
23367       {
23368         "title": "Example usage:",
23369         "content": "curl https://{domain}/api/sms/accounts/{id}/status -H 'Content-Type: application/json' -v -X POST",
23370         "type": "json"
23371       }
23372     ],
23373     "name": "statusMessage",
23374     "group": "Sms_Accounts",
23375     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23376     "version": "0.0.0",
23377     "filename": "server/api/smsAccount/index.js",
23378     "groupTitle": "Sms_Accounts"
23379   },
23380   {
23381     "type": "get",
23382     "url": "/api/sms/accounts/{id}/status",
23383     "title": "Receive message status as get request",
23384     "examples": [
23385       {
23386         "title": "Example usage:",
23387         "content": "curl https://{domain}/api/sms/accounts/{id}/status -H 'Content-Type: application/json' -v -X GET",
23388         "type": "json"
23389       }
23390     ],
23391     "name": "statusMessage",
23392     "group": "Sms_Accounts",
23393     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23394     "version": "0.0.0",
23395     "filename": "server/api/smsAccount/index.js",
23396     "groupTitle": "Sms_Accounts"
23397   },
23398   {
23399     "type": "put",
23400     "url": "/api/sms/accounts/{id}",
23401     "title": "Update an existing Account",
23402     "examples": [
23403       {
23404         "title": "Example usage:",
23405         "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",
23406         "type": "json"
23407       }
23408     ],
23409     "name": "updateAccounts",
23410     "group": "Sms_Accounts",
23411     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23412     "version": "0.0.0",
23413     "filename": "server/api/smsAccount/index.js",
23414     "groupTitle": "Sms_Accounts"
23415   },
23416   {
23417     "type": "post",
23418     "url": "/api/sms/applications",
23419     "title": "Creates a new Application",
23420     "examples": [
23421       {
23422         "title": "Example usage:",
23423         "content": "curl https://{domain}/api/sms/applications -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
23424         "type": "json"
23425       }
23426     ],
23427     "name": "CreateApplications",
23428     "group": "Sms_Applications",
23429     "parameter": {
23430       "fields": {
23431         "Body": [
23432           {
23433             "group": "Body",
23434             "type": "Integer",
23435             "optional": false,
23436             "field": "priority",
23437             "description": ""
23438           },
23439           {
23440             "group": "Body",
23441             "type": "String",
23442             "optional": false,
23443             "field": "app",
23444             "description": ""
23445           },
23446           {
23447             "group": "Body",
23448             "type": "Text",
23449             "optional": true,
23450             "field": "appdata",
23451             "description": ""
23452           },
23453           {
23454             "group": "Body",
23455             "type": "String",
23456             "optional": true,
23457             "field": "description",
23458             "description": ""
23459           },
23460           {
23461             "group": "Body",
23462             "type": "String",
23463             "optional": true,
23464             "field": "interval",
23465             "description": ""
23466           }
23467         ]
23468       }
23469     },
23470     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23471     "version": "0.0.0",
23472     "filename": "server/api/smsApplication/index.js",
23473     "groupTitle": "Sms_Applications"
23474   },
23475   {
23476     "type": "delete",
23477     "url": "/api/sms/applications/{id}",
23478     "title": "Deletes a Application",
23479     "examples": [
23480       {
23481         "title": "Example usage:",
23482         "content": "curl https://{domain}/api/sms/applications/{id} -v -u {name}:{password} -X DELETE",
23483         "type": "json"
23484       }
23485     ],
23486     "name": "DeleteApplications",
23487     "group": "Sms_Applications",
23488     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23489     "version": "0.0.0",
23490     "filename": "server/api/smsApplication/index.js",
23491     "groupTitle": "Sms_Applications"
23492   },
23493   {
23494     "type": "get",
23495     "url": "/api/sms/applications",
23496     "title": "Gets a list of Applications",
23497     "examples": [
23498       {
23499         "title": "Example usage:",
23500         "content": "curl https://{domain}/api/sms/applications -v -u {name}:{password}",
23501         "type": "json"
23502       }
23503     ],
23504     "name": "GetApplications",
23505     "group": "Sms_Applications",
23506     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
23507     "version": "0.0.0",
23508     "filename": "server/api/smsApplication/index.js",
23509     "groupTitle": "Sms_Applications"
23510   },
23511   {
23512     "type": "get",
23513     "url": "/api/sms/applications/{id}",
23514     "title": "Gets a single Application",
23515     "examples": [
23516       {
23517         "title": "Example usage:",
23518         "content": "curl https://{domain}/api/sms/applications/{id} -v -u {name}:{password}",
23519         "type": "json"
23520       }
23521     ],
23522     "name": "ShowApplications",
23523     "group": "Sms_Applications",
23524     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23525     "version": "0.0.0",
23526     "filename": "server/api/smsApplication/index.js",
23527     "groupTitle": "Sms_Applications"
23528   },
23529   {
23530     "type": "put",
23531     "url": "/api/sms/applications/{id}",
23532     "title": "Update an existing Application",
23533     "examples": [
23534       {
23535         "title": "Example usage:",
23536         "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",
23537         "type": "json"
23538       }
23539     ],
23540     "name": "updateApplications",
23541     "group": "Sms_Applications",
23542     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23543     "version": "0.0.0",
23544     "filename": "server/api/smsApplication/index.js",
23545     "groupTitle": "Sms_Applications"
23546   },
23547   {
23548     "type": "post",
23549     "url": "/api/sms/interactions/{id}/tags",
23550     "title": "Add tags to the interaction",
23551     "examples": [
23552       {
23553         "title": "Example usage:",
23554         "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",
23555         "type": "json"
23556       }
23557     ],
23558     "name": "AddTags",
23559     "group": "Sms_Interactions",
23560     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23561     "version": "0.0.0",
23562     "filename": "server/api/smsInteraction/index.js",
23563     "groupTitle": "Sms_Interactions"
23564   },
23565   {
23566     "type": "post",
23567     "url": "/api/sms/interactions",
23568     "title": "Creates a new Interaction",
23569     "examples": [
23570       {
23571         "title": "Example usage:",
23572         "content": "curl https://{domain}/api/sms/interactions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
23573         "type": "json"
23574       }
23575     ],
23576     "name": "CreateInteractions",
23577     "group": "Sms_Interactions",
23578     "parameter": {
23579       "fields": {
23580         "Body": [
23581           {
23582             "group": "Body",
23583             "type": "Boolean",
23584             "optional": true,
23585             "field": "closed",
23586             "description": ""
23587           },
23588           {
23589             "group": "Body",
23590             "type": "String",
23591             "optional": true,
23592             "field": "closedAt",
23593             "description": ""
23594           },
23595           {
23596             "group": "Body",
23597             "type": "String",
23598             "optional": true,
23599             "field": "disposition",
23600             "description": ""
23601           },
23602           {
23603             "group": "Body",
23604             "type": "String",
23605             "optional": true,
23606             "field": "secondDisposition",
23607             "description": ""
23608           },
23609           {
23610             "group": "Body",
23611             "type": "String",
23612             "optional": true,
23613             "field": "thirdDisposition",
23614             "description": ""
23615           },
23616           {
23617             "group": "Body",
23618             "type": "String",
23619             "optional": true,
23620             "field": "note",
23621             "description": ""
23622           },
23623           {
23624             "group": "Body",
23625             "type": "String",
23626             "optional": true,
23627             "field": "phone",
23628             "description": ""
23629           },
23630           {
23631             "group": "Body",
23632             "type": "String",
23633             "optional": true,
23634             "field": "read1stAt",
23635             "description": ""
23636           },
23637           {
23638             "group": "Body",
23639             "type": "String",
23640             "allowedValues": [
23641               "\"in\"",
23642               "\"out\""
23643             ],
23644             "optional": false,
23645             "field": "firstMsgDirection",
23646             "description": ""
23647           },
23648           {
23649             "group": "Body",
23650             "type": "String",
23651             "optional": true,
23652             "field": "lastMsgAt",
23653             "description": ""
23654           },
23655           {
23656             "group": "Body",
23657             "type": "String",
23658             "allowedValues": [
23659               "\"in\"",
23660               "\"out\""
23661             ],
23662             "optional": false,
23663             "field": "lastMsgDirection",
23664             "description": ""
23665           }
23666         ]
23667       }
23668     },
23669     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23670     "version": "0.0.0",
23671     "filename": "server/api/smsInteraction/index.js",
23672     "groupTitle": "Sms_Interactions"
23673   },
23674   {
23675     "type": "delete",
23676     "url": "/api/sms/interactions/{id}",
23677     "title": "Deletes a Interaction",
23678     "examples": [
23679       {
23680         "title": "Example usage:",
23681         "content": "curl https://{domain}/api/sms/interactions/{id} -v -u {name}:{password} -X DELETE",
23682         "type": "json"
23683       }
23684     ],
23685     "name": "DeleteInteractions",
23686     "group": "Sms_Interactions",
23687     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23688     "version": "0.0.0",
23689     "filename": "server/api/smsInteraction/index.js",
23690     "groupTitle": "Sms_Interactions"
23691   },
23692   {
23693     "type": "get",
23694     "url": "/api/sms/interactions/describe",
23695     "title": "Gets table info about Interactions",
23696     "examples": [
23697       {
23698         "title": "Example usage:",
23699         "content": "curl https://{domain}/api/sms/interactions/describe -v -u {name}:{password}",
23700         "type": "json"
23701       }
23702     ],
23703     "name": "DescribeInteractions",
23704     "group": "Sms_Interactions",
23705     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23706     "version": "0.0.0",
23707     "filename": "server/api/smsInteraction/index.js",
23708     "groupTitle": "Sms_Interactions"
23709   },
23710   {
23711     "type": "get",
23712     "url": "/api/sms/interactions",
23713     "title": "Gets a list of Interactions",
23714     "examples": [
23715       {
23716         "title": "Example usage:",
23717         "content": "curl https://{domain}/api/sms/interactions -v -u {name}:{password}",
23718         "type": "json"
23719       }
23720     ],
23721     "name": "GetInteractions",
23722     "group": "Sms_Interactions",
23723     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
23724     "version": "0.0.0",
23725     "filename": "server/api/smsInteraction/index.js",
23726     "groupTitle": "Sms_Interactions"
23727   },
23728   {
23729     "type": "delete",
23730     "url": "/api/sms/interactions/{id}/tags",
23731     "title": "Removes tags from interaction",
23732     "examples": [
23733       {
23734         "title": "Example usage:",
23735         "content": "curl https://{domain}/api/sms/interactions/{id}/tags?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
23736         "type": "json"
23737       }
23738     ],
23739     "name": "RemoveTags",
23740     "group": "Sms_Interactions",
23741     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23742     "version": "0.0.0",
23743     "filename": "server/api/smsInteraction/index.js",
23744     "groupTitle": "Sms_Interactions"
23745   },
23746   {
23747     "type": "get",
23748     "url": "/api/sms/interactions/{id}",
23749     "title": "Gets a single Interaction",
23750     "examples": [
23751       {
23752         "title": "Example usage:",
23753         "content": "curl https://{domain}/api/sms/interactions/{id} -v -u {name}:{password}",
23754         "type": "json"
23755       }
23756     ],
23757     "name": "ShowInteractions",
23758     "group": "Sms_Interactions",
23759     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23760     "version": "0.0.0",
23761     "filename": "server/api/smsInteraction/index.js",
23762     "groupTitle": "Sms_Interactions"
23763   },
23764   {
23765     "type": "post",
23766     "url": "/api/sms/interactions/{id}/messages",
23767     "title": "Creates new messages",
23768     "examples": [
23769       {
23770         "title": "Example usage:",
23771         "content": "curl https://{domain}/api/sms/interactions/{id}/messages -d '[{\"to\": \"+3901119886500\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
23772         "type": "json"
23773       }
23774     ],
23775     "name": "addMessage",
23776     "group": "Sms_Interactions",
23777     "parameter": {
23778       "fields": {
23779         "Body": [
23780           {
23781             "group": "Body",
23782             "type": "Text",
23783             "optional": false,
23784             "field": "body",
23785             "description": ""
23786           },
23787           {
23788             "group": "Body",
23789             "type": "Boolean",
23790             "optional": true,
23791             "field": "read",
23792             "description": ""
23793           },
23794           {
23795             "group": "Body",
23796             "type": "String",
23797             "allowedValues": [
23798               "\"in\"",
23799               "\"out\""
23800             ],
23801             "optional": false,
23802             "field": "direction",
23803             "description": ""
23804           },
23805           {
23806             "group": "Body",
23807             "type": "String",
23808             "optional": true,
23809             "field": "messageId",
23810             "description": ""
23811           },
23812           {
23813             "group": "Body",
23814             "type": "String",
23815             "optional": true,
23816             "field": "phone",
23817             "description": ""
23818           },
23819           {
23820             "group": "Body",
23821             "type": "String",
23822             "optional": true,
23823             "field": "readAt",
23824             "description": ""
23825           },
23826           {
23827             "group": "Body",
23828             "type": "Boolean",
23829             "optional": true,
23830             "field": "secret",
23831             "description": ""
23832           },
23833           {
23834             "group": "Body",
23835             "type": "String",
23836             "optional": true,
23837             "field": "providerName",
23838             "description": ""
23839           },
23840           {
23841             "group": "Body",
23842             "type": "Text",
23843             "optional": true,
23844             "field": "providerResponse",
23845             "description": ""
23846           }
23847         ]
23848       }
23849     },
23850     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23851     "version": "0.0.0",
23852     "filename": "server/api/smsInteraction/index.js",
23853     "groupTitle": "Sms_Interactions"
23854   },
23855   {
23856     "type": "get",
23857     "url": "/api/sms/interactions/{id}/download",
23858     "title": "Gets interaction",
23859     "examples": [
23860       {
23861         "title": "Example usage:",
23862         "content": "curl https://{domain}/api/sms/interactions/{id}/download -v -u {name}:{password} -X GET",
23863         "type": "json"
23864       }
23865     ],
23866     "name": "download",
23867     "group": "Sms_Interactions",
23868     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23869     "version": "0.0.0",
23870     "filename": "server/api/smsInteraction/index.js",
23871     "groupTitle": "Sms_Interactions"
23872   },
23873   {
23874     "type": "get",
23875     "url": "/api/sms/interactions/{id}/messages",
23876     "title": "Gets interaction messages",
23877     "examples": [
23878       {
23879         "title": "Example usage:",
23880         "content": "curl https://{domain}/api/sms/interactions/{id}/messages -v -u {name}:{password} -X GET",
23881         "type": "json"
23882       }
23883     ],
23884     "name": "getMessages",
23885     "group": "Sms_Interactions",
23886     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23887     "version": "0.0.0",
23888     "filename": "server/api/smsInteraction/index.js",
23889     "groupTitle": "Sms_Interactions"
23890   },
23891   {
23892     "type": "put",
23893     "url": "/api/sms/interactions/{id}",
23894     "title": "Update an existing Interaction",
23895     "examples": [
23896       {
23897         "title": "Example usage:",
23898         "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",
23899         "type": "json"
23900       }
23901     ],
23902     "name": "updateInteractions",
23903     "group": "Sms_Interactions",
23904     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23905     "version": "0.0.0",
23906     "filename": "server/api/smsInteraction/index.js",
23907     "groupTitle": "Sms_Interactions"
23908   },
23909   {
23910     "type": "post",
23911     "url": "/api/sms/messages",
23912     "title": "Creates a new Message",
23913     "examples": [
23914       {
23915         "title": "Example usage:",
23916         "content": "curl https://{domain}/api/sms/messages -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
23917         "type": "json"
23918       }
23919     ],
23920     "name": "CreateMessages",
23921     "group": "Sms_Messages",
23922     "parameter": {
23923       "fields": {
23924         "Body": [
23925           {
23926             "group": "Body",
23927             "type": "Text",
23928             "optional": false,
23929             "field": "body",
23930             "description": ""
23931           },
23932           {
23933             "group": "Body",
23934             "type": "Boolean",
23935             "optional": true,
23936             "field": "read",
23937             "description": ""
23938           },
23939           {
23940             "group": "Body",
23941             "type": "String",
23942             "allowedValues": [
23943               "\"in\"",
23944               "\"out\""
23945             ],
23946             "optional": false,
23947             "field": "direction",
23948             "description": ""
23949           },
23950           {
23951             "group": "Body",
23952             "type": "String",
23953             "optional": true,
23954             "field": "messageId",
23955             "description": ""
23956           },
23957           {
23958             "group": "Body",
23959             "type": "String",
23960             "optional": true,
23961             "field": "phone",
23962             "description": ""
23963           },
23964           {
23965             "group": "Body",
23966             "type": "String",
23967             "optional": true,
23968             "field": "readAt",
23969             "description": ""
23970           },
23971           {
23972             "group": "Body",
23973             "type": "Boolean",
23974             "optional": true,
23975             "field": "secret",
23976             "description": ""
23977           },
23978           {
23979             "group": "Body",
23980             "type": "String",
23981             "optional": true,
23982             "field": "providerName",
23983             "description": ""
23984           },
23985           {
23986             "group": "Body",
23987             "type": "Text",
23988             "optional": true,
23989             "field": "providerResponse",
23990             "description": ""
23991           }
23992         ]
23993       }
23994     },
23995     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23996     "version": "0.0.0",
23997     "filename": "server/api/smsMessage/index.js",
23998     "groupTitle": "Sms_Messages"
23999   },
24000   {
24001     "type": "delete",
24002     "url": "/api/sms/messages/{id}",
24003     "title": "Deletes a Message",
24004     "examples": [
24005       {
24006         "title": "Example usage:",
24007         "content": "curl https://{domain}/api/sms/messages/{id} -v -u {name}:{password} -X DELETE",
24008         "type": "json"
24009       }
24010     ],
24011     "name": "DeleteMessages",
24012     "group": "Sms_Messages",
24013     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24014     "version": "0.0.0",
24015     "filename": "server/api/smsMessage/index.js",
24016     "groupTitle": "Sms_Messages"
24017   },
24018   {
24019     "type": "get",
24020     "url": "/api/sms/messages/describe",
24021     "title": "Gets table info about Messages",
24022     "examples": [
24023       {
24024         "title": "Example usage:",
24025         "content": "curl https://{domain}/api/sms/messages/describe -v -u {name}:{password}",
24026         "type": "json"
24027       }
24028     ],
24029     "name": "DescribeMessages",
24030     "group": "Sms_Messages",
24031     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24032     "version": "0.0.0",
24033     "filename": "server/api/smsMessage/index.js",
24034     "groupTitle": "Sms_Messages"
24035   },
24036   {
24037     "type": "get",
24038     "url": "/api/sms/messages",
24039     "title": "Gets a list of Messages",
24040     "examples": [
24041       {
24042         "title": "Example usage:",
24043         "content": "curl https://{domain}/api/sms/messages -v -u {name}:{password}",
24044         "type": "json"
24045       }
24046     ],
24047     "name": "GetMessages",
24048     "group": "Sms_Messages",
24049     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
24050     "version": "0.0.0",
24051     "filename": "server/api/smsMessage/index.js",
24052     "groupTitle": "Sms_Messages"
24053   },
24054   {
24055     "type": "get",
24056     "url": "/api/sms/messages/{id}",
24057     "title": "Gets a single Message",
24058     "examples": [
24059       {
24060         "title": "Example usage:",
24061         "content": "curl https://{domain}/api/sms/messages/{id} -v -u {name}:{password}",
24062         "type": "json"
24063       }
24064     ],
24065     "name": "ShowMessages",
24066     "group": "Sms_Messages",
24067     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24068     "version": "0.0.0",
24069     "filename": "server/api/smsMessage/index.js",
24070     "groupTitle": "Sms_Messages"
24071   },
24072   {
24073     "type": "put",
24074     "url": "/api/sms/messages/{id}",
24075     "title": "Update an existing Message",
24076     "examples": [
24077       {
24078         "title": "Example usage:",
24079         "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",
24080         "type": "json"
24081       }
24082     ],
24083     "name": "updateMessages",
24084     "group": "Sms_Messages",
24085     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24086     "version": "0.0.0",
24087     "filename": "server/api/smsMessage/index.js",
24088     "groupTitle": "Sms_Messages"
24089   },
24090   {
24091     "type": "post",
24092     "url": "/api/sms/reports/queue",
24093     "title": "Creates a new Sms Queue Report",
24094     "examples": [
24095       {
24096         "title": "Example usage:",
24097         "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",
24098         "type": "json"
24099       }
24100     ],
24101     "name": "CreateSms_Queue_Reports",
24102     "group": "Sms_Queue_Reports",
24103     "parameter": {
24104       "fields": {
24105         "Body": [
24106           {
24107             "group": "Body",
24108             "type": "String",
24109             "optional": false,
24110             "field": "uniqueid",
24111             "description": ""
24112           },
24113           {
24114             "group": "Body",
24115             "type": "String",
24116             "optional": true,
24117             "field": "from",
24118             "description": ""
24119           },
24120           {
24121             "group": "Body",
24122             "type": "String",
24123             "optional": true,
24124             "field": "joinAt",
24125             "description": ""
24126           },
24127           {
24128             "group": "Body",
24129             "type": "String",
24130             "optional": true,
24131             "field": "leaveAt",
24132             "description": ""
24133           },
24134           {
24135             "group": "Body",
24136             "type": "String",
24137             "optional": true,
24138             "field": "acceptAt",
24139             "description": ""
24140           },
24141           {
24142             "group": "Body",
24143             "type": "String",
24144             "optional": true,
24145             "field": "exitAt",
24146             "description": ""
24147           },
24148           {
24149             "group": "Body",
24150             "type": "String",
24151             "optional": true,
24152             "field": "reason",
24153             "description": ""
24154           }
24155         ]
24156       }
24157     },
24158     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24159     "version": "0.0.0",
24160     "filename": "server/api/smsQueueReport/index.js",
24161     "groupTitle": "Sms_Queue_Reports"
24162   },
24163   {
24164     "type": "delete",
24165     "url": "/api/sms/reports/queue/{id}",
24166     "title": "Deletes a Sms Queue Report",
24167     "examples": [
24168       {
24169         "title": "Example usage:",
24170         "content": "curl https://{domain}/api/sms/reports/queue/{id} -v -u {name}:{password} -X DELETE",
24171         "type": "json"
24172       }
24173     ],
24174     "name": "DeleteSms_Queue_Reports",
24175     "group": "Sms_Queue_Reports",
24176     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24177     "version": "0.0.0",
24178     "filename": "server/api/smsQueueReport/index.js",
24179     "groupTitle": "Sms_Queue_Reports"
24180   },
24181   {
24182     "type": "get",
24183     "url": "/api/sms/reports/queue/describe",
24184     "title": "Gets table info about Sms Queue Reports",
24185     "examples": [
24186       {
24187         "title": "Example usage:",
24188         "content": "curl https://{domain}/api/sms/reports/queue/describe -v -u {name}:{password}",
24189         "type": "json"
24190       }
24191     ],
24192     "name": "DescribeSms_Queue_Reports",
24193     "group": "Sms_Queue_Reports",
24194     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24195     "version": "0.0.0",
24196     "filename": "server/api/smsQueueReport/index.js",
24197     "groupTitle": "Sms_Queue_Reports"
24198   },
24199   {
24200     "type": "get",
24201     "url": "/api/sms/reports/queue",
24202     "title": "Gets a list of Sms Queue Reports",
24203     "examples": [
24204       {
24205         "title": "Example usage:",
24206         "content": "curl https://{domain}/api/sms/reports/queue -v -u {name}:{password}",
24207         "type": "json"
24208       }
24209     ],
24210     "name": "GetSms_Queue_Reports",
24211     "group": "Sms_Queue_Reports",
24212     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
24213     "version": "0.0.0",
24214     "filename": "server/api/smsQueueReport/index.js",
24215     "groupTitle": "Sms_Queue_Reports"
24216   },
24217   {
24218     "type": "get",
24219     "url": "/api/sms/reports/queue/{id}",
24220     "title": "Gets a single Sms Queue Report",
24221     "examples": [
24222       {
24223         "title": "Example usage:",
24224         "content": "curl https://{domain}/api/sms/reports/queue/{id} -v -u {name}:{password}",
24225         "type": "json"
24226       }
24227     ],
24228     "name": "ShowSms_Queue_Reports",
24229     "group": "Sms_Queue_Reports",
24230     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24231     "version": "0.0.0",
24232     "filename": "server/api/smsQueueReport/index.js",
24233     "groupTitle": "Sms_Queue_Reports"
24234   },
24235   {
24236     "type": "put",
24237     "url": "/api/sms/reports/queue/{id}",
24238     "title": "Update an existing Sms Queue Report",
24239     "examples": [
24240       {
24241         "title": "Example usage:",
24242         "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",
24243         "type": "json"
24244       }
24245     ],
24246     "name": "updateSms_Queue_Reports",
24247     "group": "Sms_Queue_Reports",
24248     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24249     "version": "0.0.0",
24250     "filename": "server/api/smsQueueReport/index.js",
24251     "groupTitle": "Sms_Queue_Reports"
24252   },
24253   {
24254     "type": "post",
24255     "url": "/api/sms/queues/{id}/users",
24256     "title": "Add agents to a queue",
24257     "examples": [
24258       {
24259         "title": "Example usage:",
24260         "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",
24261         "type": "json"
24262       }
24263     ],
24264     "name": "AddAgents",
24265     "group": "Sms_Queues",
24266     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24267     "version": "0.0.0",
24268     "filename": "server/api/smsQueue/index.js",
24269     "groupTitle": "Sms_Queues"
24270   },
24271   {
24272     "type": "post",
24273     "url": "/api/sms/queues/{id}/teams",
24274     "title": "Add teams to a queue",
24275     "examples": [
24276       {
24277         "title": "Example usage:",
24278         "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",
24279         "type": "json"
24280       }
24281     ],
24282     "name": "AddTeams",
24283     "group": "Sms_Queues",
24284     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24285     "version": "0.0.0",
24286     "filename": "server/api/smsQueue/index.js",
24287     "groupTitle": "Sms_Queues"
24288   },
24289   {
24290     "type": "post",
24291     "url": "/api/sms/queues",
24292     "title": "Creates a new Queue",
24293     "examples": [
24294       {
24295         "title": "Example usage:",
24296         "content": "curl https://{domain}/api/sms/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
24297         "type": "json"
24298       }
24299     ],
24300     "name": "CreateQueues",
24301     "group": "Sms_Queues",
24302     "parameter": {
24303       "fields": {
24304         "Body": [
24305           {
24306             "group": "Body",
24307             "type": "String",
24308             "optional": true,
24309             "field": "name",
24310             "description": ""
24311           },
24312           {
24313             "group": "Body",
24314             "type": "String",
24315             "optional": true,
24316             "field": "description",
24317             "description": ""
24318           },
24319           {
24320             "group": "Body",
24321             "type": "Integer",
24322             "optional": true,
24323             "field": "timeout",
24324             "description": ""
24325           },
24326           {
24327             "group": "Body",
24328             "type": "String",
24329             "allowedValues": [
24330               "\"rrmemory\"",
24331               "\"beepall\"",
24332               "\"roundrobin\""
24333             ],
24334             "optional": true,
24335             "field": "strategy",
24336             "description": ""
24337           }
24338         ]
24339       }
24340     },
24341     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24342     "version": "0.0.0",
24343     "filename": "server/api/smsQueue/index.js",
24344     "groupTitle": "Sms_Queues"
24345   },
24346   {
24347     "type": "delete",
24348     "url": "/api/sms/queues/{id}",
24349     "title": "Deletes a Queue",
24350     "examples": [
24351       {
24352         "title": "Example usage:",
24353         "content": "curl https://{domain}/api/sms/queues/{id} -v -u {name}:{password} -X DELETE",
24354         "type": "json"
24355       }
24356     ],
24357     "name": "DeleteQueues",
24358     "group": "Sms_Queues",
24359     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24360     "version": "0.0.0",
24361     "filename": "server/api/smsQueue/index.js",
24362     "groupTitle": "Sms_Queues"
24363   },
24364   {
24365     "type": "get",
24366     "url": "/api/sms/queues/describe",
24367     "title": "Gets table info about Queues",
24368     "examples": [
24369       {
24370         "title": "Example usage:",
24371         "content": "curl https://{domain}/api/sms/queues/describe -v -u {name}:{password}",
24372         "type": "json"
24373       }
24374     ],
24375     "name": "DescribeQueues",
24376     "group": "Sms_Queues",
24377     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24378     "version": "0.0.0",
24379     "filename": "server/api/smsQueue/index.js",
24380     "groupTitle": "Sms_Queues"
24381   },
24382   {
24383     "type": "get",
24384     "url": "/api/sms/queues/{id}/users",
24385     "title": "Gets queue agents",
24386     "examples": [
24387       {
24388         "title": "Example usage:",
24389         "content": "curl https://{domain}/api/sms/queues/{id}/users -v -u {name}:{password} -X POST",
24390         "type": "json"
24391       }
24392     ],
24393     "name": "GetAgents",
24394     "group": "Sms_Queues",
24395     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24396     "version": "0.0.0",
24397     "filename": "server/api/smsQueue/index.js",
24398     "groupTitle": "Sms_Queues"
24399   },
24400   {
24401     "type": "get",
24402     "url": "/api/sms/queues/{id}/members",
24403     "title": "GetMembers",
24404     "examples": [
24405       {
24406         "title": "Example usage:",
24407         "content": "curl https://{domain}/api/sms/queues/{id}/members  -v -u {name}:{password}",
24408         "type": "json"
24409       }
24410     ],
24411     "name": "GetMembers",
24412     "group": "Sms_Queues",
24413     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24414     "version": "0.0.0",
24415     "filename": "server/api/smsQueue/index.js",
24416     "groupTitle": "Sms_Queues"
24417   },
24418   {
24419     "type": "get",
24420     "url": "/api/sms/queues",
24421     "title": "Gets a list of Queues",
24422     "examples": [
24423       {
24424         "title": "Example usage:",
24425         "content": "curl https://{domain}/api/sms/queues -v -u {name}:{password}",
24426         "type": "json"
24427       }
24428     ],
24429     "name": "GetQueues",
24430     "group": "Sms_Queues",
24431     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
24432     "version": "0.0.0",
24433     "filename": "server/api/smsQueue/index.js",
24434     "groupTitle": "Sms_Queues"
24435   },
24436   {
24437     "type": "get",
24438     "url": "/api/sms/queues/{id}/teams",
24439     "title": "Gets queues list",
24440     "examples": [
24441       {
24442         "title": "Example usage:",
24443         "content": "curl https://{domain}/api/sms/queues/{id}/teams -v -u {name}:{password}",
24444         "type": "json"
24445       }
24446     ],
24447     "name": "GetTeams",
24448     "group": "Sms_Queues",
24449     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24450     "version": "0.0.0",
24451     "filename": "server/api/smsQueue/index.js",
24452     "groupTitle": "Sms_Queues"
24453   },
24454   {
24455     "type": "delete",
24456     "url": "/api/sms/queues/{id}/users",
24457     "title": "Removes agents from a queue",
24458     "examples": [
24459       {
24460         "title": "Example usage:",
24461         "content": "curl https://{domain}/api/sms/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
24462         "type": "json"
24463       }
24464     ],
24465     "name": "RemoveAgents",
24466     "group": "Sms_Queues",
24467     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24468     "version": "0.0.0",
24469     "filename": "server/api/smsQueue/index.js",
24470     "groupTitle": "Sms_Queues"
24471   },
24472   {
24473     "type": "get",
24474     "url": "/api/sms/queues/{id}",
24475     "title": "Gets a single Queue",
24476     "examples": [
24477       {
24478         "title": "Example usage:",
24479         "content": "curl https://{domain}/api/sms/queues/{id} -v -u {name}:{password}",
24480         "type": "json"
24481       }
24482     ],
24483     "name": "ShowQueues",
24484     "group": "Sms_Queues",
24485     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24486     "version": "0.0.0",
24487     "filename": "server/api/smsQueue/index.js",
24488     "groupTitle": "Sms_Queues"
24489   },
24490   {
24491     "type": "put",
24492     "url": "/api/sms/queues/{id}",
24493     "title": "Update an existing Queue",
24494     "examples": [
24495       {
24496         "title": "Example usage:",
24497         "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",
24498         "type": "json"
24499       }
24500     ],
24501     "name": "updateQueues",
24502     "group": "Sms_Queues",
24503     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24504     "version": "0.0.0",
24505     "filename": "server/api/smsQueue/index.js",
24506     "groupTitle": "Sms_Queues"
24507   },
24508   {
24509     "type": "post",
24510     "url": "/api/sms/reports/transfer",
24511     "title": "Creates a new Sms Transfer Report",
24512     "examples": [
24513       {
24514         "title": "Example usage:",
24515         "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",
24516         "type": "json"
24517       }
24518     ],
24519     "name": "CreateSms_Transfer_Reports",
24520     "group": "Sms_Transfer_Reports",
24521     "parameter": {
24522       "fields": {
24523         "Body": [
24524           {
24525             "group": "Body",
24526             "type": "String",
24527             "optional": false,
24528             "field": "uniqueid",
24529             "description": ""
24530           },
24531           {
24532             "group": "Body",
24533             "type": "String",
24534             "allowedValues": [
24535               "\"account\"",
24536               "\"agent\"",
24537               "\"queue\""
24538             ],
24539             "optional": false,
24540             "field": "type",
24541             "description": ""
24542           },
24543           {
24544             "group": "Body",
24545             "type": "String",
24546             "optional": false,
24547             "field": "transferredAt",
24548             "description": ""
24549           }
24550         ]
24551       }
24552     },
24553     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24554     "version": "0.0.0",
24555     "filename": "server/api/smsTransferReport/index.js",
24556     "groupTitle": "Sms_Transfer_Reports"
24557   },
24558   {
24559     "type": "delete",
24560     "url": "/api/sms/reports/transfer/{id}",
24561     "title": "Deletes a Sms Transfer Report",
24562     "examples": [
24563       {
24564         "title": "Example usage:",
24565         "content": "curl https://{domain}/api/sms/reports/transfer/{id} -v -u {name}:{password} -X DELETE",
24566         "type": "json"
24567       }
24568     ],
24569     "name": "DeleteSms_Transfer_Reports",
24570     "group": "Sms_Transfer_Reports",
24571     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24572     "version": "0.0.0",
24573     "filename": "server/api/smsTransferReport/index.js",
24574     "groupTitle": "Sms_Transfer_Reports"
24575   },
24576   {
24577     "type": "get",
24578     "url": "/api/sms/reports/transfer/describe",
24579     "title": "Gets table info about Sms Transfer Reports",
24580     "examples": [
24581       {
24582         "title": "Example usage:",
24583         "content": "curl https://{domain}/api/sms/reports/transfer/describe -v -u {name}:{password}",
24584         "type": "json"
24585       }
24586     ],
24587     "name": "DescribeSms_Transfer_Reports",
24588     "group": "Sms_Transfer_Reports",
24589     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24590     "version": "0.0.0",
24591     "filename": "server/api/smsTransferReport/index.js",
24592     "groupTitle": "Sms_Transfer_Reports"
24593   },
24594   {
24595     "type": "get",
24596     "url": "/api/sms/reports/transfer",
24597     "title": "Gets a list of Sms Transfer Reports",
24598     "examples": [
24599       {
24600         "title": "Example usage:",
24601         "content": "curl https://{domain}/api/sms/reports/transfer -v -u {name}:{password}",
24602         "type": "json"
24603       }
24604     ],
24605     "name": "GetSms_Transfer_Reports",
24606     "group": "Sms_Transfer_Reports",
24607     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
24608     "version": "0.0.0",
24609     "filename": "server/api/smsTransferReport/index.js",
24610     "groupTitle": "Sms_Transfer_Reports"
24611   },
24612   {
24613     "type": "get",
24614     "url": "/api/sms/reports/transfer/{id}",
24615     "title": "Gets a single Sms Transfer Report",
24616     "examples": [
24617       {
24618         "title": "Example usage:",
24619         "content": "curl https://{domain}/api/sms/reports/transfer/{id} -v -u {name}:{password}",
24620         "type": "json"
24621       }
24622     ],
24623     "name": "ShowSms_Transfer_Reports",
24624     "group": "Sms_Transfer_Reports",
24625     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24626     "version": "0.0.0",
24627     "filename": "server/api/smsTransferReport/index.js",
24628     "groupTitle": "Sms_Transfer_Reports"
24629   },
24630   {
24631     "type": "put",
24632     "url": "/api/sms/reports/transfer/{id}",
24633     "title": "Update an existing Sms Transfer Report",
24634     "examples": [
24635       {
24636         "title": "Example usage:",
24637         "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",
24638         "type": "json"
24639       }
24640     ],
24641     "name": "updateSms_Transfer_Reports",
24642     "group": "Sms_Transfer_Reports",
24643     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24644     "version": "0.0.0",
24645     "filename": "server/api/smsTransferReport/index.js",
24646     "groupTitle": "Sms_Transfer_Reports"
24647   },
24648   {
24649     "type": "get",
24650     "url": "/api/sounds",
24651     "title": "Gets a list of Sounds",
24652     "examples": [
24653       {
24654         "title": "Example usage:",
24655         "content": "curl https://{domain}/api/sounds -v -u {name}:{password}",
24656         "type": "json"
24657       }
24658     ],
24659     "name": "GetSounds",
24660     "group": "Sounds",
24661     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
24662     "version": "0.0.0",
24663     "filename": "server/api/sound/index.js",
24664     "groupTitle": "Sounds"
24665   },
24666   {
24667     "type": "get",
24668     "url": "/api/sounds/{id}",
24669     "title": "Gets a single Sound",
24670     "examples": [
24671       {
24672         "title": "Example usage:",
24673         "content": "curl https://{domain}/api/sounds/{id} -v -u {name}:{password}",
24674         "type": "json"
24675       }
24676     ],
24677     "name": "ShowSounds",
24678     "group": "Sounds",
24679     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24680     "version": "0.0.0",
24681     "filename": "server/api/sound/index.js",
24682     "groupTitle": "Sounds"
24683   },
24684   {
24685     "type": "post",
24686     "url": "/api/sounds",
24687     "title": "Create a new sound",
24688     "examples": [
24689       {
24690         "title": "Example usage:",
24691         "content": "curl https://{domain}/api/sounds -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
24692         "type": "json"
24693       }
24694     ],
24695     "name": "addSound",
24696     "group": "Sounds",
24697     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24698     "version": "0.0.0",
24699     "filename": "server/api/sound/index.js",
24700     "groupTitle": "Sounds"
24701   },
24702   {
24703     "type": "delete",
24704     "url": "/api/sounds/{id}",
24705     "title": "Deletes a sound",
24706     "examples": [
24707       {
24708         "title": "Example usage:",
24709         "content": "curl https://{domain}/api/sounds/{id} -v -u {name}:{password} -X DELETE",
24710         "type": "json"
24711       }
24712     ],
24713     "name": "destroySound",
24714     "group": "Sounds",
24715     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24716     "version": "0.0.0",
24717     "filename": "server/api/sound/index.js",
24718     "groupTitle": "Sounds"
24719   },
24720   {
24721     "type": "get",
24722     "url": "/api/sounds/{id}/download",
24723     "title": "Download Sound",
24724     "examples": [
24725       {
24726         "title": "Example usage:",
24727         "content": "curl https://{domain}/api/sounds/{id}/download -v -u {name}:{password} -X GET",
24728         "type": "json"
24729       }
24730     ],
24731     "name": "download",
24732     "group": "Sounds",
24733     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24734     "version": "0.0.0",
24735     "filename": "server/api/sound/index.js",
24736     "groupTitle": "Sounds"
24737   },
24738   {
24739     "type": "put",
24740     "url": "/api/sounds",
24741     "title": "Update an existing new sound",
24742     "examples": [
24743       {
24744         "title": "Example usage:",
24745         "content": "curl https://{domain}/api/sounds -d '[\"name\": \"sound_name\", \"description\": \"sound_desc\"]' -v -u {name}:{password} -X PUT",
24746         "type": "json"
24747       }
24748     ],
24749     "name": "updateSound",
24750     "group": "Sounds",
24751     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24752     "version": "0.0.0",
24753     "filename": "server/api/sound/index.js",
24754     "groupTitle": "Sounds"
24755   },
24756   {
24757     "type": "post",
24758     "url": "/api/square/details/reports",
24759     "title": "Creates a new Square Detail Report",
24760     "examples": [
24761       {
24762         "title": "Example usage:",
24763         "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",
24764         "type": "json"
24765       }
24766     ],
24767     "name": "CreateSquare_Detail_Reports",
24768     "group": "Square_Details_Reports",
24769     "parameter": {
24770       "fields": {
24771         "Body": [
24772           {
24773             "group": "Body",
24774             "type": "String",
24775             "optional": true,
24776             "field": "uniqueid",
24777             "description": ""
24778           },
24779           {
24780             "group": "Body",
24781             "type": "String",
24782             "optional": true,
24783             "field": "node",
24784             "description": ""
24785           },
24786           {
24787             "group": "Body",
24788             "type": "String",
24789             "optional": true,
24790             "field": "application",
24791             "description": ""
24792           },
24793           {
24794             "group": "Body",
24795             "type": "Text",
24796             "optional": true,
24797             "field": "data",
24798             "description": ""
24799           },
24800           {
24801             "group": "Body",
24802             "type": "String",
24803             "optional": true,
24804             "field": "project_name",
24805             "description": ""
24806           },
24807           {
24808             "group": "Body",
24809             "type": "String",
24810             "optional": true,
24811             "field": "callerid",
24812             "description": ""
24813           }
24814         ]
24815       }
24816     },
24817     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24818     "version": "0.0.0",
24819     "filename": "server/api/squareReportDetail/index.js",
24820     "groupTitle": "Square_Details_Reports"
24821   },
24822   {
24823     "type": "delete",
24824     "url": "/api/square/details/reports/{id}",
24825     "title": "Deletes a Square Detail Report",
24826     "examples": [
24827       {
24828         "title": "Example usage:",
24829         "content": "curl https://{domain}/api/square/details/reports/{id} -v -u {name}:{password} -X DELETE",
24830         "type": "json"
24831       }
24832     ],
24833     "name": "DeleteSquare_Detail_Reports",
24834     "group": "Square_Details_Reports",
24835     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24836     "version": "0.0.0",
24837     "filename": "server/api/squareReportDetail/index.js",
24838     "groupTitle": "Square_Details_Reports"
24839   },
24840   {
24841     "type": "get",
24842     "url": "/api/square/details/reports/describe",
24843     "title": "Gets table info about Square Detail Reports",
24844     "examples": [
24845       {
24846         "title": "Example usage:",
24847         "content": "curl https://{domain}/api/square/details/reports/describe -v -u {name}:{password}",
24848         "type": "json"
24849       }
24850     ],
24851     "name": "DescribeSquare_Detail_Reports",
24852     "group": "Square_Details_Reports",
24853     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24854     "version": "0.0.0",
24855     "filename": "server/api/squareReportDetail/index.js",
24856     "groupTitle": "Square_Details_Reports"
24857   },
24858   {
24859     "type": "get",
24860     "url": "/api/square/details/reports",
24861     "title": "Gets a list of Square Detail Reports",
24862     "examples": [
24863       {
24864         "title": "Example usage:",
24865         "content": "curl https://{domain}/api/square/details/reports -v -u {name}:{password}",
24866         "type": "json"
24867       }
24868     ],
24869     "name": "GetSquare_Detail_Reports",
24870     "group": "Square_Details_Reports",
24871     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
24872     "version": "0.0.0",
24873     "filename": "server/api/squareReportDetail/index.js",
24874     "groupTitle": "Square_Details_Reports"
24875   },
24876   {
24877     "type": "get",
24878     "url": "/api/square/details/reports/{id}",
24879     "title": "Gets a single Square Detail Report",
24880     "examples": [
24881       {
24882         "title": "Example usage:",
24883         "content": "curl https://{domain}/api/square/details/reports/{id} -v -u {name}:{password}",
24884         "type": "json"
24885       }
24886     ],
24887     "name": "ShowSquare_Detail_Reports",
24888     "group": "Square_Details_Reports",
24889     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24890     "version": "0.0.0",
24891     "filename": "server/api/squareReportDetail/index.js",
24892     "groupTitle": "Square_Details_Reports"
24893   },
24894   {
24895     "type": "put",
24896     "url": "/api/square/details/reports/{id}",
24897     "title": "Update an existing Square Detail Report",
24898     "examples": [
24899       {
24900         "title": "Example usage:",
24901         "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",
24902         "type": "json"
24903       }
24904     ],
24905     "name": "updateSquare_Detail_Reports",
24906     "group": "Square_Details_Reports",
24907     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24908     "version": "0.0.0",
24909     "filename": "server/api/squareReportDetail/index.js",
24910     "groupTitle": "Square_Details_Reports"
24911   },
24912   {
24913     "type": "post",
24914     "url": "/api/square/messages",
24915     "title": "Creates a new Message",
24916     "examples": [
24917       {
24918         "title": "Example usage:",
24919         "content": "curl https://{domain}/api/square/messages -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
24920         "type": "json"
24921       }
24922     ],
24923     "name": "CreateMessages",
24924     "group": "Square_Messages",
24925     "parameter": {
24926       "fields": {
24927         "Body": [
24928           {
24929             "group": "Body",
24930             "type": "String",
24931             "optional": true,
24932             "field": "uniqueid",
24933             "description": ""
24934           },
24935           {
24936             "group": "Body",
24937             "type": "Text",
24938             "optional": false,
24939             "field": "body",
24940             "description": ""
24941           },
24942           {
24943             "group": "Body",
24944             "type": "String",
24945             "allowedValues": [
24946               "\"in\"",
24947               "\"out\""
24948             ],
24949             "optional": false,
24950             "field": "direction",
24951             "description": ""
24952           },
24953           {
24954             "group": "Body",
24955             "type": "String",
24956             "optional": true,
24957             "field": "providerName",
24958             "description": ""
24959           },
24960           {
24961             "group": "Body",
24962             "type": "Text",
24963             "optional": true,
24964             "field": "providerResponse",
24965             "description": ""
24966           }
24967         ]
24968       }
24969     },
24970     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24971     "version": "0.0.0",
24972     "filename": "server/api/squareMessage/index.js",
24973     "groupTitle": "Square_Messages"
24974   },
24975   {
24976     "type": "delete",
24977     "url": "/api/square/messages/{id}",
24978     "title": "Deletes a Message",
24979     "examples": [
24980       {
24981         "title": "Example usage:",
24982         "content": "curl https://{domain}/api/square/messages/{id} -v -u {name}:{password} -X DELETE",
24983         "type": "json"
24984       }
24985     ],
24986     "name": "DeleteMessages",
24987     "group": "Square_Messages",
24988     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24989     "version": "0.0.0",
24990     "filename": "server/api/squareMessage/index.js",
24991     "groupTitle": "Square_Messages"
24992   },
24993   {
24994     "type": "get",
24995     "url": "/api/square/messages",
24996     "title": "Gets a list of Messages",
24997     "examples": [
24998       {
24999         "title": "Example usage:",
25000         "content": "curl https://{domain}/api/square/messages -v -u {name}:{password}",
25001         "type": "json"
25002       }
25003     ],
25004     "name": "GetMessages",
25005     "group": "Square_Messages",
25006     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
25007     "version": "0.0.0",
25008     "filename": "server/api/squareMessage/index.js",
25009     "groupTitle": "Square_Messages"
25010   },
25011   {
25012     "type": "get",
25013     "url": "/api/square/messages/{id}",
25014     "title": "Gets a single Message",
25015     "examples": [
25016       {
25017         "title": "Example usage:",
25018         "content": "curl https://{domain}/api/square/messages/{id} -v -u {name}:{password}",
25019         "type": "json"
25020       }
25021     ],
25022     "name": "ShowMessages",
25023     "group": "Square_Messages",
25024     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25025     "version": "0.0.0",
25026     "filename": "server/api/squareMessage/index.js",
25027     "groupTitle": "Square_Messages"
25028   },
25029   {
25030     "type": "put",
25031     "url": "/api/square/messages/{id}",
25032     "title": "Update an existing Message",
25033     "examples": [
25034       {
25035         "title": "Example usage:",
25036         "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",
25037         "type": "json"
25038       }
25039     ],
25040     "name": "updateMessages",
25041     "group": "Square_Messages",
25042     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25043     "version": "0.0.0",
25044     "filename": "server/api/squareMessage/index.js",
25045     "groupTitle": "Square_Messages"
25046   },
25047   {
25048     "type": "post",
25049     "url": "/api/square/odbc",
25050     "title": "Creates a new ODBC",
25051     "examples": [
25052       {
25053         "title": "Example usage:",
25054         "content": "curl https://{domain}/api/square/odbc -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
25055         "type": "json"
25056       }
25057     ],
25058     "name": "CreateODBCs",
25059     "group": "Square_ODBC",
25060     "parameter": {
25061       "fields": {
25062         "Body": [
25063           {
25064             "group": "Body",
25065             "type": "String",
25066             "optional": false,
25067             "field": "name",
25068             "description": ""
25069           },
25070           {
25071             "group": "Body",
25072             "type": "String",
25073             "optional": true,
25074             "field": "dsn",
25075             "description": ""
25076           },
25077           {
25078             "group": "Body",
25079             "type": "String",
25080             "optional": true,
25081             "field": "description",
25082             "description": ""
25083           }
25084         ]
25085       }
25086     },
25087     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25088     "version": "0.0.0",
25089     "filename": "server/api/squareOdbc/index.js",
25090     "groupTitle": "Square_ODBC"
25091   },
25092   {
25093     "type": "delete",
25094     "url": "/api/square/odbc/{id}",
25095     "title": "Deletes a ODBC",
25096     "examples": [
25097       {
25098         "title": "Example usage:",
25099         "content": "curl https://{domain}/api/square/odbc/{id} -v -u {name}:{password} -X DELETE",
25100         "type": "json"
25101       }
25102     ],
25103     "name": "DeleteODBCs",
25104     "group": "Square_ODBC",
25105     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25106     "version": "0.0.0",
25107     "filename": "server/api/squareOdbc/index.js",
25108     "groupTitle": "Square_ODBC"
25109   },
25110   {
25111     "type": "get",
25112     "url": "/api/square/odbc",
25113     "title": "Gets a list of ODBCs",
25114     "examples": [
25115       {
25116         "title": "Example usage:",
25117         "content": "curl https://{domain}/api/square/odbc -v -u {name}:{password}",
25118         "type": "json"
25119       }
25120     ],
25121     "name": "GetODBCs",
25122     "group": "Square_ODBC",
25123     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
25124     "version": "0.0.0",
25125     "filename": "server/api/squareOdbc/index.js",
25126     "groupTitle": "Square_ODBC"
25127   },
25128   {
25129     "type": "get",
25130     "url": "/api/square/odbc/{id}",
25131     "title": "Gets a single ODBC",
25132     "examples": [
25133       {
25134         "title": "Example usage:",
25135         "content": "curl https://{domain}/api/square/odbc/{id} -v -u {name}:{password}",
25136         "type": "json"
25137       }
25138     ],
25139     "name": "ShowODBCs",
25140     "group": "Square_ODBC",
25141     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25142     "version": "0.0.0",
25143     "filename": "server/api/squareOdbc/index.js",
25144     "groupTitle": "Square_ODBC"
25145   },
25146   {
25147     "type": "get",
25148     "url": "/api/square/odbc/{id}/test",
25149     "title": "Test Odbc",
25150     "examples": [
25151       {
25152         "title": "Example usage:",
25153         "content": "curl https://{domain}/api/square/odbc/{id}/test -v -u {name}:{password} -X GET",
25154         "type": "json"
25155       }
25156     ],
25157     "name": "test",
25158     "group": "Square_ODBC",
25159     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25160     "version": "0.0.0",
25161     "filename": "server/api/squareOdbc/index.js",
25162     "groupTitle": "Square_ODBC"
25163   },
25164   {
25165     "type": "put",
25166     "url": "/api/square/odbc/{id}",
25167     "title": "Update an existing ODBC",
25168     "examples": [
25169       {
25170         "title": "Example usage:",
25171         "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",
25172         "type": "json"
25173       }
25174     ],
25175     "name": "updateODBCs",
25176     "group": "Square_ODBC",
25177     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25178     "version": "0.0.0",
25179     "filename": "server/api/squareOdbc/index.js",
25180     "groupTitle": "Square_ODBC"
25181   },
25182   {
25183     "type": "post",
25184     "url": "/api/square/projects",
25185     "title": "Creates a new Project",
25186     "examples": [
25187       {
25188         "title": "Example usage:",
25189         "content": "curl https://{domain}/api/square/projects -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
25190         "type": "json"
25191       }
25192     ],
25193     "name": "CreateProjects",
25194     "group": "Square_Projects",
25195     "parameter": {
25196       "fields": {
25197         "Body": [
25198           {
25199             "group": "Body",
25200             "type": "String",
25201             "optional": false,
25202             "field": "name",
25203             "description": ""
25204           },
25205           {
25206             "group": "Body",
25207             "type": "String",
25208             "optional": true,
25209             "field": "description",
25210             "description": ""
25211           },
25212           {
25213             "group": "Body",
25214             "type": "Text",
25215             "optional": true,
25216             "field": "notes",
25217             "description": ""
25218           },
25219           {
25220             "group": "Body",
25221             "type": "Blob",
25222             "optional": true,
25223             "field": "preproduction",
25224             "description": ""
25225           },
25226           {
25227             "group": "Body",
25228             "type": "Blob",
25229             "optional": true,
25230             "field": "production",
25231             "description": ""
25232           },
25233           {
25234             "group": "Body",
25235             "type": "String",
25236             "optional": true,
25237             "field": "savedAt",
25238             "description": ""
25239           },
25240           {
25241             "group": "Body",
25242             "type": "String",
25243             "optional": true,
25244             "field": "publishedAt",
25245             "description": ""
25246           }
25247         ]
25248       }
25249     },
25250     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25251     "version": "0.0.0",
25252     "filename": "server/api/squareProject/index.js",
25253     "groupTitle": "Square_Projects"
25254   },
25255   {
25256     "type": "delete",
25257     "url": "/api/square/projects/{id}",
25258     "title": "Deletes a Project",
25259     "examples": [
25260       {
25261         "title": "Example usage:",
25262         "content": "curl https://{domain}/api/square/projects/{id} -v -u {name}:{password} -X DELETE",
25263         "type": "json"
25264       }
25265     ],
25266     "name": "DeleteProjects",
25267     "group": "Square_Projects",
25268     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25269     "version": "0.0.0",
25270     "filename": "server/api/squareProject/index.js",
25271     "groupTitle": "Square_Projects"
25272   },
25273   {
25274     "type": "get",
25275     "url": "/api/square/projects",
25276     "title": "Gets a list of Projects",
25277     "examples": [
25278       {
25279         "title": "Example usage:",
25280         "content": "curl https://{domain}/api/square/projects -v -u {name}:{password}",
25281         "type": "json"
25282       }
25283     ],
25284     "name": "GetProjects",
25285     "group": "Square_Projects",
25286     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
25287     "version": "0.0.0",
25288     "filename": "server/api/squareProject/index.js",
25289     "groupTitle": "Square_Projects"
25290   },
25291   {
25292     "type": "get",
25293     "url": "/api/square/projects/{id}",
25294     "title": "Gets a single Project",
25295     "examples": [
25296       {
25297         "title": "Example usage:",
25298         "content": "curl https://{domain}/api/square/projects/{id} -v -u {name}:{password}",
25299         "type": "json"
25300       }
25301     ],
25302     "name": "ShowProjects",
25303     "group": "Square_Projects",
25304     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25305     "version": "0.0.0",
25306     "filename": "server/api/squareProject/index.js",
25307     "groupTitle": "Square_Projects"
25308   },
25309   {
25310     "type": "post",
25311     "url": "/api/square/projects/{id}/users",
25312     "title": "Adds user permissions to a Project",
25313     "examples": [
25314       {
25315         "title": "Example usage:",
25316         "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",
25317         "type": "json"
25318       }
25319     ],
25320     "name": "addUsers",
25321     "group": "Square_Projects",
25322     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25323     "version": "0.0.0",
25324     "filename": "server/api/squareProject/index.js",
25325     "groupTitle": "Square_Projects"
25326   },
25327   {
25328     "type": "get",
25329     "url": "/api/square/projects/{id}/users",
25330     "title": "Gets users permissions from Project",
25331     "examples": [
25332       {
25333         "title": "Example usage:",
25334         "content": "curl https://{domain}/api/square/projects/{id}/users -v -u {name}:{password} -X GET",
25335         "type": "json"
25336       }
25337     ],
25338     "name": "getUsers",
25339     "group": "Square_Projects",
25340     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25341     "version": "0.0.0",
25342     "filename": "server/api/squareProject/index.js",
25343     "groupTitle": "Square_Projects"
25344   },
25345   {
25346     "type": "delete",
25347     "url": "/api/square/projects/{id}/users",
25348     "title": "Removes user permissions from a Project",
25349     "examples": [
25350       {
25351         "title": "Example usage:",
25352         "content": "curl https://{domain}/api/square/projects/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
25353         "type": "json"
25354       }
25355     ],
25356     "name": "removeUsers",
25357     "group": "Square_Projects",
25358     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25359     "version": "0.0.0",
25360     "filename": "server/api/squareProject/index.js",
25361     "groupTitle": "Square_Projects"
25362   },
25363   {
25364     "type": "put",
25365     "url": "/api/square/projects/{id}",
25366     "title": "Update an existing Project",
25367     "examples": [
25368       {
25369         "title": "Example usage:",
25370         "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",
25371         "type": "json"
25372       }
25373     ],
25374     "name": "updateProjects",
25375     "group": "Square_Projects",
25376     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25377     "version": "0.0.0",
25378     "filename": "server/api/squareProject/index.js",
25379     "groupTitle": "Square_Projects"
25380   },
25381   {
25382     "type": "post",
25383     "url": "/api/square/recordings",
25384     "title": "Creates a new Recording",
25385     "examples": [
25386       {
25387         "title": "Example usage:",
25388         "content": "curl https://{domain}/api/square/recordings -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
25389         "type": "json"
25390       }
25391     ],
25392     "name": "CreateRecordings",
25393     "group": "Square_Recordings",
25394     "parameter": {
25395       "fields": {
25396         "Body": [
25397           {
25398             "group": "Body",
25399             "type": "String",
25400             "optional": true,
25401             "field": "uniqueid",
25402             "description": ""
25403           },
25404           {
25405             "group": "Body",
25406             "type": "String",
25407             "optional": true,
25408             "field": "callerid",
25409             "description": ""
25410           },
25411           {
25412             "group": "Body",
25413             "type": "String",
25414             "optional": true,
25415             "field": "calleridname",
25416             "description": ""
25417           },
25418           {
25419             "group": "Body",
25420             "type": "String",
25421             "optional": true,
25422             "field": "context",
25423             "description": ""
25424           },
25425           {
25426             "group": "Body",
25427             "type": "String",
25428             "optional": true,
25429             "field": "extension",
25430             "description": ""
25431           },
25432           {
25433             "group": "Body",
25434             "type": "String",
25435             "optional": true,
25436             "field": "priority",
25437             "description": ""
25438           },
25439           {
25440             "group": "Body",
25441             "type": "String",
25442             "optional": true,
25443             "field": "accountcode",
25444             "description": ""
25445           },
25446           {
25447             "group": "Body",
25448             "type": "String",
25449             "optional": true,
25450             "field": "dnid",
25451             "description": ""
25452           },
25453           {
25454             "group": "Body",
25455             "type": "String",
25456             "optional": true,
25457             "field": "projectName",
25458             "description": ""
25459           },
25460           {
25461             "group": "Body",
25462             "type": "String",
25463             "optional": true,
25464             "field": "saveName",
25465             "description": ""
25466           },
25467           {
25468             "group": "Body",
25469             "type": "String",
25470             "optional": true,
25471             "field": "filename",
25472             "description": ""
25473           },
25474           {
25475             "group": "Body",
25476             "type": "String",
25477             "optional": true,
25478             "field": "savePath",
25479             "description": ""
25480           },
25481           {
25482             "group": "Body",
25483             "type": "Virtual",
25484             "optional": true,
25485             "field": "format",
25486             "description": ""
25487           }
25488         ]
25489       }
25490     },
25491     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25492     "version": "0.0.0",
25493     "filename": "server/api/squareRecording/index.js",
25494     "groupTitle": "Square_Recordings"
25495   },
25496   {
25497     "type": "get",
25498     "url": "/api/square/recordings",
25499     "title": "Gets a list of Recordings",
25500     "examples": [
25501       {
25502         "title": "Example usage:",
25503         "content": "curl https://{domain}/api/square/recordings -v -u {name}:{password}",
25504         "type": "json"
25505       }
25506     ],
25507     "name": "GetRecordings",
25508     "group": "Square_Recordings",
25509     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
25510     "version": "0.0.0",
25511     "filename": "server/api/squareRecording/index.js",
25512     "groupTitle": "Square_Recordings"
25513   },
25514   {
25515     "type": "get",
25516     "url": "/api/square/recordings/{id}",
25517     "title": "Gets a single Recording",
25518     "examples": [
25519       {
25520         "title": "Example usage:",
25521         "content": "curl https://{domain}/api/square/recordings/{id} -v -u {name}:{password}",
25522         "type": "json"
25523       }
25524     ],
25525     "name": "ShowRecordings",
25526     "group": "Square_Recordings",
25527     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25528     "version": "0.0.0",
25529     "filename": "server/api/squareRecording/index.js",
25530     "groupTitle": "Square_Recordings"
25531   },
25532   {
25533     "type": "delete",
25534     "url": "/api/square/recordings/{id}",
25535     "title": "Delete recording",
25536     "examples": [
25537       {
25538         "title": "Example usage:",
25539         "content": "curl https://{domain}/api/square/recordings/{id} -v -u {name}:{password} -X DELETE",
25540         "type": "json"
25541       }
25542     ],
25543     "name": "destroy",
25544     "group": "Square_Recordings",
25545     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25546     "version": "0.0.0",
25547     "filename": "server/api/squareRecording/index.js",
25548     "groupTitle": "Square_Recordings"
25549   },
25550   {
25551     "type": "get",
25552     "url": "/api/square/recordings/{id}/download",
25553     "title": "Download Recording",
25554     "examples": [
25555       {
25556         "title": "Example usage:",
25557         "content": "curl https://{domain}/api/square/recordings/{id}/download -v -u {name}:{password} -X GET",
25558         "type": "json"
25559       }
25560     ],
25561     "name": "download",
25562     "group": "Square_Recordings",
25563     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25564     "version": "0.0.0",
25565     "filename": "server/api/squareRecording/index.js",
25566     "groupTitle": "Square_Recordings"
25567   },
25568   {
25569     "type": "put",
25570     "url": "/api/square/recordings/{id}",
25571     "title": "Update an existing Recording",
25572     "examples": [
25573       {
25574         "title": "Example usage:",
25575         "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",
25576         "type": "json"
25577       }
25578     ],
25579     "name": "updateRecordings",
25580     "group": "Square_Recordings",
25581     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25582     "version": "0.0.0",
25583     "filename": "server/api/squareRecording/index.js",
25584     "groupTitle": "Square_Recordings"
25585   },
25586   {
25587     "type": "post",
25588     "url": "/api/square/reports",
25589     "title": "Creates a new Square Report",
25590     "examples": [
25591       {
25592         "title": "Example usage:",
25593         "content": "curl https://{domain}/api/square/reports -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
25594         "type": "json"
25595       }
25596     ],
25597     "name": "CreateSquare_Reports",
25598     "group": "Square_Reports",
25599     "parameter": {
25600       "fields": {
25601         "Body": [
25602           {
25603             "group": "Body",
25604             "type": "String",
25605             "optional": true,
25606             "field": "network",
25607             "description": ""
25608           },
25609           {
25610             "group": "Body",
25611             "type": "String",
25612             "optional": true,
25613             "field": "network_script",
25614             "description": ""
25615           },
25616           {
25617             "group": "Body",
25618             "type": "String",
25619             "optional": true,
25620             "field": "request",
25621             "description": ""
25622           },
25623           {
25624             "group": "Body",
25625             "type": "String",
25626             "optional": true,
25627             "field": "channel",
25628             "description": ""
25629           },
25630           {
25631             "group": "Body",
25632             "type": "String",
25633             "optional": true,
25634             "field": "language",
25635             "description": ""
25636           },
25637           {
25638             "group": "Body",
25639             "type": "String",
25640             "optional": true,
25641             "field": "type",
25642             "description": ""
25643           },
25644           {
25645             "group": "Body",
25646             "type": "String",
25647             "optional": true,
25648             "field": "uniqueid",
25649             "description": ""
25650           },
25651           {
25652             "group": "Body",
25653             "type": "String",
25654             "optional": true,
25655             "field": "version",
25656             "description": ""
25657           },
25658           {
25659             "group": "Body",
25660             "type": "String",
25661             "optional": true,
25662             "field": "callerid",
25663             "description": ""
25664           },
25665           {
25666             "group": "Body",
25667             "type": "String",
25668             "optional": true,
25669             "field": "calleridname",
25670             "description": ""
25671           },
25672           {
25673             "group": "Body",
25674             "type": "String",
25675             "optional": true,
25676             "field": "callingpres",
25677             "description": ""
25678           },
25679           {
25680             "group": "Body",
25681             "type": "String",
25682             "optional": true,
25683             "field": "callingani2",
25684             "description": ""
25685           },
25686           {
25687             "group": "Body",
25688             "type": "String",
25689             "optional": true,
25690             "field": "callington",
25691             "description": ""
25692           },
25693           {
25694             "group": "Body",
25695             "type": "String",
25696             "optional": true,
25697             "field": "callingtns",
25698             "description": ""
25699           },
25700           {
25701             "group": "Body",
25702             "type": "String",
25703             "optional": true,
25704             "field": "dnid",
25705             "description": ""
25706           },
25707           {
25708             "group": "Body",
25709             "type": "String",
25710             "optional": true,
25711             "field": "rdnis",
25712             "description": ""
25713           },
25714           {
25715             "group": "Body",
25716             "type": "String",
25717             "optional": true,
25718             "field": "context",
25719             "description": ""
25720           },
25721           {
25722             "group": "Body",
25723             "type": "String",
25724             "optional": true,
25725             "field": "extension",
25726             "description": ""
25727           },
25728           {
25729             "group": "Body",
25730             "type": "String",
25731             "optional": true,
25732             "field": "priority",
25733             "description": ""
25734           },
25735           {
25736             "group": "Body",
25737             "type": "String",
25738             "optional": true,
25739             "field": "enhanced",
25740             "description": ""
25741           },
25742           {
25743             "group": "Body",
25744             "type": "String",
25745             "optional": true,
25746             "field": "accountcode",
25747             "description": ""
25748           },
25749           {
25750             "group": "Body",
25751             "type": "String",
25752             "optional": true,
25753             "field": "threadid",
25754             "description": ""
25755           },
25756           {
25757             "group": "Body",
25758             "type": "String",
25759             "optional": true,
25760             "field": "project_name",
25761             "description": ""
25762           },
25763           {
25764             "group": "Body",
25765             "type": "String",
25766             "optional": true,
25767             "field": "joinAt",
25768             "description": ""
25769           },
25770           {
25771             "group": "Body",
25772             "type": "String",
25773             "optional": true,
25774             "field": "leaveAt",
25775             "description": ""
25776           },
25777           {
25778             "group": "Body",
25779             "type": "Boolean",
25780             "optional": true,
25781             "field": "bot",
25782             "description": ""
25783           }
25784         ]
25785       }
25786     },
25787     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25788     "version": "0.0.0",
25789     "filename": "server/api/squareReport/index.js",
25790     "groupTitle": "Square_Reports"
25791   },
25792   {
25793     "type": "delete",
25794     "url": "/api/square/reports/{id}",
25795     "title": "Deletes a Square Report",
25796     "examples": [
25797       {
25798         "title": "Example usage:",
25799         "content": "curl https://{domain}/api/square/reports/{id} -v -u {name}:{password} -X DELETE",
25800         "type": "json"
25801       }
25802     ],
25803     "name": "DeleteSquare_Reports",
25804     "group": "Square_Reports",
25805     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25806     "version": "0.0.0",
25807     "filename": "server/api/squareReport/index.js",
25808     "groupTitle": "Square_Reports"
25809   },
25810   {
25811     "type": "get",
25812     "url": "/api/square/reports/describe",
25813     "title": "Gets table info about Square Reports",
25814     "examples": [
25815       {
25816         "title": "Example usage:",
25817         "content": "curl https://{domain}/api/square/reports/describe -v -u {name}:{password}",
25818         "type": "json"
25819       }
25820     ],
25821     "name": "DescribeSquare_Reports",
25822     "group": "Square_Reports",
25823     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25824     "version": "0.0.0",
25825     "filename": "server/api/squareReport/index.js",
25826     "groupTitle": "Square_Reports"
25827   },
25828   {
25829     "type": "get",
25830     "url": "/api/square/reports",
25831     "title": "Gets a list of Square Reports",
25832     "examples": [
25833       {
25834         "title": "Example usage:",
25835         "content": "curl https://{domain}/api/square/reports -v -u {name}:{password}",
25836         "type": "json"
25837       }
25838     ],
25839     "name": "GetSquare_Reports",
25840     "group": "Square_Reports",
25841     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
25842     "version": "0.0.0",
25843     "filename": "server/api/squareReport/index.js",
25844     "groupTitle": "Square_Reports"
25845   },
25846   {
25847     "type": "get",
25848     "url": "/api/square/reports/{id}",
25849     "title": "Gets a single Square Report",
25850     "examples": [
25851       {
25852         "title": "Example usage:",
25853         "content": "curl https://{domain}/api/square/reports/{id} -v -u {name}:{password}",
25854         "type": "json"
25855       }
25856     ],
25857     "name": "ShowSquare_Reports",
25858     "group": "Square_Reports",
25859     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25860     "version": "0.0.0",
25861     "filename": "server/api/squareReport/index.js",
25862     "groupTitle": "Square_Reports"
25863   },
25864   {
25865     "type": "put",
25866     "url": "/api/square/reports/{id}",
25867     "title": "Update an existing Square Report",
25868     "examples": [
25869       {
25870         "title": "Example usage:",
25871         "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",
25872         "type": "json"
25873       }
25874     ],
25875     "name": "updateSquare_Reports",
25876     "group": "Square_Reports",
25877     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25878     "version": "0.0.0",
25879     "filename": "server/api/squareReport/index.js",
25880     "groupTitle": "Square_Reports"
25881   },
25882   {
25883     "type": "post",
25884     "url": "/api/integrations/sugarcrm/configurations",
25885     "title": "Creates a new SugarCRM Configuration",
25886     "examples": [
25887       {
25888         "title": "Example usage:",
25889         "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",
25890         "type": "json"
25891       }
25892     ],
25893     "name": "CreateSugarCRM_Configurations",
25894     "group": "SugarCRM_Configurations",
25895     "parameter": {
25896       "fields": {
25897         "Body": [
25898           {
25899             "group": "Body",
25900             "type": "String",
25901             "optional": true,
25902             "field": "name",
25903             "description": ""
25904           },
25905           {
25906             "group": "Body",
25907             "type": "String",
25908             "optional": true,
25909             "field": "description",
25910             "description": ""
25911           }
25912         ]
25913       }
25914     },
25915     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25916     "version": "0.0.0",
25917     "filename": "server/api/intSugarcrmConfiguration/index.js",
25918     "groupTitle": "SugarCRM_Configurations"
25919   },
25920   {
25921     "type": "delete",
25922     "url": "/api/integrations/sugarcrm/configurations/{id}",
25923     "title": "Deletes a SugarCRM Configuration",
25924     "examples": [
25925       {
25926         "title": "Example usage:",
25927         "content": "curl https://{domain}/api/integrations/sugarcrm/configurations/{id} -v -u {name}:{password} -X DELETE",
25928         "type": "json"
25929       }
25930     ],
25931     "name": "DeleteSugarCRM_Configurations",
25932     "group": "SugarCRM_Configurations",
25933     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25934     "version": "0.0.0",
25935     "filename": "server/api/intSugarcrmConfiguration/index.js",
25936     "groupTitle": "SugarCRM_Configurations"
25937   },
25938   {
25939     "type": "get",
25940     "url": "/api/integrations/sugarcrm/configurations",
25941     "title": "Gets a list of SugarCRM Configurations",
25942     "examples": [
25943       {
25944         "title": "Example usage:",
25945         "content": "curl https://{domain}/api/integrations/sugarcrm/configurations -v -u {name}:{password}",
25946         "type": "json"
25947       }
25948     ],
25949     "name": "GetSugarCRM_Configurations",
25950     "group": "SugarCRM_Configurations",
25951     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
25952     "version": "0.0.0",
25953     "filename": "server/api/intSugarcrmConfiguration/index.js",
25954     "groupTitle": "SugarCRM_Configurations"
25955   },
25956   {
25957     "type": "get",
25958     "url": "/api/integrations/sugarcrm/configurations/{id}",
25959     "title": "Gets a single SugarCRM Configuration",
25960     "examples": [
25961       {
25962         "title": "Example usage:",
25963         "content": "curl https://{domain}/api/integrations/sugarcrm/configurations/{id} -v -u {name}:{password}",
25964         "type": "json"
25965       }
25966     ],
25967     "name": "ShowSugarCRM_Configurations",
25968     "group": "SugarCRM_Configurations",
25969     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25970     "version": "0.0.0",
25971     "filename": "server/api/intSugarcrmConfiguration/index.js",
25972     "groupTitle": "SugarCRM_Configurations"
25973   },
25974   {
25975     "type": "put",
25976     "url": "/api/integrations/sugarcrm/configurations/{id}",
25977     "title": "Update an existing SugarCRM Configuration",
25978     "examples": [
25979       {
25980         "title": "Example usage:",
25981         "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",
25982         "type": "json"
25983       }
25984     ],
25985     "name": "updateSugarCRM_Configurations",
25986     "group": "SugarCRM_Configurations",
25987     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25988     "version": "0.0.0",
25989     "filename": "server/api/intSugarcrmConfiguration/index.js",
25990     "groupTitle": "SugarCRM_Configurations"
25991   },
25992   {
25993     "type": "post",
25994     "url": "/api/integrations/sugarcrm/accounts",
25995     "title": "Creates a new Sugarcrm Account",
25996     "examples": [
25997       {
25998         "title": "Example usage:",
25999         "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",
26000         "type": "json"
26001       }
26002     ],
26003     "name": "CreateSugarcrm_Accounts",
26004     "group": "Sugarcrm_Accounts",
26005     "parameter": {
26006       "fields": {
26007         "Body": [
26008           {
26009             "group": "Body",
26010             "type": "String",
26011             "optional": true,
26012             "field": "name",
26013             "description": ""
26014           },
26015           {
26016             "group": "Body",
26017             "type": "String",
26018             "optional": true,
26019             "field": "description",
26020             "description": ""
26021           },
26022           {
26023             "group": "Body",
26024             "type": "String",
26025             "optional": true,
26026             "field": "username",
26027             "description": ""
26028           },
26029           {
26030             "group": "Body",
26031             "type": "String",
26032             "optional": true,
26033             "field": "password",
26034             "description": ""
26035           },
26036           {
26037             "group": "Body",
26038             "type": "String",
26039             "optional": true,
26040             "field": "remoteUri",
26041             "description": ""
26042           },
26043           {
26044             "group": "Body",
26045             "type": "String",
26046             "optional": false,
26047             "field": "serverUrl",
26048             "description": ""
26049           }
26050         ]
26051       }
26052     },
26053     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26054     "version": "0.0.0",
26055     "filename": "server/api/intSugarcrmAccount/index.js",
26056     "groupTitle": "Sugarcrm_Accounts"
26057   },
26058   {
26059     "type": "delete",
26060     "url": "/api/integrations/sugarcrm/accounts/{id}",
26061     "title": "Deletes a Sugarcrm Account",
26062     "examples": [
26063       {
26064         "title": "Example usage:",
26065         "content": "curl https://{domain}/api/integrations/sugarcrm/accounts/{id} -v -u {name}:{password} -X DELETE",
26066         "type": "json"
26067       }
26068     ],
26069     "name": "DeleteSugarcrm_Accounts",
26070     "group": "Sugarcrm_Accounts",
26071     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <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/intSugarcrmAccount/index.js",
26074     "groupTitle": "Sugarcrm_Accounts"
26075   },
26076   {
26077     "type": "get",
26078     "url": "/api/integrations/sugarcrm/accounts",
26079     "title": "Gets a list of Sugarcrm Accounts",
26080     "examples": [
26081       {
26082         "title": "Example usage:",
26083         "content": "curl https://{domain}/api/integrations/sugarcrm/accounts -v -u {name}:{password}",
26084         "type": "json"
26085       }
26086     ],
26087     "name": "GetSugarcrm_Accounts",
26088     "group": "Sugarcrm_Accounts",
26089     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
26090     "version": "0.0.0",
26091     "filename": "server/api/intSugarcrmAccount/index.js",
26092     "groupTitle": "Sugarcrm_Accounts"
26093   },
26094   {
26095     "type": "get",
26096     "url": "/api/integrations/sugarcrm/accounts/{id}",
26097     "title": "Gets a single Sugarcrm Account",
26098     "examples": [
26099       {
26100         "title": "Example usage:",
26101         "content": "curl https://{domain}/api/integrations/sugarcrm/accounts/{id} -v -u {name}:{password}",
26102         "type": "json"
26103       }
26104     ],
26105     "name": "ShowSugarcrm_Accounts",
26106     "group": "Sugarcrm_Accounts",
26107     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26108     "version": "0.0.0",
26109     "filename": "server/api/intSugarcrmAccount/index.js",
26110     "groupTitle": "Sugarcrm_Accounts"
26111   },
26112   {
26113     "type": "post",
26114     "url": "/api/integrations/sugarcrm/accounts/{id}/configurations",
26115     "title": "Creates new configuration",
26116     "examples": [
26117       {
26118         "title": "Example usage:",
26119         "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",
26120         "type": "json"
26121       }
26122     ],
26123     "name": "addConfiguration",
26124     "group": "Sugarcrm_Accounts",
26125     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26126     "version": "0.0.0",
26127     "filename": "server/api/intSugarcrmAccount/index.js",
26128     "groupTitle": "Sugarcrm_Accounts"
26129   },
26130   {
26131     "type": "get",
26132     "url": "/api/integrations/sugarcrm/accounts/{id}/configurations",
26133     "title": "Gets account configurations",
26134     "examples": [
26135       {
26136         "title": "Example usage:",
26137         "content": "curl https://{domain}/api/integrations/sugarcrm/accounts/{id}/configurations -v -u {name}:{password} -X GET",
26138         "type": "json"
26139       }
26140     ],
26141     "name": "getConfigurations",
26142     "group": "Sugarcrm_Accounts",
26143     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26144     "version": "0.0.0",
26145     "filename": "server/api/intSugarcrmAccount/index.js",
26146     "groupTitle": "Sugarcrm_Accounts"
26147   },
26148   {
26149     "type": "get",
26150     "url": "/api/integrations/sugarcrm/accounts/{id}/fields",
26151     "title": "Gets account fields",
26152     "examples": [
26153       {
26154         "title": "Example usage:",
26155         "content": "curl https://{domain}/api/integrations/sugarcrm/accounts/{id}/fields -v -u {name}:{password} -X GET",
26156         "type": "json"
26157       }
26158     ],
26159     "name": "getFields",
26160     "group": "Sugarcrm_Accounts",
26161     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26162     "version": "0.0.0",
26163     "filename": "server/api/intSugarcrmAccount/index.js",
26164     "groupTitle": "Sugarcrm_Accounts"
26165   },
26166   {
26167     "type": "put",
26168     "url": "/api/integrations/sugarcrm/accounts/{id}",
26169     "title": "Update an existing Sugarcrm Account",
26170     "examples": [
26171       {
26172         "title": "Example usage:",
26173         "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",
26174         "type": "json"
26175       }
26176     ],
26177     "name": "updateSugarcrm_Accounts",
26178     "group": "Sugarcrm_Accounts",
26179     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26180     "version": "0.0.0",
26181     "filename": "server/api/intSugarcrmAccount/index.js",
26182     "groupTitle": "Sugarcrm_Accounts"
26183   },
26184   {
26185     "type": "get",
26186     "url": "/api/integrations/sugarcrm/configurations/{id}/descriptions",
26187     "title": "Gets configurations descriptions",
26188     "examples": [
26189       {
26190         "title": "Example usage:",
26191         "content": "curl https://{domain}/api/integrations/sugarcrm/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
26192         "type": "json"
26193       }
26194     ],
26195     "name": "getDescriptions",
26196     "group": "Sugarcrm_Configurations",
26197     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26198     "version": "0.0.0",
26199     "filename": "server/api/intSugarcrmConfiguration/index.js",
26200     "groupTitle": "Sugarcrm_Configurations"
26201   },
26202   {
26203     "type": "get",
26204     "url": "/api/integrations/sugarcrm/configurations/{id}/fields",
26205     "title": "Gets configurations fields",
26206     "examples": [
26207       {
26208         "title": "Example usage:",
26209         "content": "curl https://{domain}/api/integrations/sugarcrm/configurations/{id}/fields -v -u {name}:{password} -X GET",
26210         "type": "json"
26211       }
26212     ],
26213     "name": "getFields",
26214     "group": "Sugarcrm_Configurations",
26215     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26216     "version": "0.0.0",
26217     "filename": "server/api/intSugarcrmConfiguration/index.js",
26218     "groupTitle": "Sugarcrm_Configurations"
26219   },
26220   {
26221     "type": "get",
26222     "url": "/api/integrations/sugarcrm/configurations/{id}/subjects",
26223     "title": "Gets configurations subjects",
26224     "examples": [
26225       {
26226         "title": "Example usage:",
26227         "content": "curl https://{domain}/api/integrations/sugarcrm/configurations/{id}/subjects -v -u {name}:{password} -X GET",
26228         "type": "json"
26229       }
26230     ],
26231     "name": "getSubjects",
26232     "group": "Sugarcrm_Configurations",
26233     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26234     "version": "0.0.0",
26235     "filename": "server/api/intSugarcrmConfiguration/index.js",
26236     "groupTitle": "Sugarcrm_Configurations"
26237   },
26238   {
26239     "type": "post",
26240     "url": "/api/integrations/sugarcrm/fields",
26241     "title": "Creates a new Sugarcrm Field",
26242     "examples": [
26243       {
26244         "title": "Example usage:",
26245         "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",
26246         "type": "json"
26247       }
26248     ],
26249     "name": "CreateSugarcrm_Fields",
26250     "group": "Sugarcrm_Fields",
26251     "parameter": {
26252       "fields": {
26253         "Body": [
26254           {
26255             "group": "Body",
26256             "type": "String",
26257             "allowedValues": [
26258               "\"string\"",
26259               "\"variable\"",
26260               "\"customVariable\"",
26261               "\"keyValue\"",
26262               "\"picklist\""
26263             ],
26264             "optional": true,
26265             "field": "type",
26266             "description": ""
26267           },
26268           {
26269             "group": "Body",
26270             "type": "String",
26271             "optional": true,
26272             "field": "content",
26273             "description": ""
26274           },
26275           {
26276             "group": "Body",
26277             "type": "String",
26278             "optional": true,
26279             "field": "key",
26280             "description": ""
26281           },
26282           {
26283             "group": "Body",
26284             "type": "String",
26285             "allowedValues": [
26286               "\"string\"",
26287               "\"variable\"",
26288               "\"customVariable\""
26289             ],
26290             "optional": true,
26291             "field": "keyType",
26292             "description": ""
26293           },
26294           {
26295             "group": "Body",
26296             "type": "String",
26297             "optional": true,
26298             "field": "keyContent",
26299             "description": ""
26300           },
26301           {
26302             "group": "Body",
26303             "type": "String",
26304             "optional": true,
26305             "field": "idField",
26306             "description": ""
26307           },
26308           {
26309             "group": "Body",
26310             "type": "String",
26311             "optional": true,
26312             "field": "nameField",
26313             "description": ""
26314           },
26315           {
26316             "group": "Body",
26317             "type": "Boolean",
26318             "optional": true,
26319             "field": "customField",
26320             "description": ""
26321           },
26322           {
26323             "group": "Body",
26324             "type": "String",
26325             "optional": true,
26326             "field": "variableName",
26327             "description": ""
26328           }
26329         ]
26330       }
26331     },
26332     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26333     "version": "0.0.0",
26334     "filename": "server/api/intSugarcrmField/index.js",
26335     "groupTitle": "Sugarcrm_Fields"
26336   },
26337   {
26338     "type": "delete",
26339     "url": "/api/integrations/sugarcrm/fields/{id}",
26340     "title": "Deletes a Sugarcrm Field",
26341     "examples": [
26342       {
26343         "title": "Example usage:",
26344         "content": "curl https://{domain}/api/integrations/sugarcrm/fields/{id} -v -u {name}:{password} -X DELETE",
26345         "type": "json"
26346       }
26347     ],
26348     "name": "DeleteSugarcrm_Fields",
26349     "group": "Sugarcrm_Fields",
26350     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26351     "version": "0.0.0",
26352     "filename": "server/api/intSugarcrmField/index.js",
26353     "groupTitle": "Sugarcrm_Fields"
26354   },
26355   {
26356     "type": "get",
26357     "url": "/api/integrations/sugarcrm/fields",
26358     "title": "Gets a list of Sugarcrm Fields",
26359     "examples": [
26360       {
26361         "title": "Example usage:",
26362         "content": "curl https://{domain}/api/integrations/sugarcrm/fields -v -u {name}:{password}",
26363         "type": "json"
26364       }
26365     ],
26366     "name": "GetSugarcrm_Fields",
26367     "group": "Sugarcrm_Fields",
26368     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
26369     "version": "0.0.0",
26370     "filename": "server/api/intSugarcrmField/index.js",
26371     "groupTitle": "Sugarcrm_Fields"
26372   },
26373   {
26374     "type": "get",
26375     "url": "/api/integrations/sugarcrm/fields/{id}",
26376     "title": "Gets a single Sugarcrm Field",
26377     "examples": [
26378       {
26379         "title": "Example usage:",
26380         "content": "curl https://{domain}/api/integrations/sugarcrm/fields/{id} -v -u {name}:{password}",
26381         "type": "json"
26382       }
26383     ],
26384     "name": "ShowSugarcrm_Fields",
26385     "group": "Sugarcrm_Fields",
26386     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26387     "version": "0.0.0",
26388     "filename": "server/api/intSugarcrmField/index.js",
26389     "groupTitle": "Sugarcrm_Fields"
26390   },
26391   {
26392     "type": "put",
26393     "url": "/api/integrations/sugarcrm/fields/{id}",
26394     "title": "Update an existing Sugarcrm Field",
26395     "examples": [
26396       {
26397         "title": "Example usage:",
26398         "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",
26399         "type": "json"
26400       }
26401     ],
26402     "name": "updateSugarcrm_Fields",
26403     "group": "Sugarcrm_Fields",
26404     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26405     "version": "0.0.0",
26406     "filename": "server/api/intSugarcrmField/index.js",
26407     "groupTitle": "Sugarcrm_Fields"
26408   },
26409   {
26410     "type": "get",
26411     "url": "/api/system",
26412     "title": "Gets system information",
26413     "examples": [
26414       {
26415         "title": "Example usage:",
26416         "content": "curl https://{domain}/api/system -v -u {name}:{password}",
26417         "type": "json"
26418       }
26419     ],
26420     "name": "GetSystemInformation",
26421     "group": "System_Information",
26422     "description": "<p>Motion returns the system information.</p>",
26423     "version": "0.0.0",
26424     "filename": "server/api/system/index.js",
26425     "groupTitle": "System_Information"
26426   },
26427   {
26428     "type": "get",
26429     "url": "/api/system/process",
26430     "title": "Gets system information",
26431     "examples": [
26432       {
26433         "title": "Example usage:",
26434         "content": "curl https://{domain}/api/system -v -u {name}:{password}",
26435         "type": "json"
26436       }
26437     ],
26438     "name": "GetSystemInformation",
26439     "group": "System_Information",
26440     "description": "<p>Motion returns the system information.</p>",
26441     "version": "0.0.0",
26442     "filename": "server/api/system/index.js",
26443     "groupTitle": "System_Information"
26444   },
26445   {
26446     "type": "post",
26447     "url": "/api/tags",
26448     "title": "Creates a new Tag",
26449     "examples": [
26450       {
26451         "title": "Example usage:",
26452         "content": "curl https://{domain}/api/tags -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
26453         "type": "json"
26454       }
26455     ],
26456     "name": "CreateTags",
26457     "group": "Tags",
26458     "parameter": {
26459       "fields": {
26460         "Body": [
26461           {
26462             "group": "Body",
26463             "type": "String",
26464             "optional": false,
26465             "field": "name",
26466             "description": ""
26467           },
26468           {
26469             "group": "Body",
26470             "type": "String",
26471             "optional": true,
26472             "field": "color",
26473             "description": ""
26474           },
26475           {
26476             "group": "Body",
26477             "type": "String",
26478             "optional": true,
26479             "field": "description",
26480             "description": ""
26481           }
26482         ]
26483       }
26484     },
26485     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26486     "version": "0.0.0",
26487     "filename": "server/api/tag/index.js",
26488     "groupTitle": "Tags"
26489   },
26490   {
26491     "type": "delete",
26492     "url": "/api/tags/{id}",
26493     "title": "Deletes a Tag",
26494     "examples": [
26495       {
26496         "title": "Example usage:",
26497         "content": "curl https://{domain}/api/tags/{id} -v -u {name}:{password} -X DELETE",
26498         "type": "json"
26499       }
26500     ],
26501     "name": "DeleteTags",
26502     "group": "Tags",
26503     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26504     "version": "0.0.0",
26505     "filename": "server/api/tag/index.js",
26506     "groupTitle": "Tags"
26507   },
26508   {
26509     "type": "get",
26510     "url": "/api/tags",
26511     "title": "Gets a list of Tags",
26512     "examples": [
26513       {
26514         "title": "Example usage:",
26515         "content": "curl https://{domain}/api/tags -v -u {name}:{password}",
26516         "type": "json"
26517       }
26518     ],
26519     "name": "GetTags",
26520     "group": "Tags",
26521     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
26522     "version": "0.0.0",
26523     "filename": "server/api/tag/index.js",
26524     "groupTitle": "Tags"
26525   },
26526   {
26527     "type": "get",
26528     "url": "/api/tags/{id}",
26529     "title": "Gets a single Tag",
26530     "examples": [
26531       {
26532         "title": "Example usage:",
26533         "content": "curl https://{domain}/api/tags/{id} -v -u {name}:{password}",
26534         "type": "json"
26535       }
26536     ],
26537     "name": "ShowTags",
26538     "group": "Tags",
26539     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26540     "version": "0.0.0",
26541     "filename": "server/api/tag/index.js",
26542     "groupTitle": "Tags"
26543   },
26544   {
26545     "type": "put",
26546     "url": "/api/tags/{id}",
26547     "title": "Update an existing Tag",
26548     "examples": [
26549       {
26550         "title": "Example usage:",
26551         "content": "curl https://{domain}/api/tags/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
26552         "type": "json"
26553       }
26554     ],
26555     "name": "updateTags",
26556     "group": "Tags",
26557     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26558     "version": "0.0.0",
26559     "filename": "server/api/tag/index.js",
26560     "groupTitle": "Tags"
26561   },
26562   {
26563     "type": "post",
26564     "url": "/api/teams/{id}/queues",
26565     "title": "Add queues to a team",
26566     "examples": [
26567       {
26568         "title": "Example usage:",
26569         "content": "curl https://{domain}/api/teams/{id}/queues -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
26570         "type": "json"
26571       }
26572     ],
26573     "name": "AddQueues",
26574     "group": "Teams",
26575     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26576     "version": "0.0.0",
26577     "filename": "server/api/team/index.js",
26578     "groupTitle": "Teams"
26579   },
26580   {
26581     "type": "post",
26582     "url": "/api/teams",
26583     "title": "Creates a new Team",
26584     "examples": [
26585       {
26586         "title": "Example usage:",
26587         "content": "curl https://{domain}/api/teams -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
26588         "type": "json"
26589       }
26590     ],
26591     "name": "CreateTeams",
26592     "group": "Teams",
26593     "parameter": {
26594       "fields": {
26595         "Body": [
26596           {
26597             "group": "Body",
26598             "type": "String",
26599             "optional": false,
26600             "field": "name",
26601             "description": ""
26602           },
26603           {
26604             "group": "Body",
26605             "type": "String",
26606             "optional": true,
26607             "field": "description",
26608             "description": ""
26609           }
26610         ]
26611       }
26612     },
26613     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26614     "version": "0.0.0",
26615     "filename": "server/api/team/index.js",
26616     "groupTitle": "Teams"
26617   },
26618   {
26619     "type": "delete",
26620     "url": "/api/teams/{id}",
26621     "title": "Deletes a Team",
26622     "examples": [
26623       {
26624         "title": "Example usage:",
26625         "content": "curl https://{domain}/api/teams/{id} -v -u {name}:{password} -X DELETE",
26626         "type": "json"
26627       }
26628     ],
26629     "name": "DeleteTeams",
26630     "group": "Teams",
26631     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26632     "version": "0.0.0",
26633     "filename": "server/api/team/index.js",
26634     "groupTitle": "Teams"
26635   },
26636   {
26637     "type": "get",
26638     "url": "/api/teams/{id}/users",
26639     "title": "Gets agents from team",
26640     "examples": [
26641       {
26642         "title": "Example usage:",
26643         "content": "curl https://{domain}/api/teams/{id}/users -v -u {name}:{password} -X GET",
26644         "type": "json"
26645       }
26646     ],
26647     "name": "GetAgents",
26648     "group": "Teams",
26649     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <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/team/index.js",
26652     "groupTitle": "Teams"
26653   },
26654   {
26655     "type": "get",
26656     "url": "/api/teams/{id}/queues?channel={channel}",
26657     "title": "Gets Queues list",
26658     "examples": [
26659       {
26660         "title": "Example usage:",
26661         "content": "curl https://{domain}/api/teams/{id}/queues?channel={channel} -v -u {name}:{password}",
26662         "type": "json"
26663       }
26664     ],
26665     "name": "GetQueues",
26666     "group": "Teams",
26667     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26668     "version": "0.0.0",
26669     "filename": "server/api/team/index.js",
26670     "groupTitle": "Teams"
26671   },
26672   {
26673     "type": "get",
26674     "url": "/api/teams",
26675     "title": "Gets a list of Teams",
26676     "examples": [
26677       {
26678         "title": "Example usage:",
26679         "content": "curl https://{domain}/api/teams -v -u {name}:{password}",
26680         "type": "json"
26681       }
26682     ],
26683     "name": "GetTeams",
26684     "group": "Teams",
26685     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
26686     "version": "0.0.0",
26687     "filename": "server/api/team/index.js",
26688     "groupTitle": "Teams"
26689   },
26690   {
26691     "type": "delete",
26692     "url": "/api/teams/{id}/users",
26693     "title": "Removes agents from a team",
26694     "examples": [
26695       {
26696         "title": "Example usage:",
26697         "content": "curl https://{domain}/api/teams/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
26698         "type": "json"
26699       }
26700     ],
26701     "name": "RemoveAgents",
26702     "group": "Teams",
26703     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <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/team/index.js",
26706     "groupTitle": "Teams"
26707   },
26708   {
26709     "type": "delete",
26710     "url": "/api/teams/{id}/queues",
26711     "title": "Remove queues to a team",
26712     "examples": [
26713       {
26714         "title": "Example usage:",
26715         "content": "curl https://{domain}/api/teams/{id}/queues?channel=voice&ids=1&ids=2 -v -u {name}:{password} -X DELETE",
26716         "type": "json"
26717       }
26718     ],
26719     "name": "RemoveQueues",
26720     "group": "Teams",
26721     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26722     "version": "0.0.0",
26723     "filename": "server/api/team/index.js",
26724     "groupTitle": "Teams"
26725   },
26726   {
26727     "type": "delete",
26728     "url": "/api/fax/queues/{id}/teams",
26729     "title": "Remove teams from a queue",
26730     "examples": [
26731       {
26732         "title": "Example usage:",
26733         "content": "curl https://{domain}/api/fax/queues/{id}/teams -v -u {name}:{password} -X DELETE",
26734         "type": "json"
26735       }
26736     ],
26737     "name": "RemoveTeams",
26738     "group": "Teams",
26739     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26740     "version": "0.0.0",
26741     "filename": "server/api/faxQueue/index.js",
26742     "groupTitle": "Teams"
26743   },
26744   {
26745     "type": "delete",
26746     "url": "/api/whatsapp/queues/{id}/teams",
26747     "title": "Remove teams from a queue",
26748     "examples": [
26749       {
26750         "title": "Example usage:",
26751         "content": "curl https://{domain}/api/whatsapp/queues/{id}/teams -v -u {name}:{password} -X DELETE",
26752         "type": "json"
26753       }
26754     ],
26755     "name": "RemoveTeams",
26756     "group": "Teams",
26757     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26758     "version": "0.0.0",
26759     "filename": "server/api/whatsappQueue/index.js",
26760     "groupTitle": "Teams"
26761   },
26762   {
26763     "type": "delete",
26764     "url": "/api/openchannel/queues/{id}/teams",
26765     "title": "Remove teams from a queue",
26766     "examples": [
26767       {
26768         "title": "Example usage:",
26769         "content": "curl https://{domain}/api/openchannel/queues/{id}/teams -v -u {name}:{password} -X DELETE",
26770         "type": "json"
26771       }
26772     ],
26773     "name": "RemoveTeams",
26774     "group": "Teams",
26775     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26776     "version": "0.0.0",
26777     "filename": "server/api/openchannelQueue/index.js",
26778     "groupTitle": "Teams"
26779   },
26780   {
26781     "type": "delete",
26782     "url": "/api/sms/queues/{id}/teams",
26783     "title": "Remove teams from a queue",
26784     "examples": [
26785       {
26786         "title": "Example usage:",
26787         "content": "curl https://{domain}/api/sms/queues/{id}/teams -v -u {name}:{password} -X DELETE",
26788         "type": "json"
26789       }
26790     ],
26791     "name": "RemoveTeams",
26792     "group": "Teams",
26793     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26794     "version": "0.0.0",
26795     "filename": "server/api/smsQueue/index.js",
26796     "groupTitle": "Teams"
26797   },
26798   {
26799     "type": "delete",
26800     "url": "/api/voice/queues/{id}/teams",
26801     "title": "Remove teams from a queue",
26802     "examples": [
26803       {
26804         "title": "Example usage:",
26805         "content": "curl https://{domain}/api/voice/queues/{id}/teams -v -u {name}:{password} -X DELETE",
26806         "type": "json"
26807       }
26808     ],
26809     "name": "RemoveTeams",
26810     "group": "Teams",
26811     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26812     "version": "0.0.0",
26813     "filename": "server/api/voiceQueue/index.js",
26814     "groupTitle": "Teams"
26815   },
26816   {
26817     "type": "delete",
26818     "url": "/api/chat/queues/{id}/teams",
26819     "title": "Remove teams from a queue",
26820     "examples": [
26821       {
26822         "title": "Example usage:",
26823         "content": "curl https://{domain}/api/chat/queues/{id}/teams -v -u {name}:{password} -X DELETE",
26824         "type": "json"
26825       }
26826     ],
26827     "name": "RemoveTeams",
26828     "group": "Teams",
26829     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26830     "version": "0.0.0",
26831     "filename": "server/api/chatQueue/index.js",
26832     "groupTitle": "Teams"
26833   },
26834   {
26835     "type": "delete",
26836     "url": "/api/mail/queues/{id}/teams",
26837     "title": "Remove teams from a queue",
26838     "examples": [
26839       {
26840         "title": "Example usage:",
26841         "content": "curl https://{domain}/api/mail/queues/{id}/teams -v -u {name}:{password} -X DELETE",
26842         "type": "json"
26843       }
26844     ],
26845     "name": "RemoveTeams",
26846     "group": "Teams",
26847     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26848     "version": "0.0.0",
26849     "filename": "server/api/mailQueue/index.js",
26850     "groupTitle": "Teams"
26851   },
26852   {
26853     "type": "get",
26854     "url": "/api/teams/{id}",
26855     "title": "Gets a single Team",
26856     "examples": [
26857       {
26858         "title": "Example usage:",
26859         "content": "curl https://{domain}/api/teams/{id} -v -u {name}:{password}",
26860         "type": "json"
26861       }
26862     ],
26863     "name": "ShowTeams",
26864     "group": "Teams",
26865     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26866     "version": "0.0.0",
26867     "filename": "server/api/team/index.js",
26868     "groupTitle": "Teams"
26869   },
26870   {
26871     "type": "post",
26872     "url": "/api/teams/{id}/users",
26873     "title": "Adds agents to a team",
26874     "examples": [
26875       {
26876         "title": "Example usage:",
26877         "content": "curl https://{domain}/api/teams/{id}/users -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
26878         "type": "json"
26879       }
26880     ],
26881     "name": "addAgents",
26882     "group": "Teams",
26883     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26884     "version": "0.0.0",
26885     "filename": "server/api/team/index.js",
26886     "groupTitle": "Teams"
26887   },
26888   {
26889     "type": "put",
26890     "url": "/api/teams/{id}",
26891     "title": "Update an existing Team",
26892     "examples": [
26893       {
26894         "title": "Example usage:",
26895         "content": "curl https://{domain}/api/teams/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
26896         "type": "json"
26897       }
26898     ],
26899     "name": "updateTeams",
26900     "group": "Teams",
26901     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26902     "version": "0.0.0",
26903     "filename": "server/api/team/index.js",
26904     "groupTitle": "Teams"
26905   },
26906   {
26907     "type": "post",
26908     "url": "/api/templates",
26909     "title": "Creates a new Template",
26910     "examples": [
26911       {
26912         "title": "Example usage:",
26913         "content": "curl https://{domain}/api/templates -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
26914         "type": "json"
26915       }
26916     ],
26917     "name": "CreateTemplates",
26918     "group": "Templates",
26919     "parameter": {
26920       "fields": {
26921         "Body": [
26922           {
26923             "group": "Body",
26924             "type": "String",
26925             "optional": true,
26926             "field": "name",
26927             "description": ""
26928           },
26929           {
26930             "group": "Body",
26931             "type": "String",
26932             "optional": true,
26933             "field": "description",
26934             "description": ""
26935           },
26936           {
26937             "group": "Body",
26938             "type": "Text",
26939             "optional": true,
26940             "field": "html",
26941             "description": ""
26942           }
26943         ]
26944       }
26945     },
26946     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26947     "version": "0.0.0",
26948     "filename": "server/api/template/index.js",
26949     "groupTitle": "Templates"
26950   },
26951   {
26952     "type": "delete",
26953     "url": "/api/templates/{id}",
26954     "title": "Deletes a Template",
26955     "examples": [
26956       {
26957         "title": "Example usage:",
26958         "content": "curl https://{domain}/api/templates/{id} -v -u {name}:{password} -X DELETE",
26959         "type": "json"
26960       }
26961     ],
26962     "name": "DeleteTemplates",
26963     "group": "Templates",
26964     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26965     "version": "0.0.0",
26966     "filename": "server/api/template/index.js",
26967     "groupTitle": "Templates"
26968   },
26969   {
26970     "type": "get",
26971     "url": "/api/templates",
26972     "title": "Gets a list of Templates",
26973     "examples": [
26974       {
26975         "title": "Example usage:",
26976         "content": "curl https://{domain}/api/templates -v -u {name}:{password}",
26977         "type": "json"
26978       }
26979     ],
26980     "name": "GetTemplates",
26981     "group": "Templates",
26982     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
26983     "version": "0.0.0",
26984     "filename": "server/api/template/index.js",
26985     "groupTitle": "Templates"
26986   },
26987   {
26988     "type": "get",
26989     "url": "/api/templates/{id}",
26990     "title": "Gets a single Template",
26991     "examples": [
26992       {
26993         "title": "Example usage:",
26994         "content": "curl https://{domain}/api/templates/{id} -v -u {name}:{password}",
26995         "type": "json"
26996       }
26997     ],
26998     "name": "ShowTemplates",
26999     "group": "Templates",
27000     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27001     "version": "0.0.0",
27002     "filename": "server/api/template/index.js",
27003     "groupTitle": "Templates"
27004   },
27005   {
27006     "type": "put",
27007     "url": "/api/templates/{id}",
27008     "title": "Update an existing Template",
27009     "examples": [
27010       {
27011         "title": "Example usage:",
27012         "content": "curl https://{domain}/api/templates/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
27013         "type": "json"
27014       }
27015     ],
27016     "name": "updateTemplates",
27017     "group": "Templates",
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/template/index.js",
27021     "groupTitle": "Templates"
27022   },
27023   {
27024     "type": "post",
27025     "url": "/api/triggers",
27026     "title": "Creates a new Trigger",
27027     "examples": [
27028       {
27029         "title": "Example usage:",
27030         "content": "curl https://{domain}/api/triggers -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
27031         "type": "json"
27032       }
27033     ],
27034     "name": "CreateTriggers",
27035     "group": "Triggers",
27036     "parameter": {
27037       "fields": {
27038         "Body": [
27039           {
27040             "group": "Body",
27041             "type": "String",
27042             "optional": true,
27043             "field": "name",
27044             "description": ""
27045           },
27046           {
27047             "group": "Body",
27048             "type": "String",
27049             "optional": true,
27050             "field": "channel",
27051             "description": ""
27052           },
27053           {
27054             "group": "Body",
27055             "type": "String",
27056             "optional": true,
27057             "field": "description",
27058             "description": ""
27059           },
27060           {
27061             "group": "Body",
27062             "type": "Boolean",
27063             "optional": true,
27064             "field": "status",
27065             "description": ""
27066           }
27067         ]
27068       }
27069     },
27070     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27071     "version": "0.0.0",
27072     "filename": "server/api/trigger/index.js",
27073     "groupTitle": "Triggers"
27074   },
27075   {
27076     "type": "delete",
27077     "url": "/api/triggers/{id}",
27078     "title": "Deletes a Trigger",
27079     "examples": [
27080       {
27081         "title": "Example usage:",
27082         "content": "curl https://{domain}/api/triggers/{id} -v -u {name}:{password} -X DELETE",
27083         "type": "json"
27084       }
27085     ],
27086     "name": "DeleteTriggers",
27087     "group": "Triggers",
27088     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27089     "version": "0.0.0",
27090     "filename": "server/api/trigger/index.js",
27091     "groupTitle": "Triggers"
27092   },
27093   {
27094     "type": "get",
27095     "url": "/api/triggers",
27096     "title": "Gets a list of Triggers",
27097     "examples": [
27098       {
27099         "title": "Example usage:",
27100         "content": "curl https://{domain}/api/triggers -v -u {name}:{password}",
27101         "type": "json"
27102       }
27103     ],
27104     "name": "GetTriggers",
27105     "group": "Triggers",
27106     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
27107     "version": "0.0.0",
27108     "filename": "server/api/trigger/index.js",
27109     "groupTitle": "Triggers"
27110   },
27111   {
27112     "type": "get",
27113     "url": "/api/triggers/{id}",
27114     "title": "Gets a single Trigger",
27115     "examples": [
27116       {
27117         "title": "Example usage:",
27118         "content": "curl https://{domain}/api/triggers/{id} -v -u {name}:{password}",
27119         "type": "json"
27120       }
27121     ],
27122     "name": "ShowTriggers",
27123     "group": "Triggers",
27124     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27125     "version": "0.0.0",
27126     "filename": "server/api/trigger/index.js",
27127     "groupTitle": "Triggers"
27128   },
27129   {
27130     "type": "post",
27131     "url": "/api/triggers/{id}/actions",
27132     "title": "Creates new actions",
27133     "examples": [
27134       {
27135         "title": "Example usage:",
27136         "content": "curl https://{domain}/api/triggers/{id}/actions -d '{\"action\": \"contactManager\",\"data1\": \"1\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
27137         "type": "json"
27138       }
27139     ],
27140     "name": "addAction",
27141     "group": "Triggers",
27142     "parameter": {
27143       "fields": {
27144         "Body": [
27145           {
27146             "group": "Body",
27147             "type": "Virtual",
27148             "optional": true,
27149             "field": "name",
27150             "description": ""
27151           },
27152           {
27153             "group": "Body",
27154             "type": "String",
27155             "optional": false,
27156             "field": "action",
27157             "description": "<p>Allowed values: contactManager, integration, motionbar, jscripty, urlForward, browser, bot, script</p>"
27158           },
27159           {
27160             "group": "Body",
27161             "type": "String",
27162             "optional": true,
27163             "field": "data1",
27164             "description": "<p>contactManager[ListId], integration[intName(zendesk)], motionbar[Popup(0),URL(1),WinApp(2)], urlForward[GET,POST], browser[TemplateId(0),URL(1)]</p>"
27165           },
27166           {
27167             "group": "Body",
27168             "type": "String",
27169             "optional": true,
27170             "field": "data2",
27171             "description": "<p>integration[AccountId], motionbar[TemplateId,URL,WinAppPath], urlForward[URL]</p>"
27172           },
27173           {
27174             "group": "Body",
27175             "type": "String",
27176             "optional": true,
27177             "field": "data3",
27178             "description": "<p>motionbar[NULL,NULL,WinAppArguments]</p>"
27179           },
27180           {
27181             "group": "Body",
27182             "type": "String",
27183             "optional": true,
27184             "field": "data4",
27185             "description": ""
27186           },
27187           {
27188             "group": "Body",
27189             "type": "String",
27190             "optional": true,
27191             "field": "data5",
27192             "description": ""
27193           },
27194           {
27195             "group": "Body",
27196             "type": "String",
27197             "optional": true,
27198             "field": "data6",
27199             "description": ""
27200           },
27201           {
27202             "group": "Body",
27203             "type": "Text",
27204             "optional": true,
27205             "field": "data7",
27206             "description": ""
27207           }
27208         ]
27209       }
27210     },
27211     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27212     "version": "0.0.0",
27213     "filename": "server/api/trigger/index.js",
27214     "groupTitle": "Triggers"
27215   },
27216   {
27217     "type": "post",
27218     "url": "/api/triggers/{id}/all_conditions",
27219     "title": "Creates a new \"AND\"condition",
27220     "examples": [
27221       {
27222         "title": "Example usage:",
27223         "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",
27224         "type": "json"
27225       }
27226     ],
27227     "name": "addAllCondition",
27228     "group": "Triggers",
27229     "parameter": {
27230       "fields": {
27231         "Body": [
27232           {
27233             "group": "Body",
27234             "type": "Virtual",
27235             "optional": true,
27236             "field": "name",
27237             "description": ""
27238           },
27239           {
27240             "group": "Body",
27241             "type": "String",
27242             "optional": false,
27243             "field": "field",
27244             "description": ""
27245           },
27246           {
27247             "group": "Body",
27248             "type": "String",
27249             "optional": false,
27250             "field": "operator",
27251             "description": ""
27252           },
27253           {
27254             "group": "Body",
27255             "type": "String",
27256             "optional": false,
27257             "field": "value",
27258             "description": ""
27259           }
27260         ]
27261       }
27262     },
27263     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27264     "version": "0.0.0",
27265     "filename": "server/api/trigger/index.js",
27266     "groupTitle": "Triggers"
27267   },
27268   {
27269     "type": "post",
27270     "url": "/api/triggers/{id}/any_conditions",
27271     "title": "Creates a new \"OR\"condition",
27272     "examples": [
27273       {
27274         "title": "Example usage:",
27275         "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",
27276         "type": "json"
27277       }
27278     ],
27279     "name": "addAnyCondition",
27280     "group": "Triggers",
27281     "parameter": {
27282       "fields": {
27283         "Body": [
27284           {
27285             "group": "Body",
27286             "type": "Virtual",
27287             "optional": true,
27288             "field": "name",
27289             "description": ""
27290           },
27291           {
27292             "group": "Body",
27293             "type": "String",
27294             "optional": false,
27295             "field": "field",
27296             "description": ""
27297           },
27298           {
27299             "group": "Body",
27300             "type": "String",
27301             "optional": false,
27302             "field": "operator",
27303             "description": ""
27304           },
27305           {
27306             "group": "Body",
27307             "type": "String",
27308             "optional": false,
27309             "field": "value",
27310             "description": ""
27311           }
27312         ]
27313       }
27314     },
27315     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27316     "version": "0.0.0",
27317     "filename": "server/api/trigger/index.js",
27318     "groupTitle": "Triggers"
27319   },
27320   {
27321     "type": "get",
27322     "url": "/api/triggers/{id}/actions",
27323     "title": "Gets Trigger Actions",
27324     "examples": [
27325       {
27326         "title": "Example usage:",
27327         "content": "curl https://{domain}/api/triggers/{id}/actions -v -u {name}:{password} -X GET",
27328         "type": "json"
27329       }
27330     ],
27331     "name": "getActions",
27332     "group": "Triggers",
27333     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27334     "version": "0.0.0",
27335     "filename": "server/api/trigger/index.js",
27336     "groupTitle": "Triggers"
27337   },
27338   {
27339     "type": "get",
27340     "url": "/api/triggers/{id}/all_conditions",
27341     "title": "Gets \"AND\" Trigger Conditions",
27342     "examples": [
27343       {
27344         "title": "Example usage:",
27345         "content": "curl https://{domain}/api/triggers/{id}/all_conditions -v -u {name}:{password} -X GET",
27346         "type": "json"
27347       }
27348     ],
27349     "name": "getAllConditions",
27350     "group": "Triggers",
27351     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27352     "version": "0.0.0",
27353     "filename": "server/api/trigger/index.js",
27354     "groupTitle": "Triggers"
27355   },
27356   {
27357     "type": "get",
27358     "url": "/api/triggers/{id}/any_conditions",
27359     "title": "Gets \"OR\" Trigger Conditions",
27360     "examples": [
27361       {
27362         "title": "Example usage:",
27363         "content": "curl https://{domain}/api/triggers/{id}/any_conditions -v -u {name}:{password} -X GET",
27364         "type": "json"
27365       }
27366     ],
27367     "name": "getAnyConditions",
27368     "group": "Triggers",
27369     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27370     "version": "0.0.0",
27371     "filename": "server/api/trigger/index.js",
27372     "groupTitle": "Triggers"
27373   },
27374   {
27375     "type": "put",
27376     "url": "/api/triggers/{id}",
27377     "title": "Update an existing Trigger",
27378     "examples": [
27379       {
27380         "title": "Example usage:",
27381         "content": "curl https://{domain}/api/triggers/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
27382         "type": "json"
27383       }
27384     ],
27385     "name": "updateTriggers",
27386     "group": "Triggers",
27387     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27388     "version": "0.0.0",
27389     "filename": "server/api/trigger/index.js",
27390     "groupTitle": "Triggers"
27391   },
27392   {
27393     "type": "post",
27394     "url": "/api/trunks/clone",
27395     "title": "Clone an existing Trunk",
27396     "examples": [
27397       {
27398         "title": "Example usage:",
27399         "content": "curl https://{domain}/api/trunks/clone -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
27400         "type": "json"
27401       }
27402     ],
27403     "name": "CloneTrunks",
27404     "group": "Trunks",
27405     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27406     "version": "0.0.0",
27407     "filename": "server/api/trunk/index.js",
27408     "groupTitle": "Trunks"
27409   },
27410   {
27411     "type": "post",
27412     "url": "/api/trunks",
27413     "title": "Create a new trunk",
27414     "examples": [
27415       {
27416         "title": "Example usage:",
27417         "content": "curl https://{domain}/api/trunks -v -u {name}:{password} -X POST",
27418         "type": "json"
27419       }
27420     ],
27421     "name": "Create",
27422     "group": "Trunks",
27423     "parameter": {
27424       "fields": {
27425         "Body": [
27426           {
27427             "group": "Body",
27428             "type": "String",
27429             "optional": false,
27430             "field": "name",
27431             "description": ""
27432           },
27433           {
27434             "group": "Body",
27435             "type": "String",
27436             "allowedValues": [
27437               "\"friend\"",
27438               "\"user\"",
27439               "\"peer\""
27440             ],
27441             "optional": false,
27442             "field": "type",
27443             "description": ""
27444           },
27445           {
27446             "group": "Body",
27447             "type": "String",
27448             "optional": false,
27449             "field": "context",
27450             "description": ""
27451           },
27452           {
27453             "group": "Body",
27454             "type": "String",
27455             "allowedValues": [
27456               "\"ALLOWED_NOT_SCREENED\"",
27457               "\"ALLOWED_PASSED_SCREEN\"",
27458               "\"ALLOWED_FAILED_SCREEN\"",
27459               "\"ALLOWED\"",
27460               "\"PROHIB_NOT_SCREENED\"",
27461               "\"PROHIB_PASSED_SCREEN\"",
27462               "\"PROHIB_FAILED_SCREEN\"",
27463               "\"PROHIB\""
27464             ],
27465             "optional": true,
27466             "field": "callingpres",
27467             "description": ""
27468           },
27469           {
27470             "group": "Body",
27471             "type": "String",
27472             "optional": true,
27473             "field": "deny",
27474             "description": ""
27475           },
27476           {
27477             "group": "Body",
27478             "type": "String",
27479             "optional": true,
27480             "field": "permit",
27481             "description": ""
27482           },
27483           {
27484             "group": "Body",
27485             "type": "String",
27486             "optional": true,
27487             "field": "secret",
27488             "description": ""
27489           },
27490           {
27491             "group": "Body",
27492             "type": "String",
27493             "optional": true,
27494             "field": "md5secret",
27495             "description": ""
27496           },
27497           {
27498             "group": "Body",
27499             "type": "String",
27500             "optional": true,
27501             "field": "remotesecret",
27502             "description": ""
27503           },
27504           {
27505             "group": "Body",
27506             "type": "String",
27507             "optional": true,
27508             "field": "transport",
27509             "description": "<p>String is deprecated. Please use an Array as [&quot;udp&quot;, &quot;tcp&quot;]</p>"
27510           },
27511           {
27512             "group": "Body",
27513             "type": "String",
27514             "allowedValues": [
27515               "\"rfc2833\"",
27516               "\"info\"",
27517               "\"shortinfo\"",
27518               "\"inband\"",
27519               "\"auto\""
27520             ],
27521             "optional": true,
27522             "field": "dtmfmode",
27523             "description": ""
27524           },
27525           {
27526             "group": "Body",
27527             "type": "String",
27528             "allowedValues": [
27529               "\"yes\"",
27530               "\"no\"",
27531               "\"nonat\"",
27532               "\"update\"",
27533               "\"outgoing\""
27534             ],
27535             "optional": true,
27536             "field": "directmedia",
27537             "description": ""
27538           },
27539           {
27540             "group": "Body",
27541             "type": "String",
27542             "allowedValues": [
27543               "\"yes\"",
27544               "\"no\""
27545             ],
27546             "optional": true,
27547             "field": "directrtpsetup",
27548             "description": ""
27549           },
27550           {
27551             "group": "Body",
27552             "type": "String",
27553             "optional": true,
27554             "field": "directmediapermit",
27555             "description": ""
27556           },
27557           {
27558             "group": "Body",
27559             "type": "String",
27560             "optional": true,
27561             "field": "directmediadeny",
27562             "description": ""
27563           },
27564           {
27565             "group": "Body",
27566             "type": "String",
27567             "optional": true,
27568             "field": "nat",
27569             "description": "<p>String is deprecated. Please use an Array as [&quot;force_rport&quot;, &quot;comedia&quot;]</p>"
27570           },
27571           {
27572             "group": "Body",
27573             "type": "String",
27574             "optional": true,
27575             "field": "callgroup",
27576             "description": ""
27577           },
27578           {
27579             "group": "Body",
27580             "type": "String",
27581             "optional": true,
27582             "field": "namedcallgroup",
27583             "description": ""
27584           },
27585           {
27586             "group": "Body",
27587             "type": "String",
27588             "optional": true,
27589             "field": "pickupgroup",
27590             "description": ""
27591           },
27592           {
27593             "group": "Body",
27594             "type": "String",
27595             "optional": true,
27596             "field": "namedpickupgroup",
27597             "description": ""
27598           },
27599           {
27600             "group": "Body",
27601             "type": "String",
27602             "optional": true,
27603             "field": "language",
27604             "description": ""
27605           },
27606           {
27607             "group": "Body",
27608             "type": "String",
27609             "optional": true,
27610             "field": "tonezone",
27611             "description": ""
27612           },
27613           {
27614             "group": "Body",
27615             "type": "String",
27616             "optional": true,
27617             "field": "disallow",
27618             "description": ""
27619           },
27620           {
27621             "group": "Body",
27622             "type": "String",
27623             "optional": false,
27624             "field": "allow",
27625             "description": "<p>String is deprecated. Please use an Array as [&quot;ulaw&quot;, &quot;alaw&quot;, &quot;alaw&quot;]</p>"
27626           },
27627           {
27628             "group": "Body",
27629             "type": "String",
27630             "allowedValues": [
27631               "\"yes\"",
27632               "\"no\""
27633             ],
27634             "optional": true,
27635             "field": "autoframing",
27636             "description": ""
27637           },
27638           {
27639             "group": "Body",
27640             "type": "String",
27641             "optional": true,
27642             "field": "insecure",
27643             "description": "<p>String is deprecated. Please use an Array as [&quot;port&quot;, &quot;invite&quot;]</p>"
27644           },
27645           {
27646             "group": "Body",
27647             "type": "String",
27648             "allowedValues": [
27649               "\"yes\"",
27650               "\"no\""
27651             ],
27652             "optional": true,
27653             "field": "trustrpid",
27654             "description": ""
27655           },
27656           {
27657             "group": "Body",
27658             "type": "String",
27659             "allowedValues": [
27660               "\"yes\"",
27661               "\"no\""
27662             ],
27663             "optional": true,
27664             "field": "trust_id_outbound",
27665             "description": ""
27666           },
27667           {
27668             "group": "Body",
27669             "type": "String",
27670             "allowedValues": [
27671               "\"yes\"",
27672               "\"no\"",
27673               "\"never\""
27674             ],
27675             "optional": true,
27676             "field": "progressinband",
27677             "description": ""
27678           },
27679           {
27680             "group": "Body",
27681             "type": "String",
27682             "allowedValues": [
27683               "\"yes\"",
27684               "\"no\""
27685             ],
27686             "optional": true,
27687             "field": "promiscredir",
27688             "description": ""
27689           },
27690           {
27691             "group": "Body",
27692             "type": "String",
27693             "allowedValues": [
27694               "\"yes\"",
27695               "\"no\""
27696             ],
27697             "optional": true,
27698             "field": "useclientcode",
27699             "description": ""
27700           },
27701           {
27702             "group": "Body",
27703             "type": "Integer",
27704             "optional": true,
27705             "field": "accountcode",
27706             "description": ""
27707           },
27708           {
27709             "group": "Body",
27710             "type": "String",
27711             "optional": true,
27712             "field": "setvar",
27713             "description": ""
27714           },
27715           {
27716             "group": "Body",
27717             "type": "String",
27718             "optional": true,
27719             "field": "callerid",
27720             "description": ""
27721           },
27722           {
27723             "group": "Body",
27724             "type": "String",
27725             "optional": true,
27726             "field": "amaflags",
27727             "description": ""
27728           },
27729           {
27730             "group": "Body",
27731             "type": "String",
27732             "allowedValues": [
27733               "\"yes\"",
27734               "\"no\""
27735             ],
27736             "optional": true,
27737             "field": "callcounter",
27738             "description": ""
27739           },
27740           {
27741             "group": "Body",
27742             "type": "Integer",
27743             "optional": true,
27744             "field": "busylevel",
27745             "description": ""
27746           },
27747           {
27748             "group": "Body",
27749             "type": "String",
27750             "allowedValues": [
27751               "\"yes\"",
27752               "\"no\""
27753             ],
27754             "optional": true,
27755             "field": "allowoverlap",
27756             "description": ""
27757           },
27758           {
27759             "group": "Body",
27760             "type": "String",
27761             "allowedValues": [
27762               "\"yes\"",
27763               "\"no\""
27764             ],
27765             "optional": true,
27766             "field": "allowsubscribe",
27767             "description": ""
27768           },
27769           {
27770             "group": "Body",
27771             "type": "String",
27772             "allowedValues": [
27773               "\"yes\"",
27774               "\"no\""
27775             ],
27776             "optional": true,
27777             "field": "allowtransfer",
27778             "description": ""
27779           },
27780           {
27781             "group": "Body",
27782             "type": "String",
27783             "allowedValues": [
27784               "\"yes\"",
27785               "\"no\""
27786             ],
27787             "optional": true,
27788             "field": "ignoresdpversion",
27789             "description": ""
27790           },
27791           {
27792             "group": "Body",
27793             "type": "String",
27794             "optional": true,
27795             "field": "subscribecontext",
27796             "description": ""
27797           },
27798           {
27799             "group": "Body",
27800             "type": "String",
27801             "optional": true,
27802             "field": "template",
27803             "description": ""
27804           },
27805           {
27806             "group": "Body",
27807             "type": "String",
27808             "allowedValues": [
27809               "\"yes\"",
27810               "\"no\"",
27811               "\"always\""
27812             ],
27813             "optional": true,
27814             "field": "videosupport",
27815             "description": ""
27816           },
27817           {
27818             "group": "Body",
27819             "type": "Integer",
27820             "optional": true,
27821             "field": "maxcallbitrate",
27822             "description": ""
27823           },
27824           {
27825             "group": "Body",
27826             "type": "String",
27827             "allowedValues": [
27828               "\"yes\"",
27829               "\"no\""
27830             ],
27831             "optional": true,
27832             "field": "rfc2833compensate",
27833             "description": ""
27834           },
27835           {
27836             "group": "Body",
27837             "type": "String",
27838             "optional": true,
27839             "field": "mailbox",
27840             "description": ""
27841           },
27842           {
27843             "group": "Body",
27844             "type": "String",
27845             "allowedValues": [
27846               "\"accept\"",
27847               "\"refuse\"",
27848               "\"originate\""
27849             ],
27850             "optional": true,
27851             "field": "session_timers",
27852             "description": ""
27853           },
27854           {
27855             "group": "Body",
27856             "type": "Integer",
27857             "optional": true,
27858             "field": "session_expires",
27859             "description": ""
27860           },
27861           {
27862             "group": "Body",
27863             "type": "Integer",
27864             "optional": true,
27865             "field": "session_minse",
27866             "description": ""
27867           },
27868           {
27869             "group": "Body",
27870             "type": "String",
27871             "allowedValues": [
27872               "\"uac\"",
27873               "\"uas\""
27874             ],
27875             "optional": true,
27876             "field": "session_refresher",
27877             "description": ""
27878           },
27879           {
27880             "group": "Body",
27881             "type": "String",
27882             "optional": true,
27883             "field": "t38pt_usertpsource",
27884             "description": ""
27885           },
27886           {
27887             "group": "Body",
27888             "type": "String",
27889             "optional": true,
27890             "field": "regexten",
27891             "description": ""
27892           },
27893           {
27894             "group": "Body",
27895             "type": "String",
27896             "optional": true,
27897             "field": "fromdomain",
27898             "description": ""
27899           },
27900           {
27901             "group": "Body",
27902             "type": "String",
27903             "optional": true,
27904             "field": "fromuser",
27905             "description": ""
27906           },
27907           {
27908             "group": "Body",
27909             "type": "Integer",
27910             "optional": true,
27911             "field": "port",
27912             "description": ""
27913           },
27914           {
27915             "group": "Body",
27916             "type": "String",
27917             "allowedValues": [
27918               "\"yes\"",
27919               "\"no\""
27920             ],
27921             "optional": true,
27922             "field": "qualify",
27923             "description": ""
27924           },
27925           {
27926             "group": "Body",
27927             "type": "Integer",
27928             "optional": true,
27929             "field": "keepalive",
27930             "description": ""
27931           },
27932           {
27933             "group": "Body",
27934             "type": "String",
27935             "optional": true,
27936             "field": "defaultip",
27937             "description": ""
27938           },
27939           {
27940             "group": "Body",
27941             "type": "String",
27942             "optional": true,
27943             "field": "defaultuser",
27944             "description": ""
27945           },
27946           {
27947             "group": "Body",
27948             "type": "Integer",
27949             "optional": true,
27950             "field": "rtptimeout",
27951             "description": ""
27952           },
27953           {
27954             "group": "Body",
27955             "type": "Integer",
27956             "optional": true,
27957             "field": "rtpholdtimeout",
27958             "description": ""
27959           },
27960           {
27961             "group": "Body",
27962             "type": "Integer",
27963             "optional": true,
27964             "field": "rtpkeepalive",
27965             "description": ""
27966           },
27967           {
27968             "group": "Body",
27969             "type": "String",
27970             "allowedValues": [
27971               "\"yes\"",
27972               "\"no\"",
27973               "\"pai\""
27974             ],
27975             "optional": true,
27976             "field": "sendrpid",
27977             "description": ""
27978           },
27979           {
27980             "group": "Body",
27981             "type": "String",
27982             "optional": true,
27983             "field": "outboundproxy",
27984             "description": ""
27985           },
27986           {
27987             "group": "Body",
27988             "type": "String",
27989             "optional": true,
27990             "field": "callbackextension",
27991             "description": ""
27992           },
27993           {
27994             "group": "Body",
27995             "type": "Integer",
27996             "optional": true,
27997             "field": "timert1",
27998             "description": ""
27999           },
28000           {
28001             "group": "Body",
28002             "type": "Integer",
28003             "optional": true,
28004             "field": "timerb",
28005             "description": ""
28006           },
28007           {
28008             "group": "Body",
28009             "type": "Integer",
28010             "optional": true,
28011             "field": "qualifyfreq",
28012             "description": ""
28013           },
28014           {
28015             "group": "Body",
28016             "type": "String",
28017             "optional": true,
28018             "field": "contactpermit",
28019             "description": ""
28020           },
28021           {
28022             "group": "Body",
28023             "type": "String",
28024             "optional": true,
28025             "field": "contactdeny",
28026             "description": ""
28027           },
28028           {
28029             "group": "Body",
28030             "type": "String",
28031             "optional": true,
28032             "field": "contactacl",
28033             "description": ""
28034           },
28035           {
28036             "group": "Body",
28037             "type": "String",
28038             "optional": true,
28039             "field": "unsolicited_mailbox",
28040             "description": ""
28041           },
28042           {
28043             "group": "Body",
28044             "type": "String",
28045             "optional": true,
28046             "field": "use_q850_reason",
28047             "description": ""
28048           },
28049           {
28050             "group": "Body",
28051             "type": "Integer",
28052             "optional": true,
28053             "field": "maxforwards",
28054             "description": ""
28055           },
28056           {
28057             "group": "Body",
28058             "type": "String",
28059             "allowedValues": [
28060               "\"yes\"",
28061               "\"no\""
28062             ],
28063             "optional": true,
28064             "field": "encryption",
28065             "description": ""
28066           },
28067           {
28068             "group": "Body",
28069             "type": "String",
28070             "allowedValues": [
28071               "\"yes\"",
28072               "\"no\""
28073             ],
28074             "optional": true,
28075             "field": "avpf",
28076             "description": ""
28077           },
28078           {
28079             "group": "Body",
28080             "type": "String",
28081             "allowedValues": [
28082               "\"yes\"",
28083               "\"no\""
28084             ],
28085             "optional": true,
28086             "field": "force_avp",
28087             "description": ""
28088           },
28089           {
28090             "group": "Body",
28091             "type": "String",
28092             "allowedValues": [
28093               "\"yes\"",
28094               "\"no\""
28095             ],
28096             "optional": true,
28097             "field": "icesupport",
28098             "description": ""
28099           },
28100           {
28101             "group": "Body",
28102             "type": "String",
28103             "allowedValues": [
28104               "\"yes\"",
28105               "\"no\""
28106             ],
28107             "optional": true,
28108             "field": "dtlsenable",
28109             "description": ""
28110           },
28111           {
28112             "group": "Body",
28113             "type": "String",
28114             "allowedValues": [
28115               "\"yes\"",
28116               "\"no\"",
28117               "\"fingerprint\"",
28118               "\"certificate\""
28119             ],
28120             "optional": true,
28121             "field": "dtlsverify",
28122             "description": ""
28123           },
28124           {
28125             "group": "Body",
28126             "type": "Integer",
28127             "optional": true,
28128             "field": "dtlsrekey",
28129             "description": ""
28130           },
28131           {
28132             "group": "Body",
28133             "type": "String",
28134             "optional": true,
28135             "field": "dtlscertfile",
28136             "description": ""
28137           },
28138           {
28139             "group": "Body",
28140             "type": "String",
28141             "optional": true,
28142             "field": "dtlsprivatekey",
28143             "description": ""
28144           },
28145           {
28146             "group": "Body",
28147             "type": "String",
28148             "optional": true,
28149             "field": "dtlscipher",
28150             "description": ""
28151           },
28152           {
28153             "group": "Body",
28154             "type": "String",
28155             "optional": true,
28156             "field": "dtlscafile",
28157             "description": ""
28158           },
28159           {
28160             "group": "Body",
28161             "type": "String",
28162             "optional": true,
28163             "field": "dtlscapath",
28164             "description": ""
28165           },
28166           {
28167             "group": "Body",
28168             "type": "String",
28169             "allowedValues": [
28170               "\"active\"",
28171               "\"passive\"",
28172               "\"actpass\""
28173             ],
28174             "optional": true,
28175             "field": "dtlssetup",
28176             "description": ""
28177           },
28178           {
28179             "group": "Body",
28180             "type": "String",
28181             "optional": true,
28182             "field": "dtlsfingerprint",
28183             "description": ""
28184           },
28185           {
28186             "group": "Body",
28187             "type": "String",
28188             "allowedValues": [
28189               "\"yes\"",
28190               "\"no\""
28191             ],
28192             "optional": true,
28193             "field": "usereqphone",
28194             "description": ""
28195           },
28196           {
28197             "group": "Body",
28198             "type": "String",
28199             "optional": true,
28200             "field": "recordonfeature",
28201             "description": ""
28202           },
28203           {
28204             "group": "Body",
28205             "type": "String",
28206             "optional": true,
28207             "field": "recordofffeature",
28208             "description": ""
28209           },
28210           {
28211             "group": "Body",
28212             "type": "Integer",
28213             "optional": true,
28214             "field": "call_limit",
28215             "description": ""
28216           },
28217           {
28218             "group": "Body",
28219             "type": "String",
28220             "allowedValues": [
28221               "\"yes\"",
28222               "\"no\""
28223             ],
28224             "optional": true,
28225             "field": "registertrying",
28226             "description": ""
28227           },
28228           {
28229             "group": "Body",
28230             "type": "String",
28231             "allowedValues": [
28232               "\"yes\"",
28233               "\"no\""
28234             ],
28235             "optional": true,
28236             "field": "subscribemwi",
28237             "description": ""
28238           },
28239           {
28240             "group": "Body",
28241             "type": "String",
28242             "optional": true,
28243             "field": "vmexten",
28244             "description": ""
28245           },
28246           {
28247             "group": "Body",
28248             "type": "String",
28249             "optional": true,
28250             "field": "mohinterpret",
28251             "description": ""
28252           },
28253           {
28254             "group": "Body",
28255             "type": "String",
28256             "optional": true,
28257             "field": "mohsuggest",
28258             "description": ""
28259           },
28260           {
28261             "group": "Body",
28262             "type": "String",
28263             "optional": true,
28264             "field": "parkinglot",
28265             "description": ""
28266           },
28267           {
28268             "group": "Body",
28269             "type": "String",
28270             "optional": true,
28271             "field": "description",
28272             "description": ""
28273           },
28274           {
28275             "group": "Body",
28276             "type": "String",
28277             "optional": true,
28278             "field": "host",
28279             "description": ""
28280           },
28281           {
28282             "group": "Body",
28283             "type": "String",
28284             "allowedValues": [
28285               "\"yes\"",
28286               "\"no\"",
28287               "\"nonat\"",
28288               "\"update\"",
28289               "\"update,nonat\""
28290             ],
28291             "optional": true,
28292             "field": "canreinvite",
28293             "description": ""
28294           },
28295           {
28296             "group": "Body",
28297             "type": "String",
28298             "optional": true,
28299             "field": "registry",
28300             "description": ""
28301           },
28302           {
28303             "group": "Body",
28304             "type": "String",
28305             "optional": true,
28306             "field": "otherFields",
28307             "description": ""
28308           },
28309           {
28310             "group": "Body",
28311             "type": "Boolean",
28312             "optional": false,
28313             "field": "active",
28314             "description": ""
28315           },
28316           {
28317             "group": "Body",
28318             "type": "String",
28319             "optional": true,
28320             "field": "t38pt_udptl",
28321             "description": ""
28322           }
28323         ]
28324       }
28325     },
28326     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28327     "version": "0.0.0",
28328     "filename": "server/api/trunk/index.js",
28329     "groupTitle": "Trunks"
28330   },
28331   {
28332     "type": "delete",
28333     "url": "/api/trunks/{id}",
28334     "title": "Deletes a trunk",
28335     "examples": [
28336       {
28337         "title": "Example usage:",
28338         "content": "curl https://{domain}/api/trunks/{id} -v -u {name}:{password} -X DELETE",
28339         "type": "json"
28340       }
28341     ],
28342     "name": "Delete",
28343     "group": "Trunks",
28344     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28345     "version": "0.0.0",
28346     "filename": "server/api/trunk/index.js",
28347     "groupTitle": "Trunks"
28348   },
28349   {
28350     "type": "get",
28351     "url": "/api/trunks",
28352     "title": "Gets a list of Trunks",
28353     "examples": [
28354       {
28355         "title": "Example usage:",
28356         "content": "curl https://{domain}/api/trunks -v -u {name}:{password}",
28357         "type": "json"
28358       }
28359     ],
28360     "name": "GetTrunks",
28361     "group": "Trunks",
28362     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
28363     "version": "0.0.0",
28364     "filename": "server/api/trunk/index.js",
28365     "groupTitle": "Trunks"
28366   },
28367   {
28368     "type": "get",
28369     "url": "/api/trunks/{id}",
28370     "title": "Gets a single Trunk",
28371     "examples": [
28372       {
28373         "title": "Example usage:",
28374         "content": "curl https://{domain}/api/trunks/{id} -v -u {name}:{password}",
28375         "type": "json"
28376       }
28377     ],
28378     "name": "ShowTrunks",
28379     "group": "Trunks",
28380     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28381     "version": "0.0.0",
28382     "filename": "server/api/trunk/index.js",
28383     "groupTitle": "Trunks"
28384   },
28385   {
28386     "type": "put",
28387     "url": "/api/trunks/{id}",
28388     "title": "Update an existing trunk",
28389     "examples": [
28390       {
28391         "title": "Example usage:",
28392         "content": "curl https://{domain}/api/trunks/{id} -v -u {name}:{password} -X PUT",
28393         "type": "json"
28394       }
28395     ],
28396     "name": "Update",
28397     "group": "Trunks",
28398     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28399     "version": "0.0.0",
28400     "filename": "server/api/trunk/index.js",
28401     "groupTitle": "Trunks"
28402   },
28403   {
28404     "type": "post",
28405     "url": "/api/userNotifications",
28406     "title": "Send notification to user",
28407     "examples": [
28408       {
28409         "title": "Example usage:",
28410         "content": "curl https://{domain}/api/userNotifications -d '{\"text\": \"Hello!\", \"TemplateId\": 1}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
28411         "type": "json"
28412       }
28413     ],
28414     "name": "Send",
28415     "group": "UserNotifications",
28416     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28417     "version": "0.0.0",
28418     "filename": "server/api/userNotification/index.js",
28419     "groupTitle": "UserNotifications"
28420   },
28421   {
28422     "type": "post",
28423     "url": "/api/userProfile/resources",
28424     "title": "Creates a new User Profile Resource",
28425     "examples": [
28426       {
28427         "title": "Example usage:",
28428         "content": "curl https://{domain}/api/userProfile/resources -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
28429         "type": "json"
28430       }
28431     ],
28432     "name": "CreateUser_Profile_Resources",
28433     "group": "User_Profile_Resources",
28434     "parameter": {
28435       "fields": {
28436         "Body": [
28437           {
28438             "group": "Body",
28439             "type": "String",
28440             "optional": false,
28441             "field": "name",
28442             "description": ""
28443           },
28444           {
28445             "group": "Body",
28446             "type": "Integer",
28447             "optional": false,
28448             "field": "resourceId",
28449             "description": ""
28450           },
28451           {
28452             "group": "Body",
28453             "type": "String",
28454             "optional": false,
28455             "field": "type",
28456             "description": ""
28457           }
28458         ]
28459       }
28460     },
28461     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28462     "version": "0.0.0",
28463     "filename": "server/api/userProfileResource/index.js",
28464     "groupTitle": "User_Profile_Resources"
28465   },
28466   {
28467     "type": "delete",
28468     "url": "/api/userProfile/resources/{id}",
28469     "title": "Deletes a User Profile Resource",
28470     "examples": [
28471       {
28472         "title": "Example usage:",
28473         "content": "curl https://{domain}/api/userProfile/resources/{id} -v -u {name}:{password} -X DELETE",
28474         "type": "json"
28475       }
28476     ],
28477     "name": "DeleteUser_Profile_Resources",
28478     "group": "User_Profile_Resources",
28479     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28480     "version": "0.0.0",
28481     "filename": "server/api/userProfileResource/index.js",
28482     "groupTitle": "User_Profile_Resources"
28483   },
28484   {
28485     "type": "get",
28486     "url": "/api/userProfile/resources/describe",
28487     "title": "Gets table info about User Profile Resources",
28488     "examples": [
28489       {
28490         "title": "Example usage:",
28491         "content": "curl https://{domain}/api/userProfile/resources/describe -v -u {name}:{password}",
28492         "type": "json"
28493       }
28494     ],
28495     "name": "DescribeUser_Profile_Resources",
28496     "group": "User_Profile_Resources",
28497     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28498     "version": "0.0.0",
28499     "filename": "server/api/userProfileResource/index.js",
28500     "groupTitle": "User_Profile_Resources"
28501   },
28502   {
28503     "type": "get",
28504     "url": "/api/userProfile/resources",
28505     "title": "Gets a list of User Profile Resources",
28506     "examples": [
28507       {
28508         "title": "Example usage:",
28509         "content": "curl https://{domain}/api/userProfile/resources -v -u {name}:{password}",
28510         "type": "json"
28511       }
28512     ],
28513     "name": "GetUser_Profile_Resources",
28514     "group": "User_Profile_Resources",
28515     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
28516     "version": "0.0.0",
28517     "filename": "server/api/userProfileResource/index.js",
28518     "groupTitle": "User_Profile_Resources"
28519   },
28520   {
28521     "type": "get",
28522     "url": "/api/userProfile/resources/{id}",
28523     "title": "Gets a single User Profile Resource",
28524     "examples": [
28525       {
28526         "title": "Example usage:",
28527         "content": "curl https://{domain}/api/userProfile/resources/{id} -v -u {name}:{password}",
28528         "type": "json"
28529       }
28530     ],
28531     "name": "ShowUser_Profile_Resources",
28532     "group": "User_Profile_Resources",
28533     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28534     "version": "0.0.0",
28535     "filename": "server/api/userProfileResource/index.js",
28536     "groupTitle": "User_Profile_Resources"
28537   },
28538   {
28539     "type": "put",
28540     "url": "/api/userProfile/resources/{id}",
28541     "title": "Update an existing User Profile Resource",
28542     "examples": [
28543       {
28544         "title": "Example usage:",
28545         "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",
28546         "type": "json"
28547       }
28548     ],
28549     "name": "updateUser_Profile_Resources",
28550     "group": "User_Profile_Resources",
28551     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28552     "version": "0.0.0",
28553     "filename": "server/api/userProfileResource/index.js",
28554     "groupTitle": "User_Profile_Resources"
28555   },
28556   {
28557     "type": "post",
28558     "url": "/api/userProfile/sections",
28559     "title": "Creates a new User Profile Section",
28560     "examples": [
28561       {
28562         "title": "Example usage:",
28563         "content": "curl https://{domain}/api/userProfile/sections -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
28564         "type": "json"
28565       }
28566     ],
28567     "name": "CreateUser_Profile_Sections",
28568     "group": "User_Profile_Sections",
28569     "parameter": {
28570       "fields": {
28571         "Body": [
28572           {
28573             "group": "Body",
28574             "type": "String",
28575             "optional": false,
28576             "field": "name",
28577             "description": ""
28578           },
28579           {
28580             "group": "Body",
28581             "type": "String",
28582             "optional": false,
28583             "field": "category",
28584             "description": ""
28585           },
28586           {
28587             "group": "Body",
28588             "type": "Integer",
28589             "optional": false,
28590             "field": "sectionId",
28591             "description": ""
28592           },
28593           {
28594             "group": "Body",
28595             "type": "Boolean",
28596             "optional": true,
28597             "field": "enabled",
28598             "description": ""
28599           },
28600           {
28601             "group": "Body",
28602             "type": "Boolean",
28603             "optional": true,
28604             "field": "autoAssociation",
28605             "description": ""
28606           },
28607           {
28608             "group": "Body",
28609             "type": "String",
28610             "optional": true,
28611             "field": "crudPermissions",
28612             "description": ""
28613           }
28614         ]
28615       }
28616     },
28617     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28618     "version": "0.0.0",
28619     "filename": "server/api/userProfileSection/index.js",
28620     "groupTitle": "User_Profile_Sections"
28621   },
28622   {
28623     "type": "delete",
28624     "url": "/api/userProfile/sections/{id}",
28625     "title": "Deletes a User Profile Section",
28626     "examples": [
28627       {
28628         "title": "Example usage:",
28629         "content": "curl https://{domain}/api/userProfile/sections/{id} -v -u {name}:{password} -X DELETE",
28630         "type": "json"
28631       }
28632     ],
28633     "name": "DeleteUser_Profile_Sections",
28634     "group": "User_Profile_Sections",
28635     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28636     "version": "0.0.0",
28637     "filename": "server/api/userProfileSection/index.js",
28638     "groupTitle": "User_Profile_Sections"
28639   },
28640   {
28641     "type": "get",
28642     "url": "/api/userProfile/sections/describe",
28643     "title": "Gets table info about User Profile Sections",
28644     "examples": [
28645       {
28646         "title": "Example usage:",
28647         "content": "curl https://{domain}/api/userProfile/sections/describe -v -u {name}:{password}",
28648         "type": "json"
28649       }
28650     ],
28651     "name": "DescribeUser_Profile_Sections",
28652     "group": "User_Profile_Sections",
28653     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28654     "version": "0.0.0",
28655     "filename": "server/api/userProfileSection/index.js",
28656     "groupTitle": "User_Profile_Sections"
28657   },
28658   {
28659     "type": "get",
28660     "url": "/api/userProfile/sections",
28661     "title": "Gets a list of User Profile Sections",
28662     "examples": [
28663       {
28664         "title": "Example usage:",
28665         "content": "curl https://{domain}/api/userProfile/sections -v -u {name}:{password}",
28666         "type": "json"
28667       }
28668     ],
28669     "name": "GetUser_Profile_Sections",
28670     "group": "User_Profile_Sections",
28671     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
28672     "version": "0.0.0",
28673     "filename": "server/api/userProfileSection/index.js",
28674     "groupTitle": "User_Profile_Sections"
28675   },
28676   {
28677     "type": "get",
28678     "url": "/api/userProfile/sections/{id}",
28679     "title": "Gets a single User Profile Section",
28680     "examples": [
28681       {
28682         "title": "Example usage:",
28683         "content": "curl https://{domain}/api/userProfile/sections/{id} -v -u {name}:{password}",
28684         "type": "json"
28685       }
28686     ],
28687     "name": "ShowUser_Profile_Sections",
28688     "group": "User_Profile_Sections",
28689     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28690     "version": "0.0.0",
28691     "filename": "server/api/userProfileSection/index.js",
28692     "groupTitle": "User_Profile_Sections"
28693   },
28694   {
28695     "type": "put",
28696     "url": "/api/userProfile/sections/{id}",
28697     "title": "Update an existing User Profile Section",
28698     "examples": [
28699       {
28700         "title": "Example usage:",
28701         "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",
28702         "type": "json"
28703       }
28704     ],
28705     "name": "updateUser_Profile_Sections",
28706     "group": "User_Profile_Sections",
28707     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28708     "version": "0.0.0",
28709     "filename": "server/api/userProfileSection/index.js",
28710     "groupTitle": "User_Profile_Sections"
28711   },
28712   {
28713     "type": "post",
28714     "url": "/api/userProfiles/{id}/resources",
28715     "title": "Add resources' permissions to User Profile",
28716     "examples": [
28717       {
28718         "title": "Example usage:",
28719         "content": "curl https://{domain}/api/userProfiles/{id}/resources -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
28720         "type": "json"
28721       }
28722     ],
28723     "name": "AddResources",
28724     "group": "User_Profiles",
28725     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28726     "version": "0.0.0",
28727     "filename": "server/api/userProfile/index.js",
28728     "groupTitle": "User_Profiles"
28729   },
28730   {
28731     "type": "post",
28732     "url": "/api/userProfiles/{id}/sections",
28733     "title": "Add sections' permissions to User Profile",
28734     "examples": [
28735       {
28736         "title": "Example usage:",
28737         "content": "curl https://{domain}/api/userProfiles/{id}/sections -d '[{\"sectionId\": \"name\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
28738         "type": "json"
28739       }
28740     ],
28741     "name": "AddSections",
28742     "group": "User_Profiles",
28743     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28744     "version": "0.0.0",
28745     "filename": "server/api/userProfile/index.js",
28746     "groupTitle": "User_Profiles"
28747   },
28748   {
28749     "type": "post",
28750     "url": "/api/userProfiles/clone",
28751     "title": "Clone an existing User Profile",
28752     "examples": [
28753       {
28754         "title": "Example usage:",
28755         "content": "curl https://{domain}/api/userProfiles/clone -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
28756         "type": "json"
28757       }
28758     ],
28759     "name": "CloneUser_Profiles",
28760     "group": "User_Profiles",
28761     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28762     "version": "0.0.0",
28763     "filename": "server/api/userProfile/index.js",
28764     "groupTitle": "User_Profiles"
28765   },
28766   {
28767     "type": "post",
28768     "url": "/api/userProfiles",
28769     "title": "Creates a new User Profile",
28770     "examples": [
28771       {
28772         "title": "Example usage:",
28773         "content": "curl https://{domain}/api/userProfiles -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
28774         "type": "json"
28775       }
28776     ],
28777     "name": "CreateUser_Profiles",
28778     "group": "User_Profiles",
28779     "parameter": {
28780       "fields": {
28781         "Body": [
28782           {
28783             "group": "Body",
28784             "type": "String",
28785             "optional": false,
28786             "field": "name",
28787             "description": ""
28788           },
28789           {
28790             "group": "Body",
28791             "type": "String",
28792             "optional": false,
28793             "field": "crudPermissions",
28794             "description": ""
28795           },
28796           {
28797             "group": "Body",
28798             "type": "String",
28799             "optional": true,
28800             "field": "description",
28801             "description": ""
28802           },
28803           {
28804             "group": "Body",
28805             "type": "Boolean",
28806             "optional": true,
28807             "field": "privacyEnabled",
28808             "description": ""
28809           },
28810           {
28811             "group": "Body",
28812             "type": "Boolean",
28813             "optional": true,
28814             "field": "downloadAttachments",
28815             "description": ""
28816           },
28817           {
28818             "group": "Body",
28819             "type": "Boolean",
28820             "optional": true,
28821             "field": "downloadCallySquareRecordings",
28822             "description": ""
28823           },
28824           {
28825             "group": "Body",
28826             "type": "Boolean",
28827             "optional": true,
28828             "field": "downloadContactManagerLists",
28829             "description": ""
28830           },
28831           {
28832             "group": "Body",
28833             "type": "Boolean",
28834             "optional": true,
28835             "field": "downloadJscriptySessions",
28836             "description": ""
28837           },
28838           {
28839             "group": "Body",
28840             "type": "Boolean",
28841             "optional": true,
28842             "field": "downloadOmnichannelInteractions",
28843             "description": ""
28844           },
28845           {
28846             "group": "Body",
28847             "type": "Boolean",
28848             "optional": true,
28849             "field": "downloadScreenRecordings",
28850             "description": ""
28851           },
28852           {
28853             "group": "Body",
28854             "type": "Boolean",
28855             "optional": true,
28856             "field": "downloadVoiceRecordings",
28857             "description": ""
28858           }
28859         ]
28860       }
28861     },
28862     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28863     "version": "0.0.0",
28864     "filename": "server/api/userProfile/index.js",
28865     "groupTitle": "User_Profiles"
28866   },
28867   {
28868     "type": "delete",
28869     "url": "/api/userProfiles/{id}",
28870     "title": "Deletes a User Profile",
28871     "examples": [
28872       {
28873         "title": "Example usage:",
28874         "content": "curl https://{domain}/api/userProfiles/{id} -v -u {name}:{password} -X DELETE",
28875         "type": "json"
28876       }
28877     ],
28878     "name": "DeleteUser_Profiles",
28879     "group": "User_Profiles",
28880     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28881     "version": "0.0.0",
28882     "filename": "server/api/userProfile/index.js",
28883     "groupTitle": "User_Profiles"
28884   },
28885   {
28886     "type": "get",
28887     "url": "/api/userProfiles/describe",
28888     "title": "Gets table info about User Profiles",
28889     "examples": [
28890       {
28891         "title": "Example usage:",
28892         "content": "curl https://{domain}/api/userProfiles/describe -v -u {name}:{password}",
28893         "type": "json"
28894       }
28895     ],
28896     "name": "DescribeUser_Profiles",
28897     "group": "User_Profiles",
28898     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28899     "version": "0.0.0",
28900     "filename": "server/api/userProfile/index.js",
28901     "groupTitle": "User_Profiles"
28902   },
28903   {
28904     "type": "get",
28905     "url": "/api/userProfiles/{id}/resources?section={section}",
28906     "title": "Get Resources assigned to a Section",
28907     "examples": [
28908       {
28909         "title": "Example usage:",
28910         "content": "curl https://{domain}/api/userProfiles/{id}/resources?section={section} -v -u {name}:{password} -X GET",
28911         "type": "json"
28912       }
28913     ],
28914     "name": "GetResources",
28915     "group": "User_Profiles",
28916     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28917     "version": "0.0.0",
28918     "filename": "server/api/userProfile/index.js",
28919     "groupTitle": "User_Profiles"
28920   },
28921   {
28922     "type": "get",
28923     "url": "/api/userProfiles/{id}/sections",
28924     "title": "Get sections associated to a User Profile",
28925     "examples": [
28926       {
28927         "title": "Example usage:",
28928         "content": "curl https://{domain}/api/userProfiles/{id}/sections -v -u {name}:{password} -X GET",
28929         "type": "json"
28930       }
28931     ],
28932     "name": "GetSections",
28933     "group": "User_Profiles",
28934     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28935     "version": "0.0.0",
28936     "filename": "server/api/userProfile/index.js",
28937     "groupTitle": "User_Profiles"
28938   },
28939   {
28940     "type": "get",
28941     "url": "/api/userProfiles",
28942     "title": "Gets a list of User Profiles",
28943     "examples": [
28944       {
28945         "title": "Example usage:",
28946         "content": "curl https://{domain}/api/userProfiles -v -u {name}:{password}",
28947         "type": "json"
28948       }
28949     ],
28950     "name": "GetUser_Profiles",
28951     "group": "User_Profiles",
28952     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
28953     "version": "0.0.0",
28954     "filename": "server/api/userProfile/index.js",
28955     "groupTitle": "User_Profiles"
28956   },
28957   {
28958     "type": "delete",
28959     "url": "/api/userProfiles/{id}/resources",
28960     "title": "Removes resources' permissions from User Profile",
28961     "examples": [
28962       {
28963         "title": "Example usage:",
28964         "content": "curl https://{domain}/api/userProfiles/{id}/resources?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
28965         "type": "json"
28966       }
28967     ],
28968     "name": "RemoveResources",
28969     "group": "User_Profiles",
28970     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28971     "version": "0.0.0",
28972     "filename": "server/api/userProfile/index.js",
28973     "groupTitle": "User_Profiles"
28974   },
28975   {
28976     "type": "delete",
28977     "url": "/api/userProfiles/{id}/sections",
28978     "title": "Removes sections' permissions from User Profile",
28979     "examples": [
28980       {
28981         "title": "Example usage:",
28982         "content": "curl https://{domain}/api/userProfiles/{id}/sections?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
28983         "type": "json"
28984       }
28985     ],
28986     "name": "RemoveSections",
28987     "group": "User_Profiles",
28988     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28989     "version": "0.0.0",
28990     "filename": "server/api/userProfile/index.js",
28991     "groupTitle": "User_Profiles"
28992   },
28993   {
28994     "type": "get",
28995     "url": "/api/userProfiles/{id}",
28996     "title": "Gets a single User Profile",
28997     "examples": [
28998       {
28999         "title": "Example usage:",
29000         "content": "curl https://{domain}/api/userProfiles/{id} -v -u {name}:{password}",
29001         "type": "json"
29002       }
29003     ],
29004     "name": "ShowUser_Profiles",
29005     "group": "User_Profiles",
29006     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29007     "version": "0.0.0",
29008     "filename": "server/api/userProfile/index.js",
29009     "groupTitle": "User_Profiles"
29010   },
29011   {
29012     "type": "put",
29013     "url": "/api/userProfiles/{id}",
29014     "title": "Update an existing User Profile",
29015     "examples": [
29016       {
29017         "title": "Example usage:",
29018         "content": "curl https://{domain}/api/userProfiles/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
29019         "type": "json"
29020       }
29021     ],
29022     "name": "updateUser_Profiles",
29023     "group": "User_Profiles",
29024     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29025     "version": "0.0.0",
29026     "filename": "server/api/userProfile/index.js",
29027     "groupTitle": "User_Profiles"
29028   },
29029   {
29030     "type": "post",
29031     "url": "/api/users/{id}/chat_interactions",
29032     "title": "Add chat interaction tabs to an agent",
29033     "examples": [
29034       {
29035         "title": "Example usage:",
29036         "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",
29037         "type": "json"
29038       }
29039     ],
29040     "name": "AddChatInteractions",
29041     "group": "Users",
29042     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29043     "version": "0.0.0",
29044     "filename": "server/api/user/index.js",
29045     "groupTitle": "Users"
29046   },
29047   {
29048     "type": "post",
29049     "url": "/api/users/{id}/chat_websites",
29050     "title": "Add a Chat Website to a user",
29051     "examples": [
29052       {
29053         "title": "Example usage:",
29054         "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",
29055         "type": "json"
29056       }
29057     ],
29058     "name": "AddChatWebsites",
29059     "group": "Users",
29060     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29061     "version": "0.0.0",
29062     "filename": "server/api/user/index.js",
29063     "groupTitle": "Users"
29064   },
29065   {
29066     "type": "post",
29067     "url": "/api/users/{id}/contacts",
29068     "title": "Add contacts to a user",
29069     "examples": [
29070       {
29071         "title": "Example usage:",
29072         "content": "curl https://{domain}/api/users/{id}/contacts -d '{\"ids\": [1,2]}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
29073         "type": "json"
29074       }
29075     ],
29076     "name": "AddContacts",
29077     "group": "Users",
29078     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29079     "version": "0.0.0",
29080     "filename": "server/api/user/index.js",
29081     "groupTitle": "Users"
29082   },
29083   {
29084     "type": "post",
29085     "url": "/api/users/{id}/fax_accounts",
29086     "title": "Add a Fax Account to a user",
29087     "examples": [
29088       {
29089         "title": "Example usage:",
29090         "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",
29091         "type": "json"
29092       }
29093     ],
29094     "name": "AddFaxAccounts",
29095     "group": "Users",
29096     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29097     "version": "0.0.0",
29098     "filename": "server/api/user/index.js",
29099     "groupTitle": "Users"
29100   },
29101   {
29102     "type": "post",
29103     "url": "/api/users/{id}/fax_interactions",
29104     "title": "Add fax interaction tabs to an agent",
29105     "examples": [
29106       {
29107         "title": "Example usage:",
29108         "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",
29109         "type": "json"
29110       }
29111     ],
29112     "name": "AddFaxInteractions",
29113     "group": "Users",
29114     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29115     "version": "0.0.0",
29116     "filename": "server/api/user/index.js",
29117     "groupTitle": "Users"
29118   },
29119   {
29120     "type": "post",
29121     "url": "/api/users/{id}/mail_accounts",
29122     "title": "Add a Mail Account to a user",
29123     "examples": [
29124       {
29125         "title": "Example usage:",
29126         "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",
29127         "type": "json"
29128       }
29129     ],
29130     "name": "AddMailAccounts",
29131     "group": "Users",
29132     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29133     "version": "0.0.0",
29134     "filename": "server/api/user/index.js",
29135     "groupTitle": "Users"
29136   },
29137   {
29138     "type": "post",
29139     "url": "/api/users/{id}/mail_interactions",
29140     "title": "Add mail interaction tabs to an agent",
29141     "examples": [
29142       {
29143         "title": "Example usage:",
29144         "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",
29145         "type": "json"
29146       }
29147     ],
29148     "name": "AddMailInteractions",
29149     "group": "Users",
29150     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29151     "version": "0.0.0",
29152     "filename": "server/api/user/index.js",
29153     "groupTitle": "Users"
29154   },
29155   {
29156     "type": "post",
29157     "url": "/api/users/{id}/openchannel_accounts",
29158     "title": "Add a Open Channel Account to a user",
29159     "examples": [
29160       {
29161         "title": "Example usage:",
29162         "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",
29163         "type": "json"
29164       }
29165     ],
29166     "name": "AddOpenchannelAccounts",
29167     "group": "Users",
29168     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29169     "version": "0.0.0",
29170     "filename": "server/api/user/index.js",
29171     "groupTitle": "Users"
29172   },
29173   {
29174     "type": "post",
29175     "url": "/api/users/{id}/openchannel_interactions",
29176     "title": "Add openchannel interaction tabs to an agent",
29177     "examples": [
29178       {
29179         "title": "Example usage:",
29180         "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",
29181         "type": "json"
29182       }
29183     ],
29184     "name": "AddOpenchannelInteractions",
29185     "group": "Users",
29186     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29187     "version": "0.0.0",
29188     "filename": "server/api/user/index.js",
29189     "groupTitle": "Users"
29190   },
29191   {
29192     "type": "post",
29193     "url": "/api/users/{id}/queues",
29194     "title": "Add queues to an agent",
29195     "examples": [
29196       {
29197         "title": "Example usage:",
29198         "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",
29199         "type": "json"
29200       }
29201     ],
29202     "name": "AddQueues",
29203     "group": "Users",
29204     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29205     "version": "0.0.0",
29206     "filename": "server/api/user/index.js",
29207     "groupTitle": "Users"
29208   },
29209   {
29210     "type": "post",
29211     "url": "/api/users/{id}/sms_accounts",
29212     "title": "Add a Sms Account to a user",
29213     "examples": [
29214       {
29215         "title": "Example usage:",
29216         "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",
29217         "type": "json"
29218       }
29219     ],
29220     "name": "AddSmsAccounts",
29221     "group": "Users",
29222     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29223     "version": "0.0.0",
29224     "filename": "server/api/user/index.js",
29225     "groupTitle": "Users"
29226   },
29227   {
29228     "type": "post",
29229     "url": "/api/users/{id}/sms_interactions",
29230     "title": "Add sms interaction tabs to an agent",
29231     "examples": [
29232       {
29233         "title": "Example usage:",
29234         "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",
29235         "type": "json"
29236       }
29237     ],
29238     "name": "AddSmsInteractions",
29239     "group": "Users",
29240     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29241     "version": "0.0.0",
29242     "filename": "server/api/user/index.js",
29243     "groupTitle": "Users"
29244   },
29245   {
29246     "type": "post",
29247     "url": "/api/users/{id}/square_projects",
29248     "title": "Add a Square Project to a user",
29249     "examples": [
29250       {
29251         "title": "Example usage:",
29252         "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",
29253         "type": "json"
29254       }
29255     ],
29256     "name": "AddSquareProjects",
29257     "group": "Users",
29258     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29259     "version": "0.0.0",
29260     "filename": "server/api/user/index.js",
29261     "groupTitle": "Users"
29262   },
29263   {
29264     "type": "post",
29265     "url": "/api/users/{id}/teams",
29266     "title": "Add teams to an agent",
29267     "examples": [
29268       {
29269         "title": "Example usage:",
29270         "content": "curl https://{domain}/api/users/{id}/teams -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
29271         "type": "json"
29272       }
29273     ],
29274     "name": "AddTeams",
29275     "group": "Users",
29276     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29277     "version": "0.0.0",
29278     "filename": "server/api/user/index.js",
29279     "groupTitle": "Users"
29280   },
29281   {
29282     "type": "post",
29283     "url": "/api/users/{id}/whatsapp_accounts",
29284     "title": "Add a Whatsapp Account to a user",
29285     "examples": [
29286       {
29287         "title": "Example usage:",
29288         "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",
29289         "type": "json"
29290       }
29291     ],
29292     "name": "AddWhatsappAccounts",
29293     "group": "Users",
29294     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29295     "version": "0.0.0",
29296     "filename": "server/api/user/index.js",
29297     "groupTitle": "Users"
29298   },
29299   {
29300     "type": "post",
29301     "url": "/api/users/{id}/whatsapp_interactions",
29302     "title": "Add Whatsapp interaction tabs to an agent",
29303     "examples": [
29304       {
29305         "title": "Example usage:",
29306         "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",
29307         "type": "json"
29308       }
29309     ],
29310     "name": "AddWhatsappInteractions",
29311     "group": "Users",
29312     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29313     "version": "0.0.0",
29314     "filename": "server/api/user/index.js",
29315     "groupTitle": "Users"
29316   },
29317   {
29318     "type": "put",
29319     "url": "/api/users/{id}/password",
29320     "title": "Change user password",
29321     "examples": [
29322       {
29323         "title": "Example usage:",
29324         "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",
29325         "type": "json"
29326       }
29327     ],
29328     "name": "ChangePwd",
29329     "group": "Users",
29330     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29331     "version": "0.0.0",
29332     "filename": "server/api/user/index.js",
29333     "groupTitle": "Users"
29334   },
29335   {
29336     "type": "post",
29337     "url": "/api/users",
29338     "title": "Create a new user",
29339     "examples": [
29340       {
29341         "title": "Example usage:",
29342         "content": "curl https://{domain}/api/users -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
29343         "type": "json"
29344       }
29345     ],
29346     "name": "Create",
29347     "group": "Users",
29348     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29349     "version": "0.0.0",
29350     "filename": "server/api/user/index.js",
29351     "groupTitle": "Users"
29352   },
29353   {
29354     "type": "post",
29355     "url": "/api/users/{id}/api_key",
29356     "title": "Create a new API access key for the user",
29357     "examples": [
29358       {
29359         "title": "Example usage:",
29360         "content": "curl https://{domain}/api/users/:id/api_key -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
29361         "type": "json"
29362       }
29363     ],
29364     "name": "CreateApiKey",
29365     "group": "Users",
29366     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29367     "version": "0.0.0",
29368     "filename": "server/api/user/index.js",
29369     "groupTitle": "Users"
29370   },
29371   {
29372     "type": "delete",
29373     "url": "/api/users/{id}",
29374     "title": "Deletes a user",
29375     "examples": [
29376       {
29377         "title": "Example usage:",
29378         "content": "curl https://{domain}/api/users/{id} -v -u {name}:{password} -X DELETE",
29379         "type": "json"
29380       }
29381     ],
29382     "name": "Delete",
29383     "group": "Users",
29384     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29385     "version": "0.0.0",
29386     "filename": "server/api/user/index.js",
29387     "groupTitle": "Users"
29388   },
29389   {
29390     "type": "get",
29391     "url": "/api/users/describe",
29392     "title": "Gets table info about Users",
29393     "examples": [
29394       {
29395         "title": "Example usage:",
29396         "content": "curl https://{domain}/api/users/describe -v -u {name}:{password}",
29397         "type": "json"
29398       }
29399     ],
29400     "name": "DescribeUsers",
29401     "group": "Users",
29402     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29403     "version": "0.0.0",
29404     "filename": "server/api/user/index.js",
29405     "groupTitle": "Users"
29406   },
29407   {
29408     "type": "get",
29409     "url": "/api/users/{id}/agents",
29410     "title": "GetAgents",
29411     "examples": [
29412       {
29413         "title": "Example usage:",
29414         "content": "curl https://{domain}/api/users/{id}/agents -v -u {name}:{password} -X GET",
29415         "type": "json"
29416       }
29417     ],
29418     "name": "GetAgents",
29419     "group": "Users",
29420     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29421     "version": "0.0.0",
29422     "filename": "server/api/user/index.js",
29423     "groupTitle": "Users"
29424   },
29425   {
29426     "type": "get",
29427     "url": "/api/users/{id}/api_key",
29428     "title": "Get the API access key for the user",
29429     "examples": [
29430       {
29431         "title": "Example usage:",
29432         "content": "curl https://{domain}/api/users/:id/api_key -v -u {name}:{password} -X GET",
29433         "type": "json"
29434       }
29435     ],
29436     "name": "GetApiKey",
29437     "group": "Users",
29438     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29439     "version": "0.0.0",
29440     "filename": "server/api/user/index.js",
29441     "groupTitle": "Users"
29442   },
29443   {
29444     "type": "get",
29445     "url": "/api/users/{id}/groups",
29446     "title": "GetChatGroups",
29447     "examples": [
29448       {
29449         "title": "Example usage:",
29450         "content": "curl https://{domain}/api/users/{id}/groups -v -u {name}:{password} -X GET",
29451         "type": "json"
29452       }
29453     ],
29454     "name": "GetChatGroups",
29455     "group": "Users",
29456     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29457     "version": "0.0.0",
29458     "filename": "server/api/user/index.js",
29459     "groupTitle": "Users"
29460   },
29461   {
29462     "type": "get",
29463     "url": "/api/users/{id}/chat/interactions",
29464     "title": "GetChatInteractions",
29465     "examples": [
29466       {
29467         "title": "Example usage:",
29468         "content": "curl https://{domain}/api/users/{id}/chat/interactions -v -u {name}:{password} -X GET",
29469         "type": "json"
29470       }
29471     ],
29472     "name": "GetChatInteractions",
29473     "group": "Users",
29474     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29475     "version": "0.0.0",
29476     "filename": "server/api/user/index.js",
29477     "groupTitle": "Users"
29478   },
29479   {
29480     "type": "get",
29481     "url": "/api/users/{id}/chat_websites",
29482     "title": "GetChatWebsites",
29483     "examples": [
29484       {
29485         "title": "Example usage:",
29486         "content": "curl https://{domain}/api/users/{id}/chat_websites -v -u {name}:{password} -X GET",
29487         "type": "json"
29488       }
29489     ],
29490     "name": "GetChatWebsites",
29491     "group": "Users",
29492     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29493     "version": "0.0.0",
29494     "filename": "server/api/user/index.js",
29495     "groupTitle": "Users"
29496   },
29497   {
29498     "type": "get",
29499     "url": "/api/users/{id}/contacts",
29500     "title": "GetContacts",
29501     "examples": [
29502       {
29503         "title": "Example usage:",
29504         "content": "curl https://{domain}/api/users/{id}/contacts -v -u {name}:{password} -X GET",
29505         "type": "json"
29506       }
29507     ],
29508     "name": "GetContacts",
29509     "group": "Users",
29510     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29511     "version": "0.0.0",
29512     "filename": "server/api/user/index.js",
29513     "groupTitle": "Users"
29514   },
29515   {
29516     "type": "get",
29517     "url": "/api/users/{id}/fax_accounts",
29518     "title": "GetFaxAccounts",
29519     "examples": [
29520       {
29521         "title": "Example usage:",
29522         "content": "curl https://{domain}/api/users/{id}/fax_accounts -v -u {name}:{password} -X GET",
29523         "type": "json"
29524       }
29525     ],
29526     "name": "GetFaxAccounts",
29527     "group": "Users",
29528     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29529     "version": "0.0.0",
29530     "filename": "server/api/user/index.js",
29531     "groupTitle": "Users"
29532   },
29533   {
29534     "type": "get",
29535     "url": "/api/users/{id}/fax/interactions",
29536     "title": "GetFaxInteractions",
29537     "examples": [
29538       {
29539         "title": "Example usage:",
29540         "content": "curl https://{domain}/api/users/{id}/fax/interactions -v -u {name}:{password} -X GET",
29541         "type": "json"
29542       }
29543     ],
29544     "name": "GetFaxInteractions",
29545     "group": "Users",
29546     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29547     "version": "0.0.0",
29548     "filename": "server/api/user/index.js",
29549     "groupTitle": "Users"
29550   },
29551   {
29552     "type": "get",
29553     "url": "/api/users/{id}/lists",
29554     "title": "GetLists",
29555     "examples": [
29556       {
29557         "title": "Example usage:",
29558         "content": "curl https://{domain}/api/users/{id}/lists -v -u {name}:{password} -X GET",
29559         "type": "json"
29560       }
29561     ],
29562     "name": "GetLists",
29563     "group": "Users",
29564     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29565     "version": "0.0.0",
29566     "filename": "server/api/user/index.js",
29567     "groupTitle": "Users"
29568   },
29569   {
29570     "type": "get",
29571     "url": "/api/users/{id}/mail_accounts",
29572     "title": "GetMailAccounts",
29573     "examples": [
29574       {
29575         "title": "Example usage:",
29576         "content": "curl https://{domain}/api/users/{id}/mail_accounts -v -u {name}:{password} -X GET",
29577         "type": "json"
29578       }
29579     ],
29580     "name": "GetMailAccounts",
29581     "group": "Users",
29582     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29583     "version": "0.0.0",
29584     "filename": "server/api/user/index.js",
29585     "groupTitle": "Users"
29586   },
29587   {
29588     "type": "get",
29589     "url": "/api/users/{id}/mail/interactions",
29590     "title": "GetMailInteractions",
29591     "examples": [
29592       {
29593         "title": "Example usage:",
29594         "content": "curl https://{domain}/api/users/{id}/mail/interactions -v -u {name}:{password} -X GET",
29595         "type": "json"
29596       }
29597     ],
29598     "name": "GetMailInteractions",
29599     "group": "Users",
29600     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29601     "version": "0.0.0",
29602     "filename": "server/api/user/index.js",
29603     "groupTitle": "Users"
29604   },
29605   {
29606     "type": "get",
29607     "url": "/api/users/{id}/openchannel_accounts",
29608     "title": "GetOpenchannelAccounts",
29609     "examples": [
29610       {
29611         "title": "Example usage:",
29612         "content": "curl https://{domain}/api/users/{id}/openchannel_accounts -v -u {name}:{password} -X GET",
29613         "type": "json"
29614       }
29615     ],
29616     "name": "GetOpenchannelAccounts",
29617     "group": "Users",
29618     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29619     "version": "0.0.0",
29620     "filename": "server/api/user/index.js",
29621     "groupTitle": "Users"
29622   },
29623   {
29624     "type": "get",
29625     "url": "/api/users/{id}/openchannel/interactions",
29626     "title": "GetOpenchannelInteractions",
29627     "examples": [
29628       {
29629         "title": "Example usage:",
29630         "content": "curl https://{domain}/api/users/{id}/openchannel/interactions -v -u {name}:{password}",
29631         "type": "json"
29632       }
29633     ],
29634     "name": "GetOpenchannelInteractions",
29635     "group": "Users",
29636     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29637     "version": "0.0.0",
29638     "filename": "server/api/user/index.js",
29639     "groupTitle": "Users"
29640   },
29641   {
29642     "type": "get",
29643     "url": "/api/users/{id}/prefixes",
29644     "title": "GetPrefixes",
29645     "examples": [
29646       {
29647         "title": "Example usage:",
29648         "content": "curl https://{domain}/api/users/{id}/prefixes -v -u {name}:{password} -X GET",
29649         "type": "json"
29650       }
29651     ],
29652     "name": "GetPrefixes",
29653     "group": "Users",
29654     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29655     "version": "0.0.0",
29656     "filename": "server/api/user/index.js",
29657     "groupTitle": "Users"
29658   },
29659   {
29660     "type": "get",
29661     "url": "/api/users/{id}/queues?channel={channel}",
29662     "title": "Gets Queues list",
29663     "examples": [
29664       {
29665         "title": "Example usage:",
29666         "content": "curl https://{domain}/api/users/{id}/queues/?channel={channel} -v -u {name}:{password} -X GET",
29667         "type": "json"
29668       }
29669     ],
29670     "name": "GetQueues",
29671     "group": "Users",
29672     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29673     "version": "0.0.0",
29674     "filename": "server/api/user/index.js",
29675     "groupTitle": "Users"
29676   },
29677   {
29678     "type": "get",
29679     "url": "/api/users/{id}/recordings",
29680     "title": "GetRecordings",
29681     "examples": [
29682       {
29683         "title": "Example usage:",
29684         "content": "curl https://{domain}/api/users/{id}/recordings -v -u {name}:{password} -X GET",
29685         "type": "json"
29686       }
29687     ],
29688     "name": "GetRecordings",
29689     "group": "Users",
29690     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29691     "version": "0.0.0",
29692     "filename": "server/api/user/index.js",
29693     "groupTitle": "Users"
29694   },
29695   {
29696     "type": "get",
29697     "url": "/api/users/{id}/scheduled_calls",
29698     "title": "GetScheduledCalls",
29699     "examples": [
29700       {
29701         "title": "Example usage:",
29702         "content": "curl https://{domain}/api/users/{id}/scheduled_calls -v -u {name}:{password} -X GET",
29703         "type": "json"
29704       }
29705     ],
29706     "name": "GetScheduledCalls",
29707     "group": "Users",
29708     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29709     "version": "0.0.0",
29710     "filename": "server/api/user/index.js",
29711     "groupTitle": "Users"
29712   },
29713   {
29714     "type": "get",
29715     "url": "/api/users/{id}/screen_recordings",
29716     "title": "GetScreenRecordings",
29717     "examples": [
29718       {
29719         "title": "Example usage:",
29720         "content": "curl https://{domain}/api/users/{id}/screen_recordings -v -u {name}:{password} -X GET",
29721         "type": "json"
29722       }
29723     ],
29724     "name": "GetScreenRecordings",
29725     "group": "Users",
29726     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29727     "version": "0.0.0",
29728     "filename": "server/api/user/index.js",
29729     "groupTitle": "Users"
29730   },
29731   {
29732     "type": "get",
29733     "url": "/api/users/{id}/sms_accounts",
29734     "title": "GetSmsAccounts",
29735     "examples": [
29736       {
29737         "title": "Example usage:",
29738         "content": "curl https://{domain}/api/users/{id}/sms_accounts -v -u {name}:{password} -X GET",
29739         "type": "json"
29740       }
29741     ],
29742     "name": "GetSmsAccounts",
29743     "group": "Users",
29744     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29745     "version": "0.0.0",
29746     "filename": "server/api/user/index.js",
29747     "groupTitle": "Users"
29748   },
29749   {
29750     "type": "get",
29751     "url": "/api/users/{id}/sms/interactions",
29752     "title": "GetSmsInteractions",
29753     "examples": [
29754       {
29755         "title": "Example usage:",
29756         "content": "curl https://{domain}/api/users/{id}/sms/interactions -v -u {name}:{password} -X GET",
29757         "type": "json"
29758       }
29759     ],
29760     "name": "GetSmsInteractions",
29761     "group": "Users",
29762     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29763     "version": "0.0.0",
29764     "filename": "server/api/user/index.js",
29765     "groupTitle": "Users"
29766   },
29767   {
29768     "type": "get",
29769     "url": "/api/users/{id}/square_projects",
29770     "title": "GetSquareProjects",
29771     "examples": [
29772       {
29773         "title": "Example usage:",
29774         "content": "curl https://{domain}/api/users/{id}/square_projects -v -u {name}:{password} -X GET",
29775         "type": "json"
29776       }
29777     ],
29778     "name": "GetSquareProjects",
29779     "group": "Users",
29780     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29781     "version": "0.0.0",
29782     "filename": "server/api/user/index.js",
29783     "groupTitle": "Users"
29784   },
29785   {
29786     "type": "get",
29787     "url": "/api/users/{id}/teams",
29788     "title": "GetTeams",
29789     "examples": [
29790       {
29791         "title": "Example usage:",
29792         "content": "curl https://{domain}/api/users/{id}/teams -v -u {name}:{password} -X GET",
29793         "type": "json"
29794       }
29795     ],
29796     "name": "GetTeams",
29797     "group": "Users",
29798     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29799     "version": "0.0.0",
29800     "filename": "server/api/user/index.js",
29801     "groupTitle": "Users"
29802   },
29803   {
29804     "type": "get",
29805     "url": "/api/users",
29806     "title": "Gets a list of Users",
29807     "examples": [
29808       {
29809         "title": "Example usage:",
29810         "content": "curl https://{domain}/api/users -v -u {name}:{password}",
29811         "type": "json"
29812       }
29813     ],
29814     "name": "GetUsers",
29815     "group": "Users",
29816     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
29817     "version": "0.0.0",
29818     "filename": "server/api/user/index.js",
29819     "groupTitle": "Users"
29820   },
29821   {
29822     "type": "get",
29823     "url": "/api/users/{id}/queues_rt",
29824     "title": "GetVoiceQueuesRt",
29825     "examples": [
29826       {
29827         "title": "Example usage:",
29828         "content": "curl https://{domain}/api/users/{id}/queues_rt -v -u {name}:{password} -X GET",
29829         "type": "json"
29830       }
29831     ],
29832     "name": "GetVoiceQueuesRt",
29833     "group": "Users",
29834     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29835     "version": "0.0.0",
29836     "filename": "server/api/user/index.js",
29837     "groupTitle": "Users"
29838   },
29839   {
29840     "type": "get",
29841     "url": "/api/users/{id}/whatsapp_accounts",
29842     "title": "GetWhatsappAccounts",
29843     "examples": [
29844       {
29845         "title": "Example usage:",
29846         "content": "curl https://{domain}/api/users/{id}/whatsapp_accounts -v -u {name}:{password} -X GET",
29847         "type": "json"
29848       }
29849     ],
29850     "name": "GetWhatsappAccounts",
29851     "group": "Users",
29852     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29853     "version": "0.0.0",
29854     "filename": "server/api/user/index.js",
29855     "groupTitle": "Users"
29856   },
29857   {
29858     "type": "get",
29859     "url": "/api/users/{id}/whatsapp/interactions",
29860     "title": "GetWhatsappInteractions",
29861     "examples": [
29862       {
29863         "title": "Example usage:",
29864         "content": "curl https://{domain}/api/users/{id}/whatsapp/interactions -v -u {name}:{password} -X GET",
29865         "type": "json"
29866       }
29867     ],
29868     "name": "GetWhatsappInteractions",
29869     "group": "Users",
29870     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29871     "version": "0.0.0",
29872     "filename": "server/api/user/index.js",
29873     "groupTitle": "Users"
29874   },
29875   {
29876     "type": "post",
29877     "url": "/api/users/{id}/login",
29878     "title": "Login",
29879     "examples": [
29880       {
29881         "title": "Example usage:",
29882         "content": "curl https://{domain}/api/users/{id}/login  -v -u {name}:{password} -X POST",
29883         "type": "json"
29884       }
29885     ],
29886     "name": "Login",
29887     "group": "Users",
29888     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29889     "version": "0.0.0",
29890     "filename": "server/api/user/index.js",
29891     "groupTitle": "Users"
29892   },
29893   {
29894     "type": "post",
29895     "url": "/api/users/{id}/logout",
29896     "title": "Logout",
29897     "examples": [
29898       {
29899         "title": "Example usage:",
29900         "content": "curl https://{domain}/api/users/{id}/logout -v -u {name}:{password} -X POST",
29901         "type": "json"
29902       }
29903     ],
29904     "name": "Logout",
29905     "group": "Users",
29906     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29907     "version": "0.0.0",
29908     "filename": "server/api/user/index.js",
29909     "groupTitle": "Users"
29910   },
29911   {
29912     "type": "post",
29913     "url": "/api/users/{id}/pause",
29914     "title": "Pause",
29915     "examples": [
29916       {
29917         "title": "Example usage:",
29918         "content": "curl https://{domain}/api/users/{id}/pause -v -u {name}:{password} -X POST",
29919         "type": "json"
29920       }
29921     ],
29922     "name": "Pause",
29923     "group": "Users",
29924     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29925     "version": "0.0.0",
29926     "filename": "server/api/user/index.js",
29927     "groupTitle": "Users"
29928   },
29929   {
29930     "type": "delete",
29931     "url": "/api/users/{id}/api_key",
29932     "title": "Remove API access key for the user",
29933     "examples": [
29934       {
29935         "title": "Example usage:",
29936         "content": "curl https://{domain}/api/users/:id/api_key -v -u {name}:{password} -X DELETE",
29937         "type": "json"
29938       }
29939     ],
29940     "name": "RemoveApiKey",
29941     "group": "Users",
29942     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29943     "version": "0.0.0",
29944     "filename": "server/api/user/index.js",
29945     "groupTitle": "Users"
29946   },
29947   {
29948     "type": "delete",
29949     "url": "/api/users/{id}/chat_interactions",
29950     "title": "Removes interactions from an agent",
29951     "examples": [
29952       {
29953         "title": "Example usage:",
29954         "content": "curl https://{domain}/api/users/{id}/chat_interactions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29955         "type": "json"
29956       }
29957     ],
29958     "name": "RemoveChatInteractions",
29959     "group": "Users",
29960     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29961     "version": "0.0.0",
29962     "filename": "server/api/user/index.js",
29963     "groupTitle": "Users"
29964   },
29965   {
29966     "type": "delete",
29967     "url": "/api/users/{id}/chat_websites",
29968     "title": "Removes a Chat Website from a user",
29969     "examples": [
29970       {
29971         "title": "Example usage:",
29972         "content": "curl https://{domain}/api/users/{id}/chat_websites?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29973         "type": "json"
29974       }
29975     ],
29976     "name": "RemoveChatWebsites",
29977     "group": "Users",
29978     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29979     "version": "0.0.0",
29980     "filename": "server/api/user/index.js",
29981     "groupTitle": "Users"
29982   },
29983   {
29984     "type": "delete",
29985     "url": "/api/users/{id}/fax_accounts",
29986     "title": "Removes a Fax Account from a user",
29987     "examples": [
29988       {
29989         "title": "Example usage:",
29990         "content": "curl https://{domain}/api/users/{id}/fax_accounts?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29991         "type": "json"
29992       }
29993     ],
29994     "name": "RemoveFaxAccounts",
29995     "group": "Users",
29996     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29997     "version": "0.0.0",
29998     "filename": "server/api/user/index.js",
29999     "groupTitle": "Users"
30000   },
30001   {
30002     "type": "delete",
30003     "url": "/api/users/{id}/fax_interactions",
30004     "title": "Removes interactions from an agent",
30005     "examples": [
30006       {
30007         "title": "Example usage:",
30008         "content": "curl https://{domain}/api/users/{id}/fax_interactions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
30009         "type": "json"
30010       }
30011     ],
30012     "name": "RemoveFaxInteractions",
30013     "group": "Users",
30014     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30015     "version": "0.0.0",
30016     "filename": "server/api/user/index.js",
30017     "groupTitle": "Users"
30018   },
30019   {
30020     "type": "delete",
30021     "url": "/api/users/{id}/mail_accounts",
30022     "title": "Removes a Mail Account from a user",
30023     "examples": [
30024       {
30025         "title": "Example usage:",
30026         "content": "curl https://{domain}/api/users/{id}/mail_accounts?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
30027         "type": "json"
30028       }
30029     ],
30030     "name": "RemoveMailAccounts",
30031     "group": "Users",
30032     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30033     "version": "0.0.0",
30034     "filename": "server/api/user/index.js",
30035     "groupTitle": "Users"
30036   },
30037   {
30038     "type": "delete",
30039     "url": "/api/users/{id}/mail_interactions",
30040     "title": "Removes interactions from an agent",
30041     "examples": [
30042       {
30043         "title": "Example usage:",
30044         "content": "curl https://{domain}/api/users/{id}/mail_interactions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
30045         "type": "json"
30046       }
30047     ],
30048     "name": "RemoveMailInteractions",
30049     "group": "Users",
30050     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30051     "version": "0.0.0",
30052     "filename": "server/api/user/index.js",
30053     "groupTitle": "Users"
30054   },
30055   {
30056     "type": "delete",
30057     "url": "/api/users/{id}/openchannel_accounts",
30058     "title": "Removes a Open Channel Account from a user",
30059     "examples": [
30060       {
30061         "title": "Example usage:",
30062         "content": "curl https://{domain}/api/users/{id}/openchannel_accounts?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
30063         "type": "json"
30064       }
30065     ],
30066     "name": "RemoveOpenchannelAccounts",
30067     "group": "Users",
30068     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30069     "version": "0.0.0",
30070     "filename": "server/api/user/index.js",
30071     "groupTitle": "Users"
30072   },
30073   {
30074     "type": "delete",
30075     "url": "/api/users/{id}/openchannel_interactions",
30076     "title": "Removes openchannel interactions from an agent",
30077     "examples": [
30078       {
30079         "title": "Example usage:",
30080         "content": "curl https://{domain}/api/users/{id}/openchannel_interactions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
30081         "type": "json"
30082       }
30083     ],
30084     "name": "RemoveOpenchannelInteractions",
30085     "group": "Users",
30086     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30087     "version": "0.0.0",
30088     "filename": "server/api/user/index.js",
30089     "groupTitle": "Users"
30090   },
30091   {
30092     "type": "delete",
30093     "url": "/api/users/{id}/queues",
30094     "title": "Remove queues to an agent",
30095     "examples": [
30096       {
30097         "title": "Example usage:",
30098         "content": "curl https://{domain}/api/users/{id}/queues?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
30099         "type": "json"
30100       }
30101     ],
30102     "name": "RemoveQueues",
30103     "group": "Users",
30104     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30105     "version": "0.0.0",
30106     "filename": "server/api/user/index.js",
30107     "groupTitle": "Users"
30108   },
30109   {
30110     "type": "delete",
30111     "url": "/api/users/{id}/sms_accounts",
30112     "title": "Removes a Sms Account from a user",
30113     "examples": [
30114       {
30115         "title": "Example usage:",
30116         "content": "curl https://{domain}/api/users/{id}/sms_accounts?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
30117         "type": "json"
30118       }
30119     ],
30120     "name": "RemoveSmsAccounts",
30121     "group": "Users",
30122     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30123     "version": "0.0.0",
30124     "filename": "server/api/user/index.js",
30125     "groupTitle": "Users"
30126   },
30127   {
30128     "type": "delete",
30129     "url": "/api/users/{id}/sms_interactions",
30130     "title": "Removes interactions from an agent",
30131     "examples": [
30132       {
30133         "title": "Example usage:",
30134         "content": "curl https://{domain}/api/users/{id}/sms_interactions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
30135         "type": "json"
30136       }
30137     ],
30138     "name": "RemoveSmsInteractions",
30139     "group": "Users",
30140     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30141     "version": "0.0.0",
30142     "filename": "server/api/user/index.js",
30143     "groupTitle": "Users"
30144   },
30145   {
30146     "type": "delete",
30147     "url": "/api/users/{id}/square_projects",
30148     "title": "Removes a Square Project from a user",
30149     "examples": [
30150       {
30151         "title": "Example usage:",
30152         "content": "curl https://{domain}/api/users/{id}/square_projects?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
30153         "type": "json"
30154       }
30155     ],
30156     "name": "RemoveSquareProjects",
30157     "group": "Users",
30158     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30159     "version": "0.0.0",
30160     "filename": "server/api/user/index.js",
30161     "groupTitle": "Users"
30162   },
30163   {
30164     "type": "delete",
30165     "url": "/api/users/{id}/teams",
30166     "title": "Removes teams from an agent",
30167     "examples": [
30168       {
30169         "title": "Example usage:",
30170         "content": "curl https://{domain}/api/users/{id}/teams?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
30171         "type": "json"
30172       }
30173     ],
30174     "name": "RemoveTeams",
30175     "group": "Users",
30176     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30177     "version": "0.0.0",
30178     "filename": "server/api/user/index.js",
30179     "groupTitle": "Users"
30180   },
30181   {
30182     "type": "delete",
30183     "url": "/api/users/{id}/whatsapp_accounts",
30184     "title": "Removes a Whatsapp Account from a user",
30185     "examples": [
30186       {
30187         "title": "Example usage:",
30188         "content": "curl https://{domain}/api/users/{id}/whatsapp_accounts?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
30189         "type": "json"
30190       }
30191     ],
30192     "name": "RemoveWhatsappAccounts",
30193     "group": "Users",
30194     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30195     "version": "0.0.0",
30196     "filename": "server/api/user/index.js",
30197     "groupTitle": "Users"
30198   },
30199   {
30200     "type": "delete",
30201     "url": "/api/users/{id}/whatsapp_interactions",
30202     "title": "Removes Whatsapp interactions from an agent",
30203     "examples": [
30204       {
30205         "title": "Example usage:",
30206         "content": "curl https://{domain}/api/users/{id}/whatsapp_interactions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
30207         "type": "json"
30208       }
30209     ],
30210     "name": "RemoveWhatsappInteractions",
30211     "group": "Users",
30212     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30213     "version": "0.0.0",
30214     "filename": "server/api/user/index.js",
30215     "groupTitle": "Users"
30216   },
30217   {
30218     "type": "get",
30219     "url": "/api/users/{id}",
30220     "title": "Gets a single User",
30221     "examples": [
30222       {
30223         "title": "Example usage:",
30224         "content": "curl https://{domain}/api/users/{id} -v -u {name}:{password}",
30225         "type": "json"
30226       }
30227     ],
30228     "name": "ShowUsers",
30229     "group": "Users",
30230     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30231     "version": "0.0.0",
30232     "filename": "server/api/user/index.js",
30233     "groupTitle": "Users"
30234   },
30235   {
30236     "type": "post",
30237     "url": "/api/users/{id}/unpause",
30238     "title": "Unpause",
30239     "examples": [
30240       {
30241         "title": "Example usage:",
30242         "content": "curl https://{domain}/api/users/{id}/unpause -v -u {name}:{password} -X POST",
30243         "type": "json"
30244       }
30245     ],
30246     "name": "Unpause",
30247     "group": "Users",
30248     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30249     "version": "0.0.0",
30250     "filename": "server/api/user/index.js",
30251     "groupTitle": "Users"
30252   },
30253   {
30254     "type": "get",
30255     "url": "/api/users/whoami",
30256     "title": "WhoAmI",
30257     "examples": [
30258       {
30259         "title": "Example usage:",
30260         "content": "curl https://{domain}/api/users/whoami -v -u {name}:{password} -X GET",
30261         "type": "json"
30262       }
30263     ],
30264     "name": "WhoAmI",
30265     "group": "Users",
30266     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30267     "version": "0.0.0",
30268     "filename": "server/api/user/index.js",
30269     "groupTitle": "Users"
30270   },
30271   {
30272     "type": "post",
30273     "url": "/api/users/{id}/avatar",
30274     "title": "Add avatar",
30275     "examples": [
30276       {
30277         "title": "Example usage:",
30278         "content": "curl https://{domain}/api/users/{id}/avatar -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
30279         "type": "json"
30280       }
30281     ],
30282     "name": "addAvatar",
30283     "group": "Users",
30284     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30285     "version": "0.0.0",
30286     "filename": "server/api/user/index.js",
30287     "groupTitle": "Users"
30288   },
30289   {
30290     "type": "post",
30291     "url": "/api/users/create_many",
30292     "title": "Create Users",
30293     "examples": [
30294       {
30295         "title": "Example usage:",
30296         "content": "curl https://{domain}/api/users/create_many -d '[{\"name\": \"john.doe\", \"role\": \"user\", \"...\": \"...\"}]' -v -u {name}:{password} -X POST",
30297         "type": "json"
30298       }
30299     ],
30300     "name": "bulkCreate",
30301     "group": "Users",
30302     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30303     "version": "0.0.0",
30304     "filename": "server/api/user/index.js",
30305     "groupTitle": "Users"
30306   },
30307   {
30308     "type": "get",
30309     "url": "/api/users/{id}/avatar",
30310     "title": "Get avatar",
30311     "examples": [
30312       {
30313         "title": "Example usage:",
30314         "content": "curl https://{domain}/api/users/{id}/avatar -v -u {name}:{password} -X GET",
30315         "type": "json"
30316       }
30317     ],
30318     "name": "getAvatar",
30319     "group": "Users",
30320     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30321     "version": "0.0.0",
30322     "filename": "server/api/user/index.js",
30323     "groupTitle": "Users"
30324   },
30325   {
30326     "type": "get",
30327     "url": "/api/users/{id}/open_tabs",
30328     "title": "Get interactions opened tabs",
30329     "examples": [
30330       {
30331         "title": "Example usage:",
30332         "content": "curl https://{domain}/api/users/{id}/open_tabs -v -u {name}:{password} -X GET",
30333         "type": "json"
30334       }
30335     ],
30336     "name": "getOpenTabs",
30337     "group": "Users",
30338     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30339     "version": "0.0.0",
30340     "filename": "server/api/user/index.js",
30341     "groupTitle": "Users"
30342   },
30343   {
30344     "type": "get",
30345     "url": "/api/users/presence",
30346     "title": "Gets agent presence",
30347     "examples": [
30348       {
30349         "title": "Example usage:",
30350         "content": "curl https://{domain}/api/users/presence -v -u {name}:{password}  -X GET",
30351         "type": "json"
30352       }
30353     ],
30354     "name": "getPresence",
30355     "group": "Users",
30356     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30357     "version": "0.0.0",
30358     "filename": "server/api/user/index.js",
30359     "groupTitle": "Users"
30360   },
30361   {
30362     "type": "put",
30363     "url": "/api/users/{id}",
30364     "title": "Update an existing User",
30365     "examples": [
30366       {
30367         "title": "Example usage:",
30368         "content": "curl https://{domain}/api/users/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
30369         "type": "json"
30370       }
30371     ],
30372     "name": "updateUsers",
30373     "group": "Users",
30374     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30375     "version": "0.0.0",
30376     "filename": "server/api/user/index.js",
30377     "groupTitle": "Users"
30378   },
30379   {
30380     "type": "post",
30381     "url": "/api/variables",
30382     "title": "Creates a new Variable",
30383     "examples": [
30384       {
30385         "title": "Example usage:",
30386         "content": "curl https://{domain}/api/variables -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
30387         "type": "json"
30388       }
30389     ],
30390     "name": "CreateVariables",
30391     "group": "Variables",
30392     "parameter": {
30393       "fields": {
30394         "Body": [
30395           {
30396             "group": "Body",
30397             "type": "String",
30398             "optional": false,
30399             "field": "name",
30400             "description": ""
30401           },
30402           {
30403             "group": "Body",
30404             "type": "String",
30405             "optional": true,
30406             "field": "description",
30407             "description": ""
30408           }
30409         ]
30410       }
30411     },
30412     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30413     "version": "0.0.0",
30414     "filename": "server/api/variable/index.js",
30415     "groupTitle": "Variables"
30416   },
30417   {
30418     "type": "delete",
30419     "url": "/api/variables/{id}",
30420     "title": "Deletes a Variable",
30421     "examples": [
30422       {
30423         "title": "Example usage:",
30424         "content": "curl https://{domain}/api/variables/{id} -v -u {name}:{password} -X DELETE",
30425         "type": "json"
30426       }
30427     ],
30428     "name": "DeleteVariables",
30429     "group": "Variables",
30430     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30431     "version": "0.0.0",
30432     "filename": "server/api/variable/index.js",
30433     "groupTitle": "Variables"
30434   },
30435   {
30436     "type": "get",
30437     "url": "/api/variables",
30438     "title": "Gets a list of Variables",
30439     "examples": [
30440       {
30441         "title": "Example usage:",
30442         "content": "curl https://{domain}/api/variables -v -u {name}:{password}",
30443         "type": "json"
30444       }
30445     ],
30446     "name": "GetVariables",
30447     "group": "Variables",
30448     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
30449     "version": "0.0.0",
30450     "filename": "server/api/variable/index.js",
30451     "groupTitle": "Variables"
30452   },
30453   {
30454     "type": "get",
30455     "url": "/api/variables/{id}",
30456     "title": "Gets a single Variable",
30457     "examples": [
30458       {
30459         "title": "Example usage:",
30460         "content": "curl https://{domain}/api/variables/{id} -v -u {name}:{password}",
30461         "type": "json"
30462       }
30463     ],
30464     "name": "ShowVariables",
30465     "group": "Variables",
30466     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30467     "version": "0.0.0",
30468     "filename": "server/api/variable/index.js",
30469     "groupTitle": "Variables"
30470   },
30471   {
30472     "type": "put",
30473     "url": "/api/variables/{id}",
30474     "title": "Update an existing Variable",
30475     "examples": [
30476       {
30477         "title": "Example usage:",
30478         "content": "curl https://{domain}/api/variables/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
30479         "type": "json"
30480       }
30481     ],
30482     "name": "updateVariables",
30483     "group": "Variables",
30484     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30485     "version": "0.0.0",
30486     "filename": "server/api/variable/index.js",
30487     "groupTitle": "Variables"
30488   },
30489   {
30490     "type": "get",
30491     "url": "/api/version/fetch",
30492     "title": "Fetch git version",
30493     "examples": [
30494       {
30495         "title": "Example usage:",
30496         "content": "curl https://{domain}/api/version/fetch -v -u {name}:{password}",
30497         "type": "json"
30498       }
30499     ],
30500     "name": "FetchVersion",
30501     "group": "Version",
30502     "description": "<p>Motion run the following command: git fetch origin master</p>",
30503     "version": "0.0.0",
30504     "filename": "server/api/version/index.js",
30505     "groupTitle": "Version"
30506   },
30507   {
30508     "type": "get",
30509     "url": "/api/version",
30510     "title": "Gets version",
30511     "examples": [
30512       {
30513         "title": "Example usage:",
30514         "content": "curl https://{domain}/api/version -v -u {name}:{password}",
30515         "type": "json"
30516       }
30517     ],
30518     "name": "GetVersion",
30519     "group": "Version",
30520     "description": "<p>Motion returns the current and latest motion version.</p>",
30521     "version": "0.0.0",
30522     "filename": "server/api/version/index.js",
30523     "groupTitle": "Version"
30524   },
30525   {
30526     "type": "get",
30527     "url": "/api/version/migrations",
30528     "title": "Launch database migrations",
30529     "examples": [
30530       {
30531         "title": "Example usage:",
30532         "content": "curl https://{domain}/api/version/migrations -v -u {name}:{password}",
30533         "type": "json"
30534       }
30535     ],
30536     "name": "MigrateVersion",
30537     "group": "Version",
30538     "description": "<p>Motion launch the database migrations, according to the application version</p>",
30539     "version": "0.0.0",
30540     "filename": "server/api/version/index.js",
30541     "groupTitle": "Version"
30542   },
30543   {
30544     "type": "get",
30545     "url": "/api/version/pull",
30546     "title": "Pull git version",
30547     "examples": [
30548       {
30549         "title": "Example usage:",
30550         "content": "curl https://{domain}/api/version/pull -v -u {name}:{password}",
30551         "type": "json"
30552       }
30553     ],
30554     "name": "PullVersion",
30555     "group": "Version",
30556     "description": "<p>Motion run the following command: git pull</p>",
30557     "version": "0.0.0",
30558     "filename": "server/api/version/index.js",
30559     "groupTitle": "Version"
30560   },
30561   {
30562     "type": "get",
30563     "url": "/api/version/reset",
30564     "title": "Reset git version",
30565     "examples": [
30566       {
30567         "title": "Example usage:",
30568         "content": "curl https://{domain}/api/version/reset -v -u {name}:{password}",
30569         "type": "json"
30570       }
30571     ],
30572     "name": "ResetVersion",
30573     "group": "Version",
30574     "description": "<p>Motion run the following command: git reset --hard FETCH_HEAD</p>",
30575     "version": "0.0.0",
30576     "filename": "server/api/version/index.js",
30577     "groupTitle": "Version"
30578   },
30579   {
30580     "type": "get",
30581     "url": "/api/version/restart",
30582     "title": "Restart motion2 after update",
30583     "examples": [
30584       {
30585         "title": "Example usage:",
30586         "content": "curl https://{domain}/api/version/restart -v -u {name}:{password}",
30587         "type": "json"
30588       }
30589     ],
30590     "name": "RestartVersion",
30591     "group": "Version",
30592     "description": "<p>Motion run the following command: pm2 restart motion</p>",
30593     "version": "0.0.0",
30594     "filename": "server/api/version/index.js",
30595     "groupTitle": "Version"
30596   },
30597   {
30598     "type": "get",
30599     "url": "/api/voice/agents/reports/describe",
30600     "title": "Gets table info about Agent Reports",
30601     "examples": [
30602       {
30603         "title": "Example usage:",
30604         "content": "curl https://{domain}/api/voice/agents/reports/describe -v -u {name}:{password}",
30605         "type": "json"
30606       }
30607     ],
30608     "name": "DescribeAgent_Reports",
30609     "group": "Voice_Agent_Reports",
30610     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30611     "version": "0.0.0",
30612     "filename": "server/api/voiceAgentReport/index.js",
30613     "groupTitle": "Voice_Agent_Reports"
30614   },
30615   {
30616     "type": "get",
30617     "url": "/api/voice/agents/reports",
30618     "title": "Gets a list of Agent Reports",
30619     "examples": [
30620       {
30621         "title": "Example usage:",
30622         "content": "curl https://{domain}/api/voice/agents/reports -v -u {name}:{password}",
30623         "type": "json"
30624       }
30625     ],
30626     "name": "GetAgent_Reports",
30627     "group": "Voice_Agent_Reports",
30628     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
30629     "version": "0.0.0",
30630     "filename": "server/api/voiceAgentReport/index.js",
30631     "groupTitle": "Voice_Agent_Reports"
30632   },
30633   {
30634     "type": "get",
30635     "url": "/api/voice/agents/reports/{id}",
30636     "title": "Gets a single Agent Report",
30637     "examples": [
30638       {
30639         "title": "Example usage:",
30640         "content": "curl https://{domain}/api/voice/agents/reports/{id} -v -u {name}:{password}",
30641         "type": "json"
30642       }
30643     ],
30644     "name": "ShowAgent_Reports",
30645     "group": "Voice_Agent_Reports",
30646     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30647     "version": "0.0.0",
30648     "filename": "server/api/voiceAgentReport/index.js",
30649     "groupTitle": "Voice_Agent_Reports"
30650   },
30651   {
30652     "type": "get",
30653     "url": "/api/voice/calls/reports/describe",
30654     "title": "Gets table info about Call Reports",
30655     "examples": [
30656       {
30657         "title": "Example usage:",
30658         "content": "curl https://{domain}/api/voice/calls/reports/describe -v -u {name}:{password}",
30659         "type": "json"
30660       }
30661     ],
30662     "name": "DescribeCall_Reports",
30663     "group": "Voice_Call_Reports",
30664     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30665     "version": "0.0.0",
30666     "filename": "server/api/voiceCallReport/index.js",
30667     "groupTitle": "Voice_Call_Reports"
30668   },
30669   {
30670     "type": "get",
30671     "url": "/api/voice/calls/reports",
30672     "title": "Gets a list of Call Reports",
30673     "examples": [
30674       {
30675         "title": "Example usage:",
30676         "content": "curl https://{domain}/api/voice/calls/reports -v -u {name}:{password}",
30677         "type": "json"
30678       }
30679     ],
30680     "name": "GetCall_Reports",
30681     "group": "Voice_Call_Reports",
30682     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
30683     "version": "0.0.0",
30684     "filename": "server/api/voiceCallReport/index.js",
30685     "groupTitle": "Voice_Call_Reports"
30686   },
30687   {
30688     "type": "get",
30689     "url": "/api/voice/calls/reports/{id}",
30690     "title": "Gets a single Call Report",
30691     "examples": [
30692       {
30693         "title": "Example usage:",
30694         "content": "curl https://{domain}/api/voice/calls/reports/{id} -v -u {name}:{password}",
30695         "type": "json"
30696       }
30697     ],
30698     "name": "ShowCall_Reports",
30699     "group": "Voice_Call_Reports",
30700     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30701     "version": "0.0.0",
30702     "filename": "server/api/voiceCallReport/index.js",
30703     "groupTitle": "Voice_Call_Reports"
30704   },
30705   {
30706     "type": "put",
30707     "url": "/api/voice/calls/reports/{id}",
30708     "title": "Update a single cdr",
30709     "examples": [
30710       {
30711         "title": "Example usage:",
30712         "content": "curl https://{domain}/api/voice/calls/reports/{id} -d '{\"userDispositio\": \"OK\"}' -v -u {name}:{password} -X PUT",
30713         "type": "json"
30714       }
30715     ],
30716     "name": "update",
30717     "group": "Voice_Call_Reports",
30718     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30719     "version": "0.0.0",
30720     "filename": "server/api/voiceCallReport/index.js",
30721     "groupTitle": "Voice_Call_Reports"
30722   },
30723   {
30724     "type": "post",
30725     "url": "/api/voice/chanspy",
30726     "title": "Creates a new ChanSpy",
30727     "examples": [
30728       {
30729         "title": "Example usage:",
30730         "content": "curl https://{domain}/api/voice/chanspy -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
30731         "type": "json"
30732       }
30733     ],
30734     "name": "CreateChanSpy",
30735     "group": "Voice_ChanSpy",
30736     "parameter": {
30737       "fields": {
30738         "Body": [
30739           {
30740             "group": "Body",
30741             "type": "String",
30742             "optional": true,
30743             "field": "name",
30744             "description": ""
30745           },
30746           {
30747             "group": "Body",
30748             "type": "String",
30749             "optional": false,
30750             "field": "prefix",
30751             "description": ""
30752           },
30753           {
30754             "group": "Body",
30755             "type": "String",
30756             "optional": true,
30757             "field": "options",
30758             "description": ""
30759           },
30760           {
30761             "group": "Body",
30762             "type": "Boolean",
30763             "optional": true,
30764             "field": "auth",
30765             "description": ""
30766           },
30767           {
30768             "group": "Body",
30769             "type": "String",
30770             "optional": true,
30771             "field": "password",
30772             "description": ""
30773           },
30774           {
30775             "group": "Body",
30776             "type": "Boolean",
30777             "optional": true,
30778             "field": "record",
30779             "description": ""
30780           },
30781           {
30782             "group": "Body",
30783             "type": "String",
30784             "optional": true,
30785             "field": "recordingFormat",
30786             "description": ""
30787           },
30788           {
30789             "group": "Body",
30790             "type": "String",
30791             "optional": true,
30792             "field": "description",
30793             "description": ""
30794           }
30795         ]
30796       }
30797     },
30798     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30799     "version": "0.0.0",
30800     "filename": "server/api/voiceChanSpy/index.js",
30801     "groupTitle": "Voice_ChanSpy"
30802   },
30803   {
30804     "type": "delete",
30805     "url": "/api/voice/chanspy/{id}",
30806     "title": "Deletes a ChanSpy",
30807     "examples": [
30808       {
30809         "title": "Example usage:",
30810         "content": "curl https://{domain}/api/voice/chanspy/{id} -v -u {name}:{password} -X DELETE",
30811         "type": "json"
30812       }
30813     ],
30814     "name": "DeleteChanSpy",
30815     "group": "Voice_ChanSpy",
30816     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30817     "version": "0.0.0",
30818     "filename": "server/api/voiceChanSpy/index.js",
30819     "groupTitle": "Voice_ChanSpy"
30820   },
30821   {
30822     "type": "get",
30823     "url": "/api/voice/chanspy",
30824     "title": "Gets a list of ChanSpy",
30825     "examples": [
30826       {
30827         "title": "Example usage:",
30828         "content": "curl https://{domain}/api/voice/chanspy -v -u {name}:{password}",
30829         "type": "json"
30830       }
30831     ],
30832     "name": "GetChanSpy",
30833     "group": "Voice_ChanSpy",
30834     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
30835     "version": "0.0.0",
30836     "filename": "server/api/voiceChanSpy/index.js",
30837     "groupTitle": "Voice_ChanSpy"
30838   },
30839   {
30840     "type": "get",
30841     "url": "/api/voice/chanspy/{id}",
30842     "title": "Gets a single ChanSpy",
30843     "examples": [
30844       {
30845         "title": "Example usage:",
30846         "content": "curl https://{domain}/api/voice/chanspy/{id} -v -u {name}:{password}",
30847         "type": "json"
30848       }
30849     ],
30850     "name": "ShowChanSpy",
30851     "group": "Voice_ChanSpy",
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/voiceChanSpy/index.js",
30855     "groupTitle": "Voice_ChanSpy"
30856   },
30857   {
30858     "type": "put",
30859     "url": "/api/voice/chanspy/{id}",
30860     "title": "Update an existing ChanSpy",
30861     "examples": [
30862       {
30863         "title": "Example usage:",
30864         "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",
30865         "type": "json"
30866       }
30867     ],
30868     "name": "updateChanSpy",
30869     "group": "Voice_ChanSpy",
30870     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30871     "version": "0.0.0",
30872     "filename": "server/api/voiceChanSpy/index.js",
30873     "groupTitle": "Voice_ChanSpy"
30874   },
30875   {
30876     "type": "post",
30877     "url": "/api/voice/contexts",
30878     "title": "Create a new context",
30879     "examples": [
30880       {
30881         "title": "Example usage:",
30882         "content": "curl https://{domain}/api/voice/contexts -v -u {name}:{password} -X POST",
30883         "type": "json"
30884       }
30885     ],
30886     "name": "Create",
30887     "group": "Voice_Contexts",
30888     "parameter": {
30889       "fields": {
30890         "Body": [
30891           {
30892             "group": "Body",
30893             "type": "String",
30894             "optional": true,
30895             "field": "name",
30896             "description": ""
30897           },
30898           {
30899             "group": "Body",
30900             "type": "String",
30901             "optional": true,
30902             "field": "description",
30903             "description": ""
30904           },
30905           {
30906             "group": "Body",
30907             "type": "Boolean",
30908             "optional": true,
30909             "field": "defaultEntry",
30910             "description": ""
30911           }
30912         ]
30913       }
30914     },
30915     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30916     "version": "0.0.0",
30917     "filename": "server/api/voiceContext/index.js",
30918     "groupTitle": "Voice_Contexts"
30919   },
30920   {
30921     "type": "delete",
30922     "url": "/api/voice/contexts/{id}",
30923     "title": "Deletes a context",
30924     "examples": [
30925       {
30926         "title": "Example usage:",
30927         "content": "curl https://{domain}/api/voice/contexts/{id} -v -u {name}:{password} -X DELETE",
30928         "type": "json"
30929       }
30930     ],
30931     "name": "Delete",
30932     "group": "Voice_Contexts",
30933     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30934     "version": "0.0.0",
30935     "filename": "server/api/voiceContext/index.js",
30936     "groupTitle": "Voice_Contexts"
30937   },
30938   {
30939     "type": "get",
30940     "url": "/api/voice/contexts",
30941     "title": "Gets a list of Contexts",
30942     "examples": [
30943       {
30944         "title": "Example usage:",
30945         "content": "curl https://{domain}/api/voice/contexts -v -u {name}:{password}",
30946         "type": "json"
30947       }
30948     ],
30949     "name": "GetContexts",
30950     "group": "Voice_Contexts",
30951     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
30952     "version": "0.0.0",
30953     "filename": "server/api/voiceContext/index.js",
30954     "groupTitle": "Voice_Contexts"
30955   },
30956   {
30957     "type": "get",
30958     "url": "/api/voice/contexts/{id}",
30959     "title": "Gets a single Context",
30960     "examples": [
30961       {
30962         "title": "Example usage:",
30963         "content": "curl https://{domain}/api/voice/contexts/{id} -v -u {name}:{password}",
30964         "type": "json"
30965       }
30966     ],
30967     "name": "ShowContexts",
30968     "group": "Voice_Contexts",
30969     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30970     "version": "0.0.0",
30971     "filename": "server/api/voiceContext/index.js",
30972     "groupTitle": "Voice_Contexts"
30973   },
30974   {
30975     "type": "put",
30976     "url": "/api/voice/contexts/{id}",
30977     "title": "Update an existing context",
30978     "examples": [
30979       {
30980         "title": "Example usage:",
30981         "content": "curl https://{domain}/api/voice/contexts/{id} -v -u {name}:{password} -X PUT",
30982         "type": "json"
30983       }
30984     ],
30985     "name": "Update",
30986     "group": "Voice_Contexts",
30987     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30988     "version": "0.0.0",
30989     "filename": "server/api/voiceContext/index.js",
30990     "groupTitle": "Voice_Contexts"
30991   },
30992   {
30993     "type": "get",
30994     "url": "/api/voice/dials/reports/describe",
30995     "title": "Gets table info about Dial Reports",
30996     "examples": [
30997       {
30998         "title": "Example usage:",
30999         "content": "curl https://{domain}/api/voice/dials/reports/describe -v -u {name}:{password}",
31000         "type": "json"
31001       }
31002     ],
31003     "name": "DescribeDial_Reports",
31004     "group": "Voice_Dial_Reports",
31005     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31006     "version": "0.0.0",
31007     "filename": "server/api/voiceDialReport/index.js",
31008     "groupTitle": "Voice_Dial_Reports"
31009   },
31010   {
31011     "type": "get",
31012     "url": "/api/voice/dials/reports",
31013     "title": "Gets a list of Dial Reports",
31014     "examples": [
31015       {
31016         "title": "Example usage:",
31017         "content": "curl https://{domain}/api/voice/dials/reports -v -u {name}:{password}",
31018         "type": "json"
31019       }
31020     ],
31021     "name": "GetDial_Reports",
31022     "group": "Voice_Dial_Reports",
31023     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
31024     "version": "0.0.0",
31025     "filename": "server/api/voiceDialReport/index.js",
31026     "groupTitle": "Voice_Dial_Reports"
31027   },
31028   {
31029     "type": "get",
31030     "url": "/api/voice/dials/reports/{id}",
31031     "title": "Gets a single Dial Report",
31032     "examples": [
31033       {
31034         "title": "Example usage:",
31035         "content": "curl https://{domain}/api/voice/dials/reports/{id} -v -u {name}:{password}",
31036         "type": "json"
31037       }
31038     ],
31039     "name": "ShowDial_Reports",
31040     "group": "Voice_Dial_Reports",
31041     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31042     "version": "0.0.0",
31043     "filename": "server/api/voiceDialReport/index.js",
31044     "groupTitle": "Voice_Dial_Reports"
31045   },
31046   {
31047     "type": "delete",
31048     "url": "/api/voice/extensions/{id}",
31049     "title": "Deletes a Extension",
31050     "examples": [
31051       {
31052         "title": "Example usage:",
31053         "content": "curl https://{domain}/api/voice/extensions/{id} -v -u {name}:{password} -X DELETE",
31054         "type": "json"
31055       }
31056     ],
31057     "name": "DeleteExtensions",
31058     "group": "Voice_Extensions",
31059     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31060     "version": "0.0.0",
31061     "filename": "server/api/voiceExtension/index.js",
31062     "groupTitle": "Voice_Extensions"
31063   },
31064   {
31065     "type": "get",
31066     "url": "/api/voice/extensions",
31067     "title": "Gets a list of Extensions",
31068     "examples": [
31069       {
31070         "title": "Example usage:",
31071         "content": "curl https://{domain}/api/voice/extensions -v -u {name}:{password}",
31072         "type": "json"
31073       }
31074     ],
31075     "name": "GetExtensions",
31076     "group": "Voice_Extensions",
31077     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
31078     "version": "0.0.0",
31079     "filename": "server/api/voiceExtension/index.js",
31080     "groupTitle": "Voice_Extensions"
31081   },
31082   {
31083     "type": "get",
31084     "url": "/api/voice/extensions/{id}",
31085     "title": "Gets a single Extension",
31086     "examples": [
31087       {
31088         "title": "Example usage:",
31089         "content": "curl https://{domain}/api/voice/extensions/{id} -v -u {name}:{password}",
31090         "type": "json"
31091       }
31092     ],
31093     "name": "ShowExtensions",
31094     "group": "Voice_Extensions",
31095     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31096     "version": "0.0.0",
31097     "filename": "server/api/voiceExtension/index.js",
31098     "groupTitle": "Voice_Extensions"
31099   },
31100   {
31101     "type": "post",
31102     "url": "/api/voice/extensions",
31103     "title": "Create new applications",
31104     "examples": [
31105       {
31106         "title": "Example usage:",
31107         "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",
31108         "type": "json"
31109       }
31110     ],
31111     "name": "addApplications",
31112     "group": "Voice_Extensions",
31113     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31114     "version": "0.0.0",
31115     "filename": "server/api/voiceExtension/index.js",
31116     "groupTitle": "Voice_Extensions"
31117   },
31118   {
31119     "type": "post",
31120     "url": "/api/voice/extensions",
31121     "title": "Create an extension",
31122     "examples": [
31123       {
31124         "title": "Example usage:",
31125         "content": "curl https://{domain}/api/voice/extensions -d '{\"exten\": \"12345\", \"context\": \"from-custom\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
31126         "type": "json"
31127       }
31128     ],
31129     "name": "create",
31130     "group": "Voice_Extensions",
31131     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31132     "version": "0.0.0",
31133     "filename": "server/api/voiceExtension/index.js",
31134     "groupTitle": "Voice_Extensions"
31135   },
31136   {
31137     "type": "put",
31138     "url": "/api/voice/extensions/{id}",
31139     "title": "Update an extension",
31140     "examples": [
31141       {
31142         "title": "Example usage:",
31143         "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",
31144         "type": "json"
31145       }
31146     ],
31147     "name": "update",
31148     "group": "Voice_Extensions",
31149     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31150     "version": "0.0.0",
31151     "filename": "server/api/voiceExtension/index.js",
31152     "groupTitle": "Voice_Extensions"
31153   },
31154   {
31155     "type": "post",
31156     "url": "/api/voice/mohs",
31157     "title": "Create a new a new MOH",
31158     "examples": [
31159       {
31160         "title": "Example usage:",
31161         "content": "curl https://{domain}/api/voice/mohs -d '{\"name\": \"xmas_musics\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
31162         "type": "json"
31163       }
31164     ],
31165     "name": "AddMoh",
31166     "group": "Voice_MOHs",
31167     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31168     "version": "0.0.0",
31169     "filename": "server/api/voiceMusicOnHold/index.js",
31170     "groupTitle": "Voice_MOHs"
31171   },
31172   {
31173     "type": "post",
31174     "url": "/api/voice/mohs/{id}/sounds",
31175     "title": "Add sound to MOH",
31176     "examples": [
31177       {
31178         "title": "Example usage:",
31179         "content": "curl https://{domain}/api/voice/mohs/{id}/sounds -d '{\"id\": 1}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
31180         "type": "json"
31181       }
31182     ],
31183     "name": "AddSound",
31184     "group": "Voice_MOHs",
31185     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31186     "version": "0.0.0",
31187     "filename": "server/api/voiceMusicOnHold/index.js",
31188     "groupTitle": "Voice_MOHs"
31189   },
31190   {
31191     "type": "delete",
31192     "url": "/api/voice/mohs/{id}",
31193     "title": "Deletes an MOH",
31194     "examples": [
31195       {
31196         "title": "Example usage:",
31197         "content": "curl https://{domain}/api/voice/mohs/{id} -v -u {name}:{password} -X DELETE",
31198         "type": "json"
31199       }
31200     ],
31201     "name": "DestroyMoh",
31202     "group": "Voice_MOHs",
31203     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31204     "version": "0.0.0",
31205     "filename": "server/api/voiceMusicOnHold/index.js",
31206     "groupTitle": "Voice_MOHs"
31207   },
31208   {
31209     "type": "get",
31210     "url": "/api/voice/mohs",
31211     "title": "Gets a list of Music On Holds",
31212     "examples": [
31213       {
31214         "title": "Example usage:",
31215         "content": "curl https://{domain}/api/voice/mohs -v -u {name}:{password}",
31216         "type": "json"
31217       }
31218     ],
31219     "name": "GetMusic_On_Holds",
31220     "group": "Voice_MOHs",
31221     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
31222     "version": "0.0.0",
31223     "filename": "server/api/voiceMusicOnHold/index.js",
31224     "groupTitle": "Voice_MOHs"
31225   },
31226   {
31227     "type": "get",
31228     "url": "/api/voice/mohs/{id}/sounds",
31229     "title": "Gets sounds from MOH",
31230     "examples": [
31231       {
31232         "title": "Example usage:",
31233         "content": "curl https://{domain}/api/voice/mohs/{id}/sounds -v -u {name}:{password} -X DELETE",
31234         "type": "json"
31235       }
31236     ],
31237     "name": "GetSounds",
31238     "group": "Voice_MOHs",
31239     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31240     "version": "0.0.0",
31241     "filename": "server/api/voiceMusicOnHold/index.js",
31242     "groupTitle": "Voice_MOHs"
31243   },
31244   {
31245     "type": "delete",
31246     "url": "/api/voice/mohs/{id}/sounds/{id2}",
31247     "title": "Remove sound from MOH",
31248     "examples": [
31249       {
31250         "title": "Example usage:",
31251         "content": "curl https://{domain}/api/voice/mohs/{id}/sounds/{id2} -v -u {name}:{password} -X DELETE",
31252         "type": "json"
31253       }
31254     ],
31255     "name": "RemoveSound",
31256     "group": "Voice_MOHs",
31257     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31258     "version": "0.0.0",
31259     "filename": "server/api/voiceMusicOnHold/index.js",
31260     "groupTitle": "Voice_MOHs"
31261   },
31262   {
31263     "type": "get",
31264     "url": "/api/voice/mohs/{id}",
31265     "title": "Gets a single Music On Hold",
31266     "examples": [
31267       {
31268         "title": "Example usage:",
31269         "content": "curl https://{domain}/api/voice/mohs/{id} -v -u {name}:{password}",
31270         "type": "json"
31271       }
31272     ],
31273     "name": "ShowMusic_On_Holds",
31274     "group": "Voice_MOHs",
31275     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31276     "version": "0.0.0",
31277     "filename": "server/api/voiceMusicOnHold/index.js",
31278     "groupTitle": "Voice_MOHs"
31279   },
31280   {
31281     "type": "put",
31282     "url": "/api/voice/mohs/{id}",
31283     "title": "Update an existing Music On Hold",
31284     "examples": [
31285       {
31286         "title": "Example usage:",
31287         "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",
31288         "type": "json"
31289       }
31290     ],
31291     "name": "updateMusic_On_Holds",
31292     "group": "Voice_MOHs",
31293     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31294     "version": "0.0.0",
31295     "filename": "server/api/voiceMusicOnHold/index.js",
31296     "groupTitle": "Voice_MOHs"
31297   },
31298   {
31299     "type": "post",
31300     "url": "/api/voice/mails",
31301     "title": "Creates a new Mail",
31302     "examples": [
31303       {
31304         "title": "Example usage:",
31305         "content": "curl https://{domain}/api/voice/mails -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
31306         "type": "json"
31307       }
31308     ],
31309     "name": "CreateMails",
31310     "group": "Voice_Mails",
31311     "parameter": {
31312       "fields": {
31313         "Body": [
31314           {
31315             "group": "Body",
31316             "type": "String",
31317             "optional": true,
31318             "field": "customer_id",
31319             "description": ""
31320           },
31321           {
31322             "group": "Body",
31323             "type": "String",
31324             "optional": true,
31325             "field": "context",
31326             "description": ""
31327           },
31328           {
31329             "group": "Body",
31330             "type": "String",
31331             "optional": false,
31332             "field": "mailbox",
31333             "description": ""
31334           },
31335           {
31336             "group": "Body",
31337             "type": "String",
31338             "optional": true,
31339             "field": "password",
31340             "description": ""
31341           },
31342           {
31343             "group": "Body",
31344             "type": "String",
31345             "optional": true,
31346             "field": "fullname",
31347             "description": ""
31348           },
31349           {
31350             "group": "Body",
31351             "type": "String",
31352             "optional": true,
31353             "field": "email",
31354             "description": ""
31355           },
31356           {
31357             "group": "Body",
31358             "type": "String",
31359             "optional": true,
31360             "field": "pager",
31361             "description": ""
31362           },
31363           {
31364             "group": "Body",
31365             "type": "String",
31366             "optional": true,
31367             "field": "tz",
31368             "description": ""
31369           },
31370           {
31371             "group": "Body",
31372             "type": "String",
31373             "allowedValues": [
31374               "\"yes\"",
31375               "\"no\""
31376             ],
31377             "optional": false,
31378             "field": "attach",
31379             "description": ""
31380           },
31381           {
31382             "group": "Body",
31383             "type": "String",
31384             "allowedValues": [
31385               "\"yes\"",
31386               "\"no\""
31387             ],
31388             "optional": false,
31389             "field": "saycid",
31390             "description": ""
31391           },
31392           {
31393             "group": "Body",
31394             "type": "String",
31395             "optional": true,
31396             "field": "dialout",
31397             "description": ""
31398           },
31399           {
31400             "group": "Body",
31401             "type": "String",
31402             "optional": true,
31403             "field": "callback",
31404             "description": ""
31405           },
31406           {
31407             "group": "Body",
31408             "type": "String",
31409             "allowedValues": [
31410               "\"yes\"",
31411               "\"no\""
31412             ],
31413             "optional": false,
31414             "field": "review",
31415             "description": ""
31416           },
31417           {
31418             "group": "Body",
31419             "type": "String",
31420             "allowedValues": [
31421               "\"yes\"",
31422               "\"no\""
31423             ],
31424             "optional": false,
31425             "field": "operator",
31426             "description": ""
31427           },
31428           {
31429             "group": "Body",
31430             "type": "String",
31431             "allowedValues": [
31432               "\"yes\"",
31433               "\"no\""
31434             ],
31435             "optional": false,
31436             "field": "envelope",
31437             "description": ""
31438           },
31439           {
31440             "group": "Body",
31441             "type": "String",
31442             "allowedValues": [
31443               "\"yes\"",
31444               "\"no\""
31445             ],
31446             "optional": false,
31447             "field": "sayduration",
31448             "description": ""
31449           },
31450           {
31451             "group": "Body",
31452             "type": "String",
31453             "optional": false,
31454             "field": "saydurationm",
31455             "description": ""
31456           },
31457           {
31458             "group": "Body",
31459             "type": "String",
31460             "allowedValues": [
31461               "\"yes\"",
31462               "\"no\""
31463             ],
31464             "optional": false,
31465             "field": "sendvoicemail",
31466             "description": ""
31467           },
31468           {
31469             "group": "Body",
31470             "type": "String",
31471             "allowedValues": [
31472               "\"yes\"",
31473               "\"no\""
31474             ],
31475             "optional": false,
31476             "field": "delete",
31477             "description": ""
31478           },
31479           {
31480             "group": "Body",
31481             "type": "String",
31482             "allowedValues": [
31483               "\"yes\"",
31484               "\"no\""
31485             ],
31486             "optional": false,
31487             "field": "nextaftercmd",
31488             "description": ""
31489           },
31490           {
31491             "group": "Body",
31492             "type": "String",
31493             "allowedValues": [
31494               "\"yes\"",
31495               "\"no\""
31496             ],
31497             "optional": false,
31498             "field": "forcename",
31499             "description": ""
31500           },
31501           {
31502             "group": "Body",
31503             "type": "String",
31504             "allowedValues": [
31505               "\"yes\"",
31506               "\"no\""
31507             ],
31508             "optional": false,
31509             "field": "forcegreetings",
31510             "description": ""
31511           },
31512           {
31513             "group": "Body",
31514             "type": "String",
31515             "allowedValues": [
31516               "\"yes\"",
31517               "\"no\""
31518             ],
31519             "optional": false,
31520             "field": "hidefromdir",
31521             "description": ""
31522           },
31523           {
31524             "group": "Body",
31525             "type": "String",
31526             "optional": true,
31527             "field": "stamp",
31528             "description": ""
31529           },
31530           {
31531             "group": "Body",
31532             "type": "String",
31533             "optional": true,
31534             "field": "emailsubject",
31535             "description": ""
31536           },
31537           {
31538             "group": "Body",
31539             "type": "String",
31540             "optional": true,
31541             "field": "emailbody",
31542             "description": ""
31543           },
31544           {
31545             "group": "Body",
31546             "type": "Integer",
31547             "optional": false,
31548             "field": "maxsecs",
31549             "description": ""
31550           },
31551           {
31552             "group": "Body",
31553             "type": "Integer",
31554             "optional": false,
31555             "field": "maxmsg",
31556             "description": ""
31557           },
31558           {
31559             "group": "Body",
31560             "type": "Virtual",
31561             "optional": true,
31562             "field": "name",
31563             "description": ""
31564           }
31565         ]
31566       }
31567     },
31568     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31569     "version": "0.0.0",
31570     "filename": "server/api/voiceMail/index.js",
31571     "groupTitle": "Voice_Mails"
31572   },
31573   {
31574     "type": "delete",
31575     "url": "/api/voice/mails/{id}",
31576     "title": "Deletes a Mail",
31577     "examples": [
31578       {
31579         "title": "Example usage:",
31580         "content": "curl https://{domain}/api/voice/mails/{id} -v -u {name}:{password} -X DELETE",
31581         "type": "json"
31582       }
31583     ],
31584     "name": "DeleteMails",
31585     "group": "Voice_Mails",
31586     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31587     "version": "0.0.0",
31588     "filename": "server/api/voiceMail/index.js",
31589     "groupTitle": "Voice_Mails"
31590   },
31591   {
31592     "type": "get",
31593     "url": "/api/voice/mails",
31594     "title": "Gets a list of Mails",
31595     "examples": [
31596       {
31597         "title": "Example usage:",
31598         "content": "curl https://{domain}/api/voice/mails -v -u {name}:{password}",
31599         "type": "json"
31600       }
31601     ],
31602     "name": "GetMails",
31603     "group": "Voice_Mails",
31604     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
31605     "version": "0.0.0",
31606     "filename": "server/api/voiceMail/index.js",
31607     "groupTitle": "Voice_Mails"
31608   },
31609   {
31610     "type": "get",
31611     "url": "/api/voice/mails/{id}",
31612     "title": "Gets a single Mail",
31613     "examples": [
31614       {
31615         "title": "Example usage:",
31616         "content": "curl https://{domain}/api/voice/mails/{id} -v -u {name}:{password}",
31617         "type": "json"
31618       }
31619     ],
31620     "name": "ShowMails",
31621     "group": "Voice_Mails",
31622     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31623     "version": "0.0.0",
31624     "filename": "server/api/voiceMail/index.js",
31625     "groupTitle": "Voice_Mails"
31626   },
31627   {
31628     "type": "get",
31629     "url": "/api/voice/mails/{id}/messages",
31630     "title": "Gets voice mail messages",
31631     "examples": [
31632       {
31633         "title": "Example usage:",
31634         "content": "curl https://{domain}/api/voice/mails/{id}/messages -v -u {name}:{password} -X GET",
31635         "type": "json"
31636       }
31637     ],
31638     "name": "getMessages",
31639     "group": "Voice_Mails",
31640     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31641     "version": "0.0.0",
31642     "filename": "server/api/voiceMail/index.js",
31643     "groupTitle": "Voice_Mails"
31644   },
31645   {
31646     "type": "put",
31647     "url": "/api/voice/mails/{id}",
31648     "title": "Update an existing Mail",
31649     "examples": [
31650       {
31651         "title": "Example usage:",
31652         "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",
31653         "type": "json"
31654       }
31655     ],
31656     "name": "updateMails",
31657     "group": "Voice_Mails",
31658     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31659     "version": "0.0.0",
31660     "filename": "server/api/voiceMail/index.js",
31661     "groupTitle": "Voice_Mails"
31662   },
31663   {
31664     "type": "post",
31665     "url": "/api/voice/mails/messages",
31666     "title": "Creates a new Message",
31667     "examples": [
31668       {
31669         "title": "Example usage:",
31670         "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",
31671         "type": "json"
31672       }
31673     ],
31674     "name": "CreateMessages",
31675     "group": "Voice_Messages",
31676     "parameter": {
31677       "fields": {
31678         "Body": [
31679           {
31680             "group": "Body",
31681             "type": "Virtual",
31682             "optional": true,
31683             "field": "name",
31684             "description": ""
31685           },
31686           {
31687             "group": "Body",
31688             "type": "Integer",
31689             "optional": false,
31690             "field": "msgnum",
31691             "description": ""
31692           },
31693           {
31694             "group": "Body",
31695             "type": "String",
31696             "optional": true,
31697             "field": "dir",
31698             "description": ""
31699           },
31700           {
31701             "group": "Body",
31702             "type": "String",
31703             "optional": true,
31704             "field": "context",
31705             "description": ""
31706           },
31707           {
31708             "group": "Body",
31709             "type": "String",
31710             "optional": true,
31711             "field": "macrocontext",
31712             "description": ""
31713           },
31714           {
31715             "group": "Body",
31716             "type": "String",
31717             "optional": true,
31718             "field": "callerid",
31719             "description": ""
31720           },
31721           {
31722             "group": "Body",
31723             "type": "String",
31724             "optional": true,
31725             "field": "origtime",
31726             "description": ""
31727           },
31728           {
31729             "group": "Body",
31730             "type": "String",
31731             "optional": true,
31732             "field": "duration",
31733             "description": ""
31734           },
31735           {
31736             "group": "Body",
31737             "type": "String",
31738             "optional": true,
31739             "field": "mailboxuser",
31740             "description": ""
31741           },
31742           {
31743             "group": "Body",
31744             "type": "String",
31745             "optional": true,
31746             "field": "mailboxcontext",
31747             "description": ""
31748           },
31749           {
31750             "group": "Body",
31751             "type": "Blob",
31752             "optional": true,
31753             "field": "recording",
31754             "description": ""
31755           },
31756           {
31757             "group": "Body",
31758             "type": "String",
31759             "optional": true,
31760             "field": "flag",
31761             "description": ""
31762           },
31763           {
31764             "group": "Body",
31765             "type": "String",
31766             "optional": true,
31767             "field": "msg_id",
31768             "description": ""
31769           },
31770           {
31771             "group": "Body",
31772             "type": "String",
31773             "optional": true,
31774             "field": "stamp",
31775             "description": ""
31776           }
31777         ]
31778       }
31779     },
31780     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31781     "version": "0.0.0",
31782     "filename": "server/api/voiceMailMessage/index.js",
31783     "groupTitle": "Voice_Messages"
31784   },
31785   {
31786     "type": "delete",
31787     "url": "/api/voice/mails/messages/{id}",
31788     "title": "Deletes a Message",
31789     "examples": [
31790       {
31791         "title": "Example usage:",
31792         "content": "curl https://{domain}/api/voice/mails/messages/{id} -v -u {name}:{password} -X DELETE",
31793         "type": "json"
31794       }
31795     ],
31796     "name": "DeleteMessages",
31797     "group": "Voice_Messages",
31798     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31799     "version": "0.0.0",
31800     "filename": "server/api/voiceMailMessage/index.js",
31801     "groupTitle": "Voice_Messages"
31802   },
31803   {
31804     "type": "get",
31805     "url": "/api/voice/mails/messages",
31806     "title": "Gets a list of Messages",
31807     "examples": [
31808       {
31809         "title": "Example usage:",
31810         "content": "curl https://{domain}/api/voice/mails/messages -v -u {name}:{password}",
31811         "type": "json"
31812       }
31813     ],
31814     "name": "GetMessages",
31815     "group": "Voice_Messages",
31816     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
31817     "version": "0.0.0",
31818     "filename": "server/api/voiceMailMessage/index.js",
31819     "groupTitle": "Voice_Messages"
31820   },
31821   {
31822     "type": "get",
31823     "url": "/api/voice/mails/messages/{id}",
31824     "title": "Gets a single Message",
31825     "examples": [
31826       {
31827         "title": "Example usage:",
31828         "content": "curl https://{domain}/api/voice/mails/messages/{id} -v -u {name}:{password}",
31829         "type": "json"
31830       }
31831     ],
31832     "name": "ShowMessages",
31833     "group": "Voice_Messages",
31834     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31835     "version": "0.0.0",
31836     "filename": "server/api/voiceMailMessage/index.js",
31837     "groupTitle": "Voice_Messages"
31838   },
31839   {
31840     "type": "get",
31841     "url": "voice/mails/messages/{id}/download",
31842     "title": "Download Voice Message",
31843     "examples": [
31844       {
31845         "title": "Example usage:",
31846         "content": "curl https://{domain}voice/mails/messages/{id}/download -v -u {name}:{password} -X GET",
31847         "type": "json"
31848       }
31849     ],
31850     "name": "download",
31851     "group": "Voice_Messages",
31852     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31853     "version": "0.0.0",
31854     "filename": "server/api/voiceMailMessage/index.js",
31855     "groupTitle": "Voice_Messages"
31856   },
31857   {
31858     "type": "put",
31859     "url": "/api/voice/mails/messages/{id}",
31860     "title": "Update an existing Message",
31861     "examples": [
31862       {
31863         "title": "Example usage:",
31864         "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",
31865         "type": "json"
31866       }
31867     ],
31868     "name": "updateMessages",
31869     "group": "Voice_Messages",
31870     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31871     "version": "0.0.0",
31872     "filename": "server/api/voiceMailMessage/index.js",
31873     "groupTitle": "Voice_Messages"
31874   },
31875   {
31876     "type": "post",
31877     "url": "/api/voice/prefixes/{id}/users",
31878     "title": "Add agents to a prefix",
31879     "examples": [
31880       {
31881         "title": "Example usage:",
31882         "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",
31883         "type": "json"
31884       }
31885     ],
31886     "name": "AddAgents",
31887     "group": "Voice_Prefixes",
31888     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31889     "version": "0.0.0",
31890     "filename": "server/api/voicePrefix/index.js",
31891     "groupTitle": "Voice_Prefixes"
31892   },
31893   {
31894     "type": "delete",
31895     "url": "/api/voice/prefixes/{id}",
31896     "title": "Deletes a Prefix",
31897     "examples": [
31898       {
31899         "title": "Example usage:",
31900         "content": "curl https://{domain}/api/voice/prefixes/{id} -v -u {name}:{password} -X DELETE",
31901         "type": "json"
31902       }
31903     ],
31904     "name": "DeletePrefixes",
31905     "group": "Voice_Prefixes",
31906     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31907     "version": "0.0.0",
31908     "filename": "server/api/voicePrefix/index.js",
31909     "groupTitle": "Voice_Prefixes"
31910   },
31911   {
31912     "type": "get",
31913     "url": "/api/voice/prefixes/describe",
31914     "title": "Gets table info about Prefixes",
31915     "examples": [
31916       {
31917         "title": "Example usage:",
31918         "content": "curl https://{domain}/api/voice/prefixes/describe -v -u {name}:{password}",
31919         "type": "json"
31920       }
31921     ],
31922     "name": "DescribePrefixes",
31923     "group": "Voice_Prefixes",
31924     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31925     "version": "0.0.0",
31926     "filename": "server/api/voicePrefix/index.js",
31927     "groupTitle": "Voice_Prefixes"
31928   },
31929   {
31930     "type": "get",
31931     "url": "/api/voice/prefixes/{id}/users",
31932     "title": "Gets agents from prefix",
31933     "examples": [
31934       {
31935         "title": "Example usage:",
31936         "content": "curl https://{domain}/api/voice/prefixes/{id}/users -v -u {name}:{password} -X GET",
31937         "type": "json"
31938       }
31939     ],
31940     "name": "GetAgents",
31941     "group": "Voice_Prefixes",
31942     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31943     "version": "0.0.0",
31944     "filename": "server/api/voicePrefix/index.js",
31945     "groupTitle": "Voice_Prefixes"
31946   },
31947   {
31948     "type": "get",
31949     "url": "/api/voice/prefixes",
31950     "title": "Gets a list of Prefixes",
31951     "examples": [
31952       {
31953         "title": "Example usage:",
31954         "content": "curl https://{domain}/api/voice/prefixes -v -u {name}:{password}",
31955         "type": "json"
31956       }
31957     ],
31958     "name": "GetPrefixes",
31959     "group": "Voice_Prefixes",
31960     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
31961     "version": "0.0.0",
31962     "filename": "server/api/voicePrefix/index.js",
31963     "groupTitle": "Voice_Prefixes"
31964   },
31965   {
31966     "type": "delete",
31967     "url": "/api/voice/prefixes/{id}/users",
31968     "title": "Removes agents from a prefix",
31969     "examples": [
31970       {
31971         "title": "Example usage:",
31972         "content": "curl https://{domain}/api/voice/prefixes/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
31973         "type": "json"
31974       }
31975     ],
31976     "name": "RemoveAgents",
31977     "group": "Voice_Prefixes",
31978     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31979     "version": "0.0.0",
31980     "filename": "server/api/voicePrefix/index.js",
31981     "groupTitle": "Voice_Prefixes"
31982   },
31983   {
31984     "type": "get",
31985     "url": "/api/voice/prefixes/{id}",
31986     "title": "Gets a single Prefix",
31987     "examples": [
31988       {
31989         "title": "Example usage:",
31990         "content": "curl https://{domain}/api/voice/prefixes/{id} -v -u {name}:{password}",
31991         "type": "json"
31992       }
31993     ],
31994     "name": "ShowPrefixes",
31995     "group": "Voice_Prefixes",
31996     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31997     "version": "0.0.0",
31998     "filename": "server/api/voicePrefix/index.js",
31999     "groupTitle": "Voice_Prefixes"
32000   },
32001   {
32002     "type": "put",
32003     "url": "/api/voice/prefixes/{id}",
32004     "title": "Update an existing prefix",
32005     "examples": [
32006       {
32007         "title": "Example usage:",
32008         "content": "curl https://{domain}/api/voice/prefixes/{id} -v -u {name}:{password} -X PUT",
32009         "type": "json"
32010       }
32011     ],
32012     "name": "Update",
32013     "group": "Voice_Prefixes",
32014     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32015     "version": "0.0.0",
32016     "filename": "server/api/voicePrefix/index.js",
32017     "groupTitle": "Voice_Prefixes"
32018   },
32019   {
32020     "type": "post",
32021     "url": "/api/voice/prefixes",
32022     "title": "Create a prefix",
32023     "examples": [
32024       {
32025         "title": "Example usage:",
32026         "content": "curl https://{domain}/api/voice/prefixes -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
32027         "type": "json"
32028       }
32029     ],
32030     "name": "create",
32031     "group": "Voice_Prefixes",
32032     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32033     "version": "0.0.0",
32034     "filename": "server/api/voicePrefix/index.js",
32035     "groupTitle": "Voice_Prefixes"
32036   },
32037   {
32038     "type": "get",
32039     "url": "/api/voice/queues/reports/describe",
32040     "title": "Gets table info about Queue Reports",
32041     "examples": [
32042       {
32043         "title": "Example usage:",
32044         "content": "curl https://{domain}/api/voice/queues/reports/describe -v -u {name}:{password}",
32045         "type": "json"
32046       }
32047     ],
32048     "name": "DescribeQueue_Reports",
32049     "group": "Voice_Queue_Reports",
32050     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32051     "version": "0.0.0",
32052     "filename": "server/api/voiceQueueReport/index.js",
32053     "groupTitle": "Voice_Queue_Reports"
32054   },
32055   {
32056     "type": "get",
32057     "url": "/api/voice/queues/reports",
32058     "title": "Gets a list of Queue Reports",
32059     "examples": [
32060       {
32061         "title": "Example usage:",
32062         "content": "curl https://{domain}/api/voice/queues/reports -v -u {name}:{password}",
32063         "type": "json"
32064       }
32065     ],
32066     "name": "GetQueue_Reports",
32067     "group": "Voice_Queue_Reports",
32068     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
32069     "version": "0.0.0",
32070     "filename": "server/api/voiceQueueReport/index.js",
32071     "groupTitle": "Voice_Queue_Reports"
32072   },
32073   {
32074     "type": "get",
32075     "url": "/api/voice/queues/reports/{id}",
32076     "title": "Gets a single Queue Report",
32077     "examples": [
32078       {
32079         "title": "Example usage:",
32080         "content": "curl https://{domain}/api/voice/queues/reports/{id} -v -u {name}:{password}",
32081         "type": "json"
32082       }
32083     ],
32084     "name": "ShowQueue_Reports",
32085     "group": "Voice_Queue_Reports",
32086     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32087     "version": "0.0.0",
32088     "filename": "server/api/voiceQueueReport/index.js",
32089     "groupTitle": "Voice_Queue_Reports"
32090   },
32091   {
32092     "type": "get",
32093     "url": "/api/voice/queues/reports/index",
32094     "title": "Get Voice Queues Report",
32095     "examples": [
32096       {
32097         "title": "Example usage:",
32098         "content": "curl https://{domain}/api/voice/queues/reports/index -v -u {name}:{password} -X GET",
32099         "type": "json"
32100       }
32101     ],
32102     "name": "getVoiceQueuesReport",
32103     "group": "Voice_Queue_Reports",
32104     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32105     "version": "0.0.0",
32106     "filename": "server/api/voiceQueueReport/index.js",
32107     "groupTitle": "Voice_Queue_Reports"
32108   },
32109   {
32110     "type": "post",
32111     "url": "/api/voice/queues/{id}/users",
32112     "title": "Add agents to queue",
32113     "examples": [
32114       {
32115         "title": "Example usage:",
32116         "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",
32117         "type": "json"
32118       }
32119     ],
32120     "name": "AddAgents",
32121     "group": "Voice_Queues",
32122     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32123     "version": "0.0.0",
32124     "filename": "server/api/voiceQueue/index.js",
32125     "groupTitle": "Voice_Queues"
32126   },
32127   {
32128     "type": "post",
32129     "url": "/api/voice/queues/{id}/blacklists",
32130     "title": "Add blacklists to a queue",
32131     "examples": [
32132       {
32133         "title": "Example usage:",
32134         "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",
32135         "type": "json"
32136       }
32137     ],
32138     "name": "AddBlackLists",
32139     "group": "Voice_Queues",
32140     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32141     "version": "0.0.0",
32142     "filename": "server/api/voiceQueue/index.js",
32143     "groupTitle": "Voice_Queues"
32144   },
32145   {
32146     "type": "post",
32147     "url": "/api/voice/queues/{id}/lists",
32148     "title": "Add lists to a queue",
32149     "examples": [
32150       {
32151         "title": "Example usage:",
32152         "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",
32153         "type": "json"
32154       }
32155     ],
32156     "name": "AddLists",
32157     "group": "Voice_Queues",
32158     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32159     "version": "0.0.0",
32160     "filename": "server/api/voiceQueue/index.js",
32161     "groupTitle": "Voice_Queues"
32162   },
32163   {
32164     "type": "post",
32165     "url": "/api/voice/queues/{id}/teams",
32166     "title": "Add teams to queue",
32167     "examples": [
32168       {
32169         "title": "Example usage:",
32170         "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",
32171         "type": "json"
32172       }
32173     ],
32174     "name": "AddTeams",
32175     "group": "Voice_Queues",
32176     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32177     "version": "0.0.0",
32178     "filename": "server/api/voiceQueue/index.js",
32179     "groupTitle": "Voice_Queues"
32180   },
32181   {
32182     "type": "post",
32183     "url": "/api/voice/queues/clone",
32184     "title": "Clone an existing Queue",
32185     "examples": [
32186       {
32187         "title": "Example usage:",
32188         "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",
32189         "type": "json"
32190       }
32191     ],
32192     "name": "CloneQueues",
32193     "group": "Voice_Queues",
32194     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32195     "version": "0.0.0",
32196     "filename": "server/api/voiceQueue/index.js",
32197     "groupTitle": "Voice_Queues"
32198   },
32199   {
32200     "type": "post",
32201     "url": "/api/voice/queues",
32202     "title": "Creates a new Queue",
32203     "examples": [
32204       {
32205         "title": "Example usage:",
32206         "content": "curl https://{domain}/api/voice/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
32207         "type": "json"
32208       }
32209     ],
32210     "name": "CreateQueues",
32211     "group": "Voice_Queues",
32212     "parameter": {
32213       "fields": {
32214         "Body": [
32215           {
32216             "group": "Body",
32217             "type": "String",
32218             "optional": false,
32219             "field": "name",
32220             "description": ""
32221           },
32222           {
32223             "group": "Body",
32224             "type": "String",
32225             "allowedValues": [
32226               "\"inbound\"",
32227               "\"outbound\""
32228             ],
32229             "optional": false,
32230             "field": "type",
32231             "description": ""
32232           },
32233           {
32234             "group": "Body",
32235             "type": "String",
32236             "optional": true,
32237             "field": "musiconhold",
32238             "description": ""
32239           },
32240           {
32241             "group": "Body",
32242             "type": "String",
32243             "optional": true,
32244             "field": "announce",
32245             "description": ""
32246           },
32247           {
32248             "group": "Body",
32249             "type": "String",
32250             "allowedValues": [
32251               "\"rr\"",
32252               "\"ringall\"",
32253               "\"leastrecent\"",
32254               "\"fewestcalls\"",
32255               "\"random\"",
32256               "\"rrmemory\"",
32257               "\"linear\"",
32258               "\"wrandom\"",
32259               "\"rrordered\""
32260             ],
32261             "optional": false,
32262             "field": "strategy",
32263             "description": ""
32264           },
32265           {
32266             "group": "Body",
32267             "type": "Integer",
32268             "optional": true,
32269             "field": "servicelevel",
32270             "description": ""
32271           },
32272           {
32273             "group": "Body",
32274             "type": "String",
32275             "optional": true,
32276             "field": "context",
32277             "description": ""
32278           },
32279           {
32280             "group": "Body",
32281             "type": "Integer",
32282             "optional": true,
32283             "field": "penaltymemberslimit",
32284             "description": ""
32285           },
32286           {
32287             "group": "Body",
32288             "type": "Integer",
32289             "optional": true,
32290             "field": "timeout",
32291             "description": ""
32292           },
32293           {
32294             "group": "Body",
32295             "type": "Integer",
32296             "optional": true,
32297             "field": "retry",
32298             "description": ""
32299           },
32300           {
32301             "group": "Body",
32302             "type": "String",
32303             "optional": true,
32304             "field": "timeoutpriority",
32305             "description": ""
32306           },
32307           {
32308             "group": "Body",
32309             "type": "Integer",
32310             "optional": true,
32311             "field": "weight",
32312             "description": ""
32313           },
32314           {
32315             "group": "Body",
32316             "type": "Integer",
32317             "optional": true,
32318             "field": "wrapuptime",
32319             "description": ""
32320           },
32321           {
32322             "group": "Body",
32323             "type": "String",
32324             "allowedValues": [
32325               "\"yes\"",
32326               "\"no\""
32327             ],
32328             "optional": true,
32329             "field": "autofill",
32330             "description": ""
32331           },
32332           {
32333             "group": "Body",
32334             "type": "String",
32335             "allowedValues": [
32336               "\"yes\"",
32337               "\"no\"",
32338               "\"all\""
32339             ],
32340             "optional": true,
32341             "field": "autopause",
32342             "description": ""
32343           },
32344           {
32345             "group": "Body",
32346             "type": "Integer",
32347             "optional": true,
32348             "field": "autopausedelay",
32349             "description": ""
32350           },
32351           {
32352             "group": "Body",
32353             "type": "String",
32354             "allowedValues": [
32355               "\"yes\"",
32356               "\"no\""
32357             ],
32358             "optional": true,
32359             "field": "autopausebusy",
32360             "description": ""
32361           },
32362           {
32363             "group": "Body",
32364             "type": "String",
32365             "allowedValues": [
32366               "\"yes\"",
32367               "\"no\""
32368             ],
32369             "optional": true,
32370             "field": "autopauseunavail",
32371             "description": ""
32372           },
32373           {
32374             "group": "Body",
32375             "type": "Integer",
32376             "optional": true,
32377             "field": "maxlen",
32378             "description": ""
32379           },
32380           {
32381             "group": "Body",
32382             "type": "String",
32383             "allowedValues": [
32384               "\"yes\"",
32385               "\"no\""
32386             ],
32387             "optional": true,
32388             "field": "setinterfacevar",
32389             "description": ""
32390           },
32391           {
32392             "group": "Body",
32393             "type": "String",
32394             "allowedValues": [
32395               "\"yes\"",
32396               "\"no\""
32397             ],
32398             "optional": true,
32399             "field": "setqueueentryvar",
32400             "description": ""
32401           },
32402           {
32403             "group": "Body",
32404             "type": "String",
32405             "allowedValues": [
32406               "\"yes\"",
32407               "\"no\""
32408             ],
32409             "optional": true,
32410             "field": "setqueuevar",
32411             "description": ""
32412           },
32413           {
32414             "group": "Body",
32415             "type": "String",
32416             "allowedValues": [
32417               "\"yes\"",
32418               "\"no\""
32419             ],
32420             "optional": true,
32421             "field": "eventmemberstatus",
32422             "description": ""
32423           },
32424           {
32425             "group": "Body",
32426             "type": "String",
32427             "optional": true,
32428             "field": "membermacro",
32429             "description": ""
32430           },
32431           {
32432             "group": "Body",
32433             "type": "String",
32434             "optional": true,
32435             "field": "membergosub",
32436             "description": ""
32437           },
32438           {
32439             "group": "Body",
32440             "type": "Integer",
32441             "optional": true,
32442             "field": "announce_frequency",
32443             "description": ""
32444           },
32445           {
32446             "group": "Body",
32447             "type": "Integer",
32448             "optional": true,
32449             "field": "min_announce_frequency",
32450             "description": ""
32451           },
32452           {
32453             "group": "Body",
32454             "type": "Integer",
32455             "optional": true,
32456             "field": "periodic_announce_frequency",
32457             "description": ""
32458           },
32459           {
32460             "group": "Body",
32461             "type": "String",
32462             "allowedValues": [
32463               "\"yes\"",
32464               "\"no\""
32465             ],
32466             "optional": true,
32467             "field": "random_periodic_announce",
32468             "description": ""
32469           },
32470           {
32471             "group": "Body",
32472             "type": "String",
32473             "allowedValues": [
32474               "\"yes\"",
32475               "\"no\""
32476             ],
32477             "optional": true,
32478             "field": "relative_periodic_announce",
32479             "description": ""
32480           },
32481           {
32482             "group": "Body",
32483             "type": "String",
32484             "allowedValues": [
32485               "\"yes\"",
32486               "\"no\"",
32487               "\"once\""
32488             ],
32489             "optional": true,
32490             "field": "announce_holdtime",
32491             "description": ""
32492           },
32493           {
32494             "group": "Body",
32495             "type": "String",
32496             "optional": true,
32497             "field": "announce_position",
32498             "description": ""
32499           },
32500           {
32501             "group": "Body",
32502             "type": "String",
32503             "allowedValues": [
32504               "\"yes\"",
32505               "\"no\""
32506             ],
32507             "optional": true,
32508             "field": "announce_to_first_user",
32509             "description": ""
32510           },
32511           {
32512             "group": "Body",
32513             "type": "Integer",
32514             "optional": true,
32515             "field": "announce_position_limit",
32516             "description": ""
32517           },
32518           {
32519             "group": "Body",
32520             "type": "String",
32521             "allowedValues": [
32522               "\"0\"",
32523               "\"5\"",
32524               "\"10\"",
32525               "\"15\"",
32526               "\"20\"",
32527               "\"30\""
32528             ],
32529             "optional": true,
32530             "field": "announce_round_seconds",
32531             "description": ""
32532           },
32533           {
32534             "group": "Body",
32535             "type": "String",
32536             "optional": true,
32537             "field": "monitor_format",
32538             "description": ""
32539           },
32540           {
32541             "group": "Body",
32542             "type": "String",
32543             "optional": true,
32544             "field": "monitor_type",
32545             "description": ""
32546           },
32547           {
32548             "group": "Body",
32549             "type": "String",
32550             "optional": true,
32551             "field": "queue_youarenext",
32552             "description": ""
32553           },
32554           {
32555             "group": "Body",
32556             "type": "String",
32557             "optional": true,
32558             "field": "queue_thereare",
32559             "description": ""
32560           },
32561           {
32562             "group": "Body",
32563             "type": "String",
32564             "optional": true,
32565             "field": "queue_callswaiting",
32566             "description": ""
32567           },
32568           {
32569             "group": "Body",
32570             "type": "String",
32571             "optional": true,
32572             "field": "queue_holdtime",
32573             "description": ""
32574           },
32575           {
32576             "group": "Body",
32577             "type": "String",
32578             "optional": true,
32579             "field": "queue_minute",
32580             "description": ""
32581           },
32582           {
32583             "group": "Body",
32584             "type": "String",
32585             "optional": true,
32586             "field": "queue_minutes",
32587             "description": ""
32588           },
32589           {
32590             "group": "Body",
32591             "type": "String",
32592             "optional": true,
32593             "field": "queue_seconds",
32594             "description": ""
32595           },
32596           {
32597             "group": "Body",
32598             "type": "String",
32599             "optional": true,
32600             "field": "queue_thankyou",
32601             "description": ""
32602           },
32603           {
32604             "group": "Body",
32605             "type": "String",
32606             "optional": true,
32607             "field": "queue_reporthold",
32608             "description": ""
32609           },
32610           {
32611             "group": "Body",
32612             "type": "String",
32613             "optional": true,
32614             "field": "queue_quantity1",
32615             "description": ""
32616           },
32617           {
32618             "group": "Body",
32619             "type": "String",
32620             "optional": true,
32621             "field": "queue_quantity2",
32622             "description": ""
32623           },
32624           {
32625             "group": "Body",
32626             "type": "String",
32627             "optional": true,
32628             "field": "queue_periodic_announce",
32629             "description": ""
32630           },
32631           {
32632             "group": "Body",
32633             "type": "String",
32634             "optional": true,
32635             "field": "queue_less_than",
32636             "description": ""
32637           },
32638           {
32639             "group": "Body",
32640             "type": "Text",
32641             "optional": true,
32642             "field": "periodic_announce",
32643             "description": ""
32644           },
32645           {
32646             "group": "Body",
32647             "type": "String",
32648             "optional": true,
32649             "field": "joinempty",
32650             "description": ""
32651           },
32652           {
32653             "group": "Body",
32654             "type": "String",
32655             "optional": true,
32656             "field": "leavewhenempty",
32657             "description": ""
32658           },
32659           {
32660             "group": "Body",
32661             "type": "String",
32662             "allowedValues": [
32663               "\"yes\"",
32664               "\"no\""
32665             ],
32666             "optional": true,
32667             "field": "reportholdtime",
32668             "description": ""
32669           },
32670           {
32671             "group": "Body",
32672             "type": "String",
32673             "allowedValues": [
32674               "\"yes\"",
32675               "\"no\""
32676             ],
32677             "optional": true,
32678             "field": "ringinuse",
32679             "description": ""
32680           },
32681           {
32682             "group": "Body",
32683             "type": "Integer",
32684             "optional": true,
32685             "field": "memberdelay",
32686             "description": ""
32687           },
32688           {
32689             "group": "Body",
32690             "type": "String",
32691             "allowedValues": [
32692               "\"yes\"",
32693               "\"no\""
32694             ],
32695             "optional": true,
32696             "field": "timeoutrestart",
32697             "description": ""
32698           },
32699           {
32700             "group": "Body",
32701             "type": "String",
32702             "optional": true,
32703             "field": "defaultrule",
32704             "description": ""
32705           },
32706           {
32707             "group": "Body",
32708             "type": "String",
32709             "optional": true,
32710             "field": "description",
32711             "description": ""
32712           },
32713           {
32714             "group": "Body",
32715             "type": "Boolean",
32716             "optional": true,
32717             "field": "acw",
32718             "description": ""
32719           },
32720           {
32721             "group": "Body",
32722             "type": "Integer",
32723             "optional": true,
32724             "field": "acwTimeout",
32725             "description": ""
32726           },
32727           {
32728             "group": "Body",
32729             "type": "Boolean",
32730             "optional": true,
32731             "field": "dialActive",
32732             "description": "<p>Active/Disactive Campaign</p>"
32733           },
32734           {
32735             "group": "Body",
32736             "type": "String",
32737             "allowedValues": [
32738               "\"preview\"",
32739               "\"progressive\"",
32740               "\"power\"",
32741               "\"predictive\"",
32742               "\"booked\""
32743             ],
32744             "optional": true,
32745             "field": "dialMethod",
32746             "description": "<p>Dial Method.</p>"
32747           },
32748           {
32749             "group": "Body",
32750             "type": "Integer",
32751             "optional": true,
32752             "field": "dialLimitChannel",
32753             "description": "<p>Max 9999 channels, 0 means unlimited.</p>"
32754           },
32755           {
32756             "group": "Body",
32757             "type": "Integer",
32758             "optional": true,
32759             "field": "dialLimitQueue",
32760             "description": "<p>Max 9999 member in queue(min:1, max:9999), 0 means unlimited.</p>"
32761           },
32762           {
32763             "group": "Body",
32764             "type": "Float",
32765             "optional": true,
32766             "field": "dialPowerLevel",
32767             "description": "<p>Power Level: Calls for agents (min:1, max:10).</p>"
32768           },
32769           {
32770             "group": "Body",
32771             "type": "String",
32772             "allowedValues": [
32773               "\"agentBusyFactor\"",
32774               "\"dropRate\""
32775             ],
32776             "optional": true,
32777             "field": "dialPredictiveOptimization",
32778             "description": "<p>Only for predictive method.</p>"
32779           },
32780           {
32781             "group": "Body",
32782             "type": "Float",
32783             "optional": true,
32784             "field": "dialPredictiveOptimizationPercentage",
32785             "description": "<p>Predictive Optimization Percentage (min: 1, max: 95)</p>"
32786           },
32787           {
32788             "group": "Body",
32789             "type": "Integer",
32790             "optional": true,
32791             "field": "dialPredictiveInterval",
32792             "description": "<p>Interval Predictive Minutes (min:5 max:30)</p>"
32793           },
32794           {
32795             "group": "Body",
32796             "type": "String",
32797             "optional": true,
32798             "field": "dialOriginateCallerIdName",
32799             "description": ""
32800           },
32801           {
32802             "group": "Body",
32803             "type": "String",
32804             "optional": true,
32805             "field": "dialOriginateCallerIdNumber",
32806             "description": ""
32807           },
32808           {
32809             "group": "Body",
32810             "type": "Integer",
32811             "optional": true,
32812             "field": "dialOriginateTimeout",
32813             "description": "<p>Originate Timeout Seconds (min:1, max:999)</p>"
32814           },
32815           {
32816             "group": "Body",
32817             "type": "String",
32818             "optional": true,
32819             "field": "dialQueueOptions",
32820             "description": "<p>https://wiki.asterisk.org/wiki/display/AST/Asterisk+13+Application_Queue</p>"
32821           },
32822           {
32823             "group": "Body",
32824             "type": "Integer",
32825             "optional": true,
32826             "field": "dialQueueTimeout",
32827             "description": "<p>Queue Timeout Seconds (min:1, max:999)</p>"
32828           },
32829           {
32830             "group": "Body",
32831             "type": "String",
32832             "optional": true,
32833             "field": "dialQueueProject",
32834             "description": "<p>AGI queue option (use: agi://127.0.0.1/square,&lt;project_name&gt;)</p>"
32835           },
32836           {
32837             "group": "Body",
32838             "type": "Integer",
32839             "optional": true,
32840             "field": "dialCongestionMaxRetry",
32841             "description": "<p>#Congestion Retry (min:1, max:999)</p>"
32842           },
32843           {
32844             "group": "Body",
32845             "type": "Integer",
32846             "optional": true,
32847             "field": "dialCongestionRetryFrequency",
32848             "description": "<p>Congestion Retry Frequency Minutes (min:1, max:99999)</p>"
32849           },
32850           {
32851             "group": "Body",
32852             "type": "Integer",
32853             "optional": true,
32854             "field": "dialBusyMaxRetry",
32855             "description": "<p>#Busy Retry (min:1, max:999)</p>"
32856           },
32857           {
32858             "group": "Body",
32859             "type": "Integer",
32860             "optional": true,
32861             "field": "dialBusyRetryFrequency",
32862             "description": "<p>Busy Retry Frequency Minutes (min:1, max:99999)</p>"
32863           },
32864           {
32865             "group": "Body",
32866             "type": "Integer",
32867             "optional": true,
32868             "field": "dialNoAnswerMaxRetry",
32869             "description": "<p>#NoAnswer Retry (min:1, max:999)</p>"
32870           },
32871           {
32872             "group": "Body",
32873             "type": "Integer",
32874             "optional": true,
32875             "field": "dialNoAnswerRetryFrequency",
32876             "description": "<p>NoAnswer Retry Frequency Minutes (min:1, max:99999)</p>"
32877           },
32878           {
32879             "group": "Body",
32880             "type": "Integer",
32881             "optional": true,
32882             "field": "dialGlobalMaxRetry",
32883             "description": "<p>#Global Max Retry (min:1, max:999)</p>"
32884           },
32885           {
32886             "group": "Body",
32887             "type": "String",
32888             "optional": true,
32889             "field": "dialTimezone",
32890             "description": ""
32891           },
32892           {
32893             "group": "Body",
32894             "type": "String",
32895             "optional": true,
32896             "field": "dialGlobalInterval",
32897             "description": ""
32898           },
32899           {
32900             "group": "Body",
32901             "type": "String",
32902             "optional": true,
32903             "field": "dialPrefix",
32904             "description": ""
32905           },
32906           {
32907             "group": "Body",
32908             "type": "String",
32909             "allowedValues": [
32910               "\"always\"",
32911               "\"never\"",
32912               "\"onlyIfOpen\""
32913             ],
32914             "optional": true,
32915             "field": "dialCheckDuplicateType",
32916             "description": ""
32917           },
32918           {
32919             "group": "Body",
32920             "type": "Boolean",
32921             "optional": true,
32922             "field": "dialAMDActive",
32923             "description": "<p>Active/Disactive AMD</p>"
32924           },
32925           {
32926             "group": "Body",
32927             "type": "Integer",
32928             "optional": true,
32929             "field": "dialAMDInitialSilence",
32930             "description": "<p>#AMD Initial Silence</p>"
32931           },
32932           {
32933             "group": "Body",
32934             "type": "Integer",
32935             "optional": true,
32936             "field": "dialAMDGreeting",
32937             "description": "<p>#AMD Greeting</p>"
32938           },
32939           {
32940             "group": "Body",
32941             "type": "Integer",
32942             "optional": true,
32943             "field": "dialAMDAfterGreetingSilence",
32944             "description": "<p>#AMD After Greeting Silence</p>"
32945           },
32946           {
32947             "group": "Body",
32948             "type": "Integer",
32949             "optional": true,
32950             "field": "dialAMDTotalAnalysisTime",
32951             "description": "<p>#AMD Total Analysis Time</p>"
32952           },
32953           {
32954             "group": "Body",
32955             "type": "Integer",
32956             "optional": true,
32957             "field": "dialAMDMinWordLength",
32958             "description": "<p>#AMD Min Word Length</p>"
32959           },
32960           {
32961             "group": "Body",
32962             "type": "Integer",
32963             "optional": true,
32964             "field": "dialAMDBetweenWordsSilence",
32965             "description": "<p>#AMD Between Words Silence</p>"
32966           },
32967           {
32968             "group": "Body",
32969             "type": "Integer",
32970             "optional": true,
32971             "field": "dialAMDMaximumNumberOfWords",
32972             "description": "<p>#AMD Maximum Number Of Words</p>"
32973           },
32974           {
32975             "group": "Body",
32976             "type": "Integer",
32977             "optional": true,
32978             "field": "dialAMDSilenceThreshold",
32979             "description": "<p>#AMD Silence Threshold (min:0, max:32767)</p>"
32980           },
32981           {
32982             "group": "Body",
32983             "type": "Integer",
32984             "optional": true,
32985             "field": "dialAMDMaximumWordLength",
32986             "description": "<p>#AMD Maximum Word Length</p>"
32987           },
32988           {
32989             "group": "Body",
32990             "type": "Integer",
32991             "optional": true,
32992             "field": "dialRecallMeTimeout",
32993             "description": "<p>#RecallMe Timeout (min:1)</p>"
32994           },
32995           {
32996             "group": "Body",
32997             "type": "Boolean",
32998             "optional": true,
32999             "field": "dialRecallInQueue",
33000             "description": "<p>Active/Disactive Recall In Queue</p>"
33001           },
33002           {
33003             "group": "Body",
33004             "type": "String",
33005             "allowedValues": [
33006               "\"DESC\"",
33007               "\"ASC\""
33008             ],
33009             "optional": true,
33010             "field": "dialOrderByScheduledAt",
33011             "description": ""
33012           },
33013           {
33014             "group": "Body",
33015             "type": "String",
33016             "optional": true,
33017             "field": "dialQueueProject2",
33018             "description": "<p>AGI queue option (use: agi://127.0.0.1/square,&lt;project_name&gt;)</p>"
33019           },
33020           {
33021             "group": "Body",
33022             "type": "Boolean",
33023             "optional": true,
33024             "field": "dialAgiAfterHangupClient",
33025             "description": ""
33026           },
33027           {
33028             "group": "Body",
33029             "type": "Boolean",
33030             "optional": true,
33031             "field": "dialAgiAfterHangupAgent",
33032             "description": ""
33033           },
33034           {
33035             "group": "Body",
33036             "type": "Integer",
33037             "optional": true,
33038             "field": "dialRandomLastDigitCallerIdNumber",
33039             "description": "<p>Random Last Digit (min:1, max:15)</p>"
33040           },
33041           {
33042             "group": "Body",
33043             "type": "Integer",
33044             "optional": true,
33045             "field": "dialCutDigit",
33046             "description": "<p>Cut Digit (min:1, max:15)</p>"
33047           },
33048           {
33049             "group": "Body",
33050             "type": "Integer",
33051             "optional": true,
33052             "field": "dialNoSuchNumberMaxRetry",
33053             "description": "<p>#NoSuchNumber Retry (min:1, max:999)</p>"
33054           },
33055           {
33056             "group": "Body",
33057             "type": "Integer",
33058             "optional": true,
33059             "field": "dialNoSuchNumberRetryFrequency",
33060             "description": "<p>NoSuchNumber Retry Frequency Minutes (min:1, max:99999)</p>"
33061           },
33062           {
33063             "group": "Body",
33064             "type": "Integer",
33065             "optional": true,
33066             "field": "dialDropMaxRetry",
33067             "description": "<p>#Drop Retry (min:1, max:999)</p>"
33068           },
33069           {
33070             "group": "Body",
33071             "type": "Integer",
33072             "optional": true,
33073             "field": "dialDropRetryFrequency",
33074             "description": "<p>Drop Retry Frequency Minutes (min:1, max:99999)</p>"
33075           },
33076           {
33077             "group": "Body",
33078             "type": "Integer",
33079             "optional": true,
33080             "field": "dialAbandonedMaxRetry",
33081             "description": "<p>#Abandoned Retry (min:1, max:999)</p>"
33082           },
33083           {
33084             "group": "Body",
33085             "type": "Integer",
33086             "optional": true,
33087             "field": "dialAbandonedRetryFrequency",
33088             "description": "<p>Abandoned Retry Frequency Minutes (min:1, max:99999)</p>"
33089           },
33090           {
33091             "group": "Body",
33092             "type": "Integer",
33093             "optional": true,
33094             "field": "dialMachineMaxRetry",
33095             "description": "<p>#Machine Retry (min:1, max:999)</p>"
33096           },
33097           {
33098             "group": "Body",
33099             "type": "Integer",
33100             "optional": true,
33101             "field": "dialMachineRetryFrequency",
33102             "description": "<p>Machine Retry Frequency Minutes (min:1, max:99999)</p>"
33103           },
33104           {
33105             "group": "Body",
33106             "type": "Integer",
33107             "optional": true,
33108             "field": "dialAgentRejectMaxRetry",
33109             "description": "<p>#AgentReject Retry (min:1, max:999)</p>"
33110           },
33111           {
33112             "group": "Body",
33113             "type": "Integer",
33114             "optional": true,
33115             "field": "dialAgentRejectRetryFrequency",
33116             "description": "<p>AgentReject Retry Frequency Minutes (min:1, max:99999)</p>"
33117           },
33118           {
33119             "group": "Body",
33120             "type": "Integer",
33121             "optional": true,
33122             "field": "mandatoryDispositionPauseId",
33123             "description": "<p>Status to put when mandatory disposition is enabled</p>"
33124           },
33125           {
33126             "group": "Body",
33127             "type": "Boolean",
33128             "optional": true,
33129             "field": "mandatoryDisposition",
33130             "description": "<p>Enabled/disables mandatory dispo on a queue</p>"
33131           },
33132           {
33133             "group": "Body",
33134             "type": "Integer",
33135             "optional": true,
33136             "field": "dialPredictiveIntervalMaxThreshold",
33137             "description": ""
33138           },
33139           {
33140             "group": "Body",
33141             "type": "Integer",
33142             "optional": true,
33143             "field": "dialPredictiveIntervalMinThreshold",
33144             "description": ""
33145           }
33146         ]
33147       }
33148     },
33149     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33150     "version": "0.0.0",
33151     "filename": "server/api/voiceQueue/index.js",
33152     "groupTitle": "Voice_Queues"
33153   },
33154   {
33155     "type": "delete",
33156     "url": "/api/voice/queues/{id}",
33157     "title": "Deletes a Queue",
33158     "examples": [
33159       {
33160         "title": "Example usage:",
33161         "content": "curl https://{domain}/api/voice/queues/{id} -v -u {name}:{password} -X DELETE",
33162         "type": "json"
33163       }
33164     ],
33165     "name": "DeleteQueues",
33166     "group": "Voice_Queues",
33167     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33168     "version": "0.0.0",
33169     "filename": "server/api/voiceQueue/index.js",
33170     "groupTitle": "Voice_Queues"
33171   },
33172   {
33173     "type": "get",
33174     "url": "/api/voice/queues/{id}/users",
33175     "title": "Gets queue agents",
33176     "examples": [
33177       {
33178         "title": "Example usage:",
33179         "content": "curl https://{domain}/api/voice/queues/{id}/users -v -u {name}:{password} -X GET",
33180         "type": "json"
33181       }
33182     ],
33183     "name": "GetAgents",
33184     "group": "Voice_Queues",
33185     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33186     "version": "0.0.0",
33187     "filename": "server/api/voiceQueue/index.js",
33188     "groupTitle": "Voice_Queues"
33189   },
33190   {
33191     "type": "get",
33192     "url": "/api/voice/queues/{id}/blacklists",
33193     "title": "Get queue blacklists",
33194     "examples": [
33195       {
33196         "title": "Example usage:",
33197         "content": "curl https://{domain}/api/voice/queues/{id}/blacklists -v -u {name}:{password} -X GET",
33198         "type": "json"
33199       }
33200     ],
33201     "name": "GetBlackLists",
33202     "group": "Voice_Queues",
33203     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33204     "version": "0.0.0",
33205     "filename": "server/api/voiceQueue/index.js",
33206     "groupTitle": "Voice_Queues"
33207   },
33208   {
33209     "type": "get",
33210     "url": "/api/voice/queues/{id}/finals",
33211     "title": "Gets queue hopper finals",
33212     "examples": [
33213       {
33214         "title": "Example usage:",
33215         "content": "curl https://{domain}/api/voice/queues/{id}/hopper_finals -v -u {name}:{password}  -X GET",
33216         "type": "json"
33217       }
33218     ],
33219     "name": "GetHopperFinals",
33220     "group": "Voice_Queues",
33221     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33222     "version": "0.0.0",
33223     "filename": "server/api/voiceQueue/index.js",
33224     "groupTitle": "Voice_Queues"
33225   },
33226   {
33227     "type": "get",
33228     "url": "/api/voice/queues/{id}/hopper_histories",
33229     "title": "Gets queue hopper histories",
33230     "examples": [
33231       {
33232         "title": "Example usage:",
33233         "content": "curl https://{domain}/api/voice/queues/{id}/hopper_histories -v -u {name}:{password} -X GET",
33234         "type": "json"
33235       }
33236     ],
33237     "name": "GetHopperHistories",
33238     "group": "Voice_Queues",
33239     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33240     "version": "0.0.0",
33241     "filename": "server/api/voiceQueue/index.js",
33242     "groupTitle": "Voice_Queues"
33243   },
33244   {
33245     "type": "get",
33246     "url": "/api/voice/queues/{id}/hoppers",
33247     "title": "Gets queue hoppers",
33248     "examples": [
33249       {
33250         "title": "Example usage:",
33251         "content": "curl https://{domain}/api/voice/queues/{id}/hoppers -v -u {name}:{password} -X GET",
33252         "type": "json"
33253       }
33254     ],
33255     "name": "GetHoppers",
33256     "group": "Voice_Queues",
33257     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33258     "version": "0.0.0",
33259     "filename": "server/api/voiceQueue/index.js",
33260     "groupTitle": "Voice_Queues"
33261   },
33262   {
33263     "type": "get",
33264     "url": "/api/voice/queues/{id}/lists",
33265     "title": "Get queue lists",
33266     "examples": [
33267       {
33268         "title": "Example usage:",
33269         "content": "curl https://{domain}/api/voice/queues/{id}/lists -v -u {name}:{password} -X GET",
33270         "type": "json"
33271       }
33272     ],
33273     "name": "GetLists",
33274     "group": "Voice_Queues",
33275     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33276     "version": "0.0.0",
33277     "filename": "server/api/voiceQueue/index.js",
33278     "groupTitle": "Voice_Queues"
33279   },
33280   {
33281     "type": "get",
33282     "url": "/api/voice/queues/{id}/members",
33283     "title": "Gets queue members",
33284     "examples": [
33285       {
33286         "title": "Example usage:",
33287         "content": "curl https://{domain}/api/voice/queues/{id}/members -v -u {name}:{password} -X GET",
33288         "type": "json"
33289       }
33290     ],
33291     "name": "GetMembers",
33292     "group": "Voice_Queues",
33293     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33294     "version": "0.0.0",
33295     "filename": "server/api/voiceQueue/index.js",
33296     "groupTitle": "Voice_Queues"
33297   },
33298   {
33299     "type": "get",
33300     "url": "/api/voice/queues",
33301     "title": "Gets a list of Queues",
33302     "examples": [
33303       {
33304         "title": "Example usage:",
33305         "content": "curl https://{domain}/api/voice/queues -v -u {name}:{password}",
33306         "type": "json"
33307       }
33308     ],
33309     "name": "GetQueues",
33310     "group": "Voice_Queues",
33311     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
33312     "version": "0.0.0",
33313     "filename": "server/api/voiceQueue/index.js",
33314     "groupTitle": "Voice_Queues"
33315   },
33316   {
33317     "type": "get",
33318     "url": "/api/voice/queues/{id}/teams",
33319     "title": "Gets queue team",
33320     "examples": [
33321       {
33322         "title": "Example usage:",
33323         "content": "curl https://{domain}/api/voice/queues/{id}/teams -v -u {name}:{password}  -X GET",
33324         "type": "json"
33325       }
33326     ],
33327     "name": "GetTeams",
33328     "group": "Voice_Queues",
33329     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33330     "version": "0.0.0",
33331     "filename": "server/api/voiceQueue/index.js",
33332     "groupTitle": "Voice_Queues"
33333   },
33334   {
33335     "type": "delete",
33336     "url": "/api/voice/queues/{id}/users",
33337     "title": "Removes agents from a queue",
33338     "examples": [
33339       {
33340         "title": "Example usage:",
33341         "content": "curl https://{domain}/api/voice/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
33342         "type": "json"
33343       }
33344     ],
33345     "name": "RemoveAgents",
33346     "group": "Voice_Queues",
33347     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33348     "version": "0.0.0",
33349     "filename": "server/api/voiceQueue/index.js",
33350     "groupTitle": "Voice_Queues"
33351   },
33352   {
33353     "type": "delete",
33354     "url": "/api/voice/queues/{id}/blacklists",
33355     "title": "Remove blacklists from a queue",
33356     "examples": [
33357       {
33358         "title": "Example usage:",
33359         "content": "curl https://{domain}/api/voice/queues/{id}/blacklists?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
33360         "type": "json"
33361       }
33362     ],
33363     "name": "RemoveBlackLists",
33364     "group": "Voice_Queues",
33365     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33366     "version": "0.0.0",
33367     "filename": "server/api/voiceQueue/index.js",
33368     "groupTitle": "Voice_Queues"
33369   },
33370   {
33371     "type": "delete",
33372     "url": "/api/voice/queues/{id}/lists",
33373     "title": "Remove lists from a queue",
33374     "examples": [
33375       {
33376         "title": "Example usage:",
33377         "content": "curl https://{domain}/api/voice/queues/{id}/lists?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
33378         "type": "json"
33379       }
33380     ],
33381     "name": "RemoveLists",
33382     "group": "Voice_Queues",
33383     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33384     "version": "0.0.0",
33385     "filename": "server/api/voiceQueue/index.js",
33386     "groupTitle": "Voice_Queues"
33387   },
33388   {
33389     "type": "get",
33390     "url": "/api/voice/queues/{id}",
33391     "title": "Gets a single Queue",
33392     "examples": [
33393       {
33394         "title": "Example usage:",
33395         "content": "curl https://{domain}/api/voice/queues/{id} -v -u {name}:{password}",
33396         "type": "json"
33397       }
33398     ],
33399     "name": "ShowQueues",
33400     "group": "Voice_Queues",
33401     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33402     "version": "0.0.0",
33403     "filename": "server/api/voiceQueue/index.js",
33404     "groupTitle": "Voice_Queues"
33405   },
33406   {
33407     "type": "get",
33408     "url": "/api/voice/queues/{id}/blacks",
33409     "title": "Gets queue hopper blacks",
33410     "examples": [
33411       {
33412         "title": "Example usage:",
33413         "content": "curl https://{domain}/api/voice/queues/{id}/hopper_black -v -u {name}:{password}  -X GET",
33414         "type": "json"
33415       }
33416     ],
33417     "name": "getHopperBlacks",
33418     "group": "Voice_Queues",
33419     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33420     "version": "0.0.0",
33421     "filename": "server/api/voiceQueue/index.js",
33422     "groupTitle": "Voice_Queues"
33423   },
33424   {
33425     "type": "put",
33426     "url": "/api/voice/queues/{id}",
33427     "title": "Update an existing Queue",
33428     "examples": [
33429       {
33430         "title": "Example usage:",
33431         "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",
33432         "type": "json"
33433       }
33434     ],
33435     "name": "updateQueues",
33436     "group": "Voice_Queues",
33437     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33438     "version": "0.0.0",
33439     "filename": "server/api/voiceQueue/index.js",
33440     "groupTitle": "Voice_Queues"
33441   },
33442   {
33443     "type": "post",
33444     "url": "/api/voice/recordings",
33445     "title": "Creates a new Recording",
33446     "examples": [
33447       {
33448         "title": "Example usage:",
33449         "content": "curl https://{domain}/api/voice/recordings -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
33450         "type": "json"
33451       }
33452     ],
33453     "name": "CreateRecordings",
33454     "group": "Voice_Recordings",
33455     "parameter": {
33456       "fields": {
33457         "Body": [
33458           {
33459             "group": "Body",
33460             "type": "Virtual",
33461             "optional": true,
33462             "field": "format",
33463             "description": ""
33464           },
33465           {
33466             "group": "Body",
33467             "type": "String",
33468             "optional": true,
33469             "field": "uniqueid",
33470             "description": ""
33471           },
33472           {
33473             "group": "Body",
33474             "type": "String",
33475             "optional": true,
33476             "field": "channel",
33477             "description": ""
33478           },
33479           {
33480             "group": "Body",
33481             "type": "String",
33482             "optional": true,
33483             "field": "membername",
33484             "description": ""
33485           },
33486           {
33487             "group": "Body",
33488             "type": "String",
33489             "optional": true,
33490             "field": "calleridnum",
33491             "description": ""
33492           },
33493           {
33494             "group": "Body",
33495             "type": "String",
33496             "optional": true,
33497             "field": "calleridname",
33498             "description": ""
33499           },
33500           {
33501             "group": "Body",
33502             "type": "String",
33503             "optional": true,
33504             "field": "connectedlinenum",
33505             "description": ""
33506           },
33507           {
33508             "group": "Body",
33509             "type": "String",
33510             "optional": true,
33511             "field": "connectedlinename",
33512             "description": ""
33513           },
33514           {
33515             "group": "Body",
33516             "type": "String",
33517             "optional": true,
33518             "field": "accountcode",
33519             "description": ""
33520           },
33521           {
33522             "group": "Body",
33523             "type": "String",
33524             "optional": true,
33525             "field": "context",
33526             "description": ""
33527           },
33528           {
33529             "group": "Body",
33530             "type": "String",
33531             "optional": true,
33532             "field": "exten",
33533             "description": ""
33534           },
33535           {
33536             "group": "Body",
33537             "type": "String",
33538             "optional": true,
33539             "field": "value",
33540             "description": ""
33541           },
33542           {
33543             "group": "Body",
33544             "type": "String",
33545             "optional": true,
33546             "field": "type",
33547             "description": ""
33548           },
33549           {
33550             "group": "Body",
33551             "type": "Integer",
33552             "optional": true,
33553             "field": "rating",
33554             "description": ""
33555           },
33556           {
33557             "group": "Body",
33558             "type": "String",
33559             "optional": true,
33560             "field": "queue",
33561             "description": ""
33562           },
33563           {
33564             "group": "Body",
33565             "type": "String",
33566             "optional": true,
33567             "field": "userDisposition",
33568             "description": ""
33569           },
33570           {
33571             "group": "Body",
33572             "type": "String",
33573             "optional": true,
33574             "field": "userSecondDisposition",
33575             "description": ""
33576           },
33577           {
33578             "group": "Body",
33579             "type": "String",
33580             "optional": true,
33581             "field": "userThirdDisposition",
33582             "description": ""
33583           },
33584           {
33585             "group": "Body",
33586             "type": "Text",
33587             "optional": true,
33588             "field": "location",
33589             "description": ""
33590           },
33591           {
33592             "group": "Body",
33593             "type": "String",
33594             "optional": true,
33595             "field": "transcribeName",
33596             "description": ""
33597           },
33598           {
33599             "group": "Body",
33600             "type": "String",
33601             "optional": true,
33602             "field": "transcribeStatus",
33603             "description": ""
33604           },
33605           {
33606             "group": "Body",
33607             "type": "Text",
33608             "optional": true,
33609             "field": "fileUri",
33610             "description": ""
33611           },
33612           {
33613             "group": "Body",
33614             "type": "Text",
33615             "optional": true,
33616             "field": "fileText",
33617             "description": ""
33618           },
33619           {
33620             "group": "Body",
33621             "type": "Text",
33622             "optional": true,
33623             "field": "failureReason",
33624             "description": ""
33625           },
33626           {
33627             "group": "Body",
33628             "type": "String",
33629             "optional": true,
33630             "field": "sentiment",
33631             "description": ""
33632           },
33633           {
33634             "group": "Body",
33635             "type": "Float",
33636             "optional": true,
33637             "field": "sPositive",
33638             "description": ""
33639           },
33640           {
33641             "group": "Body",
33642             "type": "Float",
33643             "optional": true,
33644             "field": "sNegative",
33645             "description": ""
33646           },
33647           {
33648             "group": "Body",
33649             "type": "Float",
33650             "optional": true,
33651             "field": "sNeutral",
33652             "description": ""
33653           },
33654           {
33655             "group": "Body",
33656             "type": "Float",
33657             "optional": true,
33658             "field": "sMixed",
33659             "description": ""
33660           },
33661           {
33662             "group": "Body",
33663             "type": "Boolean",
33664             "optional": true,
33665             "field": "tempSentiment",
33666             "description": ""
33667           },
33668           {
33669             "group": "Body",
33670             "type": "String",
33671             "optional": true,
33672             "field": "createdAt",
33673             "description": ""
33674           },
33675           {
33676             "group": "Body",
33677             "type": "String",
33678             "optional": true,
33679             "field": "updatedAt",
33680             "description": ""
33681           }
33682         ]
33683       }
33684     },
33685     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33686     "version": "0.0.0",
33687     "filename": "server/api/voiceRecording/index.js",
33688     "groupTitle": "Voice_Recordings"
33689   },
33690   {
33691     "type": "get",
33692     "url": "/api/voice/recordings/describe",
33693     "title": "Gets table info about Recordings",
33694     "examples": [
33695       {
33696         "title": "Example usage:",
33697         "content": "curl https://{domain}/api/voice/recordings/describe -v -u {name}:{password}",
33698         "type": "json"
33699       }
33700     ],
33701     "name": "DescribeRecordings",
33702     "group": "Voice_Recordings",
33703     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33704     "version": "0.0.0",
33705     "filename": "server/api/voiceRecording/index.js",
33706     "groupTitle": "Voice_Recordings"
33707   },
33708   {
33709     "type": "get",
33710     "url": "/api/voice/recordings",
33711     "title": "Gets a list of Recordings",
33712     "examples": [
33713       {
33714         "title": "Example usage:",
33715         "content": "curl https://{domain}/api/voice/recordings -v -u {name}:{password}",
33716         "type": "json"
33717       }
33718     ],
33719     "name": "GetRecordings",
33720     "group": "Voice_Recordings",
33721     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
33722     "version": "0.0.0",
33723     "filename": "server/api/voiceRecording/index.js",
33724     "groupTitle": "Voice_Recordings"
33725   },
33726   {
33727     "type": "get",
33728     "url": "/api/voice/recordings/{id}",
33729     "title": "Gets a single Recording",
33730     "examples": [
33731       {
33732         "title": "Example usage:",
33733         "content": "curl https://{domain}/api/voice/recordings/{id} -v -u {name}:{password}",
33734         "type": "json"
33735       }
33736     ],
33737     "name": "ShowRecordings",
33738     "group": "Voice_Recordings",
33739     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33740     "version": "0.0.0",
33741     "filename": "server/api/voiceRecording/index.js",
33742     "groupTitle": "Voice_Recordings"
33743   },
33744   {
33745     "type": "delete",
33746     "url": "/api/voice/recordings/{id}",
33747     "title": "Delete voice recording",
33748     "examples": [
33749       {
33750         "title": "Example usage:",
33751         "content": "curl https://{domain}/api/voice/recordings/{id} -v -u {name}:{password} -X DELETE",
33752         "type": "json"
33753       }
33754     ],
33755     "name": "destroy",
33756     "group": "Voice_Recordings",
33757     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33758     "version": "0.0.0",
33759     "filename": "server/api/voiceRecording/index.js",
33760     "groupTitle": "Voice_Recordings"
33761   },
33762   {
33763     "type": "get",
33764     "url": "/api/voice/recordings/{id}/download",
33765     "title": "Download Recording",
33766     "examples": [
33767       {
33768         "title": "Example usage:",
33769         "content": "curl https://{domain}/api/voice/recordings/{id}/download -v -u {name}:{password} -X GET",
33770         "type": "json"
33771       }
33772     ],
33773     "name": "download",
33774     "group": "Voice_Recordings",
33775     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33776     "version": "0.0.0",
33777     "filename": "server/api/voiceRecording/index.js",
33778     "groupTitle": "Voice_Recordings"
33779   },
33780   {
33781     "type": "get",
33782     "url": "/api/voice/recordings/{id}/downloads",
33783     "title": "Download Recording",
33784     "examples": [
33785       {
33786         "title": "Example usage:",
33787         "content": "curl https://{domain}/api/voice/recordings/{id}/downloads -v -u {name}:{password} -X GET",
33788         "type": "json"
33789       }
33790     ],
33791     "name": "downloads",
33792     "group": "Voice_Recordings",
33793     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33794     "version": "0.0.0",
33795     "filename": "server/api/voiceRecording/index.js",
33796     "groupTitle": "Voice_Recordings"
33797   },
33798   {
33799     "type": "post",
33800     "url": "/api/voice/recordings/{id}/transcribe",
33801     "title": "Run Transcribe Recording",
33802     "examples": [
33803       {
33804         "title": "Example usage:",
33805         "content": "curl https://{domain}/api/voice/recordings/{id}/transcribe -d '{\"runSentiment\": \"true\"}' -v -u {name}:{password} -X POST",
33806         "type": "json"
33807       }
33808     ],
33809     "name": "transcribe",
33810     "group": "Voice_Recordings",
33811     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33812     "version": "0.0.0",
33813     "filename": "server/api/voiceRecording/index.js",
33814     "groupTitle": "Voice_Recordings"
33815   },
33816   {
33817     "type": "get",
33818     "url": "/api/voice/recordings/{id}/transcribe",
33819     "title": "Run Transcribe Recording",
33820     "examples": [
33821       {
33822         "title": "Example usage:",
33823         "content": "curl https://{domain}/api/voice/recordings/{id}/transcribe -v -u {name}:{password} -X GET",
33824         "type": "json"
33825       }
33826     ],
33827     "name": "transcribe",
33828     "group": "Voice_Recordings",
33829     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33830     "version": "0.0.0",
33831     "filename": "server/api/voiceRecording/index.js",
33832     "groupTitle": "Voice_Recordings"
33833   },
33834   {
33835     "type": "put",
33836     "url": "/api/voice/recordings/{id}",
33837     "title": "Update an existing Recording",
33838     "examples": [
33839       {
33840         "title": "Example usage:",
33841         "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",
33842         "type": "json"
33843       }
33844     ],
33845     "name": "updateRecordings",
33846     "group": "Voice_Recordings",
33847     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33848     "version": "0.0.0",
33849     "filename": "server/api/voiceRecording/index.js",
33850     "groupTitle": "Voice_Recordings"
33851   },
33852   {
33853     "type": "post",
33854     "url": "/api/voice/transfers/reports",
33855     "title": "Creates a new Transfer Report",
33856     "examples": [
33857       {
33858         "title": "Example usage:",
33859         "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",
33860         "type": "json"
33861       }
33862     ],
33863     "name": "CreateTransfer_Reports",
33864     "group": "Voice_Transfer_Reports",
33865     "parameter": {
33866       "fields": {
33867         "Body": [
33868           {
33869             "group": "Body",
33870             "type": "String",
33871             "allowedValues": [
33872               "\"blind\"",
33873               "\"attended\""
33874             ],
33875             "optional": true,
33876             "field": "type",
33877             "description": ""
33878           },
33879           {
33880             "group": "Body",
33881             "type": "String",
33882             "optional": true,
33883             "field": "result",
33884             "description": ""
33885           },
33886           {
33887             "group": "Body",
33888             "type": "String",
33889             "optional": true,
33890             "field": "transfererchannel",
33891             "description": ""
33892           },
33893           {
33894             "group": "Body",
33895             "type": "String",
33896             "optional": true,
33897             "field": "transferercalleridnum",
33898             "description": ""
33899           },
33900           {
33901             "group": "Body",
33902             "type": "String",
33903             "optional": true,
33904             "field": "transferercalleridname",
33905             "description": ""
33906           },
33907           {
33908             "group": "Body",
33909             "type": "String",
33910             "optional": true,
33911             "field": "transfererconnectedlinenum",
33912             "description": ""
33913           },
33914           {
33915             "group": "Body",
33916             "type": "String",
33917             "optional": true,
33918             "field": "transfererconnectedlinename",
33919             "description": ""
33920           },
33921           {
33922             "group": "Body",
33923             "type": "String",
33924             "optional": true,
33925             "field": "transfereraccountcode",
33926             "description": ""
33927           },
33928           {
33929             "group": "Body",
33930             "type": "String",
33931             "optional": true,
33932             "field": "transferercontext",
33933             "description": ""
33934           },
33935           {
33936             "group": "Body",
33937             "type": "String",
33938             "optional": true,
33939             "field": "transfererexten",
33940             "description": ""
33941           },
33942           {
33943             "group": "Body",
33944             "type": "String",
33945             "optional": true,
33946             "field": "transfererlinkedid",
33947             "description": ""
33948           },
33949           {
33950             "group": "Body",
33951             "type": "String",
33952             "optional": true,
33953             "field": "transfereechannel",
33954             "description": ""
33955           },
33956           {
33957             "group": "Body",
33958             "type": "String",
33959             "optional": true,
33960             "field": "transfereecalleridnum",
33961             "description": ""
33962           },
33963           {
33964             "group": "Body",
33965             "type": "String",
33966             "optional": true,
33967             "field": "transfereecalleridname",
33968             "description": ""
33969           },
33970           {
33971             "group": "Body",
33972             "type": "String",
33973             "optional": true,
33974             "field": "transfereeconnectedlinenum",
33975             "description": ""
33976           },
33977           {
33978             "group": "Body",
33979             "type": "String",
33980             "optional": true,
33981             "field": "transfereeconnectedlinename",
33982             "description": ""
33983           },
33984           {
33985             "group": "Body",
33986             "type": "String",
33987             "optional": true,
33988             "field": "transfereeaccountcode",
33989             "description": ""
33990           },
33991           {
33992             "group": "Body",
33993             "type": "String",
33994             "optional": true,
33995             "field": "transfereecontext",
33996             "description": ""
33997           },
33998           {
33999             "group": "Body",
34000             "type": "String",
34001             "optional": true,
34002             "field": "transfereeexten",
34003             "description": ""
34004           },
34005           {
34006             "group": "Body",
34007             "type": "String",
34008             "optional": true,
34009             "field": "transfereelinkedid",
34010             "description": ""
34011           },
34012           {
34013             "group": "Body",
34014             "type": "String",
34015             "allowedValues": [
34016               "\"Yes\"",
34017               "\"No\""
34018             ],
34019             "optional": true,
34020             "field": "isexternal",
34021             "description": ""
34022           },
34023           {
34024             "group": "Body",
34025             "type": "String",
34026             "optional": true,
34027             "field": "context",
34028             "description": ""
34029           },
34030           {
34031             "group": "Body",
34032             "type": "String",
34033             "optional": true,
34034             "field": "extension",
34035             "description": ""
34036           }
34037         ]
34038       }
34039     },
34040     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34041     "version": "0.0.0",
34042     "filename": "server/api/voiceTransferReport/index.js",
34043     "groupTitle": "Voice_Transfer_Reports"
34044   },
34045   {
34046     "type": "delete",
34047     "url": "/api/voice/transfers/reports/{id}",
34048     "title": "Deletes a Transfer Report",
34049     "examples": [
34050       {
34051         "title": "Example usage:",
34052         "content": "curl https://{domain}/api/voice/transfers/reports/{id} -v -u {name}:{password} -X DELETE",
34053         "type": "json"
34054       }
34055     ],
34056     "name": "DeleteTransfer_Reports",
34057     "group": "Voice_Transfer_Reports",
34058     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34059     "version": "0.0.0",
34060     "filename": "server/api/voiceTransferReport/index.js",
34061     "groupTitle": "Voice_Transfer_Reports"
34062   },
34063   {
34064     "type": "get",
34065     "url": "/api/voice/transfers/reports/describe",
34066     "title": "Gets table info about Transfer Reports",
34067     "examples": [
34068       {
34069         "title": "Example usage:",
34070         "content": "curl https://{domain}/api/voice/transfers/reports/describe -v -u {name}:{password}",
34071         "type": "json"
34072       }
34073     ],
34074     "name": "DescribeTransfer_Reports",
34075     "group": "Voice_Transfer_Reports",
34076     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34077     "version": "0.0.0",
34078     "filename": "server/api/voiceTransferReport/index.js",
34079     "groupTitle": "Voice_Transfer_Reports"
34080   },
34081   {
34082     "type": "get",
34083     "url": "/api/voice/transfers/reports",
34084     "title": "Gets a list of Transfer Reports",
34085     "examples": [
34086       {
34087         "title": "Example usage:",
34088         "content": "curl https://{domain}/api/voice/transfers/reports -v -u {name}:{password}",
34089         "type": "json"
34090       }
34091     ],
34092     "name": "GetTransfer_Reports",
34093     "group": "Voice_Transfer_Reports",
34094     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
34095     "version": "0.0.0",
34096     "filename": "server/api/voiceTransferReport/index.js",
34097     "groupTitle": "Voice_Transfer_Reports"
34098   },
34099   {
34100     "type": "get",
34101     "url": "/api/voice/transfers/reports/{id}",
34102     "title": "Gets a single Transfer Report",
34103     "examples": [
34104       {
34105         "title": "Example usage:",
34106         "content": "curl https://{domain}/api/voice/transfers/reports/{id} -v -u {name}:{password}",
34107         "type": "json"
34108       }
34109     ],
34110     "name": "ShowTransfer_Reports",
34111     "group": "Voice_Transfer_Reports",
34112     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34113     "version": "0.0.0",
34114     "filename": "server/api/voiceTransferReport/index.js",
34115     "groupTitle": "Voice_Transfer_Reports"
34116   },
34117   {
34118     "type": "put",
34119     "url": "/api/voice/transfers/reports/{id}",
34120     "title": "Update an existing Transfer Report",
34121     "examples": [
34122       {
34123         "title": "Example usage:",
34124         "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",
34125         "type": "json"
34126       }
34127     ],
34128     "name": "updateTransfer_Reports",
34129     "group": "Voice_Transfer_Reports",
34130     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34131     "version": "0.0.0",
34132     "filename": "server/api/voiceTransferReport/index.js",
34133     "groupTitle": "Voice_Transfer_Reports"
34134   },
34135   {
34136     "type": "post",
34137     "url": "/api/integrations/vtiger/accounts",
34138     "title": "Creates a new Vtiger Account",
34139     "examples": [
34140       {
34141         "title": "Example usage:",
34142         "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",
34143         "type": "json"
34144       }
34145     ],
34146     "name": "CreateVtiger_Accounts",
34147     "group": "Vtiger_Accounts",
34148     "parameter": {
34149       "fields": {
34150         "Body": [
34151           {
34152             "group": "Body",
34153             "type": "String",
34154             "optional": false,
34155             "field": "name",
34156             "description": ""
34157           },
34158           {
34159             "group": "Body",
34160             "type": "String",
34161             "optional": true,
34162             "field": "description",
34163             "description": ""
34164           },
34165           {
34166             "group": "Body",
34167             "type": "String",
34168             "optional": false,
34169             "field": "username",
34170             "description": ""
34171           },
34172           {
34173             "group": "Body",
34174             "type": "String",
34175             "optional": false,
34176             "field": "moduleName",
34177             "description": ""
34178           },
34179           {
34180             "group": "Body",
34181             "type": "String",
34182             "optional": false,
34183             "field": "remoteUri",
34184             "description": ""
34185           },
34186           {
34187             "group": "Body",
34188             "type": "String",
34189             "optional": false,
34190             "field": "serverUrl",
34191             "description": ""
34192           },
34193           {
34194             "group": "Body",
34195             "type": "String",
34196             "optional": false,
34197             "field": "accessKey",
34198             "description": ""
34199           }
34200         ]
34201       }
34202     },
34203     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34204     "version": "0.0.0",
34205     "filename": "server/api/intVtigerAccount/index.js",
34206     "groupTitle": "Vtiger_Accounts"
34207   },
34208   {
34209     "type": "delete",
34210     "url": "/api/integrations/vtiger/accounts/{id}",
34211     "title": "Deletes a Vtiger Account",
34212     "examples": [
34213       {
34214         "title": "Example usage:",
34215         "content": "curl https://{domain}/api/integrations/vtiger/accounts/{id} -v -u {name}:{password} -X DELETE",
34216         "type": "json"
34217       }
34218     ],
34219     "name": "DeleteVtiger_Accounts",
34220     "group": "Vtiger_Accounts",
34221     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <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/intVtigerAccount/index.js",
34224     "groupTitle": "Vtiger_Accounts"
34225   },
34226   {
34227     "type": "get",
34228     "url": "/api/integrations/vtiger/accounts",
34229     "title": "Gets a list of Vtiger Accounts",
34230     "examples": [
34231       {
34232         "title": "Example usage:",
34233         "content": "curl https://{domain}/api/integrations/vtiger/accounts -v -u {name}:{password}",
34234         "type": "json"
34235       }
34236     ],
34237     "name": "GetVtiger_Accounts",
34238     "group": "Vtiger_Accounts",
34239     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
34240     "version": "0.0.0",
34241     "filename": "server/api/intVtigerAccount/index.js",
34242     "groupTitle": "Vtiger_Accounts"
34243   },
34244   {
34245     "type": "get",
34246     "url": "/api/integrations/vtiger/accounts/{id}",
34247     "title": "Gets a single Vtiger Account",
34248     "examples": [
34249       {
34250         "title": "Example usage:",
34251         "content": "curl https://{domain}/api/integrations/vtiger/accounts/{id} -v -u {name}:{password}",
34252         "type": "json"
34253       }
34254     ],
34255     "name": "ShowVtiger_Accounts",
34256     "group": "Vtiger_Accounts",
34257     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34258     "version": "0.0.0",
34259     "filename": "server/api/intVtigerAccount/index.js",
34260     "groupTitle": "Vtiger_Accounts"
34261   },
34262   {
34263     "type": "post",
34264     "url": "/api/integrations/vtiger/accounts/{id}/configurations",
34265     "title": "Creates new configuration",
34266     "examples": [
34267       {
34268         "title": "Example usage:",
34269         "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",
34270         "type": "json"
34271       }
34272     ],
34273     "name": "addConfiguration",
34274     "group": "Vtiger_Accounts",
34275     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34276     "version": "0.0.0",
34277     "filename": "server/api/intVtigerAccount/index.js",
34278     "groupTitle": "Vtiger_Accounts"
34279   },
34280   {
34281     "type": "get",
34282     "url": "/api/integrations/vtiger/accounts/{id}/configurations",
34283     "title": "Gets account configurations",
34284     "examples": [
34285       {
34286         "title": "Example usage:",
34287         "content": "curl https://{domain}/api/integrations/vtiger/accounts/{id}/configurations -v -u {name}:{password} -X GET",
34288         "type": "json"
34289       }
34290     ],
34291     "name": "getConfigurations",
34292     "group": "Vtiger_Accounts",
34293     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34294     "version": "0.0.0",
34295     "filename": "server/api/intVtigerAccount/index.js",
34296     "groupTitle": "Vtiger_Accounts"
34297   },
34298   {
34299     "type": "get",
34300     "url": "/api/integrations/vtiger/accounts/{id}/fields",
34301     "title": "Gets account fields",
34302     "examples": [
34303       {
34304         "title": "Example usage:",
34305         "content": "curl https://{domain}/api/integrations/vtiger/accounts/{id}/fields -v -u {name}:{password} -X GET",
34306         "type": "json"
34307       }
34308     ],
34309     "name": "getFields",
34310     "group": "Vtiger_Accounts",
34311     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34312     "version": "0.0.0",
34313     "filename": "server/api/intVtigerAccount/index.js",
34314     "groupTitle": "Vtiger_Accounts"
34315   },
34316   {
34317     "type": "put",
34318     "url": "/api/integrations/vtiger/accounts/{id}",
34319     "title": "Update an existing Vtiger Account",
34320     "examples": [
34321       {
34322         "title": "Example usage:",
34323         "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",
34324         "type": "json"
34325       }
34326     ],
34327     "name": "updateVtiger_Accounts",
34328     "group": "Vtiger_Accounts",
34329     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34330     "version": "0.0.0",
34331     "filename": "server/api/intVtigerAccount/index.js",
34332     "groupTitle": "Vtiger_Accounts"
34333   },
34334   {
34335     "type": "post",
34336     "url": "/api/integrations/vtiger/configurations",
34337     "title": "Creates a new Vtiger Configuration",
34338     "examples": [
34339       {
34340         "title": "Example usage:",
34341         "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",
34342         "type": "json"
34343       }
34344     ],
34345     "name": "CreateVtiger_Configurations",
34346     "group": "Vtiger_Configurations",
34347     "parameter": {
34348       "fields": {
34349         "Body": [
34350           {
34351             "group": "Body",
34352             "type": "String",
34353             "optional": true,
34354             "field": "name",
34355             "description": ""
34356           },
34357           {
34358             "group": "Body",
34359             "type": "String",
34360             "optional": true,
34361             "field": "description",
34362             "description": ""
34363           }
34364         ]
34365       }
34366     },
34367     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34368     "version": "0.0.0",
34369     "filename": "server/api/intVtigerConfiguration/index.js",
34370     "groupTitle": "Vtiger_Configurations"
34371   },
34372   {
34373     "type": "delete",
34374     "url": "/api/integrations/vtiger/configurations/{id}",
34375     "title": "Deletes a Vtiger Configuration",
34376     "examples": [
34377       {
34378         "title": "Example usage:",
34379         "content": "curl https://{domain}/api/integrations/vtiger/configurations/{id} -v -u {name}:{password} -X DELETE",
34380         "type": "json"
34381       }
34382     ],
34383     "name": "DeleteVtiger_Configurations",
34384     "group": "Vtiger_Configurations",
34385     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34386     "version": "0.0.0",
34387     "filename": "server/api/intVtigerConfiguration/index.js",
34388     "groupTitle": "Vtiger_Configurations"
34389   },
34390   {
34391     "type": "get",
34392     "url": "/api/integrations/vtiger/configurations",
34393     "title": "Gets a list of Vtiger Configurations",
34394     "examples": [
34395       {
34396         "title": "Example usage:",
34397         "content": "curl https://{domain}/api/integrations/vtiger/configurations -v -u {name}:{password}",
34398         "type": "json"
34399       }
34400     ],
34401     "name": "GetVtiger_Configurations",
34402     "group": "Vtiger_Configurations",
34403     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
34404     "version": "0.0.0",
34405     "filename": "server/api/intVtigerConfiguration/index.js",
34406     "groupTitle": "Vtiger_Configurations"
34407   },
34408   {
34409     "type": "get",
34410     "url": "/api/integrations/vtiger/configurations/{id}",
34411     "title": "Gets a single Vtiger Configuration",
34412     "examples": [
34413       {
34414         "title": "Example usage:",
34415         "content": "curl https://{domain}/api/integrations/vtiger/configurations/{id} -v -u {name}:{password}",
34416         "type": "json"
34417       }
34418     ],
34419     "name": "ShowVtiger_Configurations",
34420     "group": "Vtiger_Configurations",
34421     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34422     "version": "0.0.0",
34423     "filename": "server/api/intVtigerConfiguration/index.js",
34424     "groupTitle": "Vtiger_Configurations"
34425   },
34426   {
34427     "type": "get",
34428     "url": "/api/integrations/vtiger/configurations/{id}/descriptions",
34429     "title": "Gets configurations descriptions",
34430     "examples": [
34431       {
34432         "title": "Example usage:",
34433         "content": "curl https://{domain}/api/integrations/vtiger/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
34434         "type": "json"
34435       }
34436     ],
34437     "name": "getDescriptions",
34438     "group": "Vtiger_Configurations",
34439     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34440     "version": "0.0.0",
34441     "filename": "server/api/intVtigerConfiguration/index.js",
34442     "groupTitle": "Vtiger_Configurations"
34443   },
34444   {
34445     "type": "get",
34446     "url": "/api/integrations/vtiger/configurations/{id}/fields",
34447     "title": "Gets configurations fields",
34448     "examples": [
34449       {
34450         "title": "Example usage:",
34451         "content": "curl https://{domain}/api/integrations/vtiger/configurations/{id}/fields -v -u {name}:{password} -X GET",
34452         "type": "json"
34453       }
34454     ],
34455     "name": "getFields",
34456     "group": "Vtiger_Configurations",
34457     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34458     "version": "0.0.0",
34459     "filename": "server/api/intVtigerConfiguration/index.js",
34460     "groupTitle": "Vtiger_Configurations"
34461   },
34462   {
34463     "type": "get",
34464     "url": "/api/integrations/vtiger/configurations/{id}/subjects",
34465     "title": "Gets configurations subjects",
34466     "examples": [
34467       {
34468         "title": "Example usage:",
34469         "content": "curl https://{domain}/api/integrations/vtiger/configurations/{id}/subjects -v -u {name}:{password} -X GET",
34470         "type": "json"
34471       }
34472     ],
34473     "name": "getSubjects",
34474     "group": "Vtiger_Configurations",
34475     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34476     "version": "0.0.0",
34477     "filename": "server/api/intVtigerConfiguration/index.js",
34478     "groupTitle": "Vtiger_Configurations"
34479   },
34480   {
34481     "type": "put",
34482     "url": "/api/integrations/vtiger/configurations/{id}",
34483     "title": "Update an existing Vtiger Configuration",
34484     "examples": [
34485       {
34486         "title": "Example usage:",
34487         "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",
34488         "type": "json"
34489       }
34490     ],
34491     "name": "updateVtiger_Configurations",
34492     "group": "Vtiger_Configurations",
34493     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34494     "version": "0.0.0",
34495     "filename": "server/api/intVtigerConfiguration/index.js",
34496     "groupTitle": "Vtiger_Configurations"
34497   },
34498   {
34499     "type": "post",
34500     "url": "/api/integrations/vtiger/fields",
34501     "title": "Creates a new Vtiger Field",
34502     "examples": [
34503       {
34504         "title": "Example usage:",
34505         "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",
34506         "type": "json"
34507       }
34508     ],
34509     "name": "CreateVtiger_Fields",
34510     "group": "Vtiger_Fields",
34511     "parameter": {
34512       "fields": {
34513         "Body": [
34514           {
34515             "group": "Body",
34516             "type": "String",
34517             "allowedValues": [
34518               "\"string\"",
34519               "\"variable\"",
34520               "\"customVariable\"",
34521               "\"keyValue\"",
34522               "\"picklist\""
34523             ],
34524             "optional": true,
34525             "field": "type",
34526             "description": ""
34527           },
34528           {
34529             "group": "Body",
34530             "type": "String",
34531             "optional": true,
34532             "field": "content",
34533             "description": ""
34534           },
34535           {
34536             "group": "Body",
34537             "type": "String",
34538             "optional": true,
34539             "field": "key",
34540             "description": ""
34541           },
34542           {
34543             "group": "Body",
34544             "type": "String",
34545             "allowedValues": [
34546               "\"string\"",
34547               "\"variable\"",
34548               "\"customVariable\""
34549             ],
34550             "optional": true,
34551             "field": "keyType",
34552             "description": ""
34553           },
34554           {
34555             "group": "Body",
34556             "type": "String",
34557             "optional": true,
34558             "field": "keyContent",
34559             "description": ""
34560           },
34561           {
34562             "group": "Body",
34563             "type": "String",
34564             "optional": true,
34565             "field": "idField",
34566             "description": ""
34567           },
34568           {
34569             "group": "Body",
34570             "type": "String",
34571             "optional": true,
34572             "field": "nameField",
34573             "description": ""
34574           },
34575           {
34576             "group": "Body",
34577             "type": "Boolean",
34578             "optional": true,
34579             "field": "customField",
34580             "description": ""
34581           },
34582           {
34583             "group": "Body",
34584             "type": "String",
34585             "optional": true,
34586             "field": "variableName",
34587             "description": ""
34588           }
34589         ]
34590       }
34591     },
34592     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34593     "version": "0.0.0",
34594     "filename": "server/api/intVtigerField/index.js",
34595     "groupTitle": "Vtiger_Fields"
34596   },
34597   {
34598     "type": "delete",
34599     "url": "/api/integrations/vtiger/fields/{id}",
34600     "title": "Deletes a Vtiger Field",
34601     "examples": [
34602       {
34603         "title": "Example usage:",
34604         "content": "curl https://{domain}/api/integrations/vtiger/fields/{id} -v -u {name}:{password} -X DELETE",
34605         "type": "json"
34606       }
34607     ],
34608     "name": "DeleteVtiger_Fields",
34609     "group": "Vtiger_Fields",
34610     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34611     "version": "0.0.0",
34612     "filename": "server/api/intVtigerField/index.js",
34613     "groupTitle": "Vtiger_Fields"
34614   },
34615   {
34616     "type": "get",
34617     "url": "/api/integrations/vtiger/fields",
34618     "title": "Gets a list of Vtiger Fields",
34619     "examples": [
34620       {
34621         "title": "Example usage:",
34622         "content": "curl https://{domain}/api/integrations/vtiger/fields -v -u {name}:{password}",
34623         "type": "json"
34624       }
34625     ],
34626     "name": "GetVtiger_Fields",
34627     "group": "Vtiger_Fields",
34628     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
34629     "version": "0.0.0",
34630     "filename": "server/api/intVtigerField/index.js",
34631     "groupTitle": "Vtiger_Fields"
34632   },
34633   {
34634     "type": "get",
34635     "url": "/api/integrations/vtiger/fields/{id}",
34636     "title": "Gets a single Vtiger Field",
34637     "examples": [
34638       {
34639         "title": "Example usage:",
34640         "content": "curl https://{domain}/api/integrations/vtiger/fields/{id} -v -u {name}:{password}",
34641         "type": "json"
34642       }
34643     ],
34644     "name": "ShowVtiger_Fields",
34645     "group": "Vtiger_Fields",
34646     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34647     "version": "0.0.0",
34648     "filename": "server/api/intVtigerField/index.js",
34649     "groupTitle": "Vtiger_Fields"
34650   },
34651   {
34652     "type": "put",
34653     "url": "/api/integrations/vtiger/fields/{id}",
34654     "title": "Update an existing Vtiger Field",
34655     "examples": [
34656       {
34657         "title": "Example usage:",
34658         "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",
34659         "type": "json"
34660       }
34661     ],
34662     "name": "updateVtiger_Fields",
34663     "group": "Vtiger_Fields",
34664     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34665     "version": "0.0.0",
34666     "filename": "server/api/intVtigerField/index.js",
34667     "groupTitle": "Vtiger_Fields"
34668   },
34669   {
34670     "type": "post",
34671     "url": "/api/webbar/answer",
34672     "title": "answer webrtc call",
34673     "examples": [
34674       {
34675         "title": "Example usage:",
34676         "content": "curl https://{domain}/api/webbar/answer -d '{\"sessionId\": \"<sessionId>\", \"userId\": 54}' \\\n -H \"Content-Type: application/json\" -X POST",
34677         "type": "json"
34678       }
34679     ],
34680     "name": "Web_Bar_answer",
34681     "group": "WebBar",
34682     "parameter": {
34683       "fields": {
34684         "Body": [
34685           {
34686             "group": "Body",
34687             "type": "String",
34688             "optional": false,
34689             "field": "sessionId",
34690             "description": ""
34691           },
34692           {
34693             "group": "Body",
34694             "type": "number",
34695             "optional": false,
34696             "field": "userId",
34697             "description": ""
34698           }
34699         ]
34700       }
34701     },
34702     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34703     "version": "0.0.0",
34704     "filename": "server/api/webbar/index.js",
34705     "groupTitle": "WebBar"
34706   },
34707   {
34708     "type": "post",
34709     "url": "/api/webbar/calls",
34710     "title": "webrtc call list",
34711     "examples": [
34712       {
34713         "title": "Example usage:",
34714         "content": "curl https://{domain}/api/webbar/calls -d '{\"userId\": 54}' \\\n -H \"Content-Type: application/json\" -X POST",
34715         "type": "json"
34716       }
34717     ],
34718     "name": "Web_Bar_calls",
34719     "group": "WebBar",
34720     "parameter": {
34721       "fields": {
34722         "Body": [
34723           {
34724             "group": "Body",
34725             "type": "number",
34726             "optional": false,
34727             "field": "userId",
34728             "description": ""
34729           }
34730         ]
34731       }
34732     },
34733     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34734     "version": "0.0.0",
34735     "filename": "server/api/webbar/index.js",
34736     "groupTitle": "WebBar"
34737   },
34738   {
34739     "type": "post",
34740     "url": "/api/webbar/hangup",
34741     "title": "hangup webrtc call",
34742     "examples": [
34743       {
34744         "title": "Example usage:",
34745         "content": "curl https://{domain}/api/webbar/hangup -d '{\"sessionId\": \"<sessionId>\", \"userId\": 54}' \\\n -H \"Content-Type: application/json\" -X POST",
34746         "type": "json"
34747       }
34748     ],
34749     "name": "Web_Bar_hangup",
34750     "group": "WebBar",
34751     "parameter": {
34752       "fields": {
34753         "Body": [
34754           {
34755             "group": "Body",
34756             "type": "String",
34757             "optional": false,
34758             "field": "sessionId",
34759             "description": ""
34760           },
34761           {
34762             "group": "Body",
34763             "type": "number",
34764             "optional": false,
34765             "field": "userId",
34766             "description": ""
34767           }
34768         ]
34769       }
34770     },
34771     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34772     "version": "0.0.0",
34773     "filename": "server/api/webbar/index.js",
34774     "groupTitle": "WebBar"
34775   },
34776   {
34777     "type": "post",
34778     "url": "/api/webbar/hold",
34779     "title": "hold webrtc call",
34780     "examples": [
34781       {
34782         "title": "Example usage:",
34783         "content": "curl https://{domain}/api/webbar/hold -d '{\"sessionId\": \"<sessionId>\", \"userId\": 54}' \\\n -H \"Content-Type: application/json\" -X POST",
34784         "type": "json"
34785       }
34786     ],
34787     "name": "Web_Bar_hold",
34788     "group": "WebBar",
34789     "parameter": {
34790       "fields": {
34791         "Body": [
34792           {
34793             "group": "Body",
34794             "type": "String",
34795             "optional": true,
34796             "field": "sessionId",
34797             "description": ""
34798           },
34799           {
34800             "group": "Body",
34801             "type": "number",
34802             "optional": false,
34803             "field": "userId",
34804             "description": ""
34805           }
34806         ]
34807       }
34808     },
34809     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34810     "version": "0.0.0",
34811     "filename": "server/api/webbar/index.js",
34812     "groupTitle": "WebBar"
34813   },
34814   {
34815     "type": "post",
34816     "url": "/api/webbar/unhold",
34817     "title": "unhold webrtc call",
34818     "examples": [
34819       {
34820         "title": "Example usage:",
34821         "content": "curl https://{domain}/api/webbar/unhold -d '{\"sessionId\": \"<sessionId>\", \"userId\": 54}' \\\n -H \"Content-Type: application/json\" -X POST",
34822         "type": "json"
34823       }
34824     ],
34825     "name": "Web_Bar_hold",
34826     "group": "WebBar",
34827     "parameter": {
34828       "fields": {
34829         "Body": [
34830           {
34831             "group": "Body",
34832             "type": "String",
34833             "optional": false,
34834             "field": "sessionId",
34835             "description": ""
34836           },
34837           {
34838             "group": "Body",
34839             "type": "number",
34840             "optional": false,
34841             "field": "userId",
34842             "description": ""
34843           }
34844         ]
34845       }
34846     },
34847     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34848     "version": "0.0.0",
34849     "filename": "server/api/webbar/index.js",
34850     "groupTitle": "WebBar"
34851   },
34852   {
34853     "type": "post",
34854     "url": "/api/webbar/originate",
34855     "title": "Originate new webrtc call",
34856     "examples": [
34857       {
34858         "title": "Example usage:",
34859         "content": "curl https://{domain}/api/webbar/originate -d '{\"callNumber\": \"0119692844\", \"userId\": 54}' \\\n -H \"Content-Type: application/json\" -X POST",
34860         "type": "json"
34861       }
34862     ],
34863     "name": "Web_Bar_originate",
34864     "group": "WebBar",
34865     "parameter": {
34866       "fields": {
34867         "Body": [
34868           {
34869             "group": "Body",
34870             "type": "String",
34871             "optional": false,
34872             "field": "callNumber",
34873             "description": ""
34874           },
34875           {
34876             "group": "Body",
34877             "type": "number",
34878             "optional": false,
34879             "field": "userId",
34880             "description": ""
34881           },
34882           {
34883             "group": "Body",
34884             "type": "String",
34885             "optional": false,
34886             "field": "callerId",
34887             "description": ""
34888           },
34889           {
34890             "group": "Body",
34891             "type": "String",
34892             "optional": false,
34893             "field": "callbackUrl",
34894             "description": ""
34895           }
34896         ]
34897       }
34898     },
34899     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34900     "version": "0.0.0",
34901     "filename": "server/api/webbar/index.js",
34902     "groupTitle": "WebBar"
34903   },
34904   {
34905     "type": "post",
34906     "url": "/api/webbar/transfer",
34907     "title": "blind transfer webrtc call",
34908     "examples": [
34909       {
34910         "title": "Example usage:",
34911         "content": "curl https://{domain}/api/webbar/transfer -d '{\"userId\": 54, \"sessionId\":\"<sessionId>\", \"transferNumber\":\"<transferNumber>\"}' \\\n -H \"Content-Type: application/json\" -X POST",
34912         "type": "json"
34913       }
34914     ],
34915     "name": "Web_Bar_transfer",
34916     "group": "WebBar",
34917     "parameter": {
34918       "fields": {
34919         "Body": [
34920           {
34921             "group": "Body",
34922             "type": "number",
34923             "optional": false,
34924             "field": "userId",
34925             "description": ""
34926           },
34927           {
34928             "group": "Body",
34929             "type": "string",
34930             "optional": false,
34931             "field": "sessionId",
34932             "description": ""
34933           },
34934           {
34935             "group": "Body",
34936             "type": "string",
34937             "optional": false,
34938             "field": "transferNumber",
34939             "description": ""
34940           }
34941         ]
34942       }
34943     },
34944     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34945     "version": "0.0.0",
34946     "filename": "server/api/webbar/index.js",
34947     "groupTitle": "WebBar"
34948   },
34949   {
34950     "type": "post",
34951     "url": "/api/whatsapp/accounts/{id}/users",
34952     "title": "Add agents to a whatsapp account",
34953     "examples": [
34954       {
34955         "title": "Example usage:",
34956         "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",
34957         "type": "json"
34958       }
34959     ],
34960     "name": "AddAgents",
34961     "group": "Whatsapp_Accounts",
34962     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34963     "version": "0.0.0",
34964     "filename": "server/api/whatsappAccount/index.js",
34965     "groupTitle": "Whatsapp_Accounts"
34966   },
34967   {
34968     "type": "post",
34969     "url": "/api/whatsapp/accounts",
34970     "title": "Creates a new Account",
34971     "examples": [
34972       {
34973         "title": "Example usage:",
34974         "content": "curl https://{domain}/api/whatsapp/accounts -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
34975         "type": "json"
34976       }
34977     ],
34978     "name": "CreateAccounts",
34979     "group": "Whatsapp_Accounts",
34980     "parameter": {
34981       "fields": {
34982         "Body": [
34983           {
34984             "group": "Body",
34985             "type": "String",
34986             "optional": false,
34987             "field": "name",
34988             "description": ""
34989           },
34990           {
34991             "group": "Body",
34992             "type": "String",
34993             "optional": false,
34994             "field": "key",
34995             "description": ""
34996           },
34997           {
34998             "group": "Body",
34999             "type": "String",
35000             "optional": false,
35001             "field": "remote",
35002             "description": ""
35003           },
35004           {
35005             "group": "Body",
35006             "type": "String",
35007             "optional": true,
35008             "field": "token",
35009             "description": ""
35010           },
35011           {
35012             "group": "Body",
35013             "type": "String",
35014             "optional": true,
35015             "field": "phone",
35016             "description": ""
35017           },
35018           {
35019             "group": "Body",
35020             "type": "String",
35021             "allowedValues": [
35022               "\"twilio\""
35023             ],
35024             "optional": true,
35025             "field": "type",
35026             "description": ""
35027           },
35028           {
35029             "group": "Body",
35030             "type": "String",
35031             "optional": true,
35032             "field": "accountSid",
35033             "description": ""
35034           },
35035           {
35036             "group": "Body",
35037             "type": "String",
35038             "optional": true,
35039             "field": "authToken",
35040             "description": ""
35041           },
35042           {
35043             "group": "Body",
35044             "type": "Text",
35045             "optional": true,
35046             "field": "notificationTemplate",
35047             "description": ""
35048           },
35049           {
35050             "group": "Body",
35051             "type": "Boolean",
35052             "optional": true,
35053             "field": "notificationSound",
35054             "description": ""
35055           },
35056           {
35057             "group": "Body",
35058             "type": "Boolean",
35059             "optional": true,
35060             "field": "notificationShake",
35061             "description": ""
35062           },
35063           {
35064             "group": "Body",
35065             "type": "Integer",
35066             "optional": true,
35067             "field": "waitForTheAssignedAgent",
35068             "description": ""
35069           },
35070           {
35071             "group": "Body",
35072             "type": "Boolean",
35073             "optional": true,
35074             "field": "queueTransfer",
35075             "description": ""
35076           },
35077           {
35078             "group": "Body",
35079             "type": "Integer",
35080             "optional": true,
35081             "field": "queueTransferTimeout",
35082             "description": ""
35083           },
35084           {
35085             "group": "Body",
35086             "type": "Boolean",
35087             "optional": true,
35088             "field": "agentTransfer",
35089             "description": ""
35090           },
35091           {
35092             "group": "Body",
35093             "type": "Integer",
35094             "optional": true,
35095             "field": "agentTransferTimeout",
35096             "description": ""
35097           },
35098           {
35099             "group": "Body",
35100             "type": "Integer",
35101             "optional": true,
35102             "field": "mandatoryDispositionPauseId",
35103             "description": "<p>Status to put when mandatory disposition is enabled</p>"
35104           },
35105           {
35106             "group": "Body",
35107             "type": "Boolean",
35108             "optional": true,
35109             "field": "mandatoryDisposition",
35110             "description": "<p>Enabled/disables mandatory dispo on a queue</p>"
35111           },
35112           {
35113             "group": "Body",
35114             "type": "String",
35115             "optional": true,
35116             "field": "description",
35117             "description": ""
35118           }
35119         ]
35120       }
35121     },
35122     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35123     "version": "0.0.0",
35124     "filename": "server/api/whatsappAccount/index.js",
35125     "groupTitle": "Whatsapp_Accounts"
35126   },
35127   {
35128     "type": "delete",
35129     "url": "/api/whatsapp/accounts/{id}",
35130     "title": "Deletes a Account",
35131     "examples": [
35132       {
35133         "title": "Example usage:",
35134         "content": "curl https://{domain}/api/whatsapp/accounts/{id} -v -u {name}:{password} -X DELETE",
35135         "type": "json"
35136       }
35137     ],
35138     "name": "DeleteAccounts",
35139     "group": "Whatsapp_Accounts",
35140     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35141     "version": "0.0.0",
35142     "filename": "server/api/whatsappAccount/index.js",
35143     "groupTitle": "Whatsapp_Accounts"
35144   },
35145   {
35146     "type": "get",
35147     "url": "/api/whatsapp/accounts/describe",
35148     "title": "Gets table info about Accounts",
35149     "examples": [
35150       {
35151         "title": "Example usage:",
35152         "content": "curl https://{domain}/api/whatsapp/accounts/describe -v -u {name}:{password}",
35153         "type": "json"
35154       }
35155     ],
35156     "name": "DescribeAccounts",
35157     "group": "Whatsapp_Accounts",
35158     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35159     "version": "0.0.0",
35160     "filename": "server/api/whatsappAccount/index.js",
35161     "groupTitle": "Whatsapp_Accounts"
35162   },
35163   {
35164     "type": "get",
35165     "url": "/api/whatsapp/accounts",
35166     "title": "Gets a list of Accounts",
35167     "examples": [
35168       {
35169         "title": "Example usage:",
35170         "content": "curl https://{domain}/api/whatsapp/accounts -v -u {name}:{password}",
35171         "type": "json"
35172       }
35173     ],
35174     "name": "GetAccounts",
35175     "group": "Whatsapp_Accounts",
35176     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
35177     "version": "0.0.0",
35178     "filename": "server/api/whatsappAccount/index.js",
35179     "groupTitle": "Whatsapp_Accounts"
35180   },
35181   {
35182     "type": "get",
35183     "url": "/api/whatsapp/accounts/{id}/users",
35184     "title": "Gets agents from whatsapp account",
35185     "examples": [
35186       {
35187         "title": "Example usage:",
35188         "content": "curl https://{domain}/api/whatsapp/accounts/{id}/users -v -u {name}:{password} -X GET",
35189         "type": "json"
35190       }
35191     ],
35192     "name": "GetAgents",
35193     "group": "Whatsapp_Accounts",
35194     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35195     "version": "0.0.0",
35196     "filename": "server/api/whatsappAccount/index.js",
35197     "groupTitle": "Whatsapp_Accounts"
35198   },
35199   {
35200     "type": "delete",
35201     "url": "/api/whatsapp/accounts/{id}/users",
35202     "title": "Removes agents from a whatsapp account",
35203     "examples": [
35204       {
35205         "title": "Example usage:",
35206         "content": "curl https://{domain}/api/whatsapp/accounts/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
35207         "type": "json"
35208       }
35209     ],
35210     "name": "RemoveAgents",
35211     "group": "Whatsapp_Accounts",
35212     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35213     "version": "0.0.0",
35214     "filename": "server/api/whatsappAccount/index.js",
35215     "groupTitle": "Whatsapp_Accounts"
35216   },
35217   {
35218     "type": "delete",
35219     "url": "/api/whatsapp/accounts/{id}/canned_answers",
35220     "title": "Removes canned answers from account",
35221     "examples": [
35222       {
35223         "title": "Example usage:",
35224         "content": "curl https://{domain}/api/whatsapp/accounts/{id}/canned_answers?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
35225         "type": "json"
35226       }
35227     ],
35228     "name": "RemoveAnswers",
35229     "group": "Whatsapp_Accounts",
35230     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35231     "version": "0.0.0",
35232     "filename": "server/api/whatsappAccount/index.js",
35233     "groupTitle": "Whatsapp_Accounts"
35234   },
35235   {
35236     "type": "delete",
35237     "url": "/api/whatsapp/accounts/{id}/dispositions",
35238     "title": "Removes dispositions from account",
35239     "examples": [
35240       {
35241         "title": "Example usage:",
35242         "content": "curl https://{domain}/api/whatsapp/accounts/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
35243         "type": "json"
35244       }
35245     ],
35246     "name": "RemoveDispositions",
35247     "group": "Whatsapp_Accounts",
35248     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35249     "version": "0.0.0",
35250     "filename": "server/api/whatsappAccount/index.js",
35251     "groupTitle": "Whatsapp_Accounts"
35252   },
35253   {
35254     "type": "get",
35255     "url": "/api/whatsapp/accounts/{id}",
35256     "title": "Gets a single Account",
35257     "examples": [
35258       {
35259         "title": "Example usage:",
35260         "content": "curl https://{domain}/api/whatsapp/accounts/{id} -v -u {name}:{password}",
35261         "type": "json"
35262       }
35263     ],
35264     "name": "ShowAccounts",
35265     "group": "Whatsapp_Accounts",
35266     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35267     "version": "0.0.0",
35268     "filename": "server/api/whatsappAccount/index.js",
35269     "groupTitle": "Whatsapp_Accounts"
35270   },
35271   {
35272     "type": "put",
35273     "url": "/api/whatsapp/messages/{id}/accept",
35274     "title": "Accepts message",
35275     "examples": [
35276       {
35277         "title": "Example usage:",
35278         "content": "curl https://{domain}/api/whatsapp/messages/{id}/accept \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
35279         "type": "json"
35280       }
35281     ],
35282     "name": "acceptMessage",
35283     "group": "Whatsapp_Accounts",
35284     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35285     "version": "0.0.0",
35286     "filename": "server/api/whatsappMessage/index.js",
35287     "groupTitle": "Whatsapp_Accounts"
35288   },
35289   {
35290     "type": "post",
35291     "url": "/api/whatsapp/accounts/{id}/canned_answers",
35292     "title": "Creates new canned answer",
35293     "examples": [
35294       {
35295         "title": "Example usage:",
35296         "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",
35297         "type": "json"
35298       }
35299     ],
35300     "name": "addAnswer",
35301     "group": "Whatsapp_Accounts",
35302     "parameter": {
35303       "fields": {
35304         "Body": [
35305           {
35306             "group": "Body",
35307             "type": "String",
35308             "optional": false,
35309             "field": "key",
35310             "description": ""
35311           },
35312           {
35313             "group": "Body",
35314             "type": "Text",
35315             "optional": false,
35316             "field": "value",
35317             "description": ""
35318           },
35319           {
35320             "group": "Body",
35321             "type": "String",
35322             "optional": true,
35323             "field": "description",
35324             "description": ""
35325           },
35326           {
35327             "group": "Body",
35328             "type": "Virtual",
35329             "optional": true,
35330             "field": "name",
35331             "description": ""
35332           }
35333         ]
35334       }
35335     },
35336     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35337     "version": "0.0.0",
35338     "filename": "server/api/whatsappAccount/index.js",
35339     "groupTitle": "Whatsapp_Accounts"
35340   },
35341   {
35342     "type": "post",
35343     "url": "/api/whatsapp/accounts/{id}/applications",
35344     "title": "Creates new applications",
35345     "examples": [
35346       {
35347         "title": "Example usage:",
35348         "content": "curl https://{domain}/api/whatsapp/accounts/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
35349         "type": "json"
35350       }
35351     ],
35352     "name": "addApplications",
35353     "group": "Whatsapp_Accounts",
35354     "parameter": {
35355       "fields": {
35356         "Body": [
35357           {
35358             "group": "Body",
35359             "type": "Integer",
35360             "optional": false,
35361             "field": "priority",
35362             "description": ""
35363           },
35364           {
35365             "group": "Body",
35366             "type": "String",
35367             "optional": false,
35368             "field": "app",
35369             "description": ""
35370           },
35371           {
35372             "group": "Body",
35373             "type": "Text",
35374             "optional": true,
35375             "field": "appdata",
35376             "description": ""
35377           },
35378           {
35379             "group": "Body",
35380             "type": "String",
35381             "optional": true,
35382             "field": "description",
35383             "description": ""
35384           },
35385           {
35386             "group": "Body",
35387             "type": "String",
35388             "optional": true,
35389             "field": "interval",
35390             "description": ""
35391           }
35392         ]
35393       }
35394     },
35395     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35396     "version": "0.0.0",
35397     "filename": "server/api/whatsappAccount/index.js",
35398     "groupTitle": "Whatsapp_Accounts"
35399   },
35400   {
35401     "type": "post",
35402     "url": "/api/whatsapp/accounts/{id}/dispositions",
35403     "title": "Creates new disposition",
35404     "examples": [
35405       {
35406         "title": "Example usage:",
35407         "content": "curl https://{domain}/api/whatsapp/accounts/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
35408         "type": "json"
35409       }
35410     ],
35411     "name": "addDisposition",
35412     "group": "Whatsapp_Accounts",
35413     "parameter": {
35414       "fields": {
35415         "Body": [
35416           {
35417             "group": "Body",
35418             "type": "String",
35419             "optional": false,
35420             "field": "name",
35421             "description": ""
35422           },
35423           {
35424             "group": "Body",
35425             "type": "String",
35426             "allowedValues": [
35427               "\"first\"",
35428               "\"second\"",
35429               "\"third\""
35430             ],
35431             "optional": false,
35432             "field": "level",
35433             "description": ""
35434           },
35435           {
35436             "group": "Body",
35437             "type": "String",
35438             "optional": true,
35439             "field": "description",
35440             "description": ""
35441           }
35442         ]
35443       }
35444     },
35445     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35446     "version": "0.0.0",
35447     "filename": "server/api/whatsappAccount/index.js",
35448     "groupTitle": "Whatsapp_Accounts"
35449   },
35450   {
35451     "type": "get",
35452     "url": "/api/whatsapp/accounts/{id}/canned_answers",
35453     "title": "Gets account canned answers",
35454     "examples": [
35455       {
35456         "title": "Example usage:",
35457         "content": "curl https://{domain}/api/whatsapp/accounts/{id}/canned_answers -v -u {name}:{password} -X GET",
35458         "type": "json"
35459       }
35460     ],
35461     "name": "getAnswers",
35462     "group": "Whatsapp_Accounts",
35463     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35464     "version": "0.0.0",
35465     "filename": "server/api/whatsappAccount/index.js",
35466     "groupTitle": "Whatsapp_Accounts"
35467   },
35468   {
35469     "type": "get",
35470     "url": "/api/whatsapp/accounts/{id}/applications",
35471     "title": "Gets account applications",
35472     "examples": [
35473       {
35474         "title": "Example usage:",
35475         "content": "curl https://{domain}/api/whatsapp/accounts/{id}/applications -v -u {name}:{password} -X GET",
35476         "type": "json"
35477       }
35478     ],
35479     "name": "getApplications",
35480     "group": "Whatsapp_Accounts",
35481     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35482     "version": "0.0.0",
35483     "filename": "server/api/whatsappAccount/index.js",
35484     "groupTitle": "Whatsapp_Accounts"
35485   },
35486   {
35487     "type": "get",
35488     "url": "/api/whatsapp/accounts/{id}/dispositions",
35489     "title": "Gets account dispositions",
35490     "examples": [
35491       {
35492         "title": "Example usage:",
35493         "content": "curl https://{domain}/api/whatsapp/accounts/{id}/dispositions -v -u {name}:{password} -X GET",
35494         "type": "json"
35495       }
35496     ],
35497     "name": "getDispositions",
35498     "group": "Whatsapp_Accounts",
35499     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35500     "version": "0.0.0",
35501     "filename": "server/api/whatsappAccount/index.js",
35502     "groupTitle": "Whatsapp_Accounts"
35503   },
35504   {
35505     "type": "post",
35506     "url": "/api/whatsapp/accounts/{id}/notify",
35507     "title": "Notify new message",
35508     "examples": [
35509       {
35510         "title": "Example usage:",
35511         "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",
35512         "type": "json"
35513       }
35514     ],
35515     "name": "notify",
35516     "group": "Whatsapp_Accounts",
35517     "description": "<p>Motion 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>",
35518     "version": "0.0.0",
35519     "filename": "server/api/whatsappAccount/index.js",
35520     "groupTitle": "Whatsapp_Accounts"
35521   },
35522   {
35523     "type": "put",
35524     "url": "/api/whatsapp/messages/{id}/reject",
35525     "title": "Rejects message",
35526     "examples": [
35527       {
35528         "title": "Example usage:",
35529         "content": "curl https://{domain}/api/whatsapp/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
35530         "type": "json"
35531       }
35532     ],
35533     "name": "rejectMessage",
35534     "group": "Whatsapp_Accounts",
35535     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35536     "version": "0.0.0",
35537     "filename": "server/api/whatsappMessage/index.js",
35538     "groupTitle": "Whatsapp_Accounts"
35539   },
35540   {
35541     "type": "post",
35542     "url": "/api/whatsapp/accounts/{id}/send",
35543     "title": "Send new whatsapp message",
35544     "examples": [
35545       {
35546         "title": "Example usage:",
35547         "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",
35548         "type": "json"
35549       }
35550     ],
35551     "name": "sendWhatsapp",
35552     "group": "Whatsapp_Accounts",
35553     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35554     "version": "0.0.0",
35555     "filename": "server/api/whatsappAccount/index.js",
35556     "groupTitle": "Whatsapp_Accounts"
35557   },
35558   {
35559     "type": "post",
35560     "url": "/api/whatsapp/messages/{id}/status",
35561     "title": "Receive message status",
35562     "examples": [
35563       {
35564         "title": "Example usage:",
35565         "content": "curl https://{domain}/api/whatsapp/messages/{id}/status \\ \n -H 'Content-Type: application/json' -v -X POST",
35566         "type": "json"
35567       }
35568     ],
35569     "name": "statusMessage",
35570     "group": "Whatsapp_Accounts",
35571     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35572     "version": "0.0.0",
35573     "filename": "server/api/whatsappMessage/index.js",
35574     "groupTitle": "Whatsapp_Accounts"
35575   },
35576   {
35577     "type": "put",
35578     "url": "/api/whatsapp/accounts/{id}",
35579     "title": "Update an existing Account",
35580     "examples": [
35581       {
35582         "title": "Example usage:",
35583         "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",
35584         "type": "json"
35585       }
35586     ],
35587     "name": "updateAccounts",
35588     "group": "Whatsapp_Accounts",
35589     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35590     "version": "0.0.0",
35591     "filename": "server/api/whatsappAccount/index.js",
35592     "groupTitle": "Whatsapp_Accounts"
35593   },
35594   {
35595     "type": "post",
35596     "url": "/api/whatsapp/applications",
35597     "title": "Creates a new Application",
35598     "examples": [
35599       {
35600         "title": "Example usage:",
35601         "content": "curl https://{domain}/api/whatsapp/applications -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
35602         "type": "json"
35603       }
35604     ],
35605     "name": "CreateApplications",
35606     "group": "Whatsapp_Applications",
35607     "parameter": {
35608       "fields": {
35609         "Body": [
35610           {
35611             "group": "Body",
35612             "type": "Integer",
35613             "optional": false,
35614             "field": "priority",
35615             "description": ""
35616           },
35617           {
35618             "group": "Body",
35619             "type": "String",
35620             "optional": false,
35621             "field": "app",
35622             "description": ""
35623           },
35624           {
35625             "group": "Body",
35626             "type": "Text",
35627             "optional": true,
35628             "field": "appdata",
35629             "description": ""
35630           },
35631           {
35632             "group": "Body",
35633             "type": "String",
35634             "optional": true,
35635             "field": "description",
35636             "description": ""
35637           },
35638           {
35639             "group": "Body",
35640             "type": "String",
35641             "optional": true,
35642             "field": "interval",
35643             "description": ""
35644           }
35645         ]
35646       }
35647     },
35648     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35649     "version": "0.0.0",
35650     "filename": "server/api/whatsappApplication/index.js",
35651     "groupTitle": "Whatsapp_Applications"
35652   },
35653   {
35654     "type": "delete",
35655     "url": "/api/whatsapp/applications/{id}",
35656     "title": "Deletes a Application",
35657     "examples": [
35658       {
35659         "title": "Example usage:",
35660         "content": "curl https://{domain}/api/whatsapp/applications/{id} -v -u {name}:{password} -X DELETE",
35661         "type": "json"
35662       }
35663     ],
35664     "name": "DeleteApplications",
35665     "group": "Whatsapp_Applications",
35666     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35667     "version": "0.0.0",
35668     "filename": "server/api/whatsappApplication/index.js",
35669     "groupTitle": "Whatsapp_Applications"
35670   },
35671   {
35672     "type": "get",
35673     "url": "/api/whatsapp/applications",
35674     "title": "Gets a list of Applications",
35675     "examples": [
35676       {
35677         "title": "Example usage:",
35678         "content": "curl https://{domain}/api/whatsapp/applications -v -u {name}:{password}",
35679         "type": "json"
35680       }
35681     ],
35682     "name": "GetApplications",
35683     "group": "Whatsapp_Applications",
35684     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
35685     "version": "0.0.0",
35686     "filename": "server/api/whatsappApplication/index.js",
35687     "groupTitle": "Whatsapp_Applications"
35688   },
35689   {
35690     "type": "get",
35691     "url": "/api/whatsapp/applications/{id}",
35692     "title": "Gets a single Application",
35693     "examples": [
35694       {
35695         "title": "Example usage:",
35696         "content": "curl https://{domain}/api/whatsapp/applications/{id} -v -u {name}:{password}",
35697         "type": "json"
35698       }
35699     ],
35700     "name": "ShowApplications",
35701     "group": "Whatsapp_Applications",
35702     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35703     "version": "0.0.0",
35704     "filename": "server/api/whatsappApplication/index.js",
35705     "groupTitle": "Whatsapp_Applications"
35706   },
35707   {
35708     "type": "put",
35709     "url": "/api/whatsapp/applications/{id}",
35710     "title": "Update an existing Application",
35711     "examples": [
35712       {
35713         "title": "Example usage:",
35714         "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",
35715         "type": "json"
35716       }
35717     ],
35718     "name": "updateApplications",
35719     "group": "Whatsapp_Applications",
35720     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35721     "version": "0.0.0",
35722     "filename": "server/api/whatsappApplication/index.js",
35723     "groupTitle": "Whatsapp_Applications"
35724   },
35725   {
35726     "type": "post",
35727     "url": "/api/whatsapp/interactions/{id}/tags",
35728     "title": "Add tags to the interaction",
35729     "examples": [
35730       {
35731         "title": "Example usage:",
35732         "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",
35733         "type": "json"
35734       }
35735     ],
35736     "name": "AddTags",
35737     "group": "Whatsapp_Interactions",
35738     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35739     "version": "0.0.0",
35740     "filename": "server/api/whatsappInteraction/index.js",
35741     "groupTitle": "Whatsapp_Interactions"
35742   },
35743   {
35744     "type": "post",
35745     "url": "/api/whatsapp/interactions",
35746     "title": "Creates a new Interaction",
35747     "examples": [
35748       {
35749         "title": "Example usage:",
35750         "content": "curl https://{domain}/api/whatsapp/interactions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
35751         "type": "json"
35752       }
35753     ],
35754     "name": "CreateInteractions",
35755     "group": "Whatsapp_Interactions",
35756     "parameter": {
35757       "fields": {
35758         "Body": [
35759           {
35760             "group": "Body",
35761             "type": "Boolean",
35762             "optional": true,
35763             "field": "closed",
35764             "description": ""
35765           },
35766           {
35767             "group": "Body",
35768             "type": "String",
35769             "optional": true,
35770             "field": "closedAt",
35771             "description": ""
35772           },
35773           {
35774             "group": "Body",
35775             "type": "String",
35776             "optional": true,
35777             "field": "disposition",
35778             "description": ""
35779           },
35780           {
35781             "group": "Body",
35782             "type": "String",
35783             "optional": true,
35784             "field": "secondDisposition",
35785             "description": ""
35786           },
35787           {
35788             "group": "Body",
35789             "type": "String",
35790             "optional": true,
35791             "field": "thirdDisposition",
35792             "description": ""
35793           },
35794           {
35795             "group": "Body",
35796             "type": "String",
35797             "optional": true,
35798             "field": "note",
35799             "description": ""
35800           },
35801           {
35802             "group": "Body",
35803             "type": "String",
35804             "optional": true,
35805             "field": "phone",
35806             "description": ""
35807           },
35808           {
35809             "group": "Body",
35810             "type": "String",
35811             "optional": true,
35812             "field": "read1stAt",
35813             "description": ""
35814           },
35815           {
35816             "group": "Body",
35817             "type": "String",
35818             "allowedValues": [
35819               "\"in\"",
35820               "\"out\""
35821             ],
35822             "optional": false,
35823             "field": "firstMsgDirection",
35824             "description": ""
35825           },
35826           {
35827             "group": "Body",
35828             "type": "String",
35829             "optional": true,
35830             "field": "lastMsgAt",
35831             "description": ""
35832           },
35833           {
35834             "group": "Body",
35835             "type": "String",
35836             "allowedValues": [
35837               "\"in\"",
35838               "\"out\""
35839             ],
35840             "optional": false,
35841             "field": "lastMsgDirection",
35842             "description": ""
35843           }
35844         ]
35845       }
35846     },
35847     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35848     "version": "0.0.0",
35849     "filename": "server/api/whatsappInteraction/index.js",
35850     "groupTitle": "Whatsapp_Interactions"
35851   },
35852   {
35853     "type": "delete",
35854     "url": "/api/whatsapp/interactions/{id}",
35855     "title": "Deletes a Interaction",
35856     "examples": [
35857       {
35858         "title": "Example usage:",
35859         "content": "curl https://{domain}/api/whatsapp/interactions/{id} -v -u {name}:{password} -X DELETE",
35860         "type": "json"
35861       }
35862     ],
35863     "name": "DeleteInteractions",
35864     "group": "Whatsapp_Interactions",
35865     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35866     "version": "0.0.0",
35867     "filename": "server/api/whatsappInteraction/index.js",
35868     "groupTitle": "Whatsapp_Interactions"
35869   },
35870   {
35871     "type": "get",
35872     "url": "/api/whatsapp/interactions/describe",
35873     "title": "Gets table info about Interactions",
35874     "examples": [
35875       {
35876         "title": "Example usage:",
35877         "content": "curl https://{domain}/api/whatsapp/interactions/describe -v -u {name}:{password}",
35878         "type": "json"
35879       }
35880     ],
35881     "name": "DescribeInteractions",
35882     "group": "Whatsapp_Interactions",
35883     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35884     "version": "0.0.0",
35885     "filename": "server/api/whatsappInteraction/index.js",
35886     "groupTitle": "Whatsapp_Interactions"
35887   },
35888   {
35889     "type": "get",
35890     "url": "/api/whatsapp/interactions",
35891     "title": "Gets a list of Interactions",
35892     "examples": [
35893       {
35894         "title": "Example usage:",
35895         "content": "curl https://{domain}/api/whatsapp/interactions -v -u {name}:{password}",
35896         "type": "json"
35897       }
35898     ],
35899     "name": "GetInteractions",
35900     "group": "Whatsapp_Interactions",
35901     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
35902     "version": "0.0.0",
35903     "filename": "server/api/whatsappInteraction/index.js",
35904     "groupTitle": "Whatsapp_Interactions"
35905   },
35906   {
35907     "type": "delete",
35908     "url": "/api/whatsapp/interactions/{id}/tags",
35909     "title": "Removes tags from interaction",
35910     "examples": [
35911       {
35912         "title": "Example usage:",
35913         "content": "curl https://{domain}/api/whatsapp/interactions/{id}/tags?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
35914         "type": "json"
35915       }
35916     ],
35917     "name": "RemoveTags",
35918     "group": "Whatsapp_Interactions",
35919     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35920     "version": "0.0.0",
35921     "filename": "server/api/whatsappInteraction/index.js",
35922     "groupTitle": "Whatsapp_Interactions"
35923   },
35924   {
35925     "type": "get",
35926     "url": "/api/whatsapp/interactions/{id}",
35927     "title": "Gets a single Interaction",
35928     "examples": [
35929       {
35930         "title": "Example usage:",
35931         "content": "curl https://{domain}/api/whatsapp/interactions/{id} -v -u {name}:{password}",
35932         "type": "json"
35933       }
35934     ],
35935     "name": "ShowInteractions",
35936     "group": "Whatsapp_Interactions",
35937     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35938     "version": "0.0.0",
35939     "filename": "server/api/whatsappInteraction/index.js",
35940     "groupTitle": "Whatsapp_Interactions"
35941   },
35942   {
35943     "type": "post",
35944     "url": "/api/whatsapp/interactions/{id}/messages",
35945     "title": "Creates new messages",
35946     "examples": [
35947       {
35948         "title": "Example usage:",
35949         "content": "curl https://{domain}/api/whatsapp/interactions/{id}/messages -d '[{\"to\": \"+3901119886500\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
35950         "type": "json"
35951       }
35952     ],
35953     "name": "addMessage",
35954     "group": "Whatsapp_Interactions",
35955     "parameter": {
35956       "fields": {
35957         "Body": [
35958           {
35959             "group": "Body",
35960             "type": "Text",
35961             "optional": false,
35962             "field": "body",
35963             "description": ""
35964           },
35965           {
35966             "group": "Body",
35967             "type": "Boolean",
35968             "optional": true,
35969             "field": "read",
35970             "description": ""
35971           },
35972           {
35973             "group": "Body",
35974             "type": "String",
35975             "allowedValues": [
35976               "\"in\"",
35977               "\"out\""
35978             ],
35979             "optional": false,
35980             "field": "direction",
35981             "description": ""
35982           },
35983           {
35984             "group": "Body",
35985             "type": "String",
35986             "optional": true,
35987             "field": "messageId",
35988             "description": ""
35989           },
35990           {
35991             "group": "Body",
35992             "type": "String",
35993             "optional": true,
35994             "field": "phone",
35995             "description": ""
35996           },
35997           {
35998             "group": "Body",
35999             "type": "String",
36000             "optional": true,
36001             "field": "readAt",
36002             "description": ""
36003           },
36004           {
36005             "group": "Body",
36006             "type": "Boolean",
36007             "optional": true,
36008             "field": "secret",
36009             "description": ""
36010           },
36011           {
36012             "group": "Body",
36013             "type": "String",
36014             "optional": true,
36015             "field": "providerName",
36016             "description": ""
36017           },
36018           {
36019             "group": "Body",
36020             "type": "Text",
36021             "optional": true,
36022             "field": "providerResponse",
36023             "description": ""
36024           }
36025         ]
36026       }
36027     },
36028     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36029     "version": "0.0.0",
36030     "filename": "server/api/whatsappInteraction/index.js",
36031     "groupTitle": "Whatsapp_Interactions"
36032   },
36033   {
36034     "type": "get",
36035     "url": "/api/whatsapp/interactions/{id}/download",
36036     "title": "Gets interaction",
36037     "examples": [
36038       {
36039         "title": "Example usage:",
36040         "content": "curl https://{domain}/api/whatsapp/interactions/{id}/download -v -u {name}:{password} -X GET",
36041         "type": "json"
36042       }
36043     ],
36044     "name": "download",
36045     "group": "Whatsapp_Interactions",
36046     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36047     "version": "0.0.0",
36048     "filename": "server/api/whatsappInteraction/index.js",
36049     "groupTitle": "Whatsapp_Interactions"
36050   },
36051   {
36052     "type": "get",
36053     "url": "/api/whatsapp/interactions/{id}/messages",
36054     "title": "Gets interaction messages",
36055     "examples": [
36056       {
36057         "title": "Example usage:",
36058         "content": "curl https://{domain}/api/whatsapp/interactions/{id}/messages -v -u {name}:{password} -X GET",
36059         "type": "json"
36060       }
36061     ],
36062     "name": "getMessages",
36063     "group": "Whatsapp_Interactions",
36064     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36065     "version": "0.0.0",
36066     "filename": "server/api/whatsappInteraction/index.js",
36067     "groupTitle": "Whatsapp_Interactions"
36068   },
36069   {
36070     "type": "put",
36071     "url": "/api/whatsapp/interactions/{id}",
36072     "title": "Update an existing Interaction",
36073     "examples": [
36074       {
36075         "title": "Example usage:",
36076         "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",
36077         "type": "json"
36078       }
36079     ],
36080     "name": "updateInteractions",
36081     "group": "Whatsapp_Interactions",
36082     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36083     "version": "0.0.0",
36084     "filename": "server/api/whatsappInteraction/index.js",
36085     "groupTitle": "Whatsapp_Interactions"
36086   },
36087   {
36088     "type": "post",
36089     "url": "/api/whatsapp/messages",
36090     "title": "Creates a new Message",
36091     "examples": [
36092       {
36093         "title": "Example usage:",
36094         "content": "curl https://{domain}/api/whatsapp/messages -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
36095         "type": "json"
36096       }
36097     ],
36098     "name": "CreateMessages",
36099     "group": "Whatsapp_Messages",
36100     "parameter": {
36101       "fields": {
36102         "Body": [
36103           {
36104             "group": "Body",
36105             "type": "Text",
36106             "optional": false,
36107             "field": "body",
36108             "description": ""
36109           },
36110           {
36111             "group": "Body",
36112             "type": "Boolean",
36113             "optional": true,
36114             "field": "read",
36115             "description": ""
36116           },
36117           {
36118             "group": "Body",
36119             "type": "String",
36120             "allowedValues": [
36121               "\"in\"",
36122               "\"out\""
36123             ],
36124             "optional": false,
36125             "field": "direction",
36126             "description": ""
36127           },
36128           {
36129             "group": "Body",
36130             "type": "String",
36131             "optional": true,
36132             "field": "messageId",
36133             "description": ""
36134           },
36135           {
36136             "group": "Body",
36137             "type": "String",
36138             "optional": true,
36139             "field": "phone",
36140             "description": ""
36141           },
36142           {
36143             "group": "Body",
36144             "type": "String",
36145             "optional": true,
36146             "field": "readAt",
36147             "description": ""
36148           },
36149           {
36150             "group": "Body",
36151             "type": "Boolean",
36152             "optional": true,
36153             "field": "secret",
36154             "description": ""
36155           },
36156           {
36157             "group": "Body",
36158             "type": "String",
36159             "optional": true,
36160             "field": "providerName",
36161             "description": ""
36162           },
36163           {
36164             "group": "Body",
36165             "type": "Text",
36166             "optional": true,
36167             "field": "providerResponse",
36168             "description": ""
36169           }
36170         ]
36171       }
36172     },
36173     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36174     "version": "0.0.0",
36175     "filename": "server/api/whatsappMessage/index.js",
36176     "groupTitle": "Whatsapp_Messages"
36177   },
36178   {
36179     "type": "delete",
36180     "url": "/api/whatsapp/messages/{id}",
36181     "title": "Deletes a Message",
36182     "examples": [
36183       {
36184         "title": "Example usage:",
36185         "content": "curl https://{domain}/api/whatsapp/messages/{id} -v -u {name}:{password} -X DELETE",
36186         "type": "json"
36187       }
36188     ],
36189     "name": "DeleteMessages",
36190     "group": "Whatsapp_Messages",
36191     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36192     "version": "0.0.0",
36193     "filename": "server/api/whatsappMessage/index.js",
36194     "groupTitle": "Whatsapp_Messages"
36195   },
36196   {
36197     "type": "get",
36198     "url": "/api/whatsapp/messages/describe",
36199     "title": "Gets table info about Messages",
36200     "examples": [
36201       {
36202         "title": "Example usage:",
36203         "content": "curl https://{domain}/api/whatsapp/messages/describe -v -u {name}:{password}",
36204         "type": "json"
36205       }
36206     ],
36207     "name": "DescribeMessages",
36208     "group": "Whatsapp_Messages",
36209     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36210     "version": "0.0.0",
36211     "filename": "server/api/whatsappMessage/index.js",
36212     "groupTitle": "Whatsapp_Messages"
36213   },
36214   {
36215     "type": "get",
36216     "url": "/api/whatsapp/messages",
36217     "title": "Gets a list of Messages",
36218     "examples": [
36219       {
36220         "title": "Example usage:",
36221         "content": "curl https://{domain}/api/whatsapp/messages -v -u {name}:{password}",
36222         "type": "json"
36223       }
36224     ],
36225     "name": "GetMessages",
36226     "group": "Whatsapp_Messages",
36227     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
36228     "version": "0.0.0",
36229     "filename": "server/api/whatsappMessage/index.js",
36230     "groupTitle": "Whatsapp_Messages"
36231   },
36232   {
36233     "type": "get",
36234     "url": "/api/whatsapp/messages/{id}",
36235     "title": "Gets a single Message",
36236     "examples": [
36237       {
36238         "title": "Example usage:",
36239         "content": "curl https://{domain}/api/whatsapp/messages/{id} -v -u {name}:{password}",
36240         "type": "json"
36241       }
36242     ],
36243     "name": "ShowMessages",
36244     "group": "Whatsapp_Messages",
36245     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36246     "version": "0.0.0",
36247     "filename": "server/api/whatsappMessage/index.js",
36248     "groupTitle": "Whatsapp_Messages"
36249   },
36250   {
36251     "type": "put",
36252     "url": "/api/whatsapp/messages/{id}",
36253     "title": "Update an existing Message",
36254     "examples": [
36255       {
36256         "title": "Example usage:",
36257         "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",
36258         "type": "json"
36259       }
36260     ],
36261     "name": "updateMessages",
36262     "group": "Whatsapp_Messages",
36263     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36264     "version": "0.0.0",
36265     "filename": "server/api/whatsappMessage/index.js",
36266     "groupTitle": "Whatsapp_Messages"
36267   },
36268   {
36269     "type": "post",
36270     "url": "/api/whatsapp/reports/queue",
36271     "title": "Creates a new Whatsapp Queue Report",
36272     "examples": [
36273       {
36274         "title": "Example usage:",
36275         "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",
36276         "type": "json"
36277       }
36278     ],
36279     "name": "CreateWhatsapp_Queue_Reports",
36280     "group": "Whatsapp_Queue_Reports",
36281     "parameter": {
36282       "fields": {
36283         "Body": [
36284           {
36285             "group": "Body",
36286             "type": "String",
36287             "optional": false,
36288             "field": "uniqueid",
36289             "description": ""
36290           },
36291           {
36292             "group": "Body",
36293             "type": "String",
36294             "optional": true,
36295             "field": "from",
36296             "description": ""
36297           },
36298           {
36299             "group": "Body",
36300             "type": "String",
36301             "optional": true,
36302             "field": "joinAt",
36303             "description": ""
36304           },
36305           {
36306             "group": "Body",
36307             "type": "String",
36308             "optional": true,
36309             "field": "leaveAt",
36310             "description": ""
36311           },
36312           {
36313             "group": "Body",
36314             "type": "String",
36315             "optional": true,
36316             "field": "acceptAt",
36317             "description": ""
36318           },
36319           {
36320             "group": "Body",
36321             "type": "String",
36322             "optional": true,
36323             "field": "exitAt",
36324             "description": ""
36325           },
36326           {
36327             "group": "Body",
36328             "type": "String",
36329             "optional": true,
36330             "field": "reason",
36331             "description": ""
36332           }
36333         ]
36334       }
36335     },
36336     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36337     "version": "0.0.0",
36338     "filename": "server/api/whatsappQueueReport/index.js",
36339     "groupTitle": "Whatsapp_Queue_Reports"
36340   },
36341   {
36342     "type": "delete",
36343     "url": "/api/whatsapp/reports/queue/{id}",
36344     "title": "Deletes a Whatsapp Queue Report",
36345     "examples": [
36346       {
36347         "title": "Example usage:",
36348         "content": "curl https://{domain}/api/whatsapp/reports/queue/{id} -v -u {name}:{password} -X DELETE",
36349         "type": "json"
36350       }
36351     ],
36352     "name": "DeleteWhatsapp_Queue_Reports",
36353     "group": "Whatsapp_Queue_Reports",
36354     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36355     "version": "0.0.0",
36356     "filename": "server/api/whatsappQueueReport/index.js",
36357     "groupTitle": "Whatsapp_Queue_Reports"
36358   },
36359   {
36360     "type": "get",
36361     "url": "/api/whatsapp/reports/queue/describe",
36362     "title": "Gets table info about Whatsapp Queue Reports",
36363     "examples": [
36364       {
36365         "title": "Example usage:",
36366         "content": "curl https://{domain}/api/whatsapp/reports/queue/describe -v -u {name}:{password}",
36367         "type": "json"
36368       }
36369     ],
36370     "name": "DescribeWhatsapp_Queue_Reports",
36371     "group": "Whatsapp_Queue_Reports",
36372     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36373     "version": "0.0.0",
36374     "filename": "server/api/whatsappQueueReport/index.js",
36375     "groupTitle": "Whatsapp_Queue_Reports"
36376   },
36377   {
36378     "type": "get",
36379     "url": "/api/whatsapp/reports/queue",
36380     "title": "Gets a list of Whatsapp Queue Reports",
36381     "examples": [
36382       {
36383         "title": "Example usage:",
36384         "content": "curl https://{domain}/api/whatsapp/reports/queue -v -u {name}:{password}",
36385         "type": "json"
36386       }
36387     ],
36388     "name": "GetWhatsapp_Queue_Reports",
36389     "group": "Whatsapp_Queue_Reports",
36390     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
36391     "version": "0.0.0",
36392     "filename": "server/api/whatsappQueueReport/index.js",
36393     "groupTitle": "Whatsapp_Queue_Reports"
36394   },
36395   {
36396     "type": "get",
36397     "url": "/api/whatsapp/reports/queue/{id}",
36398     "title": "Gets a single Whatsapp Queue Report",
36399     "examples": [
36400       {
36401         "title": "Example usage:",
36402         "content": "curl https://{domain}/api/whatsapp/reports/queue/{id} -v -u {name}:{password}",
36403         "type": "json"
36404       }
36405     ],
36406     "name": "ShowWhatsapp_Queue_Reports",
36407     "group": "Whatsapp_Queue_Reports",
36408     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36409     "version": "0.0.0",
36410     "filename": "server/api/whatsappQueueReport/index.js",
36411     "groupTitle": "Whatsapp_Queue_Reports"
36412   },
36413   {
36414     "type": "put",
36415     "url": "/api/whatsapp/reports/queue/{id}",
36416     "title": "Update an existing Whatsapp Queue Report",
36417     "examples": [
36418       {
36419         "title": "Example usage:",
36420         "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",
36421         "type": "json"
36422       }
36423     ],
36424     "name": "updateWhatsapp_Queue_Reports",
36425     "group": "Whatsapp_Queue_Reports",
36426     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36427     "version": "0.0.0",
36428     "filename": "server/api/whatsappQueueReport/index.js",
36429     "groupTitle": "Whatsapp_Queue_Reports"
36430   },
36431   {
36432     "type": "post",
36433     "url": "/api/whatsapp/queues/{id}/users",
36434     "title": "Add agents to a queue",
36435     "examples": [
36436       {
36437         "title": "Example usage:",
36438         "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",
36439         "type": "json"
36440       }
36441     ],
36442     "name": "AddAgents",
36443     "group": "Whatsapp_Queues",
36444     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36445     "version": "0.0.0",
36446     "filename": "server/api/whatsappQueue/index.js",
36447     "groupTitle": "Whatsapp_Queues"
36448   },
36449   {
36450     "type": "post",
36451     "url": "/api/whatsapp/queues/{id}/teams",
36452     "title": "Add teams to a queue",
36453     "examples": [
36454       {
36455         "title": "Example usage:",
36456         "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",
36457         "type": "json"
36458       }
36459     ],
36460     "name": "AddTeams",
36461     "group": "Whatsapp_Queues",
36462     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36463     "version": "0.0.0",
36464     "filename": "server/api/whatsappQueue/index.js",
36465     "groupTitle": "Whatsapp_Queues"
36466   },
36467   {
36468     "type": "post",
36469     "url": "/api/whatsapp/queues",
36470     "title": "Creates a new Queue",
36471     "examples": [
36472       {
36473         "title": "Example usage:",
36474         "content": "curl https://{domain}/api/whatsapp/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
36475         "type": "json"
36476       }
36477     ],
36478     "name": "CreateQueues",
36479     "group": "Whatsapp_Queues",
36480     "parameter": {
36481       "fields": {
36482         "Body": [
36483           {
36484             "group": "Body",
36485             "type": "String",
36486             "optional": true,
36487             "field": "name",
36488             "description": ""
36489           },
36490           {
36491             "group": "Body",
36492             "type": "Integer",
36493             "optional": true,
36494             "field": "timeout",
36495             "description": ""
36496           },
36497           {
36498             "group": "Body",
36499             "type": "String",
36500             "allowedValues": [
36501               "\"rrmemory\"",
36502               "\"beepall\"",
36503               "\"roundrobin\""
36504             ],
36505             "optional": true,
36506             "field": "strategy",
36507             "description": ""
36508           },
36509           {
36510             "group": "Body",
36511             "type": "String",
36512             "optional": true,
36513             "field": "description",
36514             "description": ""
36515           }
36516         ]
36517       }
36518     },
36519     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36520     "version": "0.0.0",
36521     "filename": "server/api/whatsappQueue/index.js",
36522     "groupTitle": "Whatsapp_Queues"
36523   },
36524   {
36525     "type": "delete",
36526     "url": "/api/whatsapp/queues/{id}",
36527     "title": "Deletes a Queue",
36528     "examples": [
36529       {
36530         "title": "Example usage:",
36531         "content": "curl https://{domain}/api/whatsapp/queues/{id} -v -u {name}:{password} -X DELETE",
36532         "type": "json"
36533       }
36534     ],
36535     "name": "DeleteQueues",
36536     "group": "Whatsapp_Queues",
36537     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36538     "version": "0.0.0",
36539     "filename": "server/api/whatsappQueue/index.js",
36540     "groupTitle": "Whatsapp_Queues"
36541   },
36542   {
36543     "type": "get",
36544     "url": "/api/whatsapp/queues/describe",
36545     "title": "Gets table info about Queues",
36546     "examples": [
36547       {
36548         "title": "Example usage:",
36549         "content": "curl https://{domain}/api/whatsapp/queues/describe -v -u {name}:{password}",
36550         "type": "json"
36551       }
36552     ],
36553     "name": "DescribeQueues",
36554     "group": "Whatsapp_Queues",
36555     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36556     "version": "0.0.0",
36557     "filename": "server/api/whatsappQueue/index.js",
36558     "groupTitle": "Whatsapp_Queues"
36559   },
36560   {
36561     "type": "get",
36562     "url": "/api/whatsapp/queues/{id}/users",
36563     "title": "Gets queue agents",
36564     "examples": [
36565       {
36566         "title": "Example usage:",
36567         "content": "curl https://{domain}/api/whatsapp/queues/{id}/users -v -u {name}:{password} -X POST",
36568         "type": "json"
36569       }
36570     ],
36571     "name": "GetAgents",
36572     "group": "Whatsapp_Queues",
36573     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36574     "version": "0.0.0",
36575     "filename": "server/api/whatsappQueue/index.js",
36576     "groupTitle": "Whatsapp_Queues"
36577   },
36578   {
36579     "type": "get",
36580     "url": "/api/whatsapp/queues/{id}/members",
36581     "title": "GetMembers",
36582     "examples": [
36583       {
36584         "title": "Example usage:",
36585         "content": "curl https://{domain}/api/whatsapp/queues/{id}/members  -v -u {name}:{password}",
36586         "type": "json"
36587       }
36588     ],
36589     "name": "GetMembers",
36590     "group": "Whatsapp_Queues",
36591     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36592     "version": "0.0.0",
36593     "filename": "server/api/whatsappQueue/index.js",
36594     "groupTitle": "Whatsapp_Queues"
36595   },
36596   {
36597     "type": "get",
36598     "url": "/api/whatsapp/queues",
36599     "title": "Gets a list of Queues",
36600     "examples": [
36601       {
36602         "title": "Example usage:",
36603         "content": "curl https://{domain}/api/whatsapp/queues -v -u {name}:{password}",
36604         "type": "json"
36605       }
36606     ],
36607     "name": "GetQueues",
36608     "group": "Whatsapp_Queues",
36609     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
36610     "version": "0.0.0",
36611     "filename": "server/api/whatsappQueue/index.js",
36612     "groupTitle": "Whatsapp_Queues"
36613   },
36614   {
36615     "type": "get",
36616     "url": "/api/whatsapp/queues/{id}/teams",
36617     "title": "Gets queues list",
36618     "examples": [
36619       {
36620         "title": "Example usage:",
36621         "content": "curl https://{domain}/api/whatsapp/queues/{id}/teams -v -u {name}:{password}",
36622         "type": "json"
36623       }
36624     ],
36625     "name": "GetTeams",
36626     "group": "Whatsapp_Queues",
36627     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36628     "version": "0.0.0",
36629     "filename": "server/api/whatsappQueue/index.js",
36630     "groupTitle": "Whatsapp_Queues"
36631   },
36632   {
36633     "type": "delete",
36634     "url": "/api/whatsapp/queues/{id}/users",
36635     "title": "Removes agents from a queue",
36636     "examples": [
36637       {
36638         "title": "Example usage:",
36639         "content": "curl https://{domain}/api/whatsapp/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
36640         "type": "json"
36641       }
36642     ],
36643     "name": "RemoveAgents",
36644     "group": "Whatsapp_Queues",
36645     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36646     "version": "0.0.0",
36647     "filename": "server/api/whatsappQueue/index.js",
36648     "groupTitle": "Whatsapp_Queues"
36649   },
36650   {
36651     "type": "get",
36652     "url": "/api/whatsapp/queues/{id}",
36653     "title": "Gets a single Queue",
36654     "examples": [
36655       {
36656         "title": "Example usage:",
36657         "content": "curl https://{domain}/api/whatsapp/queues/{id} -v -u {name}:{password}",
36658         "type": "json"
36659       }
36660     ],
36661     "name": "ShowQueues",
36662     "group": "Whatsapp_Queues",
36663     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36664     "version": "0.0.0",
36665     "filename": "server/api/whatsappQueue/index.js",
36666     "groupTitle": "Whatsapp_Queues"
36667   },
36668   {
36669     "type": "put",
36670     "url": "/api/whatsapp/queues/{id}",
36671     "title": "Update an existing Queue",
36672     "examples": [
36673       {
36674         "title": "Example usage:",
36675         "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",
36676         "type": "json"
36677       }
36678     ],
36679     "name": "updateQueues",
36680     "group": "Whatsapp_Queues",
36681     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36682     "version": "0.0.0",
36683     "filename": "server/api/whatsappQueue/index.js",
36684     "groupTitle": "Whatsapp_Queues"
36685   },
36686   {
36687     "type": "post",
36688     "url": "/api/whatsapp/reports/transfer",
36689     "title": "Creates a new Whatsapp Transfer Report",
36690     "examples": [
36691       {
36692         "title": "Example usage:",
36693         "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",
36694         "type": "json"
36695       }
36696     ],
36697     "name": "CreateWhatsapp_Transfer_Reports",
36698     "group": "Whatsapp_Transfer_Reports",
36699     "parameter": {
36700       "fields": {
36701         "Body": [
36702           {
36703             "group": "Body",
36704             "type": "String",
36705             "optional": false,
36706             "field": "uniqueid",
36707             "description": ""
36708           },
36709           {
36710             "group": "Body",
36711             "type": "String",
36712             "allowedValues": [
36713               "\"account\"",
36714               "\"agent\"",
36715               "\"queue\""
36716             ],
36717             "optional": false,
36718             "field": "type",
36719             "description": ""
36720           },
36721           {
36722             "group": "Body",
36723             "type": "String",
36724             "optional": true,
36725             "field": "transferredAt",
36726             "description": ""
36727           }
36728         ]
36729       }
36730     },
36731     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36732     "version": "0.0.0",
36733     "filename": "server/api/whatsappTransferReport/index.js",
36734     "groupTitle": "Whatsapp_Transfer_Reports"
36735   },
36736   {
36737     "type": "delete",
36738     "url": "/api/whatsapp/reports/transfer/{id}",
36739     "title": "Deletes a Whatsapp Transfer Report",
36740     "examples": [
36741       {
36742         "title": "Example usage:",
36743         "content": "curl https://{domain}/api/whatsapp/reports/transfer/{id} -v -u {name}:{password} -X DELETE",
36744         "type": "json"
36745       }
36746     ],
36747     "name": "DeleteWhatsapp_Transfer_Reports",
36748     "group": "Whatsapp_Transfer_Reports",
36749     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36750     "version": "0.0.0",
36751     "filename": "server/api/whatsappTransferReport/index.js",
36752     "groupTitle": "Whatsapp_Transfer_Reports"
36753   },
36754   {
36755     "type": "get",
36756     "url": "/api/whatsapp/reports/transfer/describe",
36757     "title": "Gets table info about Whatsapp Transfer Reports",
36758     "examples": [
36759       {
36760         "title": "Example usage:",
36761         "content": "curl https://{domain}/api/whatsapp/reports/transfer/describe -v -u {name}:{password}",
36762         "type": "json"
36763       }
36764     ],
36765     "name": "DescribeWhatsapp_Transfer_Reports",
36766     "group": "Whatsapp_Transfer_Reports",
36767     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36768     "version": "0.0.0",
36769     "filename": "server/api/whatsappTransferReport/index.js",
36770     "groupTitle": "Whatsapp_Transfer_Reports"
36771   },
36772   {
36773     "type": "get",
36774     "url": "/api/whatsapp/reports/transfer",
36775     "title": "Gets a list of Whatsapp Transfer Reports",
36776     "examples": [
36777       {
36778         "title": "Example usage:",
36779         "content": "curl https://{domain}/api/whatsapp/reports/transfer -v -u {name}:{password}",
36780         "type": "json"
36781       }
36782     ],
36783     "name": "GetWhatsapp_Transfer_Reports",
36784     "group": "Whatsapp_Transfer_Reports",
36785     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
36786     "version": "0.0.0",
36787     "filename": "server/api/whatsappTransferReport/index.js",
36788     "groupTitle": "Whatsapp_Transfer_Reports"
36789   },
36790   {
36791     "type": "get",
36792     "url": "/api/whatsapp/reports/transfer/{id}",
36793     "title": "Gets a single Whatsapp Transfer Report",
36794     "examples": [
36795       {
36796         "title": "Example usage:",
36797         "content": "curl https://{domain}/api/whatsapp/reports/transfer/{id} -v -u {name}:{password}",
36798         "type": "json"
36799       }
36800     ],
36801     "name": "ShowWhatsapp_Transfer_Reports",
36802     "group": "Whatsapp_Transfer_Reports",
36803     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36804     "version": "0.0.0",
36805     "filename": "server/api/whatsappTransferReport/index.js",
36806     "groupTitle": "Whatsapp_Transfer_Reports"
36807   },
36808   {
36809     "type": "put",
36810     "url": "/api/whatsapp/reports/transfer/{id}",
36811     "title": "Update an existing Whatsapp Transfer Report",
36812     "examples": [
36813       {
36814         "title": "Example usage:",
36815         "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",
36816         "type": "json"
36817       }
36818     ],
36819     "name": "updateWhatsapp_Transfer_Reports",
36820     "group": "Whatsapp_Transfer_Reports",
36821     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36822     "version": "0.0.0",
36823     "filename": "server/api/whatsappTransferReport/index.js",
36824     "groupTitle": "Whatsapp_Transfer_Reports"
36825   },
36826   {
36827     "type": "post",
36828     "url": "/api/integrations/zendesk/accounts",
36829     "title": "Creates a new Zendesk Account",
36830     "examples": [
36831       {
36832         "title": "Example usage:",
36833         "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",
36834         "type": "json"
36835       }
36836     ],
36837     "name": "CreateZendesk_Accounts",
36838     "group": "Zendesk_Accounts",
36839     "parameter": {
36840       "fields": {
36841         "Body": [
36842           {
36843             "group": "Body",
36844             "type": "String",
36845             "optional": true,
36846             "field": "name",
36847             "description": ""
36848           },
36849           {
36850             "group": "Body",
36851             "type": "String",
36852             "optional": true,
36853             "field": "description",
36854             "description": ""
36855           },
36856           {
36857             "group": "Body",
36858             "type": "String",
36859             "optional": true,
36860             "field": "username",
36861             "description": ""
36862           },
36863           {
36864             "group": "Body",
36865             "type": "String",
36866             "optional": true,
36867             "field": "password",
36868             "description": ""
36869           },
36870           {
36871             "group": "Body",
36872             "type": "String",
36873             "optional": true,
36874             "field": "token",
36875             "description": ""
36876           },
36877           {
36878             "group": "Body",
36879             "type": "String",
36880             "optional": true,
36881             "field": "remoteUri",
36882             "description": ""
36883           },
36884           {
36885             "group": "Body",
36886             "type": "String",
36887             "allowedValues": [
36888               "\"password\"",
36889               "\"token\""
36890             ],
36891             "optional": true,
36892             "field": "authType",
36893             "description": ""
36894           },
36895           {
36896             "group": "Body",
36897             "type": "String",
36898             "optional": false,
36899             "field": "serverUrl",
36900             "description": ""
36901           },
36902           {
36903             "group": "Body",
36904             "type": "String",
36905             "allowedValues": [
36906               "\"integrationTab\"",
36907               "\"newTab\""
36908             ],
36909             "optional": true,
36910             "field": "type",
36911             "description": ""
36912           }
36913         ]
36914       }
36915     },
36916     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36917     "version": "0.0.0",
36918     "filename": "server/api/intZendeskAccount/index.js",
36919     "groupTitle": "Zendesk_Accounts"
36920   },
36921   {
36922     "type": "delete",
36923     "url": "/api/integrations/zendesk/accounts/{id}",
36924     "title": "Deletes a Zendesk Account",
36925     "examples": [
36926       {
36927         "title": "Example usage:",
36928         "content": "curl https://{domain}/api/integrations/zendesk/accounts/{id} -v -u {name}:{password} -X DELETE",
36929         "type": "json"
36930       }
36931     ],
36932     "name": "DeleteZendesk_Accounts",
36933     "group": "Zendesk_Accounts",
36934     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36935     "version": "0.0.0",
36936     "filename": "server/api/intZendeskAccount/index.js",
36937     "groupTitle": "Zendesk_Accounts"
36938   },
36939   {
36940     "type": "get",
36941     "url": "/api/integrations/zendesk/accounts",
36942     "title": "Gets a list of Zendesk Accounts",
36943     "examples": [
36944       {
36945         "title": "Example usage:",
36946         "content": "curl https://{domain}/api/integrations/zendesk/accounts -v -u {name}:{password}",
36947         "type": "json"
36948       }
36949     ],
36950     "name": "GetZendesk_Accounts",
36951     "group": "Zendesk_Accounts",
36952     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
36953     "version": "0.0.0",
36954     "filename": "server/api/intZendeskAccount/index.js",
36955     "groupTitle": "Zendesk_Accounts"
36956   },
36957   {
36958     "type": "get",
36959     "url": "/api/integrations/zendesk/accounts/{id}",
36960     "title": "Gets a single Zendesk Account",
36961     "examples": [
36962       {
36963         "title": "Example usage:",
36964         "content": "curl https://{domain}/api/integrations/zendesk/accounts/{id} -v -u {name}:{password}",
36965         "type": "json"
36966       }
36967     ],
36968     "name": "ShowZendesk_Accounts",
36969     "group": "Zendesk_Accounts",
36970     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36971     "version": "0.0.0",
36972     "filename": "server/api/intZendeskAccount/index.js",
36973     "groupTitle": "Zendesk_Accounts"
36974   },
36975   {
36976     "type": "post",
36977     "url": "/api/integrations/zendesk/accounts/{id}/configurations",
36978     "title": "Creates new configuration",
36979     "examples": [
36980       {
36981         "title": "Example usage:",
36982         "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",
36983         "type": "json"
36984       }
36985     ],
36986     "name": "addConfiguration",
36987     "group": "Zendesk_Accounts",
36988     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36989     "version": "0.0.0",
36990     "filename": "server/api/intZendeskAccount/index.js",
36991     "groupTitle": "Zendesk_Accounts"
36992   },
36993   {
36994     "type": "get",
36995     "url": "/api/integrations/zendesk/accounts/{id}/configurations",
36996     "title": "Gets account configurations",
36997     "examples": [
36998       {
36999         "title": "Example usage:",
37000         "content": "curl https://{domain}/api/integrations/zendesk/accounts/{id}/configurations -v -u {name}:{password} -X GET",
37001         "type": "json"
37002       }
37003     ],
37004     "name": "getConfigurations",
37005     "group": "Zendesk_Accounts",
37006     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37007     "version": "0.0.0",
37008     "filename": "server/api/intZendeskAccount/index.js",
37009     "groupTitle": "Zendesk_Accounts"
37010   },
37011   {
37012     "type": "get",
37013     "url": "/api/integrations/zendesk/accounts/{id}/fields",
37014     "title": "Gets account fields",
37015     "examples": [
37016       {
37017         "title": "Example usage:",
37018         "content": "curl https://{domain}/api/integrations/zendesk/accounts/{id}/fields -v -u {name}:{password} -X GET",
37019         "type": "json"
37020       }
37021     ],
37022     "name": "getFields",
37023     "group": "Zendesk_Accounts",
37024     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37025     "version": "0.0.0",
37026     "filename": "server/api/intZendeskAccount/index.js",
37027     "groupTitle": "Zendesk_Accounts"
37028   },
37029   {
37030     "type": "put",
37031     "url": "/api/integrations/zendesk/accounts/{id}",
37032     "title": "Update an existing Zendesk Account",
37033     "examples": [
37034       {
37035         "title": "Example usage:",
37036         "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",
37037         "type": "json"
37038       }
37039     ],
37040     "name": "updateZendesk_Accounts",
37041     "group": "Zendesk_Accounts",
37042     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37043     "version": "0.0.0",
37044     "filename": "server/api/intZendeskAccount/index.js",
37045     "groupTitle": "Zendesk_Accounts"
37046   },
37047   {
37048     "type": "post",
37049     "url": "/api/integrations/zendesk/configurations",
37050     "title": "Creates a new Zendesk Configuration",
37051     "examples": [
37052       {
37053         "title": "Example usage:",
37054         "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",
37055         "type": "json"
37056       }
37057     ],
37058     "name": "CreateZendesk_Configurations",
37059     "group": "Zendesk_Configurations",
37060     "parameter": {
37061       "fields": {
37062         "Body": [
37063           {
37064             "group": "Body",
37065             "type": "String",
37066             "optional": true,
37067             "field": "name",
37068             "description": ""
37069           },
37070           {
37071             "group": "Body",
37072             "type": "String",
37073             "optional": true,
37074             "field": "description",
37075             "description": ""
37076           }
37077         ]
37078       }
37079     },
37080     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37081     "version": "0.0.0",
37082     "filename": "server/api/intZendeskConfiguration/index.js",
37083     "groupTitle": "Zendesk_Configurations"
37084   },
37085   {
37086     "type": "delete",
37087     "url": "/api/integrations/zendesk/configurations/{id}",
37088     "title": "Deletes a Zendesk Configuration",
37089     "examples": [
37090       {
37091         "title": "Example usage:",
37092         "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id} -v -u {name}:{password} -X DELETE",
37093         "type": "json"
37094       }
37095     ],
37096     "name": "DeleteZendesk_Configurations",
37097     "group": "Zendesk_Configurations",
37098     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37099     "version": "0.0.0",
37100     "filename": "server/api/intZendeskConfiguration/index.js",
37101     "groupTitle": "Zendesk_Configurations"
37102   },
37103   {
37104     "type": "get",
37105     "url": "/api/integrations/zendesk/configurations",
37106     "title": "Gets a list of Zendesk Configurations",
37107     "examples": [
37108       {
37109         "title": "Example usage:",
37110         "content": "curl https://{domain}/api/integrations/zendesk/configurations -v -u {name}:{password}",
37111         "type": "json"
37112       }
37113     ],
37114     "name": "GetZendesk_Configurations",
37115     "group": "Zendesk_Configurations",
37116     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
37117     "version": "0.0.0",
37118     "filename": "server/api/intZendeskConfiguration/index.js",
37119     "groupTitle": "Zendesk_Configurations"
37120   },
37121   {
37122     "type": "get",
37123     "url": "/api/integrations/zendesk/configurations/{id}",
37124     "title": "Gets a single Zendesk Configuration",
37125     "examples": [
37126       {
37127         "title": "Example usage:",
37128         "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id} -v -u {name}:{password}",
37129         "type": "json"
37130       }
37131     ],
37132     "name": "ShowZendesk_Configurations",
37133     "group": "Zendesk_Configurations",
37134     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37135     "version": "0.0.0",
37136     "filename": "server/api/intZendeskConfiguration/index.js",
37137     "groupTitle": "Zendesk_Configurations"
37138   },
37139   {
37140     "type": "get",
37141     "url": "/api/integrations/zendesk/configurations/{id}/descriptions",
37142     "title": "Gets configurations descriptions",
37143     "examples": [
37144       {
37145         "title": "Example usage:",
37146         "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
37147         "type": "json"
37148       }
37149     ],
37150     "name": "getDescriptions",
37151     "group": "Zendesk_Configurations",
37152     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37153     "version": "0.0.0",
37154     "filename": "server/api/intZendeskConfiguration/index.js",
37155     "groupTitle": "Zendesk_Configurations"
37156   },
37157   {
37158     "type": "get",
37159     "url": "/api/integrations/zendesk/configurations/{id}/fields",
37160     "title": "Gets configurations fields",
37161     "examples": [
37162       {
37163         "title": "Example usage:",
37164         "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id}/fields -v -u {name}:{password} -X GET",
37165         "type": "json"
37166       }
37167     ],
37168     "name": "getFields",
37169     "group": "Zendesk_Configurations",
37170     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37171     "version": "0.0.0",
37172     "filename": "server/api/intZendeskConfiguration/index.js",
37173     "groupTitle": "Zendesk_Configurations"
37174   },
37175   {
37176     "type": "get",
37177     "url": "/api/integrations/zendesk/configurations/{id}/subjects",
37178     "title": "Gets configurations subjects",
37179     "examples": [
37180       {
37181         "title": "Example usage:",
37182         "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id}/subjects -v -u {name}:{password} -X GET",
37183         "type": "json"
37184       }
37185     ],
37186     "name": "getSubjects",
37187     "group": "Zendesk_Configurations",
37188     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37189     "version": "0.0.0",
37190     "filename": "server/api/intZendeskConfiguration/index.js",
37191     "groupTitle": "Zendesk_Configurations"
37192   },
37193   {
37194     "type": "get",
37195     "url": "/api/integrations/zendesk/configurations/{id}/tags",
37196     "title": "Gets configurations tags",
37197     "examples": [
37198       {
37199         "title": "Example usage:",
37200         "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id}/tags -v -u {name}:{password} -X GET",
37201         "type": "json"
37202       }
37203     ],
37204     "name": "getTags",
37205     "group": "Zendesk_Configurations",
37206     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37207     "version": "0.0.0",
37208     "filename": "server/api/intZendeskConfiguration/index.js",
37209     "groupTitle": "Zendesk_Configurations"
37210   },
37211   {
37212     "type": "post",
37213     "url": "/api/integrations/zendesk/configurations/{id}/tags",
37214     "title": "Sets new tags",
37215     "examples": [
37216       {
37217         "title": "Example usage:",
37218         "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",
37219         "type": "json"
37220       }
37221     ],
37222     "name": "setTags",
37223     "group": "Zendesk_Configurations",
37224     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37225     "version": "0.0.0",
37226     "filename": "server/api/intZendeskConfiguration/index.js",
37227     "groupTitle": "Zendesk_Configurations"
37228   },
37229   {
37230     "type": "put",
37231     "url": "/api/integrations/zendesk/configurations/{id}",
37232     "title": "Update an existing Zendesk Configuration",
37233     "examples": [
37234       {
37235         "title": "Example usage:",
37236         "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",
37237         "type": "json"
37238       }
37239     ],
37240     "name": "updateZendesk_Configurations",
37241     "group": "Zendesk_Configurations",
37242     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37243     "version": "0.0.0",
37244     "filename": "server/api/intZendeskConfiguration/index.js",
37245     "groupTitle": "Zendesk_Configurations"
37246   },
37247   {
37248     "type": "post",
37249     "url": "/api/integrations/zendesk/fields",
37250     "title": "Creates a new Zendesk Field",
37251     "examples": [
37252       {
37253         "title": "Example usage:",
37254         "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",
37255         "type": "json"
37256       }
37257     ],
37258     "name": "CreateZendesk_Fields",
37259     "group": "Zendesk_Fields",
37260     "parameter": {
37261       "fields": {
37262         "Body": [
37263           {
37264             "group": "Body",
37265             "type": "String",
37266             "allowedValues": [
37267               "\"string\"",
37268               "\"variable\"",
37269               "\"customVariable\"",
37270               "\"keyValue\"",
37271               "\"picklist\""
37272             ],
37273             "optional": true,
37274             "field": "type",
37275             "description": ""
37276           },
37277           {
37278             "group": "Body",
37279             "type": "String",
37280             "optional": true,
37281             "field": "content",
37282             "description": ""
37283           },
37284           {
37285             "group": "Body",
37286             "type": "String",
37287             "optional": true,
37288             "field": "key",
37289             "description": ""
37290           },
37291           {
37292             "group": "Body",
37293             "type": "String",
37294             "allowedValues": [
37295               "\"string\"",
37296               "\"variable\"",
37297               "\"customVariable\""
37298             ],
37299             "optional": true,
37300             "field": "keyType",
37301             "description": ""
37302           },
37303           {
37304             "group": "Body",
37305             "type": "String",
37306             "optional": true,
37307             "field": "keyContent",
37308             "description": ""
37309           },
37310           {
37311             "group": "Body",
37312             "type": "String",
37313             "optional": true,
37314             "field": "idField",
37315             "description": ""
37316           },
37317           {
37318             "group": "Body",
37319             "type": "String",
37320             "optional": true,
37321             "field": "nameField",
37322             "description": ""
37323           },
37324           {
37325             "group": "Body",
37326             "type": "Boolean",
37327             "optional": true,
37328             "field": "customField",
37329             "description": ""
37330           },
37331           {
37332             "group": "Body",
37333             "type": "String",
37334             "optional": true,
37335             "field": "variableName",
37336             "description": ""
37337           }
37338         ]
37339       }
37340     },
37341     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37342     "version": "0.0.0",
37343     "filename": "server/api/intZendeskField/index.js",
37344     "groupTitle": "Zendesk_Fields"
37345   },
37346   {
37347     "type": "delete",
37348     "url": "/api/integrations/zendesk/fields/{id}",
37349     "title": "Deletes a Zendesk Field",
37350     "examples": [
37351       {
37352         "title": "Example usage:",
37353         "content": "curl https://{domain}/api/integrations/zendesk/fields/{id} -v -u {name}:{password} -X DELETE",
37354         "type": "json"
37355       }
37356     ],
37357     "name": "DeleteZendesk_Fields",
37358     "group": "Zendesk_Fields",
37359     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37360     "version": "0.0.0",
37361     "filename": "server/api/intZendeskField/index.js",
37362     "groupTitle": "Zendesk_Fields"
37363   },
37364   {
37365     "type": "get",
37366     "url": "/api/integrations/zendesk/fields",
37367     "title": "Gets a list of Zendesk Fields",
37368     "examples": [
37369       {
37370         "title": "Example usage:",
37371         "content": "curl https://{domain}/api/integrations/zendesk/fields -v -u {name}:{password}",
37372         "type": "json"
37373       }
37374     ],
37375     "name": "GetZendesk_Fields",
37376     "group": "Zendesk_Fields",
37377     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
37378     "version": "0.0.0",
37379     "filename": "server/api/intZendeskField/index.js",
37380     "groupTitle": "Zendesk_Fields"
37381   },
37382   {
37383     "type": "get",
37384     "url": "/api/integrations/zendesk/fields/{id}",
37385     "title": "Gets a single Zendesk Field",
37386     "examples": [
37387       {
37388         "title": "Example usage:",
37389         "content": "curl https://{domain}/api/integrations/zendesk/fields/{id} -v -u {name}:{password}",
37390         "type": "json"
37391       }
37392     ],
37393     "name": "ShowZendesk_Fields",
37394     "group": "Zendesk_Fields",
37395     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37396     "version": "0.0.0",
37397     "filename": "server/api/intZendeskField/index.js",
37398     "groupTitle": "Zendesk_Fields"
37399   },
37400   {
37401     "type": "put",
37402     "url": "/api/integrations/zendesk/fields/{id}",
37403     "title": "Update an existing Zendesk Field",
37404     "examples": [
37405       {
37406         "title": "Example usage:",
37407         "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",
37408         "type": "json"
37409       }
37410     ],
37411     "name": "updateZendesk_Fields",
37412     "group": "Zendesk_Fields",
37413     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37414     "version": "0.0.0",
37415     "filename": "server/api/intZendeskField/index.js",
37416     "groupTitle": "Zendesk_Fields"
37417   },
37418   {
37419     "type": "post",
37420     "url": "/api/integrations/zoho/accounts",
37421     "title": "Creates a new Zoho Account",
37422     "examples": [
37423       {
37424         "title": "Example usage:",
37425         "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",
37426         "type": "json"
37427       }
37428     ],
37429     "name": "CreateZoho_Accounts",
37430     "group": "Zoho_Accounts",
37431     "parameter": {
37432       "fields": {
37433         "Body": [
37434           {
37435             "group": "Body",
37436             "type": "String",
37437             "optional": true,
37438             "field": "name",
37439             "description": ""
37440           },
37441           {
37442             "group": "Body",
37443             "type": "String",
37444             "optional": true,
37445             "field": "description",
37446             "description": ""
37447           },
37448           {
37449             "group": "Body",
37450             "type": "String",
37451             "optional": true,
37452             "field": "host",
37453             "description": ""
37454           },
37455           {
37456             "group": "Body",
37457             "type": "String",
37458             "optional": true,
37459             "field": "zone",
37460             "description": ""
37461           },
37462           {
37463             "group": "Body",
37464             "type": "String",
37465             "optional": true,
37466             "field": "clientId",
37467             "description": ""
37468           },
37469           {
37470             "group": "Body",
37471             "type": "String",
37472             "optional": true,
37473             "field": "clientSecret",
37474             "description": ""
37475           },
37476           {
37477             "group": "Body",
37478             "type": "String",
37479             "optional": false,
37480             "field": "serverUrl",
37481             "description": ""
37482           },
37483           {
37484             "group": "Body",
37485             "type": "String",
37486             "optional": true,
37487             "field": "code",
37488             "description": ""
37489           },
37490           {
37491             "group": "Body",
37492             "type": "String",
37493             "optional": true,
37494             "field": "refreshToken",
37495             "description": ""
37496           }
37497         ]
37498       }
37499     },
37500     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37501     "version": "0.0.0",
37502     "filename": "server/api/intZohoAccount/index.js",
37503     "groupTitle": "Zoho_Accounts"
37504   },
37505   {
37506     "type": "delete",
37507     "url": "/api/integrations/zoho/accounts/{id}",
37508     "title": "Deletes a Zoho Account",
37509     "examples": [
37510       {
37511         "title": "Example usage:",
37512         "content": "curl https://{domain}/api/integrations/zoho/accounts/{id} -v -u {name}:{password} -X DELETE",
37513         "type": "json"
37514       }
37515     ],
37516     "name": "DeleteZoho_Accounts",
37517     "group": "Zoho_Accounts",
37518     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37519     "version": "0.0.0",
37520     "filename": "server/api/intZohoAccount/index.js",
37521     "groupTitle": "Zoho_Accounts"
37522   },
37523   {
37524     "type": "get",
37525     "url": "/api/integrations/zoho/accounts",
37526     "title": "Gets a list of Zoho Accounts",
37527     "examples": [
37528       {
37529         "title": "Example usage:",
37530         "content": "curl https://{domain}/api/integrations/zoho/accounts -v -u {name}:{password}",
37531         "type": "json"
37532       }
37533     ],
37534     "name": "GetZoho_Accounts",
37535     "group": "Zoho_Accounts",
37536     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
37537     "version": "0.0.0",
37538     "filename": "server/api/intZohoAccount/index.js",
37539     "groupTitle": "Zoho_Accounts"
37540   },
37541   {
37542     "type": "get",
37543     "url": "/api/integrations/zoho/accounts/{id}",
37544     "title": "Gets a single Zoho Account",
37545     "examples": [
37546       {
37547         "title": "Example usage:",
37548         "content": "curl https://{domain}/api/integrations/zoho/accounts/{id} -v -u {name}:{password}",
37549         "type": "json"
37550       }
37551     ],
37552     "name": "ShowZoho_Accounts",
37553     "group": "Zoho_Accounts",
37554     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37555     "version": "0.0.0",
37556     "filename": "server/api/intZohoAccount/index.js",
37557     "groupTitle": "Zoho_Accounts"
37558   },
37559   {
37560     "type": "post",
37561     "url": "/api/integrations/zoho/accounts/{id}/configurations",
37562     "title": "Creates new configuration",
37563     "examples": [
37564       {
37565         "title": "Example usage:",
37566         "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",
37567         "type": "json"
37568       }
37569     ],
37570     "name": "addConfiguration",
37571     "group": "Zoho_Accounts",
37572     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37573     "version": "0.0.0",
37574     "filename": "server/api/intZohoAccount/index.js",
37575     "groupTitle": "Zoho_Accounts"
37576   },
37577   {
37578     "type": "get",
37579     "url": "/api/integrations/zoho/accounts/{id}/configurations",
37580     "title": "Gets account configurations",
37581     "examples": [
37582       {
37583         "title": "Example usage:",
37584         "content": "curl https://{domain}/api/integrations/zoho/accounts/{id}/configurations -v -u {name}:{password} -X GET",
37585         "type": "json"
37586       }
37587     ],
37588     "name": "getConfigurations",
37589     "group": "Zoho_Accounts",
37590     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37591     "version": "0.0.0",
37592     "filename": "server/api/intZohoAccount/index.js",
37593     "groupTitle": "Zoho_Accounts"
37594   },
37595   {
37596     "type": "get",
37597     "url": "/api/integrations/zoho/accounts/{id}/fields",
37598     "title": "Gets account fields",
37599     "examples": [
37600       {
37601         "title": "Example usage:",
37602         "content": "curl https://{domain}/api/integrations/zoho/accounts/{id}/fields -v -u {name}:{password} -X GET",
37603         "type": "json"
37604       }
37605     ],
37606     "name": "getFields",
37607     "group": "Zoho_Accounts",
37608     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37609     "version": "0.0.0",
37610     "filename": "server/api/intZohoAccount/index.js",
37611     "groupTitle": "Zoho_Accounts"
37612   },
37613   {
37614     "type": "put",
37615     "url": "/api/integrations/zoho/accounts/{id}",
37616     "title": "Update an existing Zoho Account",
37617     "examples": [
37618       {
37619         "title": "Example usage:",
37620         "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",
37621         "type": "json"
37622       }
37623     ],
37624     "name": "updateZoho_Accounts",
37625     "group": "Zoho_Accounts",
37626     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37627     "version": "0.0.0",
37628     "filename": "server/api/intZohoAccount/index.js",
37629     "groupTitle": "Zoho_Accounts"
37630   },
37631   {
37632     "type": "post",
37633     "url": "/api/integrations/zoho/configurations",
37634     "title": "Creates a new Zoho Configuration",
37635     "examples": [
37636       {
37637         "title": "Example usage:",
37638         "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",
37639         "type": "json"
37640       }
37641     ],
37642     "name": "CreateZoho_Configurations",
37643     "group": "Zoho_Configurations",
37644     "parameter": {
37645       "fields": {
37646         "Body": [
37647           {
37648             "group": "Body",
37649             "type": "String",
37650             "optional": true,
37651             "field": "name",
37652             "description": ""
37653           },
37654           {
37655             "group": "Body",
37656             "type": "String",
37657             "allowedValues": [
37658               "\"lead\"",
37659               "\"contact\"",
37660               "\"nothing\""
37661             ],
37662             "optional": true,
37663             "field": "moduleCreate",
37664             "description": ""
37665           },
37666           {
37667             "group": "Body",
37668             "type": "String",
37669             "allowedValues": [
37670               "\"contact_lead\"",
37671               "\"contact\"",
37672               "\"lead\""
37673             ],
37674             "optional": true,
37675             "field": "moduleSearch",
37676             "description": ""
37677           },
37678           {
37679             "group": "Body",
37680             "type": "String",
37681             "optional": true,
37682             "field": "description",
37683             "description": ""
37684           }
37685         ]
37686       }
37687     },
37688     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37689     "version": "0.0.0",
37690     "filename": "server/api/intZohoConfiguration/index.js",
37691     "groupTitle": "Zoho_Configurations"
37692   },
37693   {
37694     "type": "delete",
37695     "url": "/api/integrations/zoho/configurations/{id}",
37696     "title": "Deletes a Zoho Configuration",
37697     "examples": [
37698       {
37699         "title": "Example usage:",
37700         "content": "curl https://{domain}/api/integrations/zoho/configurations/{id} -v -u {name}:{password} -X DELETE",
37701         "type": "json"
37702       }
37703     ],
37704     "name": "DeleteZoho_Configurations",
37705     "group": "Zoho_Configurations",
37706     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37707     "version": "0.0.0",
37708     "filename": "server/api/intZohoConfiguration/index.js",
37709     "groupTitle": "Zoho_Configurations"
37710   },
37711   {
37712     "type": "get",
37713     "url": "/api/integrations/zoho/configurations",
37714     "title": "Gets a list of Zoho Configurations",
37715     "examples": [
37716       {
37717         "title": "Example usage:",
37718         "content": "curl https://{domain}/api/integrations/zoho/configurations -v -u {name}:{password}",
37719         "type": "json"
37720       }
37721     ],
37722     "name": "GetZoho_Configurations",
37723     "group": "Zoho_Configurations",
37724     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
37725     "version": "0.0.0",
37726     "filename": "server/api/intZohoConfiguration/index.js",
37727     "groupTitle": "Zoho_Configurations"
37728   },
37729   {
37730     "type": "get",
37731     "url": "/api/integrations/zoho/configurations/{id}",
37732     "title": "Gets a single Zoho Configuration",
37733     "examples": [
37734       {
37735         "title": "Example usage:",
37736         "content": "curl https://{domain}/api/integrations/zoho/configurations/{id} -v -u {name}:{password}",
37737         "type": "json"
37738       }
37739     ],
37740     "name": "ShowZoho_Configurations",
37741     "group": "Zoho_Configurations",
37742     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37743     "version": "0.0.0",
37744     "filename": "server/api/intZohoConfiguration/index.js",
37745     "groupTitle": "Zoho_Configurations"
37746   },
37747   {
37748     "type": "get",
37749     "url": "/api/integrations/zoho/configurations/{id}/descriptions",
37750     "title": "Gets configurations descriptions",
37751     "examples": [
37752       {
37753         "title": "Example usage:",
37754         "content": "curl https://{domain}/api/integrations/zoho/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
37755         "type": "json"
37756       }
37757     ],
37758     "name": "getDescriptions",
37759     "group": "Zoho_Configurations",
37760     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37761     "version": "0.0.0",
37762     "filename": "server/api/intZohoConfiguration/index.js",
37763     "groupTitle": "Zoho_Configurations"
37764   },
37765   {
37766     "type": "get",
37767     "url": "/api/integrations/zoho/configurations/{id}/fields",
37768     "title": "Gets configurations fields",
37769     "examples": [
37770       {
37771         "title": "Example usage:",
37772         "content": "curl https://{domain}/api/integrations/zoho/configurations/{id}/fields -v -u {name}:{password} -X GET",
37773         "type": "json"
37774       }
37775     ],
37776     "name": "getFields",
37777     "group": "Zoho_Configurations",
37778     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37779     "version": "0.0.0",
37780     "filename": "server/api/intZohoConfiguration/index.js",
37781     "groupTitle": "Zoho_Configurations"
37782   },
37783   {
37784     "type": "get",
37785     "url": "/api/integrations/zoho/configurations/{id}/subjects",
37786     "title": "Gets configurations subjects",
37787     "examples": [
37788       {
37789         "title": "Example usage:",
37790         "content": "curl https://{domain}/api/integrations/zoho/configurations/{id}/subjects -v -u {name}:{password} -X GET",
37791         "type": "json"
37792       }
37793     ],
37794     "name": "getSubjects",
37795     "group": "Zoho_Configurations",
37796     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37797     "version": "0.0.0",
37798     "filename": "server/api/intZohoConfiguration/index.js",
37799     "groupTitle": "Zoho_Configurations"
37800   },
37801   {
37802     "type": "put",
37803     "url": "/api/integrations/zoho/configurations/{id}",
37804     "title": "Update an existing Zoho Configuration",
37805     "examples": [
37806       {
37807         "title": "Example usage:",
37808         "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",
37809         "type": "json"
37810       }
37811     ],
37812     "name": "updateZoho_Configurations",
37813     "group": "Zoho_Configurations",
37814     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37815     "version": "0.0.0",
37816     "filename": "server/api/intZohoConfiguration/index.js",
37817     "groupTitle": "Zoho_Configurations"
37818   },
37819   {
37820     "type": "post",
37821     "url": "/api/integrations/zoho/fields",
37822     "title": "Creates a new Zoho Field",
37823     "examples": [
37824       {
37825         "title": "Example usage:",
37826         "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",
37827         "type": "json"
37828       }
37829     ],
37830     "name": "CreateZoho_Fields",
37831     "group": "Zoho_Fields",
37832     "parameter": {
37833       "fields": {
37834         "Body": [
37835           {
37836             "group": "Body",
37837             "type": "String",
37838             "allowedValues": [
37839               "\"string\"",
37840               "\"variable\"",
37841               "\"customVariable\"",
37842               "\"keyValue\"",
37843               "\"picklist\""
37844             ],
37845             "optional": true,
37846             "field": "type",
37847             "description": ""
37848           },
37849           {
37850             "group": "Body",
37851             "type": "String",
37852             "optional": true,
37853             "field": "content",
37854             "description": ""
37855           },
37856           {
37857             "group": "Body",
37858             "type": "String",
37859             "optional": true,
37860             "field": "key",
37861             "description": ""
37862           },
37863           {
37864             "group": "Body",
37865             "type": "String",
37866             "allowedValues": [
37867               "\"string\"",
37868               "\"variable\"",
37869               "\"customVariable\""
37870             ],
37871             "optional": true,
37872             "field": "keyType",
37873             "description": ""
37874           },
37875           {
37876             "group": "Body",
37877             "type": "String",
37878             "optional": true,
37879             "field": "keyContent",
37880             "description": ""
37881           },
37882           {
37883             "group": "Body",
37884             "type": "String",
37885             "optional": true,
37886             "field": "idField",
37887             "description": ""
37888           },
37889           {
37890             "group": "Body",
37891             "type": "String",
37892             "optional": true,
37893             "field": "nameField",
37894             "description": ""
37895           },
37896           {
37897             "group": "Body",
37898             "type": "Boolean",
37899             "optional": true,
37900             "field": "customField",
37901             "description": ""
37902           },
37903           {
37904             "group": "Body",
37905             "type": "String",
37906             "optional": true,
37907             "field": "variableName",
37908             "description": ""
37909           }
37910         ]
37911       }
37912     },
37913     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37914     "version": "0.0.0",
37915     "filename": "server/api/intZohoField/index.js",
37916     "groupTitle": "Zoho_Fields"
37917   },
37918   {
37919     "type": "delete",
37920     "url": "/api/integrations/zoho/fields/{id}",
37921     "title": "Deletes a Zoho Field",
37922     "examples": [
37923       {
37924         "title": "Example usage:",
37925         "content": "curl https://{domain}/api/integrations/zoho/fields/{id} -v -u {name}:{password} -X DELETE",
37926         "type": "json"
37927       }
37928     ],
37929     "name": "DeleteZoho_Fields",
37930     "group": "Zoho_Fields",
37931     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37932     "version": "0.0.0",
37933     "filename": "server/api/intZohoField/index.js",
37934     "groupTitle": "Zoho_Fields"
37935   },
37936   {
37937     "type": "get",
37938     "url": "/api/integrations/zoho/fields",
37939     "title": "Gets a list of Zoho Fields",
37940     "examples": [
37941       {
37942         "title": "Example usage:",
37943         "content": "curl https://{domain}/api/integrations/zoho/fields -v -u {name}:{password}",
37944         "type": "json"
37945       }
37946     ],
37947     "name": "GetZoho_Fields",
37948     "group": "Zoho_Fields",
37949     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
37950     "version": "0.0.0",
37951     "filename": "server/api/intZohoField/index.js",
37952     "groupTitle": "Zoho_Fields"
37953   },
37954   {
37955     "type": "get",
37956     "url": "/api/integrations/zoho/fields/{id}",
37957     "title": "Gets a single Zoho Field",
37958     "examples": [
37959       {
37960         "title": "Example usage:",
37961         "content": "curl https://{domain}/api/integrations/zoho/fields/{id} -v -u {name}:{password}",
37962         "type": "json"
37963       }
37964     ],
37965     "name": "ShowZoho_Fields",
37966     "group": "Zoho_Fields",
37967     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37968     "version": "0.0.0",
37969     "filename": "server/api/intZohoField/index.js",
37970     "groupTitle": "Zoho_Fields"
37971   },
37972   {
37973     "type": "put",
37974     "url": "/api/integrations/zoho/fields/{id}",
37975     "title": "Update an existing Zoho Field",
37976     "examples": [
37977       {
37978         "title": "Example usage:",
37979         "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",
37980         "type": "json"
37981       }
37982     ],
37983     "name": "updateZoho_Fields",
37984     "group": "Zoho_Fields",
37985     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37986     "version": "0.0.0",
37987     "filename": "server/api/intZohoField/index.js",
37988     "groupTitle": "Zoho_Fields"
37989   },
37990   {
37991     "type": "post",
37992     "url": "/api/cdr",
37993     "title": "Creates a new Cdr",
37994     "examples": [
37995       {
37996         "title": "Example usage:",
37997         "content": "curl https://{domain}/api/cdr -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
37998         "type": "json"
37999       }
38000     ],
38001     "name": "CreateCdrs",
38002     "group": "cdr",
38003     "parameter": {
38004       "fields": {
38005         "Body": [
38006           {
38007             "group": "Body",
38008             "type": "String",
38009             "optional": false,
38010             "field": "calldate",
38011             "description": ""
38012           },
38013           {
38014             "group": "Body",
38015             "type": "String",
38016             "optional": true,
38017             "field": "clid",
38018             "description": ""
38019           },
38020           {
38021             "group": "Body",
38022             "type": "String",
38023             "optional": true,
38024             "field": "src",
38025             "description": ""
38026           },
38027           {
38028             "group": "Body",
38029             "type": "String",
38030             "optional": true,
38031             "field": "dst",
38032             "description": ""
38033           },
38034           {
38035             "group": "Body",
38036             "type": "String",
38037             "optional": true,
38038             "field": "dcontext",
38039             "description": ""
38040           },
38041           {
38042             "group": "Body",
38043             "type": "String",
38044             "optional": true,
38045             "field": "channel",
38046             "description": ""
38047           },
38048           {
38049             "group": "Body",
38050             "type": "String",
38051             "optional": true,
38052             "field": "dstchannel",
38053             "description": ""
38054           },
38055           {
38056             "group": "Body",
38057             "type": "String",
38058             "optional": true,
38059             "field": "lastapp",
38060             "description": ""
38061           },
38062           {
38063             "group": "Body",
38064             "type": "String",
38065             "optional": true,
38066             "field": "lastdata",
38067             "description": ""
38068           },
38069           {
38070             "group": "Body",
38071             "type": "Integer",
38072             "optional": false,
38073             "field": "duration",
38074             "description": ""
38075           },
38076           {
38077             "group": "Body",
38078             "type": "Integer",
38079             "optional": false,
38080             "field": "billsec",
38081             "description": ""
38082           },
38083           {
38084             "group": "Body",
38085             "type": "String",
38086             "optional": true,
38087             "field": "disposition",
38088             "description": ""
38089           },
38090           {
38091             "group": "Body",
38092             "type": "Integer",
38093             "optional": false,
38094             "field": "amaflags",
38095             "description": ""
38096           },
38097           {
38098             "group": "Body",
38099             "type": "String",
38100             "optional": true,
38101             "field": "accountcode",
38102             "description": ""
38103           },
38104           {
38105             "group": "Body",
38106             "type": "String",
38107             "optional": true,
38108             "field": "userfield",
38109             "description": ""
38110           },
38111           {
38112             "group": "Body",
38113             "type": "String",
38114             "optional": true,
38115             "field": "uniqueid",
38116             "description": ""
38117           },
38118           {
38119             "group": "Body",
38120             "type": "String",
38121             "optional": true,
38122             "field": "linkedid",
38123             "description": ""
38124           },
38125           {
38126             "group": "Body",
38127             "type": "String",
38128             "optional": true,
38129             "field": "sequence",
38130             "description": ""
38131           },
38132           {
38133             "group": "Body",
38134             "type": "String",
38135             "optional": true,
38136             "field": "peeraccount",
38137             "description": ""
38138           },
38139           {
38140             "group": "Body",
38141             "type": "String",
38142             "optional": true,
38143             "field": "type",
38144             "description": ""
38145           },
38146           {
38147             "group": "Body",
38148             "type": "String",
38149             "optional": true,
38150             "field": "tag",
38151             "description": ""
38152           }
38153         ]
38154       }
38155     },
38156     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
38157     "version": "0.0.0",
38158     "filename": "server/api/cdr/index.js",
38159     "groupTitle": "cdr"
38160   },
38161   {
38162     "type": "delete",
38163     "url": "/api/cdr/{id}",
38164     "title": "Deletes a Cdr",
38165     "examples": [
38166       {
38167         "title": "Example usage:",
38168         "content": "curl https://{domain}/api/cdr/{id} -v -u {name}:{password} -X DELETE",
38169         "type": "json"
38170       }
38171     ],
38172     "name": "DeleteCdrs",
38173     "group": "cdr",
38174     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
38175     "version": "0.0.0",
38176     "filename": "server/api/cdr/index.js",
38177     "groupTitle": "cdr"
38178   },
38179   {
38180     "type": "get",
38181     "url": "/api/cdr/describe",
38182     "title": "Gets table info about Cdrs",
38183     "examples": [
38184       {
38185         "title": "Example usage:",
38186         "content": "curl https://{domain}/api/cdr/describe -v -u {name}:{password}",
38187         "type": "json"
38188       }
38189     ],
38190     "name": "DescribeCdrs",
38191     "group": "cdr",
38192     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
38193     "version": "0.0.0",
38194     "filename": "server/api/cdr/index.js",
38195     "groupTitle": "cdr"
38196   },
38197   {
38198     "type": "get",
38199     "url": "/api/cdr",
38200     "title": "Gets a list of Cdrs",
38201     "examples": [
38202       {
38203         "title": "Example usage:",
38204         "content": "curl https://{domain}/api/cdr -v -u {name}:{password}",
38205         "type": "json"
38206       }
38207     ],
38208     "name": "GetCdrs",
38209     "group": "cdr",
38210     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
38211     "version": "0.0.0",
38212     "filename": "server/api/cdr/index.js",
38213     "groupTitle": "cdr"
38214   },
38215   {
38216     "type": "get",
38217     "url": "/api/cdr/{id}",
38218     "title": "Gets a single Cdr",
38219     "examples": [
38220       {
38221         "title": "Example usage:",
38222         "content": "curl https://{domain}/api/cdr/{id} -v -u {name}:{password}",
38223         "type": "json"
38224       }
38225     ],
38226     "name": "ShowCdrs",
38227     "group": "cdr",
38228     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
38229     "version": "0.0.0",
38230     "filename": "server/api/cdr/index.js",
38231     "groupTitle": "cdr"
38232   },
38233   {
38234     "type": "put",
38235     "url": "/api/cdr/{id}",
38236     "title": "Update an existing Cdr",
38237     "examples": [
38238       {
38239         "title": "Example usage:",
38240         "content": "curl https://{domain}/api/cdr/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
38241         "type": "json"
38242       }
38243     ],
38244     "name": "updateCdrs",
38245     "group": "cdr",
38246     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
38247     "version": "0.0.0",
38248     "filename": "server/api/cdr/index.js",
38249     "groupTitle": "cdr"
38250   },
38251   {
38252     "type": "post",
38253     "url": "/api/voiceQueuesLog",
38254     "title": "Creates a new VoiceQueuesLog",
38255     "examples": [
38256       {
38257         "title": "Example usage:",
38258         "content": "curl https://{domain}/api/voiceQueuesLog -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
38259         "type": "json"
38260       }
38261     ],
38262     "name": "CreateVoiceQueuesLogs",
38263     "group": "voiceQueuesLog",
38264     "parameter": {
38265       "fields": {
38266         "Body": [
38267           {
38268             "group": "Body",
38269             "type": "String",
38270             "optional": true,
38271             "field": "time",
38272             "description": ""
38273           },
38274           {
38275             "group": "Body",
38276             "type": "String",
38277             "optional": false,
38278             "field": "callid",
38279             "description": ""
38280           },
38281           {
38282             "group": "Body",
38283             "type": "String",
38284             "optional": false,
38285             "field": "queuename",
38286             "description": ""
38287           },
38288           {
38289             "group": "Body",
38290             "type": "String",
38291             "optional": false,
38292             "field": "agent",
38293             "description": ""
38294           },
38295           {
38296             "group": "Body",
38297             "type": "String",
38298             "optional": false,
38299             "field": "event",
38300             "description": ""
38301           },
38302           {
38303             "group": "Body",
38304             "type": "String",
38305             "optional": false,
38306             "field": "data",
38307             "description": ""
38308           },
38309           {
38310             "group": "Body",
38311             "type": "String",
38312             "optional": false,
38313             "field": "data1",
38314             "description": ""
38315           },
38316           {
38317             "group": "Body",
38318             "type": "String",
38319             "optional": false,
38320             "field": "data2",
38321             "description": ""
38322           },
38323           {
38324             "group": "Body",
38325             "type": "String",
38326             "optional": false,
38327             "field": "data3",
38328             "description": ""
38329           },
38330           {
38331             "group": "Body",
38332             "type": "String",
38333             "optional": false,
38334             "field": "data4",
38335             "description": ""
38336           },
38337           {
38338             "group": "Body",
38339             "type": "String",
38340             "optional": false,
38341             "field": "data5",
38342             "description": ""
38343           },
38344           {
38345             "group": "Body",
38346             "type": "String",
38347             "optional": false,
38348             "field": "dtm",
38349             "description": ""
38350           }
38351         ]
38352       }
38353     },
38354     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
38355     "version": "0.0.0",
38356     "filename": "server/api/voiceQueuesLog/index.js",
38357     "groupTitle": "voiceQueuesLog"
38358   },
38359   {
38360     "type": "delete",
38361     "url": "/api/voiceQueuesLog/{id}",
38362     "title": "Deletes a VoiceQueuesLog",
38363     "examples": [
38364       {
38365         "title": "Example usage:",
38366         "content": "curl https://{domain}/api/voiceQueuesLog/{id} -v -u {name}:{password} -X DELETE",
38367         "type": "json"
38368       }
38369     ],
38370     "name": "DeleteVoiceQueuesLogs",
38371     "group": "voiceQueuesLog",
38372     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
38373     "version": "0.0.0",
38374     "filename": "server/api/voiceQueuesLog/index.js",
38375     "groupTitle": "voiceQueuesLog"
38376   },
38377   {
38378     "type": "get",
38379     "url": "/api/voiceQueuesLog",
38380     "title": "Gets a list of VoiceQueuesLogs",
38381     "examples": [
38382       {
38383         "title": "Example usage:",
38384         "content": "curl https://{domain}/api/voiceQueuesLog -v -u {name}:{password}",
38385         "type": "json"
38386       }
38387     ],
38388     "name": "GetVoiceQueuesLogs",
38389     "group": "voiceQueuesLog",
38390     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
38391     "version": "0.0.0",
38392     "filename": "server/api/voiceQueuesLog/index.js",
38393     "groupTitle": "voiceQueuesLog"
38394   },
38395   {
38396     "type": "get",
38397     "url": "/api/voiceQueuesLog/{id}",
38398     "title": "Gets a single VoiceQueuesLog",
38399     "examples": [
38400       {
38401         "title": "Example usage:",
38402         "content": "curl https://{domain}/api/voiceQueuesLog/{id} -v -u {name}:{password}",
38403         "type": "json"
38404       }
38405     ],
38406     "name": "ShowVoiceQueuesLogs",
38407     "group": "voiceQueuesLog",
38408     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
38409     "version": "0.0.0",
38410     "filename": "server/api/voiceQueuesLog/index.js",
38411     "groupTitle": "voiceQueuesLog"
38412   },
38413   {
38414     "type": "put",
38415     "url": "/api/voiceQueuesLog/{id}",
38416     "title": "Update an existing VoiceQueuesLog",
38417     "examples": [
38418       {
38419         "title": "Example usage:",
38420         "content": "curl https://{domain}/api/voiceQueuesLog/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
38421         "type": "json"
38422       }
38423     ],
38424     "name": "updateVoiceQueuesLogs",
38425     "group": "voiceQueuesLog",
38426     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
38427     "version": "0.0.0",
38428     "filename": "server/api/voiceQueuesLog/index.js",
38429     "groupTitle": "voiceQueuesLog"
38430   }
38431 ]