apidoc/api_data.js

   1 define({ "api": [
   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/google",
1305     "title": "Creates a new User token",
1306     "examples": [
1307       {
1308         "title": "Example usage:",
1309         "content": "curl https://{domain}/api/auth/google -d '{\"name\": \"john.doe\", \"password\": \"password\"}' \\\n -H \"Content-Type: application/json\" -X POST",
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/authGoogle/index.js",
1338     "groupTitle": "Authentication"
1339   },
1340   {
1341     "type": "post",
1342     "url": "/api/auth/local",
1343     "title": "Creates a new User token",
1344     "examples": [
1345       {
1346         "title": "Example usage:",
1347         "content": "curl https://{domain}/api/auth/local -d '{\"name\": \"john.doe\", \"password\": \"password\"}' \\\n -H \"Content-Type: application/json\" -X POST",
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/authLocal/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": "note",
2188             "description": ""
2189           },
2190           {
2191             "group": "Body",
2192             "type": "String",
2193             "optional": true,
2194             "field": "browserName",
2195             "description": ""
2196           },
2197           {
2198             "group": "Body",
2199             "type": "String",
2200             "optional": true,
2201             "field": "browserVersion",
2202             "description": ""
2203           },
2204           {
2205             "group": "Body",
2206             "type": "String",
2207             "optional": true,
2208             "field": "osName",
2209             "description": ""
2210           },
2211           {
2212             "group": "Body",
2213             "type": "String",
2214             "optional": true,
2215             "field": "osVersion",
2216             "description": ""
2217           },
2218           {
2219             "group": "Body",
2220             "type": "String",
2221             "optional": true,
2222             "field": "deviceModel",
2223             "description": ""
2224           },
2225           {
2226             "group": "Body",
2227             "type": "String",
2228             "optional": true,
2229             "field": "deviceVendor",
2230             "description": ""
2231           },
2232           {
2233             "group": "Body",
2234             "type": "String",
2235             "optional": true,
2236             "field": "deviceType",
2237             "description": ""
2238           },
2239           {
2240             "group": "Body",
2241             "type": "Text",
2242             "optional": true,
2243             "field": "referer",
2244             "description": ""
2245           },
2246           {
2247             "group": "Body",
2248             "type": "String",
2249             "optional": true,
2250             "field": "customerIp",
2251             "description": ""
2252           },
2253           {
2254             "group": "Body",
2255             "type": "Text",
2256             "optional": true,
2257             "field": "formData",
2258             "description": ""
2259           },
2260           {
2261             "group": "Body",
2262             "type": "String",
2263             "optional": true,
2264             "field": "read1stAt",
2265             "description": ""
2266           },
2267           {
2268             "group": "Body",
2269             "type": "String",
2270             "optional": true,
2271             "field": "lastMsgAt",
2272             "description": ""
2273           },
2274           {
2275             "group": "Body",
2276             "type": "String",
2277             "allowedValues": [
2278               "\"in\"",
2279               "\"out\""
2280             ],
2281             "optional": false,
2282             "field": "lastMsgDirection",
2283             "description": ""
2284           },
2285           {
2286             "group": "Body",
2287             "type": "String",
2288             "optional": true,
2289             "field": "closeReason",
2290             "description": ""
2291           },
2292           {
2293             "group": "Body",
2294             "type": "String",
2295             "optional": true,
2296             "field": "customerPort",
2297             "description": ""
2298           },
2299           {
2300             "group": "Body",
2301             "type": "Text",
2302             "optional": true,
2303             "field": "vidaooSessionId",
2304             "description": ""
2305           }
2306         ]
2307       }
2308     },
2309     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2310     "version": "0.0.0",
2311     "filename": "server/api/chatInteraction/index.js",
2312     "groupTitle": "Chat_Interactions"
2313   },
2314   {
2315     "type": "delete",
2316     "url": "/api/chat/interactions/{id}",
2317     "title": "Deletes a Interaction",
2318     "examples": [
2319       {
2320         "title": "Example usage:",
2321         "content": "curl https://{domain}/api/chat/interactions/{id} -v -u {name}:{password} -X DELETE",
2322         "type": "json"
2323       }
2324     ],
2325     "name": "DeleteInteractions",
2326     "group": "Chat_Interactions",
2327     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2328     "version": "0.0.0",
2329     "filename": "server/api/chatInteraction/index.js",
2330     "groupTitle": "Chat_Interactions"
2331   },
2332   {
2333     "type": "get",
2334     "url": "/api/chat/interactions/describe",
2335     "title": "Gets table info about Interactions",
2336     "examples": [
2337       {
2338         "title": "Example usage:",
2339         "content": "curl https://{domain}/api/chat/interactions/describe -v -u {name}:{password}",
2340         "type": "json"
2341       }
2342     ],
2343     "name": "DescribeInteractions",
2344     "group": "Chat_Interactions",
2345     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2346     "version": "0.0.0",
2347     "filename": "server/api/chatInteraction/index.js",
2348     "groupTitle": "Chat_Interactions"
2349   },
2350   {
2351     "type": "get",
2352     "url": "/api/chat/interactions",
2353     "title": "Gets a list of Interactions",
2354     "examples": [
2355       {
2356         "title": "Example usage:",
2357         "content": "curl https://{domain}/api/chat/interactions -v -u {name}:{password}",
2358         "type": "json"
2359       }
2360     ],
2361     "name": "GetInteractions",
2362     "group": "Chat_Interactions",
2363     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
2364     "version": "0.0.0",
2365     "filename": "server/api/chatInteraction/index.js",
2366     "groupTitle": "Chat_Interactions"
2367   },
2368   {
2369     "type": "delete",
2370     "url": "/api/chat/interactions/{id}/tags",
2371     "title": "Removes tags from interaction",
2372     "examples": [
2373       {
2374         "title": "Example usage:",
2375         "content": "curl https://{domain}/api/chat/interactions/{id}/tags?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
2376         "type": "json"
2377       }
2378     ],
2379     "name": "RemoveTags",
2380     "group": "Chat_Interactions",
2381     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2382     "version": "0.0.0",
2383     "filename": "server/api/chatInteraction/index.js",
2384     "groupTitle": "Chat_Interactions"
2385   },
2386   {
2387     "type": "get",
2388     "url": "/api/chat/interactions/{id}",
2389     "title": "Gets a single Interaction",
2390     "examples": [
2391       {
2392         "title": "Example usage:",
2393         "content": "curl https://{domain}/api/chat/interactions/{id} -v -u {name}:{password}",
2394         "type": "json"
2395       }
2396     ],
2397     "name": "ShowInteractions",
2398     "group": "Chat_Interactions",
2399     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2400     "version": "0.0.0",
2401     "filename": "server/api/chatInteraction/index.js",
2402     "groupTitle": "Chat_Interactions"
2403   },
2404   {
2405     "type": "put",
2406     "url": "/api/chat/interactions/{id}/abandon",
2407     "title": "Abandon interaction",
2408     "examples": [
2409       {
2410         "title": "Example usage:",
2411         "content": "curl https://{domain}/api/chat/interactions/{id}/abandon -d '{\"channel\": \"chat\", \"...\": \"...\"}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
2412         "type": "json"
2413       }
2414     ],
2415     "name": "abandon",
2416     "group": "Chat_Interactions",
2417     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <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>",
2418     "version": "0.0.0",
2419     "filename": "server/api/chatInteraction/index.js",
2420     "groupTitle": "Chat_Interactions"
2421   },
2422   {
2423     "type": "put",
2424     "url": "/api/chat/interactions/{id}/close",
2425     "title": "Close Interaction",
2426     "examples": [
2427       {
2428         "title": "Example usage:",
2429         "content": "curl https://{domain}/api/chat/interactions/{id}/close -d '[{\"to\": \"+3901119886500\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
2430         "type": "json"
2431       }
2432     ],
2433     "name": "addMessage",
2434     "group": "Chat_Interactions",
2435     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2436     "version": "0.0.0",
2437     "filename": "server/api/chatInteraction/index.js",
2438     "groupTitle": "Chat_Interactions"
2439   },
2440   {
2441     "type": "post",
2442     "url": "/api/chat/interactions/{id}/messages",
2443     "title": "Creates new messages",
2444     "examples": [
2445       {
2446         "title": "Example usage:",
2447         "content": "curl https://{domain}/api/chat/interactions/{id}/messages -d '[{\"to\": \"+3901119886500\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
2448         "type": "json"
2449       }
2450     ],
2451     "name": "addMessage",
2452     "group": "Chat_Interactions",
2453     "parameter": {
2454       "fields": {
2455         "Body": [
2456           {
2457             "group": "Body",
2458             "type": "Text",
2459             "optional": false,
2460             "field": "body",
2461             "description": ""
2462           },
2463           {
2464             "group": "Body",
2465             "type": "Boolean",
2466             "optional": true,
2467             "field": "read",
2468             "description": ""
2469           },
2470           {
2471             "group": "Body",
2472             "type": "Boolean",
2473             "optional": true,
2474             "field": "secret",
2475             "description": ""
2476           },
2477           {
2478             "group": "Body",
2479             "type": "String",
2480             "allowedValues": [
2481               "\"in\"",
2482               "\"out\""
2483             ],
2484             "optional": false,
2485             "field": "direction",
2486             "description": ""
2487           },
2488           {
2489             "group": "Body",
2490             "type": "String",
2491             "optional": true,
2492             "field": "readAt",
2493             "description": ""
2494           }
2495         ]
2496       }
2497     },
2498     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2499     "version": "0.0.0",
2500     "filename": "server/api/chatInteraction/index.js",
2501     "groupTitle": "Chat_Interactions"
2502   },
2503   {
2504     "type": "post",
2505     "url": "/api/chat/interactions/{id}/attachment_upload",
2506     "title": "Add attachment",
2507     "examples": [
2508       {
2509         "title": "Example usage:",
2510         "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",
2511         "type": "json"
2512       }
2513     ],
2514     "name": "attachmentUpload",
2515     "group": "Chat_Interactions",
2516     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2517     "version": "0.0.0",
2518     "filename": "server/api/chatInteraction/index.js",
2519     "groupTitle": "Chat_Interactions"
2520   },
2521   {
2522     "type": "post",
2523     "url": "/api/chat/interactions/{id}/vidaoo",
2524     "title": "Create Vidaoo Session",
2525     "examples": [
2526       {
2527         "title": "Example usage:",
2528         "content": "curl https://{domain}/api/chat/interactions/{id}/vidaoo  -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
2529         "type": "json"
2530       }
2531     ],
2532     "name": "createVidaooSession",
2533     "group": "Chat_Interactions",
2534     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2535     "version": "0.0.0",
2536     "filename": "server/api/chatInteraction/index.js",
2537     "groupTitle": "Chat_Interactions"
2538   },
2539   {
2540     "type": "put",
2541     "url": "/api/chat/interactions/{id}/custom_update",
2542     "title": "Update interaction",
2543     "examples": [
2544       {
2545         "title": "Example usage:",
2546         "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",
2547         "type": "json"
2548       }
2549     ],
2550     "name": "customUpdate",
2551     "group": "Chat_Interactions",
2552     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <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>",
2553     "version": "0.0.0",
2554     "filename": "server/api/chatInteraction/index.js",
2555     "groupTitle": "Chat_Interactions"
2556   },
2557   {
2558     "type": "get",
2559     "url": "/api/chat/interactions/{id}/download",
2560     "title": "Gets interaction",
2561     "examples": [
2562       {
2563         "title": "Example usage:",
2564         "content": "curl https://{domain}/api/chat/interactions/{id}/download -v -u {name}:{password} -X GET",
2565         "type": "json"
2566       }
2567     ],
2568     "name": "download",
2569     "group": "Chat_Interactions",
2570     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2571     "version": "0.0.0",
2572     "filename": "server/api/chatInteraction/index.js",
2573     "groupTitle": "Chat_Interactions"
2574   },
2575   {
2576     "type": "get",
2577     "url": "/api/chat/interactions/{id}/messages",
2578     "title": "Gets interaction messages",
2579     "examples": [
2580       {
2581         "title": "Example usage:",
2582         "content": "curl https://{domain}/api/chat/interactions/{id}/messages -v -u {name}:{password} -X GET",
2583         "type": "json"
2584       }
2585     ],
2586     "name": "getMessages",
2587     "group": "Chat_Interactions",
2588     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2589     "version": "0.0.0",
2590     "filename": "server/api/chatInteraction/index.js",
2591     "groupTitle": "Chat_Interactions"
2592   },
2593   {
2594     "type": "get",
2595     "url": "/api/chat/interactions/{id}/my_messages",
2596     "title": "Gets interaction messages",
2597     "examples": [
2598       {
2599         "title": "Example usage:",
2600         "content": "curl https://{domain}/api/chat/interactions/{id}/my_messages -v -u {name}:{password} -X GET",
2601         "type": "json"
2602       }
2603     ],
2604     "name": "getMyMessages",
2605     "group": "Chat_Interactions",
2606     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2607     "version": "0.0.0",
2608     "filename": "server/api/chatInteraction/index.js",
2609     "groupTitle": "Chat_Interactions"
2610   },
2611   {
2612     "type": "put",
2613     "url": "/api/chat/interactions/{id}",
2614     "title": "Update an existing Interaction",
2615     "examples": [
2616       {
2617         "title": "Example usage:",
2618         "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",
2619         "type": "json"
2620       }
2621     ],
2622     "name": "updateInteractions",
2623     "group": "Chat_Interactions",
2624     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2625     "version": "0.0.0",
2626     "filename": "server/api/chatInteraction/index.js",
2627     "groupTitle": "Chat_Interactions"
2628   },
2629   {
2630     "type": "post",
2631     "url": "/api/chat/internal/messages",
2632     "title": "Creates a new Message",
2633     "examples": [
2634       {
2635         "title": "Example usage:",
2636         "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",
2637         "type": "json"
2638       }
2639     ],
2640     "name": "CreateMessages",
2641     "group": "Chat_Internal_Messages",
2642     "parameter": {
2643       "fields": {
2644         "Body": [
2645           {
2646             "group": "Body",
2647             "type": "Text",
2648             "optional": false,
2649             "field": "body",
2650             "description": ""
2651           },
2652           {
2653             "group": "Body",
2654             "type": "Boolean",
2655             "optional": true,
2656             "field": "read",
2657             "description": ""
2658           },
2659           {
2660             "group": "Body",
2661             "type": "Integer",
2662             "optional": true,
2663             "field": "ChatInternalMessageId",
2664             "description": ""
2665           }
2666         ]
2667       }
2668     },
2669     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2670     "version": "0.0.0",
2671     "filename": "server/api/chatInternalMessage/index.js",
2672     "groupTitle": "Chat_Internal_Messages"
2673   },
2674   {
2675     "type": "delete",
2676     "url": "/api/chat/internal/messages/{id}",
2677     "title": "Deletes a Message",
2678     "examples": [
2679       {
2680         "title": "Example usage:",
2681         "content": "curl https://{domain}/api/chat/internal/messages/{id} -v -u {name}:{password} -X DELETE",
2682         "type": "json"
2683       }
2684     ],
2685     "name": "DeleteMessages",
2686     "group": "Chat_Internal_Messages",
2687     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2688     "version": "0.0.0",
2689     "filename": "server/api/chatInternalMessage/index.js",
2690     "groupTitle": "Chat_Internal_Messages"
2691   },
2692   {
2693     "type": "get",
2694     "url": "/api/chat/internal/messages/describe",
2695     "title": "Gets table info about Messages",
2696     "examples": [
2697       {
2698         "title": "Example usage:",
2699         "content": "curl https://{domain}/api/chat/internal/messages/describe -v -u {name}:{password}",
2700         "type": "json"
2701       }
2702     ],
2703     "name": "DescribeMessages",
2704     "group": "Chat_Internal_Messages",
2705     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2706     "version": "0.0.0",
2707     "filename": "server/api/chatInternalMessage/index.js",
2708     "groupTitle": "Chat_Internal_Messages"
2709   },
2710   {
2711     "type": "get",
2712     "url": "/api/chat/internal/messages",
2713     "title": "Gets a list of Messages",
2714     "examples": [
2715       {
2716         "title": "Example usage:",
2717         "content": "curl https://{domain}/api/chat/internal/messages -v -u {name}:{password}",
2718         "type": "json"
2719       }
2720     ],
2721     "name": "GetMessages",
2722     "group": "Chat_Internal_Messages",
2723     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
2724     "version": "0.0.0",
2725     "filename": "server/api/chatInternalMessage/index.js",
2726     "groupTitle": "Chat_Internal_Messages"
2727   },
2728   {
2729     "type": "get",
2730     "url": "/api/chat/internal/messages/{id}",
2731     "title": "Gets a single Message",
2732     "examples": [
2733       {
2734         "title": "Example usage:",
2735         "content": "curl https://{domain}/api/chat/internal/messages/{id} -v -u {name}:{password}",
2736         "type": "json"
2737       }
2738     ],
2739     "name": "ShowMessages",
2740     "group": "Chat_Internal_Messages",
2741     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2742     "version": "0.0.0",
2743     "filename": "server/api/chatInternalMessage/index.js",
2744     "groupTitle": "Chat_Internal_Messages"
2745   },
2746   {
2747     "type": "put",
2748     "url": "/api/chat/internal/messages/{id}",
2749     "title": "Update an existing Message",
2750     "examples": [
2751       {
2752         "title": "Example usage:",
2753         "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",
2754         "type": "json"
2755       }
2756     ],
2757     "name": "updateMessages",
2758     "group": "Chat_Internal_Messages",
2759     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2760     "version": "0.0.0",
2761     "filename": "server/api/chatInternalMessage/index.js",
2762     "groupTitle": "Chat_Internal_Messages"
2763   },
2764   {
2765     "type": "post",
2766     "url": "/api/chat/messages",
2767     "title": "Creates a new Message",
2768     "examples": [
2769       {
2770         "title": "Example usage:",
2771         "content": "curl https://{domain}/api/chat/messages -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
2772         "type": "json"
2773       }
2774     ],
2775     "name": "CreateMessages",
2776     "group": "Chat_Messages",
2777     "parameter": {
2778       "fields": {
2779         "Body": [
2780           {
2781             "group": "Body",
2782             "type": "Text",
2783             "optional": false,
2784             "field": "body",
2785             "description": ""
2786           },
2787           {
2788             "group": "Body",
2789             "type": "Boolean",
2790             "optional": true,
2791             "field": "read",
2792             "description": ""
2793           },
2794           {
2795             "group": "Body",
2796             "type": "Boolean",
2797             "optional": true,
2798             "field": "secret",
2799             "description": ""
2800           },
2801           {
2802             "group": "Body",
2803             "type": "String",
2804             "allowedValues": [
2805               "\"in\"",
2806               "\"out\""
2807             ],
2808             "optional": false,
2809             "field": "direction",
2810             "description": ""
2811           },
2812           {
2813             "group": "Body",
2814             "type": "String",
2815             "optional": true,
2816             "field": "readAt",
2817             "description": ""
2818           }
2819         ]
2820       }
2821     },
2822     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2823     "version": "0.0.0",
2824     "filename": "server/api/chatMessage/index.js",
2825     "groupTitle": "Chat_Messages"
2826   },
2827   {
2828     "type": "delete",
2829     "url": "/api/chat/messages/{id}",
2830     "title": "Deletes a Message",
2831     "examples": [
2832       {
2833         "title": "Example usage:",
2834         "content": "curl https://{domain}/api/chat/messages/{id} -v -u {name}:{password} -X DELETE",
2835         "type": "json"
2836       }
2837     ],
2838     "name": "DeleteMessages",
2839     "group": "Chat_Messages",
2840     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2841     "version": "0.0.0",
2842     "filename": "server/api/chatMessage/index.js",
2843     "groupTitle": "Chat_Messages"
2844   },
2845   {
2846     "type": "get",
2847     "url": "/api/chat/messages/describe",
2848     "title": "Gets table info about Messages",
2849     "examples": [
2850       {
2851         "title": "Example usage:",
2852         "content": "curl https://{domain}/api/chat/messages/describe -v -u {name}:{password}",
2853         "type": "json"
2854       }
2855     ],
2856     "name": "DescribeMessages",
2857     "group": "Chat_Messages",
2858     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2859     "version": "0.0.0",
2860     "filename": "server/api/chatMessage/index.js",
2861     "groupTitle": "Chat_Messages"
2862   },
2863   {
2864     "type": "get",
2865     "url": "/api/chat/messages",
2866     "title": "Gets a list of Messages",
2867     "examples": [
2868       {
2869         "title": "Example usage:",
2870         "content": "curl https://{domain}/api/chat/messages -v -u {name}:{password}",
2871         "type": "json"
2872       }
2873     ],
2874     "name": "GetMessages",
2875     "group": "Chat_Messages",
2876     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
2877     "version": "0.0.0",
2878     "filename": "server/api/chatMessage/index.js",
2879     "groupTitle": "Chat_Messages"
2880   },
2881   {
2882     "type": "get",
2883     "url": "/api/chat/messages/{id}",
2884     "title": "Gets a single Message",
2885     "examples": [
2886       {
2887         "title": "Example usage:",
2888         "content": "curl https://{domain}/api/chat/messages/{id} -v -u {name}:{password}",
2889         "type": "json"
2890       }
2891     ],
2892     "name": "ShowMessages",
2893     "group": "Chat_Messages",
2894     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2895     "version": "0.0.0",
2896     "filename": "server/api/chatMessage/index.js",
2897     "groupTitle": "Chat_Messages"
2898   },
2899   {
2900     "type": "put",
2901     "url": "/api/chat/messages/{id}",
2902     "title": "Update an existing Message",
2903     "examples": [
2904       {
2905         "title": "Example usage:",
2906         "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",
2907         "type": "json"
2908       }
2909     ],
2910     "name": "updateMessages",
2911     "group": "Chat_Messages",
2912     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2913     "version": "0.0.0",
2914     "filename": "server/api/chatMessage/index.js",
2915     "groupTitle": "Chat_Messages"
2916   },
2917   {
2918     "type": "post",
2919     "url": "/api/chat/offline_messages",
2920     "title": "Creates a new OfflineMessage",
2921     "examples": [
2922       {
2923         "title": "Example usage:",
2924         "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",
2925         "type": "json"
2926       }
2927     ],
2928     "name": "CreateOfflineMessages",
2929     "group": "Chat_Offline_Messages",
2930     "parameter": {
2931       "fields": {
2932         "Body": [
2933           {
2934             "group": "Body",
2935             "type": "Text",
2936             "optional": false,
2937             "field": "body",
2938             "description": ""
2939           }
2940         ]
2941       }
2942     },
2943     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2944     "version": "0.0.0",
2945     "filename": "server/api/chatOfflineMessage/index.js",
2946     "groupTitle": "Chat_Offline_Messages"
2947   },
2948   {
2949     "type": "delete",
2950     "url": "/api/chat/offline_messages/{id}",
2951     "title": "Deletes a OfflineMessage",
2952     "examples": [
2953       {
2954         "title": "Example usage:",
2955         "content": "curl https://{domain}/api/chat/offline_messages/{id} -v -u {name}:{password} -X DELETE",
2956         "type": "json"
2957       }
2958     ],
2959     "name": "DeleteOfflineMessages",
2960     "group": "Chat_Offline_Messages",
2961     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2962     "version": "0.0.0",
2963     "filename": "server/api/chatOfflineMessage/index.js",
2964     "groupTitle": "Chat_Offline_Messages"
2965   },
2966   {
2967     "type": "get",
2968     "url": "/api/chat/offline_messages/describe",
2969     "title": "Gets table info about OfflineMessages",
2970     "examples": [
2971       {
2972         "title": "Example usage:",
2973         "content": "curl https://{domain}/api/chat/offline_messages/describe -v -u {name}:{password}",
2974         "type": "json"
2975       }
2976     ],
2977     "name": "DescribeOfflineMessages",
2978     "group": "Chat_Offline_Messages",
2979     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2980     "version": "0.0.0",
2981     "filename": "server/api/chatOfflineMessage/index.js",
2982     "groupTitle": "Chat_Offline_Messages"
2983   },
2984   {
2985     "type": "get",
2986     "url": "/api/chat/offline_messages",
2987     "title": "Gets a list of OfflineMessages",
2988     "examples": [
2989       {
2990         "title": "Example usage:",
2991         "content": "curl https://{domain}/api/chat/offline_messages -v -u {name}:{password}",
2992         "type": "json"
2993       }
2994     ],
2995     "name": "GetOfflineMessages",
2996     "group": "Chat_Offline_Messages",
2997     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
2998     "version": "0.0.0",
2999     "filename": "server/api/chatOfflineMessage/index.js",
3000     "groupTitle": "Chat_Offline_Messages"
3001   },
3002   {
3003     "type": "get",
3004     "url": "/api/chat/offline_messages/{id}",
3005     "title": "Gets a single OfflineMessage",
3006     "examples": [
3007       {
3008         "title": "Example usage:",
3009         "content": "curl https://{domain}/api/chat/offline_messages/{id} -v -u {name}:{password}",
3010         "type": "json"
3011       }
3012     ],
3013     "name": "ShowOfflineMessages",
3014     "group": "Chat_Offline_Messages",
3015     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3016     "version": "0.0.0",
3017     "filename": "server/api/chatOfflineMessage/index.js",
3018     "groupTitle": "Chat_Offline_Messages"
3019   },
3020   {
3021     "type": "put",
3022     "url": "/api/chat/offline_messages/{id}",
3023     "title": "Update an existing OfflineMessage",
3024     "examples": [
3025       {
3026         "title": "Example usage:",
3027         "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",
3028         "type": "json"
3029       }
3030     ],
3031     "name": "updateOfflineMessages",
3032     "group": "Chat_Offline_Messages",
3033     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3034     "version": "0.0.0",
3035     "filename": "server/api/chatOfflineMessage/index.js",
3036     "groupTitle": "Chat_Offline_Messages"
3037   },
3038   {
3039     "type": "post",
3040     "url": "/api/chat/proactive_actions",
3041     "title": "Creates a new Proactive Action",
3042     "examples": [
3043       {
3044         "title": "Example usage:",
3045         "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",
3046         "type": "json"
3047       }
3048     ],
3049     "name": "CreateProactive_Actions",
3050     "group": "Chat_Proactive_Actions",
3051     "parameter": {
3052       "fields": {
3053         "Body": [
3054           {
3055             "group": "Body",
3056             "type": "String",
3057             "optional": false,
3058             "field": "name",
3059             "description": ""
3060           },
3061           {
3062             "group": "Body",
3063             "type": "String",
3064             "allowedValues": [
3065               "\"mouseOver\"",
3066               "\"timeout\""
3067             ],
3068             "optional": true,
3069             "field": "type",
3070             "description": ""
3071           },
3072           {
3073             "group": "Body",
3074             "type": "String",
3075             "optional": true,
3076             "field": "selector",
3077             "description": ""
3078           },
3079           {
3080             "group": "Body",
3081             "type": "Integer",
3082             "optional": true,
3083             "field": "timeout",
3084             "description": ""
3085           }
3086         ]
3087       }
3088     },
3089     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3090     "version": "0.0.0",
3091     "filename": "server/api/chatProactiveAction/index.js",
3092     "groupTitle": "Chat_Proactive_Actions"
3093   },
3094   {
3095     "type": "delete",
3096     "url": "/api/chat/proactive_actions/{id}",
3097     "title": "Deletes a Proactive Action",
3098     "examples": [
3099       {
3100         "title": "Example usage:",
3101         "content": "curl https://{domain}/api/chat/proactive_actions/{id} -v -u {name}:{password} -X DELETE",
3102         "type": "json"
3103       }
3104     ],
3105     "name": "DeleteProactive_Actions",
3106     "group": "Chat_Proactive_Actions",
3107     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3108     "version": "0.0.0",
3109     "filename": "server/api/chatProactiveAction/index.js",
3110     "groupTitle": "Chat_Proactive_Actions"
3111   },
3112   {
3113     "type": "get",
3114     "url": "/api/chat/proactive_actions/{id}",
3115     "title": "Gets a single Proactive Action",
3116     "examples": [
3117       {
3118         "title": "Example usage:",
3119         "content": "curl https://{domain}/api/chat/proactive_actions/{id} -v -u {name}:{password}",
3120         "type": "json"
3121       }
3122     ],
3123     "name": "ShowProactive_Actions",
3124     "group": "Chat_Proactive_Actions",
3125     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3126     "version": "0.0.0",
3127     "filename": "server/api/chatProactiveAction/index.js",
3128     "groupTitle": "Chat_Proactive_Actions"
3129   },
3130   {
3131     "type": "put",
3132     "url": "/api/chat/proactive_actions/{id}",
3133     "title": "Update an existing Proactive Action",
3134     "examples": [
3135       {
3136         "title": "Example usage:",
3137         "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",
3138         "type": "json"
3139       }
3140     ],
3141     "name": "updateProactive_Actions",
3142     "group": "Chat_Proactive_Actions",
3143     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3144     "version": "0.0.0",
3145     "filename": "server/api/chatProactiveAction/index.js",
3146     "groupTitle": "Chat_Proactive_Actions"
3147   },
3148   {
3149     "type": "post",
3150     "url": "/api/chat/reports/queue",
3151     "title": "Creates a new Chat Queue Report",
3152     "examples": [
3153       {
3154         "title": "Example usage:",
3155         "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",
3156         "type": "json"
3157       }
3158     ],
3159     "name": "CreateChat_Queue_Reports",
3160     "group": "Chat_Queue_Reports",
3161     "parameter": {
3162       "fields": {
3163         "Body": [
3164           {
3165             "group": "Body",
3166             "type": "String",
3167             "optional": false,
3168             "field": "uniqueid",
3169             "description": ""
3170           },
3171           {
3172             "group": "Body",
3173             "type": "String",
3174             "optional": true,
3175             "field": "from",
3176             "description": ""
3177           },
3178           {
3179             "group": "Body",
3180             "type": "String",
3181             "optional": true,
3182             "field": "joinAt",
3183             "description": ""
3184           },
3185           {
3186             "group": "Body",
3187             "type": "String",
3188             "optional": true,
3189             "field": "leaveAt",
3190             "description": ""
3191           },
3192           {
3193             "group": "Body",
3194             "type": "String",
3195             "optional": true,
3196             "field": "acceptAt",
3197             "description": ""
3198           },
3199           {
3200             "group": "Body",
3201             "type": "String",
3202             "optional": true,
3203             "field": "exitAt",
3204             "description": ""
3205           },
3206           {
3207             "group": "Body",
3208             "type": "String",
3209             "optional": true,
3210             "field": "reason",
3211             "description": ""
3212           }
3213         ]
3214       }
3215     },
3216     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3217     "version": "0.0.0",
3218     "filename": "server/api/chatQueueReport/index.js",
3219     "groupTitle": "Chat_Queue_Reports"
3220   },
3221   {
3222     "type": "delete",
3223     "url": "/api/chat/reports/queue/{id}",
3224     "title": "Deletes a Chat Queue Report",
3225     "examples": [
3226       {
3227         "title": "Example usage:",
3228         "content": "curl https://{domain}/api/chat/reports/queue/{id} -v -u {name}:{password} -X DELETE",
3229         "type": "json"
3230       }
3231     ],
3232     "name": "DeleteChat_Queue_Reports",
3233     "group": "Chat_Queue_Reports",
3234     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3235     "version": "0.0.0",
3236     "filename": "server/api/chatQueueReport/index.js",
3237     "groupTitle": "Chat_Queue_Reports"
3238   },
3239   {
3240     "type": "get",
3241     "url": "/api/chat/reports/queue/describe",
3242     "title": "Gets table info about Chat Queue Reports",
3243     "examples": [
3244       {
3245         "title": "Example usage:",
3246         "content": "curl https://{domain}/api/chat/reports/queue/describe -v -u {name}:{password}",
3247         "type": "json"
3248       }
3249     ],
3250     "name": "DescribeChat_Queue_Reports",
3251     "group": "Chat_Queue_Reports",
3252     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3253     "version": "0.0.0",
3254     "filename": "server/api/chatQueueReport/index.js",
3255     "groupTitle": "Chat_Queue_Reports"
3256   },
3257   {
3258     "type": "get",
3259     "url": "/api/chat/reports/queue",
3260     "title": "Gets a list of Chat Queue Reports",
3261     "examples": [
3262       {
3263         "title": "Example usage:",
3264         "content": "curl https://{domain}/api/chat/reports/queue -v -u {name}:{password}",
3265         "type": "json"
3266       }
3267     ],
3268     "name": "GetChat_Queue_Reports",
3269     "group": "Chat_Queue_Reports",
3270     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
3271     "version": "0.0.0",
3272     "filename": "server/api/chatQueueReport/index.js",
3273     "groupTitle": "Chat_Queue_Reports"
3274   },
3275   {
3276     "type": "get",
3277     "url": "/api/chat/reports/queue/{id}",
3278     "title": "Gets a single Chat Queue Report",
3279     "examples": [
3280       {
3281         "title": "Example usage:",
3282         "content": "curl https://{domain}/api/chat/reports/queue/{id} -v -u {name}:{password}",
3283         "type": "json"
3284       }
3285     ],
3286     "name": "ShowChat_Queue_Reports",
3287     "group": "Chat_Queue_Reports",
3288     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3289     "version": "0.0.0",
3290     "filename": "server/api/chatQueueReport/index.js",
3291     "groupTitle": "Chat_Queue_Reports"
3292   },
3293   {
3294     "type": "put",
3295     "url": "/api/chat/reports/queue/{id}",
3296     "title": "Update an existing Chat Queue Report",
3297     "examples": [
3298       {
3299         "title": "Example usage:",
3300         "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",
3301         "type": "json"
3302       }
3303     ],
3304     "name": "updateChat_Queue_Reports",
3305     "group": "Chat_Queue_Reports",
3306     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3307     "version": "0.0.0",
3308     "filename": "server/api/chatQueueReport/index.js",
3309     "groupTitle": "Chat_Queue_Reports"
3310   },
3311   {
3312     "type": "post",
3313     "url": "/api/chat/queues/{id}/users",
3314     "title": "Add agents to a queue",
3315     "examples": [
3316       {
3317         "title": "Example usage:",
3318         "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",
3319         "type": "json"
3320       }
3321     ],
3322     "name": "AddAgents",
3323     "group": "Chat_Queues",
3324     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3325     "version": "0.0.0",
3326     "filename": "server/api/chatQueue/index.js",
3327     "groupTitle": "Chat_Queues"
3328   },
3329   {
3330     "type": "post",
3331     "url": "/api/chat/queues/{id}/teams",
3332     "title": "Add teams to a queue",
3333     "examples": [
3334       {
3335         "title": "Example usage:",
3336         "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",
3337         "type": "json"
3338       }
3339     ],
3340     "name": "AddTeams",
3341     "group": "Chat_Queues",
3342     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3343     "version": "0.0.0",
3344     "filename": "server/api/chatQueue/index.js",
3345     "groupTitle": "Chat_Queues"
3346   },
3347   {
3348     "type": "post",
3349     "url": "/api/chat/queues",
3350     "title": "Creates a new Queue",
3351     "examples": [
3352       {
3353         "title": "Example usage:",
3354         "content": "curl https://{domain}/api/chat/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
3355         "type": "json"
3356       }
3357     ],
3358     "name": "CreateQueues",
3359     "group": "Chat_Queues",
3360     "parameter": {
3361       "fields": {
3362         "Body": [
3363           {
3364             "group": "Body",
3365             "type": "String",
3366             "optional": false,
3367             "field": "name",
3368             "description": ""
3369           },
3370           {
3371             "group": "Body",
3372             "type": "String",
3373             "optional": true,
3374             "field": "description",
3375             "description": ""
3376           },
3377           {
3378             "group": "Body",
3379             "type": "Integer",
3380             "optional": true,
3381             "field": "timeout",
3382             "description": ""
3383           },
3384           {
3385             "group": "Body",
3386             "type": "String",
3387             "allowedValues": [
3388               "\"rrmemory\"",
3389               "\"beepall\"",
3390               "\"roundrobin\""
3391             ],
3392             "optional": true,
3393             "field": "strategy",
3394             "description": ""
3395           }
3396         ]
3397       }
3398     },
3399     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3400     "version": "0.0.0",
3401     "filename": "server/api/chatQueue/index.js",
3402     "groupTitle": "Chat_Queues"
3403   },
3404   {
3405     "type": "delete",
3406     "url": "/api/chat/queues/{id}",
3407     "title": "Deletes a Queue",
3408     "examples": [
3409       {
3410         "title": "Example usage:",
3411         "content": "curl https://{domain}/api/chat/queues/{id} -v -u {name}:{password} -X DELETE",
3412         "type": "json"
3413       }
3414     ],
3415     "name": "DeleteQueues",
3416     "group": "Chat_Queues",
3417     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3418     "version": "0.0.0",
3419     "filename": "server/api/chatQueue/index.js",
3420     "groupTitle": "Chat_Queues"
3421   },
3422   {
3423     "type": "get",
3424     "url": "/api/chat/queues/describe",
3425     "title": "Gets table info about Queues",
3426     "examples": [
3427       {
3428         "title": "Example usage:",
3429         "content": "curl https://{domain}/api/chat/queues/describe -v -u {name}:{password}",
3430         "type": "json"
3431       }
3432     ],
3433     "name": "DescribeQueues",
3434     "group": "Chat_Queues",
3435     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3436     "version": "0.0.0",
3437     "filename": "server/api/chatQueue/index.js",
3438     "groupTitle": "Chat_Queues"
3439   },
3440   {
3441     "type": "get",
3442     "url": "/api/chat/queues/{id}/users",
3443     "title": "Gets queue agents",
3444     "examples": [
3445       {
3446         "title": "Example usage:",
3447         "content": "curl https://{domain}/api/chat/queues/{id}/users -v -u {name}:{password} -X POST",
3448         "type": "json"
3449       }
3450     ],
3451     "name": "GetAgents",
3452     "group": "Chat_Queues",
3453     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3454     "version": "0.0.0",
3455     "filename": "server/api/chatQueue/index.js",
3456     "groupTitle": "Chat_Queues"
3457   },
3458   {
3459     "type": "get",
3460     "url": "/api/chat/queues/{id}/members",
3461     "title": "GetMembers",
3462     "examples": [
3463       {
3464         "title": "Example usage:",
3465         "content": "curl https://{domain}/api/chat/queues/{id}/members  -v -u {name}:{password}",
3466         "type": "json"
3467       }
3468     ],
3469     "name": "GetMembers",
3470     "group": "Chat_Queues",
3471     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3472     "version": "0.0.0",
3473     "filename": "server/api/chatQueue/index.js",
3474     "groupTitle": "Chat_Queues"
3475   },
3476   {
3477     "type": "get",
3478     "url": "/api/chat/queues",
3479     "title": "Gets a list of Queues",
3480     "examples": [
3481       {
3482         "title": "Example usage:",
3483         "content": "curl https://{domain}/api/chat/queues -v -u {name}:{password}",
3484         "type": "json"
3485       }
3486     ],
3487     "name": "GetQueues",
3488     "group": "Chat_Queues",
3489     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
3490     "version": "0.0.0",
3491     "filename": "server/api/chatQueue/index.js",
3492     "groupTitle": "Chat_Queues"
3493   },
3494   {
3495     "type": "get",
3496     "url": "/api/chat/queues/{id}/teams",
3497     "title": "Gets queues list",
3498     "examples": [
3499       {
3500         "title": "Example usage:",
3501         "content": "curl https://{domain}/api/chat/queues/{id}/teams -v -u {name}:{password}",
3502         "type": "json"
3503       }
3504     ],
3505     "name": "GetTeams",
3506     "group": "Chat_Queues",
3507     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3508     "version": "0.0.0",
3509     "filename": "server/api/chatQueue/index.js",
3510     "groupTitle": "Chat_Queues"
3511   },
3512   {
3513     "type": "delete",
3514     "url": "/api/chat/queues/{id}/users",
3515     "title": "Removes agents from a queue",
3516     "examples": [
3517       {
3518         "title": "Example usage:",
3519         "content": "curl https://{domain}/api/chat/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
3520         "type": "json"
3521       }
3522     ],
3523     "name": "RemoveAgents",
3524     "group": "Chat_Queues",
3525     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3526     "version": "0.0.0",
3527     "filename": "server/api/chatQueue/index.js",
3528     "groupTitle": "Chat_Queues"
3529   },
3530   {
3531     "type": "get",
3532     "url": "/api/chat/queues/{id}",
3533     "title": "Gets a single Queue",
3534     "examples": [
3535       {
3536         "title": "Example usage:",
3537         "content": "curl https://{domain}/api/chat/queues/{id} -v -u {name}:{password}",
3538         "type": "json"
3539       }
3540     ],
3541     "name": "ShowQueues",
3542     "group": "Chat_Queues",
3543     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3544     "version": "0.0.0",
3545     "filename": "server/api/chatQueue/index.js",
3546     "groupTitle": "Chat_Queues"
3547   },
3548   {
3549     "type": "put",
3550     "url": "/api/chat/queues/{id}",
3551     "title": "Update an existing Queue",
3552     "examples": [
3553       {
3554         "title": "Example usage:",
3555         "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",
3556         "type": "json"
3557       }
3558     ],
3559     "name": "updateQueues",
3560     "group": "Chat_Queues",
3561     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3562     "version": "0.0.0",
3563     "filename": "server/api/chatQueue/index.js",
3564     "groupTitle": "Chat_Queues"
3565   },
3566   {
3567     "type": "post",
3568     "url": "/api/chat/reports/transfer",
3569     "title": "Creates a new Chat Transfer Report",
3570     "examples": [
3571       {
3572         "title": "Example usage:",
3573         "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",
3574         "type": "json"
3575       }
3576     ],
3577     "name": "CreateChat_Transfer_Reports",
3578     "group": "Chat_Transfer_Reports",
3579     "parameter": {
3580       "fields": {
3581         "Body": [
3582           {
3583             "group": "Body",
3584             "type": "String",
3585             "optional": false,
3586             "field": "uniqueid",
3587             "description": ""
3588           },
3589           {
3590             "group": "Body",
3591             "type": "String",
3592             "allowedValues": [
3593               "\"account\"",
3594               "\"agent\"",
3595               "\"queue\""
3596             ],
3597             "optional": false,
3598             "field": "type",
3599             "description": ""
3600           },
3601           {
3602             "group": "Body",
3603             "type": "String",
3604             "optional": false,
3605             "field": "transferredAt",
3606             "description": ""
3607           }
3608         ]
3609       }
3610     },
3611     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3612     "version": "0.0.0",
3613     "filename": "server/api/chatTransferReport/index.js",
3614     "groupTitle": "Chat_Transfer_Reports"
3615   },
3616   {
3617     "type": "delete",
3618     "url": "/api/chat/reports/transfer/{id}",
3619     "title": "Deletes a Chat Transfer Report",
3620     "examples": [
3621       {
3622         "title": "Example usage:",
3623         "content": "curl https://{domain}/api/chat/reports/transfer/{id} -v -u {name}:{password} -X DELETE",
3624         "type": "json"
3625       }
3626     ],
3627     "name": "DeleteChat_Transfer_Reports",
3628     "group": "Chat_Transfer_Reports",
3629     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3630     "version": "0.0.0",
3631     "filename": "server/api/chatTransferReport/index.js",
3632     "groupTitle": "Chat_Transfer_Reports"
3633   },
3634   {
3635     "type": "get",
3636     "url": "/api/chat/reports/transfer/describe",
3637     "title": "Gets table info about Chat Transfer Reports",
3638     "examples": [
3639       {
3640         "title": "Example usage:",
3641         "content": "curl https://{domain}/api/chat/reports/transfer/describe -v -u {name}:{password}",
3642         "type": "json"
3643       }
3644     ],
3645     "name": "DescribeChat_Transfer_Reports",
3646     "group": "Chat_Transfer_Reports",
3647     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3648     "version": "0.0.0",
3649     "filename": "server/api/chatTransferReport/index.js",
3650     "groupTitle": "Chat_Transfer_Reports"
3651   },
3652   {
3653     "type": "get",
3654     "url": "/api/chat/reports/transfer",
3655     "title": "Gets a list of Chat Transfer Reports",
3656     "examples": [
3657       {
3658         "title": "Example usage:",
3659         "content": "curl https://{domain}/api/chat/reports/transfer -v -u {name}:{password}",
3660         "type": "json"
3661       }
3662     ],
3663     "name": "GetChat_Transfer_Reports",
3664     "group": "Chat_Transfer_Reports",
3665     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
3666     "version": "0.0.0",
3667     "filename": "server/api/chatTransferReport/index.js",
3668     "groupTitle": "Chat_Transfer_Reports"
3669   },
3670   {
3671     "type": "get",
3672     "url": "/api/chat/reports/transfer/{id}",
3673     "title": "Gets a single Chat Transfer Report",
3674     "examples": [
3675       {
3676         "title": "Example usage:",
3677         "content": "curl https://{domain}/api/chat/reports/transfer/{id} -v -u {name}:{password}",
3678         "type": "json"
3679       }
3680     ],
3681     "name": "ShowChat_Transfer_Reports",
3682     "group": "Chat_Transfer_Reports",
3683     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3684     "version": "0.0.0",
3685     "filename": "server/api/chatTransferReport/index.js",
3686     "groupTitle": "Chat_Transfer_Reports"
3687   },
3688   {
3689     "type": "put",
3690     "url": "/api/chat/reports/transfer/{id}",
3691     "title": "Update an existing Chat Transfer Report",
3692     "examples": [
3693       {
3694         "title": "Example usage:",
3695         "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",
3696         "type": "json"
3697       }
3698     ],
3699     "name": "updateChat_Transfer_Reports",
3700     "group": "Chat_Transfer_Reports",
3701     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3702     "version": "0.0.0",
3703     "filename": "server/api/chatTransferReport/index.js",
3704     "groupTitle": "Chat_Transfer_Reports"
3705   },
3706   {
3707     "type": "post",
3708     "url": "/api/chat/websites/{id}/users",
3709     "title": "Add agents to a website",
3710     "examples": [
3711       {
3712         "title": "Example usage:",
3713         "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",
3714         "type": "json"
3715       }
3716     ],
3717     "name": "AddAgents",
3718     "group": "Chat_Websites",
3719     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3720     "version": "0.0.0",
3721     "filename": "server/api/chatWebsite/index.js",
3722     "groupTitle": "Chat_Websites"
3723   },
3724   {
3725     "type": "post",
3726     "url": "/api/chat/websites",
3727     "title": "Creates a new Website",
3728     "examples": [
3729       {
3730         "title": "Example usage:",
3731         "content": "curl https://{domain}/api/chat/websites -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
3732         "type": "json"
3733       }
3734     ],
3735     "name": "CreateWebsites",
3736     "group": "Chat_Websites",
3737     "parameter": {
3738       "fields": {
3739         "Body": [
3740           {
3741             "group": "Body",
3742             "type": "String",
3743             "optional": false,
3744             "field": "name",
3745             "description": ""
3746           },
3747           {
3748             "group": "Body",
3749             "type": "String",
3750             "optional": false,
3751             "field": "address",
3752             "description": ""
3753           },
3754           {
3755             "group": "Body",
3756             "type": "String",
3757             "optional": true,
3758             "field": "description",
3759             "description": ""
3760           },
3761           {
3762             "group": "Body",
3763             "type": "String",
3764             "optional": true,
3765             "field": "mapKey",
3766             "description": ""
3767           },
3768           {
3769             "group": "Body",
3770             "type": "String",
3771             "optional": true,
3772             "field": "mapKeyOffline",
3773             "description": ""
3774           },
3775           {
3776             "group": "Body",
3777             "type": "String",
3778             "optional": false,
3779             "field": "key",
3780             "description": ""
3781           },
3782           {
3783             "group": "Body",
3784             "type": "String",
3785             "optional": true,
3786             "field": "agentAlias",
3787             "description": ""
3788           },
3789           {
3790             "group": "Body",
3791             "type": "String",
3792             "optional": true,
3793             "field": "customerAlias",
3794             "description": ""
3795           },
3796           {
3797             "group": "Body",
3798             "type": "String",
3799             "optional": false,
3800             "field": "color",
3801             "description": ""
3802           },
3803           {
3804             "group": "Body",
3805             "type": "String",
3806             "optional": false,
3807             "field": "color_button",
3808             "description": ""
3809           },
3810           {
3811             "group": "Body",
3812             "type": "String",
3813             "optional": false,
3814             "field": "textColor",
3815             "description": ""
3816           },
3817           {
3818             "group": "Body",
3819             "type": "Integer",
3820             "optional": true,
3821             "field": "fontSize",
3822             "description": ""
3823           },
3824           {
3825             "group": "Body",
3826             "type": "String",
3827             "optional": true,
3828             "field": "remote",
3829             "description": ""
3830           },
3831           {
3832             "group": "Body",
3833             "type": "Boolean",
3834             "optional": true,
3835             "field": "animation",
3836             "description": ""
3837           },
3838           {
3839             "group": "Body",
3840             "type": "String",
3841             "allowedValues": [
3842               "\"rounded\"",
3843               "\"squared\""
3844             ],
3845             "optional": true,
3846             "field": "header_shape",
3847             "description": ""
3848           },
3849           {
3850             "group": "Body",
3851             "type": "String",
3852             "optional": true,
3853             "field": "header_online",
3854             "description": ""
3855           },
3856           {
3857             "group": "Body",
3858             "type": "String",
3859             "optional": true,
3860             "field": "start_chat_button",
3861             "description": ""
3862           },
3863           {
3864             "group": "Body",
3865             "type": "String",
3866             "optional": true,
3867             "field": "offline_chat_button",
3868             "description": ""
3869           },
3870           {
3871             "group": "Body",
3872             "type": "String",
3873             "optional": true,
3874             "field": "header_offline",
3875             "description": ""
3876           },
3877           {
3878             "group": "Body",
3879             "type": "Boolean",
3880             "optional": true,
3881             "field": "download_transcript",
3882             "description": ""
3883           },
3884           {
3885             "group": "Body",
3886             "type": "Integer",
3887             "optional": true,
3888             "field": "timeout",
3889             "description": ""
3890           },
3891           {
3892             "group": "Body",
3893             "type": "String",
3894             "optional": true,
3895             "field": "whiteLabel",
3896             "description": ""
3897           },
3898           {
3899             "group": "Body",
3900             "type": "Boolean",
3901             "optional": true,
3902             "field": "defaultWhiteLabel",
3903             "description": ""
3904           },
3905           {
3906             "group": "Body",
3907             "type": "Text",
3908             "optional": true,
3909             "field": "sitepic",
3910             "description": ""
3911           },
3912           {
3913             "group": "Body",
3914             "type": "String",
3915             "optional": true,
3916             "field": "closingQuestion",
3917             "description": ""
3918           },
3919           {
3920             "group": "Body",
3921             "type": "String",
3922             "optional": true,
3923             "field": "formSubmitSuccessMessage",
3924             "description": ""
3925           },
3926           {
3927             "group": "Body",
3928             "type": "String",
3929             "optional": true,
3930             "field": "formSubmitFailureMessage",
3931             "description": ""
3932           },
3933           {
3934             "group": "Body",
3935             "type": "String",
3936             "optional": true,
3937             "field": "noteTitle",
3938             "description": ""
3939           },
3940           {
3941             "group": "Body",
3942             "type": "String",
3943             "optional": true,
3944             "field": "placeholderMessage",
3945             "description": ""
3946           },
3947           {
3948             "group": "Body",
3949             "type": "String",
3950             "optional": true,
3951             "field": "closingMessage",
3952             "description": ""
3953           },
3954           {
3955             "group": "Body",
3956             "type": "String",
3957             "optional": true,
3958             "field": "closingMessageButton",
3959             "description": ""
3960           },
3961           {
3962             "group": "Body",
3963             "type": "String",
3964             "optional": true,
3965             "field": "skipMessageButton",
3966             "description": ""
3967           },
3968           {
3969             "group": "Body",
3970             "type": "Boolean",
3971             "optional": true,
3972             "field": "conditionAgreement",
3973             "description": ""
3974           },
3975           {
3976             "group": "Body",
3977             "type": "Boolean",
3978             "optional": true,
3979             "field": "enableRating",
3980             "description": ""
3981           },
3982           {
3983             "group": "Body",
3984             "type": "Boolean",
3985             "optional": true,
3986             "field": "enableFeedback",
3987             "description": ""
3988           },
3989           {
3990             "group": "Body",
3991             "type": "Boolean",
3992             "optional": true,
3993             "field": "enableSendButton",
3994             "description": ""
3995           },
3996           {
3997             "group": "Body",
3998             "type": "String",
3999             "optional": true,
4000             "field": "feedbackTitle",
4001             "description": ""
4002           },
4003           {
4004             "group": "Body",
4005             "type": "String",
4006             "allowedValues": [
4007               "\"star\"",
4008               "\"thumb\""
4009             ],
4010             "optional": true,
4011             "field": "ratingType",
4012             "description": ""
4013           },
4014           {
4015             "group": "Body",
4016             "type": "Integer",
4017             "optional": true,
4018             "field": "ratingStarsNumber",
4019             "description": ""
4020           },
4021           {
4022             "group": "Body",
4023             "type": "Text",
4024             "optional": true,
4025             "field": "onlineForm",
4026             "description": ""
4027           },
4028           {
4029             "group": "Body",
4030             "type": "Text",
4031             "optional": true,
4032             "field": "offlineForm",
4033             "description": ""
4034           },
4035           {
4036             "group": "Body",
4037             "type": "String",
4038             "optional": true,
4039             "field": "token",
4040             "description": ""
4041           },
4042           {
4043             "group": "Body",
4044             "type": "Boolean",
4045             "optional": true,
4046             "field": "autoclose",
4047             "description": ""
4048           },
4049           {
4050             "group": "Body",
4051             "type": "Boolean",
4052             "optional": true,
4053             "field": "enableCustomerWriting",
4054             "description": ""
4055           },
4056           {
4057             "group": "Body",
4058             "type": "Boolean",
4059             "optional": true,
4060             "field": "forwardTranscript",
4061             "description": ""
4062           },
4063           {
4064             "group": "Body",
4065             "type": "String",
4066             "optional": true,
4067             "field": "forwardTranscriptMessage",
4068             "description": ""
4069           },
4070           {
4071             "group": "Body",
4072             "type": "Boolean",
4073             "optional": true,
4074             "field": "forwardOffline",
4075             "description": ""
4076           },
4077           {
4078             "group": "Body",
4079             "type": "String",
4080             "optional": true,
4081             "field": "forwardOfflineAddress",
4082             "description": ""
4083           },
4084           {
4085             "group": "Body",
4086             "type": "String",
4087             "optional": true,
4088             "field": "waitingTitle",
4089             "description": ""
4090           },
4091           {
4092             "group": "Body",
4093             "type": "String",
4094             "optional": true,
4095             "field": "waitingMessage",
4096             "description": ""
4097           },
4098           {
4099             "group": "Body",
4100             "type": "String",
4101             "optional": true,
4102             "field": "offlineMessageSubject",
4103             "description": ""
4104           },
4105           {
4106             "group": "Body",
4107             "type": "String",
4108             "optional": true,
4109             "field": "offlineMessageBody",
4110             "description": ""
4111           },
4112           {
4113             "group": "Body",
4114             "type": "Boolean",
4115             "optional": true,
4116             "field": "enableUnmanagedNote",
4117             "description": ""
4118           },
4119           {
4120             "group": "Body",
4121             "type": "String",
4122             "optional": true,
4123             "field": "unmanagedMessage",
4124             "description": ""
4125           },
4126           {
4127             "group": "Body",
4128             "type": "String",
4129             "optional": true,
4130             "field": "skipUnmanaged",
4131             "description": ""
4132           },
4133           {
4134             "group": "Body",
4135             "type": "String",
4136             "optional": true,
4137             "field": "sendUnmanaged",
4138             "description": ""
4139           },
4140           {
4141             "group": "Body",
4142             "type": "Boolean",
4143             "optional": true,
4144             "field": "enableCustomerAttachment",
4145             "description": ""
4146           },
4147           {
4148             "group": "Body",
4149             "type": "Boolean",
4150             "optional": true,
4151             "field": "enableCustomerCheckmarks",
4152             "description": ""
4153           },
4154           {
4155             "group": "Body",
4156             "type": "Text",
4157             "optional": true,
4158             "field": "agentAvatar",
4159             "description": ""
4160           },
4161           {
4162             "group": "Body",
4163             "type": "Boolean",
4164             "optional": true,
4165             "field": "showAgentAvatar",
4166             "description": ""
4167           },
4168           {
4169             "group": "Body",
4170             "type": "String",
4171             "optional": true,
4172             "field": "timezone",
4173             "description": ""
4174           },
4175           {
4176             "group": "Body",
4177             "type": "Text",
4178             "optional": true,
4179             "field": "notificationTemplate",
4180             "description": ""
4181           },
4182           {
4183             "group": "Body",
4184             "type": "Boolean",
4185             "optional": true,
4186             "field": "notificationSound",
4187             "description": ""
4188           },
4189           {
4190             "group": "Body",
4191             "type": "Boolean",
4192             "optional": true,
4193             "field": "notificationShake",
4194             "description": ""
4195           },
4196           {
4197             "group": "Body",
4198             "type": "Boolean",
4199             "optional": true,
4200             "field": "hideWhenOffline",
4201             "description": ""
4202           },
4203           {
4204             "group": "Body",
4205             "type": "String",
4206             "optional": true,
4207             "field": "agentIdentifier",
4208             "description": ""
4209           },
4210           {
4211             "group": "Body",
4212             "type": "Integer",
4213             "optional": true,
4214             "field": "waitForTheAssignedAgent",
4215             "description": ""
4216           },
4217           {
4218             "group": "Body",
4219             "type": "String",
4220             "optional": true,
4221             "field": "alignment",
4222             "description": ""
4223           },
4224           {
4225             "group": "Body",
4226             "type": "Integer",
4227             "optional": true,
4228             "field": "verticalAlignment",
4229             "description": ""
4230           },
4231           {
4232             "group": "Body",
4233             "type": "String",
4234             "optional": true,
4235             "field": "messagesAlignment",
4236             "description": ""
4237           },
4238           {
4239             "group": "Body",
4240             "type": "String",
4241             "optional": true,
4242             "field": "defaultTitle",
4243             "description": ""
4244           },
4245           {
4246             "group": "Body",
4247             "type": "Text",
4248             "optional": true,
4249             "field": "customerAvatar",
4250             "description": ""
4251           },
4252           {
4253             "group": "Body",
4254             "type": "Boolean",
4255             "optional": true,
4256             "field": "showCustomerAvatar",
4257             "description": ""
4258           },
4259           {
4260             "group": "Body",
4261             "type": "Integer",
4262             "optional": true,
4263             "field": "messageFontSize",
4264             "description": ""
4265           },
4266           {
4267             "group": "Body",
4268             "type": "String",
4269             "optional": false,
4270             "field": "backgroundColor",
4271             "description": ""
4272           },
4273           {
4274             "group": "Body",
4275             "type": "Boolean",
4276             "optional": true,
4277             "field": "queueTransfer",
4278             "description": ""
4279           },
4280           {
4281             "group": "Body",
4282             "type": "Integer",
4283             "optional": true,
4284             "field": "queueTransferTimeout",
4285             "description": ""
4286           },
4287           {
4288             "group": "Body",
4289             "type": "Boolean",
4290             "optional": true,
4291             "field": "agentTransfer",
4292             "description": ""
4293           },
4294           {
4295             "group": "Body",
4296             "type": "Integer",
4297             "optional": true,
4298             "field": "agentTransferTimeout",
4299             "description": ""
4300           },
4301           {
4302             "group": "Body",
4303             "type": "String",
4304             "optional": true,
4305             "field": "systemAlias",
4306             "description": ""
4307           },
4308           {
4309             "group": "Body",
4310             "type": "Text",
4311             "optional": true,
4312             "field": "systemAvatar",
4313             "description": ""
4314           },
4315           {
4316             "group": "Body",
4317             "type": "Integer",
4318             "optional": true,
4319             "field": "mandatoryDispositionPauseId",
4320             "description": "<p>Status to put when mandatory disposition is enabled</p>"
4321           },
4322           {
4323             "group": "Body",
4324             "type": "Boolean",
4325             "optional": true,
4326             "field": "mandatoryDisposition",
4327             "description": "<p>Enabled/disables mandatory dispo on a queue</p>"
4328           },
4329           {
4330             "group": "Body",
4331             "type": "Boolean",
4332             "optional": true,
4333             "field": "vidaooEscalation",
4334             "description": ""
4335           },
4336           {
4337             "group": "Body",
4338             "type": "String",
4339             "optional": true,
4340             "field": "vidaooApiKey",
4341             "description": ""
4342           }
4343         ]
4344       }
4345     },
4346     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4347     "version": "0.0.0",
4348     "filename": "server/api/chatWebsite/index.js",
4349     "groupTitle": "Chat_Websites"
4350   },
4351   {
4352     "type": "delete",
4353     "url": "/api/chat/websites/{id}",
4354     "title": "Deletes a Website",
4355     "examples": [
4356       {
4357         "title": "Example usage:",
4358         "content": "curl https://{domain}/api/chat/websites/{id} -v -u {name}:{password} -X DELETE",
4359         "type": "json"
4360       }
4361     ],
4362     "name": "DeleteWebsites",
4363     "group": "Chat_Websites",
4364     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4365     "version": "0.0.0",
4366     "filename": "server/api/chatWebsite/index.js",
4367     "groupTitle": "Chat_Websites"
4368   },
4369   {
4370     "type": "get",
4371     "url": "/api/chat/websites/describe",
4372     "title": "Gets table info about Websites",
4373     "examples": [
4374       {
4375         "title": "Example usage:",
4376         "content": "curl https://{domain}/api/chat/websites/describe -v -u {name}:{password}",
4377         "type": "json"
4378       }
4379     ],
4380     "name": "DescribeWebsites",
4381     "group": "Chat_Websites",
4382     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4383     "version": "0.0.0",
4384     "filename": "server/api/chatWebsite/index.js",
4385     "groupTitle": "Chat_Websites"
4386   },
4387   {
4388     "type": "get",
4389     "url": "/api/chat/websites/{id}/users",
4390     "title": "Gets agents from website",
4391     "examples": [
4392       {
4393         "title": "Example usage:",
4394         "content": "curl https://{domain}/api/chat/websites/{id}/users -v -u {name}:{password} -X GET",
4395         "type": "json"
4396       }
4397     ],
4398     "name": "GetAgents",
4399     "group": "Chat_Websites",
4400     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4401     "version": "0.0.0",
4402     "filename": "server/api/chatWebsite/index.js",
4403     "groupTitle": "Chat_Websites"
4404   },
4405   {
4406     "type": "get",
4407     "url": "/api/chat/websites",
4408     "title": "Gets a list of Websites",
4409     "examples": [
4410       {
4411         "title": "Example usage:",
4412         "content": "curl https://{domain}/api/chat/websites -v -u {name}:{password}",
4413         "type": "json"
4414       }
4415     ],
4416     "name": "GetWebsites",
4417     "group": "Chat_Websites",
4418     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
4419     "version": "0.0.0",
4420     "filename": "server/api/chatWebsite/index.js",
4421     "groupTitle": "Chat_Websites"
4422   },
4423   {
4424     "type": "delete",
4425     "url": "/api/chat/websites/{id}/users",
4426     "title": "Removes agents from a website",
4427     "examples": [
4428       {
4429         "title": "Example usage:",
4430         "content": "curl https://{domain}/api/chat/websites/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
4431         "type": "json"
4432       }
4433     ],
4434     "name": "RemoveAgents",
4435     "group": "Chat_Websites",
4436     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4437     "version": "0.0.0",
4438     "filename": "server/api/chatWebsite/index.js",
4439     "groupTitle": "Chat_Websites"
4440   },
4441   {
4442     "type": "delete",
4443     "url": "/api/chat/websites/{id}/canned_answers",
4444     "title": "Removes canned answers from account",
4445     "examples": [
4446       {
4447         "title": "Example usage:",
4448         "content": "curl https://{domain}/api/chat/websites/{id}/canned_answers?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
4449         "type": "json"
4450       }
4451     ],
4452     "name": "RemoveAnswers",
4453     "group": "Chat_Websites",
4454     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4455     "version": "0.0.0",
4456     "filename": "server/api/chatWebsite/index.js",
4457     "groupTitle": "Chat_Websites"
4458   },
4459   {
4460     "type": "delete",
4461     "url": "/api/chat/websites/{id}/dispositions",
4462     "title": "Removes canned answers from account",
4463     "examples": [
4464       {
4465         "title": "Example usage:",
4466         "content": "curl https://{domain}/api/chat/websites/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
4467         "type": "json"
4468       }
4469     ],
4470     "name": "RemoveDispositions",
4471     "group": "Chat_Websites",
4472     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4473     "version": "0.0.0",
4474     "filename": "server/api/chatWebsite/index.js",
4475     "groupTitle": "Chat_Websites"
4476   },
4477   {
4478     "type": "get",
4479     "url": "/api/chat/websites/{id}",
4480     "title": "Gets a single Website",
4481     "examples": [
4482       {
4483         "title": "Example usage:",
4484         "content": "curl https://{domain}/api/chat/websites/{id} -v -u {name}:{password}",
4485         "type": "json"
4486       }
4487     ],
4488     "name": "ShowWebsites",
4489     "group": "Chat_Websites",
4490     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4491     "version": "0.0.0",
4492     "filename": "server/api/chatWebsite/index.js",
4493     "groupTitle": "Chat_Websites"
4494   },
4495   {
4496     "type": "put",
4497     "url": "/api/chat/messages/{id}/accept",
4498     "title": "Accepts message",
4499     "examples": [
4500       {
4501         "title": "Example usage:",
4502         "content": "curl https://{domain}/api/chat/messages/{id}/accept \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
4503         "type": "json"
4504       }
4505     ],
4506     "name": "acceptMessage",
4507     "group": "Chat_Websites",
4508     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4509     "version": "0.0.0",
4510     "filename": "server/api/chatMessage/index.js",
4511     "groupTitle": "Chat_Websites"
4512   },
4513   {
4514     "type": "post",
4515     "url": "/api/chat/websites/{id}/canned_answers",
4516     "title": "Creates new canned answer",
4517     "examples": [
4518       {
4519         "title": "Example usage:",
4520         "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",
4521         "type": "json"
4522       }
4523     ],
4524     "name": "addAnswer",
4525     "group": "Chat_Websites",
4526     "parameter": {
4527       "fields": {
4528         "Body": [
4529           {
4530             "group": "Body",
4531             "type": "String",
4532             "optional": false,
4533             "field": "key",
4534             "description": ""
4535           },
4536           {
4537             "group": "Body",
4538             "type": "Text",
4539             "optional": false,
4540             "field": "value",
4541             "description": ""
4542           },
4543           {
4544             "group": "Body",
4545             "type": "String",
4546             "optional": true,
4547             "field": "description",
4548             "description": ""
4549           },
4550           {
4551             "group": "Body",
4552             "type": "Virtual",
4553             "optional": true,
4554             "field": "name",
4555             "description": ""
4556           }
4557         ]
4558       }
4559     },
4560     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4561     "version": "0.0.0",
4562     "filename": "server/api/chatWebsite/index.js",
4563     "groupTitle": "Chat_Websites"
4564   },
4565   {
4566     "type": "post",
4567     "url": "/api/chat/websites/{id}/applications",
4568     "title": "Creates new applications",
4569     "examples": [
4570       {
4571         "title": "Example usage:",
4572         "content": "curl https://{domain}/api/chat/websites/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
4573         "type": "json"
4574       }
4575     ],
4576     "name": "addApplications",
4577     "group": "Chat_Websites",
4578     "parameter": {
4579       "fields": {
4580         "Body": [
4581           {
4582             "group": "Body",
4583             "type": "Integer",
4584             "optional": false,
4585             "field": "priority",
4586             "description": ""
4587           },
4588           {
4589             "group": "Body",
4590             "type": "String",
4591             "optional": false,
4592             "field": "app",
4593             "description": ""
4594           },
4595           {
4596             "group": "Body",
4597             "type": "Text",
4598             "optional": true,
4599             "field": "appdata",
4600             "description": ""
4601           },
4602           {
4603             "group": "Body",
4604             "type": "String",
4605             "optional": true,
4606             "field": "description",
4607             "description": ""
4608           },
4609           {
4610             "group": "Body",
4611             "type": "String",
4612             "optional": true,
4613             "field": "interval",
4614             "description": ""
4615           }
4616         ]
4617       }
4618     },
4619     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4620     "version": "0.0.0",
4621     "filename": "server/api/chatWebsite/index.js",
4622     "groupTitle": "Chat_Websites"
4623   },
4624   {
4625     "type": "post",
4626     "url": "/api/chat/websites/{id}/avatar",
4627     "title": "Add avatar",
4628     "examples": [
4629       {
4630         "title": "Example usage:",
4631         "content": "curl https://{domain}/api/chat/websites/{id}/avatar -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
4632         "type": "json"
4633       }
4634     ],
4635     "name": "addAvatar",
4636     "group": "Chat_Websites",
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}/customer_avatar",
4645     "title": "Add customer avatar",
4646     "examples": [
4647       {
4648         "title": "Example usage:",
4649         "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",
4650         "type": "json"
4651       }
4652     ],
4653     "name": "addCustomerAvatar",
4654     "group": "Chat_Websites",
4655     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4656     "version": "0.0.0",
4657     "filename": "server/api/chatWebsite/index.js",
4658     "groupTitle": "Chat_Websites"
4659   },
4660   {
4661     "type": "post",
4662     "url": "/api/chat/websites/{id}/dispositions",
4663     "title": "Creates new disposition",
4664     "examples": [
4665       {
4666         "title": "Example usage:",
4667         "content": "curl https://{domain}/api/chat/websites/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
4668         "type": "json"
4669       }
4670     ],
4671     "name": "addDisposition",
4672     "group": "Chat_Websites",
4673     "parameter": {
4674       "fields": {
4675         "Body": [
4676           {
4677             "group": "Body",
4678             "type": "String",
4679             "optional": false,
4680             "field": "name",
4681             "description": ""
4682           }
4683         ]
4684       }
4685     },
4686     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4687     "version": "0.0.0",
4688     "filename": "server/api/chatWebsite/index.js",
4689     "groupTitle": "Chat_Websites"
4690   },
4691   {
4692     "type": "post",
4693     "url": "/api/chat/accounts/{id}/interactions",
4694     "title": "Creates new interactions",
4695     "examples": [
4696       {
4697         "title": "Example usage:",
4698         "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",
4699         "type": "json"
4700       }
4701     ],
4702     "name": "addInteraction",
4703     "group": "Chat_Websites",
4704     "parameter": {
4705       "fields": {
4706         "Body": [
4707           {
4708             "group": "Body",
4709             "type": "Boolean",
4710             "optional": true,
4711             "field": "closed",
4712             "description": ""
4713           },
4714           {
4715             "group": "Body",
4716             "type": "Integer",
4717             "optional": true,
4718             "field": "ratingValue",
4719             "description": ""
4720           },
4721           {
4722             "group": "Body",
4723             "type": "String",
4724             "allowedValues": [
4725               "\"star\"",
4726               "\"thumb\""
4727             ],
4728             "optional": true,
4729             "field": "ratingType",
4730             "description": ""
4731           },
4732           {
4733             "group": "Body",
4734             "type": "Text",
4735             "optional": true,
4736             "field": "ratingMessage",
4737             "description": ""
4738           },
4739           {
4740             "group": "Body",
4741             "type": "Text",
4742             "optional": true,
4743             "field": "pathTranscript",
4744             "description": ""
4745           },
4746           {
4747             "group": "Body",
4748             "type": "String",
4749             "optional": true,
4750             "field": "mailTranscript",
4751             "description": ""
4752           },
4753           {
4754             "group": "Body",
4755             "type": "String",
4756             "optional": true,
4757             "field": "closedAt",
4758             "description": ""
4759           },
4760           {
4761             "group": "Body",
4762             "type": "String",
4763             "optional": true,
4764             "field": "disposition",
4765             "description": ""
4766           },
4767           {
4768             "group": "Body",
4769             "type": "String",
4770             "optional": true,
4771             "field": "note",
4772             "description": ""
4773           },
4774           {
4775             "group": "Body",
4776             "type": "String",
4777             "optional": true,
4778             "field": "browserName",
4779             "description": ""
4780           },
4781           {
4782             "group": "Body",
4783             "type": "String",
4784             "optional": true,
4785             "field": "browserVersion",
4786             "description": ""
4787           },
4788           {
4789             "group": "Body",
4790             "type": "String",
4791             "optional": true,
4792             "field": "osName",
4793             "description": ""
4794           },
4795           {
4796             "group": "Body",
4797             "type": "String",
4798             "optional": true,
4799             "field": "osVersion",
4800             "description": ""
4801           },
4802           {
4803             "group": "Body",
4804             "type": "String",
4805             "optional": true,
4806             "field": "deviceModel",
4807             "description": ""
4808           },
4809           {
4810             "group": "Body",
4811             "type": "String",
4812             "optional": true,
4813             "field": "deviceVendor",
4814             "description": ""
4815           },
4816           {
4817             "group": "Body",
4818             "type": "String",
4819             "optional": true,
4820             "field": "deviceType",
4821             "description": ""
4822           },
4823           {
4824             "group": "Body",
4825             "type": "Text",
4826             "optional": true,
4827             "field": "referer",
4828             "description": ""
4829           },
4830           {
4831             "group": "Body",
4832             "type": "String",
4833             "optional": true,
4834             "field": "customerIp",
4835             "description": ""
4836           },
4837           {
4838             "group": "Body",
4839             "type": "Text",
4840             "optional": true,
4841             "field": "formData",
4842             "description": ""
4843           },
4844           {
4845             "group": "Body",
4846             "type": "String",
4847             "optional": true,
4848             "field": "read1stAt",
4849             "description": ""
4850           },
4851           {
4852             "group": "Body",
4853             "type": "String",
4854             "optional": true,
4855             "field": "lastMsgAt",
4856             "description": ""
4857           },
4858           {
4859             "group": "Body",
4860             "type": "String",
4861             "allowedValues": [
4862               "\"in\"",
4863               "\"out\""
4864             ],
4865             "optional": false,
4866             "field": "lastMsgDirection",
4867             "description": ""
4868           },
4869           {
4870             "group": "Body",
4871             "type": "String",
4872             "optional": true,
4873             "field": "closeReason",
4874             "description": ""
4875           },
4876           {
4877             "group": "Body",
4878             "type": "String",
4879             "optional": true,
4880             "field": "customerPort",
4881             "description": ""
4882           },
4883           {
4884             "group": "Body",
4885             "type": "Text",
4886             "optional": true,
4887             "field": "vidaooSessionId",
4888             "description": ""
4889           }
4890         ]
4891       }
4892     },
4893     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4894     "version": "0.0.0",
4895     "filename": "server/api/chatWebsite/index.js",
4896     "groupTitle": "Chat_Websites"
4897   },
4898   {
4899     "type": "post",
4900     "url": "/api/chat/websites/{id}/logo",
4901     "title": "Add logo",
4902     "examples": [
4903       {
4904         "title": "Example usage:",
4905         "content": "curl https://{domain}/api/chat/websites/{id}/logo -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
4906         "type": "json"
4907       }
4908     ],
4909     "name": "addLogo",
4910     "group": "Chat_Websites",
4911     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4912     "version": "0.0.0",
4913     "filename": "server/api/chatWebsite/index.js",
4914     "groupTitle": "Chat_Websites"
4915   },
4916   {
4917     "type": "post",
4918     "url": "/api/chat/websites/{id}/proactive_actions",
4919     "title": "Creates new Proactive Actions",
4920     "examples": [
4921       {
4922         "title": "Example usage:",
4923         "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",
4924         "type": "json"
4925       }
4926     ],
4927     "name": "addProactiveActions",
4928     "group": "Chat_Websites",
4929     "parameter": {
4930       "fields": {
4931         "Body": [
4932           {
4933             "group": "Body",
4934             "type": "String",
4935             "optional": false,
4936             "field": "name",
4937             "description": ""
4938           },
4939           {
4940             "group": "Body",
4941             "type": "String",
4942             "allowedValues": [
4943               "\"mouseOver\"",
4944               "\"timeout\""
4945             ],
4946             "optional": true,
4947             "field": "type",
4948             "description": ""
4949           },
4950           {
4951             "group": "Body",
4952             "type": "String",
4953             "optional": true,
4954             "field": "selector",
4955             "description": ""
4956           },
4957           {
4958             "group": "Body",
4959             "type": "Integer",
4960             "optional": true,
4961             "field": "timeout",
4962             "description": ""
4963           }
4964         ]
4965       }
4966     },
4967     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4968     "version": "0.0.0",
4969     "filename": "server/api/chatWebsite/index.js",
4970     "groupTitle": "Chat_Websites"
4971   },
4972   {
4973     "type": "post",
4974     "url": "/api/chat/websites/{id}/system_avatar",
4975     "title": "Add system avatar",
4976     "examples": [
4977       {
4978         "title": "Example usage:",
4979         "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",
4980         "type": "json"
4981       }
4982     ],
4983     "name": "addSystemAvatar",
4984     "group": "Chat_Websites",
4985     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4986     "version": "0.0.0",
4987     "filename": "server/api/chatWebsite/index.js",
4988     "groupTitle": "Chat_Websites"
4989   },
4990   {
4991     "type": "get",
4992     "url": "/api/chat/websites/{id}/canned_answers",
4993     "title": "Gets account canned answers",
4994     "examples": [
4995       {
4996         "title": "Example usage:",
4997         "content": "curl https://{domain}/api/chat/websites/{id}/canned_answers -v -u {name}:{password} -X GET",
4998         "type": "json"
4999       }
5000     ],
5001     "name": "getAnswers",
5002     "group": "Chat_Websites",
5003     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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": "get",
5010     "url": "/api/chat/websites/{id}/applications",
5011     "title": "Gets Website Applications",
5012     "examples": [
5013       {
5014         "title": "Example usage:",
5015         "content": "curl https://{domain}/api/chat/websites/{id}/applications -v -u {name}:{password} -X GET",
5016         "type": "json"
5017       }
5018     ],
5019     "name": "getApplications",
5020     "group": "Chat_Websites",
5021     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</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": "get",
5028     "url": "/api/chat/websites/{id}/avatar",
5029     "title": "Get avatar",
5030     "examples": [
5031       {
5032         "title": "Example usage:",
5033         "content": "curl https://{domain}/api/chat/websites/{id}/avatar -v -u {name}:{password} -X GET",
5034         "type": "json"
5035       }
5036     ],
5037     "name": "getAvatar",
5038     "group": "Chat_Websites",
5039     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5040     "version": "0.0.0",
5041     "filename": "server/api/chatWebsite/index.js",
5042     "groupTitle": "Chat_Websites"
5043   },
5044   {
5045     "type": "get",
5046     "url": "/api/chat/websites/{id}/customer_avatar",
5047     "title": "Get Customer Avatar",
5048     "examples": [
5049       {
5050         "title": "Example usage:",
5051         "content": "curl https://{domain}/api/chat/websites/{id}/customer_avatar -v -u {name}:{password} -X GET",
5052         "type": "json"
5053       }
5054     ],
5055     "name": "getCustomerAvatar",
5056     "group": "Chat_Websites",
5057     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5058     "version": "0.0.0",
5059     "filename": "server/api/chatWebsite/index.js",
5060     "groupTitle": "Chat_Websites"
5061   },
5062   {
5063     "type": "get",
5064     "url": "/api/chat/websites/{id}/dispositions",
5065     "title": "Gets account dispositions",
5066     "examples": [
5067       {
5068         "title": "Example usage:",
5069         "content": "curl https://{domain}/api/chat/websites/{id}/dispositions -v -u {name}:{password} -X GET",
5070         "type": "json"
5071       }
5072     ],
5073     "name": "getDispositions",
5074     "group": "Chat_Websites",
5075     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5076     "version": "0.0.0",
5077     "filename": "server/api/chatWebsite/index.js",
5078     "groupTitle": "Chat_Websites"
5079   },
5080   {
5081     "type": "get",
5082     "url": "/api/chat/websites/{id}/fields",
5083     "title": "Gets Website Fields",
5084     "examples": [
5085       {
5086         "title": "Example usage:",
5087         "content": "curl https://{domain}/api/chat/websites/{id}/fields -v -u {name}:{password} -X GET",
5088         "type": "json"
5089       }
5090     ],
5091     "name": "getFields",
5092     "group": "Chat_Websites",
5093     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5094     "version": "0.0.0",
5095     "filename": "server/api/chatWebsite/index.js",
5096     "groupTitle": "Chat_Websites"
5097   },
5098   {
5099     "type": "get",
5100     "url": "/api/chat/websites/{id}/interactions",
5101     "title": "Gets Website Interactions",
5102     "examples": [
5103       {
5104         "title": "Example usage:",
5105         "content": "curl https://{domain}/api/chat/websites/{id}/interactions -v -u {name}:{password} -X GET",
5106         "type": "json"
5107       }
5108     ],
5109     "name": "getInteraction",
5110     "group": "Chat_Websites",
5111     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5112     "version": "0.0.0",
5113     "filename": "server/api/chatWebsite/index.js",
5114     "groupTitle": "Chat_Websites"
5115   },
5116   {
5117     "type": "get",
5118     "url": "/api/chat/websites/{id}/logo",
5119     "title": "Get logo",
5120     "examples": [
5121       {
5122         "title": "Example usage:",
5123         "content": "curl https://{domain}/api/chat/websites/{id}/logo -v -u {name}:{password} -X GET",
5124         "type": "json"
5125       }
5126     ],
5127     "name": "getLogo",
5128     "group": "Chat_Websites",
5129     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5130     "version": "0.0.0",
5131     "filename": "server/api/chatWebsite/index.js",
5132     "groupTitle": "Chat_Websites"
5133   },
5134   {
5135     "type": "get",
5136     "url": "/api/chat/websites/{id}/offline_messages",
5137     "title": "Gets Website Offline Messages",
5138     "examples": [
5139       {
5140         "title": "Example usage:",
5141         "content": "curl https://{domain}/api/chat/websites/{id}/offline_messages -v -u {name}:{password} -X GET",
5142         "type": "json"
5143       }
5144     ],
5145     "name": "getOfflineMessages",
5146     "group": "Chat_Websites",
5147     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5148     "version": "0.0.0",
5149     "filename": "server/api/chatWebsite/index.js",
5150     "groupTitle": "Chat_Websites"
5151   },
5152   {
5153     "type": "get",
5154     "url": "/api/chat/websites/{id}/proactive_actions",
5155     "title": "Gets Website Proactive Actions",
5156     "examples": [
5157       {
5158         "title": "Example usage:",
5159         "content": "curl https://{domain}/api/chat/websites/{id}/proactive_actions -v -u {name}:{password} -X GET",
5160         "type": "json"
5161       }
5162     ],
5163     "name": "getProactiveActions",
5164     "group": "Chat_Websites",
5165     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5166     "version": "0.0.0",
5167     "filename": "server/api/chatWebsite/index.js",
5168     "groupTitle": "Chat_Websites"
5169   },
5170   {
5171     "type": "get",
5172     "url": "/api/chat/websites/{id}/snippet",
5173     "title": "Gets Website Snippet",
5174     "examples": [
5175       {
5176         "title": "Example usage:",
5177         "content": "curl https://{domain}/api/chat/websites/{id}/snippet -v -u {name}:{password} -X GET",
5178         "type": "json"
5179       }
5180     ],
5181     "name": "getSnippet",
5182     "group": "Chat_Websites",
5183     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5184     "version": "0.0.0",
5185     "filename": "server/api/chatWebsite/index.js",
5186     "groupTitle": "Chat_Websites"
5187   },
5188   {
5189     "type": "get",
5190     "url": "/api/chat/websites/{id}/system_avatar",
5191     "title": "Get System Avatar",
5192     "examples": [
5193       {
5194         "title": "Example usage:",
5195         "content": "curl https://{domain}/api/chat/websites/{id}/system_avatar -v -u {name}:{password} -X GET",
5196         "type": "json"
5197       }
5198     ],
5199     "name": "getSystemAvatar",
5200     "group": "Chat_Websites",
5201     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5202     "version": "0.0.0",
5203     "filename": "server/api/chatWebsite/index.js",
5204     "groupTitle": "Chat_Websites"
5205   },
5206   {
5207     "type": "post",
5208     "url": "/api/chat/websites/{id}/notify",
5209     "title": "Notify new message",
5210     "examples": [
5211       {
5212         "title": "Example usage:",
5213         "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",
5214         "type": "json"
5215       }
5216     ],
5217     "name": "notify",
5218     "group": "Chat_Websites",
5219     "description": "<p>Motion 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>",
5220     "version": "0.0.0",
5221     "filename": "server/api/chatWebsite/index.js",
5222     "groupTitle": "Chat_Websites"
5223   },
5224   {
5225     "type": "post",
5226     "url": "/api/chat/websites/{id}/offline",
5227     "title": "Offline message",
5228     "examples": [
5229       {
5230         "title": "Example usage:",
5231         "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",
5232         "type": "json"
5233       }
5234     ],
5235     "name": "offline",
5236     "group": "Chat_Websites",
5237     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5238     "version": "0.0.0",
5239     "filename": "server/api/chatWebsite/index.js",
5240     "groupTitle": "Chat_Websites"
5241   },
5242   {
5243     "type": "put",
5244     "url": "/api/chat/messages/{id}/reject",
5245     "title": "Rejects message",
5246     "examples": [
5247       {
5248         "title": "Example usage:",
5249         "content": "curl https://{domain}/api/chat/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
5250         "type": "json"
5251       }
5252     ],
5253     "name": "rejectMessage",
5254     "group": "Chat_Websites",
5255     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5256     "version": "0.0.0",
5257     "filename": "server/api/chatMessage/index.js",
5258     "groupTitle": "Chat_Websites"
5259   },
5260   {
5261     "type": "put",
5262     "url": "/api/chat/websites/{id}",
5263     "title": "Update an existing Website",
5264     "examples": [
5265       {
5266         "title": "Example usage:",
5267         "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",
5268         "type": "json"
5269       }
5270     ],
5271     "name": "updateWebsites",
5272     "group": "Chat_Websites",
5273     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5274     "version": "0.0.0",
5275     "filename": "server/api/chatWebsite/index.js",
5276     "groupTitle": "Chat_Websites"
5277   },
5278   {
5279     "type": "post",
5280     "url": "/api/cloudProviders",
5281     "title": "Creates a new CloudProvider",
5282     "examples": [
5283       {
5284         "title": "Example usage:",
5285         "content": "curl https://{domain}/api/cloudProviders -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
5286         "type": "json"
5287       }
5288     ],
5289     "name": "CreateCloudProviders",
5290     "group": "CloudProviders",
5291     "parameter": {
5292       "fields": {
5293         "Body": [
5294           {
5295             "group": "Body",
5296             "type": "String",
5297             "optional": false,
5298             "field": "name",
5299             "description": ""
5300           },
5301           {
5302             "group": "Body",
5303             "type": "String",
5304             "allowedValues": [
5305               "\"AmazonAWS\"",
5306               "\"Google\""
5307             ],
5308             "optional": false,
5309             "field": "service",
5310             "description": ""
5311           },
5312           {
5313             "group": "Body",
5314             "type": "String",
5315             "optional": true,
5316             "field": "data1",
5317             "description": ""
5318           },
5319           {
5320             "group": "Body",
5321             "type": "String",
5322             "optional": true,
5323             "field": "data2",
5324             "description": ""
5325           }
5326         ]
5327       }
5328     },
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>",
5330     "version": "0.0.0",
5331     "filename": "server/api/cloudProvider/index.js",
5332     "groupTitle": "CloudProviders"
5333   },
5334   {
5335     "type": "delete",
5336     "url": "/api/cloudProviders/{id}",
5337     "title": "Deletes a CloudProvider",
5338     "examples": [
5339       {
5340         "title": "Example usage:",
5341         "content": "curl https://{domain}/api/cloudProviders/{id} -v -u {name}:{password} -X DELETE",
5342         "type": "json"
5343       }
5344     ],
5345     "name": "DeleteCloudProviders",
5346     "group": "CloudProviders",
5347     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5348     "version": "0.0.0",
5349     "filename": "server/api/cloudProvider/index.js",
5350     "groupTitle": "CloudProviders"
5351   },
5352   {
5353     "type": "get",
5354     "url": "/api/cloudProviders",
5355     "title": "Gets a list of CloudProviders",
5356     "examples": [
5357       {
5358         "title": "Example usage:",
5359         "content": "curl https://{domain}/api/cloudProviders -v -u {name}:{password}",
5360         "type": "json"
5361       }
5362     ],
5363     "name": "GetCloudProviders",
5364     "group": "CloudProviders",
5365     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
5366     "version": "0.0.0",
5367     "filename": "server/api/cloudProvider/index.js",
5368     "groupTitle": "CloudProviders"
5369   },
5370   {
5371     "type": "get",
5372     "url": "/api/cloudProviders/{id}",
5373     "title": "Gets a single CloudProvider",
5374     "examples": [
5375       {
5376         "title": "Example usage:",
5377         "content": "curl https://{domain}/api/cloudProviders/{id} -v -u {name}:{password}",
5378         "type": "json"
5379       }
5380     ],
5381     "name": "ShowCloudProviders",
5382     "group": "CloudProviders",
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/cloudProvider/index.js",
5386     "groupTitle": "CloudProviders"
5387   },
5388   {
5389     "type": "put",
5390     "url": "/api/cloudProviders/{id}",
5391     "title": "Update an existing CloudProvider",
5392     "examples": [
5393       {
5394         "title": "Example usage:",
5395         "content": "curl https://{domain}/api/cloudProviders/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
5396         "type": "json"
5397       }
5398     ],
5399     "name": "updateCloudProviders",
5400     "group": "CloudProviders",
5401     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5402     "version": "0.0.0",
5403     "filename": "server/api/cloudProvider/index.js",
5404     "groupTitle": "CloudProviders"
5405   },
5406   {
5407     "type": "post",
5408     "url": "/api/cm/companies",
5409     "title": "Creates a new Company",
5410     "examples": [
5411       {
5412         "title": "Example usage:",
5413         "content": "curl https://{domain}/api/cm/companies -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
5414         "type": "json"
5415       }
5416     ],
5417     "name": "CreateCompanies",
5418     "group": "Cm_Companies",
5419     "parameter": {
5420       "fields": {
5421         "Body": [
5422           {
5423             "group": "Body",
5424             "type": "String",
5425             "optional": false,
5426             "field": "name",
5427             "description": ""
5428           },
5429           {
5430             "group": "Body",
5431             "type": "String",
5432             "optional": true,
5433             "field": "vat",
5434             "description": ""
5435           },
5436           {
5437             "group": "Body",
5438             "type": "String",
5439             "optional": true,
5440             "field": "companyId",
5441             "description": ""
5442           },
5443           {
5444             "group": "Body",
5445             "type": "String",
5446             "optional": true,
5447             "field": "website",
5448             "description": ""
5449           },
5450           {
5451             "group": "Body",
5452             "type": "String",
5453             "optional": true,
5454             "field": "phone",
5455             "description": ""
5456           },
5457           {
5458             "group": "Body",
5459             "type": "String",
5460             "optional": true,
5461             "field": "fax",
5462             "description": ""
5463           },
5464           {
5465             "group": "Body",
5466             "type": "String",
5467             "optional": true,
5468             "field": "type",
5469             "description": ""
5470           },
5471           {
5472             "group": "Body",
5473             "type": "String",
5474             "optional": true,
5475             "field": "street",
5476             "description": ""
5477           },
5478           {
5479             "group": "Body",
5480             "type": "String",
5481             "optional": true,
5482             "field": "postalCode",
5483             "description": ""
5484           },
5485           {
5486             "group": "Body",
5487             "type": "String",
5488             "optional": true,
5489             "field": "city",
5490             "description": ""
5491           },
5492           {
5493             "group": "Body",
5494             "type": "String",
5495             "optional": true,
5496             "field": "country",
5497             "description": ""
5498           },
5499           {
5500             "group": "Body",
5501             "type": "String",
5502             "optional": true,
5503             "field": "email",
5504             "description": ""
5505           },
5506           {
5507             "group": "Body",
5508             "type": "String",
5509             "optional": true,
5510             "field": "emailDomain",
5511             "description": ""
5512           },
5513           {
5514             "group": "Body",
5515             "type": "String",
5516             "optional": true,
5517             "field": "sStreet",
5518             "description": ""
5519           },
5520           {
5521             "group": "Body",
5522             "type": "String",
5523             "optional": true,
5524             "field": "sPostalCode",
5525             "description": ""
5526           },
5527           {
5528             "group": "Body",
5529             "type": "String",
5530             "optional": true,
5531             "field": "sCity",
5532             "description": ""
5533           },
5534           {
5535             "group": "Body",
5536             "type": "String",
5537             "optional": true,
5538             "field": "sCountry",
5539             "description": ""
5540           },
5541           {
5542             "group": "Body",
5543             "type": "String",
5544             "optional": true,
5545             "field": "description",
5546             "description": ""
5547           }
5548         ]
5549       }
5550     },
5551     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5552     "version": "0.0.0",
5553     "filename": "server/api/cmCompany/index.js",
5554     "groupTitle": "Cm_Companies"
5555   },
5556   {
5557     "type": "delete",
5558     "url": "/api/cm/companies/{id}",
5559     "title": "Deletes a Company",
5560     "examples": [
5561       {
5562         "title": "Example usage:",
5563         "content": "curl https://{domain}/api/cm/companies/{id} -v -u {name}:{password} -X DELETE",
5564         "type": "json"
5565       }
5566     ],
5567     "name": "DeleteCompanies",
5568     "group": "Cm_Companies",
5569     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5570     "version": "0.0.0",
5571     "filename": "server/api/cmCompany/index.js",
5572     "groupTitle": "Cm_Companies"
5573   },
5574   {
5575     "type": "get",
5576     "url": "/api/cm/companies/describe",
5577     "title": "Gets table info about Companies",
5578     "examples": [
5579       {
5580         "title": "Example usage:",
5581         "content": "curl https://{domain}/api/cm/companies/describe -v -u {name}:{password}",
5582         "type": "json"
5583       }
5584     ],
5585     "name": "DescribeCompanies",
5586     "group": "Cm_Companies",
5587     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5588     "version": "0.0.0",
5589     "filename": "server/api/cmCompany/index.js",
5590     "groupTitle": "Cm_Companies"
5591   },
5592   {
5593     "type": "get",
5594     "url": "/api/cm/companies",
5595     "title": "Gets a list of Companies",
5596     "examples": [
5597       {
5598         "title": "Example usage:",
5599         "content": "curl https://{domain}/api/cm/companies -v -u {name}:{password}",
5600         "type": "json"
5601       }
5602     ],
5603     "name": "GetCompanies",
5604     "group": "Cm_Companies",
5605     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
5606     "version": "0.0.0",
5607     "filename": "server/api/cmCompany/index.js",
5608     "groupTitle": "Cm_Companies"
5609   },
5610   {
5611     "type": "get",
5612     "url": "/api/cm/companies/{id}",
5613     "title": "Gets a single Company",
5614     "examples": [
5615       {
5616         "title": "Example usage:",
5617         "content": "curl https://{domain}/api/cm/companies/{id} -v -u {name}:{password}",
5618         "type": "json"
5619       }
5620     ],
5621     "name": "ShowCompanies",
5622     "group": "Cm_Companies",
5623     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5624     "version": "0.0.0",
5625     "filename": "server/api/cmCompany/index.js",
5626     "groupTitle": "Cm_Companies"
5627   },
5628   {
5629     "type": "post",
5630     "url": "/api/cm/companies/{id}/contacts",
5631     "title": "Creates new contacts",
5632     "examples": [
5633       {
5634         "title": "Example usage:",
5635         "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",
5636         "type": "json"
5637       }
5638     ],
5639     "name": "addContacts",
5640     "group": "Cm_Companies",
5641     "parameter": {
5642       "fields": {
5643         "Body": [
5644           {
5645             "group": "Body",
5646             "type": "String",
5647             "optional": false,
5648             "field": "firstName",
5649             "description": ""
5650           },
5651           {
5652             "group": "Body",
5653             "type": "String",
5654             "optional": true,
5655             "field": "lastName",
5656             "description": ""
5657           },
5658           {
5659             "group": "Body",
5660             "type": "String",
5661             "optional": true,
5662             "field": "street",
5663             "description": ""
5664           },
5665           {
5666             "group": "Body",
5667             "type": "String",
5668             "optional": true,
5669             "field": "postalCode",
5670             "description": ""
5671           },
5672           {
5673             "group": "Body",
5674             "type": "String",
5675             "optional": true,
5676             "field": "city",
5677             "description": ""
5678           },
5679           {
5680             "group": "Body",
5681             "type": "String",
5682             "optional": true,
5683             "field": "country",
5684             "description": ""
5685           },
5686           {
5687             "group": "Body",
5688             "type": "String",
5689             "optional": true,
5690             "field": "dateOfBirth",
5691             "description": ""
5692           },
5693           {
5694             "group": "Body",
5695             "type": "Text",
5696             "optional": true,
5697             "field": "description",
5698             "description": ""
5699           },
5700           {
5701             "group": "Body",
5702             "type": "String",
5703             "optional": true,
5704             "field": "phone",
5705             "description": ""
5706           },
5707           {
5708             "group": "Body",
5709             "type": "String",
5710             "optional": true,
5711             "field": "mobile",
5712             "description": ""
5713           },
5714           {
5715             "group": "Body",
5716             "type": "String",
5717             "optional": true,
5718             "field": "fax",
5719             "description": ""
5720           },
5721           {
5722             "group": "Body",
5723             "type": "String",
5724             "optional": true,
5725             "field": "email",
5726             "description": ""
5727           },
5728           {
5729             "group": "Body",
5730             "type": "String",
5731             "optional": true,
5732             "field": "url",
5733             "description": ""
5734           },
5735           {
5736             "group": "Body",
5737             "type": "String",
5738             "optional": true,
5739             "field": "facebook",
5740             "description": ""
5741           },
5742           {
5743             "group": "Body",
5744             "type": "String",
5745             "optional": true,
5746             "field": "fb_data",
5747             "description": ""
5748           },
5749           {
5750             "group": "Body",
5751             "type": "String",
5752             "optional": true,
5753             "field": "twitter",
5754             "description": ""
5755           },
5756           {
5757             "group": "Body",
5758             "type": "String",
5759             "optional": true,
5760             "field": "skype",
5761             "description": ""
5762           },
5763           {
5764             "group": "Body",
5765             "type": "String",
5766             "optional": true,
5767             "field": "teams",
5768             "description": ""
5769           },
5770           {
5771             "group": "Body",
5772             "type": "String",
5773             "optional": true,
5774             "field": "viber",
5775             "description": ""
5776           },
5777           {
5778             "group": "Body",
5779             "type": "String",
5780             "optional": true,
5781             "field": "line",
5782             "description": ""
5783           },
5784           {
5785             "group": "Body",
5786             "type": "String",
5787             "optional": true,
5788             "field": "wechat",
5789             "description": ""
5790           },
5791           {
5792             "group": "Body",
5793             "type": "String",
5794             "optional": true,
5795             "field": "telegram",
5796             "description": ""
5797           },
5798           {
5799             "group": "Body",
5800             "type": "Integer",
5801             "optional": true,
5802             "field": "UserId",
5803             "description": ""
5804           },
5805           {
5806             "group": "Body",
5807             "type": "Integer",
5808             "optional": true,
5809             "field": "priority",
5810             "description": ""
5811           },
5812           {
5813             "group": "Body",
5814             "type": "String",
5815             "optional": true,
5816             "field": "scheduledat",
5817             "description": ""
5818           }
5819         ]
5820       }
5821     },
5822     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5823     "version": "0.0.0",
5824     "filename": "server/api/cmCompany/index.js",
5825     "groupTitle": "Cm_Companies"
5826   },
5827   {
5828     "type": "get",
5829     "url": "/api/cm/companies/{id}/contacts",
5830     "title": "Gets List Contacts",
5831     "examples": [
5832       {
5833         "title": "Example usage:",
5834         "content": "curl https://{domain}/api/fax/companies/{id}/contacts -v -u {name}:{password} -X GET",
5835         "type": "json"
5836       }
5837     ],
5838     "name": "getContacts",
5839     "group": "Cm_Companies",
5840     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5841     "version": "0.0.0",
5842     "filename": "server/api/cmCompany/index.js",
5843     "groupTitle": "Cm_Companies"
5844   },
5845   {
5846     "type": "put",
5847     "url": "/api/cm/companies/{id}",
5848     "title": "Update an existing Company",
5849     "examples": [
5850       {
5851         "title": "Example usage:",
5852         "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",
5853         "type": "json"
5854       }
5855     ],
5856     "name": "updateCompanies",
5857     "group": "Cm_Companies",
5858     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5859     "version": "0.0.0",
5860     "filename": "server/api/cmCompany/index.js",
5861     "groupTitle": "Cm_Companies"
5862   },
5863   {
5864     "type": "delete",
5865     "url": "/api/cm/contacts/{id}",
5866     "title": "Deletes a Contact",
5867     "examples": [
5868       {
5869         "title": "Example usage:",
5870         "content": "curl https://{domain}/api/cm/contacts/{id} -v -u {name}:{password} -X DELETE",
5871         "type": "json"
5872       }
5873     ],
5874     "name": "DeleteContacts",
5875     "group": "Cm_Contacts",
5876     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5877     "version": "0.0.0",
5878     "filename": "server/api/cmContact/index.js",
5879     "groupTitle": "Cm_Contacts"
5880   },
5881   {
5882     "type": "get",
5883     "url": "/api/cm/contacts/describe",
5884     "title": "Gets table info about Contacts",
5885     "examples": [
5886       {
5887         "title": "Example usage:",
5888         "content": "curl https://{domain}/api/cm/contacts/describe -v -u {name}:{password}",
5889         "type": "json"
5890       }
5891     ],
5892     "name": "DescribeContacts",
5893     "group": "Cm_Contacts",
5894     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5895     "version": "0.0.0",
5896     "filename": "server/api/cmContact/index.js",
5897     "groupTitle": "Cm_Contacts"
5898   },
5899   {
5900     "type": "get",
5901     "url": "/api/cm/contacts",
5902     "title": "Gets a list of Contacts",
5903     "examples": [
5904       {
5905         "title": "Example usage:",
5906         "content": "curl https://{domain}/api/cm/contacts -v -u {name}:{password}",
5907         "type": "json"
5908       }
5909     ],
5910     "name": "GetContacts",
5911     "group": "Cm_Contacts",
5912     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
5913     "version": "0.0.0",
5914     "filename": "server/api/cmContact/index.js",
5915     "groupTitle": "Cm_Contacts"
5916   },
5917   {
5918     "type": "get",
5919     "url": "/api/cm/contacts/{id}/finals",
5920     "title": "Gets contact hopper finals",
5921     "examples": [
5922       {
5923         "title": "Example usage:",
5924         "content": "curl https://{domain}/api/cm/contacts/{id}/hopper_finals -v -u {name}:{password}  -X GET",
5925         "type": "json"
5926       }
5927     ],
5928     "name": "GetHopperFinals",
5929     "group": "Cm_Contacts",
5930     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5931     "version": "0.0.0",
5932     "filename": "server/api/cmContact/index.js",
5933     "groupTitle": "Cm_Contacts"
5934   },
5935   {
5936     "type": "get",
5937     "url": "/api/cm/contacts/{id}/hopper_histories",
5938     "title": "Gets contact hopper histories",
5939     "examples": [
5940       {
5941         "title": "Example usage:",
5942         "content": "curl https://{domain}/api/cm/contacts/{id}/hopper_histories -v -u {name}:{password} -X GET",
5943         "type": "json"
5944       }
5945     ],
5946     "name": "GetHopperHistories",
5947     "group": "Cm_Contacts",
5948     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5949     "version": "0.0.0",
5950     "filename": "server/api/cmContact/index.js",
5951     "groupTitle": "Cm_Contacts"
5952   },
5953   {
5954     "type": "get",
5955     "url": "/api/cm/contacts/{id}/hoppers",
5956     "title": "Gets contact hoppers",
5957     "examples": [
5958       {
5959         "title": "Example usage:",
5960         "content": "curl https://{domain}/api/cm/contacts/{id}/hoppers -v -u {name}:{password} -X GET",
5961         "type": "json"
5962       }
5963     ],
5964     "name": "GetHoppers",
5965     "group": "Cm_Contacts",
5966     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5967     "version": "0.0.0",
5968     "filename": "server/api/cmContact/index.js",
5969     "groupTitle": "Cm_Contacts"
5970   },
5971   {
5972     "type": "post",
5973     "url": "/api/cm/contacts/create_many",
5974     "title": "Create Contacts",
5975     "examples": [
5976       {
5977         "title": "Example usage:",
5978         "content": "curl https://{domain}/api/cm/contacts/create_many -d '[{\"firstName\": \"John\", \"lastName\": \"doe\", \"...\": \"...\"}]' -v -u {name}:{password} -X POST",
5979         "type": "json"
5980       }
5981     ],
5982     "name": "bulkCreate",
5983     "group": "Cm_Contacts",
5984     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5985     "version": "0.0.0",
5986     "filename": "server/api/cmContact/index.js",
5987     "groupTitle": "Cm_Contacts"
5988   },
5989   {
5990     "type": "post",
5991     "url": "/api/cm/contacts",
5992     "title": "Create Contact",
5993     "examples": [
5994       {
5995         "title": "Example usage:",
5996         "content": "curl https://{domain}/api/cm/contacts -d '{\"firstName\": \"John\", \"lastName\": \"doe\", \"...\": \"...\"}' -v -u {name}:{password} -X POST",
5997         "type": "json"
5998       }
5999     ],
6000     "name": "create",
6001     "group": "Cm_Contacts",
6002     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6003     "version": "0.0.0",
6004     "filename": "server/api/cmContact/index.js",
6005     "groupTitle": "Cm_Contacts"
6006   },
6007   {
6008     "type": "get",
6009     "url": "/api/cm/contacts/{id}/jscripty_sessions",
6010     "title": "Gets contact hopper blacks",
6011     "examples": [
6012       {
6013         "title": "Example usage:",
6014         "content": "curl https://{domain}/api/cm/contacts/{id}/hopper_black -v -u {name}:{password}  -X GET",
6015         "type": "json"
6016       }
6017     ],
6018     "name": "getJscriptySessions",
6019     "group": "Cm_Contacts",
6020     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6021     "version": "0.0.0",
6022     "filename": "server/api/cmContact/index.js",
6023     "groupTitle": "Cm_Contacts"
6024   },
6025   {
6026     "type": "get",
6027     "url": "/api/cm/contacts/{id}/tags",
6028     "title": "Gets configurations tags",
6029     "examples": [
6030       {
6031         "title": "Example usage:",
6032         "content": "curl https://{domain}/api/cm/contacts/{id}/tags -v -u {name}:{password} -X GET",
6033         "type": "json"
6034       }
6035     ],
6036     "name": "getTags",
6037     "group": "Cm_Contacts",
6038     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6039     "version": "0.0.0",
6040     "filename": "server/api/cmContact/index.js",
6041     "groupTitle": "Cm_Contacts"
6042   },
6043   {
6044     "type": "post",
6045     "url": "/api/cm/contacts/merge",
6046     "title": "Merge Contact",
6047     "examples": [
6048       {
6049         "title": "Example usage:",
6050         "content": "curl https://{domain}/api/cm/contacts/merge -d '{\"from\": 1, \"to\": 2}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
6051         "type": "json"
6052       }
6053     ],
6054     "name": "merge",
6055     "group": "Cm_Contacts",
6056     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6057     "version": "0.0.0",
6058     "filename": "server/api/cmContact/index.js",
6059     "groupTitle": "Cm_Contacts"
6060   },
6061   {
6062     "type": "post",
6063     "url": "/api/cm/contacts/{id}/tags",
6064     "title": "Sets new tags",
6065     "examples": [
6066       {
6067         "title": "Example usage:",
6068         "content": "curl https://{domain}/api/cm/contacts/{id}/tags -d '{\"ids\": [1,12]}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
6069         "type": "json"
6070       }
6071     ],
6072     "name": "setTags",
6073     "group": "Cm_Contacts",
6074     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6075     "version": "0.0.0",
6076     "filename": "server/api/cmContact/index.js",
6077     "groupTitle": "Cm_Contacts"
6078   },
6079   {
6080     "type": "get",
6081     "url": "/api/cm/contacts/{id}",
6082     "title": "Gets a single Contact",
6083     "examples": [
6084       {
6085         "title": "Example usage:",
6086         "content": "curl https://{domain}/api/cm/contacts/{id} -v -u {name}:{password} -X GET",
6087         "type": "json"
6088       }
6089     ],
6090     "name": "show",
6091     "group": "Cm_Contacts",
6092     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6093     "version": "0.0.0",
6094     "filename": "server/api/cmContact/index.js",
6095     "groupTitle": "Cm_Contacts"
6096   },
6097   {
6098     "type": "put",
6099     "url": "/api/cm/contacts/{id}",
6100     "title": "Update a single Contact",
6101     "examples": [
6102       {
6103         "title": "Example usage:",
6104         "content": "curl https://{domain}/api/cm/contacts/{id} -d '{\"firstName\": \"John\", \"lastName\": \"Doe\"}' -v -u {name}:{password} -X PUT",
6105         "type": "json"
6106       }
6107     ],
6108     "name": "update",
6109     "group": "Cm_Contacts",
6110     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6111     "version": "0.0.0",
6112     "filename": "server/api/cmContact/index.js",
6113     "groupTitle": "Cm_Contacts"
6114   },
6115   {
6116     "type": "delete",
6117     "url": "/api/cm/custom_fields/{id}",
6118     "title": "Deletes a Custom Field",
6119     "examples": [
6120       {
6121         "title": "Example usage:",
6122         "content": "curl https://{domain}/api/cm/custom_fields/{id} -v -u {name}:{password} -X DELETE",
6123         "type": "json"
6124       }
6125     ],
6126     "name": "DeleteCustom_Fields",
6127     "group": "Cm_Custom_Fields",
6128     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6129     "version": "0.0.0",
6130     "filename": "server/api/cmCustomField/index.js",
6131     "groupTitle": "Cm_Custom_Fields"
6132   },
6133   {
6134     "type": "get",
6135     "url": "/api/cm/custom_fields",
6136     "title": "Gets a list of Custom Fields",
6137     "examples": [
6138       {
6139         "title": "Example usage:",
6140         "content": "curl https://{domain}/api/cm/custom_fields -v -u {name}:{password}",
6141         "type": "json"
6142       }
6143     ],
6144     "name": "GetCustom_Fields",
6145     "group": "Cm_Custom_Fields",
6146     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
6147     "version": "0.0.0",
6148     "filename": "server/api/cmCustomField/index.js",
6149     "groupTitle": "Cm_Custom_Fields"
6150   },
6151   {
6152     "type": "get",
6153     "url": "/api/cm/custom_fields/{id}",
6154     "title": "Gets a single Custom Field",
6155     "examples": [
6156       {
6157         "title": "Example usage:",
6158         "content": "curl https://{domain}/api/cm/custom_fields/{id} -v -u {name}:{password}",
6159         "type": "json"
6160       }
6161     ],
6162     "name": "ShowCustom_Fields",
6163     "group": "Cm_Custom_Fields",
6164     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6165     "version": "0.0.0",
6166     "filename": "server/api/cmCustomField/index.js",
6167     "groupTitle": "Cm_Custom_Fields"
6168   },
6169   {
6170     "type": "put",
6171     "url": "/api/cm/custom_fields/{id}",
6172     "title": "Update an existing Custom Field",
6173     "examples": [
6174       {
6175         "title": "Example usage:",
6176         "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",
6177         "type": "json"
6178       }
6179     ],
6180     "name": "updateCustom_Fields",
6181     "group": "Cm_Custom_Fields",
6182     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6183     "version": "0.0.0",
6184     "filename": "server/api/cmCustomField/index.js",
6185     "groupTitle": "Cm_Custom_Fields"
6186   },
6187   {
6188     "type": "post",
6189     "url": "/api/cm/hopper",
6190     "title": "Creates a new Hopper",
6191     "examples": [
6192       {
6193         "title": "Example usage:",
6194         "content": "curl https://{domain}/api/cm/hopper -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
6195         "type": "json"
6196       }
6197     ],
6198     "name": "CreateHopper",
6199     "group": "Cm_Hopper",
6200     "parameter": {
6201       "fields": {
6202         "Body": [
6203           {
6204             "group": "Body",
6205             "type": "String",
6206             "optional": false,
6207             "field": "phone",
6208             "description": ""
6209           },
6210           {
6211             "group": "Body",
6212             "type": "Boolean",
6213             "optional": true,
6214             "field": "active",
6215             "description": ""
6216           },
6217           {
6218             "group": "Body",
6219             "type": "String",
6220             "optional": true,
6221             "field": "scheduledat",
6222             "description": ""
6223           },
6224           {
6225             "group": "Body",
6226             "type": "Integer",
6227             "optional": true,
6228             "field": "countbusyretry",
6229             "description": ""
6230           },
6231           {
6232             "group": "Body",
6233             "type": "Integer",
6234             "optional": true,
6235             "field": "countcongestionretry",
6236             "description": ""
6237           },
6238           {
6239             "group": "Body",
6240             "type": "Integer",
6241             "optional": true,
6242             "field": "countnoanswerretry",
6243             "description": ""
6244           },
6245           {
6246             "group": "Body",
6247             "type": "Boolean",
6248             "optional": true,
6249             "field": "callback",
6250             "description": ""
6251           },
6252           {
6253             "group": "Body",
6254             "type": "String",
6255             "optional": true,
6256             "field": "callbackuniqueid",
6257             "description": ""
6258           },
6259           {
6260             "group": "Body",
6261             "type": "String",
6262             "optional": true,
6263             "field": "callbackat",
6264             "description": ""
6265           },
6266           {
6267             "group": "Body",
6268             "type": "Integer",
6269             "optional": true,
6270             "field": "priority",
6271             "description": ""
6272           },
6273           {
6274             "group": "Body",
6275             "type": "Boolean",
6276             "optional": true,
6277             "field": "recallme",
6278             "description": ""
6279           },
6280           {
6281             "group": "Body",
6282             "type": "Integer",
6283             "optional": true,
6284             "field": "ContactId",
6285             "description": ""
6286           },
6287           {
6288             "group": "Body",
6289             "type": "Integer",
6290             "optional": true,
6291             "field": "ListId",
6292             "description": ""
6293           },
6294           {
6295             "group": "Body",
6296             "type": "Integer",
6297             "optional": true,
6298             "field": "UserId",
6299             "description": ""
6300           },
6301           {
6302             "group": "Body",
6303             "type": "Integer",
6304             "optional": true,
6305             "field": "VoiceQueueId",
6306             "description": ""
6307           },
6308           {
6309             "group": "Body",
6310             "type": "Integer",
6311             "optional": true,
6312             "field": "CampaignId",
6313             "description": ""
6314           },
6315           {
6316             "group": "Body",
6317             "type": "Integer",
6318             "optional": true,
6319             "field": "countnosuchnumberretry",
6320             "description": ""
6321           },
6322           {
6323             "group": "Body",
6324             "type": "Integer",
6325             "optional": true,
6326             "field": "countdropretry",
6327             "description": ""
6328           },
6329           {
6330             "group": "Body",
6331             "type": "Integer",
6332             "optional": true,
6333             "field": "countabandonedretry",
6334             "description": ""
6335           },
6336           {
6337             "group": "Body",
6338             "type": "Integer",
6339             "optional": true,
6340             "field": "countmachineretry",
6341             "description": ""
6342           },
6343           {
6344             "group": "Body",
6345             "type": "Integer",
6346             "optional": true,
6347             "field": "countagentrejectretry",
6348             "description": ""
6349           }
6350         ]
6351       }
6352     },
6353     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6354     "version": "0.0.0",
6355     "filename": "server/api/cmHopper/index.js",
6356     "groupTitle": "Cm_Hopper"
6357   },
6358   {
6359     "type": "get",
6360     "url": "/api/cm/hopper/describe",
6361     "title": "Gets table info about Hopper",
6362     "examples": [
6363       {
6364         "title": "Example usage:",
6365         "content": "curl https://{domain}/api/cm/hopper/describe -v -u {name}:{password}",
6366         "type": "json"
6367       }
6368     ],
6369     "name": "DescribeHopper",
6370     "group": "Cm_Hopper",
6371     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6372     "version": "0.0.0",
6373     "filename": "server/api/cmHopper/index.js",
6374     "groupTitle": "Cm_Hopper"
6375   },
6376   {
6377     "type": "get",
6378     "url": "/api/cm/hopper",
6379     "title": "Gets a list of Hopper",
6380     "examples": [
6381       {
6382         "title": "Example usage:",
6383         "content": "curl https://{domain}/api/cm/hopper -v -u {name}:{password}",
6384         "type": "json"
6385       }
6386     ],
6387     "name": "GetHopper",
6388     "group": "Cm_Hopper",
6389     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
6390     "version": "0.0.0",
6391     "filename": "server/api/cmHopper/index.js",
6392     "groupTitle": "Cm_Hopper"
6393   },
6394   {
6395     "type": "get",
6396     "url": "/api/cm/hopper/{id}",
6397     "title": "Gets a single Hopper",
6398     "examples": [
6399       {
6400         "title": "Example usage:",
6401         "content": "curl https://{domain}/api/cm/hopper/{id} -v -u {name}:{password}",
6402         "type": "json"
6403       }
6404     ],
6405     "name": "ShowHopper",
6406     "group": "Cm_Hopper",
6407     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6408     "version": "0.0.0",
6409     "filename": "server/api/cmHopper/index.js",
6410     "groupTitle": "Cm_Hopper"
6411   },
6412   {
6413     "type": "delete",
6414     "url": "/api/cm/hopper_black/{id}",
6415     "title": "Deletes a Hopper Black",
6416     "examples": [
6417       {
6418         "title": "Example usage:",
6419         "content": "curl https://{domain}/api/cm/hopper_black/{id} -v -u {name}:{password} -X DELETE",
6420         "type": "json"
6421       }
6422     ],
6423     "name": "DeleteHopper_Black",
6424     "group": "Cm_Hopper_Black",
6425     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6426     "version": "0.0.0",
6427     "filename": "server/api/cmHopperBlack/index.js",
6428     "groupTitle": "Cm_Hopper_Black"
6429   },
6430   {
6431     "type": "get",
6432     "url": "/api/cm/hopper_black/describe",
6433     "title": "Gets table info about Hopper Black",
6434     "examples": [
6435       {
6436         "title": "Example usage:",
6437         "content": "curl https://{domain}/api/cm/hopper_black/describe -v -u {name}:{password}",
6438         "type": "json"
6439       }
6440     ],
6441     "name": "DescribeHopper_Black",
6442     "group": "Cm_Hopper_Black",
6443     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6444     "version": "0.0.0",
6445     "filename": "server/api/cmHopperBlack/index.js",
6446     "groupTitle": "Cm_Hopper_Black"
6447   },
6448   {
6449     "type": "get",
6450     "url": "/api/cm/hopper_black",
6451     "title": "Gets a list of Hopper Black",
6452     "examples": [
6453       {
6454         "title": "Example usage:",
6455         "content": "curl https://{domain}/api/cm/hopper_black -v -u {name}:{password}",
6456         "type": "json"
6457       }
6458     ],
6459     "name": "GetHopper_Black",
6460     "group": "Cm_Hopper_Black",
6461     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
6462     "version": "0.0.0",
6463     "filename": "server/api/cmHopperBlack/index.js",
6464     "groupTitle": "Cm_Hopper_Black"
6465   },
6466   {
6467     "type": "get",
6468     "url": "/api/cm/hopper_black/{id}",
6469     "title": "Gets a single Hopper Black",
6470     "examples": [
6471       {
6472         "title": "Example usage:",
6473         "content": "curl https://{domain}/api/cm/hopper_black/{id} -v -u {name}:{password}",
6474         "type": "json"
6475       }
6476     ],
6477     "name": "ShowHopper_Black",
6478     "group": "Cm_Hopper_Black",
6479     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6480     "version": "0.0.0",
6481     "filename": "server/api/cmHopperBlack/index.js",
6482     "groupTitle": "Cm_Hopper_Black"
6483   },
6484   {
6485     "type": "put",
6486     "url": "/api/cm/hopper_black/{id}",
6487     "title": "Update an existing Hopper Black",
6488     "examples": [
6489       {
6490         "title": "Example usage:",
6491         "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",
6492         "type": "json"
6493       }
6494     ],
6495     "name": "updateHopper_Black",
6496     "group": "Cm_Hopper_Black",
6497     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6498     "version": "0.0.0",
6499     "filename": "server/api/cmHopperBlack/index.js",
6500     "groupTitle": "Cm_Hopper_Black"
6501   },
6502   {
6503     "type": "post",
6504     "url": "/api/cm/hopper_final/checkContactHopper",
6505     "title": "Check if contact is in hopper",
6506     "examples": [
6507       {
6508         "title": "Example usage:",
6509         "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",
6510         "type": "json"
6511       }
6512     ],
6513     "name": "/checkContactHopper",
6514     "group": "Cm_Hopper_Final",
6515     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6516     "version": "0.0.0",
6517     "filename": "server/api/cmHopperFinal/index.js",
6518     "groupTitle": "Cm_Hopper_Final"
6519   },
6520   {
6521     "type": "get",
6522     "url": "/api/cm/hopper_final/describe",
6523     "title": "Gets table info about HopperFinal",
6524     "examples": [
6525       {
6526         "title": "Example usage:",
6527         "content": "curl https://{domain}/api/cm/hopper_final/describe -v -u {name}:{password}",
6528         "type": "json"
6529       }
6530     ],
6531     "name": "DescribeHopperFinal",
6532     "group": "Cm_Hopper_Final",
6533     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6534     "version": "0.0.0",
6535     "filename": "server/api/cmHopperFinal/index.js",
6536     "groupTitle": "Cm_Hopper_Final"
6537   },
6538   {
6539     "type": "get",
6540     "url": "/api/cm/hopper_final",
6541     "title": "Gets a list of HopperFinal",
6542     "examples": [
6543       {
6544         "title": "Example usage:",
6545         "content": "curl https://{domain}/api/cm/hopper_final -v -u {name}:{password}",
6546         "type": "json"
6547       }
6548     ],
6549     "name": "GetHopperFinal",
6550     "group": "Cm_Hopper_Final",
6551     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
6552     "version": "0.0.0",
6553     "filename": "server/api/cmHopperFinal/index.js",
6554     "groupTitle": "Cm_Hopper_Final"
6555   },
6556   {
6557     "type": "get",
6558     "url": "/api/cm/hopper_final/{id}",
6559     "title": "Gets a single HopperFinal",
6560     "examples": [
6561       {
6562         "title": "Example usage:",
6563         "content": "curl https://{domain}/api/cm/hopper_final/{id} -v -u {name}:{password}",
6564         "type": "json"
6565       }
6566     ],
6567     "name": "ShowHopperFinal",
6568     "group": "Cm_Hopper_Final",
6569     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6570     "version": "0.0.0",
6571     "filename": "server/api/cmHopperFinal/index.js",
6572     "groupTitle": "Cm_Hopper_Final"
6573   },
6574   {
6575     "type": "get",
6576     "url": "/api/cm/hopper_final/campaign/countAttributes/{id}",
6577     "title": "Return number contacts for attributes",
6578     "examples": [
6579       {
6580         "title": "Example usage:",
6581         "content": "curl https://{domain}/api/hopper_final/campaign/countAttributes/{id} -d '{\"disposition\": \"OK\"}' -v -u {name}:{password} -X GET",
6582         "type": "json"
6583       }
6584     ],
6585     "name": "countContactsIvrCampaignHopperFinal",
6586     "group": "Cm_Hopper_Final",
6587     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6588     "version": "0.0.0",
6589     "filename": "server/api/cmHopperFinal/index.js",
6590     "groupTitle": "Cm_Hopper_Final"
6591   },
6592   {
6593     "type": "get",
6594     "url": "/api/cm/hopper_final/voice/queue/countAttributes/{id}",
6595     "title": "Return number contacts for attributes",
6596     "examples": [
6597       {
6598         "title": "Example usage:",
6599         "content": "curl https://{domain}/api/hopper_final/voice/queue/countAttributes/{id} -d '{\"disposition\": \"OK\"}' -v -u {name}:{password} -X GET",
6600         "type": "json"
6601       }
6602     ],
6603     "name": "countContactsQueueCampaignHopperFinal",
6604     "group": "Cm_Hopper_Final",
6605     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6606     "version": "0.0.0",
6607     "filename": "server/api/cmHopperFinal/index.js",
6608     "groupTitle": "Cm_Hopper_Final"
6609   },
6610   {
6611     "type": "post",
6612     "url": "/api/cm/hopper_final/campaign/{id}",
6613     "title": "Move contacts in hopper",
6614     "examples": [
6615       {
6616         "title": "Example usage:",
6617         "content": "curl https://{domain}/api/hopper_final/campaign/moveContacts/{id} -d '{\"state\": \"state\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
6618         "type": "json"
6619       }
6620     ],
6621     "name": "moveContactsIvrCampaignHopperFinal",
6622     "group": "Cm_Hopper_Final",
6623     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6624     "version": "0.0.0",
6625     "filename": "server/api/cmHopperFinal/index.js",
6626     "groupTitle": "Cm_Hopper_Final"
6627   },
6628   {
6629     "type": "post",
6630     "url": "/api/cm/hopper_final/voice/queue/{id}",
6631     "title": "Move contacts in hopper",
6632     "examples": [
6633       {
6634         "title": "Example usage:",
6635         "content": "curl https://{domain}/api/hopper_final/voice/queue/moveContacts/{id} -d '{\"state\": \"state\"}' -H 'Content-Type: application/json' -v -u {name}:{password}",
6636         "type": "json"
6637       }
6638     ],
6639     "name": "moveContactsQueueCampaignHopperFinal",
6640     "group": "Cm_Hopper_Final",
6641     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6642     "version": "0.0.0",
6643     "filename": "server/api/cmHopperFinal/index.js",
6644     "groupTitle": "Cm_Hopper_Final"
6645   },
6646   {
6647     "type": "put",
6648     "url": "/api/cm/hopper_final/{id}",
6649     "title": "Update a single hopper final",
6650     "examples": [
6651       {
6652         "title": "Example usage:",
6653         "content": "curl https://{domain}/api/hopper_final/{id} -d '{\"disposition\": \"OK\"}' -v -u {name}:{password} -X PUT",
6654         "type": "json"
6655       }
6656     ],
6657     "name": "update",
6658     "group": "Cm_Hopper_Final",
6659     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6660     "version": "0.0.0",
6661     "filename": "server/api/cmHopperFinal/index.js",
6662     "groupTitle": "Cm_Hopper_Final"
6663   },
6664   {
6665     "type": "post",
6666     "url": "/api/cm/hopper_history",
6667     "title": "Creates a new HopperHistory",
6668     "examples": [
6669       {
6670         "title": "Example usage:",
6671         "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",
6672         "type": "json"
6673       }
6674     ],
6675     "name": "CreateHopperHistory",
6676     "group": "Cm_Hopper_History",
6677     "parameter": {
6678       "fields": {
6679         "Body": [
6680           {
6681             "group": "Body",
6682             "type": "Integer",
6683             "optional": true,
6684             "field": "state",
6685             "description": ""
6686           },
6687           {
6688             "group": "Body",
6689             "type": "String",
6690             "optional": true,
6691             "field": "statedesc",
6692             "description": ""
6693           },
6694           {
6695             "group": "Body",
6696             "type": "String",
6697             "optional": true,
6698             "field": "scheduledat",
6699             "description": ""
6700           },
6701           {
6702             "group": "Body",
6703             "type": "Integer",
6704             "optional": true,
6705             "field": "countbusyretry",
6706             "description": ""
6707           },
6708           {
6709             "group": "Body",
6710             "type": "Integer",
6711             "optional": true,
6712             "field": "countcongestionretry",
6713             "description": ""
6714           },
6715           {
6716             "group": "Body",
6717             "type": "Integer",
6718             "optional": true,
6719             "field": "countnoanswerretry",
6720             "description": ""
6721           },
6722           {
6723             "group": "Body",
6724             "type": "Integer",
6725             "optional": true,
6726             "field": "countglobal",
6727             "description": ""
6728           },
6729           {
6730             "group": "Body",
6731             "type": "String",
6732             "optional": true,
6733             "field": "uniqueid",
6734             "description": ""
6735           },
6736           {
6737             "group": "Body",
6738             "type": "String",
6739             "optional": true,
6740             "field": "originatecalleridnum",
6741             "description": ""
6742           },
6743           {
6744             "group": "Body",
6745             "type": "String",
6746             "optional": true,
6747             "field": "originatecalleridname",
6748             "description": ""
6749           },
6750           {
6751             "group": "Body",
6752             "type": "String",
6753             "optional": true,
6754             "field": "calleridnum",
6755             "description": ""
6756           },
6757           {
6758             "group": "Body",
6759             "type": "String",
6760             "optional": true,
6761             "field": "calleridname",
6762             "description": ""
6763           },
6764           {
6765             "group": "Body",
6766             "type": "String",
6767             "optional": true,
6768             "field": "starttime",
6769             "description": ""
6770           },
6771           {
6772             "group": "Body",
6773             "type": "String",
6774             "optional": true,
6775             "field": "responsetime",
6776             "description": ""
6777           },
6778           {
6779             "group": "Body",
6780             "type": "String",
6781             "optional": true,
6782             "field": "answertime",
6783             "description": ""
6784           },
6785           {
6786             "group": "Body",
6787             "type": "String",
6788             "optional": true,
6789             "field": "droptime",
6790             "description": ""
6791           },
6792           {
6793             "group": "Body",
6794             "type": "String",
6795             "optional": true,
6796             "field": "endtime",
6797             "description": ""
6798           },
6799           {
6800             "group": "Body",
6801             "type": "Integer",
6802             "optional": true,
6803             "field": "ringtime",
6804             "description": ""
6805           },
6806           {
6807             "group": "Body",
6808             "type": "Integer",
6809             "optional": true,
6810             "field": "holdtime",
6811             "description": ""
6812           },
6813           {
6814             "group": "Body",
6815             "type": "Integer",
6816             "optional": true,
6817             "field": "talktime",
6818             "description": ""
6819           },
6820           {
6821             "group": "Body",
6822             "type": "Integer",
6823             "optional": true,
6824             "field": "followuptime",
6825             "description": ""
6826           },
6827           {
6828             "group": "Body",
6829             "type": "String",
6830             "optional": true,
6831             "field": "dropreason",
6832             "description": ""
6833           },
6834           {
6835             "group": "Body",
6836             "type": "String",
6837             "optional": true,
6838             "field": "campaign",
6839             "description": ""
6840           },
6841           {
6842             "group": "Body",
6843             "type": "String",
6844             "optional": true,
6845             "field": "campaigntype",
6846             "description": ""
6847           },
6848           {
6849             "group": "Body",
6850             "type": "String",
6851             "optional": true,
6852             "field": "membername",
6853             "description": ""
6854           },
6855           {
6856             "group": "Body",
6857             "type": "String",
6858             "optional": true,
6859             "field": "reason",
6860             "description": ""
6861           },
6862           {
6863             "group": "Body",
6864             "type": "Boolean",
6865             "optional": true,
6866             "field": "amd",
6867             "description": ""
6868           },
6869           {
6870             "group": "Body",
6871             "type": "Boolean",
6872             "optional": true,
6873             "field": "fax",
6874             "description": ""
6875           },
6876           {
6877             "group": "Body",
6878             "type": "Boolean",
6879             "optional": true,
6880             "field": "callback",
6881             "description": ""
6882           },
6883           {
6884             "group": "Body",
6885             "type": "String",
6886             "optional": true,
6887             "field": "callbackuniqueid",
6888             "description": ""
6889           },
6890           {
6891             "group": "Body",
6892             "type": "String",
6893             "optional": true,
6894             "field": "callbackat",
6895             "description": ""
6896           },
6897           {
6898             "group": "Body",
6899             "type": "Boolean",
6900             "optional": true,
6901             "field": "recallme",
6902             "description": ""
6903           },
6904           {
6905             "group": "Body",
6906             "type": "String",
6907             "optional": true,
6908             "field": "editedat",
6909             "description": ""
6910           },
6911           {
6912             "group": "Body",
6913             "type": "Boolean",
6914             "optional": true,
6915             "field": "edited",
6916             "description": ""
6917           },
6918           {
6919             "group": "Body",
6920             "type": "Integer",
6921             "optional": true,
6922             "field": "countnosuchnumberretry",
6923             "description": ""
6924           },
6925           {
6926             "group": "Body",
6927             "type": "Integer",
6928             "optional": true,
6929             "field": "countdropretry",
6930             "description": ""
6931           },
6932           {
6933             "group": "Body",
6934             "type": "Integer",
6935             "optional": true,
6936             "field": "countabandonedretry",
6937             "description": ""
6938           },
6939           {
6940             "group": "Body",
6941             "type": "Integer",
6942             "optional": true,
6943             "field": "countmachineretry",
6944             "description": ""
6945           },
6946           {
6947             "group": "Body",
6948             "type": "Integer",
6949             "optional": true,
6950             "field": "countagentrejectretry",
6951             "description": ""
6952           }
6953         ]
6954       }
6955     },
6956     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6957     "version": "0.0.0",
6958     "filename": "server/api/cmHopperHistory/index.js",
6959     "groupTitle": "Cm_Hopper_History"
6960   },
6961   {
6962     "type": "get",
6963     "url": "/api/cm/hopper_history/describe",
6964     "title": "Gets table info about HopperHistory",
6965     "examples": [
6966       {
6967         "title": "Example usage:",
6968         "content": "curl https://{domain}/api/cm/hopper_history/describe -v -u {name}:{password}",
6969         "type": "json"
6970       }
6971     ],
6972     "name": "DescribeHopperHistory",
6973     "group": "Cm_Hopper_History",
6974     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6975     "version": "0.0.0",
6976     "filename": "server/api/cmHopperHistory/index.js",
6977     "groupTitle": "Cm_Hopper_History"
6978   },
6979   {
6980     "type": "get",
6981     "url": "/api/cm/hopper_history",
6982     "title": "Gets a list of HopperHistory",
6983     "examples": [
6984       {
6985         "title": "Example usage:",
6986         "content": "curl https://{domain}/api/cm/hopper_history -v -u {name}:{password}",
6987         "type": "json"
6988       }
6989     ],
6990     "name": "GetHopperHistory",
6991     "group": "Cm_Hopper_History",
6992     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
6993     "version": "0.0.0",
6994     "filename": "server/api/cmHopperHistory/index.js",
6995     "groupTitle": "Cm_Hopper_History"
6996   },
6997   {
6998     "type": "get",
6999     "url": "/api/cm/hopper_history/{id}",
7000     "title": "Gets a single HopperHistory",
7001     "examples": [
7002       {
7003         "title": "Example usage:",
7004         "content": "curl https://{domain}/api/cm/hopper_history/{id} -v -u {name}:{password}",
7005         "type": "json"
7006       }
7007     ],
7008     "name": "ShowHopperHistory",
7009     "group": "Cm_Hopper_History",
7010     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7011     "version": "0.0.0",
7012     "filename": "server/api/cmHopperHistory/index.js",
7013     "groupTitle": "Cm_Hopper_History"
7014   },
7015   {
7016     "type": "put",
7017     "url": "/api/cm/hopper_history/{id}",
7018     "title": "Update a single hopper history",
7019     "examples": [
7020       {
7021         "title": "Example usage:",
7022         "content": "curl https://{domain}/api/hopper_history/{id} -d '{\"disposition\": \"OK\"}' -v -u {name}:{password} -X PUT",
7023         "type": "json"
7024       }
7025     ],
7026     "name": "update",
7027     "group": "Cm_Hopper_History",
7028     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7029     "version": "0.0.0",
7030     "filename": "server/api/cmHopperHistory/index.js",
7031     "groupTitle": "Cm_Hopper_History"
7032   },
7033   {
7034     "type": "delete",
7035     "url": "/api/cm/hopper/{id}",
7036     "title": "Delete Hopper",
7037     "examples": [
7038       {
7039         "title": "Example usage:",
7040         "content": "curl https://{domain}/api/cm/hopper/{id} -v -u {name}:{password} -X DELETE",
7041         "type": "json"
7042       }
7043     ],
7044     "name": "destroy",
7045     "group": "Cm_Hopper",
7046     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7047     "version": "0.0.0",
7048     "filename": "server/api/cmHopper/index.js",
7049     "groupTitle": "Cm_Hopper"
7050   },
7051   {
7052     "type": "get",
7053     "url": "/api/cm/hopper/opencontacts",
7054     "title": "Gets Open Contacts",
7055     "examples": [
7056       {
7057         "title": "Example usage:",
7058         "content": "curl https://{domain}/api/cm/hopper/opencontacts -v -u {name}:{password} -X GET",
7059         "type": "json"
7060       }
7061     ],
7062     "name": "getOpenContacts",
7063     "group": "Cm_Hopper",
7064     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7065     "version": "0.0.0",
7066     "filename": "server/api/cmHopper/index.js",
7067     "groupTitle": "Cm_Hopper"
7068   },
7069   {
7070     "type": "post",
7071     "url": "/api/cm/hopper/preview",
7072     "title": "Gets Preview Dialer Contacts",
7073     "examples": [
7074       {
7075         "title": "Example usage:",
7076         "content": "curl https://{domain}/api/cm/hopper/preview -d '{\"hopperIds\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X GET",
7077         "type": "json"
7078       }
7079     ],
7080     "name": "getPreview",
7081     "group": "Cm_Hopper",
7082     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7083     "version": "0.0.0",
7084     "filename": "server/api/cmHopper/index.js",
7085     "groupTitle": "Cm_Hopper"
7086   },
7087   {
7088     "type": "put",
7089     "url": "/api/cm/hopper/{id}",
7090     "title": "Update an existing Hopper",
7091     "examples": [
7092       {
7093         "title": "Example usage:",
7094         "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",
7095         "type": "json"
7096       }
7097     ],
7098     "name": "updateHopper",
7099     "group": "Cm_Hopper",
7100     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7101     "version": "0.0.0",
7102     "filename": "server/api/cmHopper/index.js",
7103     "groupTitle": "Cm_Hopper"
7104   },
7105   {
7106     "type": "post",
7107     "url": "/api/cm/lists",
7108     "title": "Creates a new List",
7109     "examples": [
7110       {
7111         "title": "Example usage:",
7112         "content": "curl https://{domain}/api/cm/lists -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
7113         "type": "json"
7114       }
7115     ],
7116     "name": "CreateLists",
7117     "group": "Cm_Lists",
7118     "parameter": {
7119       "fields": {
7120         "Body": [
7121           {
7122             "group": "Body",
7123             "type": "String",
7124             "optional": false,
7125             "field": "name",
7126             "description": ""
7127           },
7128           {
7129             "group": "Body",
7130             "type": "String",
7131             "optional": true,
7132             "field": "description",
7133             "description": ""
7134           },
7135           {
7136             "group": "Body",
7137             "type": "String",
7138             "optional": true,
7139             "field": "dialPrefix",
7140             "description": ""
7141           }
7142         ]
7143       }
7144     },
7145     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7146     "version": "0.0.0",
7147     "filename": "server/api/cmList/index.js",
7148     "groupTitle": "Cm_Lists"
7149   },
7150   {
7151     "type": "delete",
7152     "url": "/api/cm/lists/{id}",
7153     "title": "Deletes a List",
7154     "examples": [
7155       {
7156         "title": "Example usage:",
7157         "content": "curl https://{domain}/api/cm/lists/{id} -v -u {name}:{password} -X DELETE",
7158         "type": "json"
7159       }
7160     ],
7161     "name": "DeleteLists",
7162     "group": "Cm_Lists",
7163     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7164     "version": "0.0.0",
7165     "filename": "server/api/cmList/index.js",
7166     "groupTitle": "Cm_Lists"
7167   },
7168   {
7169     "type": "get",
7170     "url": "/api/cm/lists/describe",
7171     "title": "Gets table info about Lists",
7172     "examples": [
7173       {
7174         "title": "Example usage:",
7175         "content": "curl https://{domain}/api/cm/lists/describe -v -u {name}:{password}",
7176         "type": "json"
7177       }
7178     ],
7179     "name": "DescribeLists",
7180     "group": "Cm_Lists",
7181     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7182     "version": "0.0.0",
7183     "filename": "server/api/cmList/index.js",
7184     "groupTitle": "Cm_Lists"
7185   },
7186   {
7187     "type": "get",
7188     "url": "/api/cm/lists/{id}/users",
7189     "title": "Gets agents from list",
7190     "examples": [
7191       {
7192         "title": "Example usage:",
7193         "content": "curl https://{domain}/api/cm/lists/{id}/users -v -u {name}:{password} -X GET",
7194         "type": "json"
7195       }
7196     ],
7197     "name": "GetAgents",
7198     "group": "Cm_Lists",
7199     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7200     "version": "0.0.0",
7201     "filename": "server/api/cmList/index.js",
7202     "groupTitle": "Cm_Lists"
7203   },
7204   {
7205     "type": "get",
7206     "url": "/api/cm/lists",
7207     "title": "Gets a list of Lists",
7208     "examples": [
7209       {
7210         "title": "Example usage:",
7211         "content": "curl https://{domain}/api/cm/lists -v -u {name}:{password}",
7212         "type": "json"
7213       }
7214     ],
7215     "name": "GetLists",
7216     "group": "Cm_Lists",
7217     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
7218     "version": "0.0.0",
7219     "filename": "server/api/cmList/index.js",
7220     "groupTitle": "Cm_Lists"
7221   },
7222   {
7223     "type": "delete",
7224     "url": "/api/cm/lists/{id}/users",
7225     "title": "Removes agents from a list",
7226     "examples": [
7227       {
7228         "title": "Example usage:",
7229         "content": "curl https://{domain}/api/cm/lists/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
7230         "type": "json"
7231       }
7232     ],
7233     "name": "RemoveAgents",
7234     "group": "Cm_Lists",
7235     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7236     "version": "0.0.0",
7237     "filename": "server/api/cmList/index.js",
7238     "groupTitle": "Cm_Lists"
7239   },
7240   {
7241     "type": "delete",
7242     "url": "/api/cm/lists/{id}/dispositions",
7243     "title": "Removes dispositions from account",
7244     "examples": [
7245       {
7246         "title": "Example usage:",
7247         "content": "curl https://{domain}/api/cm/lists/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
7248         "type": "json"
7249       }
7250     ],
7251     "name": "RemoveDispositions",
7252     "group": "Cm_Lists",
7253     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7254     "version": "0.0.0",
7255     "filename": "server/api/cmList/index.js",
7256     "groupTitle": "Cm_Lists"
7257   },
7258   {
7259     "type": "get",
7260     "url": "/api/cm/lists/{id}",
7261     "title": "Gets a single List",
7262     "examples": [
7263       {
7264         "title": "Example usage:",
7265         "content": "curl https://{domain}/api/cm/lists/{id} -v -u {name}:{password}",
7266         "type": "json"
7267       }
7268     ],
7269     "name": "ShowLists",
7270     "group": "Cm_Lists",
7271     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7272     "version": "0.0.0",
7273     "filename": "server/api/cmList/index.js",
7274     "groupTitle": "Cm_Lists"
7275   },
7276   {
7277     "type": "post",
7278     "url": "/api/cm/lists/{id}/users",
7279     "title": "Adds agents to a list",
7280     "examples": [
7281       {
7282         "title": "Example usage:",
7283         "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",
7284         "type": "json"
7285       }
7286     ],
7287     "name": "addAgents",
7288     "group": "Cm_Lists",
7289     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7290     "version": "0.0.0",
7291     "filename": "server/api/cmList/index.js",
7292     "groupTitle": "Cm_Lists"
7293   },
7294   {
7295     "type": "post",
7296     "url": "/api/cm/lists/{id}/contacts",
7297     "title": "Creates new contacts",
7298     "examples": [
7299       {
7300         "title": "Example usage:",
7301         "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",
7302         "type": "json"
7303       }
7304     ],
7305     "name": "addContacts",
7306     "group": "Cm_Lists",
7307     "parameter": {
7308       "fields": {
7309         "Body": [
7310           {
7311             "group": "Body",
7312             "type": "String",
7313             "optional": false,
7314             "field": "firstName",
7315             "description": ""
7316           },
7317           {
7318             "group": "Body",
7319             "type": "String",
7320             "optional": true,
7321             "field": "lastName",
7322             "description": ""
7323           },
7324           {
7325             "group": "Body",
7326             "type": "String",
7327             "optional": true,
7328             "field": "street",
7329             "description": ""
7330           },
7331           {
7332             "group": "Body",
7333             "type": "String",
7334             "optional": true,
7335             "field": "postalCode",
7336             "description": ""
7337           },
7338           {
7339             "group": "Body",
7340             "type": "String",
7341             "optional": true,
7342             "field": "city",
7343             "description": ""
7344           },
7345           {
7346             "group": "Body",
7347             "type": "String",
7348             "optional": true,
7349             "field": "country",
7350             "description": ""
7351           },
7352           {
7353             "group": "Body",
7354             "type": "String",
7355             "optional": true,
7356             "field": "dateOfBirth",
7357             "description": ""
7358           },
7359           {
7360             "group": "Body",
7361             "type": "Text",
7362             "optional": true,
7363             "field": "description",
7364             "description": ""
7365           },
7366           {
7367             "group": "Body",
7368             "type": "String",
7369             "optional": true,
7370             "field": "phone",
7371             "description": ""
7372           },
7373           {
7374             "group": "Body",
7375             "type": "String",
7376             "optional": true,
7377             "field": "mobile",
7378             "description": ""
7379           },
7380           {
7381             "group": "Body",
7382             "type": "String",
7383             "optional": true,
7384             "field": "fax",
7385             "description": ""
7386           },
7387           {
7388             "group": "Body",
7389             "type": "String",
7390             "optional": true,
7391             "field": "email",
7392             "description": ""
7393           },
7394           {
7395             "group": "Body",
7396             "type": "String",
7397             "optional": true,
7398             "field": "url",
7399             "description": ""
7400           },
7401           {
7402             "group": "Body",
7403             "type": "String",
7404             "optional": true,
7405             "field": "facebook",
7406             "description": ""
7407           },
7408           {
7409             "group": "Body",
7410             "type": "String",
7411             "optional": true,
7412             "field": "fb_data",
7413             "description": ""
7414           },
7415           {
7416             "group": "Body",
7417             "type": "String",
7418             "optional": true,
7419             "field": "twitter",
7420             "description": ""
7421           },
7422           {
7423             "group": "Body",
7424             "type": "String",
7425             "optional": true,
7426             "field": "skype",
7427             "description": ""
7428           },
7429           {
7430             "group": "Body",
7431             "type": "String",
7432             "optional": true,
7433             "field": "teams",
7434             "description": ""
7435           },
7436           {
7437             "group": "Body",
7438             "type": "String",
7439             "optional": true,
7440             "field": "viber",
7441             "description": ""
7442           },
7443           {
7444             "group": "Body",
7445             "type": "String",
7446             "optional": true,
7447             "field": "line",
7448             "description": ""
7449           },
7450           {
7451             "group": "Body",
7452             "type": "String",
7453             "optional": true,
7454             "field": "wechat",
7455             "description": ""
7456           },
7457           {
7458             "group": "Body",
7459             "type": "String",
7460             "optional": true,
7461             "field": "telegram",
7462             "description": ""
7463           },
7464           {
7465             "group": "Body",
7466             "type": "Integer",
7467             "optional": true,
7468             "field": "UserId",
7469             "description": ""
7470           },
7471           {
7472             "group": "Body",
7473             "type": "Integer",
7474             "optional": true,
7475             "field": "priority",
7476             "description": ""
7477           },
7478           {
7479             "group": "Body",
7480             "type": "String",
7481             "optional": true,
7482             "field": "scheduledat",
7483             "description": ""
7484           }
7485         ]
7486       }
7487     },
7488     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7489     "version": "0.0.0",
7490     "filename": "server/api/cmList/index.js",
7491     "groupTitle": "Cm_Lists"
7492   },
7493   {
7494     "type": "post",
7495     "url": "/api/cm/lists/{id}/fields",
7496     "title": "Creates a new custom field",
7497     "examples": [
7498       {
7499         "title": "Example usage:",
7500         "content": "curl https://{domain}/api/cm/lists/{id}/fields -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
7501         "type": "json"
7502       }
7503     ],
7504     "name": "addCustomField",
7505     "group": "Cm_Lists",
7506     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7507     "version": "0.0.0",
7508     "filename": "server/api/cmList/index.js",
7509     "groupTitle": "Cm_Lists"
7510   },
7511   {
7512     "type": "post",
7513     "url": "/api/cm/lists/{id}/dispositions",
7514     "title": "Creates new disposition",
7515     "examples": [
7516       {
7517         "title": "Example usage:",
7518         "content": "curl https://{domain}/api/cm/lists/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
7519         "type": "json"
7520       }
7521     ],
7522     "name": "addDisposition",
7523     "group": "Cm_Lists",
7524     "parameter": {
7525       "fields": {
7526         "Body": [
7527           {
7528             "group": "Body",
7529             "type": "String",
7530             "optional": false,
7531             "field": "name",
7532             "description": ""
7533           }
7534         ]
7535       }
7536     },
7537     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7538     "version": "0.0.0",
7539     "filename": "server/api/cmList/index.js",
7540     "groupTitle": "Cm_Lists"
7541   },
7542   {
7543     "type": "get",
7544     "url": "/api/cm/lists/{id}/contacts",
7545     "title": "Gets List Contacts",
7546     "examples": [
7547       {
7548         "title": "Example usage:",
7549         "content": "curl https://{domain}/api/cm/lists/{id}/contacts -v -u {name}:{password} -X GET",
7550         "type": "json"
7551       }
7552     ],
7553     "name": "getContacts",
7554     "group": "Cm_Lists",
7555     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7556     "version": "0.0.0",
7557     "filename": "server/api/cmList/index.js",
7558     "groupTitle": "Cm_Lists"
7559   },
7560   {
7561     "type": "get",
7562     "url": "/api/cm/lists/{id}/fields",
7563     "title": "Gets Custom Fields",
7564     "examples": [
7565       {
7566         "title": "Example usage:",
7567         "content": "curl https://{domain}/api/cm/lists/{id}/fields -v -u {name}:{password} -X GET",
7568         "type": "json"
7569       }
7570     ],
7571     "name": "getCustomFields",
7572     "group": "Cm_Lists",
7573     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7574     "version": "0.0.0",
7575     "filename": "server/api/cmList/index.js",
7576     "groupTitle": "Cm_Lists"
7577   },
7578   {
7579     "type": "get",
7580     "url": "/api/cm/lists/{id}/dispositions",
7581     "title": "Gets list dispositions",
7582     "examples": [
7583       {
7584         "title": "Example usage:",
7585         "content": "curl https://{domain}/api/cm/lists/{id}/dispositions -v -u {name}:{password} -X GET",
7586         "type": "json"
7587       }
7588     ],
7589     "name": "getDispositions",
7590     "group": "Cm_Lists",
7591     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7592     "version": "0.0.0",
7593     "filename": "server/api/cmList/index.js",
7594     "groupTitle": "Cm_Lists"
7595   },
7596   {
7597     "type": "get",
7598     "url": "/api/cm/lists/{id}/contacts/csv",
7599     "title": "Gets CSV List Contacts",
7600     "examples": [
7601       {
7602         "title": "Example usage:",
7603         "content": "curl https://{domain}/api/cm/lists/{id}/contacts/csv -v -u {name}:{password} -X GET",
7604         "type": "json"
7605       }
7606     ],
7607     "name": "grunt",
7608     "group": "Cm_Lists",
7609     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7610     "version": "0.0.0",
7611     "filename": "server/api/cmList/index.js",
7612     "groupTitle": "Cm_Lists"
7613   },
7614   {
7615     "type": "put",
7616     "url": "/api/cm/lists/{id}",
7617     "title": "Update an existing List",
7618     "examples": [
7619       {
7620         "title": "Example usage:",
7621         "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",
7622         "type": "json"
7623       }
7624     ],
7625     "name": "updateLists",
7626     "group": "Cm_Lists",
7627     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7628     "version": "0.0.0",
7629     "filename": "server/api/cmList/index.js",
7630     "groupTitle": "Cm_Lists"
7631   },
7632   {
7633     "type": "post",
7634     "url": "/api/cm/contacts/upload/:id",
7635     "title": "Import new contacts by csv",
7636     "examples": [
7637       {
7638         "title": "Example usage:",
7639         "content": "curl https://{domain}/api/cm/contacts/upload/:id -v -u {name}:{password} -X POST",
7640         "type": "json"
7641       }
7642     ],
7643     "name": "import",
7644     "group": "Cm_contacts",
7645     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7646     "version": "0.0.0",
7647     "filename": "server/api/cmContact/index.js",
7648     "groupTitle": "Cm_contacts"
7649   },
7650   {
7651     "type": "post",
7652     "url": "/api/cm/contacts/upload",
7653     "title": "Upload csv",
7654     "examples": [
7655       {
7656         "title": "Example usage:",
7657         "content": "curl https://{domain}/api/cm/contacts/upload -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
7658         "type": "json"
7659       }
7660     ],
7661     "name": "upload",
7662     "group": "Cm_contacts",
7663     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7664     "version": "0.0.0",
7665     "filename": "server/api/cmContact/index.js",
7666     "groupTitle": "Cm_contacts"
7667   },
7668   {
7669     "type": "post",
7670     "url": "/api/cm/contacts/csv",
7671     "title": "Create new contacts by csv",
7672     "examples": [
7673       {
7674         "title": "Example usage:",
7675         "content": "curl https://{domain}/api/cm/contacts/csv -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
7676         "type": "json"
7677       }
7678     ],
7679     "name": "uploadCsv",
7680     "group": "Cm_contacts",
7681     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7682     "version": "0.0.0",
7683     "filename": "server/api/cmContact/index.js",
7684     "groupTitle": "Cm_contacts"
7685   },
7686   {
7687     "type": "delete",
7688     "url": "/api/conditions/{id}",
7689     "title": "Deletes a Condition",
7690     "examples": [
7691       {
7692         "title": "Example usage:",
7693         "content": "curl https://{domain}/api/conditions/{id} -v -u {name}:{password} -X DELETE",
7694         "type": "json"
7695       }
7696     ],
7697     "name": "DeleteConditions",
7698     "group": "Conditions",
7699     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7700     "version": "0.0.0",
7701     "filename": "server/api/condition/index.js",
7702     "groupTitle": "Conditions"
7703   },
7704   {
7705     "type": "put",
7706     "url": "/api/conditions/{id}",
7707     "title": "Update an existing Condition",
7708     "examples": [
7709       {
7710         "title": "Example usage:",
7711         "content": "curl https://{domain}/api/conditions/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
7712         "type": "json"
7713       }
7714     ],
7715     "name": "updateConditions",
7716     "group": "Conditions",
7717     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7718     "version": "0.0.0",
7719     "filename": "server/api/condition/index.js",
7720     "groupTitle": "Conditions"
7721   },
7722   {
7723     "type": "post",
7724     "url": "/api/cm/custom_field",
7725     "title": "Create a new custom field",
7726     "examples": [
7727       {
7728         "title": "Example usage:",
7729         "content": "curl https://{domain}/api/cm/custom_field  -d '{\"name\": \"mycf\", \"type\": \"text\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
7730         "type": "json"
7731       }
7732     ],
7733     "name": "CreateCustomField",
7734     "group": "Custom_Fields",
7735     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7736     "version": "0.0.0",
7737     "filename": "server/api/cmCustomField/index.js",
7738     "groupTitle": "Custom_Fields"
7739   },
7740   {
7741     "type": "post",
7742     "url": "/api/dashboards/items",
7743     "title": "Create dasboard item",
7744     "examples": [
7745       {
7746         "title": "Example usage:",
7747         "content": "curl https://{domain}/api/dashboards/items \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
7748         "type": "json"
7749       }
7750     ],
7751     "name": "Create",
7752     "group": "Dashboard_Items",
7753     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7754     "version": "0.0.0",
7755     "filename": "server/api/dashboardItem/index.js",
7756     "groupTitle": "Dashboard_Items"
7757   },
7758   {
7759     "type": "delete",
7760     "url": "/api/dashboards/items/{id}",
7761     "title": "Deletes a Dashboard Item",
7762     "examples": [
7763       {
7764         "title": "Example usage:",
7765         "content": "curl https://{domain}/api/dashboards/items/{id} -v -u {name}:{password} -X DELETE",
7766         "type": "json"
7767       }
7768     ],
7769     "name": "DeleteDashboard_Items",
7770     "group": "Dashboard_Items",
7771     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7772     "version": "0.0.0",
7773     "filename": "server/api/dashboardItem/index.js",
7774     "groupTitle": "Dashboard_Items"
7775   },
7776   {
7777     "type": "get",
7778     "url": "/api/dashboards/items/{id}",
7779     "title": "Gets a single Dashboard Item",
7780     "examples": [
7781       {
7782         "title": "Example usage:",
7783         "content": "curl https://{domain}/api/dashboards/items/{id} -v -u {name}:{password}",
7784         "type": "json"
7785       }
7786     ],
7787     "name": "ShowDashboard_Items",
7788     "group": "Dashboard_Items",
7789     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7790     "version": "0.0.0",
7791     "filename": "server/api/dashboardItem/index.js",
7792     "groupTitle": "Dashboard_Items"
7793   },
7794   {
7795     "type": "put",
7796     "url": "/api/dashboards/items/{id}",
7797     "title": "Update an existing item",
7798     "examples": [
7799       {
7800         "title": "Example usage:",
7801         "content": "curl https://{domain}/api/dashboards/items/{id} -v -u {name}:{password} -X PUT",
7802         "type": "json"
7803       }
7804     ],
7805     "name": "Update",
7806     "group": "Dashboard_Items",
7807     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7808     "version": "0.0.0",
7809     "filename": "server/api/dashboardItem/index.js",
7810     "groupTitle": "Dashboard_Items"
7811   },
7812   {
7813     "type": "post",
7814     "url": "/api/dashboards/clone",
7815     "title": "Clone an existing Dashboard",
7816     "examples": [
7817       {
7818         "title": "Example usage:",
7819         "content": "curl https://{domain}/api/dashboards/clone -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
7820         "type": "json"
7821       }
7822     ],
7823     "name": "CloneDashboards",
7824     "group": "Dashboards",
7825     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7826     "version": "0.0.0",
7827     "filename": "server/api/dashboard/index.js",
7828     "groupTitle": "Dashboards"
7829   },
7830   {
7831     "type": "post",
7832     "url": "/api/dashboards",
7833     "title": "Creates a new Dashboard",
7834     "examples": [
7835       {
7836         "title": "Example usage:",
7837         "content": "curl https://{domain}/api/dashboards -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
7838         "type": "json"
7839       }
7840     ],
7841     "name": "CreateDashboards",
7842     "group": "Dashboards",
7843     "parameter": {
7844       "fields": {
7845         "Body": [
7846           {
7847             "group": "Body",
7848             "type": "String",
7849             "optional": false,
7850             "field": "name",
7851             "description": ""
7852           },
7853           {
7854             "group": "Body",
7855             "type": "String",
7856             "optional": true,
7857             "field": "description",
7858             "description": ""
7859           }
7860         ]
7861       }
7862     },
7863     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7864     "version": "0.0.0",
7865     "filename": "server/api/dashboard/index.js",
7866     "groupTitle": "Dashboards"
7867   },
7868   {
7869     "type": "delete",
7870     "url": "/api/dashboards/{id}",
7871     "title": "Deletes a Dashboard",
7872     "examples": [
7873       {
7874         "title": "Example usage:",
7875         "content": "curl https://{domain}/api/dashboards/{id} -v -u {name}:{password} -X DELETE",
7876         "type": "json"
7877       }
7878     ],
7879     "name": "DeleteDashboards",
7880     "group": "Dashboards",
7881     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7882     "version": "0.0.0",
7883     "filename": "server/api/dashboard/index.js",
7884     "groupTitle": "Dashboards"
7885   },
7886   {
7887     "type": "get",
7888     "url": "/api/dashboards",
7889     "title": "Gets a list of Dashboards",
7890     "examples": [
7891       {
7892         "title": "Example usage:",
7893         "content": "curl https://{domain}/api/dashboards -v -u {name}:{password}",
7894         "type": "json"
7895       }
7896     ],
7897     "name": "GetDashboards",
7898     "group": "Dashboards",
7899     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
7900     "version": "0.0.0",
7901     "filename": "server/api/dashboard/index.js",
7902     "groupTitle": "Dashboards"
7903   },
7904   {
7905     "type": "get",
7906     "url": "/api/dashboards/{id}",
7907     "title": "Gets a single Dashboard",
7908     "examples": [
7909       {
7910         "title": "Example usage:",
7911         "content": "curl https://{domain}/api/dashboards/{id} -v -u {name}:{password}",
7912         "type": "json"
7913       }
7914     ],
7915     "name": "ShowDashboards",
7916     "group": "Dashboards",
7917     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7918     "version": "0.0.0",
7919     "filename": "server/api/dashboard/index.js",
7920     "groupTitle": "Dashboards"
7921   },
7922   {
7923     "type": "post",
7924     "url": "/api/dashboards/{id}/items",
7925     "title": "Creates new item",
7926     "examples": [
7927       {
7928         "title": "Example usage:",
7929         "content": "curl https://{domain}/api/dashboards/{id}/items -d '{\"type\": \"counter\", \"...\": \"...\"}]' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
7930         "type": "json"
7931       }
7932     ],
7933     "name": "addItem",
7934     "group": "Dashboards",
7935     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7936     "version": "0.0.0",
7937     "filename": "server/api/dashboard/index.js",
7938     "groupTitle": "Dashboards"
7939   },
7940   {
7941     "type": "get",
7942     "url": "/api/dashboards/{id}/items",
7943     "title": "Gets items",
7944     "examples": [
7945       {
7946         "title": "Example usage:",
7947         "content": "curl https://{domain}/api/dashboards/{id}/items -v -u {name}:{password} -X GET",
7948         "type": "json"
7949       }
7950     ],
7951     "name": "getItems",
7952     "group": "Dashboards",
7953     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7954     "version": "0.0.0",
7955     "filename": "server/api/dashboard/index.js",
7956     "groupTitle": "Dashboards"
7957   },
7958   {
7959     "type": "put",
7960     "url": "/api/dashboards/{id}",
7961     "title": "Update an existing Dashboard",
7962     "examples": [
7963       {
7964         "title": "Example usage:",
7965         "content": "curl https://{domain}/api/dashboards/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
7966         "type": "json"
7967       }
7968     ],
7969     "name": "updateDashboards",
7970     "group": "Dashboards",
7971     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7972     "version": "0.0.0",
7973     "filename": "server/api/dashboard/index.js",
7974     "groupTitle": "Dashboards"
7975   },
7976   {
7977     "type": "post",
7978     "url": "/api/integrations/desk/accounts",
7979     "title": "Creates a new Desk Account",
7980     "examples": [
7981       {
7982         "title": "Example usage:",
7983         "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",
7984         "type": "json"
7985       }
7986     ],
7987     "name": "CreateDesk_Accounts",
7988     "group": "Desk_Accounts",
7989     "parameter": {
7990       "fields": {
7991         "Body": [
7992           {
7993             "group": "Body",
7994             "type": "String",
7995             "optional": true,
7996             "field": "name",
7997             "description": ""
7998           },
7999           {
8000             "group": "Body",
8001             "type": "String",
8002             "optional": true,
8003             "field": "description",
8004             "description": ""
8005           },
8006           {
8007             "group": "Body",
8008             "type": "String",
8009             "optional": true,
8010             "field": "username",
8011             "description": ""
8012           },
8013           {
8014             "group": "Body",
8015             "type": "String",
8016             "optional": true,
8017             "field": "remoteUri",
8018             "description": ""
8019           },
8020           {
8021             "group": "Body",
8022             "type": "String",
8023             "allowedValues": [
8024               "\"basic\""
8025             ],
8026             "optional": true,
8027             "field": "authType",
8028             "description": ""
8029           },
8030           {
8031             "group": "Body",
8032             "type": "String",
8033             "optional": true,
8034             "field": "password",
8035             "description": ""
8036           },
8037           {
8038             "group": "Body",
8039             "type": "String",
8040             "optional": true,
8041             "field": "consumerKey",
8042             "description": ""
8043           },
8044           {
8045             "group": "Body",
8046             "type": "String",
8047             "optional": true,
8048             "field": "consumerSecret",
8049             "description": ""
8050           },
8051           {
8052             "group": "Body",
8053             "type": "String",
8054             "optional": true,
8055             "field": "token",
8056             "description": ""
8057           },
8058           {
8059             "group": "Body",
8060             "type": "String",
8061             "optional": true,
8062             "field": "tokenSecret",
8063             "description": ""
8064           },
8065           {
8066             "group": "Body",
8067             "type": "String",
8068             "optional": true,
8069             "field": "serverUrl",
8070             "description": ""
8071           },
8072           {
8073             "group": "Body",
8074             "type": "String",
8075             "allowedValues": [
8076               "\"integrationTab\"",
8077               "\"newTab\""
8078             ],
8079             "optional": true,
8080             "field": "type",
8081             "description": ""
8082           }
8083         ]
8084       }
8085     },
8086     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8087     "version": "0.0.0",
8088     "filename": "server/api/intDeskAccount/index.js",
8089     "groupTitle": "Desk_Accounts"
8090   },
8091   {
8092     "type": "delete",
8093     "url": "/api/integrations/desk/accounts/{id}",
8094     "title": "Deletes a Desk Account",
8095     "examples": [
8096       {
8097         "title": "Example usage:",
8098         "content": "curl https://{domain}/api/integrations/desk/accounts/{id} -v -u {name}:{password} -X DELETE",
8099         "type": "json"
8100       }
8101     ],
8102     "name": "DeleteDesk_Accounts",
8103     "group": "Desk_Accounts",
8104     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8105     "version": "0.0.0",
8106     "filename": "server/api/intDeskAccount/index.js",
8107     "groupTitle": "Desk_Accounts"
8108   },
8109   {
8110     "type": "get",
8111     "url": "/api/integrations/desk/accounts",
8112     "title": "Gets a list of Desk Accounts",
8113     "examples": [
8114       {
8115         "title": "Example usage:",
8116         "content": "curl https://{domain}/api/integrations/desk/accounts -v -u {name}:{password}",
8117         "type": "json"
8118       }
8119     ],
8120     "name": "GetDesk_Accounts",
8121     "group": "Desk_Accounts",
8122     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
8123     "version": "0.0.0",
8124     "filename": "server/api/intDeskAccount/index.js",
8125     "groupTitle": "Desk_Accounts"
8126   },
8127   {
8128     "type": "get",
8129     "url": "/api/integrations/desk/accounts/{id}",
8130     "title": "Gets a single Desk Account",
8131     "examples": [
8132       {
8133         "title": "Example usage:",
8134         "content": "curl https://{domain}/api/integrations/desk/accounts/{id} -v -u {name}:{password}",
8135         "type": "json"
8136       }
8137     ],
8138     "name": "ShowDesk_Accounts",
8139     "group": "Desk_Accounts",
8140     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8141     "version": "0.0.0",
8142     "filename": "server/api/intDeskAccount/index.js",
8143     "groupTitle": "Desk_Accounts"
8144   },
8145   {
8146     "type": "post",
8147     "url": "/api/integrations/desk/accounts/{id}/configurations",
8148     "title": "Creates new configuration",
8149     "examples": [
8150       {
8151         "title": "Example usage:",
8152         "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",
8153         "type": "json"
8154       }
8155     ],
8156     "name": "addConfiguration",
8157     "group": "Desk_Accounts",
8158     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8159     "version": "0.0.0",
8160     "filename": "server/api/intDeskAccount/index.js",
8161     "groupTitle": "Desk_Accounts"
8162   },
8163   {
8164     "type": "get",
8165     "url": "/api/integrations/desk/accounts/{id}/configurations",
8166     "title": "Gets account configurations",
8167     "examples": [
8168       {
8169         "title": "Example usage:",
8170         "content": "curl https://{domain}/api/integrations/desk/accounts/{id}/configurations -v -u {name}:{password} -X GET",
8171         "type": "json"
8172       }
8173     ],
8174     "name": "getConfigurations",
8175     "group": "Desk_Accounts",
8176     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8177     "version": "0.0.0",
8178     "filename": "server/api/intDeskAccount/index.js",
8179     "groupTitle": "Desk_Accounts"
8180   },
8181   {
8182     "type": "get",
8183     "url": "/api/integrations/desk/accounts/{id}/fields",
8184     "title": "Gets account fields",
8185     "examples": [
8186       {
8187         "title": "Example usage:",
8188         "content": "curl https://{domain}/api/integrations/desk/accounts/{id}/fields -v -u {name}:{password} -X GET",
8189         "type": "json"
8190       }
8191     ],
8192     "name": "getFields",
8193     "group": "Desk_Accounts",
8194     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8195     "version": "0.0.0",
8196     "filename": "server/api/intDeskAccount/index.js",
8197     "groupTitle": "Desk_Accounts"
8198   },
8199   {
8200     "type": "put",
8201     "url": "/api/integrations/desk/accounts/{id}",
8202     "title": "Update an existing Desk Account",
8203     "examples": [
8204       {
8205         "title": "Example usage:",
8206         "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",
8207         "type": "json"
8208       }
8209     ],
8210     "name": "updateDesk_Accounts",
8211     "group": "Desk_Accounts",
8212     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8213     "version": "0.0.0",
8214     "filename": "server/api/intDeskAccount/index.js",
8215     "groupTitle": "Desk_Accounts"
8216   },
8217   {
8218     "type": "post",
8219     "url": "/api/integrations/desk/configurations",
8220     "title": "Creates a new Desk Configuration",
8221     "examples": [
8222       {
8223         "title": "Example usage:",
8224         "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",
8225         "type": "json"
8226       }
8227     ],
8228     "name": "CreateDesk_Configurations",
8229     "group": "Desk_Configurations",
8230     "parameter": {
8231       "fields": {
8232         "Body": [
8233           {
8234             "group": "Body",
8235             "type": "String",
8236             "optional": true,
8237             "field": "name",
8238             "description": ""
8239           },
8240           {
8241             "group": "Body",
8242             "type": "String",
8243             "optional": true,
8244             "field": "description",
8245             "description": ""
8246           }
8247         ]
8248       }
8249     },
8250     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8251     "version": "0.0.0",
8252     "filename": "server/api/intDeskConfiguration/index.js",
8253     "groupTitle": "Desk_Configurations"
8254   },
8255   {
8256     "type": "delete",
8257     "url": "/api/integrations/desk/configurations/{id}",
8258     "title": "Deletes a Desk Configuration",
8259     "examples": [
8260       {
8261         "title": "Example usage:",
8262         "content": "curl https://{domain}/api/integrations/desk/configurations/{id} -v -u {name}:{password} -X DELETE",
8263         "type": "json"
8264       }
8265     ],
8266     "name": "DeleteDesk_Configurations",
8267     "group": "Desk_Configurations",
8268     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8269     "version": "0.0.0",
8270     "filename": "server/api/intDeskConfiguration/index.js",
8271     "groupTitle": "Desk_Configurations"
8272   },
8273   {
8274     "type": "get",
8275     "url": "/api/integrations/desk/configurations",
8276     "title": "Gets a list of Desk Configurations",
8277     "examples": [
8278       {
8279         "title": "Example usage:",
8280         "content": "curl https://{domain}/api/integrations/desk/configurations -v -u {name}:{password}",
8281         "type": "json"
8282       }
8283     ],
8284     "name": "GetDesk_Configurations",
8285     "group": "Desk_Configurations",
8286     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
8287     "version": "0.0.0",
8288     "filename": "server/api/intDeskConfiguration/index.js",
8289     "groupTitle": "Desk_Configurations"
8290   },
8291   {
8292     "type": "get",
8293     "url": "/api/integrations/desk/configurations/{id}",
8294     "title": "Gets a single Desk Configuration",
8295     "examples": [
8296       {
8297         "title": "Example usage:",
8298         "content": "curl https://{domain}/api/integrations/desk/configurations/{id} -v -u {name}:{password}",
8299         "type": "json"
8300       }
8301     ],
8302     "name": "ShowDesk_Configurations",
8303     "group": "Desk_Configurations",
8304     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8305     "version": "0.0.0",
8306     "filename": "server/api/intDeskConfiguration/index.js",
8307     "groupTitle": "Desk_Configurations"
8308   },
8309   {
8310     "type": "get",
8311     "url": "/api/integrations/desk/configurations/{id}/descriptions",
8312     "title": "Gets configurations descriptions",
8313     "examples": [
8314       {
8315         "title": "Example usage:",
8316         "content": "curl https://{domain}/api/integrations/desk/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
8317         "type": "json"
8318       }
8319     ],
8320     "name": "getDescriptions",
8321     "group": "Desk_Configurations",
8322     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8323     "version": "0.0.0",
8324     "filename": "server/api/intDeskConfiguration/index.js",
8325     "groupTitle": "Desk_Configurations"
8326   },
8327   {
8328     "type": "get",
8329     "url": "/api/integrations/desk/configurations/{id}/fields",
8330     "title": "Gets configurations fields",
8331     "examples": [
8332       {
8333         "title": "Example usage:",
8334         "content": "curl https://{domain}/api/integrations/desk/configurations/{id}/fields -v -u {name}:{password} -X GET",
8335         "type": "json"
8336       }
8337     ],
8338     "name": "getFields",
8339     "group": "Desk_Configurations",
8340     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8341     "version": "0.0.0",
8342     "filename": "server/api/intDeskConfiguration/index.js",
8343     "groupTitle": "Desk_Configurations"
8344   },
8345   {
8346     "type": "get",
8347     "url": "/api/integrations/desk/configurations/{id}/subjects",
8348     "title": "Gets configurations subjects",
8349     "examples": [
8350       {
8351         "title": "Example usage:",
8352         "content": "curl https://{domain}/api/integrations/desk/configurations/{id}/subjects -v -u {name}:{password} -X GET",
8353         "type": "json"
8354       }
8355     ],
8356     "name": "getSubjects",
8357     "group": "Desk_Configurations",
8358     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8359     "version": "0.0.0",
8360     "filename": "server/api/intDeskConfiguration/index.js",
8361     "groupTitle": "Desk_Configurations"
8362   },
8363   {
8364     "type": "get",
8365     "url": "/api/integrations/desk/configurations/{id}/tags",
8366     "title": "Gets configurations tags",
8367     "examples": [
8368       {
8369         "title": "Example usage:",
8370         "content": "curl https://{domain}/api/integrations/desk/configurations/{id}/tags -v -u {name}:{password} -X GET",
8371         "type": "json"
8372       }
8373     ],
8374     "name": "getTags",
8375     "group": "Desk_Configurations",
8376     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8377     "version": "0.0.0",
8378     "filename": "server/api/intDeskConfiguration/index.js",
8379     "groupTitle": "Desk_Configurations"
8380   },
8381   {
8382     "type": "post",
8383     "url": "/api/integrations/desk/configurations/{id}/tags",
8384     "title": "Sets new tags",
8385     "examples": [
8386       {
8387         "title": "Example usage:",
8388         "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",
8389         "type": "json"
8390       }
8391     ],
8392     "name": "setTags",
8393     "group": "Desk_Configurations",
8394     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8395     "version": "0.0.0",
8396     "filename": "server/api/intDeskConfiguration/index.js",
8397     "groupTitle": "Desk_Configurations"
8398   },
8399   {
8400     "type": "put",
8401     "url": "/api/integrations/desk/configurations/{id}",
8402     "title": "Update an existing Desk Configuration",
8403     "examples": [
8404       {
8405         "title": "Example usage:",
8406         "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",
8407         "type": "json"
8408       }
8409     ],
8410     "name": "updateDesk_Configurations",
8411     "group": "Desk_Configurations",
8412     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8413     "version": "0.0.0",
8414     "filename": "server/api/intDeskConfiguration/index.js",
8415     "groupTitle": "Desk_Configurations"
8416   },
8417   {
8418     "type": "post",
8419     "url": "/api/integrations/desk/fields",
8420     "title": "Creates a new Desk Field",
8421     "examples": [
8422       {
8423         "title": "Example usage:",
8424         "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",
8425         "type": "json"
8426       }
8427     ],
8428     "name": "CreateDesk_Fields",
8429     "group": "Desk_Fields",
8430     "parameter": {
8431       "fields": {
8432         "Body": [
8433           {
8434             "group": "Body",
8435             "type": "String",
8436             "allowedValues": [
8437               "\"string\"",
8438               "\"variable\"",
8439               "\"customVariable\"",
8440               "\"keyValue\""
8441             ],
8442             "optional": true,
8443             "field": "type",
8444             "description": ""
8445           },
8446           {
8447             "group": "Body",
8448             "type": "String",
8449             "optional": true,
8450             "field": "content",
8451             "description": ""
8452           },
8453           {
8454             "group": "Body",
8455             "type": "String",
8456             "optional": true,
8457             "field": "key",
8458             "description": ""
8459           },
8460           {
8461             "group": "Body",
8462             "type": "String",
8463             "allowedValues": [
8464               "\"string\"",
8465               "\"variable\"",
8466               "\"customVariable\""
8467             ],
8468             "optional": true,
8469             "field": "keyType",
8470             "description": ""
8471           },
8472           {
8473             "group": "Body",
8474             "type": "String",
8475             "optional": true,
8476             "field": "keyContent",
8477             "description": ""
8478           },
8479           {
8480             "group": "Body",
8481             "type": "String",
8482             "optional": true,
8483             "field": "idField",
8484             "description": ""
8485           },
8486           {
8487             "group": "Body",
8488             "type": "String",
8489             "optional": true,
8490             "field": "nameField",
8491             "description": ""
8492           },
8493           {
8494             "group": "Body",
8495             "type": "Boolean",
8496             "optional": true,
8497             "field": "customField",
8498             "description": ""
8499           },
8500           {
8501             "group": "Body",
8502             "type": "String",
8503             "optional": true,
8504             "field": "variableName",
8505             "description": ""
8506           }
8507         ]
8508       }
8509     },
8510     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8511     "version": "0.0.0",
8512     "filename": "server/api/intDeskField/index.js",
8513     "groupTitle": "Desk_Fields"
8514   },
8515   {
8516     "type": "delete",
8517     "url": "/api/integrations/desk/fields/{id}",
8518     "title": "Deletes a Desk Field",
8519     "examples": [
8520       {
8521         "title": "Example usage:",
8522         "content": "curl https://{domain}/api/integrations/desk/fields/{id} -v -u {name}:{password} -X DELETE",
8523         "type": "json"
8524       }
8525     ],
8526     "name": "DeleteDesk_Fields",
8527     "group": "Desk_Fields",
8528     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8529     "version": "0.0.0",
8530     "filename": "server/api/intDeskField/index.js",
8531     "groupTitle": "Desk_Fields"
8532   },
8533   {
8534     "type": "get",
8535     "url": "/api/integrations/desk/fields",
8536     "title": "Gets a list of Desk Fields",
8537     "examples": [
8538       {
8539         "title": "Example usage:",
8540         "content": "curl https://{domain}/api/integrations/desk/fields -v -u {name}:{password}",
8541         "type": "json"
8542       }
8543     ],
8544     "name": "GetDesk_Fields",
8545     "group": "Desk_Fields",
8546     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
8547     "version": "0.0.0",
8548     "filename": "server/api/intDeskField/index.js",
8549     "groupTitle": "Desk_Fields"
8550   },
8551   {
8552     "type": "get",
8553     "url": "/api/integrations/desk/fields/{id}",
8554     "title": "Gets a single Desk Field",
8555     "examples": [
8556       {
8557         "title": "Example usage:",
8558         "content": "curl https://{domain}/api/integrations/desk/fields/{id} -v -u {name}:{password}",
8559         "type": "json"
8560       }
8561     ],
8562     "name": "ShowDesk_Fields",
8563     "group": "Desk_Fields",
8564     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8565     "version": "0.0.0",
8566     "filename": "server/api/intDeskField/index.js",
8567     "groupTitle": "Desk_Fields"
8568   },
8569   {
8570     "type": "put",
8571     "url": "/api/integrations/desk/fields/{id}",
8572     "title": "Update an existing Desk Field",
8573     "examples": [
8574       {
8575         "title": "Example usage:",
8576         "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",
8577         "type": "json"
8578       }
8579     ],
8580     "name": "updateDesk_Fields",
8581     "group": "Desk_Fields",
8582     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8583     "version": "0.0.0",
8584     "filename": "server/api/intDeskField/index.js",
8585     "groupTitle": "Desk_Fields"
8586   },
8587   {
8588     "type": "post",
8589     "url": "/api/dispositions",
8590     "title": "Creates a new Disposition",
8591     "examples": [
8592       {
8593         "title": "Example usage:",
8594         "content": "curl https://{domain}/api/dispositions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
8595         "type": "json"
8596       }
8597     ],
8598     "name": "CreateDispositions",
8599     "group": "Dispositions",
8600     "parameter": {
8601       "fields": {
8602         "Body": [
8603           {
8604             "group": "Body",
8605             "type": "String",
8606             "optional": false,
8607             "field": "name",
8608             "description": ""
8609           }
8610         ]
8611       }
8612     },
8613     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8614     "version": "0.0.0",
8615     "filename": "server/api/disposition/index.js",
8616     "groupTitle": "Dispositions"
8617   },
8618   {
8619     "type": "delete",
8620     "url": "/api/dispositions/{id}",
8621     "title": "Deletes a Disposition",
8622     "examples": [
8623       {
8624         "title": "Example usage:",
8625         "content": "curl https://{domain}/api/dispositions/{id} -v -u {name}:{password} -X DELETE",
8626         "type": "json"
8627       }
8628     ],
8629     "name": "DeleteDispositions",
8630     "group": "Dispositions",
8631     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8632     "version": "0.0.0",
8633     "filename": "server/api/disposition/index.js",
8634     "groupTitle": "Dispositions"
8635   },
8636   {
8637     "type": "get",
8638     "url": "/api/dispositions",
8639     "title": "Gets a list of Dispositions",
8640     "examples": [
8641       {
8642         "title": "Example usage:",
8643         "content": "curl https://{domain}/api/dispositions -v -u {name}:{password}",
8644         "type": "json"
8645       }
8646     ],
8647     "name": "GetDispositions",
8648     "group": "Dispositions",
8649     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
8650     "version": "0.0.0",
8651     "filename": "server/api/disposition/index.js",
8652     "groupTitle": "Dispositions"
8653   },
8654   {
8655     "type": "get",
8656     "url": "/api/dispositions/{id}",
8657     "title": "Gets a single Disposition",
8658     "examples": [
8659       {
8660         "title": "Example usage:",
8661         "content": "curl https://{domain}/api/dispositions/{id} -v -u {name}:{password}",
8662         "type": "json"
8663       }
8664     ],
8665     "name": "ShowDispositions",
8666     "group": "Dispositions",
8667     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8668     "version": "0.0.0",
8669     "filename": "server/api/disposition/index.js",
8670     "groupTitle": "Dispositions"
8671   },
8672   {
8673     "type": "put",
8674     "url": "/api/dispositions/{id}",
8675     "title": "Update an existing Disposition",
8676     "examples": [
8677       {
8678         "title": "Example usage:",
8679         "content": "curl https://{domain}/api/dispositions/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
8680         "type": "json"
8681       }
8682     ],
8683     "name": "updateDispositions",
8684     "group": "Dispositions",
8685     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8686     "version": "0.0.0",
8687     "filename": "server/api/disposition/index.js",
8688     "groupTitle": "Dispositions"
8689   },
8690   {
8691     "type": "post",
8692     "url": "/api/integrations/dynamics365/accounts",
8693     "title": "Creates a new Dynamics365 Account",
8694     "examples": [
8695       {
8696         "title": "Example usage:",
8697         "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",
8698         "type": "json"
8699       }
8700     ],
8701     "name": "CreateDynamics365_Accounts",
8702     "group": "Dynamics365_Accounts",
8703     "parameter": {
8704       "fields": {
8705         "Body": [
8706           {
8707             "group": "Body",
8708             "type": "String",
8709             "optional": true,
8710             "field": "name",
8711             "description": ""
8712           },
8713           {
8714             "group": "Body",
8715             "type": "String",
8716             "optional": true,
8717             "field": "username",
8718             "description": ""
8719           },
8720           {
8721             "group": "Body",
8722             "type": "String",
8723             "optional": true,
8724             "field": "password",
8725             "description": ""
8726           },
8727           {
8728             "group": "Body",
8729             "type": "String",
8730             "optional": true,
8731             "field": "remoteUri",
8732             "description": ""
8733           },
8734           {
8735             "group": "Body",
8736             "type": "String",
8737             "optional": true,
8738             "field": "tenantId",
8739             "description": ""
8740           },
8741           {
8742             "group": "Body",
8743             "type": "String",
8744             "optional": true,
8745             "field": "clientId",
8746             "description": ""
8747           },
8748           {
8749             "group": "Body",
8750             "type": "String",
8751             "optional": true,
8752             "field": "clientSecret",
8753             "description": ""
8754           },
8755           {
8756             "group": "Body",
8757             "type": "String",
8758             "optional": true,
8759             "field": "serverUrl",
8760             "description": ""
8761           },
8762           {
8763             "group": "Body",
8764             "type": "String",
8765             "optional": true,
8766             "field": "description",
8767             "description": ""
8768           }
8769         ]
8770       }
8771     },
8772     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8773     "version": "0.0.0",
8774     "filename": "server/api/intDynamics365Account/index.js",
8775     "groupTitle": "Dynamics365_Accounts"
8776   },
8777   {
8778     "type": "delete",
8779     "url": "/api/integrations/dynamics365/accounts/{id}",
8780     "title": "Deletes a Dynamics365 Account",
8781     "examples": [
8782       {
8783         "title": "Example usage:",
8784         "content": "curl https://{domain}/api/integrations/dynamics365/accounts/{id} -v -u {name}:{password} -X DELETE",
8785         "type": "json"
8786       }
8787     ],
8788     "name": "DeleteDynamics365_Accounts",
8789     "group": "Dynamics365_Accounts",
8790     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8791     "version": "0.0.0",
8792     "filename": "server/api/intDynamics365Account/index.js",
8793     "groupTitle": "Dynamics365_Accounts"
8794   },
8795   {
8796     "type": "get",
8797     "url": "/api/integrations/dynamics365/accounts",
8798     "title": "Gets a list of Dynamics365 Accounts",
8799     "examples": [
8800       {
8801         "title": "Example usage:",
8802         "content": "curl https://{domain}/api/integrations/dynamics365/accounts -v -u {name}:{password}",
8803         "type": "json"
8804       }
8805     ],
8806     "name": "GetDynamics365_Accounts",
8807     "group": "Dynamics365_Accounts",
8808     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
8809     "version": "0.0.0",
8810     "filename": "server/api/intDynamics365Account/index.js",
8811     "groupTitle": "Dynamics365_Accounts"
8812   },
8813   {
8814     "type": "get",
8815     "url": "/api/integrations/dynamics365/accounts/{id}",
8816     "title": "Gets a single Dynamics365 Account",
8817     "examples": [
8818       {
8819         "title": "Example usage:",
8820         "content": "curl https://{domain}/api/integrations/dynamics365/accounts/{id} -v -u {name}:{password}",
8821         "type": "json"
8822       }
8823     ],
8824     "name": "ShowDynamics365_Accounts",
8825     "group": "Dynamics365_Accounts",
8826     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8827     "version": "0.0.0",
8828     "filename": "server/api/intDynamics365Account/index.js",
8829     "groupTitle": "Dynamics365_Accounts"
8830   },
8831   {
8832     "type": "post",
8833     "url": "/api/integrations/dynamics365/accounts/{id}/configurations",
8834     "title": "Creates new configuration",
8835     "examples": [
8836       {
8837         "title": "Example usage:",
8838         "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",
8839         "type": "json"
8840       }
8841     ],
8842     "name": "addConfiguration",
8843     "group": "Dynamics365_Accounts",
8844     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8845     "version": "0.0.0",
8846     "filename": "server/api/intDynamics365Account/index.js",
8847     "groupTitle": "Dynamics365_Accounts"
8848   },
8849   {
8850     "type": "get",
8851     "url": "/api/integrations/dynamics365/accounts/{id}/configurations",
8852     "title": "Gets account configurations",
8853     "examples": [
8854       {
8855         "title": "Example usage:",
8856         "content": "curl https://{domain}/api/integrations/dynamics365/accounts/{id}/configurations -v -u {name}:{password} -X GET",
8857         "type": "json"
8858       }
8859     ],
8860     "name": "getConfigurations",
8861     "group": "Dynamics365_Accounts",
8862     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8863     "version": "0.0.0",
8864     "filename": "server/api/intDynamics365Account/index.js",
8865     "groupTitle": "Dynamics365_Accounts"
8866   },
8867   {
8868     "type": "get",
8869     "url": "/api/integrations/dynamics365/accounts/{id}/fields",
8870     "title": "Gets account fields",
8871     "examples": [
8872       {
8873         "title": "Example usage:",
8874         "content": "curl https://{domain}/api/integrations/dynamics365/accounts/{id}/fields -v -u {name}:{password} -X GET",
8875         "type": "json"
8876       }
8877     ],
8878     "name": "getFields",
8879     "group": "Dynamics365_Accounts",
8880     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8881     "version": "0.0.0",
8882     "filename": "server/api/intDynamics365Account/index.js",
8883     "groupTitle": "Dynamics365_Accounts"
8884   },
8885   {
8886     "type": "put",
8887     "url": "/api/integrations/dynamics365/accounts/{id}",
8888     "title": "Update an existing Dynamics365 Account",
8889     "examples": [
8890       {
8891         "title": "Example usage:",
8892         "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",
8893         "type": "json"
8894       }
8895     ],
8896     "name": "updateDynamics365_Accounts",
8897     "group": "Dynamics365_Accounts",
8898     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8899     "version": "0.0.0",
8900     "filename": "server/api/intDynamics365Account/index.js",
8901     "groupTitle": "Dynamics365_Accounts"
8902   },
8903   {
8904     "type": "post",
8905     "url": "/api/integrations/dynamics365/configurations",
8906     "title": "Creates a new Dynamics365 Configuration",
8907     "examples": [
8908       {
8909         "title": "Example usage:",
8910         "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",
8911         "type": "json"
8912       }
8913     ],
8914     "name": "CreateDynamics365_Configurations",
8915     "group": "Dynamics365_Configurations",
8916     "parameter": {
8917       "fields": {
8918         "Body": [
8919           {
8920             "group": "Body",
8921             "type": "String",
8922             "optional": true,
8923             "field": "name",
8924             "description": ""
8925           },
8926           {
8927             "group": "Body",
8928             "type": "String",
8929             "optional": true,
8930             "field": "description",
8931             "description": ""
8932           },
8933           {
8934             "group": "Body",
8935             "type": "String",
8936             "allowedValues": [
8937               "\"incident\"",
8938               "\"phonecall\""
8939             ],
8940             "optional": true,
8941             "field": "ticketType",
8942             "description": ""
8943           }
8944         ]
8945       }
8946     },
8947     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8948     "version": "0.0.0",
8949     "filename": "server/api/intDynamics365Configuration/index.js",
8950     "groupTitle": "Dynamics365_Configurations"
8951   },
8952   {
8953     "type": "delete",
8954     "url": "/api/integrations/dynamics365/configurations/{id}",
8955     "title": "Deletes a Dynamics365 Configuration",
8956     "examples": [
8957       {
8958         "title": "Example usage:",
8959         "content": "curl https://{domain}/api/integrations/dynamics365/configurations/{id} -v -u {name}:{password} -X DELETE",
8960         "type": "json"
8961       }
8962     ],
8963     "name": "DeleteDynamics365_Configurations",
8964     "group": "Dynamics365_Configurations",
8965     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8966     "version": "0.0.0",
8967     "filename": "server/api/intDynamics365Configuration/index.js",
8968     "groupTitle": "Dynamics365_Configurations"
8969   },
8970   {
8971     "type": "get",
8972     "url": "/api/integrations/dynamics365/configurations",
8973     "title": "Gets a list of Dynamics365 Configurations",
8974     "examples": [
8975       {
8976         "title": "Example usage:",
8977         "content": "curl https://{domain}/api/integrations/dynamics365/configurations -v -u {name}:{password}",
8978         "type": "json"
8979       }
8980     ],
8981     "name": "GetDynamics365_Configurations",
8982     "group": "Dynamics365_Configurations",
8983     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
8984     "version": "0.0.0",
8985     "filename": "server/api/intDynamics365Configuration/index.js",
8986     "groupTitle": "Dynamics365_Configurations"
8987   },
8988   {
8989     "type": "get",
8990     "url": "/api/integrations/dynamics365/configurations/{id}",
8991     "title": "Gets a single Dynamics365 Configuration",
8992     "examples": [
8993       {
8994         "title": "Example usage:",
8995         "content": "curl https://{domain}/api/integrations/dynamics365/configurations/{id} -v -u {name}:{password}",
8996         "type": "json"
8997       }
8998     ],
8999     "name": "ShowDynamics365_Configurations",
9000     "group": "Dynamics365_Configurations",
9001     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9002     "version": "0.0.0",
9003     "filename": "server/api/intDynamics365Configuration/index.js",
9004     "groupTitle": "Dynamics365_Configurations"
9005   },
9006   {
9007     "type": "get",
9008     "url": "/api/integrations/dynamics365/configurations/{id}/descriptions",
9009     "title": "Gets configurations descriptions",
9010     "examples": [
9011       {
9012         "title": "Example usage:",
9013         "content": "curl https://{domain}/api/integrations/dynamics365/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
9014         "type": "json"
9015       }
9016     ],
9017     "name": "getDescriptions",
9018     "group": "Dynamics365_Configurations",
9019     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9020     "version": "0.0.0",
9021     "filename": "server/api/intDynamics365Configuration/index.js",
9022     "groupTitle": "Dynamics365_Configurations"
9023   },
9024   {
9025     "type": "get",
9026     "url": "/api/integrations/dynamics365/configurations/{id}/fields",
9027     "title": "Gets configurations fields",
9028     "examples": [
9029       {
9030         "title": "Example usage:",
9031         "content": "curl https://{domain}/api/integrations/zoho/configurations/{id}/fields -v -u {name}:{password} -X GET",
9032         "type": "json"
9033       }
9034     ],
9035     "name": "getFields",
9036     "group": "Dynamics365_Configurations",
9037     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9038     "version": "0.0.0",
9039     "filename": "server/api/intDynamics365Configuration/index.js",
9040     "groupTitle": "Dynamics365_Configurations"
9041   },
9042   {
9043     "type": "get",
9044     "url": "/api/integrations/zoho/configurations/{id}/subjects",
9045     "title": "Gets configurations subjects",
9046     "examples": [
9047       {
9048         "title": "Example usage:",
9049         "content": "curl https://{domain}/api/integrations/dynamics365/configurations/{id}/subjects -v -u {name}:{password} -X GET",
9050         "type": "json"
9051       }
9052     ],
9053     "name": "getSubjects",
9054     "group": "Dynamics365_Configurations",
9055     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9056     "version": "0.0.0",
9057     "filename": "server/api/intDynamics365Configuration/index.js",
9058     "groupTitle": "Dynamics365_Configurations"
9059   },
9060   {
9061     "type": "put",
9062     "url": "/api/integrations/dynamics365/configurations/{id}",
9063     "title": "Update an existing Dynamics365 Configuration",
9064     "examples": [
9065       {
9066         "title": "Example usage:",
9067         "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",
9068         "type": "json"
9069       }
9070     ],
9071     "name": "updateDynamics365_Configurations",
9072     "group": "Dynamics365_Configurations",
9073     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9074     "version": "0.0.0",
9075     "filename": "server/api/intDynamics365Configuration/index.js",
9076     "groupTitle": "Dynamics365_Configurations"
9077   },
9078   {
9079     "type": "post",
9080     "url": "/api/integrations/dynamics365/fields",
9081     "title": "Creates a new Dynamics365 Field",
9082     "examples": [
9083       {
9084         "title": "Example usage:",
9085         "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",
9086         "type": "json"
9087       }
9088     ],
9089     "name": "CreateDynamics365_Fields",
9090     "group": "Dynamics365_Fields",
9091     "parameter": {
9092       "fields": {
9093         "Body": [
9094           {
9095             "group": "Body",
9096             "type": "String",
9097             "allowedValues": [
9098               "\"string\"",
9099               "\"variable\"",
9100               "\"customVariable\"",
9101               "\"keyValue\""
9102             ],
9103             "optional": true,
9104             "field": "type",
9105             "description": ""
9106           },
9107           {
9108             "group": "Body",
9109             "type": "String",
9110             "optional": true,
9111             "field": "content",
9112             "description": ""
9113           },
9114           {
9115             "group": "Body",
9116             "type": "String",
9117             "optional": true,
9118             "field": "key",
9119             "description": ""
9120           },
9121           {
9122             "group": "Body",
9123             "type": "String",
9124             "allowedValues": [
9125               "\"string\"",
9126               "\"variable\"",
9127               "\"customVariable\""
9128             ],
9129             "optional": true,
9130             "field": "keyType",
9131             "description": ""
9132           },
9133           {
9134             "group": "Body",
9135             "type": "String",
9136             "optional": true,
9137             "field": "keyContent",
9138             "description": ""
9139           },
9140           {
9141             "group": "Body",
9142             "type": "String",
9143             "optional": true,
9144             "field": "idField",
9145             "description": ""
9146           },
9147           {
9148             "group": "Body",
9149             "type": "String",
9150             "optional": true,
9151             "field": "nameField",
9152             "description": ""
9153           },
9154           {
9155             "group": "Body",
9156             "type": "Boolean",
9157             "optional": true,
9158             "field": "customField",
9159             "description": ""
9160           },
9161           {
9162             "group": "Body",
9163             "type": "String",
9164             "optional": true,
9165             "field": "variableName",
9166             "description": ""
9167           }
9168         ]
9169       }
9170     },
9171     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9172     "version": "0.0.0",
9173     "filename": "server/api/intDynamics365Field/index.js",
9174     "groupTitle": "Dynamics365_Fields"
9175   },
9176   {
9177     "type": "delete",
9178     "url": "/api/integrations/dynamics365/fields/{id}",
9179     "title": "Deletes a Dynamics365 Field",
9180     "examples": [
9181       {
9182         "title": "Example usage:",
9183         "content": "curl https://{domain}/api/integrations/dynamics365/fields/{id} -v -u {name}:{password} -X DELETE",
9184         "type": "json"
9185       }
9186     ],
9187     "name": "DeleteDynamics365_Fields",
9188     "group": "Dynamics365_Fields",
9189     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9190     "version": "0.0.0",
9191     "filename": "server/api/intDynamics365Field/index.js",
9192     "groupTitle": "Dynamics365_Fields"
9193   },
9194   {
9195     "type": "get",
9196     "url": "/api/integrations/dynamics365/fields",
9197     "title": "Gets a list of Dynamics365 Fields",
9198     "examples": [
9199       {
9200         "title": "Example usage:",
9201         "content": "curl https://{domain}/api/integrations/dynamics365/fields -v -u {name}:{password}",
9202         "type": "json"
9203       }
9204     ],
9205     "name": "GetDynamics365_Fields",
9206     "group": "Dynamics365_Fields",
9207     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
9208     "version": "0.0.0",
9209     "filename": "server/api/intDynamics365Field/index.js",
9210     "groupTitle": "Dynamics365_Fields"
9211   },
9212   {
9213     "type": "get",
9214     "url": "/api/integrations/dynamics365/fields/{id}",
9215     "title": "Gets a single Dynamics365 Field",
9216     "examples": [
9217       {
9218         "title": "Example usage:",
9219         "content": "curl https://{domain}/api/integrations/dynamics365/fields/{id} -v -u {name}:{password}",
9220         "type": "json"
9221       }
9222     ],
9223     "name": "ShowDynamics365_Fields",
9224     "group": "Dynamics365_Fields",
9225     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9226     "version": "0.0.0",
9227     "filename": "server/api/intDynamics365Field/index.js",
9228     "groupTitle": "Dynamics365_Fields"
9229   },
9230   {
9231     "type": "put",
9232     "url": "/api/integrations/dynamics365/fields/{id}",
9233     "title": "Update an existing Dynamics365 Field",
9234     "examples": [
9235       {
9236         "title": "Example usage:",
9237         "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",
9238         "type": "json"
9239       }
9240     ],
9241     "name": "updateDynamics365_Fields",
9242     "group": "Dynamics365_Fields",
9243     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9244     "version": "0.0.0",
9245     "filename": "server/api/intDynamics365Field/index.js",
9246     "groupTitle": "Dynamics365_Fields"
9247   },
9248   {
9249     "type": "post",
9250     "url": "/api/fax/accounts/{id}/users",
9251     "title": "Add agents to a fax account",
9252     "examples": [
9253       {
9254         "title": "Example usage:",
9255         "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",
9256         "type": "json"
9257       }
9258     ],
9259     "name": "AddAgents",
9260     "group": "Fax_Accounts",
9261     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9262     "version": "0.0.0",
9263     "filename": "server/api/faxAccount/index.js",
9264     "groupTitle": "Fax_Accounts"
9265   },
9266   {
9267     "type": "post",
9268     "url": "/api/fax/accounts",
9269     "title": "Creates a new Account",
9270     "examples": [
9271       {
9272         "title": "Example usage:",
9273         "content": "curl https://{domain}/api/fax/accounts -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
9274         "type": "json"
9275       }
9276     ],
9277     "name": "CreateAccounts",
9278     "group": "Fax_Accounts",
9279     "parameter": {
9280       "fields": {
9281         "Body": [
9282           {
9283             "group": "Body",
9284             "type": "String",
9285             "optional": false,
9286             "field": "name",
9287             "description": ""
9288           },
9289           {
9290             "group": "Body",
9291             "type": "String",
9292             "optional": true,
9293             "field": "description",
9294             "description": ""
9295           },
9296           {
9297             "group": "Body",
9298             "type": "String",
9299             "allowedValues": [
9300               "\"yes\"",
9301               "\"no\""
9302             ],
9303             "optional": true,
9304             "field": "ecm",
9305             "description": ""
9306           },
9307           {
9308             "group": "Body",
9309             "type": "String",
9310             "optional": true,
9311             "field": "headerinfo",
9312             "description": ""
9313           },
9314           {
9315             "group": "Body",
9316             "type": "String",
9317             "optional": true,
9318             "field": "localstationid",
9319             "description": ""
9320           },
9321           {
9322             "group": "Body",
9323             "type": "String",
9324             "allowedValues": [
9325               "\"2400\"",
9326               "\"4800\"",
9327               "\"7200\"",
9328               "\"9600\"",
9329               "\"12000\"",
9330               "\"14400\""
9331             ],
9332             "optional": true,
9333             "field": "minrate",
9334             "description": ""
9335           },
9336           {
9337             "group": "Body",
9338             "type": "String",
9339             "allowedValues": [
9340               "\"2400\"",
9341               "\"4800\"",
9342               "\"7200\"",
9343               "\"9600\"",
9344               "\"12000\"",
9345               "\"14400\""
9346             ],
9347             "optional": true,
9348             "field": "maxrate",
9349             "description": ""
9350           },
9351           {
9352             "group": "Body",
9353             "type": "String",
9354             "optional": true,
9355             "field": "modem",
9356             "description": ""
9357           },
9358           {
9359             "group": "Body",
9360             "type": "String",
9361             "optional": true,
9362             "field": "gateway",
9363             "description": ""
9364           },
9365           {
9366             "group": "Body",
9367             "type": "String",
9368             "optional": true,
9369             "field": "faxdetect",
9370             "description": ""
9371           },
9372           {
9373             "group": "Body",
9374             "type": "Integer",
9375             "optional": true,
9376             "field": "t38timeout",
9377             "description": ""
9378           },
9379           {
9380             "group": "Body",
9381             "type": "String",
9382             "allowedValues": [
9383               "\"SIP\"",
9384               "\"IAX\"",
9385               "\"DADHI\"",
9386               "\"KHOMP\""
9387             ],
9388             "optional": true,
9389             "field": "tech",
9390             "description": ""
9391           },
9392           {
9393             "group": "Body",
9394             "type": "String",
9395             "optional": false,
9396             "field": "key",
9397             "description": ""
9398           },
9399           {
9400             "group": "Body",
9401             "type": "Text",
9402             "optional": true,
9403             "field": "notificationTemplate",
9404             "description": ""
9405           },
9406           {
9407             "group": "Body",
9408             "type": "Boolean",
9409             "optional": true,
9410             "field": "notificationSound",
9411             "description": ""
9412           },
9413           {
9414             "group": "Body",
9415             "type": "Boolean",
9416             "optional": true,
9417             "field": "notificationShake",
9418             "description": ""
9419           },
9420           {
9421             "group": "Body",
9422             "type": "Integer",
9423             "optional": true,
9424             "field": "waitForTheAssignedAgent",
9425             "description": ""
9426           },
9427           {
9428             "group": "Body",
9429             "type": "Boolean",
9430             "optional": true,
9431             "field": "queueTransfer",
9432             "description": ""
9433           },
9434           {
9435             "group": "Body",
9436             "type": "Integer",
9437             "optional": true,
9438             "field": "queueTransferTimeout",
9439             "description": ""
9440           },
9441           {
9442             "group": "Body",
9443             "type": "Boolean",
9444             "optional": true,
9445             "field": "agentTransfer",
9446             "description": ""
9447           },
9448           {
9449             "group": "Body",
9450             "type": "Integer",
9451             "optional": true,
9452             "field": "agentTransferTimeout",
9453             "description": ""
9454           },
9455           {
9456             "group": "Body",
9457             "type": "Integer",
9458             "optional": true,
9459             "field": "mandatoryDispositionPauseId",
9460             "description": "<p>Status to put when mandatory disposition is enabled</p>"
9461           },
9462           {
9463             "group": "Body",
9464             "type": "Boolean",
9465             "optional": true,
9466             "field": "mandatoryDisposition",
9467             "description": "<p>Enabled/disables mandatory dispo on a queue</p>"
9468           }
9469         ]
9470       }
9471     },
9472     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9473     "version": "0.0.0",
9474     "filename": "server/api/faxAccount/index.js",
9475     "groupTitle": "Fax_Accounts"
9476   },
9477   {
9478     "type": "delete",
9479     "url": "/api/fax/accounts/{id}",
9480     "title": "Deletes a Account",
9481     "examples": [
9482       {
9483         "title": "Example usage:",
9484         "content": "curl https://{domain}/api/fax/accounts/{id} -v -u {name}:{password} -X DELETE",
9485         "type": "json"
9486       }
9487     ],
9488     "name": "DeleteAccounts",
9489     "group": "Fax_Accounts",
9490     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9491     "version": "0.0.0",
9492     "filename": "server/api/faxAccount/index.js",
9493     "groupTitle": "Fax_Accounts"
9494   },
9495   {
9496     "type": "get",
9497     "url": "/api/fax/accounts/describe",
9498     "title": "Gets table info about Accounts",
9499     "examples": [
9500       {
9501         "title": "Example usage:",
9502         "content": "curl https://{domain}/api/fax/accounts/describe -v -u {name}:{password}",
9503         "type": "json"
9504       }
9505     ],
9506     "name": "DescribeAccounts",
9507     "group": "Fax_Accounts",
9508     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9509     "version": "0.0.0",
9510     "filename": "server/api/faxAccount/index.js",
9511     "groupTitle": "Fax_Accounts"
9512   },
9513   {
9514     "type": "get",
9515     "url": "/api/fax/accounts",
9516     "title": "Gets a list of Accounts",
9517     "examples": [
9518       {
9519         "title": "Example usage:",
9520         "content": "curl https://{domain}/api/fax/accounts -v -u {name}:{password}",
9521         "type": "json"
9522       }
9523     ],
9524     "name": "GetAccounts",
9525     "group": "Fax_Accounts",
9526     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
9527     "version": "0.0.0",
9528     "filename": "server/api/faxAccount/index.js",
9529     "groupTitle": "Fax_Accounts"
9530   },
9531   {
9532     "type": "get",
9533     "url": "/api/fax/accounts/{id}/users",
9534     "title": "Gets agents from fax account",
9535     "examples": [
9536       {
9537         "title": "Example usage:",
9538         "content": "curl https://{domain}/api/fax/accounts/{id}/users -v -u {name}:{password} -X GET",
9539         "type": "json"
9540       }
9541     ],
9542     "name": "GetAgents",
9543     "group": "Fax_Accounts",
9544     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9545     "version": "0.0.0",
9546     "filename": "server/api/faxAccount/index.js",
9547     "groupTitle": "Fax_Accounts"
9548   },
9549   {
9550     "type": "delete",
9551     "url": "/api/fax/accounts/{id}/users",
9552     "title": "Removes agents from a fax account",
9553     "examples": [
9554       {
9555         "title": "Example usage:",
9556         "content": "curl https://{domain}/api/fax/accounts/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
9557         "type": "json"
9558       }
9559     ],
9560     "name": "RemoveAgents",
9561     "group": "Fax_Accounts",
9562     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9563     "version": "0.0.0",
9564     "filename": "server/api/faxAccount/index.js",
9565     "groupTitle": "Fax_Accounts"
9566   },
9567   {
9568     "type": "delete",
9569     "url": "/api/fax/accounts/{id}/canned_answers",
9570     "title": "Removes canned answers from account",
9571     "examples": [
9572       {
9573         "title": "Example usage:",
9574         "content": "curl https://{domain}/api/fax/accounts/{id}/canned_answers?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
9575         "type": "json"
9576       }
9577     ],
9578     "name": "RemoveAnswers",
9579     "group": "Fax_Accounts",
9580     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9581     "version": "0.0.0",
9582     "filename": "server/api/faxAccount/index.js",
9583     "groupTitle": "Fax_Accounts"
9584   },
9585   {
9586     "type": "delete",
9587     "url": "/api/fax/accounts/{id}/dispositions",
9588     "title": "Removes dispositions from account",
9589     "examples": [
9590       {
9591         "title": "Example usage:",
9592         "content": "curl https://{domain}/api/fax/accounts/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
9593         "type": "json"
9594       }
9595     ],
9596     "name": "RemoveDispositions",
9597     "group": "Fax_Accounts",
9598     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9599     "version": "0.0.0",
9600     "filename": "server/api/faxAccount/index.js",
9601     "groupTitle": "Fax_Accounts"
9602   },
9603   {
9604     "type": "get",
9605     "url": "/api/fax/accounts/{id}",
9606     "title": "Gets a single Account",
9607     "examples": [
9608       {
9609         "title": "Example usage:",
9610         "content": "curl https://{domain}/api/fax/accounts/{id} -v -u {name}:{password}",
9611         "type": "json"
9612       }
9613     ],
9614     "name": "ShowAccounts",
9615     "group": "Fax_Accounts",
9616     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9617     "version": "0.0.0",
9618     "filename": "server/api/faxAccount/index.js",
9619     "groupTitle": "Fax_Accounts"
9620   },
9621   {
9622     "type": "post",
9623     "url": "/api/fax/accounts/{id}/canned_answers",
9624     "title": "Creates new canned answer",
9625     "examples": [
9626       {
9627         "title": "Example usage:",
9628         "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",
9629         "type": "json"
9630       }
9631     ],
9632     "name": "addAnswer",
9633     "group": "Fax_Accounts",
9634     "parameter": {
9635       "fields": {
9636         "Body": [
9637           {
9638             "group": "Body",
9639             "type": "String",
9640             "optional": false,
9641             "field": "key",
9642             "description": ""
9643           },
9644           {
9645             "group": "Body",
9646             "type": "Text",
9647             "optional": false,
9648             "field": "value",
9649             "description": ""
9650           },
9651           {
9652             "group": "Body",
9653             "type": "String",
9654             "optional": true,
9655             "field": "description",
9656             "description": ""
9657           },
9658           {
9659             "group": "Body",
9660             "type": "Virtual",
9661             "optional": true,
9662             "field": "name",
9663             "description": ""
9664           }
9665         ]
9666       }
9667     },
9668     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9669     "version": "0.0.0",
9670     "filename": "server/api/faxAccount/index.js",
9671     "groupTitle": "Fax_Accounts"
9672   },
9673   {
9674     "type": "post",
9675     "url": "/api/fax/accounts/addaccountapplications",
9676     "title": "Creates new account and applications",
9677     "examples": [
9678       {
9679         "title": "Example usage:",
9680         "content": "curl https://{domain}/api/fax/accounts/addaccountapplications -d '[{\"name\": \"name\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
9681         "type": "json"
9682       }
9683     ],
9684     "name": "addApplications",
9685     "group": "Fax_Accounts",
9686     "parameter": {
9687       "fields": {
9688         "Body": [
9689           {
9690             "group": "Body",
9691             "type": "Integer",
9692             "optional": false,
9693             "field": "priority",
9694             "description": ""
9695           },
9696           {
9697             "group": "Body",
9698             "type": "String",
9699             "optional": false,
9700             "field": "app",
9701             "description": ""
9702           },
9703           {
9704             "group": "Body",
9705             "type": "Text",
9706             "optional": true,
9707             "field": "appdata",
9708             "description": ""
9709           },
9710           {
9711             "group": "Body",
9712             "type": "String",
9713             "optional": true,
9714             "field": "description",
9715             "description": ""
9716           },
9717           {
9718             "group": "Body",
9719             "type": "String",
9720             "optional": true,
9721             "field": "interval",
9722             "description": ""
9723           }
9724         ]
9725       }
9726     },
9727     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9728     "version": "0.0.0",
9729     "filename": "server/api/faxAccount/index.js",
9730     "groupTitle": "Fax_Accounts"
9731   },
9732   {
9733     "type": "post",
9734     "url": "/api/fax/accounts/{id}/applications",
9735     "title": "Creates new applications",
9736     "examples": [
9737       {
9738         "title": "Example usage:",
9739         "content": "curl https://{domain}/api/fax/accounts/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
9740         "type": "json"
9741       }
9742     ],
9743     "name": "addApplications",
9744     "group": "Fax_Accounts",
9745     "parameter": {
9746       "fields": {
9747         "Body": [
9748           {
9749             "group": "Body",
9750             "type": "Integer",
9751             "optional": false,
9752             "field": "priority",
9753             "description": ""
9754           },
9755           {
9756             "group": "Body",
9757             "type": "String",
9758             "optional": false,
9759             "field": "app",
9760             "description": ""
9761           },
9762           {
9763             "group": "Body",
9764             "type": "Text",
9765             "optional": true,
9766             "field": "appdata",
9767             "description": ""
9768           },
9769           {
9770             "group": "Body",
9771             "type": "String",
9772             "optional": true,
9773             "field": "description",
9774             "description": ""
9775           },
9776           {
9777             "group": "Body",
9778             "type": "String",
9779             "optional": true,
9780             "field": "interval",
9781             "description": ""
9782           }
9783         ]
9784       }
9785     },
9786     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9787     "version": "0.0.0",
9788     "filename": "server/api/faxAccount/index.js",
9789     "groupTitle": "Fax_Accounts"
9790   },
9791   {
9792     "type": "post",
9793     "url": "/api/fax/accounts/{id}/dispositions",
9794     "title": "Creates new disposition",
9795     "examples": [
9796       {
9797         "title": "Example usage:",
9798         "content": "curl https://{domain}/api/fax/accounts/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
9799         "type": "json"
9800       }
9801     ],
9802     "name": "addDisposition",
9803     "group": "Fax_Accounts",
9804     "parameter": {
9805       "fields": {
9806         "Body": [
9807           {
9808             "group": "Body",
9809             "type": "String",
9810             "optional": false,
9811             "field": "name",
9812             "description": ""
9813           }
9814         ]
9815       }
9816     },
9817     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9818     "version": "0.0.0",
9819     "filename": "server/api/faxAccount/index.js",
9820     "groupTitle": "Fax_Accounts"
9821   },
9822   {
9823     "type": "post",
9824     "url": "/api/fax/accounts/{id}/interactions",
9825     "title": "Creates new interactions",
9826     "examples": [
9827       {
9828         "title": "Example usage:",
9829         "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",
9830         "type": "json"
9831       }
9832     ],
9833     "name": "addInteraction",
9834     "group": "Fax_Accounts",
9835     "parameter": {
9836       "fields": {
9837         "Body": [
9838           {
9839             "group": "Body",
9840             "type": "Boolean",
9841             "optional": true,
9842             "field": "closed",
9843             "description": ""
9844           },
9845           {
9846             "group": "Body",
9847             "type": "String",
9848             "optional": true,
9849             "field": "closedAt",
9850             "description": ""
9851           },
9852           {
9853             "group": "Body",
9854             "type": "String",
9855             "optional": true,
9856             "field": "disposition",
9857             "description": ""
9858           },
9859           {
9860             "group": "Body",
9861             "type": "String",
9862             "optional": true,
9863             "field": "note",
9864             "description": ""
9865           },
9866           {
9867             "group": "Body",
9868             "type": "String",
9869             "optional": true,
9870             "field": "read1stAt",
9871             "description": ""
9872           },
9873           {
9874             "group": "Body",
9875             "type": "String",
9876             "optional": true,
9877             "field": "fax",
9878             "description": ""
9879           },
9880           {
9881             "group": "Body",
9882             "type": "String",
9883             "allowedValues": [
9884               "\"in\"",
9885               "\"out\""
9886             ],
9887             "optional": false,
9888             "field": "firstMsgDirection",
9889             "description": ""
9890           },
9891           {
9892             "group": "Body",
9893             "type": "String",
9894             "optional": true,
9895             "field": "lastMsgAt",
9896             "description": ""
9897           },
9898           {
9899             "group": "Body",
9900             "type": "String",
9901             "allowedValues": [
9902               "\"in\"",
9903               "\"out\""
9904             ],
9905             "optional": false,
9906             "field": "lastMsgDirection",
9907             "description": ""
9908           }
9909         ]
9910       }
9911     },
9912     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9913     "version": "0.0.0",
9914     "filename": "server/api/faxAccount/index.js",
9915     "groupTitle": "Fax_Accounts"
9916   },
9917   {
9918     "type": "get",
9919     "url": "/api/fax/accounts/{id}/canned_answers",
9920     "title": "Gets account canned answers",
9921     "examples": [
9922       {
9923         "title": "Example usage:",
9924         "content": "curl https://{domain}/api/fax/accounts/{id}/canned_answers -v -u {name}:{password} -X GET",
9925         "type": "json"
9926       }
9927     ],
9928     "name": "getAnswers",
9929     "group": "Fax_Accounts",
9930     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9931     "version": "0.0.0",
9932     "filename": "server/api/faxAccount/index.js",
9933     "groupTitle": "Fax_Accounts"
9934   },
9935   {
9936     "type": "get",
9937     "url": "/api/fax/accounts/{id}/applications",
9938     "title": "Gets account pplications",
9939     "examples": [
9940       {
9941         "title": "Example usage:",
9942         "content": "curl https://{domain}/api/fax/accounts/{id}/applications -v -u {name}:{password} -X GET",
9943         "type": "json"
9944       }
9945     ],
9946     "name": "getApplications",
9947     "group": "Fax_Accounts",
9948     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9949     "version": "0.0.0",
9950     "filename": "server/api/faxAccount/index.js",
9951     "groupTitle": "Fax_Accounts"
9952   },
9953   {
9954     "type": "get",
9955     "url": "/api/fax/accounts/{id}/dispositions",
9956     "title": "Gets account dispositions",
9957     "examples": [
9958       {
9959         "title": "Example usage:",
9960         "content": "curl https://{domain}/api/fax/accounts/{id}/dispositions -v -u {name}:{password} -X GET",
9961         "type": "json"
9962       }
9963     ],
9964     "name": "getDispositions",
9965     "group": "Fax_Accounts",
9966     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9967     "version": "0.0.0",
9968     "filename": "server/api/faxAccount/index.js",
9969     "groupTitle": "Fax_Accounts"
9970   },
9971   {
9972     "type": "get",
9973     "url": "/api/fax/accounts/{id}/interactions",
9974     "title": "Gets account interactions",
9975     "examples": [
9976       {
9977         "title": "Example usage:",
9978         "content": "curl https://{domain}/api/fax/accounts/{id}/interactions -v -u {name}:{password} -X GET",
9979         "type": "json"
9980       }
9981     ],
9982     "name": "getInteraction",
9983     "group": "Fax_Accounts",
9984     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9985     "version": "0.0.0",
9986     "filename": "server/api/faxAccount/index.js",
9987     "groupTitle": "Fax_Accounts"
9988   },
9989   {
9990     "type": "get",
9991     "url": "/api/fax/accounts/{id}/messages",
9992     "title": "Gets account messages",
9993     "examples": [
9994       {
9995         "title": "Example usage:",
9996         "content": "curl https://{domain}/api/fax/accounts/{id}/messages -v -u {name}:{password} -X GET",
9997         "type": "json"
9998       }
9999     ],
10000     "name": "getMessages",
10001     "group": "Fax_Accounts",
10002     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10003     "version": "0.0.0",
10004     "filename": "server/api/faxAccount/index.js",
10005     "groupTitle": "Fax_Accounts"
10006   },
10007   {
10008     "type": "post",
10009     "url": "/api/fax/accounts/{id}/send",
10010     "title": "Send new fax",
10011     "examples": [
10012       {
10013         "title": "Example usage:",
10014         "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",
10015         "type": "json"
10016       }
10017     ],
10018     "name": "sendFax",
10019     "group": "Fax_Accounts",
10020     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10021     "version": "0.0.0",
10022     "filename": "server/api/faxAccount/index.js",
10023     "groupTitle": "Fax_Accounts"
10024   },
10025   {
10026     "type": "put",
10027     "url": "/api/fax/accounts/{id}",
10028     "title": "Update an existing Account",
10029     "examples": [
10030       {
10031         "title": "Example usage:",
10032         "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",
10033         "type": "json"
10034       }
10035     ],
10036     "name": "updateAccounts",
10037     "group": "Fax_Accounts",
10038     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10039     "version": "0.0.0",
10040     "filename": "server/api/faxAccount/index.js",
10041     "groupTitle": "Fax_Accounts"
10042   },
10043   {
10044     "type": "post",
10045     "url": "/api/fax/accounts/updateaccountapplications",
10046     "title": "Update account and applications",
10047     "examples": [
10048       {
10049         "title": "Example usage:",
10050         "content": "curl https://{domain}/api/fax/accounts/updateaccountapplications -d '[{\"name\": \"name\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
10051         "type": "json"
10052       }
10053     ],
10054     "name": "updateApplications",
10055     "group": "Fax_Accounts",
10056     "parameter": {
10057       "fields": {
10058         "Body": [
10059           {
10060             "group": "Body",
10061             "type": "Integer",
10062             "optional": false,
10063             "field": "priority",
10064             "description": ""
10065           },
10066           {
10067             "group": "Body",
10068             "type": "String",
10069             "optional": false,
10070             "field": "app",
10071             "description": ""
10072           },
10073           {
10074             "group": "Body",
10075             "type": "Text",
10076             "optional": true,
10077             "field": "appdata",
10078             "description": ""
10079           },
10080           {
10081             "group": "Body",
10082             "type": "String",
10083             "optional": true,
10084             "field": "description",
10085             "description": ""
10086           },
10087           {
10088             "group": "Body",
10089             "type": "String",
10090             "optional": true,
10091             "field": "interval",
10092             "description": ""
10093           }
10094         ]
10095       }
10096     },
10097     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10098     "version": "0.0.0",
10099     "filename": "server/api/faxAccount/index.js",
10100     "groupTitle": "Fax_Accounts"
10101   },
10102   {
10103     "type": "post",
10104     "url": "/api/fax/applications",
10105     "title": "Creates a new Application",
10106     "examples": [
10107       {
10108         "title": "Example usage:",
10109         "content": "curl https://{domain}/api/fax/applications -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
10110         "type": "json"
10111       }
10112     ],
10113     "name": "CreateApplications",
10114     "group": "Fax_Applications",
10115     "parameter": {
10116       "fields": {
10117         "Body": [
10118           {
10119             "group": "Body",
10120             "type": "Integer",
10121             "optional": false,
10122             "field": "priority",
10123             "description": ""
10124           },
10125           {
10126             "group": "Body",
10127             "type": "String",
10128             "optional": false,
10129             "field": "app",
10130             "description": ""
10131           },
10132           {
10133             "group": "Body",
10134             "type": "Text",
10135             "optional": true,
10136             "field": "appdata",
10137             "description": ""
10138           },
10139           {
10140             "group": "Body",
10141             "type": "String",
10142             "optional": true,
10143             "field": "description",
10144             "description": ""
10145           },
10146           {
10147             "group": "Body",
10148             "type": "String",
10149             "optional": true,
10150             "field": "interval",
10151             "description": ""
10152           }
10153         ]
10154       }
10155     },
10156     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10157     "version": "0.0.0",
10158     "filename": "server/api/faxApplication/index.js",
10159     "groupTitle": "Fax_Applications"
10160   },
10161   {
10162     "type": "delete",
10163     "url": "/api/fax/applications/{id}",
10164     "title": "Deletes a Application",
10165     "examples": [
10166       {
10167         "title": "Example usage:",
10168         "content": "curl https://{domain}/api/fax/applications/{id} -v -u {name}:{password} -X DELETE",
10169         "type": "json"
10170       }
10171     ],
10172     "name": "DeleteApplications",
10173     "group": "Fax_Applications",
10174     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10175     "version": "0.0.0",
10176     "filename": "server/api/faxApplication/index.js",
10177     "groupTitle": "Fax_Applications"
10178   },
10179   {
10180     "type": "get",
10181     "url": "/api/fax/applications",
10182     "title": "Gets a list of Applications",
10183     "examples": [
10184       {
10185         "title": "Example usage:",
10186         "content": "curl https://{domain}/api/fax/applications -v -u {name}:{password}",
10187         "type": "json"
10188       }
10189     ],
10190     "name": "GetApplications",
10191     "group": "Fax_Applications",
10192     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
10193     "version": "0.0.0",
10194     "filename": "server/api/faxApplication/index.js",
10195     "groupTitle": "Fax_Applications"
10196   },
10197   {
10198     "type": "get",
10199     "url": "/api/fax/applications/{id}",
10200     "title": "Gets a single Application",
10201     "examples": [
10202       {
10203         "title": "Example usage:",
10204         "content": "curl https://{domain}/api/fax/applications/{id} -v -u {name}:{password}",
10205         "type": "json"
10206       }
10207     ],
10208     "name": "ShowApplications",
10209     "group": "Fax_Applications",
10210     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10211     "version": "0.0.0",
10212     "filename": "server/api/faxApplication/index.js",
10213     "groupTitle": "Fax_Applications"
10214   },
10215   {
10216     "type": "put",
10217     "url": "/api/fax/applications/{id}",
10218     "title": "Update an existing Application",
10219     "examples": [
10220       {
10221         "title": "Example usage:",
10222         "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",
10223         "type": "json"
10224       }
10225     ],
10226     "name": "updateApplications",
10227     "group": "Fax_Applications",
10228     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10229     "version": "0.0.0",
10230     "filename": "server/api/faxApplication/index.js",
10231     "groupTitle": "Fax_Applications"
10232   },
10233   {
10234     "type": "post",
10235     "url": "/api/fax/interactions/{id}/tags",
10236     "title": "Add tags to the interaction",
10237     "examples": [
10238       {
10239         "title": "Example usage:",
10240         "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",
10241         "type": "json"
10242       }
10243     ],
10244     "name": "AddTags",
10245     "group": "Fax_Interactions",
10246     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10247     "version": "0.0.0",
10248     "filename": "server/api/faxInteraction/index.js",
10249     "groupTitle": "Fax_Interactions"
10250   },
10251   {
10252     "type": "post",
10253     "url": "/api/fax/interactions",
10254     "title": "Creates a new Interaction",
10255     "examples": [
10256       {
10257         "title": "Example usage:",
10258         "content": "curl https://{domain}/api/fax/interactions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
10259         "type": "json"
10260       }
10261     ],
10262     "name": "CreateInteractions",
10263     "group": "Fax_Interactions",
10264     "parameter": {
10265       "fields": {
10266         "Body": [
10267           {
10268             "group": "Body",
10269             "type": "Boolean",
10270             "optional": true,
10271             "field": "closed",
10272             "description": ""
10273           },
10274           {
10275             "group": "Body",
10276             "type": "String",
10277             "optional": true,
10278             "field": "closedAt",
10279             "description": ""
10280           },
10281           {
10282             "group": "Body",
10283             "type": "String",
10284             "optional": true,
10285             "field": "disposition",
10286             "description": ""
10287           },
10288           {
10289             "group": "Body",
10290             "type": "String",
10291             "optional": true,
10292             "field": "note",
10293             "description": ""
10294           },
10295           {
10296             "group": "Body",
10297             "type": "String",
10298             "optional": true,
10299             "field": "read1stAt",
10300             "description": ""
10301           },
10302           {
10303             "group": "Body",
10304             "type": "String",
10305             "optional": true,
10306             "field": "fax",
10307             "description": ""
10308           },
10309           {
10310             "group": "Body",
10311             "type": "String",
10312             "allowedValues": [
10313               "\"in\"",
10314               "\"out\""
10315             ],
10316             "optional": false,
10317             "field": "firstMsgDirection",
10318             "description": ""
10319           },
10320           {
10321             "group": "Body",
10322             "type": "String",
10323             "optional": true,
10324             "field": "lastMsgAt",
10325             "description": ""
10326           },
10327           {
10328             "group": "Body",
10329             "type": "String",
10330             "allowedValues": [
10331               "\"in\"",
10332               "\"out\""
10333             ],
10334             "optional": false,
10335             "field": "lastMsgDirection",
10336             "description": ""
10337           }
10338         ]
10339       }
10340     },
10341     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10342     "version": "0.0.0",
10343     "filename": "server/api/faxInteraction/index.js",
10344     "groupTitle": "Fax_Interactions"
10345   },
10346   {
10347     "type": "delete",
10348     "url": "/api/fax/interactions/{id}",
10349     "title": "Deletes a Interaction",
10350     "examples": [
10351       {
10352         "title": "Example usage:",
10353         "content": "curl https://{domain}/api/fax/interactions/{id} -v -u {name}:{password} -X DELETE",
10354         "type": "json"
10355       }
10356     ],
10357     "name": "DeleteInteractions",
10358     "group": "Fax_Interactions",
10359     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10360     "version": "0.0.0",
10361     "filename": "server/api/faxInteraction/index.js",
10362     "groupTitle": "Fax_Interactions"
10363   },
10364   {
10365     "type": "get",
10366     "url": "/api/fax/interactions/describe",
10367     "title": "Gets table info about Interactions",
10368     "examples": [
10369       {
10370         "title": "Example usage:",
10371         "content": "curl https://{domain}/api/fax/interactions/describe -v -u {name}:{password}",
10372         "type": "json"
10373       }
10374     ],
10375     "name": "DescribeInteractions",
10376     "group": "Fax_Interactions",
10377     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10378     "version": "0.0.0",
10379     "filename": "server/api/faxInteraction/index.js",
10380     "groupTitle": "Fax_Interactions"
10381   },
10382   {
10383     "type": "get",
10384     "url": "/api/fax/interactions",
10385     "title": "Gets a list of Interactions",
10386     "examples": [
10387       {
10388         "title": "Example usage:",
10389         "content": "curl https://{domain}/api/fax/interactions -v -u {name}:{password}",
10390         "type": "json"
10391       }
10392     ],
10393     "name": "GetInteractions",
10394     "group": "Fax_Interactions",
10395     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
10396     "version": "0.0.0",
10397     "filename": "server/api/faxInteraction/index.js",
10398     "groupTitle": "Fax_Interactions"
10399   },
10400   {
10401     "type": "delete",
10402     "url": "/api/fax/interactions/{id}/tags",
10403     "title": "Removes tags from interaction",
10404     "examples": [
10405       {
10406         "title": "Example usage:",
10407         "content": "curl https://{domain}/api/fax/interactions/{id}/tags?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
10408         "type": "json"
10409       }
10410     ],
10411     "name": "RemoveTags",
10412     "group": "Fax_Interactions",
10413     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10414     "version": "0.0.0",
10415     "filename": "server/api/faxInteraction/index.js",
10416     "groupTitle": "Fax_Interactions"
10417   },
10418   {
10419     "type": "get",
10420     "url": "/api/fax/interactions/{id}",
10421     "title": "Gets a single Interaction",
10422     "examples": [
10423       {
10424         "title": "Example usage:",
10425         "content": "curl https://{domain}/api/fax/interactions/{id} -v -u {name}:{password}",
10426         "type": "json"
10427       }
10428     ],
10429     "name": "ShowInteractions",
10430     "group": "Fax_Interactions",
10431     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10432     "version": "0.0.0",
10433     "filename": "server/api/faxInteraction/index.js",
10434     "groupTitle": "Fax_Interactions"
10435   },
10436   {
10437     "type": "post",
10438     "url": "/api/fax/interactions/{id}/messages",
10439     "title": "Creates new messages",
10440     "examples": [
10441       {
10442         "title": "Example usage:",
10443         "content": "curl https://{domain}/api/fax/interactions/{id}/messages -d '[{\"to\": \"+3901119886500\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
10444         "type": "json"
10445       }
10446     ],
10447     "name": "addMessage",
10448     "group": "Fax_Interactions",
10449     "parameter": {
10450       "fields": {
10451         "Body": [
10452           {
10453             "group": "Body",
10454             "type": "Text",
10455             "optional": false,
10456             "field": "body",
10457             "description": ""
10458           },
10459           {
10460             "group": "Body",
10461             "type": "Boolean",
10462             "optional": true,
10463             "field": "read",
10464             "description": ""
10465           },
10466           {
10467             "group": "Body",
10468             "type": "String",
10469             "allowedValues": [
10470               "\"in\"",
10471               "\"out\""
10472             ],
10473             "optional": false,
10474             "field": "direction",
10475             "description": ""
10476           },
10477           {
10478             "group": "Body",
10479             "type": "Text",
10480             "optional": true,
10481             "field": "failMessage",
10482             "description": ""
10483           },
10484           {
10485             "group": "Body",
10486             "type": "String",
10487             "optional": true,
10488             "field": "readAt",
10489             "description": ""
10490           }
10491         ]
10492       }
10493     },
10494     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10495     "version": "0.0.0",
10496     "filename": "server/api/faxInteraction/index.js",
10497     "groupTitle": "Fax_Interactions"
10498   },
10499   {
10500     "type": "get",
10501     "url": "/api/fax/interactions/{id}/download",
10502     "title": "Get interactions",
10503     "examples": [
10504       {
10505         "title": "Example usage:",
10506         "content": "curl https://{domain}/api/fax/interactions/{id}/download -v -u {name}:{password} -X GET",
10507         "type": "json"
10508       }
10509     ],
10510     "name": "download",
10511     "group": "Fax_Interactions",
10512     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10513     "version": "0.0.0",
10514     "filename": "server/api/faxInteraction/index.js",
10515     "groupTitle": "Fax_Interactions"
10516   },
10517   {
10518     "type": "get",
10519     "url": "/api/fax/interactions/{id}/messages",
10520     "title": "Gets interaction messages",
10521     "examples": [
10522       {
10523         "title": "Example usage:",
10524         "content": "curl https://{domain}/api/fax/interactions/{id}/messages -v -u {name}:{password} -X GET",
10525         "type": "json"
10526       }
10527     ],
10528     "name": "getMessages",
10529     "group": "Fax_Interactions",
10530     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10531     "version": "0.0.0",
10532     "filename": "server/api/faxInteraction/index.js",
10533     "groupTitle": "Fax_Interactions"
10534   },
10535   {
10536     "type": "put",
10537     "url": "/api/fax/interactions/{id}",
10538     "title": "Update an existing Interaction",
10539     "examples": [
10540       {
10541         "title": "Example usage:",
10542         "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",
10543         "type": "json"
10544       }
10545     ],
10546     "name": "updateInteractions",
10547     "group": "Fax_Interactions",
10548     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10549     "version": "0.0.0",
10550     "filename": "server/api/faxInteraction/index.js",
10551     "groupTitle": "Fax_Interactions"
10552   },
10553   {
10554     "type": "get",
10555     "url": "/api/fax/messages/{id}/download",
10556     "title": "Get message",
10557     "examples": [
10558       {
10559         "title": "Example usage:",
10560         "content": "curl https://{domain}/api/fax/messages/{id}/download -v -u {name}:{password} -X GET",
10561         "type": "json"
10562       }
10563     ],
10564     "name": "download",
10565     "group": "Fax_Message",
10566     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10567     "version": "0.0.0",
10568     "filename": "server/api/faxMessage/index.js",
10569     "groupTitle": "Fax_Message"
10570   },
10571   {
10572     "type": "delete",
10573     "url": "/api/fax/messages/{id}",
10574     "title": "Deletes a Message",
10575     "examples": [
10576       {
10577         "title": "Example usage:",
10578         "content": "curl https://{domain}/api/fax/messages/{id} -v -u {name}:{password} -X DELETE",
10579         "type": "json"
10580       }
10581     ],
10582     "name": "DeleteMessages",
10583     "group": "Fax_Messages",
10584     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10585     "version": "0.0.0",
10586     "filename": "server/api/faxMessage/index.js",
10587     "groupTitle": "Fax_Messages"
10588   },
10589   {
10590     "type": "get",
10591     "url": "/api/fax/messages/describe",
10592     "title": "Gets table info about Messages",
10593     "examples": [
10594       {
10595         "title": "Example usage:",
10596         "content": "curl https://{domain}/api/fax/messages/describe -v -u {name}:{password}",
10597         "type": "json"
10598       }
10599     ],
10600     "name": "DescribeMessages",
10601     "group": "Fax_Messages",
10602     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10603     "version": "0.0.0",
10604     "filename": "server/api/faxMessage/index.js",
10605     "groupTitle": "Fax_Messages"
10606   },
10607   {
10608     "type": "get",
10609     "url": "/api/fax/messages",
10610     "title": "Gets a list of Messages",
10611     "examples": [
10612       {
10613         "title": "Example usage:",
10614         "content": "curl https://{domain}/api/fax/messages -v -u {name}:{password}",
10615         "type": "json"
10616       }
10617     ],
10618     "name": "GetMessages",
10619     "group": "Fax_Messages",
10620     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
10621     "version": "0.0.0",
10622     "filename": "server/api/faxMessage/index.js",
10623     "groupTitle": "Fax_Messages"
10624   },
10625   {
10626     "type": "get",
10627     "url": "/api/fax/messages/{id}",
10628     "title": "Gets a single Message",
10629     "examples": [
10630       {
10631         "title": "Example usage:",
10632         "content": "curl https://{domain}/api/fax/messages/{id} -v -u {name}:{password}",
10633         "type": "json"
10634       }
10635     ],
10636     "name": "ShowMessages",
10637     "group": "Fax_Messages",
10638     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10639     "version": "0.0.0",
10640     "filename": "server/api/faxMessage/index.js",
10641     "groupTitle": "Fax_Messages"
10642   },
10643   {
10644     "type": "put",
10645     "url": "/api/fax/messages/{id}/accept",
10646     "title": "Accepts message",
10647     "examples": [
10648       {
10649         "title": "Example usage:",
10650         "content": "curl https://{domain}/api/fax/messages/{id}/accept \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
10651         "type": "json"
10652       }
10653     ],
10654     "name": "acceptMessage",
10655     "group": "Fax_Messages",
10656     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10657     "version": "0.0.0",
10658     "filename": "server/api/faxMessage/index.js",
10659     "groupTitle": "Fax_Messages"
10660   },
10661   {
10662     "type": "put",
10663     "url": "/api/fax/messages/{id}/reject",
10664     "title": "Rejects message",
10665     "examples": [
10666       {
10667         "title": "Example usage:",
10668         "content": "curl https://{domain}/api/fax/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
10669         "type": "json"
10670       }
10671     ],
10672     "name": "rejectMessage",
10673     "group": "Fax_Messages",
10674     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10675     "version": "0.0.0",
10676     "filename": "server/api/faxMessage/index.js",
10677     "groupTitle": "Fax_Messages"
10678   },
10679   {
10680     "type": "post",
10681     "url": "/api/fax/messages",
10682     "title": "Create message and send Fax",
10683     "examples": [
10684       {
10685         "title": "Example usage:",
10686         "content": "curl https://{domain}/api/fax/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
10687         "type": "json"
10688       }
10689     ],
10690     "name": "rejectMessage",
10691     "group": "Fax_Messages",
10692     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10693     "version": "0.0.0",
10694     "filename": "server/api/faxMessage/index.js",
10695     "groupTitle": "Fax_Messages"
10696   },
10697   {
10698     "type": "put",
10699     "url": "/api/fax/messages/{id}",
10700     "title": "Update an existing Message",
10701     "examples": [
10702       {
10703         "title": "Example usage:",
10704         "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",
10705         "type": "json"
10706       }
10707     ],
10708     "name": "updateMessages",
10709     "group": "Fax_Messages",
10710     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10711     "version": "0.0.0",
10712     "filename": "server/api/faxMessage/index.js",
10713     "groupTitle": "Fax_Messages"
10714   },
10715   {
10716     "type": "post",
10717     "url": "/api/fax/reports/queue",
10718     "title": "Creates a new Fax Queue Report",
10719     "examples": [
10720       {
10721         "title": "Example usage:",
10722         "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",
10723         "type": "json"
10724       }
10725     ],
10726     "name": "CreateFax_Queue_Reports",
10727     "group": "Fax_Queue_Reports",
10728     "parameter": {
10729       "fields": {
10730         "Body": [
10731           {
10732             "group": "Body",
10733             "type": "String",
10734             "optional": false,
10735             "field": "uniqueid",
10736             "description": ""
10737           },
10738           {
10739             "group": "Body",
10740             "type": "String",
10741             "optional": true,
10742             "field": "from",
10743             "description": ""
10744           },
10745           {
10746             "group": "Body",
10747             "type": "String",
10748             "optional": true,
10749             "field": "joinAt",
10750             "description": ""
10751           },
10752           {
10753             "group": "Body",
10754             "type": "String",
10755             "optional": true,
10756             "field": "leaveAt",
10757             "description": ""
10758           },
10759           {
10760             "group": "Body",
10761             "type": "String",
10762             "optional": true,
10763             "field": "acceptAt",
10764             "description": ""
10765           },
10766           {
10767             "group": "Body",
10768             "type": "String",
10769             "optional": true,
10770             "field": "exitAt",
10771             "description": ""
10772           },
10773           {
10774             "group": "Body",
10775             "type": "String",
10776             "optional": true,
10777             "field": "reason",
10778             "description": ""
10779           }
10780         ]
10781       }
10782     },
10783     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10784     "version": "0.0.0",
10785     "filename": "server/api/faxQueueReport/index.js",
10786     "groupTitle": "Fax_Queue_Reports"
10787   },
10788   {
10789     "type": "delete",
10790     "url": "/api/fax/reports/queue/{id}",
10791     "title": "Deletes a Fax Queue Report",
10792     "examples": [
10793       {
10794         "title": "Example usage:",
10795         "content": "curl https://{domain}/api/fax/reports/queue/{id} -v -u {name}:{password} -X DELETE",
10796         "type": "json"
10797       }
10798     ],
10799     "name": "DeleteFax_Queue_Reports",
10800     "group": "Fax_Queue_Reports",
10801     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10802     "version": "0.0.0",
10803     "filename": "server/api/faxQueueReport/index.js",
10804     "groupTitle": "Fax_Queue_Reports"
10805   },
10806   {
10807     "type": "get",
10808     "url": "/api/fax/reports/queue/describe",
10809     "title": "Gets table info about Fax Queue Reports",
10810     "examples": [
10811       {
10812         "title": "Example usage:",
10813         "content": "curl https://{domain}/api/fax/reports/queue/describe -v -u {name}:{password}",
10814         "type": "json"
10815       }
10816     ],
10817     "name": "DescribeFax_Queue_Reports",
10818     "group": "Fax_Queue_Reports",
10819     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10820     "version": "0.0.0",
10821     "filename": "server/api/faxQueueReport/index.js",
10822     "groupTitle": "Fax_Queue_Reports"
10823   },
10824   {
10825     "type": "get",
10826     "url": "/api/fax/reports/queue",
10827     "title": "Gets a list of Fax Queue Reports",
10828     "examples": [
10829       {
10830         "title": "Example usage:",
10831         "content": "curl https://{domain}/api/fax/reports/queue -v -u {name}:{password}",
10832         "type": "json"
10833       }
10834     ],
10835     "name": "GetFax_Queue_Reports",
10836     "group": "Fax_Queue_Reports",
10837     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
10838     "version": "0.0.0",
10839     "filename": "server/api/faxQueueReport/index.js",
10840     "groupTitle": "Fax_Queue_Reports"
10841   },
10842   {
10843     "type": "get",
10844     "url": "/api/fax/reports/queue/{id}",
10845     "title": "Gets a single Fax Queue Report",
10846     "examples": [
10847       {
10848         "title": "Example usage:",
10849         "content": "curl https://{domain}/api/fax/reports/queue/{id} -v -u {name}:{password}",
10850         "type": "json"
10851       }
10852     ],
10853     "name": "ShowFax_Queue_Reports",
10854     "group": "Fax_Queue_Reports",
10855     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10856     "version": "0.0.0",
10857     "filename": "server/api/faxQueueReport/index.js",
10858     "groupTitle": "Fax_Queue_Reports"
10859   },
10860   {
10861     "type": "put",
10862     "url": "/api/fax/reports/queue/{id}",
10863     "title": "Update an existing Fax Queue Report",
10864     "examples": [
10865       {
10866         "title": "Example usage:",
10867         "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",
10868         "type": "json"
10869       }
10870     ],
10871     "name": "updateFax_Queue_Reports",
10872     "group": "Fax_Queue_Reports",
10873     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10874     "version": "0.0.0",
10875     "filename": "server/api/faxQueueReport/index.js",
10876     "groupTitle": "Fax_Queue_Reports"
10877   },
10878   {
10879     "type": "post",
10880     "url": "/api/fax/queues/{id}/users",
10881     "title": "Add agents to a queue",
10882     "examples": [
10883       {
10884         "title": "Example usage:",
10885         "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",
10886         "type": "json"
10887       }
10888     ],
10889     "name": "AddAgents",
10890     "group": "Fax_Queues",
10891     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10892     "version": "0.0.0",
10893     "filename": "server/api/faxQueue/index.js",
10894     "groupTitle": "Fax_Queues"
10895   },
10896   {
10897     "type": "post",
10898     "url": "/api/fax/queues/{id}/teams",
10899     "title": "Add teams to a queue",
10900     "examples": [
10901       {
10902         "title": "Example usage:",
10903         "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",
10904         "type": "json"
10905       }
10906     ],
10907     "name": "AddTeams",
10908     "group": "Fax_Queues",
10909     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10910     "version": "0.0.0",
10911     "filename": "server/api/faxQueue/index.js",
10912     "groupTitle": "Fax_Queues"
10913   },
10914   {
10915     "type": "post",
10916     "url": "/api/fax/queues",
10917     "title": "Creates a new Queue",
10918     "examples": [
10919       {
10920         "title": "Example usage:",
10921         "content": "curl https://{domain}/api/fax/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
10922         "type": "json"
10923       }
10924     ],
10925     "name": "CreateQueues",
10926     "group": "Fax_Queues",
10927     "parameter": {
10928       "fields": {
10929         "Body": [
10930           {
10931             "group": "Body",
10932             "type": "String",
10933             "optional": false,
10934             "field": "name",
10935             "description": ""
10936           },
10937           {
10938             "group": "Body",
10939             "type": "String",
10940             "optional": true,
10941             "field": "description",
10942             "description": ""
10943           },
10944           {
10945             "group": "Body",
10946             "type": "Integer",
10947             "optional": false,
10948             "field": "timeout",
10949             "description": ""
10950           },
10951           {
10952             "group": "Body",
10953             "type": "String",
10954             "allowedValues": [
10955               "\"rrmemory\"",
10956               "\"beepall\"",
10957               "\"roundrobin\""
10958             ],
10959             "optional": false,
10960             "field": "strategy",
10961             "description": ""
10962           },
10963           {
10964             "group": "Body",
10965             "type": "Integer",
10966             "optional": true,
10967             "field": "lastAgent",
10968             "description": ""
10969           }
10970         ]
10971       }
10972     },
10973     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10974     "version": "0.0.0",
10975     "filename": "server/api/faxQueue/index.js",
10976     "groupTitle": "Fax_Queues"
10977   },
10978   {
10979     "type": "delete",
10980     "url": "/api/fax/queues/{id}",
10981     "title": "Deletes a Queue",
10982     "examples": [
10983       {
10984         "title": "Example usage:",
10985         "content": "curl https://{domain}/api/fax/queues/{id} -v -u {name}:{password} -X DELETE",
10986         "type": "json"
10987       }
10988     ],
10989     "name": "DeleteQueues",
10990     "group": "Fax_Queues",
10991     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10992     "version": "0.0.0",
10993     "filename": "server/api/faxQueue/index.js",
10994     "groupTitle": "Fax_Queues"
10995   },
10996   {
10997     "type": "get",
10998     "url": "/api/fax/queues/describe",
10999     "title": "Gets table info about Queues",
11000     "examples": [
11001       {
11002         "title": "Example usage:",
11003         "content": "curl https://{domain}/api/fax/queues/describe -v -u {name}:{password}",
11004         "type": "json"
11005       }
11006     ],
11007     "name": "DescribeQueues",
11008     "group": "Fax_Queues",
11009     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11010     "version": "0.0.0",
11011     "filename": "server/api/faxQueue/index.js",
11012     "groupTitle": "Fax_Queues"
11013   },
11014   {
11015     "type": "get",
11016     "url": "/api/fax/queues/{id}/users",
11017     "title": "Gets queue agents",
11018     "examples": [
11019       {
11020         "title": "Example usage:",
11021         "content": "curl https://{domain}/api/fax/queues/{id}/users -v -u {name}:{password} -X POST",
11022         "type": "json"
11023       }
11024     ],
11025     "name": "GetAgents",
11026     "group": "Fax_Queues",
11027     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11028     "version": "0.0.0",
11029     "filename": "server/api/faxQueue/index.js",
11030     "groupTitle": "Fax_Queues"
11031   },
11032   {
11033     "type": "get",
11034     "url": "/api/fax/queues/{id}/members",
11035     "title": "GetMembers",
11036     "examples": [
11037       {
11038         "title": "Example usage:",
11039         "content": "curl https://{domain}/api/fax/queues/{id}/members  -v -u {name}:{password}",
11040         "type": "json"
11041       }
11042     ],
11043     "name": "GetMembers",
11044     "group": "Fax_Queues",
11045     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11046     "version": "0.0.0",
11047     "filename": "server/api/faxQueue/index.js",
11048     "groupTitle": "Fax_Queues"
11049   },
11050   {
11051     "type": "get",
11052     "url": "/api/fax/queues",
11053     "title": "Gets a list of Queues",
11054     "examples": [
11055       {
11056         "title": "Example usage:",
11057         "content": "curl https://{domain}/api/fax/queues -v -u {name}:{password}",
11058         "type": "json"
11059       }
11060     ],
11061     "name": "GetQueues",
11062     "group": "Fax_Queues",
11063     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
11064     "version": "0.0.0",
11065     "filename": "server/api/faxQueue/index.js",
11066     "groupTitle": "Fax_Queues"
11067   },
11068   {
11069     "type": "get",
11070     "url": "/api/fax/queues/{id}/teams",
11071     "title": "Gets queues list",
11072     "examples": [
11073       {
11074         "title": "Example usage:",
11075         "content": "curl https://{domain}/api/fax/queues/{id}/teams -v -u {name}:{password}",
11076         "type": "json"
11077       }
11078     ],
11079     "name": "GetTeams",
11080     "group": "Fax_Queues",
11081     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11082     "version": "0.0.0",
11083     "filename": "server/api/faxQueue/index.js",
11084     "groupTitle": "Fax_Queues"
11085   },
11086   {
11087     "type": "delete",
11088     "url": "/api/fax/queues/{id}/users",
11089     "title": "Removes agents from a queue",
11090     "examples": [
11091       {
11092         "title": "Example usage:",
11093         "content": "curl https://{domain}/api/fax/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
11094         "type": "json"
11095       }
11096     ],
11097     "name": "RemoveAgents",
11098     "group": "Fax_Queues",
11099     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11100     "version": "0.0.0",
11101     "filename": "server/api/faxQueue/index.js",
11102     "groupTitle": "Fax_Queues"
11103   },
11104   {
11105     "type": "get",
11106     "url": "/api/fax/queues/{id}",
11107     "title": "Gets a single Queue",
11108     "examples": [
11109       {
11110         "title": "Example usage:",
11111         "content": "curl https://{domain}/api/fax/queues/{id} -v -u {name}:{password}",
11112         "type": "json"
11113       }
11114     ],
11115     "name": "ShowQueues",
11116     "group": "Fax_Queues",
11117     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11118     "version": "0.0.0",
11119     "filename": "server/api/faxQueue/index.js",
11120     "groupTitle": "Fax_Queues"
11121   },
11122   {
11123     "type": "put",
11124     "url": "/api/fax/queues/{id}",
11125     "title": "Update an existing Queue",
11126     "examples": [
11127       {
11128         "title": "Example usage:",
11129         "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",
11130         "type": "json"
11131       }
11132     ],
11133     "name": "updateQueues",
11134     "group": "Fax_Queues",
11135     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11136     "version": "0.0.0",
11137     "filename": "server/api/faxQueue/index.js",
11138     "groupTitle": "Fax_Queues"
11139   },
11140   {
11141     "type": "post",
11142     "url": "/api/fax/reports/transfer",
11143     "title": "Creates a new Fax Transfer Report",
11144     "examples": [
11145       {
11146         "title": "Example usage:",
11147         "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",
11148         "type": "json"
11149       }
11150     ],
11151     "name": "CreateFax_Transfer_Reports",
11152     "group": "Fax_Transfer_Reports",
11153     "parameter": {
11154       "fields": {
11155         "Body": [
11156           {
11157             "group": "Body",
11158             "type": "String",
11159             "optional": false,
11160             "field": "uniqueid",
11161             "description": ""
11162           },
11163           {
11164             "group": "Body",
11165             "type": "String",
11166             "allowedValues": [
11167               "\"account\"",
11168               "\"agent\"",
11169               "\"queue\""
11170             ],
11171             "optional": false,
11172             "field": "type",
11173             "description": ""
11174           },
11175           {
11176             "group": "Body",
11177             "type": "String",
11178             "optional": false,
11179             "field": "transferredAt",
11180             "description": ""
11181           }
11182         ]
11183       }
11184     },
11185     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11186     "version": "0.0.0",
11187     "filename": "server/api/faxTransferReport/index.js",
11188     "groupTitle": "Fax_Transfer_Reports"
11189   },
11190   {
11191     "type": "delete",
11192     "url": "/api/fax/reports/transfer/{id}",
11193     "title": "Deletes a Fax Transfer Report",
11194     "examples": [
11195       {
11196         "title": "Example usage:",
11197         "content": "curl https://{domain}/api/fax/reports/transfer/{id} -v -u {name}:{password} -X DELETE",
11198         "type": "json"
11199       }
11200     ],
11201     "name": "DeleteFax_Transfer_Reports",
11202     "group": "Fax_Transfer_Reports",
11203     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11204     "version": "0.0.0",
11205     "filename": "server/api/faxTransferReport/index.js",
11206     "groupTitle": "Fax_Transfer_Reports"
11207   },
11208   {
11209     "type": "get",
11210     "url": "/api/fax/reports/transfer/describe",
11211     "title": "Gets table info about Fax Transfer Reports",
11212     "examples": [
11213       {
11214         "title": "Example usage:",
11215         "content": "curl https://{domain}/api/fax/reports/transfer/describe -v -u {name}:{password}",
11216         "type": "json"
11217       }
11218     ],
11219     "name": "DescribeFax_Transfer_Reports",
11220     "group": "Fax_Transfer_Reports",
11221     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11222     "version": "0.0.0",
11223     "filename": "server/api/faxTransferReport/index.js",
11224     "groupTitle": "Fax_Transfer_Reports"
11225   },
11226   {
11227     "type": "get",
11228     "url": "/api/fax/reports/transfer",
11229     "title": "Gets a list of Fax Transfer Reports",
11230     "examples": [
11231       {
11232         "title": "Example usage:",
11233         "content": "curl https://{domain}/api/fax/reports/transfer -v -u {name}:{password}",
11234         "type": "json"
11235       }
11236     ],
11237     "name": "GetFax_Transfer_Reports",
11238     "group": "Fax_Transfer_Reports",
11239     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
11240     "version": "0.0.0",
11241     "filename": "server/api/faxTransferReport/index.js",
11242     "groupTitle": "Fax_Transfer_Reports"
11243   },
11244   {
11245     "type": "get",
11246     "url": "/api/fax/reports/transfer/{id}",
11247     "title": "Gets a single Fax Transfer Report",
11248     "examples": [
11249       {
11250         "title": "Example usage:",
11251         "content": "curl https://{domain}/api/fax/reports/transfer/{id} -v -u {name}:{password}",
11252         "type": "json"
11253       }
11254     ],
11255     "name": "ShowFax_Transfer_Reports",
11256     "group": "Fax_Transfer_Reports",
11257     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11258     "version": "0.0.0",
11259     "filename": "server/api/faxTransferReport/index.js",
11260     "groupTitle": "Fax_Transfer_Reports"
11261   },
11262   {
11263     "type": "put",
11264     "url": "/api/fax/reports/transfer/{id}",
11265     "title": "Update an existing Fax Transfer Report",
11266     "examples": [
11267       {
11268         "title": "Example usage:",
11269         "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",
11270         "type": "json"
11271       }
11272     ],
11273     "name": "updateFax_Transfer_Reports",
11274     "group": "Fax_Transfer_Reports",
11275     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11276     "version": "0.0.0",
11277     "filename": "server/api/faxTransferReport/index.js",
11278     "groupTitle": "Fax_Transfer_Reports"
11279   },
11280   {
11281     "type": "post",
11282     "url": "/api/integrations/freshdesk/accounts",
11283     "title": "Creates a new Freshdesk Account",
11284     "examples": [
11285       {
11286         "title": "Example usage:",
11287         "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",
11288         "type": "json"
11289       }
11290     ],
11291     "name": "CreateFreshdesk_Accounts",
11292     "group": "Freshdesk_Accounts",
11293     "parameter": {
11294       "fields": {
11295         "Body": [
11296           {
11297             "group": "Body",
11298             "type": "String",
11299             "optional": true,
11300             "field": "name",
11301             "description": ""
11302           },
11303           {
11304             "group": "Body",
11305             "type": "String",
11306             "optional": true,
11307             "field": "description",
11308             "description": ""
11309           },
11310           {
11311             "group": "Body",
11312             "type": "String",
11313             "optional": true,
11314             "field": "username",
11315             "description": ""
11316           },
11317           {
11318             "group": "Body",
11319             "type": "String",
11320             "optional": true,
11321             "field": "apiKey",
11322             "description": ""
11323           },
11324           {
11325             "group": "Body",
11326             "type": "String",
11327             "optional": true,
11328             "field": "remoteUri",
11329             "description": ""
11330           },
11331           {
11332             "group": "Body",
11333             "type": "String",
11334             "optional": true,
11335             "field": "serverUrl",
11336             "description": ""
11337           }
11338         ]
11339       }
11340     },
11341     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11342     "version": "0.0.0",
11343     "filename": "server/api/intFreshdeskAccount/index.js",
11344     "groupTitle": "Freshdesk_Accounts"
11345   },
11346   {
11347     "type": "delete",
11348     "url": "/api/integrations/freshdesk/accounts/{id}",
11349     "title": "Deletes a Freshdesk Account",
11350     "examples": [
11351       {
11352         "title": "Example usage:",
11353         "content": "curl https://{domain}/api/integrations/freshdesk/accounts/{id} -v -u {name}:{password} -X DELETE",
11354         "type": "json"
11355       }
11356     ],
11357     "name": "DeleteFreshdesk_Accounts",
11358     "group": "Freshdesk_Accounts",
11359     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11360     "version": "0.0.0",
11361     "filename": "server/api/intFreshdeskAccount/index.js",
11362     "groupTitle": "Freshdesk_Accounts"
11363   },
11364   {
11365     "type": "get",
11366     "url": "/api/integrations/freshdesk/accounts",
11367     "title": "Gets a list of Freshdesk Accounts",
11368     "examples": [
11369       {
11370         "title": "Example usage:",
11371         "content": "curl https://{domain}/api/integrations/freshdesk/accounts -v -u {name}:{password}",
11372         "type": "json"
11373       }
11374     ],
11375     "name": "GetFreshdesk_Accounts",
11376     "group": "Freshdesk_Accounts",
11377     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
11378     "version": "0.0.0",
11379     "filename": "server/api/intFreshdeskAccount/index.js",
11380     "groupTitle": "Freshdesk_Accounts"
11381   },
11382   {
11383     "type": "get",
11384     "url": "/api/integrations/freshdesk/accounts/{id}",
11385     "title": "Gets a single Freshdesk Account",
11386     "examples": [
11387       {
11388         "title": "Example usage:",
11389         "content": "curl https://{domain}/api/integrations/freshdesk/accounts/{id} -v -u {name}:{password}",
11390         "type": "json"
11391       }
11392     ],
11393     "name": "ShowFreshdesk_Accounts",
11394     "group": "Freshdesk_Accounts",
11395     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11396     "version": "0.0.0",
11397     "filename": "server/api/intFreshdeskAccount/index.js",
11398     "groupTitle": "Freshdesk_Accounts"
11399   },
11400   {
11401     "type": "post",
11402     "url": "/api/integrations/freshdesk/accounts/{id}/configurations",
11403     "title": "Creates new configuration",
11404     "examples": [
11405       {
11406         "title": "Example usage:",
11407         "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",
11408         "type": "json"
11409       }
11410     ],
11411     "name": "addConfiguration",
11412     "group": "Freshdesk_Accounts",
11413     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11414     "version": "0.0.0",
11415     "filename": "server/api/intFreshdeskAccount/index.js",
11416     "groupTitle": "Freshdesk_Accounts"
11417   },
11418   {
11419     "type": "get",
11420     "url": "/api/integrations/freshdesk/accounts/{id}/configurations",
11421     "title": "Gets account configurations",
11422     "examples": [
11423       {
11424         "title": "Example usage:",
11425         "content": "curl https://{domain}/api/integrations/freshdesk/accounts/{id}/configurations -v -u {name}:{password} -X GET",
11426         "type": "json"
11427       }
11428     ],
11429     "name": "getConfigurations",
11430     "group": "Freshdesk_Accounts",
11431     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11432     "version": "0.0.0",
11433     "filename": "server/api/intFreshdeskAccount/index.js",
11434     "groupTitle": "Freshdesk_Accounts"
11435   },
11436   {
11437     "type": "get",
11438     "url": "/api/integrations/freshdesk/accounts/{id}/fields",
11439     "title": "Gets account fields",
11440     "examples": [
11441       {
11442         "title": "Example usage:",
11443         "content": "curl https://{domain}/api/integrations/freshdesk/accounts/{id}/fields -v -u {name}:{password} -X GET",
11444         "type": "json"
11445       }
11446     ],
11447     "name": "getFields",
11448     "group": "Freshdesk_Accounts",
11449     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11450     "version": "0.0.0",
11451     "filename": "server/api/intFreshdeskAccount/index.js",
11452     "groupTitle": "Freshdesk_Accounts"
11453   },
11454   {
11455     "type": "put",
11456     "url": "/api/integrations/freshdesk/accounts/{id}",
11457     "title": "Update an existing Freshdesk Account",
11458     "examples": [
11459       {
11460         "title": "Example usage:",
11461         "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",
11462         "type": "json"
11463       }
11464     ],
11465     "name": "updateFreshdesk_Accounts",
11466     "group": "Freshdesk_Accounts",
11467     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11468     "version": "0.0.0",
11469     "filename": "server/api/intFreshdeskAccount/index.js",
11470     "groupTitle": "Freshdesk_Accounts"
11471   },
11472   {
11473     "type": "post",
11474     "url": "/api/integrations/freshdesk/configurations",
11475     "title": "Creates a new Freshdesk Configuration",
11476     "examples": [
11477       {
11478         "title": "Example usage:",
11479         "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",
11480         "type": "json"
11481       }
11482     ],
11483     "name": "CreateFreshdesk_Configurations",
11484     "group": "Freshdesk_Configurations",
11485     "parameter": {
11486       "fields": {
11487         "Body": [
11488           {
11489             "group": "Body",
11490             "type": "String",
11491             "optional": true,
11492             "field": "name",
11493             "description": ""
11494           },
11495           {
11496             "group": "Body",
11497             "type": "String",
11498             "optional": true,
11499             "field": "description",
11500             "description": ""
11501           }
11502         ]
11503       }
11504     },
11505     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11506     "version": "0.0.0",
11507     "filename": "server/api/intFreshdeskConfiguration/index.js",
11508     "groupTitle": "Freshdesk_Configurations"
11509   },
11510   {
11511     "type": "delete",
11512     "url": "/api/integrations/freshdesk/configurations/{id}",
11513     "title": "Deletes a Freshdesk Configuration",
11514     "examples": [
11515       {
11516         "title": "Example usage:",
11517         "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id} -v -u {name}:{password} -X DELETE",
11518         "type": "json"
11519       }
11520     ],
11521     "name": "DeleteFreshdesk_Configurations",
11522     "group": "Freshdesk_Configurations",
11523     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11524     "version": "0.0.0",
11525     "filename": "server/api/intFreshdeskConfiguration/index.js",
11526     "groupTitle": "Freshdesk_Configurations"
11527   },
11528   {
11529     "type": "get",
11530     "url": "/api/integrations/freshdesk/configurations",
11531     "title": "Gets a list of Freshdesk Configurations",
11532     "examples": [
11533       {
11534         "title": "Example usage:",
11535         "content": "curl https://{domain}/api/integrations/freshdesk/configurations -v -u {name}:{password}",
11536         "type": "json"
11537       }
11538     ],
11539     "name": "GetFreshdesk_Configurations",
11540     "group": "Freshdesk_Configurations",
11541     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
11542     "version": "0.0.0",
11543     "filename": "server/api/intFreshdeskConfiguration/index.js",
11544     "groupTitle": "Freshdesk_Configurations"
11545   },
11546   {
11547     "type": "get",
11548     "url": "/api/integrations/freshdesk/configurations/{id}",
11549     "title": "Gets a single Freshdesk Configuration",
11550     "examples": [
11551       {
11552         "title": "Example usage:",
11553         "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id} -v -u {name}:{password}",
11554         "type": "json"
11555       }
11556     ],
11557     "name": "ShowFreshdesk_Configurations",
11558     "group": "Freshdesk_Configurations",
11559     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11560     "version": "0.0.0",
11561     "filename": "server/api/intFreshdeskConfiguration/index.js",
11562     "groupTitle": "Freshdesk_Configurations"
11563   },
11564   {
11565     "type": "get",
11566     "url": "/api/integrations/freshdesk/configurations/{id}/descriptions",
11567     "title": "Gets configurations descriptions",
11568     "examples": [
11569       {
11570         "title": "Example usage:",
11571         "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
11572         "type": "json"
11573       }
11574     ],
11575     "name": "getDescriptions",
11576     "group": "Freshdesk_Configurations",
11577     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11578     "version": "0.0.0",
11579     "filename": "server/api/intFreshdeskConfiguration/index.js",
11580     "groupTitle": "Freshdesk_Configurations"
11581   },
11582   {
11583     "type": "get",
11584     "url": "/api/integrations/freshdesk/configurations/{id}/fields",
11585     "title": "Gets configurations fields",
11586     "examples": [
11587       {
11588         "title": "Example usage:",
11589         "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id}/fields -v -u {name}:{password} -X GET",
11590         "type": "json"
11591       }
11592     ],
11593     "name": "getFields",
11594     "group": "Freshdesk_Configurations",
11595     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11596     "version": "0.0.0",
11597     "filename": "server/api/intFreshdeskConfiguration/index.js",
11598     "groupTitle": "Freshdesk_Configurations"
11599   },
11600   {
11601     "type": "get",
11602     "url": "/api/integrations/freshdesk/configurations/{id}/subjects",
11603     "title": "Gets configurations subjects",
11604     "examples": [
11605       {
11606         "title": "Example usage:",
11607         "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id}/subjects -v -u {name}:{password} -X GET",
11608         "type": "json"
11609       }
11610     ],
11611     "name": "getSubjects",
11612     "group": "Freshdesk_Configurations",
11613     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11614     "version": "0.0.0",
11615     "filename": "server/api/intFreshdeskConfiguration/index.js",
11616     "groupTitle": "Freshdesk_Configurations"
11617   },
11618   {
11619     "type": "get",
11620     "url": "/api/integrations/freshdesk/configurations/{id}/tags",
11621     "title": "Gets configurations tags",
11622     "examples": [
11623       {
11624         "title": "Example usage:",
11625         "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id}/tags -v -u {name}:{password} -X GET",
11626         "type": "json"
11627       }
11628     ],
11629     "name": "getTags",
11630     "group": "Freshdesk_Configurations",
11631     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11632     "version": "0.0.0",
11633     "filename": "server/api/intFreshdeskConfiguration/index.js",
11634     "groupTitle": "Freshdesk_Configurations"
11635   },
11636   {
11637     "type": "post",
11638     "url": "/api/integrations/freshdesk/configurations/{id}/tags",
11639     "title": "Sets new tags",
11640     "examples": [
11641       {
11642         "title": "Example usage:",
11643         "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",
11644         "type": "json"
11645       }
11646     ],
11647     "name": "setTags",
11648     "group": "Freshdesk_Configurations",
11649     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11650     "version": "0.0.0",
11651     "filename": "server/api/intFreshdeskConfiguration/index.js",
11652     "groupTitle": "Freshdesk_Configurations"
11653   },
11654   {
11655     "type": "put",
11656     "url": "/api/integrations/freshdesk/configurations/{id}",
11657     "title": "Update an existing Freshdesk Configuration",
11658     "examples": [
11659       {
11660         "title": "Example usage:",
11661         "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",
11662         "type": "json"
11663       }
11664     ],
11665     "name": "updateFreshdesk_Configurations",
11666     "group": "Freshdesk_Configurations",
11667     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11668     "version": "0.0.0",
11669     "filename": "server/api/intFreshdeskConfiguration/index.js",
11670     "groupTitle": "Freshdesk_Configurations"
11671   },
11672   {
11673     "type": "post",
11674     "url": "/api/integrations/freshdesk/fields",
11675     "title": "Creates a new Freshdesk Field",
11676     "examples": [
11677       {
11678         "title": "Example usage:",
11679         "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",
11680         "type": "json"
11681       }
11682     ],
11683     "name": "CreateFreshdesk_Fields",
11684     "group": "Freshdesk_Fields",
11685     "parameter": {
11686       "fields": {
11687         "Body": [
11688           {
11689             "group": "Body",
11690             "type": "String",
11691             "allowedValues": [
11692               "\"string\"",
11693               "\"variable\"",
11694               "\"customVariable\"",
11695               "\"keyValue\""
11696             ],
11697             "optional": true,
11698             "field": "type",
11699             "description": ""
11700           },
11701           {
11702             "group": "Body",
11703             "type": "String",
11704             "optional": true,
11705             "field": "content",
11706             "description": ""
11707           },
11708           {
11709             "group": "Body",
11710             "type": "String",
11711             "optional": true,
11712             "field": "key",
11713             "description": ""
11714           },
11715           {
11716             "group": "Body",
11717             "type": "String",
11718             "allowedValues": [
11719               "\"string\"",
11720               "\"variable\"",
11721               "\"customVariable\""
11722             ],
11723             "optional": true,
11724             "field": "keyType",
11725             "description": ""
11726           },
11727           {
11728             "group": "Body",
11729             "type": "String",
11730             "optional": true,
11731             "field": "keyContent",
11732             "description": ""
11733           },
11734           {
11735             "group": "Body",
11736             "type": "String",
11737             "optional": true,
11738             "field": "idField",
11739             "description": ""
11740           },
11741           {
11742             "group": "Body",
11743             "type": "String",
11744             "optional": true,
11745             "field": "nameField",
11746             "description": ""
11747           },
11748           {
11749             "group": "Body",
11750             "type": "Boolean",
11751             "optional": true,
11752             "field": "customField",
11753             "description": ""
11754           },
11755           {
11756             "group": "Body",
11757             "type": "String",
11758             "optional": true,
11759             "field": "variableName",
11760             "description": ""
11761           }
11762         ]
11763       }
11764     },
11765     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11766     "version": "0.0.0",
11767     "filename": "server/api/intFreshdeskField/index.js",
11768     "groupTitle": "Freshdesk_Fields"
11769   },
11770   {
11771     "type": "delete",
11772     "url": "/api/integrations/freshdesk/fields/{id}",
11773     "title": "Deletes a Freshdesk Field",
11774     "examples": [
11775       {
11776         "title": "Example usage:",
11777         "content": "curl https://{domain}/api/integrations/freshdesk/fields/{id} -v -u {name}:{password} -X DELETE",
11778         "type": "json"
11779       }
11780     ],
11781     "name": "DeleteFreshdesk_Fields",
11782     "group": "Freshdesk_Fields",
11783     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11784     "version": "0.0.0",
11785     "filename": "server/api/intFreshdeskField/index.js",
11786     "groupTitle": "Freshdesk_Fields"
11787   },
11788   {
11789     "type": "get",
11790     "url": "/api/integrations/freshdesk/fields",
11791     "title": "Gets a list of Freshdesk Fields",
11792     "examples": [
11793       {
11794         "title": "Example usage:",
11795         "content": "curl https://{domain}/api/integrations/freshdesk/fields -v -u {name}:{password}",
11796         "type": "json"
11797       }
11798     ],
11799     "name": "GetFreshdesk_Fields",
11800     "group": "Freshdesk_Fields",
11801     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/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>",
11802     "version": "0.0.0",
11803     "filename": "server/api/intFreshdeskField/index.js",
11804     "groupTitle": "Freshdesk_Fields"
11805   },
11806   {
11807     "type": "get",
11808     "url": "/api/integrations/freshdesk/fields/{id}",
11809     "title": "Gets a single Freshdesk Field",
11810     "examples": [
11811       {
11812         "title": "Example usage:",
11813         "content": "curl https://{domain}/api/integrations/freshdesk/fields/{id} -v -u {name}:{password}",
11814         "type": "json"
11815       }
11816     ],
11817     "name": "ShowFreshdesk_Fields",
11818     "group": "Freshdesk_Fields",
11819     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11820     "version": "0.0.0",
11821     "filename": "server/api/intFreshdeskField/index.js",
11822     "groupTitle": "Freshdesk_Fields"
11823   },
11824   {
11825     "type": "put",
11826     "url": "/api/integrations/freshdesk/fields/{id}",
11827     "title": "Update an existing Freshdesk Field",
11828     "examples": [
11829       {
11830         "title": "Example usage:",
11831         "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",
11832         "type": "json"
11833       }
11834     ],
11835     "name": "updateFreshdesk_Fields",
11836     "group": "Freshdesk_Fields",
11837     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11838     "version": "0.0.0",
11839     "filename": "server/api/intFreshdeskField/index.js",
11840     "groupTitle": "Freshdesk_Fields"
11841   },
11842   {
11843     "type": "post",
11844     "url": "/api/integrations/freshsales/accounts",
11845     "title": "Creates a new Freshsales Account",
11846     "examples": [
11847       {
11848         "title": "Example usage:",
11849         "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",
11850         "type": "json"
11851       }
11852     ],
11853     "name": "CreateFreshsales_Accounts",
11854     "group": "Freshsales_Accounts",
11855     "parameter": {
11856       "fields": {
11857         "Body": [
11858           {
11859             "group": "Body",
11860             "type": "String",
11861             "optional": true,
11862             "field": "name",
11863             "description": ""
11864           },
11865           {
11866             "group": "Body",
11867             "type": "String",
11868             "optional": true,
11869             "field": "description",
11870             "description": ""
11871           },
11872           {
11873             "group": "Body",
11874             "type": "String",
11875             "optional": true,
11876             "field": "username",
11877             "description": ""
11878           },
11879           {
11880             "group": "Body",
11881             "type": "String",
11882             "optional": true,
11883             "field": "apiKey",
11884             "description": ""
11885           },
11886           {
11887             "group": "Body",
11888             "type": "String",
11889             "optional": true,
11890             "field": "remoteUri",
11891             "description": ""
11892           },
11893           {
11894             "group": "Body",
11895             "type": "String",
11896             "optional": true,
11897             "field": "serverUrl",
11898             "description": ""
11899           }
11900         ]
11901       }
11902     },
11903     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11904     "version": "0.0.0",
11905     "filename": "server/api/intFreshsalesAccount/index.js",
11906     "groupTitle": "Freshsales_Accounts"
11907   },
11908   {
11909     "type": "delete",
11910     "url": "/api/integrations/freshsales/accounts/{id}",
11911     "title": "Deletes a Freshsales Account",
11912     "examples": [
11913       {
11914         "title": "Example usage:",
11915         "content": "curl https://{domain}/api/integrations/freshsales/accounts/{id} -v -u {name}:{password} -X DELETE",
11916         "type": "json"
11917       }
11918     ],
11919     "name": "DeleteFreshsales_Accounts",
11920     "group": "Freshsales_Accounts",
11921     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11922     "version": "0.0.0",
11923     "filename": "server/api/intFreshsalesAccount/index.js",
11924     "groupTitle": "Freshsales_Accounts"
11925   },
11926   {
11927     "type": "get",
11928     "url": "/api/integrations/freshsales/accounts",
11929     "title": "Gets a list of Freshsales Accounts",
11930     "examples": [
11931       {
11932         "title": "Example usage:",
11933         "content": "curl https://{domain}/api/integrations/freshsales/accounts -v -u {name}:{password}",
11934         "type": "json"
11935       }
11936     ],
11937     "name": "GetFreshsales_Accounts",
11938     "group": "Freshsales_Accounts",
11939     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
11940     "version": "0.0.0",
11941     "filename": "server/api/intFreshsalesAccount/index.js",
11942     "groupTitle": "Freshsales_Accounts"
11943   },
11944   {
11945     "type": "get",
11946     "url": "/api/integrations/freshsales/accounts/{id}",
11947     "title": "Gets a single Freshsales Account",
11948     "examples": [
11949       {
11950         "title": "Example usage:",
11951         "content": "curl https://{domain}/api/integrations/freshsales/accounts/{id} -v -u {name}:{password}",
11952         "type": "json"
11953       }
11954     ],
11955     "name": "ShowFreshsales_Accounts",
11956     "group": "Freshsales_Accounts",
11957     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11958     "version": "0.0.0",
11959     "filename": "server/api/intFreshsalesAccount/index.js",
11960     "groupTitle": "Freshsales_Accounts"
11961   },
11962   {
11963     "type": "post",
11964     "url": "/api/integrations/freshsales/accounts/{id}/configurations",
11965     "title": "Creates new configuration",
11966     "examples": [
11967       {
11968         "title": "Example usage:",
11969         "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",
11970         "type": "json"
11971       }
11972     ],
11973     "name": "addConfiguration",
11974     "group": "Freshsales_Accounts",
11975     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11976     "version": "0.0.0",
11977     "filename": "server/api/intFreshsalesAccount/index.js",
11978     "groupTitle": "Freshsales_Accounts"
11979   },
11980   {
11981     "type": "get",
11982     "url": "/api/integrations/freshsales/accounts/{id}/configurations",
11983     "title": "Gets account configurations",
11984     "examples": [
11985       {
11986         "title": "Example usage:",
11987         "content": "curl https://{domain}/api/integrations/freshsales/accounts/{id}/configurations -v -u {name}:{password} -X GET",
11988         "type": "json"
11989       }
11990     ],
11991     "name": "getConfigurations",
11992     "group": "Freshsales_Accounts",
11993     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11994     "version": "0.0.0",
11995     "filename": "server/api/intFreshsalesAccount/index.js",
11996     "groupTitle": "Freshsales_Accounts"
11997   },
11998   {
11999     "type": "get",
12000     "url": "/api/integrations/freshsales/accounts/{id}/fields",
12001     "title": "Gets account fields",
12002     "examples": [
12003       {
12004         "title": "Example usage:",
12005         "content": "curl https://{domain}/api/integrations/freshsales/accounts/{id}/fields -v -u {name}:{password} -X GET",
12006         "type": "json"
12007       }
12008     ],
12009     "name": "getFields",
12010     "group": "Freshsales_Accounts",
12011     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12012     "version": "0.0.0",
12013     "filename": "server/api/intFreshsalesAccount/index.js",
12014     "groupTitle": "Freshsales_Accounts"
12015   },
12016   {
12017     "type": "put",
12018     "url": "/api/integrations/freshsales/accounts/{id}",
12019     "title": "Update an existing Freshsales Account",
12020     "examples": [
12021       {
12022         "title": "Example usage:",
12023         "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",
12024         "type": "json"
12025       }
12026     ],
12027     "name": "updateFreshsales_Accounts",
12028     "group": "Freshsales_Accounts",
12029     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12030     "version": "0.0.0",
12031     "filename": "server/api/intFreshsalesAccount/index.js",
12032     "groupTitle": "Freshsales_Accounts"
12033   },
12034   {
12035     "type": "post",
12036     "url": "/api/integrations/freshsales/configurations",
12037     "title": "Creates a new Freshsales Configuration",
12038     "examples": [
12039       {
12040         "title": "Example usage:",
12041         "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",
12042         "type": "json"
12043       }
12044     ],
12045     "name": "CreateFreshsales_Configurations",
12046     "group": "Freshsales_Configurations",
12047     "parameter": {
12048       "fields": {
12049         "Body": [
12050           {
12051             "group": "Body",
12052             "type": "String",
12053             "optional": true,
12054             "field": "name",
12055             "description": ""
12056           },
12057           {
12058             "group": "Body",
12059             "type": "String",
12060             "optional": true,
12061             "field": "description",
12062             "description": ""
12063           }
12064         ]
12065       }
12066     },
12067     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12068     "version": "0.0.0",
12069     "filename": "server/api/intFreshsalesConfiguration/index.js",
12070     "groupTitle": "Freshsales_Configurations"
12071   },
12072   {
12073     "type": "delete",
12074     "url": "/api/integrations/freshsales/configurations/{id}",
12075     "title": "Deletes a Freshsales Configuration",
12076     "examples": [
12077       {
12078         "title": "Example usage:",
12079         "content": "curl https://{domain}/api/integrations/freshsales/configurations/{id} -v -u {name}:{password} -X DELETE",
12080         "type": "json"
12081       }
12082     ],
12083     "name": "DeleteFreshsales_Configurations",
12084     "group": "Freshsales_Configurations",
12085     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12086     "version": "0.0.0",
12087     "filename": "server/api/intFreshsalesConfiguration/index.js",
12088     "groupTitle": "Freshsales_Configurations"
12089   },
12090   {
12091     "type": "get",
12092     "url": "/api/integrations/freshsales/configurations",
12093     "title": "Gets a list of Freshsales Configurations",
12094     "examples": [
12095       {
12096         "title": "Example usage:",
12097         "content": "curl https://{domain}/api/integrations/freshsales/configurations -v -u {name}:{password}",
12098         "type": "json"
12099       }
12100     ],
12101     "name": "GetFreshsales_Configurations",
12102     "group": "Freshsales_Configurations",
12103     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
12104     "version": "0.0.0",
12105     "filename": "server/api/intFreshsalesConfiguration/index.js",
12106     "groupTitle": "Freshsales_Configurations"
12107   },
12108   {
12109     "type": "get",
12110     "url": "/api/integrations/freshsales/configurations/{id}",
12111     "title": "Gets a single Freshsales Configuration",
12112     "examples": [
12113       {
12114         "title": "Example usage:",
12115         "content": "curl https://{domain}/api/integrations/freshsales/configurations/{id} -v -u {name}:{password}",
12116         "type": "json"
12117       }
12118     ],
12119     "name": "ShowFreshsales_Configurations",
12120     "group": "Freshsales_Configurations",
12121     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12122     "version": "0.0.0",
12123     "filename": "server/api/intFreshsalesConfiguration/index.js",
12124     "groupTitle": "Freshsales_Configurations"
12125   },
12126   {
12127     "type": "get",
12128     "url": "/api/integrations/freshsales/configurations/{id}/descriptions",
12129     "title": "Gets configurations descriptions",
12130     "examples": [
12131       {
12132         "title": "Example usage:",
12133         "content": "curl https://{domain}/api/integrations/freshsales/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
12134         "type": "json"
12135       }
12136     ],
12137     "name": "getDescriptions",
12138     "group": "Freshsales_Configurations",
12139     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12140     "version": "0.0.0",
12141     "filename": "server/api/intFreshsalesConfiguration/index.js",
12142     "groupTitle": "Freshsales_Configurations"
12143   },
12144   {
12145     "type": "get",
12146     "url": "/api/integrations/freshsales/configurations/{id}/fields",
12147     "title": "Gets configurations fields",
12148     "examples": [
12149       {
12150         "title": "Example usage:",
12151         "content": "curl https://{domain}/api/integrations/freshsales/configurations/{id}/fields -v -u {name}:{password} -X GET",
12152         "type": "json"
12153       }
12154     ],
12155     "name": "getFields",
12156     "group": "Freshsales_Configurations",
12157     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12158     "version": "0.0.0",
12159     "filename": "server/api/intFreshsalesConfiguration/index.js",
12160     "groupTitle": "Freshsales_Configurations"
12161   },
12162   {
12163     "type": "get",
12164     "url": "/api/integrations/freshsales/configurations/{id}/subjects",
12165     "title": "Gets configurations subjects",
12166     "examples": [
12167       {
12168         "title": "Example usage:",
12169         "content": "curl https://{domain}/api/integrations/freshsales/configurations/{id}/subjects -v -u {name}:{password} -X GET",
12170         "type": "json"
12171       }
12172     ],
12173     "name": "getSubjects",
12174     "group": "Freshsales_Configurations",
12175     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12176     "version": "0.0.0",
12177     "filename": "server/api/intFreshsalesConfiguration/index.js",
12178     "groupTitle": "Freshsales_Configurations"
12179   },
12180   {
12181     "type": "put",
12182     "url": "/api/integrations/freshsales/configurations/{id}",
12183     "title": "Update an existing Freshsales Configuration",
12184     "examples": [
12185       {
12186         "title": "Example usage:",
12187         "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",
12188         "type": "json"
12189       }
12190     ],
12191     "name": "updateFreshsales_Configurations",
12192     "group": "Freshsales_Configurations",
12193     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12194     "version": "0.0.0",
12195     "filename": "server/api/intFreshsalesConfiguration/index.js",
12196     "groupTitle": "Freshsales_Configurations"
12197   },
12198   {
12199     "type": "post",
12200     "url": "/api/integrations/freshsales/fields",
12201     "title": "Creates a new Freshsales Field",
12202     "examples": [
12203       {
12204         "title": "Example usage:",
12205         "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",
12206         "type": "json"
12207       }
12208     ],
12209     "name": "CreateFreshsales_Fields",
12210     "group": "Freshsales_Fields",
12211     "parameter": {
12212       "fields": {
12213         "Body": [
12214           {
12215             "group": "Body",
12216             "type": "String",
12217             "allowedValues": [
12218               "\"string\"",
12219               "\"variable\"",
12220               "\"customVariable\"",
12221               "\"keyValue\""
12222             ],
12223             "optional": true,
12224             "field": "type",
12225             "description": ""
12226           },
12227           {
12228             "group": "Body",
12229             "type": "String",
12230             "optional": true,
12231             "field": "content",
12232             "description": ""
12233           },
12234           {
12235             "group": "Body",
12236             "type": "String",
12237             "optional": true,
12238             "field": "key",
12239             "description": ""
12240           },
12241           {
12242             "group": "Body",
12243             "type": "String",
12244             "allowedValues": [
12245               "\"string\"",
12246               "\"variable\"",
12247               "\"customVariable\""
12248             ],
12249             "optional": true,
12250             "field": "keyType",
12251             "description": ""
12252           },
12253           {
12254             "group": "Body",
12255             "type": "String",
12256             "optional": true,
12257             "field": "keyContent",
12258             "description": ""
12259           },
12260           {
12261             "group": "Body",
12262             "type": "String",
12263             "optional": true,
12264             "field": "idField",
12265             "description": ""
12266           },
12267           {
12268             "group": "Body",
12269             "type": "String",
12270             "optional": true,
12271             "field": "nameField",
12272             "description": ""
12273           },
12274           {
12275             "group": "Body",
12276             "type": "Boolean",
12277             "optional": true,
12278             "field": "customField",
12279             "description": ""
12280           },
12281           {
12282             "group": "Body",
12283             "type": "String",
12284             "optional": true,
12285             "field": "variableName",
12286             "description": ""
12287           }
12288         ]
12289       }
12290     },
12291     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12292     "version": "0.0.0",
12293     "filename": "server/api/intFreshsalesField/index.js",
12294     "groupTitle": "Freshsales_Fields"
12295   },
12296   {
12297     "type": "delete",
12298     "url": "/api/integrations/freshsales/fields/{id}",
12299     "title": "Deletes a Freshsales Field",
12300     "examples": [
12301       {
12302         "title": "Example usage:",
12303         "content": "curl https://{domain}/api/integrations/freshsales/fields/{id} -v -u {name}:{password} -X DELETE",
12304         "type": "json"
12305       }
12306     ],
12307     "name": "DeleteFreshsales_Fields",
12308     "group": "Freshsales_Fields",
12309     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12310     "version": "0.0.0",
12311     "filename": "server/api/intFreshsalesField/index.js",
12312     "groupTitle": "Freshsales_Fields"
12313   },
12314   {
12315     "type": "get",
12316     "url": "/api/integrations/freshsales/fields",
12317     "title": "Gets a list of Freshsales Fields",
12318     "examples": [
12319       {
12320         "title": "Example usage:",
12321         "content": "curl https://{domain}/api/integrations/freshsales/fields -v -u {name}:{password}",
12322         "type": "json"
12323       }
12324     ],
12325     "name": "GetFreshsales_Fields",
12326     "group": "Freshsales_Fields",
12327     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
12328     "version": "0.0.0",
12329     "filename": "server/api/intFreshsalesField/index.js",
12330     "groupTitle": "Freshsales_Fields"
12331   },
12332   {
12333     "type": "get",
12334     "url": "/api/integrations/freshsales/fields/{id}",
12335     "title": "Gets a single Freshsales Field",
12336     "examples": [
12337       {
12338         "title": "Example usage:",
12339         "content": "curl https://{domain}/api/integrations/freshsales/fields/{id} -v -u {name}:{password}",
12340         "type": "json"
12341       }
12342     ],
12343     "name": "ShowFreshsales_Fields",
12344     "group": "Freshsales_Fields",
12345     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12346     "version": "0.0.0",
12347     "filename": "server/api/intFreshsalesField/index.js",
12348     "groupTitle": "Freshsales_Fields"
12349   },
12350   {
12351     "type": "put",
12352     "url": "/api/integrations/freshsales/fields/{id}",
12353     "title": "Update an existing Freshsales Field",
12354     "examples": [
12355       {
12356         "title": "Example usage:",
12357         "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",
12358         "type": "json"
12359       }
12360     ],
12361     "name": "updateFreshsales_Fields",
12362     "group": "Freshsales_Fields",
12363     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12364     "version": "0.0.0",
12365     "filename": "server/api/intFreshsalesField/index.js",
12366     "groupTitle": "Freshsales_Fields"
12367   },
12368   {
12369     "type": "post",
12370     "url": "/api/campaigns/{id}/blacklists",
12371     "title": "Add blacklists to an IVR campaign",
12372     "examples": [
12373       {
12374         "title": "Example usage:",
12375         "content": "curl https://{domain}/api/campaigns/{id}/blacklists -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
12376         "type": "json"
12377       }
12378     ],
12379     "name": "AddBlackLists",
12380     "group": "IVR_Campaigns",
12381     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12382     "version": "0.0.0",
12383     "filename": "server/api/campaign/index.js",
12384     "groupTitle": "IVR_Campaigns"
12385   },
12386   {
12387     "type": "post",
12388     "url": "/api/campaigns/{id}/lists",
12389     "title": "Add lists to an IVR campaign",
12390     "examples": [
12391       {
12392         "title": "Example usage:",
12393         "content": "curl https://{domain}/api/campaigns/{id}/lists -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
12394         "type": "json"
12395       }
12396     ],
12397     "name": "AddLists",
12398     "group": "IVR_Campaigns",
12399     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12400     "version": "0.0.0",
12401     "filename": "server/api/campaign/index.js",
12402     "groupTitle": "IVR_Campaigns"
12403   },
12404   {
12405     "type": "post",
12406     "url": "/api/campaigns/clone",
12407     "title": "Clone an existing IVR Campaign",
12408     "examples": [
12409       {
12410         "title": "Example usage:",
12411         "content": "curl https://{domain}/api/campaigns/clone -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
12412         "type": "json"
12413       }
12414     ],
12415     "name": "CloneIVR_Campaigns",
12416     "group": "IVR_Campaigns",
12417     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12418     "version": "0.0.0",
12419     "filename": "server/api/campaign/index.js",
12420     "groupTitle": "IVR_Campaigns"
12421   },
12422   {
12423     "type": "post",
12424     "url": "/api/campaigns",
12425     "title": "Creates a new IVR Campaign",
12426     "examples": [
12427       {
12428         "title": "Example usage:",
12429         "content": "curl https://{domain}/api/campaigns -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
12430         "type": "json"
12431       }
12432     ],
12433     "name": "CreateIVR_Campaigns",
12434     "group": "IVR_Campaigns",
12435     "parameter": {
12436       "fields": {
12437         "Body": [
12438           {
12439             "group": "Body",
12440             "type": "String",
12441             "optional": false,
12442             "field": "name",
12443             "description": ""
12444           },
12445           {
12446             "group": "Body",
12447             "type": "String",
12448             "allowedValues": [
12449               "\"ivr\""
12450             ],
12451             "optional": false,
12452             "field": "type",
12453             "description": ""
12454           },
12455           {
12456             "group": "Body",
12457             "type": "String",
12458             "optional": true,
12459             "field": "description",
12460             "description": ""
12461           },
12462           {
12463             "group": "Body",
12464             "type": "Boolean",
12465             "optional": true,
12466             "field": "active",
12467             "description": "<p>Active/Disactive Campaign</p>"
12468           },
12469           {
12470             "group": "Body",
12471             "type": "Integer",
12472             "optional": true,
12473             "field": "limitCalls",
12474             "description": "<p>Max 200 calls.</p>"
12475           },
12476           {
12477             "group": "Body",
12478             "type": "String",
12479             "optional": true,
12480             "field": "dialOriginateCallerIdName",
12481             "description": ""
12482           },
12483           {
12484             "group": "Body",
12485             "type": "String",
12486             "optional": true,
12487             "field": "dialOriginateCallerIdNumber",
12488             "description": ""
12489           },
12490           {
12491             "group": "Body",
12492             "type": "Integer",
12493             "optional": true,
12494             "field": "dialOriginateTimeout",
12495             "description": "<p>Originate Timeout Seconds (min:1, max:999)</p>"
12496           },
12497           {
12498             "group": "Body",
12499             "type": "Integer",
12500             "optional": true,
12501             "field": "dialCongestionMaxRetry",
12502             "description": "<p>#Congestion Retry (min:1, max:999)</p>"
12503           },
12504           {
12505             "group": "Body",
12506             "type": "Integer",
12507             "optional": true,
12508             "field": "dialCongestionRetryFrequency",
12509             "description": "<p>Congestion Retry Frequency Minutes (min:1, max:99999)</p>"
12510           },
12511           {
12512             "group": "Body",
12513             "type": "Integer",
12514             "optional": true,
12515             "field": "dialBusyMaxRetry",
12516             "description": "<p>#Busy Retry (min:1, max:999)</p>"
12517           },
12518           {
12519             "group": "Body",
12520             "type": "Integer",
12521             "optional": true,
12522             "field": "dialBusyRetryFrequency",
12523             "description": "<p>Busy Retry Frequency Minutes (min:1, max:99999)</p>"
12524           },
12525           {
12526             "group": "Body",
12527             "type": "Integer",
12528             "optional": true,
12529             "field": "dialNoAnswerMaxRetry",
12530             "description": "<p>#NoAnswer Retry (min:1, max:999)</p>"
12531           },
12532           {
12533             "group": "Body",
12534             "type": "Integer",
12535             "optional": true,
12536             "field": "dialNoAnswerRetryFrequency",
12537             "description": "<p>NoAnswer Retry Frequency Minutes (min:1, max:99999)</p>"
12538           },
12539           {
12540             "group": "Body",
12541             "type": "Integer",
12542             "optional": true,
12543             "field": "dialGlobalMaxRetry",
12544             "description": "<p>#Global Max Retry (min:1, max:999)</p>"
12545           },
12546           {
12547             "group": "Body",
12548             "type": "String",
12549             "optional": true,
12550             "field": "dialTimezone",
12551             "description": ""
12552           },
12553           {
12554             "group": "Body",
12555             "type": "String",
12556             "optional": true,
12557             "field": "dialGlobalInterval",
12558             "description": ""
12559           },
12560           {
12561             "group": "Body",
12562             "type": "String",
12563             "allowedValues": [
12564               "\"always\"",
12565               "\"never\"",
12566               "\"onlyIfOpen\""
12567             ],
12568             "optional": true,
12569             "field": "dialCheckDuplicateType",
12570             "description": ""
12571           },
12572           {
12573             "group": "Body",
12574             "type": "Boolean",
12575             "optional": true,
12576             "field": "dialAMDActive",
12577             "description": "<p>Active/Disactive AMD</p>"
12578           },
12579           {
12580             "group": "Body",
12581             "type": "Integer",
12582             "optional": true,
12583             "field": "dialAMDInitialSilence",
12584             "description": "<p>#AMD Initial Silence</p>"
12585           },
12586           {
12587             "group": "Body",
12588             "type": "Integer",
12589             "optional": true,
12590             "field": "dialAMDGreeting",
12591             "description": "<p>#AMD Greeting</p>"
12592           },
12593           {
12594             "group": "Body",
12595             "type": "Integer",
12596             "optional": true,
12597             "field": "dialAMDAfterGreetingSilence",
12598             "description": "<p>#AMD After Greeting Silence</p>"
12599           },
12600           {
12601             "group": "Body",
12602             "type": "Integer",
12603             "optional": true,
12604             "field": "dialAMDTotalAnalysisTime",
12605             "description": "<p>#AMD Total Analysis Time</p>"
12606           },
12607           {
12608             "group": "Body",
12609             "type": "Integer",
12610             "optional": true,
12611             "field": "dialAMDMinWordLength",
12612             "description": "<p>#AMD Min Word Length</p>"
12613           },
12614           {
12615             "group": "Body",
12616             "type": "Integer",
12617             "optional": true,
12618             "field": "dialAMDBetweenWordsSilence",
12619             "description": "<p>#AMD Between Words Silence</p>"
12620           },
12621           {
12622             "group": "Body",
12623             "type": "Integer",
12624             "optional": true,
12625             "field": "dialAMDMaximumNumberOfWords",
12626             "description": "<p>#AMD Maximum Number Of Words</p>"
12627           },
12628           {
12629             "group": "Body",
12630             "type": "Integer",
12631             "optional": true,
12632             "field": "dialAMDSilenceThreshold",
12633             "description": "<p>#AMD Silence Threshold (min:0, max:32767)</p>"
12634           },
12635           {
12636             "group": "Body",
12637             "type": "Integer",
12638             "optional": true,
12639             "field": "dialAMDMaximumWordLength",
12640             "description": "<p>#AMD Maximum Word Length</p>"
12641           },
12642           {
12643             "group": "Body",
12644             "type": "String",
12645             "allowedValues": [
12646               "\"DESC\"",
12647               "\"ASC\""
12648             ],
12649             "optional": true,
12650             "field": "dialOrderByScheduledAt",
12651             "description": ""
12652           },
12653           {
12654             "group": "Body",
12655             "type": "String",
12656             "optional": true,
12657             "field": "dialPrefix",
12658             "description": ""
12659           },
12660           {
12661             "group": "Body",
12662             "type": "Integer",
12663             "optional": true,
12664             "field": "dialRandomLastDigitCallerIdNumber",
12665             "description": "<p>Random Last Digit (min:1, max:15)</p>"
12666           },
12667           {
12668             "group": "Body",
12669             "type": "Integer",
12670             "optional": true,
12671             "field": "dialCutDigit",
12672             "description": "<p>Cut Digit (min:1, max:15)</p>"
12673           },
12674           {
12675             "group": "Body",
12676             "type": "Integer",
12677             "optional": true,
12678             "field": "dialNoSuchNumberMaxRetry",
12679             "description": "<p>#NoSuchNumber Retry (min:1, max:999)</p>"
12680           },
12681           {
12682             "group": "Body",
12683             "type": "Integer",
12684             "optional": true,
12685             "field": "dialNoSuchNumberRetryFrequency",
12686             "description": "<p>NoSuchNumber Retry Frequency Minutes (min:1, max:99999)</p>"
12687           },
12688           {
12689             "group": "Body",
12690             "type": "Integer",
12691             "optional": true,
12692             "field": "dialDropMaxRetry",
12693             "description": "<p>#Drop Retry (min:1, max:999)</p>"
12694           },
12695           {
12696             "group": "Body",
12697             "type": "Integer",
12698             "optional": true,
12699             "field": "dialDropRetryFrequency",
12700             "description": "<p>Drop Retry Frequency Minutes (min:1, max:99999)</p>"
12701           },
12702           {
12703             "group": "Body",
12704             "type": "Integer",
12705             "optional": true,
12706             "field": "dialAbandonedMaxRetry",
12707             "description": "<p>#Abandoned Retry (min:1, max:999)</p>"
12708           },
12709           {
12710             "group": "Body",
12711             "type": "Integer",
12712             "optional": true,
12713             "field": "dialAbandonedRetryFrequency",
12714             "description": "<p>Abandoned Retry Frequency Minutes (min:1, max:99999)</p>"
12715           },
12716           {
12717             "group": "Body",
12718             "type": "Integer",
12719             "optional": true,
12720             "field": "dialMachineMaxRetry",
12721             "description": "<p>#Machine Retry (min:1, max:999)</p>"
12722           },
12723           {
12724             "group": "Body",
12725             "type": "Integer",
12726             "optional": true,
12727             "field": "dialMachineRetryFrequency",
12728             "description": "<p>Machine Retry Frequency Minutes (min:1, max:99999)</p>"
12729           },
12730           {
12731             "group": "Body",
12732             "type": "Integer",
12733             "optional": true,
12734             "field": "dialAgentRejectMaxRetry",
12735             "description": "<p>#AgentReject Retry (min:1, max:999)</p>"
12736           },
12737           {
12738             "group": "Body",
12739             "type": "Integer",
12740             "optional": true,
12741             "field": "dialAgentRejectRetryFrequency",
12742             "description": "<p>AgentReject Retry Frequency Minutes (min:1, max:99999)</p>"
12743           }
12744         ]
12745       }
12746     },
12747     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12748     "version": "0.0.0",
12749     "filename": "server/api/campaign/index.js",
12750     "groupTitle": "IVR_Campaigns"
12751   },
12752   {
12753     "type": "delete",
12754     "url": "/api/campaigns/{id}",
12755     "title": "Deletes a IVR Campaign",
12756     "examples": [
12757       {
12758         "title": "Example usage:",
12759         "content": "curl https://{domain}/api/campaigns/{id} -v -u {name}:{password} -X DELETE",
12760         "type": "json"
12761       }
12762     ],
12763     "name": "DeleteIVR_Campaigns",
12764     "group": "IVR_Campaigns",
12765     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12766     "version": "0.0.0",
12767     "filename": "server/api/campaign/index.js",
12768     "groupTitle": "IVR_Campaigns"
12769   },
12770   {
12771     "type": "get",
12772     "url": "/api/campaigns/{id}/blacklists",
12773     "title": "Get IVR campaign blacklists",
12774     "examples": [
12775       {
12776         "title": "Example usage:",
12777         "content": "curl https://{domain}/api/campaigns/{id}/blacklists -v -u {name}:{password} -X GET",
12778         "type": "json"
12779       }
12780     ],
12781     "name": "GetBlackLists",
12782     "group": "IVR_Campaigns",
12783     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12784     "version": "0.0.0",
12785     "filename": "server/api/campaign/index.js",
12786     "groupTitle": "IVR_Campaigns"
12787   },
12788   {
12789     "type": "get",
12790     "url": "/api/campaigns/{id}/finals",
12791     "title": "Gets IVR campaign hopper finals",
12792     "examples": [
12793       {
12794         "title": "Example usage:",
12795         "content": "curl https://{domain}/api/campaigns/{id}/hopper_finals -v -u {name}:{password}  -X GET",
12796         "type": "json"
12797       }
12798     ],
12799     "name": "GetHopperFinals",
12800     "group": "IVR_Campaigns",
12801     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12802     "version": "0.0.0",
12803     "filename": "server/api/campaign/index.js",
12804     "groupTitle": "IVR_Campaigns"
12805   },
12806   {
12807     "type": "get",
12808     "url": "/api/campaigns/{id}/hopper_histories",
12809     "title": "Gets IVR campaign hopper histories",
12810     "examples": [
12811       {
12812         "title": "Example usage:",
12813         "content": "curl https://{domain}/api/campaigns/{id}/hopper_histories -v -u {name}:{password} -X GET",
12814         "type": "json"
12815       }
12816     ],
12817     "name": "GetHopperHistories",
12818     "group": "IVR_Campaigns",
12819     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12820     "version": "0.0.0",
12821     "filename": "server/api/campaign/index.js",
12822     "groupTitle": "IVR_Campaigns"
12823   },
12824   {
12825     "type": "get",
12826     "url": "/api/campaigns/{id}/hoppers",
12827     "title": "Gets IVR campaign hoppers",
12828     "examples": [
12829       {
12830         "title": "Example usage:",
12831         "content": "curl https://{domain}/api/campaigns/{id}/hoppers -v -u {name}:{password} -X GET",
12832         "type": "json"
12833       }
12834     ],
12835     "name": "GetHoppers",
12836     "group": "IVR_Campaigns",
12837     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12838     "version": "0.0.0",
12839     "filename": "server/api/campaign/index.js",
12840     "groupTitle": "IVR_Campaigns"
12841   },
12842   {
12843     "type": "get",
12844     "url": "/api/campaigns",
12845     "title": "Gets a list of IVR Campaigns",
12846     "examples": [
12847       {
12848         "title": "Example usage:",
12849         "content": "curl https://{domain}/api/campaigns -v -u {name}:{password}",
12850         "type": "json"
12851       }
12852     ],
12853     "name": "GetIVR_Campaigns",
12854     "group": "IVR_Campaigns",
12855     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
12856     "version": "0.0.0",
12857     "filename": "server/api/campaign/index.js",
12858     "groupTitle": "IVR_Campaigns"
12859   },
12860   {
12861     "type": "get",
12862     "url": "/api/campaigns/{id}/lists",
12863     "title": "Get IVR campaign lists",
12864     "examples": [
12865       {
12866         "title": "Example usage:",
12867         "content": "curl https://{domain}/api/campaigns/{id}/lists -v -u {name}:{password} -X GET",
12868         "type": "json"
12869       }
12870     ],
12871     "name": "GetLists",
12872     "group": "IVR_Campaigns",
12873     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12874     "version": "0.0.0",
12875     "filename": "server/api/campaign/index.js",
12876     "groupTitle": "IVR_Campaigns"
12877   },
12878   {
12879     "type": "delete",
12880     "url": "/api/campaigns/{id}/blacklists",
12881     "title": "Remove blacklists from an IVR Campaign",
12882     "examples": [
12883       {
12884         "title": "Example usage:",
12885         "content": "curl https://{domain}/api/campaigns/{id}/blacklists?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
12886         "type": "json"
12887       }
12888     ],
12889     "name": "RemoveBlackLists",
12890     "group": "IVR_Campaigns",
12891     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12892     "version": "0.0.0",
12893     "filename": "server/api/campaign/index.js",
12894     "groupTitle": "IVR_Campaigns"
12895   },
12896   {
12897     "type": "delete",
12898     "url": "/api/campaigns/{id}/lists",
12899     "title": "Remove lists from an IVR Campaign",
12900     "examples": [
12901       {
12902         "title": "Example usage:",
12903         "content": "curl https://{domain}/api/campaigns/{id}/lists?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
12904         "type": "json"
12905       }
12906     ],
12907     "name": "RemoveLists",
12908     "group": "IVR_Campaigns",
12909     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12910     "version": "0.0.0",
12911     "filename": "server/api/campaign/index.js",
12912     "groupTitle": "IVR_Campaigns"
12913   },
12914   {
12915     "type": "get",
12916     "url": "/api/campaigns/{id}",
12917     "title": "Gets a single IVR Campaign",
12918     "examples": [
12919       {
12920         "title": "Example usage:",
12921         "content": "curl https://{domain}/api/campaigns/{id} -v -u {name}:{password}",
12922         "type": "json"
12923       }
12924     ],
12925     "name": "ShowIVR_Campaigns",
12926     "group": "IVR_Campaigns",
12927     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12928     "version": "0.0.0",
12929     "filename": "server/api/campaign/index.js",
12930     "groupTitle": "IVR_Campaigns"
12931   },
12932   {
12933     "type": "get",
12934     "url": "/api/campaigns/{id}/blacks",
12935     "title": "Gets IVR campaign hopper blacks",
12936     "examples": [
12937       {
12938         "title": "Example usage:",
12939         "content": "curl https://{domain}/api/campaigns/{id}/hopper_black -v -u {name}:{password}  -X GET",
12940         "type": "json"
12941       }
12942     ],
12943     "name": "getHopperBlacks",
12944     "group": "IVR_Campaigns",
12945     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12946     "version": "0.0.0",
12947     "filename": "server/api/campaign/index.js",
12948     "groupTitle": "IVR_Campaigns"
12949   },
12950   {
12951     "type": "put",
12952     "url": "/api/campaigns/{id}",
12953     "title": "Update an existing IVR Campaign",
12954     "examples": [
12955       {
12956         "title": "Example usage:",
12957         "content": "curl https://{domain}/api/campaigns/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
12958         "type": "json"
12959       }
12960     ],
12961     "name": "updateIVR_Campaigns",
12962     "group": "IVR_Campaigns",
12963     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12964     "version": "0.0.0",
12965     "filename": "server/api/campaign/index.js",
12966     "groupTitle": "IVR_Campaigns"
12967   },
12968   {
12969     "type": "post",
12970     "url": "/api/integrations/reports",
12971     "title": "Creates a new Integration Report",
12972     "examples": [
12973       {
12974         "title": "Example usage:",
12975         "content": "curl https://{domain}/api/integrations/reports -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
12976         "type": "json"
12977       }
12978     ],
12979     "name": "CreateIntegration_Reports",
12980     "group": "Integration_Reports",
12981     "parameter": {
12982       "fields": {
12983         "Body": [
12984           {
12985             "group": "Body",
12986             "type": "String",
12987             "optional": true,
12988             "field": "integration",
12989             "description": ""
12990           },
12991           {
12992             "group": "Body",
12993             "type": "String",
12994             "optional": true,
12995             "field": "eventChannel",
12996             "description": ""
12997           },
12998           {
12999             "group": "Body",
13000             "type": "String",
13001             "optional": true,
13002             "field": "exitStatus",
13003             "description": ""
13004           },
13005           {
13006             "group": "Body",
13007             "type": "String",
13008             "optional": true,
13009             "field": "ticketId",
13010             "description": ""
13011           },
13012           {
13013             "group": "Body",
13014             "type": "Integer",
13015             "optional": true,
13016             "field": "integrationId",
13017             "description": ""
13018           },
13019           {
13020             "group": "Body",
13021             "type": "String",
13022             "optional": true,
13023             "field": "contacts",
13024             "description": ""
13025           },
13026           {
13027             "group": "Body",
13028             "type": "String",
13029             "optional": true,
13030             "field": "uniqueid",
13031             "description": ""
13032           },
13033           {
13034             "group": "Body",
13035             "type": "String",
13036             "optional": true,
13037             "field": "calleridnum",
13038             "description": ""
13039           },
13040           {
13041             "group": "Body",
13042             "type": "String",
13043             "optional": true,
13044             "field": "calleridname",
13045             "description": ""
13046           },
13047           {
13048             "group": "Body",
13049             "type": "String",
13050             "optional": true,
13051             "field": "queue",
13052             "description": ""
13053           },
13054           {
13055             "group": "Body",
13056             "type": "String",
13057             "optional": true,
13058             "field": "interface",
13059             "description": ""
13060           },
13061           {
13062             "group": "Body",
13063             "type": "String",
13064             "optional": true,
13065             "field": "membername",
13066             "description": ""
13067           },
13068           {
13069             "group": "Body",
13070             "type": "String",
13071             "optional": true,
13072             "field": "agentcalledAt",
13073             "description": ""
13074           },
13075           {
13076             "group": "Body",
13077             "type": "String",
13078             "optional": true,
13079             "field": "agentconnectAt",
13080             "description": ""
13081           },
13082           {
13083             "group": "Body",
13084             "type": "Integer",
13085             "optional": true,
13086             "field": "holdtime",
13087             "description": ""
13088           },
13089           {
13090             "group": "Body",
13091             "type": "Boolean",
13092             "optional": true,
13093             "field": "agentcomplete",
13094             "description": ""
13095           },
13096           {
13097             "group": "Body",
13098             "type": "String",
13099             "optional": true,
13100             "field": "agentcompleteAt",
13101             "description": ""
13102           },
13103           {
13104             "group": "Body",
13105             "type": "Integer",
13106             "optional": true,
13107             "field": "talktime",
13108             "description": ""
13109           },
13110           {
13111             "group": "Body",
13112             "type": "Boolean",
13113             "optional": true,
13114             "field": "agentacw",
13115             "description": ""
13116           },
13117           {
13118             "group": "Body",
13119             "type": "Integer",
13120             "optional": true,
13121             "field": "acwtime",
13122             "description": ""
13123           },
13124           {
13125             "group": "Body",
13126             "type": "String",
13127             "optional": true,
13128             "field": "reason",
13129             "description": ""
13130           },
13131           {
13132             "group": "Body",
13133             "type": "Boolean",
13134             "optional": true,
13135             "field": "agentringnoanswer",
13136             "description": ""
13137           },
13138           {
13139             "group": "Body",
13140             "type": "String",
13141             "optional": true,
13142             "field": "agentringnoanswerAt",
13143             "description": ""
13144           },
13145           {
13146             "group": "Body",
13147             "type": "Boolean",
13148             "optional": true,
13149             "field": "agentdump",
13150             "description": ""
13151           },
13152           {
13153             "group": "Body",
13154             "type": "String",
13155             "optional": true,
13156             "field": "agentdumpAt",
13157             "description": ""
13158           },
13159           {
13160             "group": "Body",
13161             "type": "String",
13162             "optional": true,
13163             "field": "lastevent",
13164             "description": ""
13165           },
13166           {
13167             "group": "Body",
13168             "type": "String",
13169             "optional": true,
13170             "field": "channel",
13171             "description": ""
13172           },
13173           {
13174             "group": "Body",
13175             "type": "Integer",
13176             "optional": true,
13177             "field": "channelstate",
13178             "description": ""
13179           },
13180           {
13181             "group": "Body",
13182             "type": "String",
13183             "optional": true,
13184             "field": "channelstatedesc",
13185             "description": ""
13186           },
13187           {
13188             "group": "Body",
13189             "type": "String",
13190             "optional": true,
13191             "field": "connectedlinenum",
13192             "description": ""
13193           },
13194           {
13195             "group": "Body",
13196             "type": "String",
13197             "optional": true,
13198             "field": "connectedlinename",
13199             "description": ""
13200           },
13201           {
13202             "group": "Body",
13203             "type": "String",
13204             "optional": true,
13205             "field": "language",
13206             "description": ""
13207           },
13208           {
13209             "group": "Body",
13210             "type": "String",
13211             "optional": true,
13212             "field": "accountcode",
13213             "description": ""
13214           },
13215           {
13216             "group": "Body",
13217             "type": "String",
13218             "optional": true,
13219             "field": "context",
13220             "description": ""
13221           },
13222           {
13223             "group": "Body",
13224             "type": "String",
13225             "optional": true,
13226             "field": "exten",
13227             "description": ""
13228           },
13229           {
13230             "group": "Body",
13231             "type": "String",
13232             "optional": true,
13233             "field": "priority",
13234             "description": ""
13235           },
13236           {
13237             "group": "Body",
13238             "type": "String",
13239             "optional": true,
13240             "field": "destchannel",
13241             "description": ""
13242           },
13243           {
13244             "group": "Body",
13245             "type": "Integer",
13246             "optional": true,
13247             "field": "destchannelstate",
13248             "description": ""
13249           },
13250           {
13251             "group": "Body",
13252             "type": "String",
13253             "optional": true,
13254             "field": "destchannelstatedesc",
13255             "description": ""
13256           },
13257           {
13258             "group": "Body",
13259             "type": "String",
13260             "optional": true,
13261             "field": "destcalleridnum",
13262             "description": ""
13263           },
13264           {
13265             "group": "Body",
13266             "type": "String",
13267             "optional": true,
13268             "field": "destcalleridname",
13269             "description": ""
13270           },
13271           {
13272             "group": "Body",
13273             "type": "String",
13274             "optional": true,
13275             "field": "destconnectedlinenum",
13276             "description": ""
13277           },
13278           {
13279             "group": "Body",
13280             "type": "String",
13281             "optional": true,
13282             "field": "destconnectedlinename",
13283             "description": ""
13284           },
13285           {
13286             "group": "Body",
13287             "type": "String",
13288             "optional": true,
13289             "field": "destlanguage",
13290             "description": ""
13291           },
13292           {
13293             "group": "Body",
13294             "type": "String",
13295             "optional": true,
13296             "field": "destaccountcode",
13297             "description": ""
13298           },
13299           {
13300             "group": "Body",
13301             "type": "String",
13302             "optional": true,
13303             "field": "destcontext",
13304             "description": ""
13305           },
13306           {
13307             "group": "Body",
13308             "type": "String",
13309             "optional": true,
13310             "field": "destexten",
13311             "description": ""
13312           },
13313           {
13314             "group": "Body",
13315             "type": "String",
13316             "optional": true,
13317             "field": "destpriority",
13318             "description": ""
13319           },
13320           {
13321             "group": "Body",
13322             "type": "String",
13323             "optional": true,
13324             "field": "destuniqueid",
13325             "description": ""
13326           },
13327           {
13328             "group": "Body",
13329             "type": "String",
13330             "optional": true,
13331             "field": "messageId",
13332             "description": ""
13333           },
13334           {
13335             "group": "Body",
13336             "type": "String",
13337             "optional": true,
13338             "field": "inReplyTo",
13339             "description": ""
13340           },
13341           {
13342             "group": "Body",
13343             "type": "String",
13344             "optional": true,
13345             "field": "subject",
13346             "description": ""
13347           },
13348           {
13349             "group": "Body",
13350             "type": "String",
13351             "optional": true,
13352             "field": "from",
13353             "description": ""
13354           },
13355           {
13356             "group": "Body",
13357             "type": "String",
13358             "optional": true,
13359             "field": "to",
13360             "description": ""
13361           },
13362           {
13363             "group": "Body",
13364             "type": "String",
13365             "optional": true,
13366             "field": "cc",
13367             "description": ""
13368           },
13369           {
13370             "group": "Body",
13371             "type": "Text",
13372             "optional": true,
13373             "field": "attachment",
13374             "description": ""
13375           },
13376           {
13377             "group": "Body",
13378             "type": "Text",
13379             "optional": true,
13380             "field": "html",
13381             "description": ""
13382           },
13383           {
13384             "group": "Body",
13385             "type": "Text",
13386             "optional": true,
13387             "field": "text",
13388             "description": ""
13389           },
13390           {
13391             "group": "Body",
13392             "type": "String",
13393             "allowedValues": [
13394               "\"SENT\"",
13395               "\"SENDING\"",
13396               "\"RECEIVED\"",
13397               "\"FAILED\""
13398             ],
13399             "optional": true,
13400             "field": "status",
13401             "description": ""
13402           },
13403           {
13404             "group": "Body",
13405             "type": "String",
13406             "optional": true,
13407             "field": "url",
13408             "description": ""
13409           },
13410           {
13411             "group": "Body",
13412             "type": "String",
13413             "optional": true,
13414             "field": "app",
13415             "description": ""
13416           },
13417           {
13418             "group": "Body",
13419             "type": "String",
13420             "optional": true,
13421             "field": "appdata",
13422             "description": ""
13423           },
13424           {
13425             "group": "Body",
13426             "type": "Integer",
13427             "optional": true,
13428             "field": "projectId",
13429             "description": ""
13430           }
13431         ]
13432       }
13433     },
13434     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13435     "version": "0.0.0",
13436     "filename": "server/api/integrationReport/index.js",
13437     "groupTitle": "Integration_Reports"
13438   },
13439   {
13440     "type": "delete",
13441     "url": "/api/integrations/reports/{id}",
13442     "title": "Deletes a Integration Report",
13443     "examples": [
13444       {
13445         "title": "Example usage:",
13446         "content": "curl https://{domain}/api/integrations/reports/{id} -v -u {name}:{password} -X DELETE",
13447         "type": "json"
13448       }
13449     ],
13450     "name": "DeleteIntegration_Reports",
13451     "group": "Integration_Reports",
13452     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13453     "version": "0.0.0",
13454     "filename": "server/api/integrationReport/index.js",
13455     "groupTitle": "Integration_Reports"
13456   },
13457   {
13458     "type": "get",
13459     "url": "/api/integrations/reports/describe",
13460     "title": "Gets table info about Integration Reports",
13461     "examples": [
13462       {
13463         "title": "Example usage:",
13464         "content": "curl https://{domain}/api/integrations/reports/describe -v -u {name}:{password}",
13465         "type": "json"
13466       }
13467     ],
13468     "name": "DescribeIntegration_Reports",
13469     "group": "Integration_Reports",
13470     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13471     "version": "0.0.0",
13472     "filename": "server/api/integrationReport/index.js",
13473     "groupTitle": "Integration_Reports"
13474   },
13475   {
13476     "type": "get",
13477     "url": "/api/integrations/reports",
13478     "title": "Gets a list of Integration Reports",
13479     "examples": [
13480       {
13481         "title": "Example usage:",
13482         "content": "curl https://{domain}/api/integrations/reports -v -u {name}:{password}",
13483         "type": "json"
13484       }
13485     ],
13486     "name": "GetIntegration_Reports",
13487     "group": "Integration_Reports",
13488     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
13489     "version": "0.0.0",
13490     "filename": "server/api/integrationReport/index.js",
13491     "groupTitle": "Integration_Reports"
13492   },
13493   {
13494     "type": "get",
13495     "url": "/api/integrations/reports/{id}",
13496     "title": "Gets a single Integration Report",
13497     "examples": [
13498       {
13499         "title": "Example usage:",
13500         "content": "curl https://{domain}/api/integrations/reports/{id} -v -u {name}:{password}",
13501         "type": "json"
13502       }
13503     ],
13504     "name": "ShowIntegration_Reports",
13505     "group": "Integration_Reports",
13506     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13507     "version": "0.0.0",
13508     "filename": "server/api/integrationReport/index.js",
13509     "groupTitle": "Integration_Reports"
13510   },
13511   {
13512     "type": "put",
13513     "url": "/api/integrations/reports/{id}",
13514     "title": "Update an existing Integration Report",
13515     "examples": [
13516       {
13517         "title": "Example usage:",
13518         "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",
13519         "type": "json"
13520       }
13521     ],
13522     "name": "updateIntegration_Reports",
13523     "group": "Integration_Reports",
13524     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13525     "version": "0.0.0",
13526     "filename": "server/api/integrationReport/index.js",
13527     "groupTitle": "Integration_Reports"
13528   },
13529   {
13530     "type": "post",
13531     "url": "/api/intervals",
13532     "title": "Creates a new Interval",
13533     "examples": [
13534       {
13535         "title": "Example usage:",
13536         "content": "curl https://{domain}/api/intervals -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
13537         "type": "json"
13538       }
13539     ],
13540     "name": "CreateIntervals",
13541     "group": "Intervals",
13542     "parameter": {
13543       "fields": {
13544         "Body": [
13545           {
13546             "group": "Body",
13547             "type": "String",
13548             "optional": true,
13549             "field": "name",
13550             "description": ""
13551           },
13552           {
13553             "group": "Body",
13554             "type": "String",
13555             "optional": true,
13556             "field": "description",
13557             "description": ""
13558           },
13559           {
13560             "group": "Body",
13561             "type": "String",
13562             "optional": true,
13563             "field": "interval",
13564             "description": ""
13565           }
13566         ]
13567       }
13568     },
13569     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13570     "version": "0.0.0",
13571     "filename": "server/api/interval/index.js",
13572     "groupTitle": "Intervals"
13573   },
13574   {
13575     "type": "delete",
13576     "url": "/api/intervals/{id}",
13577     "title": "Deletes a Interval",
13578     "examples": [
13579       {
13580         "title": "Example usage:",
13581         "content": "curl https://{domain}/api/intervals/{id} -v -u {name}:{password} -X DELETE",
13582         "type": "json"
13583       }
13584     ],
13585     "name": "DeleteIntervals",
13586     "group": "Intervals",
13587     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13588     "version": "0.0.0",
13589     "filename": "server/api/interval/index.js",
13590     "groupTitle": "Intervals"
13591   },
13592   {
13593     "type": "get",
13594     "url": "/api/intervals",
13595     "title": "Gets a list of Intervals",
13596     "examples": [
13597       {
13598         "title": "Example usage:",
13599         "content": "curl https://{domain}/api/intervals -v -u {name}:{password}",
13600         "type": "json"
13601       }
13602     ],
13603     "name": "GetIntervals",
13604     "group": "Intervals",
13605     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
13606     "version": "0.0.0",
13607     "filename": "server/api/interval/index.js",
13608     "groupTitle": "Intervals"
13609   },
13610   {
13611     "type": "get",
13612     "url": "/api/intervals/{id}",
13613     "title": "Gets a single Interval",
13614     "examples": [
13615       {
13616         "title": "Example usage:",
13617         "content": "curl https://{domain}/api/intervals/{id} -v -u {name}:{password}",
13618         "type": "json"
13619       }
13620     ],
13621     "name": "ShowIntervals",
13622     "group": "Intervals",
13623     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13624     "version": "0.0.0",
13625     "filename": "server/api/interval/index.js",
13626     "groupTitle": "Intervals"
13627   },
13628   {
13629     "type": "post",
13630     "url": "/api/intervals/{id}/sub_intervals",
13631     "title": "Creates a new sub interval",
13632     "examples": [
13633       {
13634         "title": "Example usage:",
13635         "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",
13636         "type": "json"
13637       }
13638     ],
13639     "name": "addInterval",
13640     "group": "Intervals",
13641     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13642     "version": "0.0.0",
13643     "filename": "server/api/interval/index.js",
13644     "groupTitle": "Intervals"
13645   },
13646   {
13647     "type": "post",
13648     "url": "/api/intervals/{id}/sub_intervals/create_many",
13649     "title": "Create new sub intervals set",
13650     "examples": [
13651       {
13652         "title": "Example usage:",
13653         "content": "curl https://{domain}/api/intervals/{id}/sub_intervals -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
13654         "type": "json"
13655       }
13656     ],
13657     "name": "addIntervals",
13658     "group": "Intervals",
13659     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13660     "version": "0.0.0",
13661     "filename": "server/api/interval/index.js",
13662     "groupTitle": "Intervals"
13663   },
13664   {
13665     "type": "get",
13666     "url": "/api/intervals/{id}/sub_intervals",
13667     "title": "Get sub intervals set",
13668     "examples": [
13669       {
13670         "title": "Example usage:",
13671         "content": "curl https://{domain}/api/intervals/{id}/sub_intervals -v -u {name}:{password} -X GET",
13672         "type": "json"
13673       }
13674     ],
13675     "name": "getIntervals",
13676     "group": "Intervals",
13677     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13678     "version": "0.0.0",
13679     "filename": "server/api/interval/index.js",
13680     "groupTitle": "Intervals"
13681   },
13682   {
13683     "type": "put",
13684     "url": "/api/intervals/{id}",
13685     "title": "Update an existing Interval",
13686     "examples": [
13687       {
13688         "title": "Example usage:",
13689         "content": "curl https://{domain}/api/intervals/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
13690         "type": "json"
13691       }
13692     ],
13693     "name": "updateIntervals",
13694     "group": "Intervals",
13695     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13696     "version": "0.0.0",
13697     "filename": "server/api/interval/index.js",
13698     "groupTitle": "Intervals"
13699   },
13700   {
13701     "type": "post",
13702     "url": "/api/jira",
13703     "title": "Creates a new issue",
13704     "examples": [
13705       {
13706         "title": "Example usage:",
13707         "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}",
13708         "type": "json"
13709       }
13710     ],
13711     "name": "Creates_Issue",
13712     "group": "Issue",
13713     "parameter": {
13714       "fields": {
13715         "Body": [
13716           {
13717             "group": "Body",
13718             "type": "String",
13719             "allowedValues": [
13720               "\"Bug\""
13721             ],
13722             "optional": true,
13723             "field": "issuetype",
13724             "description": ""
13725           },
13726           {
13727             "group": "Body",
13728             "type": "String",
13729             "optional": false,
13730             "field": "summary",
13731             "description": ""
13732           },
13733           {
13734             "group": "Body",
13735             "type": "String",
13736             "optional": false,
13737             "field": "description",
13738             "description": ""
13739           }
13740         ]
13741       }
13742     },
13743     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13744     "version": "0.0.0",
13745     "filename": "server/api/jira/index.js",
13746     "groupTitle": "Issue"
13747   },
13748   {
13749     "type": "post",
13750     "url": "/api/jscripty/answers/reports",
13751     "title": "Creates a new Report",
13752     "examples": [
13753       {
13754         "title": "Example usage:",
13755         "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",
13756         "type": "json"
13757       }
13758     ],
13759     "name": "CreateReports",
13760     "group": "JscriptyAnswerReport",
13761     "parameter": {
13762       "fields": {
13763         "Body": [
13764           {
13765             "group": "Body",
13766             "type": "String",
13767             "optional": true,
13768             "field": "question",
13769             "description": ""
13770           },
13771           {
13772             "group": "Body",
13773             "type": "Text",
13774             "optional": true,
13775             "field": "answer",
13776             "description": ""
13777           },
13778           {
13779             "group": "Body",
13780             "type": "String",
13781             "optional": true,
13782             "field": "membername",
13783             "description": ""
13784           },
13785           {
13786             "group": "Body",
13787             "type": "String",
13788             "optional": true,
13789             "field": "projectname",
13790             "description": ""
13791           },
13792           {
13793             "group": "Body",
13794             "type": "String",
13795             "optional": true,
13796             "field": "queue",
13797             "description": ""
13798           },
13799           {
13800             "group": "Body",
13801             "type": "String",
13802             "optional": true,
13803             "field": "uniqueid",
13804             "description": ""
13805           },
13806           {
13807             "group": "Body",
13808             "type": "String",
13809             "optional": true,
13810             "field": "calleridname",
13811             "description": ""
13812           },
13813           {
13814             "group": "Body",
13815             "type": "String",
13816             "optional": true,
13817             "field": "calleridnum",
13818             "description": ""
13819           },
13820           {
13821             "group": "Body",
13822             "type": "String",
13823             "optional": true,
13824             "field": "questionId",
13825             "description": ""
13826           }
13827         ]
13828       }
13829     },
13830     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13831     "version": "0.0.0",
13832     "filename": "server/api/jscriptyAnswerReport/index.js",
13833     "groupTitle": "JscriptyAnswerReport"
13834   },
13835   {
13836     "type": "delete",
13837     "url": "/api/jscripty/answers/reports/{id}",
13838     "title": "Deletes a Report",
13839     "examples": [
13840       {
13841         "title": "Example usage:",
13842         "content": "curl https://{domain}/api/jscripty/answers/reports/{id} -v -u {name}:{password} -X DELETE",
13843         "type": "json"
13844       }
13845     ],
13846     "name": "DeleteReports",
13847     "group": "JscriptyAnswerReport",
13848     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13849     "version": "0.0.0",
13850     "filename": "server/api/jscriptyAnswerReport/index.js",
13851     "groupTitle": "JscriptyAnswerReport"
13852   },
13853   {
13854     "type": "get",
13855     "url": "/api/jscripty/answers/reports/describe",
13856     "title": "Gets table info about Reports",
13857     "examples": [
13858       {
13859         "title": "Example usage:",
13860         "content": "curl https://{domain}/api/jscripty/answers/reports/describe -v -u {name}:{password}",
13861         "type": "json"
13862       }
13863     ],
13864     "name": "DescribeReports",
13865     "group": "JscriptyAnswerReport",
13866     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13867     "version": "0.0.0",
13868     "filename": "server/api/jscriptyAnswerReport/index.js",
13869     "groupTitle": "JscriptyAnswerReport"
13870   },
13871   {
13872     "type": "get",
13873     "url": "/api/jscripty/answers/reports",
13874     "title": "Gets a list of Reports",
13875     "examples": [
13876       {
13877         "title": "Example usage:",
13878         "content": "curl https://{domain}/api/jscripty/answers/reports -v -u {name}:{password}",
13879         "type": "json"
13880       }
13881     ],
13882     "name": "GetReports",
13883     "group": "JscriptyAnswerReport",
13884     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
13885     "version": "0.0.0",
13886     "filename": "server/api/jscriptyAnswerReport/index.js",
13887     "groupTitle": "JscriptyAnswerReport"
13888   },
13889   {
13890     "type": "get",
13891     "url": "/api/jscripty/answers/reports/{id}",
13892     "title": "Gets a single Report",
13893     "examples": [
13894       {
13895         "title": "Example usage:",
13896         "content": "curl https://{domain}/api/jscripty/answers/reports/{id} -v -u {name}:{password}",
13897         "type": "json"
13898       }
13899     ],
13900     "name": "ShowReports",
13901     "group": "JscriptyAnswerReport",
13902     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13903     "version": "0.0.0",
13904     "filename": "server/api/jscriptyAnswerReport/index.js",
13905     "groupTitle": "JscriptyAnswerReport"
13906   },
13907   {
13908     "type": "put",
13909     "url": "/api/jscripty/answers/reports/{id}",
13910     "title": "Update an existing Report",
13911     "examples": [
13912       {
13913         "title": "Example usage:",
13914         "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",
13915         "type": "json"
13916       }
13917     ],
13918     "name": "updateReports",
13919     "group": "JscriptyAnswerReport",
13920     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13921     "version": "0.0.0",
13922     "filename": "server/api/jscriptyAnswerReport/index.js",
13923     "groupTitle": "JscriptyAnswerReport"
13924   },
13925   {
13926     "type": "post",
13927     "url": "/api/jscripty/questions/reports",
13928     "title": "Creates a new Report",
13929     "examples": [
13930       {
13931         "title": "Example usage:",
13932         "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",
13933         "type": "json"
13934       }
13935     ],
13936     "name": "CreateReports",
13937     "group": "JscriptyQuestionReport",
13938     "parameter": {
13939       "fields": {
13940         "Body": [
13941           {
13942             "group": "Body",
13943             "type": "String",
13944             "optional": true,
13945             "field": "question",
13946             "description": ""
13947           },
13948           {
13949             "group": "Body",
13950             "type": "Text",
13951             "optional": true,
13952             "field": "answer",
13953             "description": ""
13954           },
13955           {
13956             "group": "Body",
13957             "type": "String",
13958             "optional": true,
13959             "field": "membername",
13960             "description": ""
13961           },
13962           {
13963             "group": "Body",
13964             "type": "String",
13965             "optional": true,
13966             "field": "projectname",
13967             "description": ""
13968           },
13969           {
13970             "group": "Body",
13971             "type": "String",
13972             "optional": true,
13973             "field": "queue",
13974             "description": ""
13975           },
13976           {
13977             "group": "Body",
13978             "type": "String",
13979             "optional": true,
13980             "field": "uniqueid",
13981             "description": ""
13982           },
13983           {
13984             "group": "Body",
13985             "type": "String",
13986             "optional": true,
13987             "field": "calleridname",
13988             "description": ""
13989           },
13990           {
13991             "group": "Body",
13992             "type": "String",
13993             "optional": true,
13994             "field": "calleridnum",
13995             "description": ""
13996           },
13997           {
13998             "group": "Body",
13999             "type": "String",
14000             "optional": true,
14001             "field": "questionId",
14002             "description": ""
14003           }
14004         ]
14005       }
14006     },
14007     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14008     "version": "0.0.0",
14009     "filename": "server/api/jscriptyQuestionReport/index.js",
14010     "groupTitle": "JscriptyQuestionReport"
14011   },
14012   {
14013     "type": "delete",
14014     "url": "/api/jscripty/questions/reports/{id}",
14015     "title": "Deletes a Report",
14016     "examples": [
14017       {
14018         "title": "Example usage:",
14019         "content": "curl https://{domain}/api/jscripty/questions/reports/{id} -v -u {name}:{password} -X DELETE",
14020         "type": "json"
14021       }
14022     ],
14023     "name": "DeleteReports",
14024     "group": "JscriptyQuestionReport",
14025     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14026     "version": "0.0.0",
14027     "filename": "server/api/jscriptyQuestionReport/index.js",
14028     "groupTitle": "JscriptyQuestionReport"
14029   },
14030   {
14031     "type": "get",
14032     "url": "/api/jscripty/questions/reports/describe",
14033     "title": "Gets table info about Reports",
14034     "examples": [
14035       {
14036         "title": "Example usage:",
14037         "content": "curl https://{domain}/api/jscripty/questions/reports/describe -v -u {name}:{password}",
14038         "type": "json"
14039       }
14040     ],
14041     "name": "DescribeReports",
14042     "group": "JscriptyQuestionReport",
14043     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14044     "version": "0.0.0",
14045     "filename": "server/api/jscriptyQuestionReport/index.js",
14046     "groupTitle": "JscriptyQuestionReport"
14047   },
14048   {
14049     "type": "get",
14050     "url": "/api/jscripty/questions/reports",
14051     "title": "Gets a list of Reports",
14052     "examples": [
14053       {
14054         "title": "Example usage:",
14055         "content": "curl https://{domain}/api/jscripty/questions/reports -v -u {name}:{password}",
14056         "type": "json"
14057       }
14058     ],
14059     "name": "GetReports",
14060     "group": "JscriptyQuestionReport",
14061     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
14062     "version": "0.0.0",
14063     "filename": "server/api/jscriptyQuestionReport/index.js",
14064     "groupTitle": "JscriptyQuestionReport"
14065   },
14066   {
14067     "type": "get",
14068     "url": "/api/jscripty/questions/reports/{id}",
14069     "title": "Gets a single Report",
14070     "examples": [
14071       {
14072         "title": "Example usage:",
14073         "content": "curl https://{domain}/api/jscripty/questions/reports/{id} -v -u {name}:{password}",
14074         "type": "json"
14075       }
14076     ],
14077     "name": "ShowReports",
14078     "group": "JscriptyQuestionReport",
14079     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14080     "version": "0.0.0",
14081     "filename": "server/api/jscriptyQuestionReport/index.js",
14082     "groupTitle": "JscriptyQuestionReport"
14083   },
14084   {
14085     "type": "put",
14086     "url": "/api/jscripty/questions/reports/{id}",
14087     "title": "Update an existing Report",
14088     "examples": [
14089       {
14090         "title": "Example usage:",
14091         "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",
14092         "type": "json"
14093       }
14094     ],
14095     "name": "updateReports",
14096     "group": "JscriptyQuestionReport",
14097     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14098     "version": "0.0.0",
14099     "filename": "server/api/jscriptyQuestionReport/index.js",
14100     "groupTitle": "JscriptyQuestionReport"
14101   },
14102   {
14103     "type": "post",
14104     "url": "/api/jscripty/sessions/reports",
14105     "title": "Creates a new Report",
14106     "examples": [
14107       {
14108         "title": "Example usage:",
14109         "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",
14110         "type": "json"
14111       }
14112     ],
14113     "name": "CreateReports",
14114     "group": "JscriptySessionReport",
14115     "parameter": {
14116       "fields": {
14117         "Body": [
14118           {
14119             "group": "Body",
14120             "type": "String",
14121             "optional": true,
14122             "field": "starttime",
14123             "description": ""
14124           },
14125           {
14126             "group": "Body",
14127             "type": "String",
14128             "optional": true,
14129             "field": "endtime",
14130             "description": ""
14131           },
14132           {
14133             "group": "Body",
14134             "type": "String",
14135             "optional": true,
14136             "field": "membername",
14137             "description": ""
14138           },
14139           {
14140             "group": "Body",
14141             "type": "String",
14142             "optional": true,
14143             "field": "projectname",
14144             "description": ""
14145           },
14146           {
14147             "group": "Body",
14148             "type": "String",
14149             "optional": true,
14150             "field": "queue",
14151             "description": ""
14152           },
14153           {
14154             "group": "Body",
14155             "type": "String",
14156             "optional": true,
14157             "field": "uniqueid",
14158             "description": ""
14159           },
14160           {
14161             "group": "Body",
14162             "type": "String",
14163             "optional": true,
14164             "field": "calleridname",
14165             "description": ""
14166           },
14167           {
14168             "group": "Body",
14169             "type": "String",
14170             "optional": true,
14171             "field": "calleridnum",
14172             "description": ""
14173           },
14174           {
14175             "group": "Body",
14176             "type": "Boolean",
14177             "optional": true,
14178             "field": "completed",
14179             "description": ""
14180           }
14181         ]
14182       }
14183     },
14184     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14185     "version": "0.0.0",
14186     "filename": "server/api/jscriptySessionReport/index.js",
14187     "groupTitle": "JscriptySessionReport"
14188   },
14189   {
14190     "type": "delete",
14191     "url": "/api/jscripty/sessions/reports/{id}",
14192     "title": "Deletes a Report",
14193     "examples": [
14194       {
14195         "title": "Example usage:",
14196         "content": "curl https://{domain}/api/jscripty/sessions/reports/{id} -v -u {name}:{password} -X DELETE",
14197         "type": "json"
14198       }
14199     ],
14200     "name": "DeleteReports",
14201     "group": "JscriptySessionReport",
14202     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14203     "version": "0.0.0",
14204     "filename": "server/api/jscriptySessionReport/index.js",
14205     "groupTitle": "JscriptySessionReport"
14206   },
14207   {
14208     "type": "get",
14209     "url": "/api/jscripty/sessions/reports/describe",
14210     "title": "Gets table info about Reports",
14211     "examples": [
14212       {
14213         "title": "Example usage:",
14214         "content": "curl https://{domain}/api/jscripty/sessions/reports/describe -v -u {name}:{password}",
14215         "type": "json"
14216       }
14217     ],
14218     "name": "DescribeReports",
14219     "group": "JscriptySessionReport",
14220     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14221     "version": "0.0.0",
14222     "filename": "server/api/jscriptySessionReport/index.js",
14223     "groupTitle": "JscriptySessionReport"
14224   },
14225   {
14226     "type": "get",
14227     "url": "/api/jscripty/sessions/reports",
14228     "title": "Gets a list of Reports",
14229     "examples": [
14230       {
14231         "title": "Example usage:",
14232         "content": "curl https://{domain}/api/jscripty/sessions/reports -v -u {name}:{password}",
14233         "type": "json"
14234       }
14235     ],
14236     "name": "GetReports",
14237     "group": "JscriptySessionReport",
14238     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
14239     "version": "0.0.0",
14240     "filename": "server/api/jscriptySessionReport/index.js",
14241     "groupTitle": "JscriptySessionReport"
14242   },
14243   {
14244     "type": "get",
14245     "url": "/api/jscripty/sessions/reports/{id}",
14246     "title": "Gets a single Report",
14247     "examples": [
14248       {
14249         "title": "Example usage:",
14250         "content": "curl https://{domain}/api/jscripty/sessions/reports/{id} -v -u {name}:{password}",
14251         "type": "json"
14252       }
14253     ],
14254     "name": "ShowReports",
14255     "group": "JscriptySessionReport",
14256     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14257     "version": "0.0.0",
14258     "filename": "server/api/jscriptySessionReport/index.js",
14259     "groupTitle": "JscriptySessionReport"
14260   },
14261   {
14262     "type": "get",
14263     "url": "/api/jscripty/sessions/reports/{id}/questions",
14264     "title": "Gets Jscripty Session questions",
14265     "examples": [
14266       {
14267         "title": "Example usage:",
14268         "content": "curl https://{domain}/api/jscripty/sessions/reports/{id}/questions -v -u {name}:{password}  -X GET",
14269         "type": "json"
14270       }
14271     ],
14272     "name": "getQuestions",
14273     "group": "JscriptySessionReport",
14274     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14275     "version": "0.0.0",
14276     "filename": "server/api/jscriptySessionReport/index.js",
14277     "groupTitle": "JscriptySessionReport"
14278   },
14279   {
14280     "type": "put",
14281     "url": "/api/jscripty/sessions/reports/{id}",
14282     "title": "Update an existing Report",
14283     "examples": [
14284       {
14285         "title": "Example usage:",
14286         "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",
14287         "type": "json"
14288       }
14289     ],
14290     "name": "updateReports",
14291     "group": "JscriptySessionReport",
14292     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14293     "version": "0.0.0",
14294     "filename": "server/api/jscriptySessionReport/index.js",
14295     "groupTitle": "JscriptySessionReport"
14296   },
14297   {
14298     "type": "post",
14299     "url": "/api/jscripty/projects/clone",
14300     "title": "Clone an existing Project",
14301     "examples": [
14302       {
14303         "title": "Example usage:",
14304         "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",
14305         "type": "json"
14306       }
14307     ],
14308     "name": "CloneProjects",
14309     "group": "Jscripty_Projects",
14310     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14311     "version": "0.0.0",
14312     "filename": "server/api/jscriptyProject/index.js",
14313     "groupTitle": "Jscripty_Projects"
14314   },
14315   {
14316     "type": "post",
14317     "url": "/api/jscripty/projects",
14318     "title": "Creates a new Project",
14319     "examples": [
14320       {
14321         "title": "Example usage:",
14322         "content": "curl https://{domain}/api/jscripty/projects -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
14323         "type": "json"
14324       }
14325     ],
14326     "name": "CreateProjects",
14327     "group": "Jscripty_Projects",
14328     "parameter": {
14329       "fields": {
14330         "Body": [
14331           {
14332             "group": "Body",
14333             "type": "String",
14334             "optional": true,
14335             "field": "name",
14336             "description": ""
14337           },
14338           {
14339             "group": "Body",
14340             "type": "String",
14341             "optional": true,
14342             "field": "description",
14343             "description": ""
14344           },
14345           {
14346             "group": "Body",
14347             "type": "Text",
14348             "optional": true,
14349             "field": "formData",
14350             "description": ""
14351           },
14352           {
14353             "group": "Body",
14354             "type": "Boolean",
14355             "optional": true,
14356             "field": "enableUncompleteSave",
14357             "description": ""
14358           },
14359           {
14360             "group": "Body",
14361             "type": "Boolean",
14362             "optional": true,
14363             "field": "sendUnpauseOnSubmit",
14364             "description": ""
14365           }
14366         ]
14367       }
14368     },
14369     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14370     "version": "0.0.0",
14371     "filename": "server/api/jscriptyProject/index.js",
14372     "groupTitle": "Jscripty_Projects"
14373   },
14374   {
14375     "type": "delete",
14376     "url": "/api/jscripty/projects/{id}",
14377     "title": "Deletes a Project",
14378     "examples": [
14379       {
14380         "title": "Example usage:",
14381         "content": "curl https://{domain}/api/jscripty/projects/{id} -v -u {name}:{password} -X DELETE",
14382         "type": "json"
14383       }
14384     ],
14385     "name": "DeleteProjects",
14386     "group": "Jscripty_Projects",
14387     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14388     "version": "0.0.0",
14389     "filename": "server/api/jscriptyProject/index.js",
14390     "groupTitle": "Jscripty_Projects"
14391   },
14392   {
14393     "type": "get",
14394     "url": "/api/jscripty/projects",
14395     "title": "Gets a list of Projects",
14396     "examples": [
14397       {
14398         "title": "Example usage:",
14399         "content": "curl https://{domain}/api/jscripty/projects -v -u {name}:{password}",
14400         "type": "json"
14401       }
14402     ],
14403     "name": "GetProjects",
14404     "group": "Jscripty_Projects",
14405     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
14406     "version": "0.0.0",
14407     "filename": "server/api/jscriptyProject/index.js",
14408     "groupTitle": "Jscripty_Projects"
14409   },
14410   {
14411     "type": "get",
14412     "url": "/api/jscripty/projects/{id}",
14413     "title": "Gets a single Project",
14414     "examples": [
14415       {
14416         "title": "Example usage:",
14417         "content": "curl https://{domain}/api/jscripty/projects/{id} -v -u {name}:{password}",
14418         "type": "json"
14419       }
14420     ],
14421     "name": "ShowProjects",
14422     "group": "Jscripty_Projects",
14423     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14424     "version": "0.0.0",
14425     "filename": "server/api/jscriptyProject/index.js",
14426     "groupTitle": "Jscripty_Projects"
14427   },
14428   {
14429     "type": "get",
14430     "url": "/api/jscripty/projects/{id}/answers",
14431     "title": "Gets jscripty project answers",
14432     "examples": [
14433       {
14434         "title": "Example usage:",
14435         "content": "curl https://{domain}/api/jscripty/projects/{id}/answers -v -u {name}:{password}  -X GET",
14436         "type": "json"
14437       }
14438     ],
14439     "name": "getAnswers",
14440     "group": "Jscripty_Projects",
14441     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14442     "version": "0.0.0",
14443     "filename": "server/api/jscriptyProject/index.js",
14444     "groupTitle": "Jscripty_Projects"
14445   },
14446   {
14447     "type": "get",
14448     "url": "/api/jscripty/projects/{id}/sessions",
14449     "title": "Gets jscripty project sessions",
14450     "examples": [
14451       {
14452         "title": "Example usage:",
14453         "content": "curl https://{domain}/api/jscripty/projects/{id}/sessions -v -u {name}:{password}  -X GET",
14454         "type": "json"
14455       }
14456     ],
14457     "name": "getSessions",
14458     "group": "Jscripty_Projects",
14459     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14460     "version": "0.0.0",
14461     "filename": "server/api/jscriptyProject/index.js",
14462     "groupTitle": "Jscripty_Projects"
14463   },
14464   {
14465     "type": "get",
14466     "url": "/api/jscripty/projects/{id}/summary",
14467     "title": "Gets jscripty project summary",
14468     "examples": [
14469       {
14470         "title": "Example usage:",
14471         "content": "curl https://{domain}/api/jscripty/projects/{id}/summary -v -u {name}:{password}  -X GET",
14472         "type": "json"
14473       }
14474     ],
14475     "name": "getSummary",
14476     "group": "Jscripty_Projects",
14477     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14478     "version": "0.0.0",
14479     "filename": "server/api/jscriptyProject/index.js",
14480     "groupTitle": "Jscripty_Projects"
14481   },
14482   {
14483     "type": "put",
14484     "url": "/api/jscripty/projects/{id}",
14485     "title": "Update an existing Project",
14486     "examples": [
14487       {
14488         "title": "Example usage:",
14489         "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",
14490         "type": "json"
14491       }
14492     ],
14493     "name": "updateProjects",
14494     "group": "Jscripty_Projects",
14495     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14496     "version": "0.0.0",
14497     "filename": "server/api/jscriptyProject/index.js",
14498     "groupTitle": "Jscripty_Projects"
14499   },
14500   {
14501     "type": "get",
14502     "url": "/api/license",
14503     "title": "Gets License Info",
14504     "examples": [
14505       {
14506         "title": "Example usage:",
14507         "content": "curl https://{domain}/api/license -v -u {name}:{password} -X GET",
14508         "type": "json"
14509       }
14510     ],
14511     "name": "index",
14512     "group": "License",
14513     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14514     "version": "0.0.0",
14515     "filename": "server/api/license/index.js",
14516     "groupTitle": "License"
14517   },
14518   {
14519     "type": "put",
14520     "url": "/api/license/{id}",
14521     "title": "Update License Info",
14522     "examples": [
14523       {
14524         "title": "Example usage:",
14525         "content": "curl https://{domain}/api/license/{id} -v -u {name}:{password} -X PUT",
14526         "type": "json"
14527       }
14528     ],
14529     "name": "update",
14530     "group": "License",
14531     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14532     "version": "0.0.0",
14533     "filename": "server/api/license/index.js",
14534     "groupTitle": "License"
14535   },
14536   {
14537     "type": "post",
14538     "url": "/api/mail/accounts/{id}/users",
14539     "title": "Add agents to a mail account",
14540     "examples": [
14541       {
14542         "title": "Example usage:",
14543         "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",
14544         "type": "json"
14545       }
14546     ],
14547     "name": "AddAgents",
14548     "group": "Mail_Accounts",
14549     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14550     "version": "0.0.0",
14551     "filename": "server/api/mailAccount/index.js",
14552     "groupTitle": "Mail_Accounts"
14553   },
14554   {
14555     "type": "post",
14556     "url": "/api/mail/accounts/{id}/in_servers",
14557     "title": "Creates a new IMAP server",
14558     "examples": [
14559       {
14560         "title": "Example usage:",
14561         "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",
14562         "type": "json"
14563       }
14564     ],
14565     "name": "AddImap",
14566     "group": "Mail_Accounts",
14567     "parameter": {
14568       "fields": {
14569         "Body": [
14570           {
14571             "group": "Body",
14572             "type": "String",
14573             "optional": true,
14574             "field": "description",
14575             "description": ""
14576           },
14577           {
14578             "group": "Body",
14579             "type": "String",
14580             "optional": true,
14581             "field": "host",
14582             "description": ""
14583           },
14584           {
14585             "group": "Body",
14586             "type": "Boolean",
14587             "optional": true,
14588             "field": "authentication",
14589             "description": ""
14590           },
14591           {
14592             "group": "Body",
14593             "type": "String",
14594             "optional": true,
14595             "field": "user",
14596             "description": ""
14597           },
14598           {
14599             "group": "Body",
14600             "type": "String",
14601             "optional": true,
14602             "field": "password",
14603             "description": ""
14604           },
14605           {
14606             "group": "Body",
14607             "type": "Integer",
14608             "optional": true,
14609             "field": "port",
14610             "description": ""
14611           },
14612           {
14613             "group": "Body",
14614             "type": "Boolean",
14615             "optional": true,
14616             "field": "tls",
14617             "description": ""
14618           },
14619           {
14620             "group": "Body",
14621             "type": "String",
14622             "optional": true,
14623             "field": "mailbox",
14624             "description": ""
14625           },
14626           {
14627             "group": "Body",
14628             "type": "Integer",
14629             "optional": true,
14630             "field": "connTimeout",
14631             "description": ""
14632           },
14633           {
14634             "group": "Body",
14635             "type": "Integer",
14636             "optional": true,
14637             "field": "authTimeout",
14638             "description": ""
14639           },
14640           {
14641             "group": "Body",
14642             "type": "String",
14643             "optional": true,
14644             "field": "service",
14645             "description": ""
14646           }
14647         ]
14648       }
14649     },
14650     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14651     "version": "0.0.0",
14652     "filename": "server/api/mailAccount/index.js",
14653     "groupTitle": "Mail_Accounts"
14654   },
14655   {
14656     "type": "post",
14657     "url": "/api/mail/accounts/{id}/out_servers",
14658     "title": "Creates a new SMTP server",
14659     "examples": [
14660       {
14661         "title": "Example usage:",
14662         "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",
14663         "type": "json"
14664       }
14665     ],
14666     "name": "AddSmtp",
14667     "group": "Mail_Accounts",
14668     "parameter": {
14669       "fields": {
14670         "Body": [
14671           {
14672             "group": "Body",
14673             "type": "String",
14674             "optional": true,
14675             "field": "description",
14676             "description": ""
14677           },
14678           {
14679             "group": "Body",
14680             "type": "String",
14681             "optional": true,
14682             "field": "host",
14683             "description": ""
14684           },
14685           {
14686             "group": "Body",
14687             "type": "String",
14688             "optional": true,
14689             "field": "user",
14690             "description": ""
14691           },
14692           {
14693             "group": "Body",
14694             "type": "String",
14695             "optional": true,
14696             "field": "pass",
14697             "description": ""
14698           },
14699           {
14700             "group": "Body",
14701             "type": "Integer",
14702             "optional": true,
14703             "field": "port",
14704             "description": ""
14705           },
14706           {
14707             "group": "Body",
14708             "type": "Boolean",
14709             "optional": true,
14710             "field": "secure",
14711             "description": ""
14712           },
14713           {
14714             "group": "Body",
14715             "type": "String",
14716             "optional": true,
14717             "field": "service",
14718             "description": ""
14719           },
14720           {
14721             "group": "Body",
14722             "type": "Boolean",
14723             "optional": true,
14724             "field": "authentication",
14725             "description": ""
14726           }
14727         ]
14728       }
14729     },
14730     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14731     "version": "0.0.0",
14732     "filename": "server/api/mailAccount/index.js",
14733     "groupTitle": "Mail_Accounts"
14734   },
14735   {
14736     "type": "delete",
14737     "url": "/api/mail/accounts/{id}",
14738     "title": "Deletes a mail account",
14739     "examples": [
14740       {
14741         "title": "Example usage:",
14742         "content": "curl https://{domain}/api/mail/accounts/{id} -v -u {name}:{password} -X DELETE",
14743         "type": "json"
14744       }
14745     ],
14746     "name": "DeleteMailAccounts",
14747     "group": "Mail_Accounts",
14748     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14749     "version": "0.0.0",
14750     "filename": "server/api/mailAccount/index.js",
14751     "groupTitle": "Mail_Accounts"
14752   },
14753   {
14754     "type": "get",
14755     "url": "/api/mail/accounts/describe",
14756     "title": "Gets table info about Accounts",
14757     "examples": [
14758       {
14759         "title": "Example usage:",
14760         "content": "curl https://{domain}/api/mail/accounts/describe -v -u {name}:{password}",
14761         "type": "json"
14762       }
14763     ],
14764     "name": "DescribeAccounts",
14765     "group": "Mail_Accounts",
14766     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14767     "version": "0.0.0",
14768     "filename": "server/api/mailAccount/index.js",
14769     "groupTitle": "Mail_Accounts"
14770   },
14771   {
14772     "type": "get",
14773     "url": "/api/mail/accounts",
14774     "title": "Gets a list of Accounts",
14775     "examples": [
14776       {
14777         "title": "Example usage:",
14778         "content": "curl https://{domain}/api/mail/accounts -v -u {name}:{password}",
14779         "type": "json"
14780       }
14781     ],
14782     "name": "GetAccounts",
14783     "group": "Mail_Accounts",
14784     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
14785     "version": "0.0.0",
14786     "filename": "server/api/mailAccount/index.js",
14787     "groupTitle": "Mail_Accounts"
14788   },
14789   {
14790     "type": "get",
14791     "url": "/api/mail/accounts/{id}/users",
14792     "title": "Gets agents from mail account",
14793     "examples": [
14794       {
14795         "title": "Example usage:",
14796         "content": "curl https://{domain}/api/mail/accounts/{id}/users -v -u {name}:{password} -X GET",
14797         "type": "json"
14798       }
14799     ],
14800     "name": "GetAgents",
14801     "group": "Mail_Accounts",
14802     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14803     "version": "0.0.0",
14804     "filename": "server/api/mailAccount/index.js",
14805     "groupTitle": "Mail_Accounts"
14806   },
14807   {
14808     "type": "get",
14809     "url": "/api/mail/accounts/{id}/in_servers",
14810     "title": "Gets account IMAP server",
14811     "examples": [
14812       {
14813         "title": "Example usage:",
14814         "content": "curl https://{domain}/api/mail/accounts/{id}/in_servers -v -u {name}:{password} -X GET",
14815         "type": "json"
14816       }
14817     ],
14818     "name": "GetImap",
14819     "group": "Mail_Accounts",
14820     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14821     "version": "0.0.0",
14822     "filename": "server/api/mailAccount/index.js",
14823     "groupTitle": "Mail_Accounts"
14824   },
14825   {
14826     "type": "get",
14827     "url": "/api/mail/accounts/{id}/out_servers",
14828     "title": "Gets account SMTP server",
14829     "examples": [
14830       {
14831         "title": "Example usage:",
14832         "content": "curl https://{domain}/api/mail/accounts/{id}/out_servers -v -u {name}:{password} -X GET",
14833         "type": "json"
14834       }
14835     ],
14836     "name": "GetSmtp",
14837     "group": "Mail_Accounts",
14838     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14839     "version": "0.0.0",
14840     "filename": "server/api/mailAccount/index.js",
14841     "groupTitle": "Mail_Accounts"
14842   },
14843   {
14844     "type": "delete",
14845     "url": "/api/mail/accounts/{id}/users",
14846     "title": "Removes agents from a mail account",
14847     "examples": [
14848       {
14849         "title": "Example usage:",
14850         "content": "curl https://{domain}/api/mail/accounts/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
14851         "type": "json"
14852       }
14853     ],
14854     "name": "RemoveAgents",
14855     "group": "Mail_Accounts",
14856     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14857     "version": "0.0.0",
14858     "filename": "server/api/mailAccount/index.js",
14859     "groupTitle": "Mail_Accounts"
14860   },
14861   {
14862     "type": "delete",
14863     "url": "/api/mail/accounts/{id}/canned_answers",
14864     "title": "Removes canned answers from account",
14865     "examples": [
14866       {
14867         "title": "Example usage:",
14868         "content": "curl https://{domain}/api/mail/accounts/{id}/canned_answers?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
14869         "type": "json"
14870       }
14871     ],
14872     "name": "RemoveAnswers",
14873     "group": "Mail_Accounts",
14874     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14875     "version": "0.0.0",
14876     "filename": "server/api/mailAccount/index.js",
14877     "groupTitle": "Mail_Accounts"
14878   },
14879   {
14880     "type": "delete",
14881     "url": "/api/mail/accounts/{id}/dispositions",
14882     "title": "Removes dispositions from account",
14883     "examples": [
14884       {
14885         "title": "Example usage:",
14886         "content": "curl https://{domain}/api/mail/accounts/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
14887         "type": "json"
14888       }
14889     ],
14890     "name": "RemoveDispositions",
14891     "group": "Mail_Accounts",
14892     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14893     "version": "0.0.0",
14894     "filename": "server/api/mailAccount/index.js",
14895     "groupTitle": "Mail_Accounts"
14896   },
14897   {
14898     "type": "delete",
14899     "url": "/api/mail/accounts/{id}/in_servers",
14900     "title": "Removes IMAP server from an account",
14901     "examples": [
14902       {
14903         "title": "Example usage:",
14904         "content": "curl https://{domain}/api/mail/accounts/{id}/in_servers -v -u {name}:{password} -X DELETE",
14905         "type": "json"
14906       }
14907     ],
14908     "name": "RemoveImmap",
14909     "group": "Mail_Accounts",
14910     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14911     "version": "0.0.0",
14912     "filename": "server/api/mailAccount/index.js",
14913     "groupTitle": "Mail_Accounts"
14914   },
14915   {
14916     "type": "delete",
14917     "url": "/api/mail/accounts/{id}/out_servers",
14918     "title": "Removes SMTP server from an account",
14919     "examples": [
14920       {
14921         "title": "Example usage:",
14922         "content": "curl https://{domain}/api/mail/accounts/{id}/out_servers -v -u {name}:{password} -X DELETE",
14923         "type": "json"
14924       }
14925     ],
14926     "name": "RemoveSmtp",
14927     "group": "Mail_Accounts",
14928     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14929     "version": "0.0.0",
14930     "filename": "server/api/mailAccount/index.js",
14931     "groupTitle": "Mail_Accounts"
14932   },
14933   {
14934     "type": "get",
14935     "url": "/api/mail/accounts/{id}",
14936     "title": "Gets a single Account",
14937     "examples": [
14938       {
14939         "title": "Example usage:",
14940         "content": "curl https://{domain}/api/mail/accounts/{id} -v -u {name}:{password}",
14941         "type": "json"
14942       }
14943     ],
14944     "name": "ShowAccounts",
14945     "group": "Mail_Accounts",
14946     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14947     "version": "0.0.0",
14948     "filename": "server/api/mailAccount/index.js",
14949     "groupTitle": "Mail_Accounts"
14950   },
14951   {
14952     "type": "post",
14953     "url": "/api/mail/accounts/{id}/canned_answers",
14954     "title": "Creates new canned answer",
14955     "examples": [
14956       {
14957         "title": "Example usage:",
14958         "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",
14959         "type": "json"
14960       }
14961     ],
14962     "name": "addAnswer",
14963     "group": "Mail_Accounts",
14964     "parameter": {
14965       "fields": {
14966         "Body": [
14967           {
14968             "group": "Body",
14969             "type": "String",
14970             "optional": false,
14971             "field": "key",
14972             "description": ""
14973           },
14974           {
14975             "group": "Body",
14976             "type": "Text",
14977             "optional": false,
14978             "field": "value",
14979             "description": ""
14980           },
14981           {
14982             "group": "Body",
14983             "type": "String",
14984             "optional": true,
14985             "field": "description",
14986             "description": ""
14987           },
14988           {
14989             "group": "Body",
14990             "type": "Virtual",
14991             "optional": true,
14992             "field": "name",
14993             "description": ""
14994           }
14995         ]
14996       }
14997     },
14998     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14999     "version": "0.0.0",
15000     "filename": "server/api/mailAccount/index.js",
15001     "groupTitle": "Mail_Accounts"
15002   },
15003   {
15004     "type": "post",
15005     "url": "/api/mail/accounts/{id}/applications",
15006     "title": "Creates new applications",
15007     "examples": [
15008       {
15009         "title": "Example usage:",
15010         "content": "curl https://{domain}/api/mail/accounts/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
15011         "type": "json"
15012       }
15013     ],
15014     "name": "addApplications",
15015     "group": "Mail_Accounts",
15016     "parameter": {
15017       "fields": {
15018         "Body": [
15019           {
15020             "group": "Body",
15021             "type": "Integer",
15022             "optional": false,
15023             "field": "priority",
15024             "description": ""
15025           },
15026           {
15027             "group": "Body",
15028             "type": "String",
15029             "optional": false,
15030             "field": "app",
15031             "description": ""
15032           },
15033           {
15034             "group": "Body",
15035             "type": "Text",
15036             "optional": true,
15037             "field": "appdata",
15038             "description": ""
15039           },
15040           {
15041             "group": "Body",
15042             "type": "String",
15043             "optional": true,
15044             "field": "description",
15045             "description": ""
15046           },
15047           {
15048             "group": "Body",
15049             "type": "String",
15050             "optional": true,
15051             "field": "interval",
15052             "description": ""
15053           }
15054         ]
15055       }
15056     },
15057     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15058     "version": "0.0.0",
15059     "filename": "server/api/mailAccount/index.js",
15060     "groupTitle": "Mail_Accounts"
15061   },
15062   {
15063     "type": "post",
15064     "url": "/api/mail/accounts/{id}/dispositions",
15065     "title": "Creates new disposition",
15066     "examples": [
15067       {
15068         "title": "Example usage:",
15069         "content": "curl https://{domain}/api/mail/accounts/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
15070         "type": "json"
15071       }
15072     ],
15073     "name": "addDisposition",
15074     "group": "Mail_Accounts",
15075     "parameter": {
15076       "fields": {
15077         "Body": [
15078           {
15079             "group": "Body",
15080             "type": "String",
15081             "optional": false,
15082             "field": "name",
15083             "description": ""
15084           }
15085         ]
15086       }
15087     },
15088     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15089     "version": "0.0.0",
15090     "filename": "server/api/mailAccount/index.js",
15091     "groupTitle": "Mail_Accounts"
15092   },
15093   {
15094     "type": "post",
15095     "url": "/api/mail/accounts/{id}/interactions",
15096     "title": "Creates new interactions",
15097     "examples": [
15098       {
15099         "title": "Example usage:",
15100         "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",
15101         "type": "json"
15102       }
15103     ],
15104     "name": "addInteraction",
15105     "group": "Mail_Accounts",
15106     "parameter": {
15107       "fields": {
15108         "Body": [
15109           {
15110             "group": "Body",
15111             "type": "Boolean",
15112             "optional": true,
15113             "field": "closed",
15114             "description": ""
15115           },
15116           {
15117             "group": "Body",
15118             "type": "String",
15119             "optional": true,
15120             "field": "closedAt",
15121             "description": ""
15122           },
15123           {
15124             "group": "Body",
15125             "type": "String",
15126             "optional": true,
15127             "field": "disposition",
15128             "description": ""
15129           },
15130           {
15131             "group": "Body",
15132             "type": "String",
15133             "optional": true,
15134             "field": "note",
15135             "description": ""
15136           },
15137           {
15138             "group": "Body",
15139             "type": "String",
15140             "optional": true,
15141             "field": "inReplyTo",
15142             "description": ""
15143           },
15144           {
15145             "group": "Body",
15146             "type": "String",
15147             "optional": true,
15148             "field": "to",
15149             "description": ""
15150           },
15151           {
15152             "group": "Body",
15153             "type": "Text",
15154             "optional": true,
15155             "field": "cc",
15156             "description": ""
15157           },
15158           {
15159             "group": "Body",
15160             "type": "Text",
15161             "optional": true,
15162             "field": "subject",
15163             "description": ""
15164           },
15165           {
15166             "group": "Body",
15167             "type": "Boolean",
15168             "optional": true,
15169             "field": "attach",
15170             "description": ""
15171           },
15172           {
15173             "group": "Body",
15174             "type": "String",
15175             "optional": true,
15176             "field": "read1stAt",
15177             "description": ""
15178           },
15179           {
15180             "group": "Body",
15181             "type": "String",
15182             "optional": true,
15183             "field": "substatus",
15184             "description": ""
15185           },
15186           {
15187             "group": "Body",
15188             "type": "String",
15189             "optional": true,
15190             "field": "substatusAt",
15191             "description": ""
15192           },
15193           {
15194             "group": "Body",
15195             "type": "String",
15196             "allowedValues": [
15197               "\"in\"",
15198               "\"out\""
15199             ],
15200             "optional": false,
15201             "field": "firstMsgDirection",
15202             "description": ""
15203           },
15204           {
15205             "group": "Body",
15206             "type": "String",
15207             "optional": true,
15208             "field": "lastMsgAt",
15209             "description": ""
15210           },
15211           {
15212             "group": "Body",
15213             "type": "String",
15214             "allowedValues": [
15215               "\"in\"",
15216               "\"out\""
15217             ],
15218             "optional": false,
15219             "field": "lastMsgDirection",
15220             "description": ""
15221           },
15222           {
15223             "group": "Body",
15224             "type": "Text",
15225             "optional": true,
15226             "field": "lastMsgBody",
15227             "description": ""
15228           },
15229           {
15230             "group": "Body",
15231             "type": "Text",
15232             "optional": true,
15233             "field": "lastMsgText",
15234             "description": ""
15235           }
15236         ]
15237       }
15238     },
15239     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15240     "version": "0.0.0",
15241     "filename": "server/api/mailAccount/index.js",
15242     "groupTitle": "Mail_Accounts"
15243   },
15244   {
15245     "type": "post",
15246     "url": "/api/mail/accounts",
15247     "title": "Create a mail account",
15248     "examples": [
15249       {
15250         "title": "Example usage:",
15251         "content": "curl https://{domain}/api/mail/accounts \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
15252         "type": "json"
15253       }
15254     ],
15255     "name": "create",
15256     "group": "Mail_Accounts",
15257     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15258     "version": "0.0.0",
15259     "filename": "server/api/mailAccount/index.js",
15260     "groupTitle": "Mail_Accounts"
15261   },
15262   {
15263     "type": "get",
15264     "url": "/api/mail/accounts/{id}/canned_answers",
15265     "title": "Gets account canned answers",
15266     "examples": [
15267       {
15268         "title": "Example usage:",
15269         "content": "curl https://{domain}/api/mail/accounts/{id}/canned_answers -v -u {name}:{password} -X GET",
15270         "type": "json"
15271       }
15272     ],
15273     "name": "getAnswers",
15274     "group": "Mail_Accounts",
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/mailAccount/index.js",
15278     "groupTitle": "Mail_Accounts"
15279   },
15280   {
15281     "type": "get",
15282     "url": "/api/mail/accounts/{id}/applications",
15283     "title": "Gets account applications",
15284     "examples": [
15285       {
15286         "title": "Example usage:",
15287         "content": "curl https://{domain}/api/mail/accounts/{id}/applications -v -u {name}:{password} -X GET",
15288         "type": "json"
15289       }
15290     ],
15291     "name": "getApplications",
15292     "group": "Mail_Accounts",
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/mailAccount/index.js",
15296     "groupTitle": "Mail_Accounts"
15297   },
15298   {
15299     "type": "get",
15300     "url": "/api/mail/accounts/{id}/dispositions",
15301     "title": "Gets account dispositions",
15302     "examples": [
15303       {
15304         "title": "Example usage:",
15305         "content": "curl https://{domain}/api/mail/accounts/{id}/dispositions -v -u {name}:{password} -X GET",
15306         "type": "json"
15307       }
15308     ],
15309     "name": "getDispositions",
15310     "group": "Mail_Accounts",
15311     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15312     "version": "0.0.0",
15313     "filename": "server/api/mailAccount/index.js",
15314     "groupTitle": "Mail_Accounts"
15315   },
15316   {
15317     "type": "get",
15318     "url": "/api/mail/accounts/{id}/interactions",
15319     "title": "Gets account interactions",
15320     "examples": [
15321       {
15322         "title": "Example usage:",
15323         "content": "curl https://{domain}/api/mail/accounts/{id}/interactions -v -u {name}:{password} -X GET",
15324         "type": "json"
15325       }
15326     ],
15327     "name": "getInteraction",
15328     "group": "Mail_Accounts",
15329     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15330     "version": "0.0.0",
15331     "filename": "server/api/mailAccount/index.js",
15332     "groupTitle": "Mail_Accounts"
15333   },
15334   {
15335     "type": "get",
15336     "url": "/api/mail/accounts/{id}/messages",
15337     "title": "Gets account messages",
15338     "examples": [
15339       {
15340         "title": "Example usage:",
15341         "content": "curl https://{domain}/api/mail/accounts/{id}/messages -v -u {name}:{password} -X GET",
15342         "type": "json"
15343       }
15344     ],
15345     "name": "getMessages",
15346     "group": "Mail_Accounts",
15347     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15348     "version": "0.0.0",
15349     "filename": "server/api/mailAccount/index.js",
15350     "groupTitle": "Mail_Accounts"
15351   },
15352   {
15353     "type": "post",
15354     "url": "/api/mail/accounts/{id}/send",
15355     "title": "Send new mail",
15356     "examples": [
15357       {
15358         "title": "Example usage:",
15359         "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",
15360         "type": "json"
15361       }
15362     ],
15363     "name": "sendMail",
15364     "group": "Mail_Accounts",
15365     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15366     "version": "0.0.0",
15367     "filename": "server/api/mailAccount/index.js",
15368     "groupTitle": "Mail_Accounts"
15369   },
15370   {
15371     "type": "put",
15372     "url": "/api/mail/accounts/{id}",
15373     "title": "Update an existing Account",
15374     "examples": [
15375       {
15376         "title": "Example usage:",
15377         "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",
15378         "type": "json"
15379       }
15380     ],
15381     "name": "updateAccounts",
15382     "group": "Mail_Accounts",
15383     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15384     "version": "0.0.0",
15385     "filename": "server/api/mailAccount/index.js",
15386     "groupTitle": "Mail_Accounts"
15387   },
15388   {
15389     "type": "get",
15390     "url": "/api/mail/accounts/{id}/verify",
15391     "title": "Verify mail account",
15392     "examples": [
15393       {
15394         "title": "Example usage:",
15395         "content": "curl https://{domain}/api/mail/accounts/{id}/verify -v -u {name}:{password} -X GET",
15396         "type": "json"
15397       }
15398     ],
15399     "name": "verifySmtp",
15400     "group": "Mail_Accounts",
15401     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15402     "version": "0.0.0",
15403     "filename": "server/api/mailAccount/index.js",
15404     "groupTitle": "Mail_Accounts"
15405   },
15406   {
15407     "type": "delete",
15408     "url": "/api/mail/applications/{id}",
15409     "title": "Deletes a Application",
15410     "examples": [
15411       {
15412         "title": "Example usage:",
15413         "content": "curl https://{domain}/api/mail/applications/{id} -v -u {name}:{password} -X DELETE",
15414         "type": "json"
15415       }
15416     ],
15417     "name": "DeleteApplications",
15418     "group": "Mail_Applications",
15419     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15420     "version": "0.0.0",
15421     "filename": "server/api/mailApplication/index.js",
15422     "groupTitle": "Mail_Applications"
15423   },
15424   {
15425     "type": "get",
15426     "url": "/api/mail/applications/{id}",
15427     "title": "Gets a single Application",
15428     "examples": [
15429       {
15430         "title": "Example usage:",
15431         "content": "curl https://{domain}/api/mail/applications/{id} -v -u {name}:{password}",
15432         "type": "json"
15433       }
15434     ],
15435     "name": "ShowApplications",
15436     "group": "Mail_Applications",
15437     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15438     "version": "0.0.0",
15439     "filename": "server/api/mailApplication/index.js",
15440     "groupTitle": "Mail_Applications"
15441   },
15442   {
15443     "type": "put",
15444     "url": "/api/mail/applications/{id}",
15445     "title": "Update an existing Application",
15446     "examples": [
15447       {
15448         "title": "Example usage:",
15449         "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",
15450         "type": "json"
15451       }
15452     ],
15453     "name": "updateApplications",
15454     "group": "Mail_Applications",
15455     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15456     "version": "0.0.0",
15457     "filename": "server/api/mailApplication/index.js",
15458     "groupTitle": "Mail_Applications"
15459   },
15460   {
15461     "type": "post",
15462     "url": "/api/mail/interactions/{id}/tags",
15463     "title": "Add tags to the interaction",
15464     "examples": [
15465       {
15466         "title": "Example usage:",
15467         "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",
15468         "type": "json"
15469       }
15470     ],
15471     "name": "AddTags",
15472     "group": "Mail_Interactions",
15473     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15474     "version": "0.0.0",
15475     "filename": "server/api/mailInteraction/index.js",
15476     "groupTitle": "Mail_Interactions"
15477   },
15478   {
15479     "type": "post",
15480     "url": "/api/mail/interactions",
15481     "title": "Creates a new Interaction",
15482     "examples": [
15483       {
15484         "title": "Example usage:",
15485         "content": "curl https://{domain}/api/mail/interactions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
15486         "type": "json"
15487       }
15488     ],
15489     "name": "CreateInteractions",
15490     "group": "Mail_Interactions",
15491     "parameter": {
15492       "fields": {
15493         "Body": [
15494           {
15495             "group": "Body",
15496             "type": "Boolean",
15497             "optional": true,
15498             "field": "closed",
15499             "description": ""
15500           },
15501           {
15502             "group": "Body",
15503             "type": "String",
15504             "optional": true,
15505             "field": "closedAt",
15506             "description": ""
15507           },
15508           {
15509             "group": "Body",
15510             "type": "String",
15511             "optional": true,
15512             "field": "disposition",
15513             "description": ""
15514           },
15515           {
15516             "group": "Body",
15517             "type": "String",
15518             "optional": true,
15519             "field": "note",
15520             "description": ""
15521           },
15522           {
15523             "group": "Body",
15524             "type": "String",
15525             "optional": true,
15526             "field": "inReplyTo",
15527             "description": ""
15528           },
15529           {
15530             "group": "Body",
15531             "type": "String",
15532             "optional": true,
15533             "field": "to",
15534             "description": ""
15535           },
15536           {
15537             "group": "Body",
15538             "type": "Text",
15539             "optional": true,
15540             "field": "cc",
15541             "description": ""
15542           },
15543           {
15544             "group": "Body",
15545             "type": "Text",
15546             "optional": true,
15547             "field": "subject",
15548             "description": ""
15549           },
15550           {
15551             "group": "Body",
15552             "type": "Boolean",
15553             "optional": true,
15554             "field": "attach",
15555             "description": ""
15556           },
15557           {
15558             "group": "Body",
15559             "type": "String",
15560             "optional": true,
15561             "field": "read1stAt",
15562             "description": ""
15563           },
15564           {
15565             "group": "Body",
15566             "type": "String",
15567             "optional": true,
15568             "field": "substatus",
15569             "description": ""
15570           },
15571           {
15572             "group": "Body",
15573             "type": "String",
15574             "optional": true,
15575             "field": "substatusAt",
15576             "description": ""
15577           },
15578           {
15579             "group": "Body",
15580             "type": "String",
15581             "allowedValues": [
15582               "\"in\"",
15583               "\"out\""
15584             ],
15585             "optional": false,
15586             "field": "firstMsgDirection",
15587             "description": ""
15588           },
15589           {
15590             "group": "Body",
15591             "type": "String",
15592             "optional": true,
15593             "field": "lastMsgAt",
15594             "description": ""
15595           },
15596           {
15597             "group": "Body",
15598             "type": "String",
15599             "allowedValues": [
15600               "\"in\"",
15601               "\"out\""
15602             ],
15603             "optional": false,
15604             "field": "lastMsgDirection",
15605             "description": ""
15606           },
15607           {
15608             "group": "Body",
15609             "type": "Text",
15610             "optional": true,
15611             "field": "lastMsgBody",
15612             "description": ""
15613           },
15614           {
15615             "group": "Body",
15616             "type": "Text",
15617             "optional": true,
15618             "field": "lastMsgText",
15619             "description": ""
15620           }
15621         ]
15622       }
15623     },
15624     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15625     "version": "0.0.0",
15626     "filename": "server/api/mailInteraction/index.js",
15627     "groupTitle": "Mail_Interactions"
15628   },
15629   {
15630     "type": "delete",
15631     "url": "/api/mail/interactions/{id}",
15632     "title": "Deletes a Interaction",
15633     "examples": [
15634       {
15635         "title": "Example usage:",
15636         "content": "curl https://{domain}/api/mail/interactions/{id} -v -u {name}:{password} -X DELETE",
15637         "type": "json"
15638       }
15639     ],
15640     "name": "DeleteInteractions",
15641     "group": "Mail_Interactions",
15642     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15643     "version": "0.0.0",
15644     "filename": "server/api/mailInteraction/index.js",
15645     "groupTitle": "Mail_Interactions"
15646   },
15647   {
15648     "type": "get",
15649     "url": "/api/mail/interactions/describe",
15650     "title": "Gets table info about Interactions",
15651     "examples": [
15652       {
15653         "title": "Example usage:",
15654         "content": "curl https://{domain}/api/mail/interactions/describe -v -u {name}:{password}",
15655         "type": "json"
15656       }
15657     ],
15658     "name": "DescribeInteractions",
15659     "group": "Mail_Interactions",
15660     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15661     "version": "0.0.0",
15662     "filename": "server/api/mailInteraction/index.js",
15663     "groupTitle": "Mail_Interactions"
15664   },
15665   {
15666     "type": "get",
15667     "url": "/api/mail/interactions",
15668     "title": "Gets a list of Interactions",
15669     "examples": [
15670       {
15671         "title": "Example usage:",
15672         "content": "curl https://{domain}/api/mail/interactions -v -u {name}:{password}",
15673         "type": "json"
15674       }
15675     ],
15676     "name": "GetInteractions",
15677     "group": "Mail_Interactions",
15678     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
15679     "version": "0.0.0",
15680     "filename": "server/api/mailInteraction/index.js",
15681     "groupTitle": "Mail_Interactions"
15682   },
15683   {
15684     "type": "delete",
15685     "url": "/api/mail/interactions/{id}/tags",
15686     "title": "Removes tags from interaction",
15687     "examples": [
15688       {
15689         "title": "Example usage:",
15690         "content": "curl https://{domain}/api/mail/interactions/{id}/tags?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
15691         "type": "json"
15692       }
15693     ],
15694     "name": "RemoveTags",
15695     "group": "Mail_Interactions",
15696     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15697     "version": "0.0.0",
15698     "filename": "server/api/mailInteraction/index.js",
15699     "groupTitle": "Mail_Interactions"
15700   },
15701   {
15702     "type": "get",
15703     "url": "/api/mail/interactions/{id}",
15704     "title": "Gets a single Interaction",
15705     "examples": [
15706       {
15707         "title": "Example usage:",
15708         "content": "curl https://{domain}/api/mail/interactions/{id} -v -u {name}:{password}",
15709         "type": "json"
15710       }
15711     ],
15712     "name": "ShowInteractions",
15713     "group": "Mail_Interactions",
15714     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15715     "version": "0.0.0",
15716     "filename": "server/api/mailInteraction/index.js",
15717     "groupTitle": "Mail_Interactions"
15718   },
15719   {
15720     "type": "post",
15721     "url": "/api/mail/interactions/{id}/messages",
15722     "title": "Creates new message",
15723     "examples": [
15724       {
15725         "title": "Example usage:",
15726         "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",
15727         "type": "json"
15728       }
15729     ],
15730     "name": "addMessage",
15731     "group": "Mail_Interactions",
15732     "parameter": {
15733       "fields": {
15734         "Body": [
15735           {
15736             "group": "Body",
15737             "type": "Text",
15738             "optional": false,
15739             "field": "body",
15740             "description": ""
15741           },
15742           {
15743             "group": "Body",
15744             "type": "Text",
15745             "optional": true,
15746             "field": "plainBody",
15747             "description": ""
15748           },
15749           {
15750             "group": "Body",
15751             "type": "Boolean",
15752             "optional": true,
15753             "field": "read",
15754             "description": ""
15755           },
15756           {
15757             "group": "Body",
15758             "type": "String",
15759             "allowedValues": [
15760               "\"in\"",
15761               "\"out\""
15762             ],
15763             "optional": false,
15764             "field": "direction",
15765             "description": ""
15766           },
15767           {
15768             "group": "Body",
15769             "type": "String",
15770             "optional": true,
15771             "field": "messageId",
15772             "description": ""
15773           },
15774           {
15775             "group": "Body",
15776             "type": "String",
15777             "optional": true,
15778             "field": "from",
15779             "description": ""
15780           },
15781           {
15782             "group": "Body",
15783             "type": "Text",
15784             "optional": true,
15785             "field": "to",
15786             "description": ""
15787           },
15788           {
15789             "group": "Body",
15790             "type": "Text",
15791             "optional": true,
15792             "field": "cc",
15793             "description": ""
15794           },
15795           {
15796             "group": "Body",
15797             "type": "Text",
15798             "optional": true,
15799             "field": "bcc",
15800             "description": ""
15801           },
15802           {
15803             "group": "Body",
15804             "type": "Text",
15805             "optional": true,
15806             "field": "subject",
15807             "description": ""
15808           },
15809           {
15810             "group": "Body",
15811             "type": "String",
15812             "optional": true,
15813             "field": "sentAt",
15814             "description": ""
15815           },
15816           {
15817             "group": "Body",
15818             "type": "Integer",
15819             "optional": true,
15820             "field": "attach",
15821             "description": ""
15822           },
15823           {
15824             "group": "Body",
15825             "type": "Boolean",
15826             "optional": true,
15827             "field": "secret",
15828             "description": ""
15829           },
15830           {
15831             "group": "Body",
15832             "type": "String",
15833             "optional": true,
15834             "field": "readAt",
15835             "description": ""
15836           },
15837           {
15838             "group": "Body",
15839             "type": "Text",
15840             "optional": true,
15841             "field": "originTo",
15842             "description": ""
15843           },
15844           {
15845             "group": "Body",
15846             "type": "Text",
15847             "optional": true,
15848             "field": "originCc",
15849             "description": ""
15850           }
15851         ]
15852       }
15853     },
15854     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15855     "version": "0.0.0",
15856     "filename": "server/api/mailInteraction/index.js",
15857     "groupTitle": "Mail_Interactions"
15858   },
15859   {
15860     "type": "get",
15861     "url": "/api/mail/interactions/{id}/download",
15862     "title": "Gets interaction",
15863     "examples": [
15864       {
15865         "title": "Example usage:",
15866         "content": "curl https://{domain}/api/mail/interactions/{id}/download -v -u {name}:{password} -X GET",
15867         "type": "json"
15868       }
15869     ],
15870     "name": "download",
15871     "group": "Mail_Interactions",
15872     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15873     "version": "0.0.0",
15874     "filename": "server/api/mailInteraction/index.js",
15875     "groupTitle": "Mail_Interactions"
15876   },
15877   {
15878     "type": "get",
15879     "url": "/api/mail/interactions/{id}/messages",
15880     "title": "Gets interaction messages",
15881     "examples": [
15882       {
15883         "title": "Example usage:",
15884         "content": "curl https://{domain}/api/mail/interactions/{id}/messages -v -u {name}:{password} -X GET",
15885         "type": "json"
15886       }
15887     ],
15888     "name": "getMessages",
15889     "group": "Mail_Interactions",
15890     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15891     "version": "0.0.0",
15892     "filename": "server/api/mailInteraction/index.js",
15893     "groupTitle": "Mail_Interactions"
15894   },
15895   {
15896     "type": "put",
15897     "url": "/api/mail/interactions/{id}",
15898     "title": "Update an existing Interaction",
15899     "examples": [
15900       {
15901         "title": "Example usage:",
15902         "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",
15903         "type": "json"
15904       }
15905     ],
15906     "name": "updateInteractions",
15907     "group": "Mail_Interactions",
15908     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15909     "version": "0.0.0",
15910     "filename": "server/api/mailInteraction/index.js",
15911     "groupTitle": "Mail_Interactions"
15912   },
15913   {
15914     "type": "delete",
15915     "url": "/api/mail/messages/{id}",
15916     "title": "Deletes a Message",
15917     "examples": [
15918       {
15919         "title": "Example usage:",
15920         "content": "curl https://{domain}/api/mail/messages/{id} -v -u {name}:{password} -X DELETE",
15921         "type": "json"
15922       }
15923     ],
15924     "name": "DeleteMessages",
15925     "group": "Mail_Messages",
15926     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15927     "version": "0.0.0",
15928     "filename": "server/api/mailMessage/index.js",
15929     "groupTitle": "Mail_Messages"
15930   },
15931   {
15932     "type": "get",
15933     "url": "/api/mail/messages/describe",
15934     "title": "Gets table info about Messages",
15935     "examples": [
15936       {
15937         "title": "Example usage:",
15938         "content": "curl https://{domain}/api/mail/messages/describe -v -u {name}:{password}",
15939         "type": "json"
15940       }
15941     ],
15942     "name": "DescribeMessages",
15943     "group": "Mail_Messages",
15944     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15945     "version": "0.0.0",
15946     "filename": "server/api/mailMessage/index.js",
15947     "groupTitle": "Mail_Messages"
15948   },
15949   {
15950     "type": "get",
15951     "url": "/api/mail/messages",
15952     "title": "Gets a list of Messages",
15953     "examples": [
15954       {
15955         "title": "Example usage:",
15956         "content": "curl https://{domain}/api/mail/messages -v -u {name}:{password}",
15957         "type": "json"
15958       }
15959     ],
15960     "name": "GetMessages",
15961     "group": "Mail_Messages",
15962     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
15963     "version": "0.0.0",
15964     "filename": "server/api/mailMessage/index.js",
15965     "groupTitle": "Mail_Messages"
15966   },
15967   {
15968     "type": "get",
15969     "url": "/api/mail/messages/{id}",
15970     "title": "Gets a single Message",
15971     "examples": [
15972       {
15973         "title": "Example usage:",
15974         "content": "curl https://{domain}/api/mail/messages/{id} -v -u {name}:{password}",
15975         "type": "json"
15976       }
15977     ],
15978     "name": "ShowMessages",
15979     "group": "Mail_Messages",
15980     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15981     "version": "0.0.0",
15982     "filename": "server/api/mailMessage/index.js",
15983     "groupTitle": "Mail_Messages"
15984   },
15985   {
15986     "type": "put",
15987     "url": "/api/mail/messages/{id}/accept",
15988     "title": "Accepts message",
15989     "examples": [
15990       {
15991         "title": "Example usage:",
15992         "content": "curl https://{domain}/api/mail/messages/{id}/accept \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
15993         "type": "json"
15994       }
15995     ],
15996     "name": "acceptMessage",
15997     "group": "Mail_Messages",
15998     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15999     "version": "0.0.0",
16000     "filename": "server/api/mailMessage/index.js",
16001     "groupTitle": "Mail_Messages"
16002   },
16003   {
16004     "type": "post",
16005     "url": "/api/mail/messages",
16006     "title": "Create a message",
16007     "examples": [
16008       {
16009         "title": "Example usage:",
16010         "content": "curl https://{domain}/api/mail/messages \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
16011         "type": "json"
16012       }
16013     ],
16014     "name": "createMessage",
16015     "group": "Mail_Messages",
16016     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16017     "version": "0.0.0",
16018     "filename": "server/api/mailMessage/index.js",
16019     "groupTitle": "Mail_Messages"
16020   },
16021   {
16022     "type": "get",
16023     "url": "/api/mail/messages/{id}/download",
16024     "title": "Gets message",
16025     "examples": [
16026       {
16027         "title": "Example usage:",
16028         "content": "curl https://{domain}/api/mail/messages/{id}/download -v -u {name}:{password} -X GET",
16029         "type": "json"
16030       }
16031     ],
16032     "name": "download",
16033     "group": "Mail_Messages",
16034     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16035     "version": "0.0.0",
16036     "filename": "server/api/mailMessage/index.js",
16037     "groupTitle": "Mail_Messages"
16038   },
16039   {
16040     "type": "put",
16041     "url": "/api/mail/messages/{id}/reject",
16042     "title": "Rejects message",
16043     "examples": [
16044       {
16045         "title": "Example usage:",
16046         "content": "curl https://{domain}/api/mail/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
16047         "type": "json"
16048       }
16049     ],
16050     "name": "rejectMessage",
16051     "group": "Mail_Messages",
16052     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16053     "version": "0.0.0",
16054     "filename": "server/api/mailMessage/index.js",
16055     "groupTitle": "Mail_Messages"
16056   },
16057   {
16058     "type": "put",
16059     "url": "/api/mail/messages/{id}",
16060     "title": "Update an existing Message",
16061     "examples": [
16062       {
16063         "title": "Example usage:",
16064         "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",
16065         "type": "json"
16066       }
16067     ],
16068     "name": "updateMessages",
16069     "group": "Mail_Messages",
16070     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16071     "version": "0.0.0",
16072     "filename": "server/api/mailMessage/index.js",
16073     "groupTitle": "Mail_Messages"
16074   },
16075   {
16076     "type": "post",
16077     "url": "/api/mail/reports/queue",
16078     "title": "Creates a new Mail Queue Report",
16079     "examples": [
16080       {
16081         "title": "Example usage:",
16082         "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",
16083         "type": "json"
16084       }
16085     ],
16086     "name": "CreateMail_Queue_Reports",
16087     "group": "Mail_Queue_Reports",
16088     "parameter": {
16089       "fields": {
16090         "Body": [
16091           {
16092             "group": "Body",
16093             "type": "String",
16094             "optional": false,
16095             "field": "uniqueid",
16096             "description": ""
16097           },
16098           {
16099             "group": "Body",
16100             "type": "String",
16101             "optional": true,
16102             "field": "from",
16103             "description": ""
16104           },
16105           {
16106             "group": "Body",
16107             "type": "String",
16108             "optional": true,
16109             "field": "joinAt",
16110             "description": ""
16111           },
16112           {
16113             "group": "Body",
16114             "type": "String",
16115             "optional": true,
16116             "field": "leaveAt",
16117             "description": ""
16118           },
16119           {
16120             "group": "Body",
16121             "type": "String",
16122             "optional": true,
16123             "field": "acceptAt",
16124             "description": ""
16125           },
16126           {
16127             "group": "Body",
16128             "type": "String",
16129             "optional": true,
16130             "field": "exitAt",
16131             "description": ""
16132           },
16133           {
16134             "group": "Body",
16135             "type": "String",
16136             "optional": true,
16137             "field": "reason",
16138             "description": ""
16139           }
16140         ]
16141       }
16142     },
16143     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16144     "version": "0.0.0",
16145     "filename": "server/api/mailQueueReport/index.js",
16146     "groupTitle": "Mail_Queue_Reports"
16147   },
16148   {
16149     "type": "delete",
16150     "url": "/api/mail/reports/queue/{id}",
16151     "title": "Deletes a Mail Queue Report",
16152     "examples": [
16153       {
16154         "title": "Example usage:",
16155         "content": "curl https://{domain}/api/mail/reports/queue/{id} -v -u {name}:{password} -X DELETE",
16156         "type": "json"
16157       }
16158     ],
16159     "name": "DeleteMail_Queue_Reports",
16160     "group": "Mail_Queue_Reports",
16161     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16162     "version": "0.0.0",
16163     "filename": "server/api/mailQueueReport/index.js",
16164     "groupTitle": "Mail_Queue_Reports"
16165   },
16166   {
16167     "type": "get",
16168     "url": "/api/mail/reports/queue/describe",
16169     "title": "Gets table info about Mail Queue Reports",
16170     "examples": [
16171       {
16172         "title": "Example usage:",
16173         "content": "curl https://{domain}/api/mail/reports/queue/describe -v -u {name}:{password}",
16174         "type": "json"
16175       }
16176     ],
16177     "name": "DescribeMail_Queue_Reports",
16178     "group": "Mail_Queue_Reports",
16179     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16180     "version": "0.0.0",
16181     "filename": "server/api/mailQueueReport/index.js",
16182     "groupTitle": "Mail_Queue_Reports"
16183   },
16184   {
16185     "type": "get",
16186     "url": "/api/mail/reports/queue",
16187     "title": "Gets a list of Mail Queue Reports",
16188     "examples": [
16189       {
16190         "title": "Example usage:",
16191         "content": "curl https://{domain}/api/mail/reports/queue -v -u {name}:{password}",
16192         "type": "json"
16193       }
16194     ],
16195     "name": "GetMail_Queue_Reports",
16196     "group": "Mail_Queue_Reports",
16197     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
16198     "version": "0.0.0",
16199     "filename": "server/api/mailQueueReport/index.js",
16200     "groupTitle": "Mail_Queue_Reports"
16201   },
16202   {
16203     "type": "get",
16204     "url": "/api/mail/reports/queue/{id}",
16205     "title": "Gets a single Mail Queue Report",
16206     "examples": [
16207       {
16208         "title": "Example usage:",
16209         "content": "curl https://{domain}/api/mail/reports/queue/{id} -v -u {name}:{password}",
16210         "type": "json"
16211       }
16212     ],
16213     "name": "ShowMail_Queue_Reports",
16214     "group": "Mail_Queue_Reports",
16215     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16216     "version": "0.0.0",
16217     "filename": "server/api/mailQueueReport/index.js",
16218     "groupTitle": "Mail_Queue_Reports"
16219   },
16220   {
16221     "type": "put",
16222     "url": "/api/mail/reports/queue/{id}",
16223     "title": "Update an existing Mail Queue Report",
16224     "examples": [
16225       {
16226         "title": "Example usage:",
16227         "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",
16228         "type": "json"
16229       }
16230     ],
16231     "name": "updateMail_Queue_Reports",
16232     "group": "Mail_Queue_Reports",
16233     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16234     "version": "0.0.0",
16235     "filename": "server/api/mailQueueReport/index.js",
16236     "groupTitle": "Mail_Queue_Reports"
16237   },
16238   {
16239     "type": "post",
16240     "url": "/api/mail/queues/{id}/users",
16241     "title": "Add agents to a queue",
16242     "examples": [
16243       {
16244         "title": "Example usage:",
16245         "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",
16246         "type": "json"
16247       }
16248     ],
16249     "name": "AddAgents",
16250     "group": "Mail_Queues",
16251     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16252     "version": "0.0.0",
16253     "filename": "server/api/mailQueue/index.js",
16254     "groupTitle": "Mail_Queues"
16255   },
16256   {
16257     "type": "post",
16258     "url": "/api/mail/queues/{id}/teams",
16259     "title": "Add teams to a queue",
16260     "examples": [
16261       {
16262         "title": "Example usage:",
16263         "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",
16264         "type": "json"
16265       }
16266     ],
16267     "name": "AddTeams",
16268     "group": "Mail_Queues",
16269     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16270     "version": "0.0.0",
16271     "filename": "server/api/mailQueue/index.js",
16272     "groupTitle": "Mail_Queues"
16273   },
16274   {
16275     "type": "post",
16276     "url": "/api/mail/queues",
16277     "title": "Creates a new Queue",
16278     "examples": [
16279       {
16280         "title": "Example usage:",
16281         "content": "curl https://{domain}/api/mail/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
16282         "type": "json"
16283       }
16284     ],
16285     "name": "CreateQueues",
16286     "group": "Mail_Queues",
16287     "parameter": {
16288       "fields": {
16289         "Body": [
16290           {
16291             "group": "Body",
16292             "type": "String",
16293             "optional": true,
16294             "field": "name",
16295             "description": ""
16296           },
16297           {
16298             "group": "Body",
16299             "type": "String",
16300             "optional": true,
16301             "field": "description",
16302             "description": ""
16303           },
16304           {
16305             "group": "Body",
16306             "type": "Integer",
16307             "optional": true,
16308             "field": "timeout",
16309             "description": ""
16310           },
16311           {
16312             "group": "Body",
16313             "type": "String",
16314             "allowedValues": [
16315               "\"rrmemory\"",
16316               "\"beepall\"",
16317               "\"roundrobin\""
16318             ],
16319             "optional": true,
16320             "field": "strategy",
16321             "description": ""
16322           }
16323         ]
16324       }
16325     },
16326     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16327     "version": "0.0.0",
16328     "filename": "server/api/mailQueue/index.js",
16329     "groupTitle": "Mail_Queues"
16330   },
16331   {
16332     "type": "delete",
16333     "url": "/api/mail/queues/{id}",
16334     "title": "Deletes a Queue",
16335     "examples": [
16336       {
16337         "title": "Example usage:",
16338         "content": "curl https://{domain}/api/mail/queues/{id} -v -u {name}:{password} -X DELETE",
16339         "type": "json"
16340       }
16341     ],
16342     "name": "DeleteQueues",
16343     "group": "Mail_Queues",
16344     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16345     "version": "0.0.0",
16346     "filename": "server/api/mailQueue/index.js",
16347     "groupTitle": "Mail_Queues"
16348   },
16349   {
16350     "type": "get",
16351     "url": "/api/mail/queues/describe",
16352     "title": "Gets table info about Queues",
16353     "examples": [
16354       {
16355         "title": "Example usage:",
16356         "content": "curl https://{domain}/api/mail/queues/describe -v -u {name}:{password}",
16357         "type": "json"
16358       }
16359     ],
16360     "name": "DescribeQueues",
16361     "group": "Mail_Queues",
16362     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16363     "version": "0.0.0",
16364     "filename": "server/api/mailQueue/index.js",
16365     "groupTitle": "Mail_Queues"
16366   },
16367   {
16368     "type": "get",
16369     "url": "/api/mail/queues/{id}/users",
16370     "title": "Gets queue agents",
16371     "examples": [
16372       {
16373         "title": "Example usage:",
16374         "content": "curl https://{domain}/api/mail/queues/{id}/users -v -u {name}:{password} -X POST",
16375         "type": "json"
16376       }
16377     ],
16378     "name": "GetAgents",
16379     "group": "Mail_Queues",
16380     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16381     "version": "0.0.0",
16382     "filename": "server/api/mailQueue/index.js",
16383     "groupTitle": "Mail_Queues"
16384   },
16385   {
16386     "type": "get",
16387     "url": "/api/mail/queues/{id}/members",
16388     "title": "GetMembers",
16389     "examples": [
16390       {
16391         "title": "Example usage:",
16392         "content": "curl https://{domain}/api/mail/queues/{id}/members  -v -u {name}:{password}",
16393         "type": "json"
16394       }
16395     ],
16396     "name": "GetMembers",
16397     "group": "Mail_Queues",
16398     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16399     "version": "0.0.0",
16400     "filename": "server/api/mailQueue/index.js",
16401     "groupTitle": "Mail_Queues"
16402   },
16403   {
16404     "type": "get",
16405     "url": "/api/mail/queues",
16406     "title": "Gets a list of Queues",
16407     "examples": [
16408       {
16409         "title": "Example usage:",
16410         "content": "curl https://{domain}/api/mail/queues -v -u {name}:{password}",
16411         "type": "json"
16412       }
16413     ],
16414     "name": "GetQueues",
16415     "group": "Mail_Queues",
16416     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/mail/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>",
16417     "version": "0.0.0",
16418     "filename": "server/api/mailQueue/index.js",
16419     "groupTitle": "Mail_Queues"
16420   },
16421   {
16422     "type": "get",
16423     "url": "/api/mail/queues/{id}/teams",
16424     "title": "Gets queues list",
16425     "examples": [
16426       {
16427         "title": "Example usage:",
16428         "content": "curl https://{domain}/api/mail/queues/{id}/teams -v -u {name}:{password}",
16429         "type": "json"
16430       }
16431     ],
16432     "name": "GetTeams",
16433     "group": "Mail_Queues",
16434     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16435     "version": "0.0.0",
16436     "filename": "server/api/mailQueue/index.js",
16437     "groupTitle": "Mail_Queues"
16438   },
16439   {
16440     "type": "delete",
16441     "url": "/api/mail/queues/{id}/users",
16442     "title": "Removes agents from a queue",
16443     "examples": [
16444       {
16445         "title": "Example usage:",
16446         "content": "curl https://{domain}/api/mail/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
16447         "type": "json"
16448       }
16449     ],
16450     "name": "RemoveAgents",
16451     "group": "Mail_Queues",
16452     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16453     "version": "0.0.0",
16454     "filename": "server/api/mailQueue/index.js",
16455     "groupTitle": "Mail_Queues"
16456   },
16457   {
16458     "type": "get",
16459     "url": "/api/mail/queues/{id}",
16460     "title": "Gets a single Queue",
16461     "examples": [
16462       {
16463         "title": "Example usage:",
16464         "content": "curl https://{domain}/api/mail/queues/{id} -v -u {name}:{password}",
16465         "type": "json"
16466       }
16467     ],
16468     "name": "ShowQueues",
16469     "group": "Mail_Queues",
16470     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16471     "version": "0.0.0",
16472     "filename": "server/api/mailQueue/index.js",
16473     "groupTitle": "Mail_Queues"
16474   },
16475   {
16476     "type": "put",
16477     "url": "/api/mail/queues/{id}",
16478     "title": "Update an existing Queue",
16479     "examples": [
16480       {
16481         "title": "Example usage:",
16482         "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",
16483         "type": "json"
16484       }
16485     ],
16486     "name": "updateQueues",
16487     "group": "Mail_Queues",
16488     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16489     "version": "0.0.0",
16490     "filename": "server/api/mailQueue/index.js",
16491     "groupTitle": "Mail_Queues"
16492   },
16493   {
16494     "type": "post",
16495     "url": "/api/mail/out_servers",
16496     "title": "Creates a new SMTP",
16497     "examples": [
16498       {
16499         "title": "Example usage:",
16500         "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",
16501         "type": "json"
16502       }
16503     ],
16504     "name": "CreateSMTPs",
16505     "group": "Mail_SMTP",
16506     "parameter": {
16507       "fields": {
16508         "Body": [
16509           {
16510             "group": "Body",
16511             "type": "String",
16512             "optional": true,
16513             "field": "description",
16514             "description": ""
16515           },
16516           {
16517             "group": "Body",
16518             "type": "String",
16519             "optional": true,
16520             "field": "host",
16521             "description": ""
16522           },
16523           {
16524             "group": "Body",
16525             "type": "String",
16526             "optional": true,
16527             "field": "user",
16528             "description": ""
16529           },
16530           {
16531             "group": "Body",
16532             "type": "String",
16533             "optional": true,
16534             "field": "pass",
16535             "description": ""
16536           },
16537           {
16538             "group": "Body",
16539             "type": "Integer",
16540             "optional": true,
16541             "field": "port",
16542             "description": ""
16543           },
16544           {
16545             "group": "Body",
16546             "type": "Boolean",
16547             "optional": true,
16548             "field": "secure",
16549             "description": ""
16550           },
16551           {
16552             "group": "Body",
16553             "type": "String",
16554             "optional": true,
16555             "field": "service",
16556             "description": ""
16557           },
16558           {
16559             "group": "Body",
16560             "type": "Boolean",
16561             "optional": true,
16562             "field": "authentication",
16563             "description": ""
16564           }
16565         ]
16566       }
16567     },
16568     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16569     "version": "0.0.0",
16570     "filename": "server/api/mailServerOut/index.js",
16571     "groupTitle": "Mail_SMTP"
16572   },
16573   {
16574     "type": "delete",
16575     "url": "/api/mail/out_servers/{id}",
16576     "title": "Deletes a SMTP",
16577     "examples": [
16578       {
16579         "title": "Example usage:",
16580         "content": "curl https://{domain}/api/mail/out_servers/{id} -v -u {name}:{password} -X DELETE",
16581         "type": "json"
16582       }
16583     ],
16584     "name": "DeleteSMTPs",
16585     "group": "Mail_SMTP",
16586     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16587     "version": "0.0.0",
16588     "filename": "server/api/mailServerOut/index.js",
16589     "groupTitle": "Mail_SMTP"
16590   },
16591   {
16592     "type": "get",
16593     "url": "/api/mail/out_servers",
16594     "title": "Gets a list of SMTPs",
16595     "examples": [
16596       {
16597         "title": "Example usage:",
16598         "content": "curl https://{domain}/api/mail/out_servers -v -u {name}:{password}",
16599         "type": "json"
16600       }
16601     ],
16602     "name": "GetSMTPs",
16603     "group": "Mail_SMTP",
16604     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
16605     "version": "0.0.0",
16606     "filename": "server/api/mailServerOut/index.js",
16607     "groupTitle": "Mail_SMTP"
16608   },
16609   {
16610     "type": "get",
16611     "url": "/api/mail/out_servers/{id}",
16612     "title": "Gets a single SMTP",
16613     "examples": [
16614       {
16615         "title": "Example usage:",
16616         "content": "curl https://{domain}/api/mail/out_servers/{id} -v -u {name}:{password}",
16617         "type": "json"
16618       }
16619     ],
16620     "name": "ShowSMTPs",
16621     "group": "Mail_SMTP",
16622     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16623     "version": "0.0.0",
16624     "filename": "server/api/mailServerOut/index.js",
16625     "groupTitle": "Mail_SMTP"
16626   },
16627   {
16628     "type": "put",
16629     "url": "/api/mail/out_servers/{id}",
16630     "title": "Update an existing SMTP",
16631     "examples": [
16632       {
16633         "title": "Example usage:",
16634         "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",
16635         "type": "json"
16636       }
16637     ],
16638     "name": "updateSMTPs",
16639     "group": "Mail_SMTP",
16640     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16641     "version": "0.0.0",
16642     "filename": "server/api/mailServerOut/index.js",
16643     "groupTitle": "Mail_SMTP"
16644   },
16645   {
16646     "type": "post",
16647     "url": "/api/mail/substatuses",
16648     "title": "Creates a new Queue",
16649     "examples": [
16650       {
16651         "title": "Example usage:",
16652         "content": "curl https://{domain}/api/mail/substatuses -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
16653         "type": "json"
16654       }
16655     ],
16656     "name": "CreateSubstatuses",
16657     "group": "Mail_Substatuses",
16658     "parameter": {
16659       "fields": {
16660         "Body": [
16661           {
16662             "group": "Body",
16663             "type": "String",
16664             "optional": false,
16665             "field": "name",
16666             "description": ""
16667           },
16668           {
16669             "group": "Body",
16670             "type": "String",
16671             "optional": true,
16672             "field": "description",
16673             "description": ""
16674           }
16675         ]
16676       }
16677     },
16678     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16679     "version": "0.0.0",
16680     "filename": "server/api/mailSubstatus/index.js",
16681     "groupTitle": "Mail_Substatuses"
16682   },
16683   {
16684     "type": "delete",
16685     "url": "/api/mail/substatuses/{id}",
16686     "title": "Deletes a Queue",
16687     "examples": [
16688       {
16689         "title": "Example usage:",
16690         "content": "curl https://{domain}/api/mail/substatuses/{id} -v -u {name}:{password} -X DELETE",
16691         "type": "json"
16692       }
16693     ],
16694     "name": "DeleteSubstatuses",
16695     "group": "Mail_Substatuses",
16696     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16697     "version": "0.0.0",
16698     "filename": "server/api/mailSubstatus/index.js",
16699     "groupTitle": "Mail_Substatuses"
16700   },
16701   {
16702     "type": "get",
16703     "url": "/api/mail/substatuses/describe",
16704     "title": "Gets table info about Substatuses",
16705     "examples": [
16706       {
16707         "title": "Example usage:",
16708         "content": "curl https://{domain}/api/mail/substatuses/describe -v -u {name}:{password}",
16709         "type": "json"
16710       }
16711     ],
16712     "name": "DescribeSubstatuses",
16713     "group": "Mail_Substatuses",
16714     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16715     "version": "0.0.0",
16716     "filename": "server/api/mailSubstatus/index.js",
16717     "groupTitle": "Mail_Substatuses"
16718   },
16719   {
16720     "type": "get",
16721     "url": "/api/mail/substatuses",
16722     "title": "Gets a list of Substatuses",
16723     "examples": [
16724       {
16725         "title": "Example usage:",
16726         "content": "curl https://{domain}/api/mail/substatuses -v -u {name}:{password}",
16727         "type": "json"
16728       }
16729     ],
16730     "name": "GetSubstatuses",
16731     "group": "Mail_Substatuses",
16732     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
16733     "version": "0.0.0",
16734     "filename": "server/api/mailSubstatus/index.js",
16735     "groupTitle": "Mail_Substatuses"
16736   },
16737   {
16738     "type": "get",
16739     "url": "/api/mail/substatuses/{id}",
16740     "title": "Gets a single Queue",
16741     "examples": [
16742       {
16743         "title": "Example usage:",
16744         "content": "curl https://{domain}/api/mail/substatuses/{id} -v -u {name}:{password}",
16745         "type": "json"
16746       }
16747     ],
16748     "name": "ShowSubstatuses",
16749     "group": "Mail_Substatuses",
16750     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16751     "version": "0.0.0",
16752     "filename": "server/api/mailSubstatus/index.js",
16753     "groupTitle": "Mail_Substatuses"
16754   },
16755   {
16756     "type": "put",
16757     "url": "/api/mail/substatuses/{id}",
16758     "title": "Update an existing Queue",
16759     "examples": [
16760       {
16761         "title": "Example usage:",
16762         "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",
16763         "type": "json"
16764       }
16765     ],
16766     "name": "updateSubstatuses",
16767     "group": "Mail_Substatuses",
16768     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16769     "version": "0.0.0",
16770     "filename": "server/api/mailSubstatus/index.js",
16771     "groupTitle": "Mail_Substatuses"
16772   },
16773   {
16774     "type": "post",
16775     "url": "/api/mail/reports/transfer",
16776     "title": "Creates a new Mail Transfer Report",
16777     "examples": [
16778       {
16779         "title": "Example usage:",
16780         "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",
16781         "type": "json"
16782       }
16783     ],
16784     "name": "CreateMail_Transfer_Reports",
16785     "group": "Mail_Transfer_Reports",
16786     "parameter": {
16787       "fields": {
16788         "Body": [
16789           {
16790             "group": "Body",
16791             "type": "String",
16792             "optional": false,
16793             "field": "uniqueid",
16794             "description": ""
16795           },
16796           {
16797             "group": "Body",
16798             "type": "String",
16799             "allowedValues": [
16800               "\"account\"",
16801               "\"agent\"",
16802               "\"queue\""
16803             ],
16804             "optional": false,
16805             "field": "type",
16806             "description": ""
16807           },
16808           {
16809             "group": "Body",
16810             "type": "String",
16811             "optional": false,
16812             "field": "transferredAt",
16813             "description": ""
16814           }
16815         ]
16816       }
16817     },
16818     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16819     "version": "0.0.0",
16820     "filename": "server/api/mailTransferReport/index.js",
16821     "groupTitle": "Mail_Transfer_Reports"
16822   },
16823   {
16824     "type": "delete",
16825     "url": "/api/mail/reports/transfer/{id}",
16826     "title": "Deletes a Mail Transfer Report",
16827     "examples": [
16828       {
16829         "title": "Example usage:",
16830         "content": "curl https://{domain}/api/mail/reports/transfer/{id} -v -u {name}:{password} -X DELETE",
16831         "type": "json"
16832       }
16833     ],
16834     "name": "DeleteMail_Transfer_Reports",
16835     "group": "Mail_Transfer_Reports",
16836     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16837     "version": "0.0.0",
16838     "filename": "server/api/mailTransferReport/index.js",
16839     "groupTitle": "Mail_Transfer_Reports"
16840   },
16841   {
16842     "type": "get",
16843     "url": "/api/mail/reports/transfer/describe",
16844     "title": "Gets table info about Mail Transfer Reports",
16845     "examples": [
16846       {
16847         "title": "Example usage:",
16848         "content": "curl https://{domain}/api/mail/reports/transfer/describe -v -u {name}:{password}",
16849         "type": "json"
16850       }
16851     ],
16852     "name": "DescribeMail_Transfer_Reports",
16853     "group": "Mail_Transfer_Reports",
16854     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16855     "version": "0.0.0",
16856     "filename": "server/api/mailTransferReport/index.js",
16857     "groupTitle": "Mail_Transfer_Reports"
16858   },
16859   {
16860     "type": "get",
16861     "url": "/api/mail/reports/transfer",
16862     "title": "Gets a list of Mail Transfer Reports",
16863     "examples": [
16864       {
16865         "title": "Example usage:",
16866         "content": "curl https://{domain}/api/mail/reports/transfer -v -u {name}:{password}",
16867         "type": "json"
16868       }
16869     ],
16870     "name": "GetMail_Transfer_Reports",
16871     "group": "Mail_Transfer_Reports",
16872     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
16873     "version": "0.0.0",
16874     "filename": "server/api/mailTransferReport/index.js",
16875     "groupTitle": "Mail_Transfer_Reports"
16876   },
16877   {
16878     "type": "get",
16879     "url": "/api/mail/reports/transfer/{id}",
16880     "title": "Gets a single Mail Transfer Report",
16881     "examples": [
16882       {
16883         "title": "Example usage:",
16884         "content": "curl https://{domain}/api/mail/reports/transfer/{id} -v -u {name}:{password}",
16885         "type": "json"
16886       }
16887     ],
16888     "name": "ShowMail_Transfer_Reports",
16889     "group": "Mail_Transfer_Reports",
16890     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16891     "version": "0.0.0",
16892     "filename": "server/api/mailTransferReport/index.js",
16893     "groupTitle": "Mail_Transfer_Reports"
16894   },
16895   {
16896     "type": "put",
16897     "url": "/api/mail/reports/transfer/{id}",
16898     "title": "Update an existing Mail Transfer Report",
16899     "examples": [
16900       {
16901         "title": "Example usage:",
16902         "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",
16903         "type": "json"
16904       }
16905     ],
16906     "name": "updateMail_Transfer_Reports",
16907     "group": "Mail_Transfer_Reports",
16908     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16909     "version": "0.0.0",
16910     "filename": "server/api/mailTransferReport/index.js",
16911     "groupTitle": "Mail_Transfer_Reports"
16912   },
16913   {
16914     "type": "get",
16915     "url": "/api/members/reports/describe",
16916     "title": "Gets table info about Member Reports",
16917     "examples": [
16918       {
16919         "title": "Example usage:",
16920         "content": "curl https://{domain}/api/members/reports/describe -v -u {name}:{password}",
16921         "type": "json"
16922       }
16923     ],
16924     "name": "DescribeMember_Reports",
16925     "group": "Member_Reports",
16926     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16927     "version": "0.0.0",
16928     "filename": "server/api/memberReport/index.js",
16929     "groupTitle": "Member_Reports"
16930   },
16931   {
16932     "type": "get",
16933     "url": "/api/members/reports",
16934     "title": "Gets a list of Member Reports",
16935     "examples": [
16936       {
16937         "title": "Example usage:",
16938         "content": "curl https://{domain}/api/members/reports -v -u {name}:{password}",
16939         "type": "json"
16940       }
16941     ],
16942     "name": "GetMember_Reports",
16943     "group": "Member_Reports",
16944     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
16945     "version": "0.0.0",
16946     "filename": "server/api/memberReport/index.js",
16947     "groupTitle": "Member_Reports"
16948   },
16949   {
16950     "type": "get",
16951     "url": "/api/members/reports/{id}",
16952     "title": "Gets a single Member Report",
16953     "examples": [
16954       {
16955         "title": "Example usage:",
16956         "content": "curl https://{domain}/api/members/reports/{id} -v -u {name}:{password}",
16957         "type": "json"
16958       }
16959     ],
16960     "name": "ShowMember_Reports",
16961     "group": "Member_Reports",
16962     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16963     "version": "0.0.0",
16964     "filename": "server/api/memberReport/index.js",
16965     "groupTitle": "Member_Reports"
16966   },
16967   {
16968     "type": "get",
16969     "url": "/api/migrations",
16970     "title": "Gets a list of Migrations",
16971     "examples": [
16972       {
16973         "title": "Example usage:",
16974         "content": "curl https://{domain}/api/migrations -v -u {name}:{password}",
16975         "type": "json"
16976       }
16977     ],
16978     "name": "GetMigrations",
16979     "group": "Migrations",
16980     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
16981     "version": "0.0.0",
16982     "filename": "server/api/migration/index.js",
16983     "groupTitle": "Migrations"
16984   },
16985   {
16986     "type": "post",
16987     "url": "/api/voice/networks",
16988     "title": "Create a new network",
16989     "examples": [
16990       {
16991         "title": "Example usage:",
16992         "content": "curl https://{domain}/api/voice/networks -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
16993         "type": "json"
16994       }
16995     ],
16996     "name": "Create",
16997     "group": "Networks",
16998     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16999     "version": "0.0.0",
17000     "filename": "server/api/network/index.js",
17001     "groupTitle": "Networks"
17002   },
17003   {
17004     "type": "delete",
17005     "url": "/api/voice/networks/{id}",
17006     "title": "Deletes a network",
17007     "examples": [
17008       {
17009         "title": "Example usage:",
17010         "content": "curl https://{domain}/api/voice/networks/{id} -v -u {name}:{password} -X DELETE",
17011         "type": "json"
17012       }
17013     ],
17014     "name": "Delete",
17015     "group": "Networks",
17016     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17017     "version": "0.0.0",
17018     "filename": "server/api/network/index.js",
17019     "groupTitle": "Networks"
17020   },
17021   {
17022     "type": "get",
17023     "url": "/api/networks",
17024     "title": "Gets a list of Networks",
17025     "examples": [
17026       {
17027         "title": "Example usage:",
17028         "content": "curl https://{domain}/api/networks -v -u {name}:{password}",
17029         "type": "json"
17030       }
17031     ],
17032     "name": "GetNetworks",
17033     "group": "Networks",
17034     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
17035     "version": "0.0.0",
17036     "filename": "server/api/network/index.js",
17037     "groupTitle": "Networks"
17038   },
17039   {
17040     "type": "get",
17041     "url": "/api/networks/{id}",
17042     "title": "Gets a single Network",
17043     "examples": [
17044       {
17045         "title": "Example usage:",
17046         "content": "curl https://{domain}/api/networks/{id} -v -u {name}:{password}",
17047         "type": "json"
17048       }
17049     ],
17050     "name": "ShowNetworks",
17051     "group": "Networks",
17052     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17053     "version": "0.0.0",
17054     "filename": "server/api/network/index.js",
17055     "groupTitle": "Networks"
17056   },
17057   {
17058     "type": "put",
17059     "url": "/api/voice/networks/{id}",
17060     "title": "Update an existing network",
17061     "examples": [
17062       {
17063         "title": "Example usage:",
17064         "content": "curl https://{domain}/api/voice/networks/{id} -v -u {name}:{password} -X PUT",
17065         "type": "json"
17066       }
17067     ],
17068     "name": "Update",
17069     "group": "Networks",
17070     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17071     "version": "0.0.0",
17072     "filename": "server/api/network/index.js",
17073     "groupTitle": "Networks"
17074   },
17075   {
17076     "type": "post",
17077     "url": "/api/notifications",
17078     "title": "Send notification to user",
17079     "examples": [
17080       {
17081         "title": "Example usage:",
17082         "content": "curl https://{domain}/api/notifications -d '{\"text\": \"Hello!\", \"TemplateId\": 1}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
17083         "type": "json"
17084       }
17085     ],
17086     "name": "Send",
17087     "group": "Notifications",
17088     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17089     "version": "0.0.0",
17090     "filename": "server/api/notification/index.js",
17091     "groupTitle": "Notifications"
17092   },
17093   {
17094     "type": "post",
17095     "url": "/api/openchannel/accounts/{id}/users",
17096     "title": "Add agents to a openchannel account",
17097     "examples": [
17098       {
17099         "title": "Example usage:",
17100         "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",
17101         "type": "json"
17102       }
17103     ],
17104     "name": "AddAgents",
17105     "group": "Openchannel_Accounts",
17106     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17107     "version": "0.0.0",
17108     "filename": "server/api/openchannelAccount/index.js",
17109     "groupTitle": "Openchannel_Accounts"
17110   },
17111   {
17112     "type": "post",
17113     "url": "/api/openchannel/accounts",
17114     "title": "Creates a new Account",
17115     "examples": [
17116       {
17117         "title": "Example usage:",
17118         "content": "curl https://{domain}/api/openchannel/accounts -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
17119         "type": "json"
17120       }
17121     ],
17122     "name": "CreateAccounts",
17123     "group": "Openchannel_Accounts",
17124     "parameter": {
17125       "fields": {
17126         "Body": [
17127           {
17128             "group": "Body",
17129             "type": "String",
17130             "optional": false,
17131             "field": "name",
17132             "description": ""
17133           },
17134           {
17135             "group": "Body",
17136             "type": "String",
17137             "optional": true,
17138             "field": "description",
17139             "description": ""
17140           },
17141           {
17142             "group": "Body",
17143             "type": "String",
17144             "optional": true,
17145             "field": "token",
17146             "description": ""
17147           },
17148           {
17149             "group": "Body",
17150             "type": "String",
17151             "optional": true,
17152             "field": "replyUri",
17153             "description": ""
17154           },
17155           {
17156             "group": "Body",
17157             "type": "String",
17158             "optional": false,
17159             "field": "key",
17160             "description": ""
17161           },
17162           {
17163             "group": "Body",
17164             "type": "Text",
17165             "optional": true,
17166             "field": "notificationTemplate",
17167             "description": ""
17168           },
17169           {
17170             "group": "Body",
17171             "type": "Boolean",
17172             "optional": true,
17173             "field": "notificationSound",
17174             "description": ""
17175           },
17176           {
17177             "group": "Body",
17178             "type": "Boolean",
17179             "optional": true,
17180             "field": "notificationShake",
17181             "description": ""
17182           },
17183           {
17184             "group": "Body",
17185             "type": "Integer",
17186             "optional": true,
17187             "field": "waitForTheAssignedAgent",
17188             "description": ""
17189           },
17190           {
17191             "group": "Body",
17192             "type": "String",
17193             "optional": true,
17194             "field": "mapKey",
17195             "description": ""
17196           },
17197           {
17198             "group": "Body",
17199             "type": "Boolean",
17200             "optional": true,
17201             "field": "queueTransfer",
17202             "description": ""
17203           },
17204           {
17205             "group": "Body",
17206             "type": "Integer",
17207             "optional": true,
17208             "field": "queueTransferTimeout",
17209             "description": ""
17210           },
17211           {
17212             "group": "Body",
17213             "type": "Boolean",
17214             "optional": true,
17215             "field": "agentTransfer",
17216             "description": ""
17217           },
17218           {
17219             "group": "Body",
17220             "type": "Integer",
17221             "optional": true,
17222             "field": "agentTransferTimeout",
17223             "description": ""
17224           },
17225           {
17226             "group": "Body",
17227             "type": "Integer",
17228             "optional": true,
17229             "field": "mandatoryDispositionPauseId",
17230             "description": "<p>Status to put when mandatory disposition is enabled</p>"
17231           },
17232           {
17233             "group": "Body",
17234             "type": "Boolean",
17235             "optional": true,
17236             "field": "mandatoryDisposition",
17237             "description": "<p>Enabled/disables mandatory dispo on a queue</p>"
17238           }
17239         ]
17240       }
17241     },
17242     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17243     "version": "0.0.0",
17244     "filename": "server/api/openchannelAccount/index.js",
17245     "groupTitle": "Openchannel_Accounts"
17246   },
17247   {
17248     "type": "delete",
17249     "url": "/api/openchannel/accounts/{id}",
17250     "title": "Deletes a Account",
17251     "examples": [
17252       {
17253         "title": "Example usage:",
17254         "content": "curl https://{domain}/api/openchannel/accounts/{id} -v -u {name}:{password} -X DELETE",
17255         "type": "json"
17256       }
17257     ],
17258     "name": "DeleteAccounts",
17259     "group": "Openchannel_Accounts",
17260     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17261     "version": "0.0.0",
17262     "filename": "server/api/openchannelAccount/index.js",
17263     "groupTitle": "Openchannel_Accounts"
17264   },
17265   {
17266     "type": "get",
17267     "url": "/api/openchannel/accounts/describe",
17268     "title": "Gets table info about Accounts",
17269     "examples": [
17270       {
17271         "title": "Example usage:",
17272         "content": "curl https://{domain}/api/openchannel/accounts/describe -v -u {name}:{password}",
17273         "type": "json"
17274       }
17275     ],
17276     "name": "DescribeAccounts",
17277     "group": "Openchannel_Accounts",
17278     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17279     "version": "0.0.0",
17280     "filename": "server/api/openchannelAccount/index.js",
17281     "groupTitle": "Openchannel_Accounts"
17282   },
17283   {
17284     "type": "get",
17285     "url": "/api/openchannel/accounts",
17286     "title": "Gets a list of Accounts",
17287     "examples": [
17288       {
17289         "title": "Example usage:",
17290         "content": "curl https://{domain}/api/openchannel/accounts -v -u {name}:{password}",
17291         "type": "json"
17292       }
17293     ],
17294     "name": "GetAccounts",
17295     "group": "Openchannel_Accounts",
17296     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
17297     "version": "0.0.0",
17298     "filename": "server/api/openchannelAccount/index.js",
17299     "groupTitle": "Openchannel_Accounts"
17300   },
17301   {
17302     "type": "get",
17303     "url": "/api/openchannel/accounts/{id}/users",
17304     "title": "Gets agents from openchannel account",
17305     "examples": [
17306       {
17307         "title": "Example usage:",
17308         "content": "curl https://{domain}/api/openchannel/accounts/{id}/users -v -u {name}:{password} -X GET",
17309         "type": "json"
17310       }
17311     ],
17312     "name": "GetAgents",
17313     "group": "Openchannel_Accounts",
17314     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17315     "version": "0.0.0",
17316     "filename": "server/api/openchannelAccount/index.js",
17317     "groupTitle": "Openchannel_Accounts"
17318   },
17319   {
17320     "type": "delete",
17321     "url": "/api/openchannel/accounts/{id}/users",
17322     "title": "Removes agents from a openchannel account",
17323     "examples": [
17324       {
17325         "title": "Example usage:",
17326         "content": "curl https://{domain}/api/openchannel/accounts/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
17327         "type": "json"
17328       }
17329     ],
17330     "name": "RemoveAgents",
17331     "group": "Openchannel_Accounts",
17332     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17333     "version": "0.0.0",
17334     "filename": "server/api/openchannelAccount/index.js",
17335     "groupTitle": "Openchannel_Accounts"
17336   },
17337   {
17338     "type": "delete",
17339     "url": "/api/openchannel/accounts/{id}/canned_answers",
17340     "title": "Removes canned answers from account",
17341     "examples": [
17342       {
17343         "title": "Example usage:",
17344         "content": "curl https://{domain}/api/openchannel/accounts/{id}/canned_answers?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
17345         "type": "json"
17346       }
17347     ],
17348     "name": "RemoveAnswers",
17349     "group": "Openchannel_Accounts",
17350     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17351     "version": "0.0.0",
17352     "filename": "server/api/openchannelAccount/index.js",
17353     "groupTitle": "Openchannel_Accounts"
17354   },
17355   {
17356     "type": "delete",
17357     "url": "/api/openchannel/accounts/{id}/dispositions",
17358     "title": "Removes dispositions from account",
17359     "examples": [
17360       {
17361         "title": "Example usage:",
17362         "content": "curl https://{domain}/api/openchannel/accounts/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
17363         "type": "json"
17364       }
17365     ],
17366     "name": "RemoveDispositions",
17367     "group": "Openchannel_Accounts",
17368     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17369     "version": "0.0.0",
17370     "filename": "server/api/openchannelAccount/index.js",
17371     "groupTitle": "Openchannel_Accounts"
17372   },
17373   {
17374     "type": "get",
17375     "url": "/api/openchannel/accounts/{id}",
17376     "title": "Gets a single Account",
17377     "examples": [
17378       {
17379         "title": "Example usage:",
17380         "content": "curl https://{domain}/api/openchannel/accounts/{id} -v -u {name}:{password}",
17381         "type": "json"
17382       }
17383     ],
17384     "name": "ShowAccounts",
17385     "group": "Openchannel_Accounts",
17386     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17387     "version": "0.0.0",
17388     "filename": "server/api/openchannelAccount/index.js",
17389     "groupTitle": "Openchannel_Accounts"
17390   },
17391   {
17392     "type": "post",
17393     "url": "/api/openchannel/accounts/{id}/canned_answers",
17394     "title": "Creates new canned answer",
17395     "examples": [
17396       {
17397         "title": "Example usage:",
17398         "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",
17399         "type": "json"
17400       }
17401     ],
17402     "name": "addAnswer",
17403     "group": "Openchannel_Accounts",
17404     "parameter": {
17405       "fields": {
17406         "Body": [
17407           {
17408             "group": "Body",
17409             "type": "String",
17410             "optional": false,
17411             "field": "key",
17412             "description": ""
17413           },
17414           {
17415             "group": "Body",
17416             "type": "Text",
17417             "optional": false,
17418             "field": "value",
17419             "description": ""
17420           },
17421           {
17422             "group": "Body",
17423             "type": "String",
17424             "optional": true,
17425             "field": "description",
17426             "description": ""
17427           },
17428           {
17429             "group": "Body",
17430             "type": "Virtual",
17431             "optional": true,
17432             "field": "name",
17433             "description": ""
17434           }
17435         ]
17436       }
17437     },
17438     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17439     "version": "0.0.0",
17440     "filename": "server/api/openchannelAccount/index.js",
17441     "groupTitle": "Openchannel_Accounts"
17442   },
17443   {
17444     "type": "post",
17445     "url": "/api/openchannel/accounts/{id}/applications",
17446     "title": "Creates new applications",
17447     "examples": [
17448       {
17449         "title": "Example usage:",
17450         "content": "curl https://{domain}/api/openchannel/accounts/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
17451         "type": "json"
17452       }
17453     ],
17454     "name": "addApplications",
17455     "group": "Openchannel_Accounts",
17456     "parameter": {
17457       "fields": {
17458         "Body": [
17459           {
17460             "group": "Body",
17461             "type": "Integer",
17462             "optional": false,
17463             "field": "priority",
17464             "description": ""
17465           },
17466           {
17467             "group": "Body",
17468             "type": "String",
17469             "optional": false,
17470             "field": "app",
17471             "description": ""
17472           },
17473           {
17474             "group": "Body",
17475             "type": "Text",
17476             "optional": true,
17477             "field": "appdata",
17478             "description": ""
17479           },
17480           {
17481             "group": "Body",
17482             "type": "String",
17483             "optional": true,
17484             "field": "description",
17485             "description": ""
17486           },
17487           {
17488             "group": "Body",
17489             "type": "String",
17490             "optional": true,
17491             "field": "interval",
17492             "description": ""
17493           }
17494         ]
17495       }
17496     },
17497     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17498     "version": "0.0.0",
17499     "filename": "server/api/openchannelAccount/index.js",
17500     "groupTitle": "Openchannel_Accounts"
17501   },
17502   {
17503     "type": "post",
17504     "url": "/api/openchannel/accounts/{id}/dispositions",
17505     "title": "Creates new disposition",
17506     "examples": [
17507       {
17508         "title": "Example usage:",
17509         "content": "curl https://{domain}/api/openchannel/accounts/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
17510         "type": "json"
17511       }
17512     ],
17513     "name": "addDisposition",
17514     "group": "Openchannel_Accounts",
17515     "parameter": {
17516       "fields": {
17517         "Body": [
17518           {
17519             "group": "Body",
17520             "type": "String",
17521             "optional": false,
17522             "field": "name",
17523             "description": ""
17524           }
17525         ]
17526       }
17527     },
17528     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17529     "version": "0.0.0",
17530     "filename": "server/api/openchannelAccount/index.js",
17531     "groupTitle": "Openchannel_Accounts"
17532   },
17533   {
17534     "type": "get",
17535     "url": "/api/openchannel/accounts/{id}/canned_answers",
17536     "title": "Gets account canned answers",
17537     "examples": [
17538       {
17539         "title": "Example usage:",
17540         "content": "curl https://{domain}/api/openchannel/accounts/{id}/canned_answers -v -u {name}:{password} -X GET",
17541         "type": "json"
17542       }
17543     ],
17544     "name": "getAnswers",
17545     "group": "Openchannel_Accounts",
17546     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17547     "version": "0.0.0",
17548     "filename": "server/api/openchannelAccount/index.js",
17549     "groupTitle": "Openchannel_Accounts"
17550   },
17551   {
17552     "type": "get",
17553     "url": "/api/openchannel/accounts/{id}/applications",
17554     "title": "Gets account applications",
17555     "examples": [
17556       {
17557         "title": "Example usage:",
17558         "content": "curl https://{domain}/api/openchannel/accounts/{id}/applications -v -u {name}:{password} -X GET",
17559         "type": "json"
17560       }
17561     ],
17562     "name": "getApplications",
17563     "group": "Openchannel_Accounts",
17564     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17565     "version": "0.0.0",
17566     "filename": "server/api/openchannelAccount/index.js",
17567     "groupTitle": "Openchannel_Accounts"
17568   },
17569   {
17570     "type": "get",
17571     "url": "/api/openchannel/accounts/{id}/dispositions",
17572     "title": "Gets account dispositions",
17573     "examples": [
17574       {
17575         "title": "Example usage:",
17576         "content": "curl https://{domain}/api/openchannel/accounts/{id}/dispositions -v -u {name}:{password} -X GET",
17577         "type": "json"
17578       }
17579     ],
17580     "name": "getDispositions",
17581     "group": "Openchannel_Accounts",
17582     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17583     "version": "0.0.0",
17584     "filename": "server/api/openchannelAccount/index.js",
17585     "groupTitle": "Openchannel_Accounts"
17586   },
17587   {
17588     "type": "get",
17589     "url": "/api/openchannel/accounts/{id}/interactions",
17590     "title": "Gets Openchannel Account Interactions",
17591     "examples": [
17592       {
17593         "title": "Example usage:",
17594         "content": "curl https://{domain}/api/openchannel/accounts/{id}/interactions -v -u {name}:{password} -X GET",
17595         "type": "json"
17596       }
17597     ],
17598     "name": "getInteractions",
17599     "group": "Openchannel_Accounts",
17600     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17601     "version": "0.0.0",
17602     "filename": "server/api/openchannelAccount/index.js",
17603     "groupTitle": "Openchannel_Accounts"
17604   },
17605   {
17606     "type": "post",
17607     "url": "/api/openchannel/accounts/{id}/notify",
17608     "title": "Notify new message",
17609     "examples": [
17610       {
17611         "title": "Example usage:",
17612         "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",
17613         "type": "json"
17614       }
17615     ],
17616     "name": "notify",
17617     "group": "Openchannel_Accounts",
17618     "description": "<p>Motion 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>",
17619     "version": "0.0.0",
17620     "filename": "server/api/openchannelAccount/index.js",
17621     "groupTitle": "Openchannel_Accounts"
17622   },
17623   {
17624     "type": "post",
17625     "url": "/api/openchannel/accounts/{id}/send",
17626     "title": "Send new openchannel message",
17627     "examples": [
17628       {
17629         "title": "Example usage:",
17630         "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",
17631         "type": "json"
17632       }
17633     ],
17634     "name": "sendOpenchannel",
17635     "group": "Openchannel_Accounts",
17636     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17637     "version": "0.0.0",
17638     "filename": "server/api/openchannelAccount/index.js",
17639     "groupTitle": "Openchannel_Accounts"
17640   },
17641   {
17642     "type": "put",
17643     "url": "/api/openchannel/accounts/{id}",
17644     "title": "Update an existing Account",
17645     "examples": [
17646       {
17647         "title": "Example usage:",
17648         "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",
17649         "type": "json"
17650       }
17651     ],
17652     "name": "updateAccounts",
17653     "group": "Openchannel_Accounts",
17654     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17655     "version": "0.0.0",
17656     "filename": "server/api/openchannelAccount/index.js",
17657     "groupTitle": "Openchannel_Accounts"
17658   },
17659   {
17660     "type": "post",
17661     "url": "/api/openchannel/applications",
17662     "title": "Creates a new Application",
17663     "examples": [
17664       {
17665         "title": "Example usage:",
17666         "content": "curl https://{domain}/api/openchannel/applications -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
17667         "type": "json"
17668       }
17669     ],
17670     "name": "CreateApplications",
17671     "group": "Openchannel_Applications",
17672     "parameter": {
17673       "fields": {
17674         "Body": [
17675           {
17676             "group": "Body",
17677             "type": "Integer",
17678             "optional": false,
17679             "field": "priority",
17680             "description": ""
17681           },
17682           {
17683             "group": "Body",
17684             "type": "String",
17685             "optional": false,
17686             "field": "app",
17687             "description": ""
17688           },
17689           {
17690             "group": "Body",
17691             "type": "Text",
17692             "optional": true,
17693             "field": "appdata",
17694             "description": ""
17695           },
17696           {
17697             "group": "Body",
17698             "type": "String",
17699             "optional": true,
17700             "field": "description",
17701             "description": ""
17702           },
17703           {
17704             "group": "Body",
17705             "type": "String",
17706             "optional": true,
17707             "field": "interval",
17708             "description": ""
17709           }
17710         ]
17711       }
17712     },
17713     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17714     "version": "0.0.0",
17715     "filename": "server/api/openchannelApplication/index.js",
17716     "groupTitle": "Openchannel_Applications"
17717   },
17718   {
17719     "type": "delete",
17720     "url": "/api/openchannel/applications/{id}",
17721     "title": "Deletes a Application",
17722     "examples": [
17723       {
17724         "title": "Example usage:",
17725         "content": "curl https://{domain}/api/openchannel/applications/{id} -v -u {name}:{password} -X DELETE",
17726         "type": "json"
17727       }
17728     ],
17729     "name": "DeleteApplications",
17730     "group": "Openchannel_Applications",
17731     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17732     "version": "0.0.0",
17733     "filename": "server/api/openchannelApplication/index.js",
17734     "groupTitle": "Openchannel_Applications"
17735   },
17736   {
17737     "type": "get",
17738     "url": "/api/openchannel/applications",
17739     "title": "Gets a list of Applications",
17740     "examples": [
17741       {
17742         "title": "Example usage:",
17743         "content": "curl https://{domain}/api/openchannel/applications -v -u {name}:{password}",
17744         "type": "json"
17745       }
17746     ],
17747     "name": "GetApplications",
17748     "group": "Openchannel_Applications",
17749     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
17750     "version": "0.0.0",
17751     "filename": "server/api/openchannelApplication/index.js",
17752     "groupTitle": "Openchannel_Applications"
17753   },
17754   {
17755     "type": "get",
17756     "url": "/api/openchannel/applications/{id}",
17757     "title": "Gets a single Application",
17758     "examples": [
17759       {
17760         "title": "Example usage:",
17761         "content": "curl https://{domain}/api/openchannel/applications/{id} -v -u {name}:{password}",
17762         "type": "json"
17763       }
17764     ],
17765     "name": "ShowApplications",
17766     "group": "Openchannel_Applications",
17767     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17768     "version": "0.0.0",
17769     "filename": "server/api/openchannelApplication/index.js",
17770     "groupTitle": "Openchannel_Applications"
17771   },
17772   {
17773     "type": "put",
17774     "url": "/api/openchannel/applications/{id}",
17775     "title": "Update an existing Application",
17776     "examples": [
17777       {
17778         "title": "Example usage:",
17779         "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",
17780         "type": "json"
17781       }
17782     ],
17783     "name": "updateApplications",
17784     "group": "Openchannel_Applications",
17785     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17786     "version": "0.0.0",
17787     "filename": "server/api/openchannelApplication/index.js",
17788     "groupTitle": "Openchannel_Applications"
17789   },
17790   {
17791     "type": "post",
17792     "url": "/api/openchannel/interactions/{id}/tags",
17793     "title": "Add tags to the interaction",
17794     "examples": [
17795       {
17796         "title": "Example usage:",
17797         "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",
17798         "type": "json"
17799       }
17800     ],
17801     "name": "AddTags",
17802     "group": "Openchannel_Interactions",
17803     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17804     "version": "0.0.0",
17805     "filename": "server/api/openchannelInteraction/index.js",
17806     "groupTitle": "Openchannel_Interactions"
17807   },
17808   {
17809     "type": "post",
17810     "url": "/api/openchannel/interactions",
17811     "title": "Creates a new Interaction",
17812     "examples": [
17813       {
17814         "title": "Example usage:",
17815         "content": "curl https://{domain}/api/openchannel/interactions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
17816         "type": "json"
17817       }
17818     ],
17819     "name": "CreateInteractions",
17820     "group": "Openchannel_Interactions",
17821     "parameter": {
17822       "fields": {
17823         "Body": [
17824           {
17825             "group": "Body",
17826             "type": "Boolean",
17827             "optional": true,
17828             "field": "closed",
17829             "description": ""
17830           },
17831           {
17832             "group": "Body",
17833             "type": "String",
17834             "optional": true,
17835             "field": "closedAt",
17836             "description": ""
17837           },
17838           {
17839             "group": "Body",
17840             "type": "String",
17841             "optional": true,
17842             "field": "disposition",
17843             "description": ""
17844           },
17845           {
17846             "group": "Body",
17847             "type": "String",
17848             "optional": true,
17849             "field": "note",
17850             "description": ""
17851           },
17852           {
17853             "group": "Body",
17854             "type": "String",
17855             "optional": true,
17856             "field": "read1stAt",
17857             "description": ""
17858           },
17859           {
17860             "group": "Body",
17861             "type": "String",
17862             "optional": true,
17863             "field": "threadId",
17864             "description": ""
17865           },
17866           {
17867             "group": "Body",
17868             "type": "String",
17869             "optional": true,
17870             "field": "externalUrl",
17871             "description": ""
17872           },
17873           {
17874             "group": "Body",
17875             "type": "String",
17876             "optional": true,
17877             "field": "lastMsgAt",
17878             "description": ""
17879           },
17880           {
17881             "group": "Body",
17882             "type": "String",
17883             "allowedValues": [
17884               "\"in\"",
17885               "\"out\""
17886             ],
17887             "optional": false,
17888             "field": "lastMsgDirection",
17889             "description": ""
17890           },
17891           {
17892             "group": "Body",
17893             "type": "String",
17894             "optional": true,
17895             "field": "from",
17896             "description": ""
17897           }
17898         ]
17899       }
17900     },
17901     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17902     "version": "0.0.0",
17903     "filename": "server/api/openchannelInteraction/index.js",
17904     "groupTitle": "Openchannel_Interactions"
17905   },
17906   {
17907     "type": "delete",
17908     "url": "/api/openchannel/interactions/{id}",
17909     "title": "Deletes a Interaction",
17910     "examples": [
17911       {
17912         "title": "Example usage:",
17913         "content": "curl https://{domain}/api/openchannel/interactions/{id} -v -u {name}:{password} -X DELETE",
17914         "type": "json"
17915       }
17916     ],
17917     "name": "DeleteInteractions",
17918     "group": "Openchannel_Interactions",
17919     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17920     "version": "0.0.0",
17921     "filename": "server/api/openchannelInteraction/index.js",
17922     "groupTitle": "Openchannel_Interactions"
17923   },
17924   {
17925     "type": "get",
17926     "url": "/api/openchannel/interactions/describe",
17927     "title": "Gets table info about Interactions",
17928     "examples": [
17929       {
17930         "title": "Example usage:",
17931         "content": "curl https://{domain}/api/openchannel/interactions/describe -v -u {name}:{password}",
17932         "type": "json"
17933       }
17934     ],
17935     "name": "DescribeInteractions",
17936     "group": "Openchannel_Interactions",
17937     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17938     "version": "0.0.0",
17939     "filename": "server/api/openchannelInteraction/index.js",
17940     "groupTitle": "Openchannel_Interactions"
17941   },
17942   {
17943     "type": "get",
17944     "url": "/api/openchannel/interactions",
17945     "title": "Gets a list of Interactions",
17946     "examples": [
17947       {
17948         "title": "Example usage:",
17949         "content": "curl https://{domain}/api/openchannel/interactions -v -u {name}:{password}",
17950         "type": "json"
17951       }
17952     ],
17953     "name": "GetInteractions",
17954     "group": "Openchannel_Interactions",
17955     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
17956     "version": "0.0.0",
17957     "filename": "server/api/openchannelInteraction/index.js",
17958     "groupTitle": "Openchannel_Interactions"
17959   },
17960   {
17961     "type": "delete",
17962     "url": "/api/openchannel/interactions/{id}/tags",
17963     "title": "Removes tags from interaction",
17964     "examples": [
17965       {
17966         "title": "Example usage:",
17967         "content": "curl https://{domain}/api/openchannel/interactions/{id}/tags?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
17968         "type": "json"
17969       }
17970     ],
17971     "name": "RemoveTags",
17972     "group": "Openchannel_Interactions",
17973     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17974     "version": "0.0.0",
17975     "filename": "server/api/openchannelInteraction/index.js",
17976     "groupTitle": "Openchannel_Interactions"
17977   },
17978   {
17979     "type": "get",
17980     "url": "/api/openchannel/interactions/{id}",
17981     "title": "Gets a single Interaction",
17982     "examples": [
17983       {
17984         "title": "Example usage:",
17985         "content": "curl https://{domain}/api/openchannel/interactions/{id} -v -u {name}:{password}",
17986         "type": "json"
17987       }
17988     ],
17989     "name": "ShowInteractions",
17990     "group": "Openchannel_Interactions",
17991     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17992     "version": "0.0.0",
17993     "filename": "server/api/openchannelInteraction/index.js",
17994     "groupTitle": "Openchannel_Interactions"
17995   },
17996   {
17997     "type": "post",
17998     "url": "/api/openchannel/interactions/{id}/messages",
17999     "title": "Creates new messages",
18000     "examples": [
18001       {
18002         "title": "Example usage:",
18003         "content": "curl https://{domain}/api/openchannel/interactions/{id}/messages -d '[{\"to\": \"+3901119886500\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
18004         "type": "json"
18005       }
18006     ],
18007     "name": "addMessage",
18008     "group": "Openchannel_Interactions",
18009     "parameter": {
18010       "fields": {
18011         "Body": [
18012           {
18013             "group": "Body",
18014             "type": "Text",
18015             "optional": false,
18016             "field": "body",
18017             "description": ""
18018           },
18019           {
18020             "group": "Body",
18021             "type": "Boolean",
18022             "optional": true,
18023             "field": "read",
18024             "description": ""
18025           },
18026           {
18027             "group": "Body",
18028             "type": "Boolean",
18029             "optional": true,
18030             "field": "secret",
18031             "description": ""
18032           },
18033           {
18034             "group": "Body",
18035             "type": "String",
18036             "allowedValues": [
18037               "\"in\"",
18038               "\"out\""
18039             ],
18040             "optional": false,
18041             "field": "direction",
18042             "description": ""
18043           },
18044           {
18045             "group": "Body",
18046             "type": "String",
18047             "optional": true,
18048             "field": "readAt",
18049             "description": ""
18050           }
18051         ]
18052       }
18053     },
18054     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18055     "version": "0.0.0",
18056     "filename": "server/api/openchannelInteraction/index.js",
18057     "groupTitle": "Openchannel_Interactions"
18058   },
18059   {
18060     "type": "get",
18061     "url": "/api/openchannel/interactions/{id}/download",
18062     "title": "Gets interaction",
18063     "examples": [
18064       {
18065         "title": "Example usage:",
18066         "content": "curl https://{domain}/api/openchannel/interactions/{id}/download -v -u {name}:{password} -X GET",
18067         "type": "json"
18068       }
18069     ],
18070     "name": "download",
18071     "group": "Openchannel_Interactions",
18072     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18073     "version": "0.0.0",
18074     "filename": "server/api/openchannelInteraction/index.js",
18075     "groupTitle": "Openchannel_Interactions"
18076   },
18077   {
18078     "type": "get",
18079     "url": "/api/openchannel/interactions/{id}/messages",
18080     "title": "Gets interaction messages",
18081     "examples": [
18082       {
18083         "title": "Example usage:",
18084         "content": "curl https://{domain}/api/openchannel/interactions/{id}/messages -v -u {name}:{password} -X GET",
18085         "type": "json"
18086       }
18087     ],
18088     "name": "getMessages",
18089     "group": "Openchannel_Interactions",
18090     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18091     "version": "0.0.0",
18092     "filename": "server/api/openchannelInteraction/index.js",
18093     "groupTitle": "Openchannel_Interactions"
18094   },
18095   {
18096     "type": "put",
18097     "url": "/api/openchannel/interactions/{id}",
18098     "title": "Update an existing Interaction",
18099     "examples": [
18100       {
18101         "title": "Example usage:",
18102         "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",
18103         "type": "json"
18104       }
18105     ],
18106     "name": "updateInteractions",
18107     "group": "Openchannel_Interactions",
18108     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18109     "version": "0.0.0",
18110     "filename": "server/api/openchannelInteraction/index.js",
18111     "groupTitle": "Openchannel_Interactions"
18112   },
18113   {
18114     "type": "post",
18115     "url": "/api/openchannel/messages",
18116     "title": "Creates a new Message",
18117     "examples": [
18118       {
18119         "title": "Example usage:",
18120         "content": "curl https://{domain}/api/openchannel/messages -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
18121         "type": "json"
18122       }
18123     ],
18124     "name": "CreateMessages",
18125     "group": "Openchannel_Messages",
18126     "parameter": {
18127       "fields": {
18128         "Body": [
18129           {
18130             "group": "Body",
18131             "type": "Text",
18132             "optional": false,
18133             "field": "body",
18134             "description": ""
18135           },
18136           {
18137             "group": "Body",
18138             "type": "Boolean",
18139             "optional": true,
18140             "field": "read",
18141             "description": ""
18142           },
18143           {
18144             "group": "Body",
18145             "type": "Boolean",
18146             "optional": true,
18147             "field": "secret",
18148             "description": ""
18149           },
18150           {
18151             "group": "Body",
18152             "type": "String",
18153             "allowedValues": [
18154               "\"in\"",
18155               "\"out\""
18156             ],
18157             "optional": false,
18158             "field": "direction",
18159             "description": ""
18160           },
18161           {
18162             "group": "Body",
18163             "type": "String",
18164             "optional": true,
18165             "field": "readAt",
18166             "description": ""
18167           }
18168         ]
18169       }
18170     },
18171     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18172     "version": "0.0.0",
18173     "filename": "server/api/openchannelMessage/index.js",
18174     "groupTitle": "Openchannel_Messages"
18175   },
18176   {
18177     "type": "delete",
18178     "url": "/api/openchannel/messages/{id}",
18179     "title": "Deletes a Message",
18180     "examples": [
18181       {
18182         "title": "Example usage:",
18183         "content": "curl https://{domain}/api/openchannel/messages/{id} -v -u {name}:{password} -X DELETE",
18184         "type": "json"
18185       }
18186     ],
18187     "name": "DeleteMessages",
18188     "group": "Openchannel_Messages",
18189     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18190     "version": "0.0.0",
18191     "filename": "server/api/openchannelMessage/index.js",
18192     "groupTitle": "Openchannel_Messages"
18193   },
18194   {
18195     "type": "get",
18196     "url": "/api/openchannel/messages/describe",
18197     "title": "Gets table info about Messages",
18198     "examples": [
18199       {
18200         "title": "Example usage:",
18201         "content": "curl https://{domain}/api/openchannel/messages/describe -v -u {name}:{password}",
18202         "type": "json"
18203       }
18204     ],
18205     "name": "DescribeMessages",
18206     "group": "Openchannel_Messages",
18207     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18208     "version": "0.0.0",
18209     "filename": "server/api/openchannelMessage/index.js",
18210     "groupTitle": "Openchannel_Messages"
18211   },
18212   {
18213     "type": "get",
18214     "url": "/api/openchannel/messages",
18215     "title": "Gets a list of Messages",
18216     "examples": [
18217       {
18218         "title": "Example usage:",
18219         "content": "curl https://{domain}/api/openchannel/messages -v -u {name}:{password}",
18220         "type": "json"
18221       }
18222     ],
18223     "name": "GetMessages",
18224     "group": "Openchannel_Messages",
18225     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
18226     "version": "0.0.0",
18227     "filename": "server/api/openchannelMessage/index.js",
18228     "groupTitle": "Openchannel_Messages"
18229   },
18230   {
18231     "type": "get",
18232     "url": "/api/openchannel/messages/{id}",
18233     "title": "Gets a single Message",
18234     "examples": [
18235       {
18236         "title": "Example usage:",
18237         "content": "curl https://{domain}/api/openchannel/messages/{id} -v -u {name}:{password}",
18238         "type": "json"
18239       }
18240     ],
18241     "name": "ShowMessages",
18242     "group": "Openchannel_Messages",
18243     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18244     "version": "0.0.0",
18245     "filename": "server/api/openchannelMessage/index.js",
18246     "groupTitle": "Openchannel_Messages"
18247   },
18248   {
18249     "type": "put",
18250     "url": "/api/openchannel/messages/{id}/accept",
18251     "title": "Accepts message",
18252     "examples": [
18253       {
18254         "title": "Example usage:",
18255         "content": "curl https://{domain}/api/openchannel/messages/{id}/accept \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
18256         "type": "json"
18257       }
18258     ],
18259     "name": "acceptMessage",
18260     "group": "Openchannel_Messages",
18261     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18262     "version": "0.0.0",
18263     "filename": "server/api/openchannelMessage/index.js",
18264     "groupTitle": "Openchannel_Messages"
18265   },
18266   {
18267     "type": "put",
18268     "url": "/api/openchannel/messages/{id}/reject",
18269     "title": "Rejects message",
18270     "examples": [
18271       {
18272         "title": "Example usage:",
18273         "content": "curl https://{domain}/api/openchannel/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
18274         "type": "json"
18275       }
18276     ],
18277     "name": "rejectMessage",
18278     "group": "Openchannel_Messages",
18279     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18280     "version": "0.0.0",
18281     "filename": "server/api/openchannelMessage/index.js",
18282     "groupTitle": "Openchannel_Messages"
18283   },
18284   {
18285     "type": "put",
18286     "url": "/api/openchannel/messages/{id}",
18287     "title": "Update an existing Message",
18288     "examples": [
18289       {
18290         "title": "Example usage:",
18291         "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",
18292         "type": "json"
18293       }
18294     ],
18295     "name": "updateMessages",
18296     "group": "Openchannel_Messages",
18297     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18298     "version": "0.0.0",
18299     "filename": "server/api/openchannelMessage/index.js",
18300     "groupTitle": "Openchannel_Messages"
18301   },
18302   {
18303     "type": "post",
18304     "url": "/api/openchannel/reports/queue",
18305     "title": "Creates a new Openchannel Queue Report",
18306     "examples": [
18307       {
18308         "title": "Example usage:",
18309         "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",
18310         "type": "json"
18311       }
18312     ],
18313     "name": "CreateOpenchannel_Queue_Reports",
18314     "group": "Openchannel_Queue_Reports",
18315     "parameter": {
18316       "fields": {
18317         "Body": [
18318           {
18319             "group": "Body",
18320             "type": "String",
18321             "optional": false,
18322             "field": "uniqueid",
18323             "description": ""
18324           },
18325           {
18326             "group": "Body",
18327             "type": "String",
18328             "optional": true,
18329             "field": "from",
18330             "description": ""
18331           },
18332           {
18333             "group": "Body",
18334             "type": "String",
18335             "optional": true,
18336             "field": "joinAt",
18337             "description": ""
18338           },
18339           {
18340             "group": "Body",
18341             "type": "String",
18342             "optional": true,
18343             "field": "leaveAt",
18344             "description": ""
18345           },
18346           {
18347             "group": "Body",
18348             "type": "String",
18349             "optional": true,
18350             "field": "acceptAt",
18351             "description": ""
18352           },
18353           {
18354             "group": "Body",
18355             "type": "String",
18356             "optional": true,
18357             "field": "exitAt",
18358             "description": ""
18359           },
18360           {
18361             "group": "Body",
18362             "type": "String",
18363             "optional": true,
18364             "field": "reason",
18365             "description": ""
18366           }
18367         ]
18368       }
18369     },
18370     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18371     "version": "0.0.0",
18372     "filename": "server/api/openchannelQueueReport/index.js",
18373     "groupTitle": "Openchannel_Queue_Reports"
18374   },
18375   {
18376     "type": "delete",
18377     "url": "/api/openchannel/reports/queue/{id}",
18378     "title": "Deletes a Openchannel Queue Report",
18379     "examples": [
18380       {
18381         "title": "Example usage:",
18382         "content": "curl https://{domain}/api/openchannel/reports/queue/{id} -v -u {name}:{password} -X DELETE",
18383         "type": "json"
18384       }
18385     ],
18386     "name": "DeleteOpenchannel_Queue_Reports",
18387     "group": "Openchannel_Queue_Reports",
18388     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18389     "version": "0.0.0",
18390     "filename": "server/api/openchannelQueueReport/index.js",
18391     "groupTitle": "Openchannel_Queue_Reports"
18392   },
18393   {
18394     "type": "get",
18395     "url": "/api/openchannel/reports/queue/describe",
18396     "title": "Gets table info about Openchannel Queue Reports",
18397     "examples": [
18398       {
18399         "title": "Example usage:",
18400         "content": "curl https://{domain}/api/openchannel/reports/queue/describe -v -u {name}:{password}",
18401         "type": "json"
18402       }
18403     ],
18404     "name": "DescribeOpenchannel_Queue_Reports",
18405     "group": "Openchannel_Queue_Reports",
18406     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18407     "version": "0.0.0",
18408     "filename": "server/api/openchannelQueueReport/index.js",
18409     "groupTitle": "Openchannel_Queue_Reports"
18410   },
18411   {
18412     "type": "get",
18413     "url": "/api/openchannel/reports/queue",
18414     "title": "Gets a list of Openchannel Queue Reports",
18415     "examples": [
18416       {
18417         "title": "Example usage:",
18418         "content": "curl https://{domain}/api/openchannel/reports/queue -v -u {name}:{password}",
18419         "type": "json"
18420       }
18421     ],
18422     "name": "GetOpenchannel_Queue_Reports",
18423     "group": "Openchannel_Queue_Reports",
18424     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
18425     "version": "0.0.0",
18426     "filename": "server/api/openchannelQueueReport/index.js",
18427     "groupTitle": "Openchannel_Queue_Reports"
18428   },
18429   {
18430     "type": "get",
18431     "url": "/api/openchannel/reports/queue/{id}",
18432     "title": "Gets a single Openchannel Queue Report",
18433     "examples": [
18434       {
18435         "title": "Example usage:",
18436         "content": "curl https://{domain}/api/openchannel/reports/queue/{id} -v -u {name}:{password}",
18437         "type": "json"
18438       }
18439     ],
18440     "name": "ShowOpenchannel_Queue_Reports",
18441     "group": "Openchannel_Queue_Reports",
18442     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18443     "version": "0.0.0",
18444     "filename": "server/api/openchannelQueueReport/index.js",
18445     "groupTitle": "Openchannel_Queue_Reports"
18446   },
18447   {
18448     "type": "put",
18449     "url": "/api/openchannel/reports/queue/{id}",
18450     "title": "Update an existing Openchannel Queue Report",
18451     "examples": [
18452       {
18453         "title": "Example usage:",
18454         "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",
18455         "type": "json"
18456       }
18457     ],
18458     "name": "updateOpenchannel_Queue_Reports",
18459     "group": "Openchannel_Queue_Reports",
18460     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18461     "version": "0.0.0",
18462     "filename": "server/api/openchannelQueueReport/index.js",
18463     "groupTitle": "Openchannel_Queue_Reports"
18464   },
18465   {
18466     "type": "post",
18467     "url": "/api/openchannel/queues/{id}/users",
18468     "title": "Add agents to a queue",
18469     "examples": [
18470       {
18471         "title": "Example usage:",
18472         "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",
18473         "type": "json"
18474       }
18475     ],
18476     "name": "AddAgents",
18477     "group": "Openchannel_Queues",
18478     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18479     "version": "0.0.0",
18480     "filename": "server/api/openchannelQueue/index.js",
18481     "groupTitle": "Openchannel_Queues"
18482   },
18483   {
18484     "type": "post",
18485     "url": "/api/openchannel/queues/{id}/teams",
18486     "title": "Add teams to a queue",
18487     "examples": [
18488       {
18489         "title": "Example usage:",
18490         "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",
18491         "type": "json"
18492       }
18493     ],
18494     "name": "AddTeams",
18495     "group": "Openchannel_Queues",
18496     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18497     "version": "0.0.0",
18498     "filename": "server/api/openchannelQueue/index.js",
18499     "groupTitle": "Openchannel_Queues"
18500   },
18501   {
18502     "type": "post",
18503     "url": "/api/openchannel/queues",
18504     "title": "Creates a new Queue",
18505     "examples": [
18506       {
18507         "title": "Example usage:",
18508         "content": "curl https://{domain}/api/openchannel/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
18509         "type": "json"
18510       }
18511     ],
18512     "name": "CreateQueues",
18513     "group": "Openchannel_Queues",
18514     "parameter": {
18515       "fields": {
18516         "Body": [
18517           {
18518             "group": "Body",
18519             "type": "String",
18520             "optional": true,
18521             "field": "name",
18522             "description": ""
18523           },
18524           {
18525             "group": "Body",
18526             "type": "String",
18527             "optional": true,
18528             "field": "description",
18529             "description": ""
18530           },
18531           {
18532             "group": "Body",
18533             "type": "Integer",
18534             "optional": true,
18535             "field": "timeout",
18536             "description": ""
18537           },
18538           {
18539             "group": "Body",
18540             "type": "String",
18541             "allowedValues": [
18542               "\"rrmemory\"",
18543               "\"beepall\"",
18544               "\"roundrobin\""
18545             ],
18546             "optional": true,
18547             "field": "strategy",
18548             "description": ""
18549           }
18550         ]
18551       }
18552     },
18553     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18554     "version": "0.0.0",
18555     "filename": "server/api/openchannelQueue/index.js",
18556     "groupTitle": "Openchannel_Queues"
18557   },
18558   {
18559     "type": "delete",
18560     "url": "/api/openchannel/queues/{id}",
18561     "title": "Deletes a Queue",
18562     "examples": [
18563       {
18564         "title": "Example usage:",
18565         "content": "curl https://{domain}/api/openchannel/queues/{id} -v -u {name}:{password} -X DELETE",
18566         "type": "json"
18567       }
18568     ],
18569     "name": "DeleteQueues",
18570     "group": "Openchannel_Queues",
18571     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18572     "version": "0.0.0",
18573     "filename": "server/api/openchannelQueue/index.js",
18574     "groupTitle": "Openchannel_Queues"
18575   },
18576   {
18577     "type": "get",
18578     "url": "/api/openchannel/queues/describe",
18579     "title": "Gets table info about Queues",
18580     "examples": [
18581       {
18582         "title": "Example usage:",
18583         "content": "curl https://{domain}/api/openchannel/queues/describe -v -u {name}:{password}",
18584         "type": "json"
18585       }
18586     ],
18587     "name": "DescribeQueues",
18588     "group": "Openchannel_Queues",
18589     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18590     "version": "0.0.0",
18591     "filename": "server/api/openchannelQueue/index.js",
18592     "groupTitle": "Openchannel_Queues"
18593   },
18594   {
18595     "type": "get",
18596     "url": "/api/openchannel/queues/{id}/users",
18597     "title": "Gets queue agents",
18598     "examples": [
18599       {
18600         "title": "Example usage:",
18601         "content": "curl https://{domain}/api/openchannel/queues/{id}/users -v -u {name}:{password} -X POST",
18602         "type": "json"
18603       }
18604     ],
18605     "name": "GetAgents",
18606     "group": "Openchannel_Queues",
18607     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18608     "version": "0.0.0",
18609     "filename": "server/api/openchannelQueue/index.js",
18610     "groupTitle": "Openchannel_Queues"
18611   },
18612   {
18613     "type": "get",
18614     "url": "/api/openchannel/queues/{id}/members",
18615     "title": "GetMembers",
18616     "examples": [
18617       {
18618         "title": "Example usage:",
18619         "content": "curl https://{domain}/api/openchannel/queues/{id}/members  -v -u {name}:{password}",
18620         "type": "json"
18621       }
18622     ],
18623     "name": "GetMembers",
18624     "group": "Openchannel_Queues",
18625     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18626     "version": "0.0.0",
18627     "filename": "server/api/openchannelQueue/index.js",
18628     "groupTitle": "Openchannel_Queues"
18629   },
18630   {
18631     "type": "get",
18632     "url": "/api/openchannel/queues",
18633     "title": "Gets a list of Queues",
18634     "examples": [
18635       {
18636         "title": "Example usage:",
18637         "content": "curl https://{domain}/api/openchannel/queues -v -u {name}:{password}",
18638         "type": "json"
18639       }
18640     ],
18641     "name": "GetQueues",
18642     "group": "Openchannel_Queues",
18643     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
18644     "version": "0.0.0",
18645     "filename": "server/api/openchannelQueue/index.js",
18646     "groupTitle": "Openchannel_Queues"
18647   },
18648   {
18649     "type": "get",
18650     "url": "/api/openchannel/queues/{id}/teams",
18651     "title": "Gets queues list",
18652     "examples": [
18653       {
18654         "title": "Example usage:",
18655         "content": "curl https://{domain}/api/openchannel/queues/{id}/teams -v -u {name}:{password}",
18656         "type": "json"
18657       }
18658     ],
18659     "name": "GetTeams",
18660     "group": "Openchannel_Queues",
18661     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18662     "version": "0.0.0",
18663     "filename": "server/api/openchannelQueue/index.js",
18664     "groupTitle": "Openchannel_Queues"
18665   },
18666   {
18667     "type": "delete",
18668     "url": "/api/openchannel/queues/{id}/users",
18669     "title": "Removes agents from a queue",
18670     "examples": [
18671       {
18672         "title": "Example usage:",
18673         "content": "curl https://{domain}/api/openchannel/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
18674         "type": "json"
18675       }
18676     ],
18677     "name": "RemoveAgents",
18678     "group": "Openchannel_Queues",
18679     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18680     "version": "0.0.0",
18681     "filename": "server/api/openchannelQueue/index.js",
18682     "groupTitle": "Openchannel_Queues"
18683   },
18684   {
18685     "type": "get",
18686     "url": "/api/openchannel/queues/{id}",
18687     "title": "Gets a single Queue",
18688     "examples": [
18689       {
18690         "title": "Example usage:",
18691         "content": "curl https://{domain}/api/openchannel/queues/{id} -v -u {name}:{password}",
18692         "type": "json"
18693       }
18694     ],
18695     "name": "ShowQueues",
18696     "group": "Openchannel_Queues",
18697     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18698     "version": "0.0.0",
18699     "filename": "server/api/openchannelQueue/index.js",
18700     "groupTitle": "Openchannel_Queues"
18701   },
18702   {
18703     "type": "put",
18704     "url": "/api/openchannel/queues/{id}",
18705     "title": "Update an existing Queue",
18706     "examples": [
18707       {
18708         "title": "Example usage:",
18709         "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",
18710         "type": "json"
18711       }
18712     ],
18713     "name": "updateQueues",
18714     "group": "Openchannel_Queues",
18715     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18716     "version": "0.0.0",
18717     "filename": "server/api/openchannelQueue/index.js",
18718     "groupTitle": "Openchannel_Queues"
18719   },
18720   {
18721     "type": "post",
18722     "url": "/api/openchannel/reports/transfer",
18723     "title": "Creates a new Openchannel Transfer Report",
18724     "examples": [
18725       {
18726         "title": "Example usage:",
18727         "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",
18728         "type": "json"
18729       }
18730     ],
18731     "name": "CreateOpenchannel_Transfer_Reports",
18732     "group": "Openchannel_Transfer_Reports",
18733     "parameter": {
18734       "fields": {
18735         "Body": [
18736           {
18737             "group": "Body",
18738             "type": "String",
18739             "optional": false,
18740             "field": "uniqueid",
18741             "description": ""
18742           },
18743           {
18744             "group": "Body",
18745             "type": "String",
18746             "allowedValues": [
18747               "\"account\"",
18748               "\"agent\"",
18749               "\"queue\""
18750             ],
18751             "optional": false,
18752             "field": "type",
18753             "description": ""
18754           },
18755           {
18756             "group": "Body",
18757             "type": "String",
18758             "optional": false,
18759             "field": "transferredAt",
18760             "description": ""
18761           }
18762         ]
18763       }
18764     },
18765     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18766     "version": "0.0.0",
18767     "filename": "server/api/openchannelTransferReport/index.js",
18768     "groupTitle": "Openchannel_Transfer_Reports"
18769   },
18770   {
18771     "type": "delete",
18772     "url": "/api/openchannel/reports/transfer/{id}",
18773     "title": "Deletes a Openchannel Transfer Report",
18774     "examples": [
18775       {
18776         "title": "Example usage:",
18777         "content": "curl https://{domain}/api/openchannel/reports/transfer/{id} -v -u {name}:{password} -X DELETE",
18778         "type": "json"
18779       }
18780     ],
18781     "name": "DeleteOpenchannel_Transfer_Reports",
18782     "group": "Openchannel_Transfer_Reports",
18783     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18784     "version": "0.0.0",
18785     "filename": "server/api/openchannelTransferReport/index.js",
18786     "groupTitle": "Openchannel_Transfer_Reports"
18787   },
18788   {
18789     "type": "get",
18790     "url": "/api/openchannel/reports/transfer/describe",
18791     "title": "Gets table info about Openchannel Transfer Reports",
18792     "examples": [
18793       {
18794         "title": "Example usage:",
18795         "content": "curl https://{domain}/api/openchannel/reports/transfer/describe -v -u {name}:{password}",
18796         "type": "json"
18797       }
18798     ],
18799     "name": "DescribeOpenchannel_Transfer_Reports",
18800     "group": "Openchannel_Transfer_Reports",
18801     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18802     "version": "0.0.0",
18803     "filename": "server/api/openchannelTransferReport/index.js",
18804     "groupTitle": "Openchannel_Transfer_Reports"
18805   },
18806   {
18807     "type": "get",
18808     "url": "/api/openchannel/reports/transfer",
18809     "title": "Gets a list of Openchannel Transfer Reports",
18810     "examples": [
18811       {
18812         "title": "Example usage:",
18813         "content": "curl https://{domain}/api/openchannel/reports/transfer -v -u {name}:{password}",
18814         "type": "json"
18815       }
18816     ],
18817     "name": "GetOpenchannel_Transfer_Reports",
18818     "group": "Openchannel_Transfer_Reports",
18819     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
18820     "version": "0.0.0",
18821     "filename": "server/api/openchannelTransferReport/index.js",
18822     "groupTitle": "Openchannel_Transfer_Reports"
18823   },
18824   {
18825     "type": "get",
18826     "url": "/api/openchannel/reports/transfer/{id}",
18827     "title": "Gets a single Openchannel Transfer Report",
18828     "examples": [
18829       {
18830         "title": "Example usage:",
18831         "content": "curl https://{domain}/api/openchannel/reports/transfer/{id} -v -u {name}:{password}",
18832         "type": "json"
18833       }
18834     ],
18835     "name": "ShowOpenchannel_Transfer_Reports",
18836     "group": "Openchannel_Transfer_Reports",
18837     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18838     "version": "0.0.0",
18839     "filename": "server/api/openchannelTransferReport/index.js",
18840     "groupTitle": "Openchannel_Transfer_Reports"
18841   },
18842   {
18843     "type": "put",
18844     "url": "/api/openchannel/reports/transfer/{id}",
18845     "title": "Update an existing Openchannel Transfer Report",
18846     "examples": [
18847       {
18848         "title": "Example usage:",
18849         "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",
18850         "type": "json"
18851       }
18852     ],
18853     "name": "updateOpenchannel_Transfer_Reports",
18854     "group": "Openchannel_Transfer_Reports",
18855     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18856     "version": "0.0.0",
18857     "filename": "server/api/openchannelTransferReport/index.js",
18858     "groupTitle": "Openchannel_Transfer_Reports"
18859   },
18860   {
18861     "type": "post",
18862     "url": "/api/pauses",
18863     "title": "Creates a new Pause",
18864     "examples": [
18865       {
18866         "title": "Example usage:",
18867         "content": "curl https://{domain}/api/pauses -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
18868         "type": "json"
18869       }
18870     ],
18871     "name": "CreatePauses",
18872     "group": "Pauses",
18873     "parameter": {
18874       "fields": {
18875         "Body": [
18876           {
18877             "group": "Body",
18878             "type": "String",
18879             "optional": false,
18880             "field": "name",
18881             "description": ""
18882           },
18883           {
18884             "group": "Body",
18885             "type": "String",
18886             "optional": true,
18887             "field": "description",
18888             "description": ""
18889           }
18890         ]
18891       }
18892     },
18893     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18894     "version": "0.0.0",
18895     "filename": "server/api/pause/index.js",
18896     "groupTitle": "Pauses"
18897   },
18898   {
18899     "type": "delete",
18900     "url": "/api/pauses/{id}",
18901     "title": "Deletes a Pause",
18902     "examples": [
18903       {
18904         "title": "Example usage:",
18905         "content": "curl https://{domain}/api/pauses/{id} -v -u {name}:{password} -X DELETE",
18906         "type": "json"
18907       }
18908     ],
18909     "name": "DeletePauses",
18910     "group": "Pauses",
18911     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <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/pause/index.js",
18914     "groupTitle": "Pauses"
18915   },
18916   {
18917     "type": "get",
18918     "url": "/api/pauses",
18919     "title": "Gets a list of Pauses",
18920     "examples": [
18921       {
18922         "title": "Example usage:",
18923         "content": "curl https://{domain}/api/pauses -v -u {name}:{password}",
18924         "type": "json"
18925       }
18926     ],
18927     "name": "GetPauses",
18928     "group": "Pauses",
18929     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/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>",
18930     "version": "0.0.0",
18931     "filename": "server/api/pause/index.js",
18932     "groupTitle": "Pauses"
18933   },
18934   {
18935     "type": "get",
18936     "url": "/api/pauses/{id}",
18937     "title": "Gets a single Pause",
18938     "examples": [
18939       {
18940         "title": "Example usage:",
18941         "content": "curl https://{domain}/api/pauses/{id} -v -u {name}:{password}",
18942         "type": "json"
18943       }
18944     ],
18945     "name": "ShowPauses",
18946     "group": "Pauses",
18947     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18948     "version": "0.0.0",
18949     "filename": "server/api/pause/index.js",
18950     "groupTitle": "Pauses"
18951   },
18952   {
18953     "type": "put",
18954     "url": "/api/pauses/{id}",
18955     "title": "Update an existing Pause",
18956     "examples": [
18957       {
18958         "title": "Example usage:",
18959         "content": "curl https://{domain}/api/pauses/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
18960         "type": "json"
18961       }
18962     ],
18963     "name": "updatePauses",
18964     "group": "Pauses",
18965     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18966     "version": "0.0.0",
18967     "filename": "server/api/pause/index.js",
18968     "groupTitle": "Pauses"
18969   },
18970   {
18971     "type": "get",
18972     "url": "/api/plugins",
18973     "title": "Gets a list of Plugins",
18974     "examples": [
18975       {
18976         "title": "Example usage:",
18977         "content": "curl https://{domain}/api/plugins -v -u {name}:{password}",
18978         "type": "json"
18979       }
18980     ],
18981     "name": "GetPlugins",
18982     "group": "Plugins",
18983     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
18984     "version": "0.0.0",
18985     "filename": "server/api/plugin/index.js",
18986     "groupTitle": "Plugins"
18987   },
18988   {
18989     "type": "get",
18990     "url": "/api/plugins/{id}",
18991     "title": "Gets a single Plugin",
18992     "examples": [
18993       {
18994         "title": "Example usage:",
18995         "content": "curl https://{domain}/api/plugins/{id} -v -u {name}:{password}",
18996         "type": "json"
18997       }
18998     ],
18999     "name": "ShowPlugins",
19000     "group": "Plugins",
19001     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19002     "version": "0.0.0",
19003     "filename": "server/api/plugin/index.js",
19004     "groupTitle": "Plugins"
19005   },
19006   {
19007     "type": "delete",
19008     "url": "/api/plugins/{id}",
19009     "title": "Delete a plugin",
19010     "examples": [
19011       {
19012         "title": "Example usage:",
19013         "content": "curl https://{domain}/api/plugins/{id} -v -u {name}:{password} -X DELETE",
19014         "type": "json"
19015       }
19016     ],
19017     "name": "destroyPlugin",
19018     "group": "Plugins",
19019     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19020     "version": "0.0.0",
19021     "filename": "server/api/plugin/index.js",
19022     "groupTitle": "Plugins"
19023   },
19024   {
19025     "type": "get",
19026     "url": "/api/plugins/{id}/download",
19027     "title": "Download plugin source code",
19028     "examples": [
19029       {
19030         "title": "Example usage:",
19031         "content": "curl https://{domain}/api/plugins/{id}/download -v -u {name}:{password} -X GET",
19032         "type": "json"
19033       }
19034     ],
19035     "name": "download",
19036     "group": "Plugins",
19037     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19038     "version": "0.0.0",
19039     "filename": "server/api/plugin/index.js",
19040     "groupTitle": "Plugins"
19041   },
19042   {
19043     "type": "put",
19044     "url": "/api/plugins/{id}",
19045     "title": "Update an existing plugin",
19046     "examples": [
19047       {
19048         "title": "Example usage:",
19049         "content": "curl https://{domain}/api/plugins/{id} -v -u {name}:{password} -X PUT",
19050         "type": "json"
19051       }
19052     ],
19053     "name": "updatePlugin",
19054     "group": "Plugins",
19055     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19056     "version": "0.0.0",
19057     "filename": "server/api/plugin/index.js",
19058     "groupTitle": "Plugins"
19059   },
19060   {
19061     "type": "post",
19062     "url": "/api/plugins",
19063     "title": "Upload new plugin",
19064     "examples": [
19065       {
19066         "title": "Example usage:",
19067         "content": "curl https://{domain}/api/plugins -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
19068         "type": "json"
19069       }
19070     ],
19071     "name": "uploadPlugin",
19072     "group": "Plugins",
19073     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19074     "version": "0.0.0",
19075     "filename": "server/api/plugin/index.js",
19076     "groupTitle": "Plugins"
19077   },
19078   {
19079     "type": "get",
19080     "url": "/api/plugins/webhook?hostname={host}&port={port}&encoding={encoding}&json={json}&path={path}",
19081     "title": "Redirect a plugin request to the specified path",
19082     "examples": [
19083       {
19084         "title": "Example usage:",
19085         "content": "curl https://{domain}/api/plugins/webhook?port={port}&path={path} -v -u {name}:{password} -X GET",
19086         "type": "json"
19087       }
19088     ],
19089     "name": "webhookPlugin",
19090     "group": "Plugins",
19091     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19092     "version": "0.0.0",
19093     "filename": "server/api/plugin/index.js",
19094     "groupTitle": "Plugins"
19095   },
19096   {
19097     "type": "post",
19098     "url": "/api/plugins/webhook?hostname={host}&port={port}&encoding={encoding}&json={json}&path={path}",
19099     "title": "Redirect a plugin request to the specified path",
19100     "examples": [
19101       {
19102         "title": "Example usage:",
19103         "content": "curl https://{domain}/api/plugins/webhook?port={port}&path={path} -H 'Content-Type: application/json' -X POST",
19104         "type": "json"
19105       }
19106     ],
19107     "name": "webhookPlugin",
19108     "group": "Plugins",
19109     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19110     "version": "0.0.0",
19111     "filename": "server/api/plugin/index.js",
19112     "groupTitle": "Plugins"
19113   },
19114   {
19115     "type": "delete",
19116     "url": "/api/pm2/{id}",
19117     "title": "Deletes an existing process",
19118     "examples": [
19119       {
19120         "title": "Example usage:",
19121         "content": "curl https://{domain}/api/pm2/{id} -v -u {name}:{password} -X DELETE",
19122         "type": "json"
19123       }
19124     ],
19125     "name": "DeletePm2Process",
19126     "group": "Pm2",
19127     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19128     "version": "0.0.0",
19129     "filename": "server/api/pm2/index.js",
19130     "groupTitle": "Pm2"
19131   },
19132   {
19133     "type": "get",
19134     "url": "/api/pm2/{id}",
19135     "title": "Gets a single pm2 process",
19136     "examples": [
19137       {
19138         "title": "Example usage:",
19139         "content": "curl https://{domain}/api/pm2/{id} -v -u {name}:{password}",
19140         "type": "json"
19141       }
19142     ],
19143     "name": "GetPm2Process",
19144     "group": "Pm2",
19145     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19146     "version": "0.0.0",
19147     "filename": "server/api/pm2/index.js",
19148     "groupTitle": "Pm2"
19149   },
19150   {
19151     "type": "get",
19152     "url": "/api/pm2",
19153     "title": "Gets pm2 processes",
19154     "examples": [
19155       {
19156         "title": "Example usage:",
19157         "content": "curl https://{domain}/api/pm2 -v -u {name}:{password}",
19158         "type": "json"
19159       }
19160     ],
19161     "name": "GetPm2Processes",
19162     "group": "Pm2",
19163     "description": "<p>Motion returns the pm2 processes list.</p>",
19164     "version": "0.0.0",
19165     "filename": "server/api/pm2/index.js",
19166     "groupTitle": "Pm2"
19167   },
19168   {
19169     "type": "post",
19170     "url": "/api/pm2",
19171     "title": "Start a single pm2 process",
19172     "examples": [
19173       {
19174         "title": "Example usage:",
19175         "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",
19176         "type": "json"
19177       }
19178     ],
19179     "name": "StartPm2Process",
19180     "group": "Pm2",
19181     "parameter": {
19182       "fields": {
19183         "Body": [
19184           {
19185             "group": "Body",
19186             "type": "String",
19187             "optional": false,
19188             "field": "name",
19189             "description": ""
19190           },
19191           {
19192             "group": "Body",
19193             "type": "String",
19194             "optional": false,
19195             "field": "script",
19196             "description": ""
19197           }
19198         ]
19199       }
19200     },
19201     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19202     "version": "0.0.0",
19203     "filename": "server/api/pm2/index.js",
19204     "groupTitle": "Pm2"
19205   },
19206   {
19207     "type": "put",
19208     "url": "/api/pm2/{id}",
19209     "title": "Update an existing process",
19210     "examples": [
19211       {
19212         "title": "Example usage:",
19213         "content": "curl https://{domain}/api/pm2/{id} -d '{\"status\": \"online\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
19214         "type": "json"
19215       }
19216     ],
19217     "name": "UpdatePm2Process",
19218     "group": "Pm2",
19219     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19220     "version": "0.0.0",
19221     "filename": "server/api/pm2/index.js",
19222     "groupTitle": "Pm2"
19223   },
19224   {
19225     "type": "get",
19226     "url": "/api/rpc/campaigns/",
19227     "title": "Gets a list of campaigns",
19228     "examples": [
19229       {
19230         "title": "Example usage:",
19231         "content": "curl https://{domain}/api/rpc/campaigns -v -u {name}:{password}",
19232         "type": "json"
19233       }
19234     ],
19235     "name": "Campaigns",
19236     "group": "RPC_Realtime",
19237     "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>",
19238     "version": "0.0.0",
19239     "filename": "server/api/rpc/index.js",
19240     "groupTitle": "RPC_Realtime"
19241   },
19242   {
19243     "type": "get",
19244     "url": "/api/rpc/fax/accounts",
19245     "title": "Gets a list of FaxAccounts",
19246     "examples": [
19247       {
19248         "title": "Example usage:",
19249         "content": "curl https://{domain}/api/rpc/fax/accounts -v -u {name}:{password}",
19250         "type": "json"
19251       }
19252     ],
19253     "name": "FaxAccounts",
19254     "group": "RPC_Realtime",
19255     "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>",
19256     "version": "0.0.0",
19257     "filename": "server/api/rpc/index.js",
19258     "groupTitle": "RPC_Realtime"
19259   },
19260   {
19261     "type": "put",
19262     "url": "/api/rpc/agents/:id/capacity",
19263     "title": "Sets agent capacity",
19264     "examples": [
19265       {
19266         "title": "Example usage:",
19267         "content": "curl https://{domain}/api/rpc/agents/:id/capacity -v -u {name}:{password}",
19268         "type": "json"
19269       }
19270     ],
19271     "name": "RTAgentCapacity",
19272     "group": "RPC_Realtime",
19273     "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>",
19274     "version": "0.0.0",
19275     "filename": "server/api/rpc/index.js",
19276     "groupTitle": "RPC_Realtime"
19277   },
19278   {
19279     "type": "get",
19280     "url": "/api/rpc/agents",
19281     "title": "Gets a list of RTAgents",
19282     "examples": [
19283       {
19284         "title": "Example usage:",
19285         "content": "curl https://{domain}/api/rpc/agents -v -u {name}:{password}",
19286         "type": "json"
19287       }
19288     ],
19289     "name": "RTAgents",
19290     "group": "RPC_Realtime",
19291     "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>",
19292     "version": "0.0.0",
19293     "filename": "server/api/rpc/index.js",
19294     "groupTitle": "RPC_Realtime"
19295   },
19296   {
19297     "type": "get",
19298     "url": "/api/rpc/chat/queues",
19299     "title": "Gets a list of RTChatQueues",
19300     "examples": [
19301       {
19302         "title": "Example usage:",
19303         "content": "curl https://{domain}/api/rpc/chat/queues -v -u {name}:{password}",
19304         "type": "json"
19305       }
19306     ],
19307     "name": "RTChatQueues",
19308     "group": "RPC_Realtime",
19309     "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>",
19310     "version": "0.0.0",
19311     "filename": "server/api/rpc/index.js",
19312     "groupTitle": "RPC_Realtime"
19313   },
19314   {
19315     "type": "get",
19316     "url": "/api/rpc/fax/queues",
19317     "title": "Gets a list of RTFaxQueues",
19318     "examples": [
19319       {
19320         "title": "Example usage:",
19321         "content": "curl https://{domain}/api/rpc/fax/queues -v -u {name}:{password}",
19322         "type": "json"
19323       }
19324     ],
19325     "name": "RTFaxQueues",
19326     "group": "RPC_Realtime",
19327     "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>",
19328     "version": "0.0.0",
19329     "filename": "server/api/rpc/index.js",
19330     "groupTitle": "RPC_Realtime"
19331   },
19332   {
19333     "type": "get",
19334     "url": "/api/rpc/mail/accounts",
19335     "title": "Gets a list of RTMailAccounts",
19336     "examples": [
19337       {
19338         "title": "Example usage:",
19339         "content": "curl https://{domain}/api/rpc/mail/accounts -v -u {name}:{password}",
19340         "type": "json"
19341       }
19342     ],
19343     "name": "RTMailAccounts",
19344     "group": "RPC_Realtime",
19345     "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>",
19346     "version": "0.0.0",
19347     "filename": "server/api/rpc/index.js",
19348     "groupTitle": "RPC_Realtime"
19349   },
19350   {
19351     "type": "get",
19352     "url": "/api/rpc/mail/queues",
19353     "title": "Gets a list of RTMailQueues",
19354     "examples": [
19355       {
19356         "title": "Example usage:",
19357         "content": "curl https://{domain}/api/rpc/mail/queues -v -u {name}:{password}",
19358         "type": "json"
19359       }
19360     ],
19361     "name": "RTMailQueues",
19362     "group": "RPC_Realtime",
19363     "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>",
19364     "version": "0.0.0",
19365     "filename": "server/api/rpc/index.js",
19366     "groupTitle": "RPC_Realtime"
19367   },
19368   {
19369     "type": "get",
19370     "url": "/api/rpc/openchannel/queues",
19371     "title": "Gets a list of RTOpenchannelQueues",
19372     "examples": [
19373       {
19374         "title": "Example usage:",
19375         "content": "curl https://{domain}/api/rpc/openchannel/queues -v -u {name}:{password}",
19376         "type": "json"
19377       }
19378     ],
19379     "name": "RTOpenchannelQueues",
19380     "group": "RPC_Realtime",
19381     "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>",
19382     "version": "0.0.0",
19383     "filename": "server/api/rpc/index.js",
19384     "groupTitle": "RPC_Realtime"
19385   },
19386   {
19387     "type": "get",
19388     "url": "/api/rpc/outbound/channels",
19389     "title": "Gets a list of RTOutboundChannels",
19390     "examples": [
19391       {
19392         "title": "Example usage:",
19393         "content": "curl https://{domain}/api/rpc/outbound/channels -v -u {name}:{password}",
19394         "type": "json"
19395       }
19396     ],
19397     "name": "RTOutboundChannels",
19398     "group": "RPC_Realtime",
19399     "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>",
19400     "version": "0.0.0",
19401     "filename": "server/api/rpc/index.js",
19402     "groupTitle": "RPC_Realtime"
19403   },
19404   {
19405     "type": "get",
19406     "url": "/api/rpc/sms/queues",
19407     "title": "Gets a list of RTSmsQueues",
19408     "examples": [
19409       {
19410         "title": "Example usage:",
19411         "content": "curl https://{domain}/api/rpc/sms/queues -v -u {name}:{password}",
19412         "type": "json"
19413       }
19414     ],
19415     "name": "RTSmsQueues",
19416     "group": "RPC_Realtime",
19417     "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>",
19418     "version": "0.0.0",
19419     "filename": "server/api/rpc/index.js",
19420     "groupTitle": "RPC_Realtime"
19421   },
19422   {
19423     "type": "get",
19424     "url": "/api/rpc/telephones",
19425     "title": "Gets a list of RTTelephones",
19426     "examples": [
19427       {
19428         "title": "Example usage:",
19429         "content": "curl https://{domain}/api/rpc/telephones -v -u {name}:{password}",
19430         "type": "json"
19431       }
19432     ],
19433     "name": "RTTelephones",
19434     "group": "RPC_Realtime",
19435     "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>",
19436     "version": "0.0.0",
19437     "filename": "server/api/rpc/index.js",
19438     "groupTitle": "RPC_Realtime"
19439   },
19440   {
19441     "type": "get",
19442     "url": "/api/rpc/trunks",
19443     "title": "Gets a list of RTTrunks",
19444     "examples": [
19445       {
19446         "title": "Example usage:",
19447         "content": "curl https://{domain}/api/rpc/trunks -v -u {name}:{password}",
19448         "type": "json"
19449       }
19450     ],
19451     "name": "RTTrunks",
19452     "group": "RPC_Realtime",
19453     "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>",
19454     "version": "0.0.0",
19455     "filename": "server/api/rpc/index.js",
19456     "groupTitle": "RPC_Realtime"
19457   },
19458   {
19459     "type": "get",
19460     "url": "/api/rpc/voice/channels",
19461     "title": "Gets a list of RTVoiceChannelMixMonitor",
19462     "examples": [
19463       {
19464         "title": "Example usage:",
19465         "content": "curl https://{domain}/api/rpc/voice/channels/{uniqueid}/mixmonitor -v -u {name}:{password}",
19466         "type": "json"
19467       }
19468     ],
19469     "name": "RTVoiceChannelMixMonitor",
19470     "group": "RPC_Realtime",
19471     "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>",
19472     "version": "0.0.0",
19473     "filename": "server/api/rpc/index.js",
19474     "groupTitle": "RPC_Realtime"
19475   },
19476   {
19477     "type": "get",
19478     "url": "/api/rpc/voice/channels",
19479     "title": "Gets a list of RTVoiceChannelStopMixMonitor",
19480     "examples": [
19481       {
19482         "title": "Example usage:",
19483         "content": "curl https://{domain}/api/rpc/voice/channels/{uniqueid}/stopmixmonitor -v -u {name}:{password}",
19484         "type": "json"
19485       }
19486     ],
19487     "name": "RTVoiceChannelStopMixMonitor",
19488     "group": "RPC_Realtime",
19489     "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>",
19490     "version": "0.0.0",
19491     "filename": "server/api/rpc/index.js",
19492     "groupTitle": "RPC_Realtime"
19493   },
19494   {
19495     "type": "get",
19496     "url": "/api/rpc/voice/channels",
19497     "title": "Gets a list of RTVoiceChannels",
19498     "examples": [
19499       {
19500         "title": "Example usage:",
19501         "content": "curl https://{domain}/api/rpc/voice/channels -v -u {name}:{password}",
19502         "type": "json"
19503       }
19504     ],
19505     "name": "RTVoiceChannels",
19506     "group": "RPC_Realtime",
19507     "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>",
19508     "version": "0.0.0",
19509     "filename": "server/api/rpc/index.js",
19510     "groupTitle": "RPC_Realtime"
19511   },
19512   {
19513     "type": "get",
19514     "url": "/api/rpc/voice/queues/channels/{uniqueid}",
19515     "title": "Gets a single RTVoiceQueueChannel",
19516     "examples": [
19517       {
19518         "title": "Example usage:",
19519         "content": "curl https://{domain}/api/rpc/voice/queues/channels/{uniqueid} -v -u {name}:{password}",
19520         "type": "json"
19521       }
19522     ],
19523     "name": "RTVoiceQueueChannel",
19524     "group": "RPC_Realtime",
19525     "description": "<p>Motion will return a specific realtime voice queue channel.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19526     "version": "0.0.0",
19527     "filename": "server/api/rpc/index.js",
19528     "groupTitle": "RPC_Realtime"
19529   },
19530   {
19531     "type": "get",
19532     "url": "/api/rpc/voice/queues/channels/{uniqueid}/hangup",
19533     "title": "Hangup a single RTVoiceQueueChannel",
19534     "examples": [
19535       {
19536         "title": "Example usage:",
19537         "content": "curl https://{domain}/api/rpc/voice/queues/channels/{uniqueid}/hangup -v -u {name}:{password}",
19538         "type": "json"
19539       }
19540     ],
19541     "name": "RTVoiceQueueChannelHangup",
19542     "group": "RPC_Realtime",
19543     "description": "<p>Motion will hangup a specific realtime voice queue channel.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19544     "version": "0.0.0",
19545     "filename": "server/api/rpc/index.js",
19546     "groupTitle": "RPC_Realtime"
19547   },
19548   {
19549     "type": "get",
19550     "url": "/api/rpc/voice/queues/channels/{uniqueid}/redirect/{exten}",
19551     "title": "Hangup a single RTVoiceQueueChannel",
19552     "examples": [
19553       {
19554         "title": "Example usage:",
19555         "content": "curl https://{domain}/api/rpc/voice/queues/channels/{uniqueid}/redirect/{exten} -v -u {name}:{password}",
19556         "type": "json"
19557       }
19558     ],
19559     "name": "RTVoiceQueueChannelRedirect",
19560     "group": "RPC_Realtime",
19561     "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>",
19562     "version": "0.0.0",
19563     "filename": "server/api/rpc/index.js",
19564     "groupTitle": "RPC_Realtime"
19565   },
19566   {
19567     "type": "get",
19568     "url": "/api/rpc/voice/queues/preview/{id}",
19569     "title": "Gets a single preview contact",
19570     "examples": [
19571       {
19572         "title": "Example usage:",
19573         "content": "curl https://{domain}/api/rpc/voice/queues/preview/{id} -v -u {name}:{password}",
19574         "type": "json"
19575       }
19576     ],
19577     "name": "RTVoiceQueuePreview",
19578     "group": "RPC_Realtime",
19579     "description": "<p>Motion will return a specific preview contact.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19580     "version": "0.0.0",
19581     "filename": "server/api/rpc/index.js",
19582     "groupTitle": "RPC_Realtime"
19583   },
19584   {
19585     "type": "get",
19586     "url": "/api/rpc/outbound",
19587     "title": "Gets a list of RTOutbound",
19588     "examples": [
19589       {
19590         "title": "Example usage:",
19591         "content": "curl https://{domain}/api/rpc/outbound -v -u {name}:{password}",
19592         "type": "json"
19593       }
19594     ],
19595     "name": "RTVoiceQueues",
19596     "group": "RPC_Realtime",
19597     "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>",
19598     "version": "0.0.0",
19599     "filename": "server/api/rpc/index.js",
19600     "groupTitle": "RPC_Realtime"
19601   },
19602   {
19603     "type": "get",
19604     "url": "/api/rpc/voice/queues",
19605     "title": "Gets a list of RTVoiceQueues",
19606     "examples": [
19607       {
19608         "title": "Example usage:",
19609         "content": "curl https://{domain}/api/rpc/voice/queues -v -u {name}:{password}",
19610         "type": "json"
19611       }
19612     ],
19613     "name": "RTVoiceQueues",
19614     "group": "RPC_Realtime",
19615     "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>",
19616     "version": "0.0.0",
19617     "filename": "server/api/rpc/index.js",
19618     "groupTitle": "RPC_Realtime"
19619   },
19620   {
19621     "type": "get",
19622     "url": "/api/rpc/voice/queues/channels",
19623     "title": "Gets a list of RTVoiceQueuesChannels",
19624     "examples": [
19625       {
19626         "title": "Example usage:",
19627         "content": "curl https://{domain}/api/rpc/voice/queues/channels -v -u {name}:{password}",
19628         "type": "json"
19629       }
19630     ],
19631     "name": "RTVoiceQueuesChannels",
19632     "group": "RPC_Realtime",
19633     "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>",
19634     "version": "0.0.0",
19635     "filename": "server/api/rpc/index.js",
19636     "groupTitle": "RPC_Realtime"
19637   },
19638   {
19639     "type": "get",
19640     "url": "/api/rpc/chat/queues/{id}",
19641     "title": "Gets a single RTChatQueue",
19642     "examples": [
19643       {
19644         "title": "Example usage:",
19645         "content": "curl https://{domain}/api/rpc/chat/queues/{id} -v -u {name}:{password}",
19646         "type": "json"
19647       }
19648     ],
19649     "name": "ShowRTChatQueues",
19650     "group": "RPC_Realtime",
19651     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19652     "version": "0.0.0",
19653     "filename": "server/api/rpc/index.js",
19654     "groupTitle": "RPC_Realtime"
19655   },
19656   {
19657     "type": "get",
19658     "url": "/api/rpc/fax/queues/{id}",
19659     "title": "Gets a single RTFaxQueue",
19660     "examples": [
19661       {
19662         "title": "Example usage:",
19663         "content": "curl https://{domain}/api/rpc/fax/queues/{id} -v -u {name}:{password}",
19664         "type": "json"
19665       }
19666     ],
19667     "name": "ShowRTFaxQueues",
19668     "group": "RPC_Realtime",
19669     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19670     "version": "0.0.0",
19671     "filename": "server/api/rpc/index.js",
19672     "groupTitle": "RPC_Realtime"
19673   },
19674   {
19675     "type": "get",
19676     "url": "/api/rpc/mail/queues/{id}",
19677     "title": "Gets a single RTMailQueue",
19678     "examples": [
19679       {
19680         "title": "Example usage:",
19681         "content": "curl https://{domain}/api/rpc/mail/queues/{id} -v -u {name}:{password}",
19682         "type": "json"
19683       }
19684     ],
19685     "name": "ShowRTMailQueues",
19686     "group": "RPC_Realtime",
19687     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19688     "version": "0.0.0",
19689     "filename": "server/api/rpc/index.js",
19690     "groupTitle": "RPC_Realtime"
19691   },
19692   {
19693     "type": "get",
19694     "url": "/api/rpc/openchannel/queues/{id}",
19695     "title": "Gets a single RTOpenchannelQueue",
19696     "examples": [
19697       {
19698         "title": "Example usage:",
19699         "content": "curl https://{domain}/api/rpc/openchannel/queues/{id} -v -u {name}:{password}",
19700         "type": "json"
19701       }
19702     ],
19703     "name": "ShowRTOpenchannelQueues",
19704     "group": "RPC_Realtime",
19705     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19706     "version": "0.0.0",
19707     "filename": "server/api/rpc/index.js",
19708     "groupTitle": "RPC_Realtime"
19709   },
19710   {
19711     "type": "get",
19712     "url": "/api/rpc/sms/queues/{id}",
19713     "title": "Gets a single RTSmsQueue",
19714     "examples": [
19715       {
19716         "title": "Example usage:",
19717         "content": "curl https://{domain}/api/rpc/sms/queues/{id} -v -u {name}:{password}",
19718         "type": "json"
19719       }
19720     ],
19721     "name": "ShowRTSmsQueues",
19722     "group": "RPC_Realtime",
19723     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19724     "version": "0.0.0",
19725     "filename": "server/api/rpc/index.js",
19726     "groupTitle": "RPC_Realtime"
19727   },
19728   {
19729     "type": "get",
19730     "url": "/api/rpc/voice/queues/{id}",
19731     "title": "Gets a single RTVoiceQueue",
19732     "examples": [
19733       {
19734         "title": "Example usage:",
19735         "content": "curl https://{domain}/api/rpc/voice/queues/{id} -v -u {name}:{password}",
19736         "type": "json"
19737       }
19738     ],
19739     "name": "ShowRTVoiceQueues",
19740     "group": "RPC_Realtime",
19741     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19742     "version": "0.0.0",
19743     "filename": "server/api/rpc/index.js",
19744     "groupTitle": "RPC_Realtime"
19745   },
19746   {
19747     "type": "post",
19748     "url": "/api/rpc/agents/:id/notify",
19749     "title": "Notify message to a specific agent",
19750     "examples": [
19751       {
19752         "title": "Example usage:",
19753         "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",
19754         "type": "json"
19755       }
19756     ],
19757     "name": "agentNotify",
19758     "group": "RPC_Realtime",
19759     "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>",
19760     "version": "0.0.0",
19761     "filename": "server/api/rpc/index.js",
19762     "groupTitle": "RPC_Realtime"
19763   },
19764   {
19765     "type": "post",
19766     "url": "/api/rpc/chat/queues/:id/notify",
19767     "title": "Notify message to a specific queue",
19768     "examples": [
19769       {
19770         "title": "Example usage:",
19771         "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",
19772         "type": "json"
19773       }
19774     ],
19775     "name": "chatQueueNotify",
19776     "group": "RPC_Realtime",
19777     "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>",
19778     "version": "0.0.0",
19779     "filename": "server/api/rpc/index.js",
19780     "groupTitle": "RPC_Realtime"
19781   },
19782   {
19783     "type": "get",
19784     "url": "/api/rpc/chat/queues/waitinginteractions",
19785     "title": "Gets a list of chatQueuesWaitingInteractions",
19786     "examples": [
19787       {
19788         "title": "Example usage:",
19789         "content": "curl https://{domain}/api/rpc/chat/queues/waitinginteractions -v -u {name}:{password}",
19790         "type": "json"
19791       }
19792     ],
19793     "name": "chatQueuesWaitingInteractions",
19794     "group": "RPC_Realtime",
19795     "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>",
19796     "version": "0.0.0",
19797     "filename": "server/api/rpc/index.js",
19798     "groupTitle": "RPC_Realtime"
19799   },
19800   {
19801     "type": "post",
19802     "url": "/api/rpc/fax/queues/:id/notify",
19803     "title": "Notify message to a specific queue",
19804     "examples": [
19805       {
19806         "title": "Example usage:",
19807         "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",
19808         "type": "json"
19809       }
19810     ],
19811     "name": "faxQueueNotify",
19812     "group": "RPC_Realtime",
19813     "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>",
19814     "version": "0.0.0",
19815     "filename": "server/api/rpc/index.js",
19816     "groupTitle": "RPC_Realtime"
19817   },
19818   {
19819     "type": "get",
19820     "url": "/api/rpc/fax/queues/waitinginteractions",
19821     "title": "Gets a list of faxQueuesWaitingInteractions",
19822     "examples": [
19823       {
19824         "title": "Example usage:",
19825         "content": "curl https://{domain}/api/rpc/fax/queues/waitinginteractions -v -u {name}:{password}",
19826         "type": "json"
19827       }
19828     ],
19829     "name": "faxQueuesWaitingInteractions",
19830     "group": "RPC_Realtime",
19831     "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>",
19832     "version": "0.0.0",
19833     "filename": "server/api/rpc/index.js",
19834     "groupTitle": "RPC_Realtime"
19835   },
19836   {
19837     "type": "post",
19838     "url": "/api/rpc/mail/queues/:id/notify",
19839     "title": "Notify message to a specific queue",
19840     "examples": [
19841       {
19842         "title": "Example usage:",
19843         "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",
19844         "type": "json"
19845       }
19846     ],
19847     "name": "mailQueueNotify",
19848     "group": "RPC_Realtime",
19849     "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>",
19850     "version": "0.0.0",
19851     "filename": "server/api/rpc/index.js",
19852     "groupTitle": "RPC_Realtime"
19853   },
19854   {
19855     "type": "get",
19856     "url": "/api/rpc/mail/queues/waitinginteractions",
19857     "title": "Gets a list of mailQueuesWaitingInteractions",
19858     "examples": [
19859       {
19860         "title": "Example usage:",
19861         "content": "curl https://{domain}/api/rpc/mail/queues/waitinginteractions -v -u {name}:{password}",
19862         "type": "json"
19863       }
19864     ],
19865     "name": "mailQueuesWaitingInteractions",
19866     "group": "RPC_Realtime",
19867     "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>",
19868     "version": "0.0.0",
19869     "filename": "server/api/rpc/index.js",
19870     "groupTitle": "RPC_Realtime"
19871   },
19872   {
19873     "type": "post",
19874     "url": "/api/rpc/openchannel/queues/:id/notify",
19875     "title": "Notify message to a specific queue",
19876     "examples": [
19877       {
19878         "title": "Example usage:",
19879         "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",
19880         "type": "json"
19881       }
19882     ],
19883     "name": "openchannelQueueNotify",
19884     "group": "RPC_Realtime",
19885     "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>",
19886     "version": "0.0.0",
19887     "filename": "server/api/rpc/index.js",
19888     "groupTitle": "RPC_Realtime"
19889   },
19890   {
19891     "type": "get",
19892     "url": "/api/rpc/openchannel/queues/waitinginteractions",
19893     "title": "Gets a list of openchannelQueuesWaitingInteractions",
19894     "examples": [
19895       {
19896         "title": "Example usage:",
19897         "content": "curl https://{domain}/api/rpc/openchannel/queues/waitinginteractions -v -u {name}:{password}",
19898         "type": "json"
19899       }
19900     ],
19901     "name": "openchannelQueuesWaitingInteractions",
19902     "group": "RPC_Realtime",
19903     "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>",
19904     "version": "0.0.0",
19905     "filename": "server/api/rpc/index.js",
19906     "groupTitle": "RPC_Realtime"
19907   },
19908   {
19909     "type": "post",
19910     "url": "/api/rpc/sms/queues/:id/notify",
19911     "title": "Notify message to a specific queue",
19912     "examples": [
19913       {
19914         "title": "Example usage:",
19915         "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",
19916         "type": "json"
19917       }
19918     ],
19919     "name": "smsQueueNotify",
19920     "group": "RPC_Realtime",
19921     "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>",
19922     "version": "0.0.0",
19923     "filename": "server/api/rpc/index.js",
19924     "groupTitle": "RPC_Realtime"
19925   },
19926   {
19927     "type": "get",
19928     "url": "/api/rpc/sms/queues/waitinginteractions",
19929     "title": "Gets a list of smsQueuesWaitingInteractions",
19930     "examples": [
19931       {
19932         "title": "Example usage:",
19933         "content": "curl https://{domain}/api/rpc/sms/queues/waitinginteractions -v -u {name}:{password}",
19934         "type": "json"
19935       }
19936     ],
19937     "name": "smsQueuesWaitingInteractions",
19938     "group": "RPC_Realtime",
19939     "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>",
19940     "version": "0.0.0",
19941     "filename": "server/api/rpc/index.js",
19942     "groupTitle": "RPC_Realtime"
19943   },
19944   {
19945     "type": "post",
19946     "url": "/api/integrations/salesforce/accounts",
19947     "title": "Creates a new Salesforce Account",
19948     "examples": [
19949       {
19950         "title": "Example usage:",
19951         "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",
19952         "type": "json"
19953       }
19954     ],
19955     "name": "CreateSalesforce_Accounts",
19956     "group": "Salesforce_Accounts",
19957     "parameter": {
19958       "fields": {
19959         "Body": [
19960           {
19961             "group": "Body",
19962             "type": "String",
19963             "optional": true,
19964             "field": "name",
19965             "description": ""
19966           },
19967           {
19968             "group": "Body",
19969             "type": "String",
19970             "optional": true,
19971             "field": "description",
19972             "description": ""
19973           },
19974           {
19975             "group": "Body",
19976             "type": "String",
19977             "optional": true,
19978             "field": "username",
19979             "description": ""
19980           },
19981           {
19982             "group": "Body",
19983             "type": "String",
19984             "optional": true,
19985             "field": "remoteUri",
19986             "description": ""
19987           },
19988           {
19989             "group": "Body",
19990             "type": "String",
19991             "optional": true,
19992             "field": "password",
19993             "description": ""
19994           },
19995           {
19996             "group": "Body",
19997             "type": "String",
19998             "optional": true,
19999             "field": "clientId",
20000             "description": ""
20001           },
20002           {
20003             "group": "Body",
20004             "type": "String",
20005             "optional": true,
20006             "field": "clientSecret",
20007             "description": ""
20008           },
20009           {
20010             "group": "Body",
20011             "type": "String",
20012             "optional": true,
20013             "field": "securityToken",
20014             "description": ""
20015           },
20016           {
20017             "group": "Body",
20018             "type": "String",
20019             "optional": true,
20020             "field": "serverUrl",
20021             "description": ""
20022           },
20023           {
20024             "group": "Body",
20025             "type": "String",
20026             "allowedValues": [
20027               "\"integrationTab\"",
20028               "\"newTab\""
20029             ],
20030             "optional": true,
20031             "field": "type",
20032             "description": ""
20033           }
20034         ]
20035       }
20036     },
20037     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20038     "version": "0.0.0",
20039     "filename": "server/api/intSalesforceAccount/index.js",
20040     "groupTitle": "Salesforce_Accounts"
20041   },
20042   {
20043     "type": "delete",
20044     "url": "/api/integrations/salesforce/accounts/{id}",
20045     "title": "Deletes a Salesforce Account",
20046     "examples": [
20047       {
20048         "title": "Example usage:",
20049         "content": "curl https://{domain}/api/integrations/salesforce/accounts/{id} -v -u {name}:{password} -X DELETE",
20050         "type": "json"
20051       }
20052     ],
20053     "name": "DeleteSalesforce_Accounts",
20054     "group": "Salesforce_Accounts",
20055     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20056     "version": "0.0.0",
20057     "filename": "server/api/intSalesforceAccount/index.js",
20058     "groupTitle": "Salesforce_Accounts"
20059   },
20060   {
20061     "type": "get",
20062     "url": "/api/integrations/salesforce/accounts",
20063     "title": "Gets a list of Salesforce Accounts",
20064     "examples": [
20065       {
20066         "title": "Example usage:",
20067         "content": "curl https://{domain}/api/integrations/salesforce/accounts -v -u {name}:{password}",
20068         "type": "json"
20069       }
20070     ],
20071     "name": "GetSalesforce_Accounts",
20072     "group": "Salesforce_Accounts",
20073     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
20074     "version": "0.0.0",
20075     "filename": "server/api/intSalesforceAccount/index.js",
20076     "groupTitle": "Salesforce_Accounts"
20077   },
20078   {
20079     "type": "get",
20080     "url": "/api/integrations/salesforce/accounts/{id}",
20081     "title": "Gets a single Salesforce Account",
20082     "examples": [
20083       {
20084         "title": "Example usage:",
20085         "content": "curl https://{domain}/api/integrations/salesforce/accounts/{id} -v -u {name}:{password}",
20086         "type": "json"
20087       }
20088     ],
20089     "name": "ShowSalesforce_Accounts",
20090     "group": "Salesforce_Accounts",
20091     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20092     "version": "0.0.0",
20093     "filename": "server/api/intSalesforceAccount/index.js",
20094     "groupTitle": "Salesforce_Accounts"
20095   },
20096   {
20097     "type": "post",
20098     "url": "/api/integrations/salesforce/accounts/{id}/configurations",
20099     "title": "Creates new configuration",
20100     "examples": [
20101       {
20102         "title": "Example usage:",
20103         "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",
20104         "type": "json"
20105       }
20106     ],
20107     "name": "addConfiguration",
20108     "group": "Salesforce_Accounts",
20109     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20110     "version": "0.0.0",
20111     "filename": "server/api/intSalesforceAccount/index.js",
20112     "groupTitle": "Salesforce_Accounts"
20113   },
20114   {
20115     "type": "get",
20116     "url": "/api/integrations/salesforce/accounts/{id}/configurations",
20117     "title": "Gets account configurations",
20118     "examples": [
20119       {
20120         "title": "Example usage:",
20121         "content": "curl https://{domain}/api/integrations/salesforce/accounts/{id}/configurations -v -u {name}:{password} -X GET",
20122         "type": "json"
20123       }
20124     ],
20125     "name": "getConfigurations",
20126     "group": "Salesforce_Accounts",
20127     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20128     "version": "0.0.0",
20129     "filename": "server/api/intSalesforceAccount/index.js",
20130     "groupTitle": "Salesforce_Accounts"
20131   },
20132   {
20133     "type": "get",
20134     "url": "/api/integrations/salesforce/accounts/{id}/fields",
20135     "title": "Gets account fields",
20136     "examples": [
20137       {
20138         "title": "Example usage:",
20139         "content": "curl https://{domain}/api/integrations/salesforce/accounts/{id}/fields -v -u {name}:{password} -X GET",
20140         "type": "json"
20141       }
20142     ],
20143     "name": "getFields",
20144     "group": "Salesforce_Accounts",
20145     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20146     "version": "0.0.0",
20147     "filename": "server/api/intSalesforceAccount/index.js",
20148     "groupTitle": "Salesforce_Accounts"
20149   },
20150   {
20151     "type": "put",
20152     "url": "/api/integrations/salesforce/accounts/{id}",
20153     "title": "Update an existing Salesforce Account",
20154     "examples": [
20155       {
20156         "title": "Example usage:",
20157         "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",
20158         "type": "json"
20159       }
20160     ],
20161     "name": "updateSalesforce_Accounts",
20162     "group": "Salesforce_Accounts",
20163     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20164     "version": "0.0.0",
20165     "filename": "server/api/intSalesforceAccount/index.js",
20166     "groupTitle": "Salesforce_Accounts"
20167   },
20168   {
20169     "type": "post",
20170     "url": "/api/integrations/salesforce/configurations",
20171     "title": "Creates a new Salesforce Configuration",
20172     "examples": [
20173       {
20174         "title": "Example usage:",
20175         "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",
20176         "type": "json"
20177       }
20178     ],
20179     "name": "CreateSalesforce_Configurations",
20180     "group": "Salesforce_Configurations",
20181     "parameter": {
20182       "fields": {
20183         "Body": [
20184           {
20185             "group": "Body",
20186             "type": "String",
20187             "optional": true,
20188             "field": "name",
20189             "description": ""
20190           },
20191           {
20192             "group": "Body",
20193             "type": "String",
20194             "optional": true,
20195             "field": "description",
20196             "description": ""
20197           },
20198           {
20199             "group": "Body",
20200             "type": "String",
20201             "allowedValues": [
20202               "\"Task\"",
20203               "\"Case\""
20204             ],
20205             "optional": true,
20206             "field": "ticketType",
20207             "description": ""
20208           },
20209           {
20210             "group": "Body",
20211             "type": "String",
20212             "allowedValues": [
20213               "\"contact_lead\"",
20214               "\"contact\"",
20215               "\"lead\""
20216             ],
20217             "optional": true,
20218             "field": "moduleSearch",
20219             "description": ""
20220           },
20221           {
20222             "group": "Body",
20223             "type": "String",
20224             "allowedValues": [
20225               "\"nothing\"",
20226               "\"contact\"",
20227               "\"lead\""
20228             ],
20229             "optional": true,
20230             "field": "moduleCreate",
20231             "description": ""
20232           }
20233         ]
20234       }
20235     },
20236     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20237     "version": "0.0.0",
20238     "filename": "server/api/intSalesforceConfiguration/index.js",
20239     "groupTitle": "Salesforce_Configurations"
20240   },
20241   {
20242     "type": "delete",
20243     "url": "/api/integrations/salesforce/configurations/{id}",
20244     "title": "Deletes a Salesforce Configuration",
20245     "examples": [
20246       {
20247         "title": "Example usage:",
20248         "content": "curl https://{domain}/api/integrations/salesforce/configurations/{id} -v -u {name}:{password} -X DELETE",
20249         "type": "json"
20250       }
20251     ],
20252     "name": "DeleteSalesforce_Configurations",
20253     "group": "Salesforce_Configurations",
20254     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20255     "version": "0.0.0",
20256     "filename": "server/api/intSalesforceConfiguration/index.js",
20257     "groupTitle": "Salesforce_Configurations"
20258   },
20259   {
20260     "type": "get",
20261     "url": "/api/integrations/salesforce/configurations",
20262     "title": "Gets a list of Salesforce Configurations",
20263     "examples": [
20264       {
20265         "title": "Example usage:",
20266         "content": "curl https://{domain}/api/integrations/salesforce/configurations -v -u {name}:{password}",
20267         "type": "json"
20268       }
20269     ],
20270     "name": "GetSalesforce_Configurations",
20271     "group": "Salesforce_Configurations",
20272     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
20273     "version": "0.0.0",
20274     "filename": "server/api/intSalesforceConfiguration/index.js",
20275     "groupTitle": "Salesforce_Configurations"
20276   },
20277   {
20278     "type": "get",
20279     "url": "/api/integrations/salesforce/configurations/{id}",
20280     "title": "Gets a single Salesforce Configuration",
20281     "examples": [
20282       {
20283         "title": "Example usage:",
20284         "content": "curl https://{domain}/api/integrations/salesforce/configurations/{id} -v -u {name}:{password}",
20285         "type": "json"
20286       }
20287     ],
20288     "name": "ShowSalesforce_Configurations",
20289     "group": "Salesforce_Configurations",
20290     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20291     "version": "0.0.0",
20292     "filename": "server/api/intSalesforceConfiguration/index.js",
20293     "groupTitle": "Salesforce_Configurations"
20294   },
20295   {
20296     "type": "get",
20297     "url": "/api/integrations/salesforce/configurations/{id}/descriptions",
20298     "title": "Gets configurations descriptions",
20299     "examples": [
20300       {
20301         "title": "Example usage:",
20302         "content": "curl https://{domain}/api/integrations/salesforce/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
20303         "type": "json"
20304       }
20305     ],
20306     "name": "getDescriptions",
20307     "group": "Salesforce_Configurations",
20308     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20309     "version": "0.0.0",
20310     "filename": "server/api/intSalesforceConfiguration/index.js",
20311     "groupTitle": "Salesforce_Configurations"
20312   },
20313   {
20314     "type": "get",
20315     "url": "/api/integrations/salesforce/configurations/{id}/fields",
20316     "title": "Gets configurations fields",
20317     "examples": [
20318       {
20319         "title": "Example usage:",
20320         "content": "curl https://{domain}/api/integrations/salesforce/configurations/{id}/fields -v -u {name}:{password} -X GET",
20321         "type": "json"
20322       }
20323     ],
20324     "name": "getFields",
20325     "group": "Salesforce_Configurations",
20326     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20327     "version": "0.0.0",
20328     "filename": "server/api/intSalesforceConfiguration/index.js",
20329     "groupTitle": "Salesforce_Configurations"
20330   },
20331   {
20332     "type": "get",
20333     "url": "/api/integrations/salesforce/configurations/{id}/subjects",
20334     "title": "Gets configurations subjects",
20335     "examples": [
20336       {
20337         "title": "Example usage:",
20338         "content": "curl https://{domain}/api/integrations/salesforce/configurations/{id}/subjects -v -u {name}:{password} -X GET",
20339         "type": "json"
20340       }
20341     ],
20342     "name": "getSubjects",
20343     "group": "Salesforce_Configurations",
20344     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20345     "version": "0.0.0",
20346     "filename": "server/api/intSalesforceConfiguration/index.js",
20347     "groupTitle": "Salesforce_Configurations"
20348   },
20349   {
20350     "type": "put",
20351     "url": "/api/integrations/salesforce/configurations/{id}",
20352     "title": "Update an existing Salesforce Configuration",
20353     "examples": [
20354       {
20355         "title": "Example usage:",
20356         "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",
20357         "type": "json"
20358       }
20359     ],
20360     "name": "updateSalesforce_Configurations",
20361     "group": "Salesforce_Configurations",
20362     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20363     "version": "0.0.0",
20364     "filename": "server/api/intSalesforceConfiguration/index.js",
20365     "groupTitle": "Salesforce_Configurations"
20366   },
20367   {
20368     "type": "post",
20369     "url": "/api/integrations/salesforce/fields",
20370     "title": "Creates a new Salesforce Field",
20371     "examples": [
20372       {
20373         "title": "Example usage:",
20374         "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",
20375         "type": "json"
20376       }
20377     ],
20378     "name": "CreateSalesforce_Fields",
20379     "group": "Salesforce_Fields",
20380     "parameter": {
20381       "fields": {
20382         "Body": [
20383           {
20384             "group": "Body",
20385             "type": "String",
20386             "allowedValues": [
20387               "\"string\"",
20388               "\"variable\"",
20389               "\"customVariable\"",
20390               "\"keyValue\""
20391             ],
20392             "optional": true,
20393             "field": "type",
20394             "description": ""
20395           },
20396           {
20397             "group": "Body",
20398             "type": "String",
20399             "optional": true,
20400             "field": "content",
20401             "description": ""
20402           },
20403           {
20404             "group": "Body",
20405             "type": "String",
20406             "optional": true,
20407             "field": "key",
20408             "description": ""
20409           },
20410           {
20411             "group": "Body",
20412             "type": "String",
20413             "allowedValues": [
20414               "\"string\"",
20415               "\"variable\"",
20416               "\"customVariable\""
20417             ],
20418             "optional": true,
20419             "field": "keyType",
20420             "description": ""
20421           },
20422           {
20423             "group": "Body",
20424             "type": "String",
20425             "optional": true,
20426             "field": "keyContent",
20427             "description": ""
20428           },
20429           {
20430             "group": "Body",
20431             "type": "String",
20432             "optional": true,
20433             "field": "idField",
20434             "description": ""
20435           },
20436           {
20437             "group": "Body",
20438             "type": "String",
20439             "optional": true,
20440             "field": "variableName",
20441             "description": ""
20442           }
20443         ]
20444       }
20445     },
20446     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20447     "version": "0.0.0",
20448     "filename": "server/api/intSalesforceField/index.js",
20449     "groupTitle": "Salesforce_Fields"
20450   },
20451   {
20452     "type": "delete",
20453     "url": "/api/integrations/salesforce/fields/{id}",
20454     "title": "Deletes a Salesforce Field",
20455     "examples": [
20456       {
20457         "title": "Example usage:",
20458         "content": "curl https://{domain}/api/integrations/salesforce/fields/{id} -v -u {name}:{password} -X DELETE",
20459         "type": "json"
20460       }
20461     ],
20462     "name": "DeleteSalesforce_Fields",
20463     "group": "Salesforce_Fields",
20464     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20465     "version": "0.0.0",
20466     "filename": "server/api/intSalesforceField/index.js",
20467     "groupTitle": "Salesforce_Fields"
20468   },
20469   {
20470     "type": "get",
20471     "url": "/api/integrations/salesforce/fields",
20472     "title": "Gets a list of Salesforce Fields",
20473     "examples": [
20474       {
20475         "title": "Example usage:",
20476         "content": "curl https://{domain}/api/integrations/salesforce/fields -v -u {name}:{password}",
20477         "type": "json"
20478       }
20479     ],
20480     "name": "GetSalesforce_Fields",
20481     "group": "Salesforce_Fields",
20482     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
20483     "version": "0.0.0",
20484     "filename": "server/api/intSalesforceField/index.js",
20485     "groupTitle": "Salesforce_Fields"
20486   },
20487   {
20488     "type": "get",
20489     "url": "/api/integrations/salesforce/fields/{id}",
20490     "title": "Gets a single Salesforce Field",
20491     "examples": [
20492       {
20493         "title": "Example usage:",
20494         "content": "curl https://{domain}/api/integrations/salesforce/fields/{id} -v -u {name}:{password}",
20495         "type": "json"
20496       }
20497     ],
20498     "name": "ShowSalesforce_Fields",
20499     "group": "Salesforce_Fields",
20500     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20501     "version": "0.0.0",
20502     "filename": "server/api/intSalesforceField/index.js",
20503     "groupTitle": "Salesforce_Fields"
20504   },
20505   {
20506     "type": "put",
20507     "url": "/api/integrations/salesforce/fields/{id}",
20508     "title": "Update an existing Salesforce Field",
20509     "examples": [
20510       {
20511         "title": "Example usage:",
20512         "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",
20513         "type": "json"
20514       }
20515     ],
20516     "name": "updateSalesforce_Fields",
20517     "group": "Salesforce_Fields",
20518     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20519     "version": "0.0.0",
20520     "filename": "server/api/intSalesforceField/index.js",
20521     "groupTitle": "Salesforce_Fields"
20522   },
20523   {
20524     "type": "post",
20525     "url": "/api/schedules",
20526     "title": "Creates a new Schedule",
20527     "examples": [
20528       {
20529         "title": "Example usage:",
20530         "content": "curl https://{domain}/api/schedules -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
20531         "type": "json"
20532       }
20533     ],
20534     "name": "CreateSchedules",
20535     "group": "Schedules",
20536     "parameter": {
20537       "fields": {
20538         "Body": [
20539           {
20540             "group": "Body",
20541             "type": "String",
20542             "optional": false,
20543             "field": "name",
20544             "description": ""
20545           },
20546           {
20547             "group": "Body",
20548             "type": "String",
20549             "optional": true,
20550             "field": "description",
20551             "description": ""
20552           },
20553           {
20554             "group": "Body",
20555             "type": "Boolean",
20556             "optional": false,
20557             "field": "active",
20558             "description": ""
20559           },
20560           {
20561             "group": "Body",
20562             "type": "String",
20563             "optional": false,
20564             "field": "cron",
20565             "description": ""
20566           },
20567           {
20568             "group": "Body",
20569             "type": "String",
20570             "optional": false,
20571             "field": "startAt",
20572             "description": ""
20573           },
20574           {
20575             "group": "Body",
20576             "type": "String",
20577             "optional": false,
20578             "field": "endAt",
20579             "description": ""
20580           },
20581           {
20582             "group": "Body",
20583             "type": "Integer",
20584             "optional": false,
20585             "field": "subtractNumber",
20586             "description": ""
20587           },
20588           {
20589             "group": "Body",
20590             "type": "String",
20591             "allowedValues": [
20592               "\"years\"",
20593               "\"quarters\"",
20594               "\"months\"",
20595               "\"weeks\"",
20596               "\"days\"",
20597               "\"hours\"",
20598               "\"minutes\""
20599             ],
20600             "optional": false,
20601             "field": "subtractUnit",
20602             "description": ""
20603           },
20604           {
20605             "group": "Body",
20606             "type": "String",
20607             "allowedValues": [
20608               "\"csv\"",
20609               "\"pdf\"",
20610               "\"xlsx\""
20611             ],
20612             "optional": false,
20613             "field": "output",
20614             "description": ""
20615           },
20616           {
20617             "group": "Body",
20618             "type": "String",
20619             "allowedValues": [
20620               "\"custom\"",
20621               "\"default\""
20622             ],
20623             "optional": false,
20624             "field": "type",
20625             "description": ""
20626           },
20627           {
20628             "group": "Body",
20629             "type": "Boolean",
20630             "optional": true,
20631             "field": "sendMail",
20632             "description": ""
20633           },
20634           {
20635             "group": "Body",
20636             "type": "String",
20637             "optional": true,
20638             "field": "email",
20639             "description": ""
20640           },
20641           {
20642             "group": "Body",
20643             "type": "Text",
20644             "optional": true,
20645             "field": "cc",
20646             "description": ""
20647           },
20648           {
20649             "group": "Body",
20650             "type": "Text",
20651             "optional": true,
20652             "field": "bcc",
20653             "description": ""
20654           },
20655           {
20656             "group": "Body",
20657             "type": "Boolean",
20658             "optional": true,
20659             "field": "sendIfEmpty",
20660             "description": ""
20661           }
20662         ]
20663       }
20664     },
20665     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20666     "version": "0.0.0",
20667     "filename": "server/api/schedule/index.js",
20668     "groupTitle": "Schedules"
20669   },
20670   {
20671     "type": "delete",
20672     "url": "/api/schedules/{id}",
20673     "title": "Deletes a Schedule",
20674     "examples": [
20675       {
20676         "title": "Example usage:",
20677         "content": "curl https://{domain}/api/schedules/{id} -v -u {name}:{password} -X DELETE",
20678         "type": "json"
20679       }
20680     ],
20681     "name": "DeleteSchedules",
20682     "group": "Schedules",
20683     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20684     "version": "0.0.0",
20685     "filename": "server/api/schedule/index.js",
20686     "groupTitle": "Schedules"
20687   },
20688   {
20689     "type": "get",
20690     "url": "/api/schedules",
20691     "title": "Gets a list of Schedules",
20692     "examples": [
20693       {
20694         "title": "Example usage:",
20695         "content": "curl https://{domain}/api/schedules -v -u {name}:{password}",
20696         "type": "json"
20697       }
20698     ],
20699     "name": "GetSchedules",
20700     "group": "Schedules",
20701     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
20702     "version": "0.0.0",
20703     "filename": "server/api/schedule/index.js",
20704     "groupTitle": "Schedules"
20705   },
20706   {
20707     "type": "get",
20708     "url": "/api/schedules/{id}",
20709     "title": "Gets a single Schedule",
20710     "examples": [
20711       {
20712         "title": "Example usage:",
20713         "content": "curl https://{domain}/api/schedules/{id} -v -u {name}:{password}",
20714         "type": "json"
20715       }
20716     ],
20717     "name": "ShowSchedules",
20718     "group": "Schedules",
20719     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20720     "version": "0.0.0",
20721     "filename": "server/api/schedule/index.js",
20722     "groupTitle": "Schedules"
20723   },
20724   {
20725     "type": "get",
20726     "url": "/api/schedules/{id}/run",
20727     "title": "Run Scheduler",
20728     "examples": [
20729       {
20730         "title": "Example usage:",
20731         "content": "curl https://{domain}/api/schedules/{id}/run -v -u {name}:{password} -X GET",
20732         "type": "json"
20733       }
20734     ],
20735     "name": "run",
20736     "group": "Schedules",
20737     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20738     "version": "0.0.0",
20739     "filename": "server/api/schedule/index.js",
20740     "groupTitle": "Schedules"
20741   },
20742   {
20743     "type": "put",
20744     "url": "/api/schedules/{id}",
20745     "title": "Update an existing Schedule",
20746     "examples": [
20747       {
20748         "title": "Example usage:",
20749         "content": "curl https://{domain}/api/schedules/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
20750         "type": "json"
20751       }
20752     ],
20753     "name": "updateSchedules",
20754     "group": "Schedules",
20755     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20756     "version": "0.0.0",
20757     "filename": "server/api/schedule/index.js",
20758     "groupTitle": "Schedules"
20759   },
20760   {
20761     "type": "post",
20762     "url": "/api/screen/recordings",
20763     "title": "Creates a new Recording",
20764     "examples": [
20765       {
20766         "title": "Example usage:",
20767         "content": "curl https://{domain}/api/screen/recordings -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
20768         "type": "json"
20769       }
20770     ],
20771     "name": "CreateRecordings",
20772     "group": "Screen_Recordings",
20773     "parameter": {
20774       "fields": {
20775         "Body": [
20776           {
20777             "group": "Body",
20778             "type": "Virtual",
20779             "optional": true,
20780             "field": "format",
20781             "description": ""
20782           },
20783           {
20784             "group": "Body",
20785             "type": "String",
20786             "optional": true,
20787             "field": "interactionid",
20788             "description": ""
20789           },
20790           {
20791             "group": "Body",
20792             "type": "String",
20793             "optional": true,
20794             "field": "channel",
20795             "description": ""
20796           },
20797           {
20798             "group": "Body",
20799             "type": "String",
20800             "optional": true,
20801             "field": "value",
20802             "description": ""
20803           },
20804           {
20805             "group": "Body",
20806             "type": "Integer",
20807             "optional": true,
20808             "field": "rating",
20809             "description": ""
20810           },
20811           {
20812             "group": "Body",
20813             "type": "Integer",
20814             "optional": true,
20815             "field": "duration",
20816             "description": ""
20817           },
20818           {
20819             "group": "Body",
20820             "type": "String",
20821             "optional": true,
20822             "field": "startedAt",
20823             "description": ""
20824           },
20825           {
20826             "group": "Body",
20827             "type": "String",
20828             "optional": true,
20829             "field": "closedAt",
20830             "description": ""
20831           },
20832           {
20833             "group": "Body",
20834             "type": "String",
20835             "optional": true,
20836             "field": "createdAt",
20837             "description": ""
20838           },
20839           {
20840             "group": "Body",
20841             "type": "String",
20842             "optional": true,
20843             "field": "updatedAt",
20844             "description": ""
20845           }
20846         ]
20847       }
20848     },
20849     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20850     "version": "0.0.0",
20851     "filename": "server/api/screenRecording/index.js",
20852     "groupTitle": "Screen_Recordings"
20853   },
20854   {
20855     "type": "get",
20856     "url": "/api/screen/recordings/describe",
20857     "title": "Gets table info about Recordings",
20858     "examples": [
20859       {
20860         "title": "Example usage:",
20861         "content": "curl https://{domain}/api/screen/recordings/describe -v -u {name}:{password}",
20862         "type": "json"
20863       }
20864     ],
20865     "name": "DescribeRecordings",
20866     "group": "Screen_Recordings",
20867     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20868     "version": "0.0.0",
20869     "filename": "server/api/screenRecording/index.js",
20870     "groupTitle": "Screen_Recordings"
20871   },
20872   {
20873     "type": "get",
20874     "url": "/api/screen/recordings",
20875     "title": "Gets a list of Recordings",
20876     "examples": [
20877       {
20878         "title": "Example usage:",
20879         "content": "curl https://{domain}/api/screen/recordings -v -u {name}:{password}",
20880         "type": "json"
20881       }
20882     ],
20883     "name": "GetRecordings",
20884     "group": "Screen_Recordings",
20885     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
20886     "version": "0.0.0",
20887     "filename": "server/api/screenRecording/index.js",
20888     "groupTitle": "Screen_Recordings"
20889   },
20890   {
20891     "type": "get",
20892     "url": "/api/screen/recordings/{id}",
20893     "title": "Gets a single Recording",
20894     "examples": [
20895       {
20896         "title": "Example usage:",
20897         "content": "curl https://{domain}/api/screen/recordings/{id} -v -u {name}:{password}",
20898         "type": "json"
20899       }
20900     ],
20901     "name": "ShowRecordings",
20902     "group": "Screen_Recordings",
20903     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20904     "version": "0.0.0",
20905     "filename": "server/api/screenRecording/index.js",
20906     "groupTitle": "Screen_Recordings"
20907   },
20908   {
20909     "type": "delete",
20910     "url": "/api/screen/recordings/{id}",
20911     "title": "Delete screen recording",
20912     "examples": [
20913       {
20914         "title": "Example usage:",
20915         "content": "curl https://{domain}/api/screen/recordings/{id} -v -u {name}:{password} -X DELETE",
20916         "type": "json"
20917       }
20918     ],
20919     "name": "destroy",
20920     "group": "Screen_Recordings",
20921     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20922     "version": "0.0.0",
20923     "filename": "server/api/screenRecording/index.js",
20924     "groupTitle": "Screen_Recordings"
20925   },
20926   {
20927     "type": "get",
20928     "url": "/api/screen/recordings/{id}/download",
20929     "title": "Download Recording",
20930     "examples": [
20931       {
20932         "title": "Example usage:",
20933         "content": "curl https://{domain}/api/screen/recordings/{id}/download -v -u {name}:{password} -X GET",
20934         "type": "json"
20935       }
20936     ],
20937     "name": "download",
20938     "group": "Screen_Recordings",
20939     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20940     "version": "0.0.0",
20941     "filename": "server/api/screenRecording/index.js",
20942     "groupTitle": "Screen_Recordings"
20943   },
20944   {
20945     "type": "put",
20946     "url": "/api/screen/recordings/{id}",
20947     "title": "Update an existing Recording",
20948     "examples": [
20949       {
20950         "title": "Example usage:",
20951         "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",
20952         "type": "json"
20953       }
20954     ],
20955     "name": "updateRecordings",
20956     "group": "Screen_Recordings",
20957     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20958     "version": "0.0.0",
20959     "filename": "server/api/screenRecording/index.js",
20960     "groupTitle": "Screen_Recordings"
20961   },
20962   {
20963     "type": "post",
20964     "url": "/api/integrations/servicenow/accounts",
20965     "title": "Creates a new Servicenow Account",
20966     "examples": [
20967       {
20968         "title": "Example usage:",
20969         "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",
20970         "type": "json"
20971       }
20972     ],
20973     "name": "CreateServicenow_Accounts",
20974     "group": "Servicenow_Accounts",
20975     "parameter": {
20976       "fields": {
20977         "Body": [
20978           {
20979             "group": "Body",
20980             "type": "String",
20981             "optional": true,
20982             "field": "name",
20983             "description": ""
20984           },
20985           {
20986             "group": "Body",
20987             "type": "String",
20988             "optional": true,
20989             "field": "description",
20990             "description": ""
20991           },
20992           {
20993             "group": "Body",
20994             "type": "String",
20995             "optional": true,
20996             "field": "username",
20997             "description": ""
20998           },
20999           {
21000             "group": "Body",
21001             "type": "String",
21002             "optional": true,
21003             "field": "password",
21004             "description": ""
21005           },
21006           {
21007             "group": "Body",
21008             "type": "String",
21009             "optional": true,
21010             "field": "email",
21011             "description": ""
21012           },
21013           {
21014             "group": "Body",
21015             "type": "String",
21016             "optional": true,
21017             "field": "remoteUri",
21018             "description": ""
21019           },
21020           {
21021             "group": "Body",
21022             "type": "String",
21023             "optional": true,
21024             "field": "serverUrl",
21025             "description": ""
21026           }
21027         ]
21028       }
21029     },
21030     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21031     "version": "0.0.0",
21032     "filename": "server/api/intServicenowAccount/index.js",
21033     "groupTitle": "Servicenow_Accounts"
21034   },
21035   {
21036     "type": "delete",
21037     "url": "/api/integrations/servicenow/accounts/{id}",
21038     "title": "Deletes a Servicenow Account",
21039     "examples": [
21040       {
21041         "title": "Example usage:",
21042         "content": "curl https://{domain}/api/integrations/servicenow/accounts/{id} -v -u {name}:{password} -X DELETE",
21043         "type": "json"
21044       }
21045     ],
21046     "name": "DeleteServicenow_Accounts",
21047     "group": "Servicenow_Accounts",
21048     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21049     "version": "0.0.0",
21050     "filename": "server/api/intServicenowAccount/index.js",
21051     "groupTitle": "Servicenow_Accounts"
21052   },
21053   {
21054     "type": "get",
21055     "url": "/api/integrations/servicenow/accounts",
21056     "title": "Gets a list of Servicenow Accounts",
21057     "examples": [
21058       {
21059         "title": "Example usage:",
21060         "content": "curl https://{domain}/api/integrations/servicenow/accounts -v -u {name}:{password}",
21061         "type": "json"
21062       }
21063     ],
21064     "name": "GetServicenow_Accounts",
21065     "group": "Servicenow_Accounts",
21066     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
21067     "version": "0.0.0",
21068     "filename": "server/api/intServicenowAccount/index.js",
21069     "groupTitle": "Servicenow_Accounts"
21070   },
21071   {
21072     "type": "get",
21073     "url": "/api/integrations/servicenow/accounts/{id}",
21074     "title": "Gets a single Servicenow Account",
21075     "examples": [
21076       {
21077         "title": "Example usage:",
21078         "content": "curl https://{domain}/api/integrations/servicenow/accounts/{id} -v -u {name}:{password}",
21079         "type": "json"
21080       }
21081     ],
21082     "name": "ShowServicenow_Accounts",
21083     "group": "Servicenow_Accounts",
21084     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21085     "version": "0.0.0",
21086     "filename": "server/api/intServicenowAccount/index.js",
21087     "groupTitle": "Servicenow_Accounts"
21088   },
21089   {
21090     "type": "post",
21091     "url": "/api/integrations/servicenow/accounts/{id}/configurations",
21092     "title": "Creates new configuration",
21093     "examples": [
21094       {
21095         "title": "Example usage:",
21096         "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",
21097         "type": "json"
21098       }
21099     ],
21100     "name": "addConfiguration",
21101     "group": "Servicenow_Accounts",
21102     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21103     "version": "0.0.0",
21104     "filename": "server/api/intServicenowAccount/index.js",
21105     "groupTitle": "Servicenow_Accounts"
21106   },
21107   {
21108     "type": "get",
21109     "url": "/api/integrations/servicenow/accounts/{id}/configurations",
21110     "title": "Gets account configurations",
21111     "examples": [
21112       {
21113         "title": "Example usage:",
21114         "content": "curl https://{domain}/api/integrations/servicenow/accounts/{id}/configurations -v -u {name}:{password} -X GET",
21115         "type": "json"
21116       }
21117     ],
21118     "name": "getConfigurations",
21119     "group": "Servicenow_Accounts",
21120     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21121     "version": "0.0.0",
21122     "filename": "server/api/intServicenowAccount/index.js",
21123     "groupTitle": "Servicenow_Accounts"
21124   },
21125   {
21126     "type": "get",
21127     "url": "/api/integrations/servicenow/accounts/{id}/fields",
21128     "title": "Gets account fields",
21129     "examples": [
21130       {
21131         "title": "Example usage:",
21132         "content": "curl https://{domain}/api/integrations/servicenow/accounts/{id}/fields -v -u {name}:{password} -X GET",
21133         "type": "json"
21134       }
21135     ],
21136     "name": "getFields",
21137     "group": "Servicenow_Accounts",
21138     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21139     "version": "0.0.0",
21140     "filename": "server/api/intServicenowAccount/index.js",
21141     "groupTitle": "Servicenow_Accounts"
21142   },
21143   {
21144     "type": "put",
21145     "url": "/api/integrations/servicenow/accounts/{id}",
21146     "title": "Update an existing Servicenow Account",
21147     "examples": [
21148       {
21149         "title": "Example usage:",
21150         "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",
21151         "type": "json"
21152       }
21153     ],
21154     "name": "updateServicenow_Accounts",
21155     "group": "Servicenow_Accounts",
21156     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <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/intServicenowAccount/index.js",
21159     "groupTitle": "Servicenow_Accounts"
21160   },
21161   {
21162     "type": "post",
21163     "url": "/api/integrations/servicenow/configurations",
21164     "title": "Creates a new Servicenow Configuration",
21165     "examples": [
21166       {
21167         "title": "Example usage:",
21168         "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",
21169         "type": "json"
21170       }
21171     ],
21172     "name": "CreateServicenow_Configurations",
21173     "group": "Servicenow_Configurations",
21174     "parameter": {
21175       "fields": {
21176         "Body": [
21177           {
21178             "group": "Body",
21179             "type": "String",
21180             "optional": true,
21181             "field": "name",
21182             "description": ""
21183           },
21184           {
21185             "group": "Body",
21186             "type": "String",
21187             "optional": true,
21188             "field": "description",
21189             "description": ""
21190           }
21191         ]
21192       }
21193     },
21194     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21195     "version": "0.0.0",
21196     "filename": "server/api/intServicenowConfiguration/index.js",
21197     "groupTitle": "Servicenow_Configurations"
21198   },
21199   {
21200     "type": "delete",
21201     "url": "/api/integrations/servicenow/configurations/{id}",
21202     "title": "Deletes a Servicenow Configuration",
21203     "examples": [
21204       {
21205         "title": "Example usage:",
21206         "content": "curl https://{domain}/api/integrations/servicenow/configurations/{id} -v -u {name}:{password} -X DELETE",
21207         "type": "json"
21208       }
21209     ],
21210     "name": "DeleteServicenow_Configurations",
21211     "group": "Servicenow_Configurations",
21212     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21213     "version": "0.0.0",
21214     "filename": "server/api/intServicenowConfiguration/index.js",
21215     "groupTitle": "Servicenow_Configurations"
21216   },
21217   {
21218     "type": "get",
21219     "url": "/api/integrations/servicenow/configurations",
21220     "title": "Gets a list of Servicenow Configurations",
21221     "examples": [
21222       {
21223         "title": "Example usage:",
21224         "content": "curl https://{domain}/api/integrations/servicenow/configurations -v -u {name}:{password}",
21225         "type": "json"
21226       }
21227     ],
21228     "name": "GetServicenow_Configurations",
21229     "group": "Servicenow_Configurations",
21230     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
21231     "version": "0.0.0",
21232     "filename": "server/api/intServicenowConfiguration/index.js",
21233     "groupTitle": "Servicenow_Configurations"
21234   },
21235   {
21236     "type": "get",
21237     "url": "/api/integrations/servicenow/configurations/{id}",
21238     "title": "Gets a single Servicenow Configuration",
21239     "examples": [
21240       {
21241         "title": "Example usage:",
21242         "content": "curl https://{domain}/api/integrations/servicenow/configurations/{id} -v -u {name}:{password}",
21243         "type": "json"
21244       }
21245     ],
21246     "name": "ShowServicenow_Configurations",
21247     "group": "Servicenow_Configurations",
21248     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21249     "version": "0.0.0",
21250     "filename": "server/api/intServicenowConfiguration/index.js",
21251     "groupTitle": "Servicenow_Configurations"
21252   },
21253   {
21254     "type": "get",
21255     "url": "/api/integrations/servicenow/configurations/{id}/descriptions",
21256     "title": "Gets configurations descriptions",
21257     "examples": [
21258       {
21259         "title": "Example usage:",
21260         "content": "curl https://{domain}/api/integrations/servicenow/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
21261         "type": "json"
21262       }
21263     ],
21264     "name": "getDescriptions",
21265     "group": "Servicenow_Configurations",
21266     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21267     "version": "0.0.0",
21268     "filename": "server/api/intServicenowConfiguration/index.js",
21269     "groupTitle": "Servicenow_Configurations"
21270   },
21271   {
21272     "type": "get",
21273     "url": "/api/integrations/servicenow/configurations/{id}/fields",
21274     "title": "Gets configurations fields",
21275     "examples": [
21276       {
21277         "title": "Example usage:",
21278         "content": "curl https://{domain}/api/integrations/servicenow/configurations/{id}/fields -v -u {name}:{password} -X GET",
21279         "type": "json"
21280       }
21281     ],
21282     "name": "getFields",
21283     "group": "Servicenow_Configurations",
21284     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21285     "version": "0.0.0",
21286     "filename": "server/api/intServicenowConfiguration/index.js",
21287     "groupTitle": "Servicenow_Configurations"
21288   },
21289   {
21290     "type": "get",
21291     "url": "/api/integrations/servicenow/configurations/{id}/subjects",
21292     "title": "Gets configurations subjects",
21293     "examples": [
21294       {
21295         "title": "Example usage:",
21296         "content": "curl https://{domain}/api/integrations/servicenow/configurations/{id}/subjects -v -u {name}:{password} -X GET",
21297         "type": "json"
21298       }
21299     ],
21300     "name": "getSubjects",
21301     "group": "Servicenow_Configurations",
21302     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21303     "version": "0.0.0",
21304     "filename": "server/api/intServicenowConfiguration/index.js",
21305     "groupTitle": "Servicenow_Configurations"
21306   },
21307   {
21308     "type": "put",
21309     "url": "/api/integrations/servicenow/configurations/{id}",
21310     "title": "Update an existing Servicenow Configuration",
21311     "examples": [
21312       {
21313         "title": "Example usage:",
21314         "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",
21315         "type": "json"
21316       }
21317     ],
21318     "name": "updateServicenow_Configurations",
21319     "group": "Servicenow_Configurations",
21320     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21321     "version": "0.0.0",
21322     "filename": "server/api/intServicenowConfiguration/index.js",
21323     "groupTitle": "Servicenow_Configurations"
21324   },
21325   {
21326     "type": "post",
21327     "url": "/api/integrations/servicenow/fields",
21328     "title": "Creates a new Servicenow Field",
21329     "examples": [
21330       {
21331         "title": "Example usage:",
21332         "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",
21333         "type": "json"
21334       }
21335     ],
21336     "name": "CreateServicenow_Fields",
21337     "group": "Servicenow_Fields",
21338     "parameter": {
21339       "fields": {
21340         "Body": [
21341           {
21342             "group": "Body",
21343             "type": "String",
21344             "allowedValues": [
21345               "\"string\"",
21346               "\"variable\"",
21347               "\"customVariable\"",
21348               "\"keyValue\""
21349             ],
21350             "optional": true,
21351             "field": "type",
21352             "description": ""
21353           },
21354           {
21355             "group": "Body",
21356             "type": "String",
21357             "optional": true,
21358             "field": "content",
21359             "description": ""
21360           },
21361           {
21362             "group": "Body",
21363             "type": "String",
21364             "optional": true,
21365             "field": "key",
21366             "description": ""
21367           },
21368           {
21369             "group": "Body",
21370             "type": "String",
21371             "allowedValues": [
21372               "\"string\"",
21373               "\"variable\"",
21374               "\"customVariable\""
21375             ],
21376             "optional": true,
21377             "field": "keyType",
21378             "description": ""
21379           },
21380           {
21381             "group": "Body",
21382             "type": "String",
21383             "optional": true,
21384             "field": "keyContent",
21385             "description": ""
21386           },
21387           {
21388             "group": "Body",
21389             "type": "String",
21390             "optional": true,
21391             "field": "idField",
21392             "description": ""
21393           },
21394           {
21395             "group": "Body",
21396             "type": "String",
21397             "optional": true,
21398             "field": "nameField",
21399             "description": ""
21400           },
21401           {
21402             "group": "Body",
21403             "type": "Boolean",
21404             "optional": true,
21405             "field": "customField",
21406             "description": ""
21407           },
21408           {
21409             "group": "Body",
21410             "type": "String",
21411             "optional": true,
21412             "field": "variableName",
21413             "description": ""
21414           }
21415         ]
21416       }
21417     },
21418     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21419     "version": "0.0.0",
21420     "filename": "server/api/intServicenowField/index.js",
21421     "groupTitle": "Servicenow_Fields"
21422   },
21423   {
21424     "type": "delete",
21425     "url": "/api/integrations/servicenow/fields/{id}",
21426     "title": "Deletes a Servicenow Field",
21427     "examples": [
21428       {
21429         "title": "Example usage:",
21430         "content": "curl https://{domain}/api/integrations/servicenow/fields/{id} -v -u {name}:{password} -X DELETE",
21431         "type": "json"
21432       }
21433     ],
21434     "name": "DeleteServicenow_Fields",
21435     "group": "Servicenow_Fields",
21436     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21437     "version": "0.0.0",
21438     "filename": "server/api/intServicenowField/index.js",
21439     "groupTitle": "Servicenow_Fields"
21440   },
21441   {
21442     "type": "get",
21443     "url": "/api/integrations/servicenow/fields",
21444     "title": "Gets a list of Servicenow Fields",
21445     "examples": [
21446       {
21447         "title": "Example usage:",
21448         "content": "curl https://{domain}/api/integrations/servicenow/fields -v -u {name}:{password}",
21449         "type": "json"
21450       }
21451     ],
21452     "name": "GetServicenow_Fields",
21453     "group": "Servicenow_Fields",
21454     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
21455     "version": "0.0.0",
21456     "filename": "server/api/intServicenowField/index.js",
21457     "groupTitle": "Servicenow_Fields"
21458   },
21459   {
21460     "type": "get",
21461     "url": "/api/integrations/servicenow/fields/{id}",
21462     "title": "Gets a single Servicenow Field",
21463     "examples": [
21464       {
21465         "title": "Example usage:",
21466         "content": "curl https://{domain}/api/integrations/servicenow/fields/{id} -v -u {name}:{password}",
21467         "type": "json"
21468       }
21469     ],
21470     "name": "ShowServicenow_Fields",
21471     "group": "Servicenow_Fields",
21472     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21473     "version": "0.0.0",
21474     "filename": "server/api/intServicenowField/index.js",
21475     "groupTitle": "Servicenow_Fields"
21476   },
21477   {
21478     "type": "put",
21479     "url": "/api/integrations/servicenow/fields/{id}",
21480     "title": "Update an existing Servicenow Field",
21481     "examples": [
21482       {
21483         "title": "Example usage:",
21484         "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",
21485         "type": "json"
21486       }
21487     ],
21488     "name": "updateServicenow_Fields",
21489     "group": "Servicenow_Fields",
21490     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21491     "version": "0.0.0",
21492     "filename": "server/api/intServicenowField/index.js",
21493     "groupTitle": "Servicenow_Fields"
21494   },
21495   {
21496     "type": "get",
21497     "url": "/api/settings",
21498     "title": "Gets a list of Settings",
21499     "examples": [
21500       {
21501         "title": "Example usage:",
21502         "content": "curl https://{domain}/api/settings -v -u {name}:{password}",
21503         "type": "json"
21504       }
21505     ],
21506     "name": "GetSettings",
21507     "group": "Settings",
21508     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
21509     "version": "0.0.0",
21510     "filename": "server/api/setting/index.js",
21511     "groupTitle": "Settings"
21512   },
21513   {
21514     "type": "get",
21515     "url": "/api/settings/{id}",
21516     "title": "Gets a single Setting",
21517     "examples": [
21518       {
21519         "title": "Example usage:",
21520         "content": "curl https://{domain}/api/settings/{id} -v -u {name}:{password}",
21521         "type": "json"
21522       }
21523     ],
21524     "name": "ShowSettings",
21525     "group": "Settings",
21526     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21527     "version": "0.0.0",
21528     "filename": "server/api/setting/index.js",
21529     "groupTitle": "Settings"
21530   },
21531   {
21532     "type": "post",
21533     "url": "/api/settings/{id}/favicon",
21534     "title": "Add Favicon",
21535     "examples": [
21536       {
21537         "title": "Example usage:",
21538         "content": "curl https://{domain}/api/settings/{id}/favicon -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
21539         "type": "json"
21540       }
21541     ],
21542     "name": "addFavicon",
21543     "group": "Settings",
21544     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21545     "version": "0.0.0",
21546     "filename": "server/api/setting/index.js",
21547     "groupTitle": "Settings"
21548   },
21549   {
21550     "type": "post",
21551     "url": "/api/settings/{id}/logo",
21552     "title": "Add logo",
21553     "examples": [
21554       {
21555         "title": "Example usage:",
21556         "content": "curl https://{domain}/api/settings/{id}/logo -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
21557         "type": "json"
21558       }
21559     ],
21560     "name": "addLogo",
21561     "group": "Settings",
21562     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21563     "version": "0.0.0",
21564     "filename": "server/api/setting/index.js",
21565     "groupTitle": "Settings"
21566   },
21567   {
21568     "type": "post",
21569     "url": "/api/settings/{id}/logo_login",
21570     "title": "Add logo login",
21571     "examples": [
21572       {
21573         "title": "Example usage:",
21574         "content": "curl https://{domain}/api/settings/{id}/logo_login -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
21575         "type": "json"
21576       }
21577     ],
21578     "name": "addLogoLogin",
21579     "group": "Settings",
21580     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21581     "version": "0.0.0",
21582     "filename": "server/api/setting/index.js",
21583     "groupTitle": "Settings"
21584   },
21585   {
21586     "type": "post",
21587     "url": "/api/settings/{id}/preferred",
21588     "title": "Add Preferred",
21589     "examples": [
21590       {
21591         "title": "Example usage:",
21592         "content": "curl https://{domain}/api/settings/{id}/preferred -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
21593         "type": "json"
21594       }
21595     ],
21596     "name": "addPreferred",
21597     "group": "Settings",
21598     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21599     "version": "0.0.0",
21600     "filename": "server/api/setting/index.js",
21601     "groupTitle": "Settings"
21602   },
21603   {
21604     "type": "get",
21605     "url": "/api/settings/{id}/favicon",
21606     "title": "Get Favicon",
21607     "examples": [
21608       {
21609         "title": "Example usage:",
21610         "content": "curl https://{domain}/api/settings/{id}/favicon -v -X GET",
21611         "type": "json"
21612       }
21613     ],
21614     "name": "getFavicon",
21615     "group": "Settings",
21616     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21617     "version": "0.0.0",
21618     "filename": "server/api/setting/index.js",
21619     "groupTitle": "Settings"
21620   },
21621   {
21622     "type": "get",
21623     "url": "/api/settings/{id}/gdpr",
21624     "title": "Get gdpr settings",
21625     "examples": [
21626       {
21627         "title": "Example usage:",
21628         "content": "curl https://{domain}/api/settings/{id}/gdpr -v -u {name}:{password} -X GET",
21629         "type": "json"
21630       }
21631     ],
21632     "name": "getGdpr",
21633     "group": "Settings",
21634     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21635     "version": "0.0.0",
21636     "filename": "server/api/setting/index.js",
21637     "groupTitle": "Settings"
21638   },
21639   {
21640     "type": "get",
21641     "url": "/api/settings/{id}/logo",
21642     "title": "Get logo",
21643     "examples": [
21644       {
21645         "title": "Example usage:",
21646         "content": "curl https://{domain}/api/settings/{id}/logo -v -X GET",
21647         "type": "json"
21648       }
21649     ],
21650     "name": "getLogo",
21651     "group": "Settings",
21652     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21653     "version": "0.0.0",
21654     "filename": "server/api/setting/index.js",
21655     "groupTitle": "Settings"
21656   },
21657   {
21658     "type": "get",
21659     "url": "/api/settings/{id}/logo_login",
21660     "title": "Get logo login",
21661     "examples": [
21662       {
21663         "title": "Example usage:",
21664         "content": "curl https://{domain}/api/settings/{id}/logo_login -v -X GET",
21665         "type": "json"
21666       }
21667     ],
21668     "name": "getLogoLogin",
21669     "group": "Settings",
21670     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21671     "version": "0.0.0",
21672     "filename": "server/api/setting/index.js",
21673     "groupTitle": "Settings"
21674   },
21675   {
21676     "type": "get",
21677     "url": "/api/settings/{id}/preferred",
21678     "title": "Get Preferred",
21679     "examples": [
21680       {
21681         "title": "Example usage:",
21682         "content": "curl https://{domain}/api/settings/{id}/preferred -v -X GET",
21683         "type": "json"
21684       }
21685     ],
21686     "name": "getPreferred",
21687     "group": "Settings",
21688     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21689     "version": "0.0.0",
21690     "filename": "server/api/setting/index.js",
21691     "groupTitle": "Settings"
21692   },
21693   {
21694     "type": "put",
21695     "url": "/api/settings/{id}",
21696     "title": "Update an existing Setting",
21697     "examples": [
21698       {
21699         "title": "Example usage:",
21700         "content": "curl https://{domain}/api/settings/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
21701         "type": "json"
21702       }
21703     ],
21704     "name": "updateSettings",
21705     "group": "Settings",
21706     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21707     "version": "0.0.0",
21708     "filename": "server/api/setting/index.js",
21709     "groupTitle": "Settings"
21710   },
21711   {
21712     "type": "post",
21713     "url": "/api/sms/accounts/{id}/users",
21714     "title": "Add agents to a sms account",
21715     "examples": [
21716       {
21717         "title": "Example usage:",
21718         "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",
21719         "type": "json"
21720       }
21721     ],
21722     "name": "AddAgents",
21723     "group": "Sms_Accounts",
21724     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21725     "version": "0.0.0",
21726     "filename": "server/api/smsAccount/index.js",
21727     "groupTitle": "Sms_Accounts"
21728   },
21729   {
21730     "type": "post",
21731     "url": "/api/sms/accounts",
21732     "title": "Creates a new Account",
21733     "examples": [
21734       {
21735         "title": "Example usage:",
21736         "content": "curl https://{domain}/api/sms/accounts -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
21737         "type": "json"
21738       }
21739     ],
21740     "name": "CreateAccounts",
21741     "group": "Sms_Accounts",
21742     "parameter": {
21743       "fields": {
21744         "Body": [
21745           {
21746             "group": "Body",
21747             "type": "String",
21748             "optional": false,
21749             "field": "name",
21750             "description": ""
21751           },
21752           {
21753             "group": "Body",
21754             "type": "String",
21755             "optional": false,
21756             "field": "key",
21757             "description": ""
21758           },
21759           {
21760             "group": "Body",
21761             "type": "String",
21762             "optional": false,
21763             "field": "remote",
21764             "description": ""
21765           },
21766           {
21767             "group": "Body",
21768             "type": "String",
21769             "optional": true,
21770             "field": "token",
21771             "description": ""
21772           },
21773           {
21774             "group": "Body",
21775             "type": "String",
21776             "optional": true,
21777             "field": "phone",
21778             "description": ""
21779           },
21780           {
21781             "group": "Body",
21782             "type": "String",
21783             "allowedValues": [
21784               "\"twilio\"",
21785               "\"skebby\"",
21786               "\"connectel\"",
21787               "\"clicksend\"",
21788               "\"plivo\"",
21789               "\"clickatell\"",
21790               "\"csc\"",
21791               "\"infobip\"",
21792               "\"intelepeer\""
21793             ],
21794             "optional": true,
21795             "field": "type",
21796             "description": ""
21797           },
21798           {
21799             "group": "Body",
21800             "type": "String",
21801             "optional": true,
21802             "field": "accountSid",
21803             "description": ""
21804           },
21805           {
21806             "group": "Body",
21807             "type": "String",
21808             "optional": true,
21809             "field": "authId",
21810             "description": ""
21811           },
21812           {
21813             "group": "Body",
21814             "type": "String",
21815             "optional": true,
21816             "field": "authToken",
21817             "description": ""
21818           },
21819           {
21820             "group": "Body",
21821             "type": "String",
21822             "allowedValues": [
21823               "\"SI\"",
21824               "\"TI\"",
21825               "\"GP\""
21826             ],
21827             "optional": true,
21828             "field": "smsMethod",
21829             "description": ""
21830           },
21831           {
21832             "group": "Body",
21833             "type": "String",
21834             "optional": true,
21835             "field": "username",
21836             "description": ""
21837           },
21838           {
21839             "group": "Body",
21840             "type": "String",
21841             "optional": true,
21842             "field": "password",
21843             "description": ""
21844           },
21845           {
21846             "group": "Body",
21847             "type": "String",
21848             "optional": true,
21849             "field": "apiKey",
21850             "description": ""
21851           },
21852           {
21853             "group": "Body",
21854             "type": "String",
21855             "optional": true,
21856             "field": "senderString",
21857             "description": ""
21858           },
21859           {
21860             "group": "Body",
21861             "type": "Boolean",
21862             "optional": true,
21863             "field": "deliveryReport",
21864             "description": ""
21865           },
21866           {
21867             "group": "Body",
21868             "type": "String",
21869             "optional": true,
21870             "field": "description",
21871             "description": ""
21872           },
21873           {
21874             "group": "Body",
21875             "type": "Text",
21876             "optional": true,
21877             "field": "notificationTemplate",
21878             "description": ""
21879           },
21880           {
21881             "group": "Body",
21882             "type": "Boolean",
21883             "optional": true,
21884             "field": "notificationSound",
21885             "description": ""
21886           },
21887           {
21888             "group": "Body",
21889             "type": "Boolean",
21890             "optional": true,
21891             "field": "notificationShake",
21892             "description": ""
21893           },
21894           {
21895             "group": "Body",
21896             "type": "Integer",
21897             "optional": true,
21898             "field": "waitForTheAssignedAgent",
21899             "description": ""
21900           },
21901           {
21902             "group": "Body",
21903             "type": "Boolean",
21904             "optional": true,
21905             "field": "queueTransfer",
21906             "description": ""
21907           },
21908           {
21909             "group": "Body",
21910             "type": "Integer",
21911             "optional": true,
21912             "field": "queueTransferTimeout",
21913             "description": ""
21914           },
21915           {
21916             "group": "Body",
21917             "type": "Boolean",
21918             "optional": true,
21919             "field": "agentTransfer",
21920             "description": ""
21921           },
21922           {
21923             "group": "Body",
21924             "type": "Integer",
21925             "optional": true,
21926             "field": "agentTransferTimeout",
21927             "description": ""
21928           },
21929           {
21930             "group": "Body",
21931             "type": "String",
21932             "optional": true,
21933             "field": "baseUrl",
21934             "description": ""
21935           },
21936           {
21937             "group": "Body",
21938             "type": "Integer",
21939             "optional": true,
21940             "field": "mandatoryDispositionPauseId",
21941             "description": "<p>Status to put when mandatory disposition is enabled</p>"
21942           },
21943           {
21944             "group": "Body",
21945             "type": "Boolean",
21946             "optional": true,
21947             "field": "mandatoryDisposition",
21948             "description": "<p>Enabled/disables mandatory dispo on a queue</p>"
21949           }
21950         ]
21951       }
21952     },
21953     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21954     "version": "0.0.0",
21955     "filename": "server/api/smsAccount/index.js",
21956     "groupTitle": "Sms_Accounts"
21957   },
21958   {
21959     "type": "delete",
21960     "url": "/api/sms/accounts/{id}",
21961     "title": "Deletes a Account",
21962     "examples": [
21963       {
21964         "title": "Example usage:",
21965         "content": "curl https://{domain}/api/sms/accounts/{id} -v -u {name}:{password} -X DELETE",
21966         "type": "json"
21967       }
21968     ],
21969     "name": "DeleteAccounts",
21970     "group": "Sms_Accounts",
21971     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21972     "version": "0.0.0",
21973     "filename": "server/api/smsAccount/index.js",
21974     "groupTitle": "Sms_Accounts"
21975   },
21976   {
21977     "type": "get",
21978     "url": "/api/sms/accounts/describe",
21979     "title": "Gets table info about Accounts",
21980     "examples": [
21981       {
21982         "title": "Example usage:",
21983         "content": "curl https://{domain}/api/sms/accounts/describe -v -u {name}:{password}",
21984         "type": "json"
21985       }
21986     ],
21987     "name": "DescribeAccounts",
21988     "group": "Sms_Accounts",
21989     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21990     "version": "0.0.0",
21991     "filename": "server/api/smsAccount/index.js",
21992     "groupTitle": "Sms_Accounts"
21993   },
21994   {
21995     "type": "get",
21996     "url": "/api/sms/accounts",
21997     "title": "Gets a list of Accounts",
21998     "examples": [
21999       {
22000         "title": "Example usage:",
22001         "content": "curl https://{domain}/api/sms/accounts -v -u {name}:{password}",
22002         "type": "json"
22003       }
22004     ],
22005     "name": "GetAccounts",
22006     "group": "Sms_Accounts",
22007     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
22008     "version": "0.0.0",
22009     "filename": "server/api/smsAccount/index.js",
22010     "groupTitle": "Sms_Accounts"
22011   },
22012   {
22013     "type": "get",
22014     "url": "/api/sms/accounts/{id}/users",
22015     "title": "Gets agents from sms account",
22016     "examples": [
22017       {
22018         "title": "Example usage:",
22019         "content": "curl https://{domain}/api/sms/accounts/{id}/users -v -u {name}:{password} -X GET",
22020         "type": "json"
22021       }
22022     ],
22023     "name": "GetAgents",
22024     "group": "Sms_Accounts",
22025     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22026     "version": "0.0.0",
22027     "filename": "server/api/smsAccount/index.js",
22028     "groupTitle": "Sms_Accounts"
22029   },
22030   {
22031     "type": "delete",
22032     "url": "/api/sms/accounts/{id}/users",
22033     "title": "Removes agents from a sms account",
22034     "examples": [
22035       {
22036         "title": "Example usage:",
22037         "content": "curl https://{domain}/api/sms/accounts/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
22038         "type": "json"
22039       }
22040     ],
22041     "name": "RemoveAgents",
22042     "group": "Sms_Accounts",
22043     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22044     "version": "0.0.0",
22045     "filename": "server/api/smsAccount/index.js",
22046     "groupTitle": "Sms_Accounts"
22047   },
22048   {
22049     "type": "delete",
22050     "url": "/api/sms/accounts/{id}/canned_answers",
22051     "title": "Removes canned answers from account",
22052     "examples": [
22053       {
22054         "title": "Example usage:",
22055         "content": "curl https://{domain}/api/sms/accounts/{id}/canned_answers?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
22056         "type": "json"
22057       }
22058     ],
22059     "name": "RemoveAnswers",
22060     "group": "Sms_Accounts",
22061     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22062     "version": "0.0.0",
22063     "filename": "server/api/smsAccount/index.js",
22064     "groupTitle": "Sms_Accounts"
22065   },
22066   {
22067     "type": "delete",
22068     "url": "/api/sms/accounts/{id}/dispositions",
22069     "title": "Removes dispositions from account",
22070     "examples": [
22071       {
22072         "title": "Example usage:",
22073         "content": "curl https://{domain}/api/sms/accounts/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
22074         "type": "json"
22075       }
22076     ],
22077     "name": "RemoveDispositions",
22078     "group": "Sms_Accounts",
22079     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22080     "version": "0.0.0",
22081     "filename": "server/api/smsAccount/index.js",
22082     "groupTitle": "Sms_Accounts"
22083   },
22084   {
22085     "type": "get",
22086     "url": "/api/sms/accounts/{id}",
22087     "title": "Gets a single Account",
22088     "examples": [
22089       {
22090         "title": "Example usage:",
22091         "content": "curl https://{domain}/api/sms/accounts/{id} -v -u {name}:{password}",
22092         "type": "json"
22093       }
22094     ],
22095     "name": "ShowAccounts",
22096     "group": "Sms_Accounts",
22097     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22098     "version": "0.0.0",
22099     "filename": "server/api/smsAccount/index.js",
22100     "groupTitle": "Sms_Accounts"
22101   },
22102   {
22103     "type": "put",
22104     "url": "/api/sms/messages/{id}/accept",
22105     "title": "Accepts message",
22106     "examples": [
22107       {
22108         "title": "Example usage:",
22109         "content": "curl https://{domain}/api/sms/messages/{id}/accept \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
22110         "type": "json"
22111       }
22112     ],
22113     "name": "acceptMessage",
22114     "group": "Sms_Accounts",
22115     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <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/smsMessage/index.js",
22118     "groupTitle": "Sms_Accounts"
22119   },
22120   {
22121     "type": "post",
22122     "url": "/api/sms/accounts/{id}/canned_answers",
22123     "title": "Creates new canned answer",
22124     "examples": [
22125       {
22126         "title": "Example usage:",
22127         "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",
22128         "type": "json"
22129       }
22130     ],
22131     "name": "addAnswer",
22132     "group": "Sms_Accounts",
22133     "parameter": {
22134       "fields": {
22135         "Body": [
22136           {
22137             "group": "Body",
22138             "type": "String",
22139             "optional": false,
22140             "field": "key",
22141             "description": ""
22142           },
22143           {
22144             "group": "Body",
22145             "type": "Text",
22146             "optional": false,
22147             "field": "value",
22148             "description": ""
22149           },
22150           {
22151             "group": "Body",
22152             "type": "String",
22153             "optional": true,
22154             "field": "description",
22155             "description": ""
22156           },
22157           {
22158             "group": "Body",
22159             "type": "Virtual",
22160             "optional": true,
22161             "field": "name",
22162             "description": ""
22163           }
22164         ]
22165       }
22166     },
22167     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22168     "version": "0.0.0",
22169     "filename": "server/api/smsAccount/index.js",
22170     "groupTitle": "Sms_Accounts"
22171   },
22172   {
22173     "type": "post",
22174     "url": "/api/sms/accounts/{id}/applications",
22175     "title": "Creates new applications",
22176     "examples": [
22177       {
22178         "title": "Example usage:",
22179         "content": "curl https://{domain}/api/sms/accounts/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
22180         "type": "json"
22181       }
22182     ],
22183     "name": "addApplications",
22184     "group": "Sms_Accounts",
22185     "parameter": {
22186       "fields": {
22187         "Body": [
22188           {
22189             "group": "Body",
22190             "type": "Integer",
22191             "optional": false,
22192             "field": "priority",
22193             "description": ""
22194           },
22195           {
22196             "group": "Body",
22197             "type": "String",
22198             "optional": false,
22199             "field": "app",
22200             "description": ""
22201           },
22202           {
22203             "group": "Body",
22204             "type": "Text",
22205             "optional": true,
22206             "field": "appdata",
22207             "description": ""
22208           },
22209           {
22210             "group": "Body",
22211             "type": "String",
22212             "optional": true,
22213             "field": "description",
22214             "description": ""
22215           },
22216           {
22217             "group": "Body",
22218             "type": "String",
22219             "optional": true,
22220             "field": "interval",
22221             "description": ""
22222           }
22223         ]
22224       }
22225     },
22226     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22227     "version": "0.0.0",
22228     "filename": "server/api/smsAccount/index.js",
22229     "groupTitle": "Sms_Accounts"
22230   },
22231   {
22232     "type": "post",
22233     "url": "/api/sms/accounts/{id}/dispositions",
22234     "title": "Creates new disposition",
22235     "examples": [
22236       {
22237         "title": "Example usage:",
22238         "content": "curl https://{domain}/api/sms/accounts/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
22239         "type": "json"
22240       }
22241     ],
22242     "name": "addDisposition",
22243     "group": "Sms_Accounts",
22244     "parameter": {
22245       "fields": {
22246         "Body": [
22247           {
22248             "group": "Body",
22249             "type": "String",
22250             "optional": false,
22251             "field": "name",
22252             "description": ""
22253           }
22254         ]
22255       }
22256     },
22257     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22258     "version": "0.0.0",
22259     "filename": "server/api/smsAccount/index.js",
22260     "groupTitle": "Sms_Accounts"
22261   },
22262   {
22263     "type": "get",
22264     "url": "/api/sms/accounts/{id}/canned_answers",
22265     "title": "Gets account canned answers",
22266     "examples": [
22267       {
22268         "title": "Example usage:",
22269         "content": "curl https://{domain}/api/sms/accounts/{id}/canned_answers -v -u {name}:{password} -X GET",
22270         "type": "json"
22271       }
22272     ],
22273     "name": "getAnswers",
22274     "group": "Sms_Accounts",
22275     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22276     "version": "0.0.0",
22277     "filename": "server/api/smsAccount/index.js",
22278     "groupTitle": "Sms_Accounts"
22279   },
22280   {
22281     "type": "get",
22282     "url": "/api/sms/accounts/{id}/applications",
22283     "title": "Gets account applications",
22284     "examples": [
22285       {
22286         "title": "Example usage:",
22287         "content": "curl https://{domain}/api/sms/accounts/{id}/applications -v -u {name}:{password} -X GET",
22288         "type": "json"
22289       }
22290     ],
22291     "name": "getApplications",
22292     "group": "Sms_Accounts",
22293     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22294     "version": "0.0.0",
22295     "filename": "server/api/smsAccount/index.js",
22296     "groupTitle": "Sms_Accounts"
22297   },
22298   {
22299     "type": "get",
22300     "url": "/api/sms/accounts/{id}/dispositions",
22301     "title": "Gets account dispositions",
22302     "examples": [
22303       {
22304         "title": "Example usage:",
22305         "content": "curl https://{domain}/api/sms/accounts/{id}/dispositions -v -u {name}:{password} -X GET",
22306         "type": "json"
22307       }
22308     ],
22309     "name": "getDispositions",
22310     "group": "Sms_Accounts",
22311     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22312     "version": "0.0.0",
22313     "filename": "server/api/smsAccount/index.js",
22314     "groupTitle": "Sms_Accounts"
22315   },
22316   {
22317     "type": "get",
22318     "url": "/api/sms/accounts/{id}/interactions",
22319     "title": "Gets Sms Account interactions",
22320     "examples": [
22321       {
22322         "title": "Example usage:",
22323         "content": "curl https://{domain}/api/sms/accounts/{id}/interactions -v -u {name}:{password} -X GET",
22324         "type": "json"
22325       }
22326     ],
22327     "name": "getInteractions",
22328     "group": "Sms_Accounts",
22329     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22330     "version": "0.0.0",
22331     "filename": "server/api/smsAccount/index.js",
22332     "groupTitle": "Sms_Accounts"
22333   },
22334   {
22335     "type": "post",
22336     "url": "/api/sms/accounts/{id}/notify",
22337     "title": "Notify new message",
22338     "examples": [
22339       {
22340         "title": "Example usage:",
22341         "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",
22342         "type": "json"
22343       }
22344     ],
22345     "name": "notify",
22346     "group": "Sms_Accounts",
22347     "description": "<p>Motion 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>",
22348     "version": "0.0.0",
22349     "filename": "server/api/smsAccount/index.js",
22350     "groupTitle": "Sms_Accounts"
22351   },
22352   {
22353     "type": "put",
22354     "url": "/api/sms/messages/{id}/reject",
22355     "title": "Rejects message",
22356     "examples": [
22357       {
22358         "title": "Example usage:",
22359         "content": "curl https://{domain}/api/sms/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
22360         "type": "json"
22361       }
22362     ],
22363     "name": "rejectMessage",
22364     "group": "Sms_Accounts",
22365     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22366     "version": "0.0.0",
22367     "filename": "server/api/smsMessage/index.js",
22368     "groupTitle": "Sms_Accounts"
22369   },
22370   {
22371     "type": "post",
22372     "url": "/api/sms/accounts/{id}/send",
22373     "title": "Send new sms message",
22374     "examples": [
22375       {
22376         "title": "Example usage:",
22377         "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",
22378         "type": "json"
22379       }
22380     ],
22381     "name": "sendSms",
22382     "group": "Sms_Accounts",
22383     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22384     "version": "0.0.0",
22385     "filename": "server/api/smsAccount/index.js",
22386     "groupTitle": "Sms_Accounts"
22387   },
22388   {
22389     "type": "post",
22390     "url": "/api/sms/messages/{id}/status",
22391     "title": "Receive message status",
22392     "examples": [
22393       {
22394         "title": "Example usage:",
22395         "content": "curl https://{domain}/api/sms/messages/{id}/status \\ \n -H 'Content-Type: application/json' -v -X POST",
22396         "type": "json"
22397       }
22398     ],
22399     "name": "statusMessage",
22400     "group": "Sms_Accounts",
22401     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22402     "version": "0.0.0",
22403     "filename": "server/api/smsMessage/index.js",
22404     "groupTitle": "Sms_Accounts"
22405   },
22406   {
22407     "type": "get",
22408     "url": "/api/sms/accounts/{id}/status",
22409     "title": "Receive message status as get request",
22410     "examples": [
22411       {
22412         "title": "Example usage:",
22413         "content": "curl https://{domain}/api/sms/accounts/{id}/status -H 'Content-Type: application/json' -v -X GET",
22414         "type": "json"
22415       }
22416     ],
22417     "name": "statusMessage",
22418     "group": "Sms_Accounts",
22419     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22420     "version": "0.0.0",
22421     "filename": "server/api/smsAccount/index.js",
22422     "groupTitle": "Sms_Accounts"
22423   },
22424   {
22425     "type": "post",
22426     "url": "/api/sms/accounts/{id}/status",
22427     "title": "Receive message status",
22428     "examples": [
22429       {
22430         "title": "Example usage:",
22431         "content": "curl https://{domain}/api/sms/accounts/{id}/status -H 'Content-Type: application/json' -v -X POST",
22432         "type": "json"
22433       }
22434     ],
22435     "name": "statusMessage",
22436     "group": "Sms_Accounts",
22437     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22438     "version": "0.0.0",
22439     "filename": "server/api/smsAccount/index.js",
22440     "groupTitle": "Sms_Accounts"
22441   },
22442   {
22443     "type": "put",
22444     "url": "/api/sms/accounts/{id}",
22445     "title": "Update an existing Account",
22446     "examples": [
22447       {
22448         "title": "Example usage:",
22449         "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",
22450         "type": "json"
22451       }
22452     ],
22453     "name": "updateAccounts",
22454     "group": "Sms_Accounts",
22455     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22456     "version": "0.0.0",
22457     "filename": "server/api/smsAccount/index.js",
22458     "groupTitle": "Sms_Accounts"
22459   },
22460   {
22461     "type": "post",
22462     "url": "/api/sms/applications",
22463     "title": "Creates a new Application",
22464     "examples": [
22465       {
22466         "title": "Example usage:",
22467         "content": "curl https://{domain}/api/sms/applications -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
22468         "type": "json"
22469       }
22470     ],
22471     "name": "CreateApplications",
22472     "group": "Sms_Applications",
22473     "parameter": {
22474       "fields": {
22475         "Body": [
22476           {
22477             "group": "Body",
22478             "type": "Integer",
22479             "optional": false,
22480             "field": "priority",
22481             "description": ""
22482           },
22483           {
22484             "group": "Body",
22485             "type": "String",
22486             "optional": false,
22487             "field": "app",
22488             "description": ""
22489           },
22490           {
22491             "group": "Body",
22492             "type": "Text",
22493             "optional": true,
22494             "field": "appdata",
22495             "description": ""
22496           },
22497           {
22498             "group": "Body",
22499             "type": "String",
22500             "optional": true,
22501             "field": "description",
22502             "description": ""
22503           },
22504           {
22505             "group": "Body",
22506             "type": "String",
22507             "optional": true,
22508             "field": "interval",
22509             "description": ""
22510           }
22511         ]
22512       }
22513     },
22514     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22515     "version": "0.0.0",
22516     "filename": "server/api/smsApplication/index.js",
22517     "groupTitle": "Sms_Applications"
22518   },
22519   {
22520     "type": "delete",
22521     "url": "/api/sms/applications/{id}",
22522     "title": "Deletes a Application",
22523     "examples": [
22524       {
22525         "title": "Example usage:",
22526         "content": "curl https://{domain}/api/sms/applications/{id} -v -u {name}:{password} -X DELETE",
22527         "type": "json"
22528       }
22529     ],
22530     "name": "DeleteApplications",
22531     "group": "Sms_Applications",
22532     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22533     "version": "0.0.0",
22534     "filename": "server/api/smsApplication/index.js",
22535     "groupTitle": "Sms_Applications"
22536   },
22537   {
22538     "type": "get",
22539     "url": "/api/sms/applications",
22540     "title": "Gets a list of Applications",
22541     "examples": [
22542       {
22543         "title": "Example usage:",
22544         "content": "curl https://{domain}/api/sms/applications -v -u {name}:{password}",
22545         "type": "json"
22546       }
22547     ],
22548     "name": "GetApplications",
22549     "group": "Sms_Applications",
22550     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
22551     "version": "0.0.0",
22552     "filename": "server/api/smsApplication/index.js",
22553     "groupTitle": "Sms_Applications"
22554   },
22555   {
22556     "type": "get",
22557     "url": "/api/sms/applications/{id}",
22558     "title": "Gets a single Application",
22559     "examples": [
22560       {
22561         "title": "Example usage:",
22562         "content": "curl https://{domain}/api/sms/applications/{id} -v -u {name}:{password}",
22563         "type": "json"
22564       }
22565     ],
22566     "name": "ShowApplications",
22567     "group": "Sms_Applications",
22568     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22569     "version": "0.0.0",
22570     "filename": "server/api/smsApplication/index.js",
22571     "groupTitle": "Sms_Applications"
22572   },
22573   {
22574     "type": "put",
22575     "url": "/api/sms/applications/{id}",
22576     "title": "Update an existing Application",
22577     "examples": [
22578       {
22579         "title": "Example usage:",
22580         "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",
22581         "type": "json"
22582       }
22583     ],
22584     "name": "updateApplications",
22585     "group": "Sms_Applications",
22586     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22587     "version": "0.0.0",
22588     "filename": "server/api/smsApplication/index.js",
22589     "groupTitle": "Sms_Applications"
22590   },
22591   {
22592     "type": "post",
22593     "url": "/api/sms/interactions/{id}/tags",
22594     "title": "Add tags to the interaction",
22595     "examples": [
22596       {
22597         "title": "Example usage:",
22598         "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",
22599         "type": "json"
22600       }
22601     ],
22602     "name": "AddTags",
22603     "group": "Sms_Interactions",
22604     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22605     "version": "0.0.0",
22606     "filename": "server/api/smsInteraction/index.js",
22607     "groupTitle": "Sms_Interactions"
22608   },
22609   {
22610     "type": "post",
22611     "url": "/api/sms/interactions",
22612     "title": "Creates a new Interaction",
22613     "examples": [
22614       {
22615         "title": "Example usage:",
22616         "content": "curl https://{domain}/api/sms/interactions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
22617         "type": "json"
22618       }
22619     ],
22620     "name": "CreateInteractions",
22621     "group": "Sms_Interactions",
22622     "parameter": {
22623       "fields": {
22624         "Body": [
22625           {
22626             "group": "Body",
22627             "type": "Boolean",
22628             "optional": true,
22629             "field": "closed",
22630             "description": ""
22631           },
22632           {
22633             "group": "Body",
22634             "type": "String",
22635             "optional": true,
22636             "field": "closedAt",
22637             "description": ""
22638           },
22639           {
22640             "group": "Body",
22641             "type": "String",
22642             "optional": true,
22643             "field": "disposition",
22644             "description": ""
22645           },
22646           {
22647             "group": "Body",
22648             "type": "String",
22649             "optional": true,
22650             "field": "note",
22651             "description": ""
22652           },
22653           {
22654             "group": "Body",
22655             "type": "String",
22656             "optional": true,
22657             "field": "phone",
22658             "description": ""
22659           },
22660           {
22661             "group": "Body",
22662             "type": "String",
22663             "optional": true,
22664             "field": "read1stAt",
22665             "description": ""
22666           },
22667           {
22668             "group": "Body",
22669             "type": "String",
22670             "allowedValues": [
22671               "\"in\"",
22672               "\"out\""
22673             ],
22674             "optional": false,
22675             "field": "firstMsgDirection",
22676             "description": ""
22677           },
22678           {
22679             "group": "Body",
22680             "type": "String",
22681             "optional": true,
22682             "field": "lastMsgAt",
22683             "description": ""
22684           },
22685           {
22686             "group": "Body",
22687             "type": "String",
22688             "allowedValues": [
22689               "\"in\"",
22690               "\"out\""
22691             ],
22692             "optional": false,
22693             "field": "lastMsgDirection",
22694             "description": ""
22695           }
22696         ]
22697       }
22698     },
22699     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22700     "version": "0.0.0",
22701     "filename": "server/api/smsInteraction/index.js",
22702     "groupTitle": "Sms_Interactions"
22703   },
22704   {
22705     "type": "delete",
22706     "url": "/api/sms/interactions/{id}",
22707     "title": "Deletes a Interaction",
22708     "examples": [
22709       {
22710         "title": "Example usage:",
22711         "content": "curl https://{domain}/api/sms/interactions/{id} -v -u {name}:{password} -X DELETE",
22712         "type": "json"
22713       }
22714     ],
22715     "name": "DeleteInteractions",
22716     "group": "Sms_Interactions",
22717     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22718     "version": "0.0.0",
22719     "filename": "server/api/smsInteraction/index.js",
22720     "groupTitle": "Sms_Interactions"
22721   },
22722   {
22723     "type": "get",
22724     "url": "/api/sms/interactions/describe",
22725     "title": "Gets table info about Interactions",
22726     "examples": [
22727       {
22728         "title": "Example usage:",
22729         "content": "curl https://{domain}/api/sms/interactions/describe -v -u {name}:{password}",
22730         "type": "json"
22731       }
22732     ],
22733     "name": "DescribeInteractions",
22734     "group": "Sms_Interactions",
22735     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22736     "version": "0.0.0",
22737     "filename": "server/api/smsInteraction/index.js",
22738     "groupTitle": "Sms_Interactions"
22739   },
22740   {
22741     "type": "get",
22742     "url": "/api/sms/interactions",
22743     "title": "Gets a list of Interactions",
22744     "examples": [
22745       {
22746         "title": "Example usage:",
22747         "content": "curl https://{domain}/api/sms/interactions -v -u {name}:{password}",
22748         "type": "json"
22749       }
22750     ],
22751     "name": "GetInteractions",
22752     "group": "Sms_Interactions",
22753     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
22754     "version": "0.0.0",
22755     "filename": "server/api/smsInteraction/index.js",
22756     "groupTitle": "Sms_Interactions"
22757   },
22758   {
22759     "type": "delete",
22760     "url": "/api/sms/interactions/{id}/tags",
22761     "title": "Removes tags from interaction",
22762     "examples": [
22763       {
22764         "title": "Example usage:",
22765         "content": "curl https://{domain}/api/sms/interactions/{id}/tags?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
22766         "type": "json"
22767       }
22768     ],
22769     "name": "RemoveTags",
22770     "group": "Sms_Interactions",
22771     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22772     "version": "0.0.0",
22773     "filename": "server/api/smsInteraction/index.js",
22774     "groupTitle": "Sms_Interactions"
22775   },
22776   {
22777     "type": "get",
22778     "url": "/api/sms/interactions/{id}",
22779     "title": "Gets a single Interaction",
22780     "examples": [
22781       {
22782         "title": "Example usage:",
22783         "content": "curl https://{domain}/api/sms/interactions/{id} -v -u {name}:{password}",
22784         "type": "json"
22785       }
22786     ],
22787     "name": "ShowInteractions",
22788     "group": "Sms_Interactions",
22789     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22790     "version": "0.0.0",
22791     "filename": "server/api/smsInteraction/index.js",
22792     "groupTitle": "Sms_Interactions"
22793   },
22794   {
22795     "type": "post",
22796     "url": "/api/sms/interactions/{id}/messages",
22797     "title": "Creates new messages",
22798     "examples": [
22799       {
22800         "title": "Example usage:",
22801         "content": "curl https://{domain}/api/sms/interactions/{id}/messages -d '[{\"to\": \"+3901119886500\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
22802         "type": "json"
22803       }
22804     ],
22805     "name": "addMessage",
22806     "group": "Sms_Interactions",
22807     "parameter": {
22808       "fields": {
22809         "Body": [
22810           {
22811             "group": "Body",
22812             "type": "Text",
22813             "optional": false,
22814             "field": "body",
22815             "description": ""
22816           },
22817           {
22818             "group": "Body",
22819             "type": "Boolean",
22820             "optional": true,
22821             "field": "read",
22822             "description": ""
22823           },
22824           {
22825             "group": "Body",
22826             "type": "String",
22827             "allowedValues": [
22828               "\"in\"",
22829               "\"out\""
22830             ],
22831             "optional": false,
22832             "field": "direction",
22833             "description": ""
22834           },
22835           {
22836             "group": "Body",
22837             "type": "String",
22838             "optional": true,
22839             "field": "messageId",
22840             "description": ""
22841           },
22842           {
22843             "group": "Body",
22844             "type": "String",
22845             "optional": true,
22846             "field": "phone",
22847             "description": ""
22848           },
22849           {
22850             "group": "Body",
22851             "type": "String",
22852             "optional": true,
22853             "field": "readAt",
22854             "description": ""
22855           },
22856           {
22857             "group": "Body",
22858             "type": "Boolean",
22859             "optional": true,
22860             "field": "secret",
22861             "description": ""
22862           }
22863         ]
22864       }
22865     },
22866     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22867     "version": "0.0.0",
22868     "filename": "server/api/smsInteraction/index.js",
22869     "groupTitle": "Sms_Interactions"
22870   },
22871   {
22872     "type": "get",
22873     "url": "/api/sms/interactions/{id}/download",
22874     "title": "Gets interaction",
22875     "examples": [
22876       {
22877         "title": "Example usage:",
22878         "content": "curl https://{domain}/api/sms/interactions/{id}/download -v -u {name}:{password} -X GET",
22879         "type": "json"
22880       }
22881     ],
22882     "name": "download",
22883     "group": "Sms_Interactions",
22884     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22885     "version": "0.0.0",
22886     "filename": "server/api/smsInteraction/index.js",
22887     "groupTitle": "Sms_Interactions"
22888   },
22889   {
22890     "type": "get",
22891     "url": "/api/sms/interactions/{id}/messages",
22892     "title": "Gets interaction messages",
22893     "examples": [
22894       {
22895         "title": "Example usage:",
22896         "content": "curl https://{domain}/api/sms/interactions/{id}/messages -v -u {name}:{password} -X GET",
22897         "type": "json"
22898       }
22899     ],
22900     "name": "getMessages",
22901     "group": "Sms_Interactions",
22902     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22903     "version": "0.0.0",
22904     "filename": "server/api/smsInteraction/index.js",
22905     "groupTitle": "Sms_Interactions"
22906   },
22907   {
22908     "type": "put",
22909     "url": "/api/sms/interactions/{id}",
22910     "title": "Update an existing Interaction",
22911     "examples": [
22912       {
22913         "title": "Example usage:",
22914         "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",
22915         "type": "json"
22916       }
22917     ],
22918     "name": "updateInteractions",
22919     "group": "Sms_Interactions",
22920     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22921     "version": "0.0.0",
22922     "filename": "server/api/smsInteraction/index.js",
22923     "groupTitle": "Sms_Interactions"
22924   },
22925   {
22926     "type": "post",
22927     "url": "/api/sms/messages",
22928     "title": "Creates a new Message",
22929     "examples": [
22930       {
22931         "title": "Example usage:",
22932         "content": "curl https://{domain}/api/sms/messages -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
22933         "type": "json"
22934       }
22935     ],
22936     "name": "CreateMessages",
22937     "group": "Sms_Messages",
22938     "parameter": {
22939       "fields": {
22940         "Body": [
22941           {
22942             "group": "Body",
22943             "type": "Text",
22944             "optional": false,
22945             "field": "body",
22946             "description": ""
22947           },
22948           {
22949             "group": "Body",
22950             "type": "Boolean",
22951             "optional": true,
22952             "field": "read",
22953             "description": ""
22954           },
22955           {
22956             "group": "Body",
22957             "type": "String",
22958             "allowedValues": [
22959               "\"in\"",
22960               "\"out\""
22961             ],
22962             "optional": false,
22963             "field": "direction",
22964             "description": ""
22965           },
22966           {
22967             "group": "Body",
22968             "type": "String",
22969             "optional": true,
22970             "field": "messageId",
22971             "description": ""
22972           },
22973           {
22974             "group": "Body",
22975             "type": "String",
22976             "optional": true,
22977             "field": "phone",
22978             "description": ""
22979           },
22980           {
22981             "group": "Body",
22982             "type": "String",
22983             "optional": true,
22984             "field": "readAt",
22985             "description": ""
22986           },
22987           {
22988             "group": "Body",
22989             "type": "Boolean",
22990             "optional": true,
22991             "field": "secret",
22992             "description": ""
22993           }
22994         ]
22995       }
22996     },
22997     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22998     "version": "0.0.0",
22999     "filename": "server/api/smsMessage/index.js",
23000     "groupTitle": "Sms_Messages"
23001   },
23002   {
23003     "type": "delete",
23004     "url": "/api/sms/messages/{id}",
23005     "title": "Deletes a Message",
23006     "examples": [
23007       {
23008         "title": "Example usage:",
23009         "content": "curl https://{domain}/api/sms/messages/{id} -v -u {name}:{password} -X DELETE",
23010         "type": "json"
23011       }
23012     ],
23013     "name": "DeleteMessages",
23014     "group": "Sms_Messages",
23015     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23016     "version": "0.0.0",
23017     "filename": "server/api/smsMessage/index.js",
23018     "groupTitle": "Sms_Messages"
23019   },
23020   {
23021     "type": "get",
23022     "url": "/api/sms/messages/describe",
23023     "title": "Gets table info about Messages",
23024     "examples": [
23025       {
23026         "title": "Example usage:",
23027         "content": "curl https://{domain}/api/sms/messages/describe -v -u {name}:{password}",
23028         "type": "json"
23029       }
23030     ],
23031     "name": "DescribeMessages",
23032     "group": "Sms_Messages",
23033     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23034     "version": "0.0.0",
23035     "filename": "server/api/smsMessage/index.js",
23036     "groupTitle": "Sms_Messages"
23037   },
23038   {
23039     "type": "get",
23040     "url": "/api/sms/messages",
23041     "title": "Gets a list of Messages",
23042     "examples": [
23043       {
23044         "title": "Example usage:",
23045         "content": "curl https://{domain}/api/sms/messages -v -u {name}:{password}",
23046         "type": "json"
23047       }
23048     ],
23049     "name": "GetMessages",
23050     "group": "Sms_Messages",
23051     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
23052     "version": "0.0.0",
23053     "filename": "server/api/smsMessage/index.js",
23054     "groupTitle": "Sms_Messages"
23055   },
23056   {
23057     "type": "get",
23058     "url": "/api/sms/messages/{id}",
23059     "title": "Gets a single Message",
23060     "examples": [
23061       {
23062         "title": "Example usage:",
23063         "content": "curl https://{domain}/api/sms/messages/{id} -v -u {name}:{password}",
23064         "type": "json"
23065       }
23066     ],
23067     "name": "ShowMessages",
23068     "group": "Sms_Messages",
23069     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23070     "version": "0.0.0",
23071     "filename": "server/api/smsMessage/index.js",
23072     "groupTitle": "Sms_Messages"
23073   },
23074   {
23075     "type": "put",
23076     "url": "/api/sms/messages/{id}",
23077     "title": "Update an existing Message",
23078     "examples": [
23079       {
23080         "title": "Example usage:",
23081         "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",
23082         "type": "json"
23083       }
23084     ],
23085     "name": "updateMessages",
23086     "group": "Sms_Messages",
23087     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23088     "version": "0.0.0",
23089     "filename": "server/api/smsMessage/index.js",
23090     "groupTitle": "Sms_Messages"
23091   },
23092   {
23093     "type": "post",
23094     "url": "/api/sms/reports/queue",
23095     "title": "Creates a new Sms Queue Report",
23096     "examples": [
23097       {
23098         "title": "Example usage:",
23099         "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",
23100         "type": "json"
23101       }
23102     ],
23103     "name": "CreateSms_Queue_Reports",
23104     "group": "Sms_Queue_Reports",
23105     "parameter": {
23106       "fields": {
23107         "Body": [
23108           {
23109             "group": "Body",
23110             "type": "String",
23111             "optional": false,
23112             "field": "uniqueid",
23113             "description": ""
23114           },
23115           {
23116             "group": "Body",
23117             "type": "String",
23118             "optional": true,
23119             "field": "from",
23120             "description": ""
23121           },
23122           {
23123             "group": "Body",
23124             "type": "String",
23125             "optional": true,
23126             "field": "joinAt",
23127             "description": ""
23128           },
23129           {
23130             "group": "Body",
23131             "type": "String",
23132             "optional": true,
23133             "field": "leaveAt",
23134             "description": ""
23135           },
23136           {
23137             "group": "Body",
23138             "type": "String",
23139             "optional": true,
23140             "field": "acceptAt",
23141             "description": ""
23142           },
23143           {
23144             "group": "Body",
23145             "type": "String",
23146             "optional": true,
23147             "field": "exitAt",
23148             "description": ""
23149           },
23150           {
23151             "group": "Body",
23152             "type": "String",
23153             "optional": true,
23154             "field": "reason",
23155             "description": ""
23156           }
23157         ]
23158       }
23159     },
23160     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23161     "version": "0.0.0",
23162     "filename": "server/api/smsQueueReport/index.js",
23163     "groupTitle": "Sms_Queue_Reports"
23164   },
23165   {
23166     "type": "delete",
23167     "url": "/api/sms/reports/queue/{id}",
23168     "title": "Deletes a Sms Queue Report",
23169     "examples": [
23170       {
23171         "title": "Example usage:",
23172         "content": "curl https://{domain}/api/sms/reports/queue/{id} -v -u {name}:{password} -X DELETE",
23173         "type": "json"
23174       }
23175     ],
23176     "name": "DeleteSms_Queue_Reports",
23177     "group": "Sms_Queue_Reports",
23178     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23179     "version": "0.0.0",
23180     "filename": "server/api/smsQueueReport/index.js",
23181     "groupTitle": "Sms_Queue_Reports"
23182   },
23183   {
23184     "type": "get",
23185     "url": "/api/sms/reports/queue/describe",
23186     "title": "Gets table info about Sms Queue Reports",
23187     "examples": [
23188       {
23189         "title": "Example usage:",
23190         "content": "curl https://{domain}/api/sms/reports/queue/describe -v -u {name}:{password}",
23191         "type": "json"
23192       }
23193     ],
23194     "name": "DescribeSms_Queue_Reports",
23195     "group": "Sms_Queue_Reports",
23196     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23197     "version": "0.0.0",
23198     "filename": "server/api/smsQueueReport/index.js",
23199     "groupTitle": "Sms_Queue_Reports"
23200   },
23201   {
23202     "type": "get",
23203     "url": "/api/sms/reports/queue",
23204     "title": "Gets a list of Sms Queue Reports",
23205     "examples": [
23206       {
23207         "title": "Example usage:",
23208         "content": "curl https://{domain}/api/sms/reports/queue -v -u {name}:{password}",
23209         "type": "json"
23210       }
23211     ],
23212     "name": "GetSms_Queue_Reports",
23213     "group": "Sms_Queue_Reports",
23214     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
23215     "version": "0.0.0",
23216     "filename": "server/api/smsQueueReport/index.js",
23217     "groupTitle": "Sms_Queue_Reports"
23218   },
23219   {
23220     "type": "get",
23221     "url": "/api/sms/reports/queue/{id}",
23222     "title": "Gets a single Sms Queue Report",
23223     "examples": [
23224       {
23225         "title": "Example usage:",
23226         "content": "curl https://{domain}/api/sms/reports/queue/{id} -v -u {name}:{password}",
23227         "type": "json"
23228       }
23229     ],
23230     "name": "ShowSms_Queue_Reports",
23231     "group": "Sms_Queue_Reports",
23232     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23233     "version": "0.0.0",
23234     "filename": "server/api/smsQueueReport/index.js",
23235     "groupTitle": "Sms_Queue_Reports"
23236   },
23237   {
23238     "type": "put",
23239     "url": "/api/sms/reports/queue/{id}",
23240     "title": "Update an existing Sms Queue Report",
23241     "examples": [
23242       {
23243         "title": "Example usage:",
23244         "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",
23245         "type": "json"
23246       }
23247     ],
23248     "name": "updateSms_Queue_Reports",
23249     "group": "Sms_Queue_Reports",
23250     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23251     "version": "0.0.0",
23252     "filename": "server/api/smsQueueReport/index.js",
23253     "groupTitle": "Sms_Queue_Reports"
23254   },
23255   {
23256     "type": "post",
23257     "url": "/api/sms/queues/{id}/users",
23258     "title": "Add agents to a queue",
23259     "examples": [
23260       {
23261         "title": "Example usage:",
23262         "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",
23263         "type": "json"
23264       }
23265     ],
23266     "name": "AddAgents",
23267     "group": "Sms_Queues",
23268     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23269     "version": "0.0.0",
23270     "filename": "server/api/smsQueue/index.js",
23271     "groupTitle": "Sms_Queues"
23272   },
23273   {
23274     "type": "post",
23275     "url": "/api/sms/queues/{id}/teams",
23276     "title": "Add teams to a queue",
23277     "examples": [
23278       {
23279         "title": "Example usage:",
23280         "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",
23281         "type": "json"
23282       }
23283     ],
23284     "name": "AddTeams",
23285     "group": "Sms_Queues",
23286     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23287     "version": "0.0.0",
23288     "filename": "server/api/smsQueue/index.js",
23289     "groupTitle": "Sms_Queues"
23290   },
23291   {
23292     "type": "post",
23293     "url": "/api/sms/queues",
23294     "title": "Creates a new Queue",
23295     "examples": [
23296       {
23297         "title": "Example usage:",
23298         "content": "curl https://{domain}/api/sms/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
23299         "type": "json"
23300       }
23301     ],
23302     "name": "CreateQueues",
23303     "group": "Sms_Queues",
23304     "parameter": {
23305       "fields": {
23306         "Body": [
23307           {
23308             "group": "Body",
23309             "type": "String",
23310             "optional": true,
23311             "field": "name",
23312             "description": ""
23313           },
23314           {
23315             "group": "Body",
23316             "type": "String",
23317             "optional": true,
23318             "field": "description",
23319             "description": ""
23320           },
23321           {
23322             "group": "Body",
23323             "type": "Integer",
23324             "optional": true,
23325             "field": "timeout",
23326             "description": ""
23327           },
23328           {
23329             "group": "Body",
23330             "type": "String",
23331             "allowedValues": [
23332               "\"rrmemory\"",
23333               "\"beepall\"",
23334               "\"roundrobin\""
23335             ],
23336             "optional": true,
23337             "field": "strategy",
23338             "description": ""
23339           }
23340         ]
23341       }
23342     },
23343     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23344     "version": "0.0.0",
23345     "filename": "server/api/smsQueue/index.js",
23346     "groupTitle": "Sms_Queues"
23347   },
23348   {
23349     "type": "delete",
23350     "url": "/api/sms/queues/{id}",
23351     "title": "Deletes a Queue",
23352     "examples": [
23353       {
23354         "title": "Example usage:",
23355         "content": "curl https://{domain}/api/sms/queues/{id} -v -u {name}:{password} -X DELETE",
23356         "type": "json"
23357       }
23358     ],
23359     "name": "DeleteQueues",
23360     "group": "Sms_Queues",
23361     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23362     "version": "0.0.0",
23363     "filename": "server/api/smsQueue/index.js",
23364     "groupTitle": "Sms_Queues"
23365   },
23366   {
23367     "type": "get",
23368     "url": "/api/sms/queues/describe",
23369     "title": "Gets table info about Queues",
23370     "examples": [
23371       {
23372         "title": "Example usage:",
23373         "content": "curl https://{domain}/api/sms/queues/describe -v -u {name}:{password}",
23374         "type": "json"
23375       }
23376     ],
23377     "name": "DescribeQueues",
23378     "group": "Sms_Queues",
23379     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23380     "version": "0.0.0",
23381     "filename": "server/api/smsQueue/index.js",
23382     "groupTitle": "Sms_Queues"
23383   },
23384   {
23385     "type": "get",
23386     "url": "/api/sms/queues/{id}/users",
23387     "title": "Gets queue agents",
23388     "examples": [
23389       {
23390         "title": "Example usage:",
23391         "content": "curl https://{domain}/api/sms/queues/{id}/users -v -u {name}:{password} -X POST",
23392         "type": "json"
23393       }
23394     ],
23395     "name": "GetAgents",
23396     "group": "Sms_Queues",
23397     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23398     "version": "0.0.0",
23399     "filename": "server/api/smsQueue/index.js",
23400     "groupTitle": "Sms_Queues"
23401   },
23402   {
23403     "type": "get",
23404     "url": "/api/sms/queues/{id}/members",
23405     "title": "GetMembers",
23406     "examples": [
23407       {
23408         "title": "Example usage:",
23409         "content": "curl https://{domain}/api/sms/queues/{id}/members  -v -u {name}:{password}",
23410         "type": "json"
23411       }
23412     ],
23413     "name": "GetMembers",
23414     "group": "Sms_Queues",
23415     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23416     "version": "0.0.0",
23417     "filename": "server/api/smsQueue/index.js",
23418     "groupTitle": "Sms_Queues"
23419   },
23420   {
23421     "type": "get",
23422     "url": "/api/sms/queues",
23423     "title": "Gets a list of Queues",
23424     "examples": [
23425       {
23426         "title": "Example usage:",
23427         "content": "curl https://{domain}/api/sms/queues -v -u {name}:{password}",
23428         "type": "json"
23429       }
23430     ],
23431     "name": "GetQueues",
23432     "group": "Sms_Queues",
23433     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
23434     "version": "0.0.0",
23435     "filename": "server/api/smsQueue/index.js",
23436     "groupTitle": "Sms_Queues"
23437   },
23438   {
23439     "type": "get",
23440     "url": "/api/sms/queues/{id}/teams",
23441     "title": "Gets queues list",
23442     "examples": [
23443       {
23444         "title": "Example usage:",
23445         "content": "curl https://{domain}/api/sms/queues/{id}/teams -v -u {name}:{password}",
23446         "type": "json"
23447       }
23448     ],
23449     "name": "GetTeams",
23450     "group": "Sms_Queues",
23451     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23452     "version": "0.0.0",
23453     "filename": "server/api/smsQueue/index.js",
23454     "groupTitle": "Sms_Queues"
23455   },
23456   {
23457     "type": "delete",
23458     "url": "/api/sms/queues/{id}/users",
23459     "title": "Removes agents from a queue",
23460     "examples": [
23461       {
23462         "title": "Example usage:",
23463         "content": "curl https://{domain}/api/sms/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
23464         "type": "json"
23465       }
23466     ],
23467     "name": "RemoveAgents",
23468     "group": "Sms_Queues",
23469     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23470     "version": "0.0.0",
23471     "filename": "server/api/smsQueue/index.js",
23472     "groupTitle": "Sms_Queues"
23473   },
23474   {
23475     "type": "get",
23476     "url": "/api/sms/queues/{id}",
23477     "title": "Gets a single Queue",
23478     "examples": [
23479       {
23480         "title": "Example usage:",
23481         "content": "curl https://{domain}/api/sms/queues/{id} -v -u {name}:{password}",
23482         "type": "json"
23483       }
23484     ],
23485     "name": "ShowQueues",
23486     "group": "Sms_Queues",
23487     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23488     "version": "0.0.0",
23489     "filename": "server/api/smsQueue/index.js",
23490     "groupTitle": "Sms_Queues"
23491   },
23492   {
23493     "type": "put",
23494     "url": "/api/sms/queues/{id}",
23495     "title": "Update an existing Queue",
23496     "examples": [
23497       {
23498         "title": "Example usage:",
23499         "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",
23500         "type": "json"
23501       }
23502     ],
23503     "name": "updateQueues",
23504     "group": "Sms_Queues",
23505     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23506     "version": "0.0.0",
23507     "filename": "server/api/smsQueue/index.js",
23508     "groupTitle": "Sms_Queues"
23509   },
23510   {
23511     "type": "post",
23512     "url": "/api/sms/reports/transfer",
23513     "title": "Creates a new Sms Transfer Report",
23514     "examples": [
23515       {
23516         "title": "Example usage:",
23517         "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",
23518         "type": "json"
23519       }
23520     ],
23521     "name": "CreateSms_Transfer_Reports",
23522     "group": "Sms_Transfer_Reports",
23523     "parameter": {
23524       "fields": {
23525         "Body": [
23526           {
23527             "group": "Body",
23528             "type": "String",
23529             "optional": false,
23530             "field": "uniqueid",
23531             "description": ""
23532           },
23533           {
23534             "group": "Body",
23535             "type": "String",
23536             "allowedValues": [
23537               "\"account\"",
23538               "\"agent\"",
23539               "\"queue\""
23540             ],
23541             "optional": false,
23542             "field": "type",
23543             "description": ""
23544           },
23545           {
23546             "group": "Body",
23547             "type": "String",
23548             "optional": false,
23549             "field": "transferredAt",
23550             "description": ""
23551           }
23552         ]
23553       }
23554     },
23555     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23556     "version": "0.0.0",
23557     "filename": "server/api/smsTransferReport/index.js",
23558     "groupTitle": "Sms_Transfer_Reports"
23559   },
23560   {
23561     "type": "delete",
23562     "url": "/api/sms/reports/transfer/{id}",
23563     "title": "Deletes a Sms Transfer Report",
23564     "examples": [
23565       {
23566         "title": "Example usage:",
23567         "content": "curl https://{domain}/api/sms/reports/transfer/{id} -v -u {name}:{password} -X DELETE",
23568         "type": "json"
23569       }
23570     ],
23571     "name": "DeleteSms_Transfer_Reports",
23572     "group": "Sms_Transfer_Reports",
23573     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23574     "version": "0.0.0",
23575     "filename": "server/api/smsTransferReport/index.js",
23576     "groupTitle": "Sms_Transfer_Reports"
23577   },
23578   {
23579     "type": "get",
23580     "url": "/api/sms/reports/transfer/describe",
23581     "title": "Gets table info about Sms Transfer Reports",
23582     "examples": [
23583       {
23584         "title": "Example usage:",
23585         "content": "curl https://{domain}/api/sms/reports/transfer/describe -v -u {name}:{password}",
23586         "type": "json"
23587       }
23588     ],
23589     "name": "DescribeSms_Transfer_Reports",
23590     "group": "Sms_Transfer_Reports",
23591     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23592     "version": "0.0.0",
23593     "filename": "server/api/smsTransferReport/index.js",
23594     "groupTitle": "Sms_Transfer_Reports"
23595   },
23596   {
23597     "type": "get",
23598     "url": "/api/sms/reports/transfer",
23599     "title": "Gets a list of Sms Transfer Reports",
23600     "examples": [
23601       {
23602         "title": "Example usage:",
23603         "content": "curl https://{domain}/api/sms/reports/transfer -v -u {name}:{password}",
23604         "type": "json"
23605       }
23606     ],
23607     "name": "GetSms_Transfer_Reports",
23608     "group": "Sms_Transfer_Reports",
23609     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
23610     "version": "0.0.0",
23611     "filename": "server/api/smsTransferReport/index.js",
23612     "groupTitle": "Sms_Transfer_Reports"
23613   },
23614   {
23615     "type": "get",
23616     "url": "/api/sms/reports/transfer/{id}",
23617     "title": "Gets a single Sms Transfer Report",
23618     "examples": [
23619       {
23620         "title": "Example usage:",
23621         "content": "curl https://{domain}/api/sms/reports/transfer/{id} -v -u {name}:{password}",
23622         "type": "json"
23623       }
23624     ],
23625     "name": "ShowSms_Transfer_Reports",
23626     "group": "Sms_Transfer_Reports",
23627     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23628     "version": "0.0.0",
23629     "filename": "server/api/smsTransferReport/index.js",
23630     "groupTitle": "Sms_Transfer_Reports"
23631   },
23632   {
23633     "type": "put",
23634     "url": "/api/sms/reports/transfer/{id}",
23635     "title": "Update an existing Sms Transfer Report",
23636     "examples": [
23637       {
23638         "title": "Example usage:",
23639         "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",
23640         "type": "json"
23641       }
23642     ],
23643     "name": "updateSms_Transfer_Reports",
23644     "group": "Sms_Transfer_Reports",
23645     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23646     "version": "0.0.0",
23647     "filename": "server/api/smsTransferReport/index.js",
23648     "groupTitle": "Sms_Transfer_Reports"
23649   },
23650   {
23651     "type": "get",
23652     "url": "/api/sounds",
23653     "title": "Gets a list of Sounds",
23654     "examples": [
23655       {
23656         "title": "Example usage:",
23657         "content": "curl https://{domain}/api/sounds -v -u {name}:{password}",
23658         "type": "json"
23659       }
23660     ],
23661     "name": "GetSounds",
23662     "group": "Sounds",
23663     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
23664     "version": "0.0.0",
23665     "filename": "server/api/sound/index.js",
23666     "groupTitle": "Sounds"
23667   },
23668   {
23669     "type": "get",
23670     "url": "/api/sounds/{id}",
23671     "title": "Gets a single Sound",
23672     "examples": [
23673       {
23674         "title": "Example usage:",
23675         "content": "curl https://{domain}/api/sounds/{id} -v -u {name}:{password}",
23676         "type": "json"
23677       }
23678     ],
23679     "name": "ShowSounds",
23680     "group": "Sounds",
23681     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23682     "version": "0.0.0",
23683     "filename": "server/api/sound/index.js",
23684     "groupTitle": "Sounds"
23685   },
23686   {
23687     "type": "post",
23688     "url": "/api/sounds",
23689     "title": "Create a new sound",
23690     "examples": [
23691       {
23692         "title": "Example usage:",
23693         "content": "curl https://{domain}/api/sounds -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
23694         "type": "json"
23695       }
23696     ],
23697     "name": "addSound",
23698     "group": "Sounds",
23699     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23700     "version": "0.0.0",
23701     "filename": "server/api/sound/index.js",
23702     "groupTitle": "Sounds"
23703   },
23704   {
23705     "type": "delete",
23706     "url": "/api/sounds/{id}",
23707     "title": "Deletes a sound",
23708     "examples": [
23709       {
23710         "title": "Example usage:",
23711         "content": "curl https://{domain}/api/sounds/{id} -v -u {name}:{password} -X DELETE",
23712         "type": "json"
23713       }
23714     ],
23715     "name": "destroySound",
23716     "group": "Sounds",
23717     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23718     "version": "0.0.0",
23719     "filename": "server/api/sound/index.js",
23720     "groupTitle": "Sounds"
23721   },
23722   {
23723     "type": "get",
23724     "url": "/api/sounds/{id}/download",
23725     "title": "Download Sound",
23726     "examples": [
23727       {
23728         "title": "Example usage:",
23729         "content": "curl https://{domain}/api/sounds/{id}/download -v -u {name}:{password} -X GET",
23730         "type": "json"
23731       }
23732     ],
23733     "name": "download",
23734     "group": "Sounds",
23735     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23736     "version": "0.0.0",
23737     "filename": "server/api/sound/index.js",
23738     "groupTitle": "Sounds"
23739   },
23740   {
23741     "type": "put",
23742     "url": "/api/sounds",
23743     "title": "Update an existing new sound",
23744     "examples": [
23745       {
23746         "title": "Example usage:",
23747         "content": "curl https://{domain}/api/sounds -d '[\"name\": \"sound_name\", \"description\": \"sound_desc\"]' -v -u {name}:{password} -X PUT",
23748         "type": "json"
23749       }
23750     ],
23751     "name": "updateSound",
23752     "group": "Sounds",
23753     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23754     "version": "0.0.0",
23755     "filename": "server/api/sound/index.js",
23756     "groupTitle": "Sounds"
23757   },
23758   {
23759     "type": "post",
23760     "url": "/api/square/details/reports",
23761     "title": "Creates a new Square Detail Report",
23762     "examples": [
23763       {
23764         "title": "Example usage:",
23765         "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",
23766         "type": "json"
23767       }
23768     ],
23769     "name": "CreateSquare_Detail_Reports",
23770     "group": "Square_Details_Reports",
23771     "parameter": {
23772       "fields": {
23773         "Body": [
23774           {
23775             "group": "Body",
23776             "type": "String",
23777             "optional": true,
23778             "field": "uniqueid",
23779             "description": ""
23780           },
23781           {
23782             "group": "Body",
23783             "type": "String",
23784             "optional": true,
23785             "field": "node",
23786             "description": ""
23787           },
23788           {
23789             "group": "Body",
23790             "type": "String",
23791             "optional": true,
23792             "field": "application",
23793             "description": ""
23794           },
23795           {
23796             "group": "Body",
23797             "type": "Text",
23798             "optional": true,
23799             "field": "data",
23800             "description": ""
23801           },
23802           {
23803             "group": "Body",
23804             "type": "String",
23805             "optional": true,
23806             "field": "project_name",
23807             "description": ""
23808           },
23809           {
23810             "group": "Body",
23811             "type": "String",
23812             "optional": true,
23813             "field": "callerid",
23814             "description": ""
23815           }
23816         ]
23817       }
23818     },
23819     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23820     "version": "0.0.0",
23821     "filename": "server/api/squareReportDetail/index.js",
23822     "groupTitle": "Square_Details_Reports"
23823   },
23824   {
23825     "type": "delete",
23826     "url": "/api/square/details/reports/{id}",
23827     "title": "Deletes a Square Detail Report",
23828     "examples": [
23829       {
23830         "title": "Example usage:",
23831         "content": "curl https://{domain}/api/square/details/reports/{id} -v -u {name}:{password} -X DELETE",
23832         "type": "json"
23833       }
23834     ],
23835     "name": "DeleteSquare_Detail_Reports",
23836     "group": "Square_Details_Reports",
23837     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23838     "version": "0.0.0",
23839     "filename": "server/api/squareReportDetail/index.js",
23840     "groupTitle": "Square_Details_Reports"
23841   },
23842   {
23843     "type": "get",
23844     "url": "/api/square/details/reports/describe",
23845     "title": "Gets table info about Square Detail Reports",
23846     "examples": [
23847       {
23848         "title": "Example usage:",
23849         "content": "curl https://{domain}/api/square/details/reports/describe -v -u {name}:{password}",
23850         "type": "json"
23851       }
23852     ],
23853     "name": "DescribeSquare_Detail_Reports",
23854     "group": "Square_Details_Reports",
23855     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23856     "version": "0.0.0",
23857     "filename": "server/api/squareReportDetail/index.js",
23858     "groupTitle": "Square_Details_Reports"
23859   },
23860   {
23861     "type": "get",
23862     "url": "/api/square/details/reports",
23863     "title": "Gets a list of Square Detail Reports",
23864     "examples": [
23865       {
23866         "title": "Example usage:",
23867         "content": "curl https://{domain}/api/square/details/reports -v -u {name}:{password}",
23868         "type": "json"
23869       }
23870     ],
23871     "name": "GetSquare_Detail_Reports",
23872     "group": "Square_Details_Reports",
23873     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
23874     "version": "0.0.0",
23875     "filename": "server/api/squareReportDetail/index.js",
23876     "groupTitle": "Square_Details_Reports"
23877   },
23878   {
23879     "type": "get",
23880     "url": "/api/square/details/reports/{id}",
23881     "title": "Gets a single Square Detail Report",
23882     "examples": [
23883       {
23884         "title": "Example usage:",
23885         "content": "curl https://{domain}/api/square/details/reports/{id} -v -u {name}:{password}",
23886         "type": "json"
23887       }
23888     ],
23889     "name": "ShowSquare_Detail_Reports",
23890     "group": "Square_Details_Reports",
23891     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23892     "version": "0.0.0",
23893     "filename": "server/api/squareReportDetail/index.js",
23894     "groupTitle": "Square_Details_Reports"
23895   },
23896   {
23897     "type": "put",
23898     "url": "/api/square/details/reports/{id}",
23899     "title": "Update an existing Square Detail Report",
23900     "examples": [
23901       {
23902         "title": "Example usage:",
23903         "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",
23904         "type": "json"
23905       }
23906     ],
23907     "name": "updateSquare_Detail_Reports",
23908     "group": "Square_Details_Reports",
23909     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23910     "version": "0.0.0",
23911     "filename": "server/api/squareReportDetail/index.js",
23912     "groupTitle": "Square_Details_Reports"
23913   },
23914   {
23915     "type": "post",
23916     "url": "/api/square/messages",
23917     "title": "Creates a new Message",
23918     "examples": [
23919       {
23920         "title": "Example usage:",
23921         "content": "curl https://{domain}/api/square/messages -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
23922         "type": "json"
23923       }
23924     ],
23925     "name": "CreateMessages",
23926     "group": "Square_Messages",
23927     "parameter": {
23928       "fields": {
23929         "Body": [
23930           {
23931             "group": "Body",
23932             "type": "String",
23933             "optional": true,
23934             "field": "uniqueid",
23935             "description": ""
23936           },
23937           {
23938             "group": "Body",
23939             "type": "Text",
23940             "optional": false,
23941             "field": "body",
23942             "description": ""
23943           },
23944           {
23945             "group": "Body",
23946             "type": "String",
23947             "allowedValues": [
23948               "\"in\"",
23949               "\"out\""
23950             ],
23951             "optional": false,
23952             "field": "direction",
23953             "description": ""
23954           }
23955         ]
23956       }
23957     },
23958     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23959     "version": "0.0.0",
23960     "filename": "server/api/squareMessage/index.js",
23961     "groupTitle": "Square_Messages"
23962   },
23963   {
23964     "type": "delete",
23965     "url": "/api/square/messages/{id}",
23966     "title": "Deletes a Message",
23967     "examples": [
23968       {
23969         "title": "Example usage:",
23970         "content": "curl https://{domain}/api/square/messages/{id} -v -u {name}:{password} -X DELETE",
23971         "type": "json"
23972       }
23973     ],
23974     "name": "DeleteMessages",
23975     "group": "Square_Messages",
23976     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23977     "version": "0.0.0",
23978     "filename": "server/api/squareMessage/index.js",
23979     "groupTitle": "Square_Messages"
23980   },
23981   {
23982     "type": "get",
23983     "url": "/api/square/messages",
23984     "title": "Gets a list of Messages",
23985     "examples": [
23986       {
23987         "title": "Example usage:",
23988         "content": "curl https://{domain}/api/square/messages -v -u {name}:{password}",
23989         "type": "json"
23990       }
23991     ],
23992     "name": "GetMessages",
23993     "group": "Square_Messages",
23994     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
23995     "version": "0.0.0",
23996     "filename": "server/api/squareMessage/index.js",
23997     "groupTitle": "Square_Messages"
23998   },
23999   {
24000     "type": "get",
24001     "url": "/api/square/messages/{id}",
24002     "title": "Gets a single Message",
24003     "examples": [
24004       {
24005         "title": "Example usage:",
24006         "content": "curl https://{domain}/api/square/messages/{id} -v -u {name}:{password}",
24007         "type": "json"
24008       }
24009     ],
24010     "name": "ShowMessages",
24011     "group": "Square_Messages",
24012     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24013     "version": "0.0.0",
24014     "filename": "server/api/squareMessage/index.js",
24015     "groupTitle": "Square_Messages"
24016   },
24017   {
24018     "type": "put",
24019     "url": "/api/square/messages/{id}",
24020     "title": "Update an existing Message",
24021     "examples": [
24022       {
24023         "title": "Example usage:",
24024         "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",
24025         "type": "json"
24026       }
24027     ],
24028     "name": "updateMessages",
24029     "group": "Square_Messages",
24030     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24031     "version": "0.0.0",
24032     "filename": "server/api/squareMessage/index.js",
24033     "groupTitle": "Square_Messages"
24034   },
24035   {
24036     "type": "post",
24037     "url": "/api/square/odbc",
24038     "title": "Creates a new ODBC",
24039     "examples": [
24040       {
24041         "title": "Example usage:",
24042         "content": "curl https://{domain}/api/square/odbc -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
24043         "type": "json"
24044       }
24045     ],
24046     "name": "CreateODBCs",
24047     "group": "Square_ODBC",
24048     "parameter": {
24049       "fields": {
24050         "Body": [
24051           {
24052             "group": "Body",
24053             "type": "String",
24054             "optional": false,
24055             "field": "name",
24056             "description": ""
24057           },
24058           {
24059             "group": "Body",
24060             "type": "String",
24061             "optional": true,
24062             "field": "dsn",
24063             "description": ""
24064           },
24065           {
24066             "group": "Body",
24067             "type": "String",
24068             "optional": true,
24069             "field": "description",
24070             "description": ""
24071           }
24072         ]
24073       }
24074     },
24075     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24076     "version": "0.0.0",
24077     "filename": "server/api/squareOdbc/index.js",
24078     "groupTitle": "Square_ODBC"
24079   },
24080   {
24081     "type": "delete",
24082     "url": "/api/square/odbc/{id}",
24083     "title": "Deletes a ODBC",
24084     "examples": [
24085       {
24086         "title": "Example usage:",
24087         "content": "curl https://{domain}/api/square/odbc/{id} -v -u {name}:{password} -X DELETE",
24088         "type": "json"
24089       }
24090     ],
24091     "name": "DeleteODBCs",
24092     "group": "Square_ODBC",
24093     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24094     "version": "0.0.0",
24095     "filename": "server/api/squareOdbc/index.js",
24096     "groupTitle": "Square_ODBC"
24097   },
24098   {
24099     "type": "get",
24100     "url": "/api/square/odbc",
24101     "title": "Gets a list of ODBCs",
24102     "examples": [
24103       {
24104         "title": "Example usage:",
24105         "content": "curl https://{domain}/api/square/odbc -v -u {name}:{password}",
24106         "type": "json"
24107       }
24108     ],
24109     "name": "GetODBCs",
24110     "group": "Square_ODBC",
24111     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
24112     "version": "0.0.0",
24113     "filename": "server/api/squareOdbc/index.js",
24114     "groupTitle": "Square_ODBC"
24115   },
24116   {
24117     "type": "get",
24118     "url": "/api/square/odbc/{id}",
24119     "title": "Gets a single ODBC",
24120     "examples": [
24121       {
24122         "title": "Example usage:",
24123         "content": "curl https://{domain}/api/square/odbc/{id} -v -u {name}:{password}",
24124         "type": "json"
24125       }
24126     ],
24127     "name": "ShowODBCs",
24128     "group": "Square_ODBC",
24129     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24130     "version": "0.0.0",
24131     "filename": "server/api/squareOdbc/index.js",
24132     "groupTitle": "Square_ODBC"
24133   },
24134   {
24135     "type": "get",
24136     "url": "/api/square/odbc/{id}/test",
24137     "title": "Test Odbc",
24138     "examples": [
24139       {
24140         "title": "Example usage:",
24141         "content": "curl https://{domain}/api/square/odbc/{id}/test -v -u {name}:{password} -X GET",
24142         "type": "json"
24143       }
24144     ],
24145     "name": "test",
24146     "group": "Square_ODBC",
24147     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24148     "version": "0.0.0",
24149     "filename": "server/api/squareOdbc/index.js",
24150     "groupTitle": "Square_ODBC"
24151   },
24152   {
24153     "type": "put",
24154     "url": "/api/square/odbc/{id}",
24155     "title": "Update an existing ODBC",
24156     "examples": [
24157       {
24158         "title": "Example usage:",
24159         "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",
24160         "type": "json"
24161       }
24162     ],
24163     "name": "updateODBCs",
24164     "group": "Square_ODBC",
24165     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24166     "version": "0.0.0",
24167     "filename": "server/api/squareOdbc/index.js",
24168     "groupTitle": "Square_ODBC"
24169   },
24170   {
24171     "type": "post",
24172     "url": "/api/square/projects",
24173     "title": "Creates a new Project",
24174     "examples": [
24175       {
24176         "title": "Example usage:",
24177         "content": "curl https://{domain}/api/square/projects -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
24178         "type": "json"
24179       }
24180     ],
24181     "name": "CreateProjects",
24182     "group": "Square_Projects",
24183     "parameter": {
24184       "fields": {
24185         "Body": [
24186           {
24187             "group": "Body",
24188             "type": "String",
24189             "optional": false,
24190             "field": "name",
24191             "description": ""
24192           },
24193           {
24194             "group": "Body",
24195             "type": "String",
24196             "optional": true,
24197             "field": "description",
24198             "description": ""
24199           },
24200           {
24201             "group": "Body",
24202             "type": "Text",
24203             "optional": true,
24204             "field": "notes",
24205             "description": ""
24206           },
24207           {
24208             "group": "Body",
24209             "type": "Blob",
24210             "optional": true,
24211             "field": "preproduction",
24212             "description": ""
24213           },
24214           {
24215             "group": "Body",
24216             "type": "Blob",
24217             "optional": true,
24218             "field": "production",
24219             "description": ""
24220           }
24221         ]
24222       }
24223     },
24224     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24225     "version": "0.0.0",
24226     "filename": "server/api/squareProject/index.js",
24227     "groupTitle": "Square_Projects"
24228   },
24229   {
24230     "type": "delete",
24231     "url": "/api/square/projects/{id}",
24232     "title": "Deletes a Project",
24233     "examples": [
24234       {
24235         "title": "Example usage:",
24236         "content": "curl https://{domain}/api/square/projects/{id} -v -u {name}:{password} -X DELETE",
24237         "type": "json"
24238       }
24239     ],
24240     "name": "DeleteProjects",
24241     "group": "Square_Projects",
24242     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24243     "version": "0.0.0",
24244     "filename": "server/api/squareProject/index.js",
24245     "groupTitle": "Square_Projects"
24246   },
24247   {
24248     "type": "get",
24249     "url": "/api/square/projects",
24250     "title": "Gets a list of Projects",
24251     "examples": [
24252       {
24253         "title": "Example usage:",
24254         "content": "curl https://{domain}/api/square/projects -v -u {name}:{password}",
24255         "type": "json"
24256       }
24257     ],
24258     "name": "GetProjects",
24259     "group": "Square_Projects",
24260     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
24261     "version": "0.0.0",
24262     "filename": "server/api/squareProject/index.js",
24263     "groupTitle": "Square_Projects"
24264   },
24265   {
24266     "type": "get",
24267     "url": "/api/square/projects/{id}",
24268     "title": "Gets a single Project",
24269     "examples": [
24270       {
24271         "title": "Example usage:",
24272         "content": "curl https://{domain}/api/square/projects/{id} -v -u {name}:{password}",
24273         "type": "json"
24274       }
24275     ],
24276     "name": "ShowProjects",
24277     "group": "Square_Projects",
24278     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24279     "version": "0.0.0",
24280     "filename": "server/api/squareProject/index.js",
24281     "groupTitle": "Square_Projects"
24282   },
24283   {
24284     "type": "post",
24285     "url": "/api/square/projects/{id}/users",
24286     "title": "Adds user permissions to a Project",
24287     "examples": [
24288       {
24289         "title": "Example usage:",
24290         "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",
24291         "type": "json"
24292       }
24293     ],
24294     "name": "addUsers",
24295     "group": "Square_Projects",
24296     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24297     "version": "0.0.0",
24298     "filename": "server/api/squareProject/index.js",
24299     "groupTitle": "Square_Projects"
24300   },
24301   {
24302     "type": "get",
24303     "url": "/api/square/projects/{id}/users",
24304     "title": "Gets users permissions from Project",
24305     "examples": [
24306       {
24307         "title": "Example usage:",
24308         "content": "curl https://{domain}/api/square/projects/{id}/users -v -u {name}:{password} -X GET",
24309         "type": "json"
24310       }
24311     ],
24312     "name": "getUsers",
24313     "group": "Square_Projects",
24314     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24315     "version": "0.0.0",
24316     "filename": "server/api/squareProject/index.js",
24317     "groupTitle": "Square_Projects"
24318   },
24319   {
24320     "type": "delete",
24321     "url": "/api/square/projects/{id}/users",
24322     "title": "Removes user permissions from a Project",
24323     "examples": [
24324       {
24325         "title": "Example usage:",
24326         "content": "curl https://{domain}/api/square/projects/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
24327         "type": "json"
24328       }
24329     ],
24330     "name": "removeUsers",
24331     "group": "Square_Projects",
24332     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24333     "version": "0.0.0",
24334     "filename": "server/api/squareProject/index.js",
24335     "groupTitle": "Square_Projects"
24336   },
24337   {
24338     "type": "put",
24339     "url": "/api/square/projects/{id}",
24340     "title": "Update an existing Project",
24341     "examples": [
24342       {
24343         "title": "Example usage:",
24344         "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",
24345         "type": "json"
24346       }
24347     ],
24348     "name": "updateProjects",
24349     "group": "Square_Projects",
24350     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24351     "version": "0.0.0",
24352     "filename": "server/api/squareProject/index.js",
24353     "groupTitle": "Square_Projects"
24354   },
24355   {
24356     "type": "post",
24357     "url": "/api/square/recordings",
24358     "title": "Creates a new Recording",
24359     "examples": [
24360       {
24361         "title": "Example usage:",
24362         "content": "curl https://{domain}/api/square/recordings -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
24363         "type": "json"
24364       }
24365     ],
24366     "name": "CreateRecordings",
24367     "group": "Square_Recordings",
24368     "parameter": {
24369       "fields": {
24370         "Body": [
24371           {
24372             "group": "Body",
24373             "type": "String",
24374             "optional": true,
24375             "field": "uniqueid",
24376             "description": ""
24377           },
24378           {
24379             "group": "Body",
24380             "type": "String",
24381             "optional": true,
24382             "field": "callerid",
24383             "description": ""
24384           },
24385           {
24386             "group": "Body",
24387             "type": "String",
24388             "optional": true,
24389             "field": "calleridname",
24390             "description": ""
24391           },
24392           {
24393             "group": "Body",
24394             "type": "String",
24395             "optional": true,
24396             "field": "context",
24397             "description": ""
24398           },
24399           {
24400             "group": "Body",
24401             "type": "String",
24402             "optional": true,
24403             "field": "extension",
24404             "description": ""
24405           },
24406           {
24407             "group": "Body",
24408             "type": "String",
24409             "optional": true,
24410             "field": "priority",
24411             "description": ""
24412           },
24413           {
24414             "group": "Body",
24415             "type": "String",
24416             "optional": true,
24417             "field": "accountcode",
24418             "description": ""
24419           },
24420           {
24421             "group": "Body",
24422             "type": "String",
24423             "optional": true,
24424             "field": "dnid",
24425             "description": ""
24426           },
24427           {
24428             "group": "Body",
24429             "type": "String",
24430             "optional": true,
24431             "field": "projectName",
24432             "description": ""
24433           },
24434           {
24435             "group": "Body",
24436             "type": "String",
24437             "optional": true,
24438             "field": "saveName",
24439             "description": ""
24440           },
24441           {
24442             "group": "Body",
24443             "type": "String",
24444             "optional": true,
24445             "field": "filename",
24446             "description": ""
24447           },
24448           {
24449             "group": "Body",
24450             "type": "String",
24451             "optional": true,
24452             "field": "savePath",
24453             "description": ""
24454           },
24455           {
24456             "group": "Body",
24457             "type": "Virtual",
24458             "optional": true,
24459             "field": "format",
24460             "description": ""
24461           }
24462         ]
24463       }
24464     },
24465     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24466     "version": "0.0.0",
24467     "filename": "server/api/squareRecording/index.js",
24468     "groupTitle": "Square_Recordings"
24469   },
24470   {
24471     "type": "get",
24472     "url": "/api/square/recordings",
24473     "title": "Gets a list of Recordings",
24474     "examples": [
24475       {
24476         "title": "Example usage:",
24477         "content": "curl https://{domain}/api/square/recordings -v -u {name}:{password}",
24478         "type": "json"
24479       }
24480     ],
24481     "name": "GetRecordings",
24482     "group": "Square_Recordings",
24483     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
24484     "version": "0.0.0",
24485     "filename": "server/api/squareRecording/index.js",
24486     "groupTitle": "Square_Recordings"
24487   },
24488   {
24489     "type": "get",
24490     "url": "/api/square/recordings/{id}",
24491     "title": "Gets a single Recording",
24492     "examples": [
24493       {
24494         "title": "Example usage:",
24495         "content": "curl https://{domain}/api/square/recordings/{id} -v -u {name}:{password}",
24496         "type": "json"
24497       }
24498     ],
24499     "name": "ShowRecordings",
24500     "group": "Square_Recordings",
24501     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24502     "version": "0.0.0",
24503     "filename": "server/api/squareRecording/index.js",
24504     "groupTitle": "Square_Recordings"
24505   },
24506   {
24507     "type": "delete",
24508     "url": "/api/square/recordings/{id}/delete",
24509     "title": "Delete recording",
24510     "examples": [
24511       {
24512         "title": "Example usage:",
24513         "content": "curl https://{domain}/api/square/recordings/{id}/delete -v -u {name}:{password} -X DELETE",
24514         "type": "json"
24515       }
24516     ],
24517     "name": "destroy",
24518     "group": "Square_Recordings",
24519     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24520     "version": "0.0.0",
24521     "filename": "server/api/squareRecording/index.js",
24522     "groupTitle": "Square_Recordings"
24523   },
24524   {
24525     "type": "get",
24526     "url": "/api/square/recordings/{id}/download",
24527     "title": "Download Recording",
24528     "examples": [
24529       {
24530         "title": "Example usage:",
24531         "content": "curl https://{domain}/api/square/recordings/{id}/download -v -u {name}:{password} -X GET",
24532         "type": "json"
24533       }
24534     ],
24535     "name": "download",
24536     "group": "Square_Recordings",
24537     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24538     "version": "0.0.0",
24539     "filename": "server/api/squareRecording/index.js",
24540     "groupTitle": "Square_Recordings"
24541   },
24542   {
24543     "type": "put",
24544     "url": "/api/square/recordings/{id}",
24545     "title": "Update an existing Recording",
24546     "examples": [
24547       {
24548         "title": "Example usage:",
24549         "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",
24550         "type": "json"
24551       }
24552     ],
24553     "name": "updateRecordings",
24554     "group": "Square_Recordings",
24555     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24556     "version": "0.0.0",
24557     "filename": "server/api/squareRecording/index.js",
24558     "groupTitle": "Square_Recordings"
24559   },
24560   {
24561     "type": "post",
24562     "url": "/api/square/reports",
24563     "title": "Creates a new Square Report",
24564     "examples": [
24565       {
24566         "title": "Example usage:",
24567         "content": "curl https://{domain}/api/square/reports -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
24568         "type": "json"
24569       }
24570     ],
24571     "name": "CreateSquare_Reports",
24572     "group": "Square_Reports",
24573     "parameter": {
24574       "fields": {
24575         "Body": [
24576           {
24577             "group": "Body",
24578             "type": "String",
24579             "optional": true,
24580             "field": "network",
24581             "description": ""
24582           },
24583           {
24584             "group": "Body",
24585             "type": "String",
24586             "optional": true,
24587             "field": "network_script",
24588             "description": ""
24589           },
24590           {
24591             "group": "Body",
24592             "type": "String",
24593             "optional": true,
24594             "field": "request",
24595             "description": ""
24596           },
24597           {
24598             "group": "Body",
24599             "type": "String",
24600             "optional": true,
24601             "field": "channel",
24602             "description": ""
24603           },
24604           {
24605             "group": "Body",
24606             "type": "String",
24607             "optional": true,
24608             "field": "language",
24609             "description": ""
24610           },
24611           {
24612             "group": "Body",
24613             "type": "String",
24614             "optional": true,
24615             "field": "type",
24616             "description": ""
24617           },
24618           {
24619             "group": "Body",
24620             "type": "String",
24621             "optional": true,
24622             "field": "uniqueid",
24623             "description": ""
24624           },
24625           {
24626             "group": "Body",
24627             "type": "String",
24628             "optional": true,
24629             "field": "version",
24630             "description": ""
24631           },
24632           {
24633             "group": "Body",
24634             "type": "String",
24635             "optional": true,
24636             "field": "callerid",
24637             "description": ""
24638           },
24639           {
24640             "group": "Body",
24641             "type": "String",
24642             "optional": true,
24643             "field": "calleridname",
24644             "description": ""
24645           },
24646           {
24647             "group": "Body",
24648             "type": "String",
24649             "optional": true,
24650             "field": "callingpres",
24651             "description": ""
24652           },
24653           {
24654             "group": "Body",
24655             "type": "String",
24656             "optional": true,
24657             "field": "callingani2",
24658             "description": ""
24659           },
24660           {
24661             "group": "Body",
24662             "type": "String",
24663             "optional": true,
24664             "field": "callington",
24665             "description": ""
24666           },
24667           {
24668             "group": "Body",
24669             "type": "String",
24670             "optional": true,
24671             "field": "callingtns",
24672             "description": ""
24673           },
24674           {
24675             "group": "Body",
24676             "type": "String",
24677             "optional": true,
24678             "field": "dnid",
24679             "description": ""
24680           },
24681           {
24682             "group": "Body",
24683             "type": "String",
24684             "optional": true,
24685             "field": "rdnis",
24686             "description": ""
24687           },
24688           {
24689             "group": "Body",
24690             "type": "String",
24691             "optional": true,
24692             "field": "context",
24693             "description": ""
24694           },
24695           {
24696             "group": "Body",
24697             "type": "String",
24698             "optional": true,
24699             "field": "extension",
24700             "description": ""
24701           },
24702           {
24703             "group": "Body",
24704             "type": "String",
24705             "optional": true,
24706             "field": "priority",
24707             "description": ""
24708           },
24709           {
24710             "group": "Body",
24711             "type": "String",
24712             "optional": true,
24713             "field": "enhanced",
24714             "description": ""
24715           },
24716           {
24717             "group": "Body",
24718             "type": "String",
24719             "optional": true,
24720             "field": "accountcode",
24721             "description": ""
24722           },
24723           {
24724             "group": "Body",
24725             "type": "String",
24726             "optional": true,
24727             "field": "threadid",
24728             "description": ""
24729           },
24730           {
24731             "group": "Body",
24732             "type": "String",
24733             "optional": true,
24734             "field": "project_name",
24735             "description": ""
24736           },
24737           {
24738             "group": "Body",
24739             "type": "String",
24740             "optional": true,
24741             "field": "joinAt",
24742             "description": ""
24743           },
24744           {
24745             "group": "Body",
24746             "type": "String",
24747             "optional": true,
24748             "field": "leaveAt",
24749             "description": ""
24750           },
24751           {
24752             "group": "Body",
24753             "type": "Boolean",
24754             "optional": true,
24755             "field": "bot",
24756             "description": ""
24757           }
24758         ]
24759       }
24760     },
24761     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24762     "version": "0.0.0",
24763     "filename": "server/api/squareReport/index.js",
24764     "groupTitle": "Square_Reports"
24765   },
24766   {
24767     "type": "delete",
24768     "url": "/api/square/reports/{id}",
24769     "title": "Deletes a Square Report",
24770     "examples": [
24771       {
24772         "title": "Example usage:",
24773         "content": "curl https://{domain}/api/square/reports/{id} -v -u {name}:{password} -X DELETE",
24774         "type": "json"
24775       }
24776     ],
24777     "name": "DeleteSquare_Reports",
24778     "group": "Square_Reports",
24779     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24780     "version": "0.0.0",
24781     "filename": "server/api/squareReport/index.js",
24782     "groupTitle": "Square_Reports"
24783   },
24784   {
24785     "type": "get",
24786     "url": "/api/square/reports/describe",
24787     "title": "Gets table info about Square Reports",
24788     "examples": [
24789       {
24790         "title": "Example usage:",
24791         "content": "curl https://{domain}/api/square/reports/describe -v -u {name}:{password}",
24792         "type": "json"
24793       }
24794     ],
24795     "name": "DescribeSquare_Reports",
24796     "group": "Square_Reports",
24797     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24798     "version": "0.0.0",
24799     "filename": "server/api/squareReport/index.js",
24800     "groupTitle": "Square_Reports"
24801   },
24802   {
24803     "type": "get",
24804     "url": "/api/square/reports",
24805     "title": "Gets a list of Square Reports",
24806     "examples": [
24807       {
24808         "title": "Example usage:",
24809         "content": "curl https://{domain}/api/square/reports -v -u {name}:{password}",
24810         "type": "json"
24811       }
24812     ],
24813     "name": "GetSquare_Reports",
24814     "group": "Square_Reports",
24815     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
24816     "version": "0.0.0",
24817     "filename": "server/api/squareReport/index.js",
24818     "groupTitle": "Square_Reports"
24819   },
24820   {
24821     "type": "get",
24822     "url": "/api/square/reports/{id}",
24823     "title": "Gets a single Square Report",
24824     "examples": [
24825       {
24826         "title": "Example usage:",
24827         "content": "curl https://{domain}/api/square/reports/{id} -v -u {name}:{password}",
24828         "type": "json"
24829       }
24830     ],
24831     "name": "ShowSquare_Reports",
24832     "group": "Square_Reports",
24833     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24834     "version": "0.0.0",
24835     "filename": "server/api/squareReport/index.js",
24836     "groupTitle": "Square_Reports"
24837   },
24838   {
24839     "type": "put",
24840     "url": "/api/square/reports/{id}",
24841     "title": "Update an existing Square Report",
24842     "examples": [
24843       {
24844         "title": "Example usage:",
24845         "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",
24846         "type": "json"
24847       }
24848     ],
24849     "name": "updateSquare_Reports",
24850     "group": "Square_Reports",
24851     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24852     "version": "0.0.0",
24853     "filename": "server/api/squareReport/index.js",
24854     "groupTitle": "Square_Reports"
24855   },
24856   {
24857     "type": "post",
24858     "url": "/api/integrations/sugarcrm/configurations",
24859     "title": "Creates a new SugarCRM Configuration",
24860     "examples": [
24861       {
24862         "title": "Example usage:",
24863         "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",
24864         "type": "json"
24865       }
24866     ],
24867     "name": "CreateSugarCRM_Configurations",
24868     "group": "SugarCRM_Configurations",
24869     "parameter": {
24870       "fields": {
24871         "Body": [
24872           {
24873             "group": "Body",
24874             "type": "String",
24875             "optional": true,
24876             "field": "name",
24877             "description": ""
24878           },
24879           {
24880             "group": "Body",
24881             "type": "String",
24882             "optional": true,
24883             "field": "description",
24884             "description": ""
24885           }
24886         ]
24887       }
24888     },
24889     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24890     "version": "0.0.0",
24891     "filename": "server/api/intSugarcrmConfiguration/index.js",
24892     "groupTitle": "SugarCRM_Configurations"
24893   },
24894   {
24895     "type": "delete",
24896     "url": "/api/integrations/sugarcrm/configurations/{id}",
24897     "title": "Deletes a SugarCRM Configuration",
24898     "examples": [
24899       {
24900         "title": "Example usage:",
24901         "content": "curl https://{domain}/api/integrations/sugarcrm/configurations/{id} -v -u {name}:{password} -X DELETE",
24902         "type": "json"
24903       }
24904     ],
24905     "name": "DeleteSugarCRM_Configurations",
24906     "group": "SugarCRM_Configurations",
24907     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <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/intSugarcrmConfiguration/index.js",
24910     "groupTitle": "SugarCRM_Configurations"
24911   },
24912   {
24913     "type": "get",
24914     "url": "/api/integrations/sugarcrm/configurations",
24915     "title": "Gets a list of SugarCRM Configurations",
24916     "examples": [
24917       {
24918         "title": "Example usage:",
24919         "content": "curl https://{domain}/api/integrations/sugarcrm/configurations -v -u {name}:{password}",
24920         "type": "json"
24921       }
24922     ],
24923     "name": "GetSugarCRM_Configurations",
24924     "group": "SugarCRM_Configurations",
24925     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
24926     "version": "0.0.0",
24927     "filename": "server/api/intSugarcrmConfiguration/index.js",
24928     "groupTitle": "SugarCRM_Configurations"
24929   },
24930   {
24931     "type": "get",
24932     "url": "/api/integrations/sugarcrm/configurations/{id}",
24933     "title": "Gets a single SugarCRM Configuration",
24934     "examples": [
24935       {
24936         "title": "Example usage:",
24937         "content": "curl https://{domain}/api/integrations/sugarcrm/configurations/{id} -v -u {name}:{password}",
24938         "type": "json"
24939       }
24940     ],
24941     "name": "ShowSugarCRM_Configurations",
24942     "group": "SugarCRM_Configurations",
24943     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24944     "version": "0.0.0",
24945     "filename": "server/api/intSugarcrmConfiguration/index.js",
24946     "groupTitle": "SugarCRM_Configurations"
24947   },
24948   {
24949     "type": "put",
24950     "url": "/api/integrations/sugarcrm/configurations/{id}",
24951     "title": "Update an existing SugarCRM Configuration",
24952     "examples": [
24953       {
24954         "title": "Example usage:",
24955         "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",
24956         "type": "json"
24957       }
24958     ],
24959     "name": "updateSugarCRM_Configurations",
24960     "group": "SugarCRM_Configurations",
24961     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24962     "version": "0.0.0",
24963     "filename": "server/api/intSugarcrmConfiguration/index.js",
24964     "groupTitle": "SugarCRM_Configurations"
24965   },
24966   {
24967     "type": "post",
24968     "url": "/api/integrations/sugarcrm/accounts",
24969     "title": "Creates a new Sugarcrm Account",
24970     "examples": [
24971       {
24972         "title": "Example usage:",
24973         "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",
24974         "type": "json"
24975       }
24976     ],
24977     "name": "CreateSugarcrm_Accounts",
24978     "group": "Sugarcrm_Accounts",
24979     "parameter": {
24980       "fields": {
24981         "Body": [
24982           {
24983             "group": "Body",
24984             "type": "String",
24985             "optional": true,
24986             "field": "name",
24987             "description": ""
24988           },
24989           {
24990             "group": "Body",
24991             "type": "String",
24992             "optional": true,
24993             "field": "description",
24994             "description": ""
24995           },
24996           {
24997             "group": "Body",
24998             "type": "String",
24999             "optional": true,
25000             "field": "username",
25001             "description": ""
25002           },
25003           {
25004             "group": "Body",
25005             "type": "String",
25006             "optional": true,
25007             "field": "password",
25008             "description": ""
25009           },
25010           {
25011             "group": "Body",
25012             "type": "String",
25013             "optional": true,
25014             "field": "remoteUri",
25015             "description": ""
25016           },
25017           {
25018             "group": "Body",
25019             "type": "String",
25020             "optional": true,
25021             "field": "serverUrl",
25022             "description": ""
25023           }
25024         ]
25025       }
25026     },
25027     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25028     "version": "0.0.0",
25029     "filename": "server/api/intSugarcrmAccount/index.js",
25030     "groupTitle": "Sugarcrm_Accounts"
25031   },
25032   {
25033     "type": "delete",
25034     "url": "/api/integrations/sugarcrm/accounts/{id}",
25035     "title": "Deletes a Sugarcrm Account",
25036     "examples": [
25037       {
25038         "title": "Example usage:",
25039         "content": "curl https://{domain}/api/integrations/sugarcrm/accounts/{id} -v -u {name}:{password} -X DELETE",
25040         "type": "json"
25041       }
25042     ],
25043     "name": "DeleteSugarcrm_Accounts",
25044     "group": "Sugarcrm_Accounts",
25045     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25046     "version": "0.0.0",
25047     "filename": "server/api/intSugarcrmAccount/index.js",
25048     "groupTitle": "Sugarcrm_Accounts"
25049   },
25050   {
25051     "type": "get",
25052     "url": "/api/integrations/sugarcrm/accounts",
25053     "title": "Gets a list of Sugarcrm Accounts",
25054     "examples": [
25055       {
25056         "title": "Example usage:",
25057         "content": "curl https://{domain}/api/integrations/sugarcrm/accounts -v -u {name}:{password}",
25058         "type": "json"
25059       }
25060     ],
25061     "name": "GetSugarcrm_Accounts",
25062     "group": "Sugarcrm_Accounts",
25063     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
25064     "version": "0.0.0",
25065     "filename": "server/api/intSugarcrmAccount/index.js",
25066     "groupTitle": "Sugarcrm_Accounts"
25067   },
25068   {
25069     "type": "get",
25070     "url": "/api/integrations/sugarcrm/accounts/{id}",
25071     "title": "Gets a single Sugarcrm Account",
25072     "examples": [
25073       {
25074         "title": "Example usage:",
25075         "content": "curl https://{domain}/api/integrations/sugarcrm/accounts/{id} -v -u {name}:{password}",
25076         "type": "json"
25077       }
25078     ],
25079     "name": "ShowSugarcrm_Accounts",
25080     "group": "Sugarcrm_Accounts",
25081     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25082     "version": "0.0.0",
25083     "filename": "server/api/intSugarcrmAccount/index.js",
25084     "groupTitle": "Sugarcrm_Accounts"
25085   },
25086   {
25087     "type": "post",
25088     "url": "/api/integrations/sugarcrm/accounts/{id}/configurations",
25089     "title": "Creates new configuration",
25090     "examples": [
25091       {
25092         "title": "Example usage:",
25093         "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",
25094         "type": "json"
25095       }
25096     ],
25097     "name": "addConfiguration",
25098     "group": "Sugarcrm_Accounts",
25099     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25100     "version": "0.0.0",
25101     "filename": "server/api/intSugarcrmAccount/index.js",
25102     "groupTitle": "Sugarcrm_Accounts"
25103   },
25104   {
25105     "type": "get",
25106     "url": "/api/integrations/sugarcrm/accounts/{id}/configurations",
25107     "title": "Gets account configurations",
25108     "examples": [
25109       {
25110         "title": "Example usage:",
25111         "content": "curl https://{domain}/api/integrations/sugarcrm/accounts/{id}/configurations -v -u {name}:{password} -X GET",
25112         "type": "json"
25113       }
25114     ],
25115     "name": "getConfigurations",
25116     "group": "Sugarcrm_Accounts",
25117     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25118     "version": "0.0.0",
25119     "filename": "server/api/intSugarcrmAccount/index.js",
25120     "groupTitle": "Sugarcrm_Accounts"
25121   },
25122   {
25123     "type": "get",
25124     "url": "/api/integrations/sugarcrm/accounts/{id}/fields",
25125     "title": "Gets account fields",
25126     "examples": [
25127       {
25128         "title": "Example usage:",
25129         "content": "curl https://{domain}/api/integrations/sugarcrm/accounts/{id}/fields -v -u {name}:{password} -X GET",
25130         "type": "json"
25131       }
25132     ],
25133     "name": "getFields",
25134     "group": "Sugarcrm_Accounts",
25135     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25136     "version": "0.0.0",
25137     "filename": "server/api/intSugarcrmAccount/index.js",
25138     "groupTitle": "Sugarcrm_Accounts"
25139   },
25140   {
25141     "type": "put",
25142     "url": "/api/integrations/sugarcrm/accounts/{id}",
25143     "title": "Update an existing Sugarcrm Account",
25144     "examples": [
25145       {
25146         "title": "Example usage:",
25147         "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",
25148         "type": "json"
25149       }
25150     ],
25151     "name": "updateSugarcrm_Accounts",
25152     "group": "Sugarcrm_Accounts",
25153     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25154     "version": "0.0.0",
25155     "filename": "server/api/intSugarcrmAccount/index.js",
25156     "groupTitle": "Sugarcrm_Accounts"
25157   },
25158   {
25159     "type": "get",
25160     "url": "/api/integrations/sugarcrm/configurations/{id}/descriptions",
25161     "title": "Gets configurations descriptions",
25162     "examples": [
25163       {
25164         "title": "Example usage:",
25165         "content": "curl https://{domain}/api/integrations/sugarcrm/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
25166         "type": "json"
25167       }
25168     ],
25169     "name": "getDescriptions",
25170     "group": "Sugarcrm_Configurations",
25171     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25172     "version": "0.0.0",
25173     "filename": "server/api/intSugarcrmConfiguration/index.js",
25174     "groupTitle": "Sugarcrm_Configurations"
25175   },
25176   {
25177     "type": "get",
25178     "url": "/api/integrations/sugarcrm/configurations/{id}/fields",
25179     "title": "Gets configurations fields",
25180     "examples": [
25181       {
25182         "title": "Example usage:",
25183         "content": "curl https://{domain}/api/integrations/sugarcrm/configurations/{id}/fields -v -u {name}:{password} -X GET",
25184         "type": "json"
25185       }
25186     ],
25187     "name": "getFields",
25188     "group": "Sugarcrm_Configurations",
25189     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25190     "version": "0.0.0",
25191     "filename": "server/api/intSugarcrmConfiguration/index.js",
25192     "groupTitle": "Sugarcrm_Configurations"
25193   },
25194   {
25195     "type": "get",
25196     "url": "/api/integrations/sugarcrm/configurations/{id}/subjects",
25197     "title": "Gets configurations subjects",
25198     "examples": [
25199       {
25200         "title": "Example usage:",
25201         "content": "curl https://{domain}/api/integrations/sugarcrm/configurations/{id}/subjects -v -u {name}:{password} -X GET",
25202         "type": "json"
25203       }
25204     ],
25205     "name": "getSubjects",
25206     "group": "Sugarcrm_Configurations",
25207     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25208     "version": "0.0.0",
25209     "filename": "server/api/intSugarcrmConfiguration/index.js",
25210     "groupTitle": "Sugarcrm_Configurations"
25211   },
25212   {
25213     "type": "post",
25214     "url": "/api/integrations/sugarcrm/fields",
25215     "title": "Creates a new Sugarcrm Field",
25216     "examples": [
25217       {
25218         "title": "Example usage:",
25219         "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",
25220         "type": "json"
25221       }
25222     ],
25223     "name": "CreateSugarcrm_Fields",
25224     "group": "Sugarcrm_Fields",
25225     "parameter": {
25226       "fields": {
25227         "Body": [
25228           {
25229             "group": "Body",
25230             "type": "String",
25231             "allowedValues": [
25232               "\"string\"",
25233               "\"variable\"",
25234               "\"customVariable\"",
25235               "\"keyValue\""
25236             ],
25237             "optional": true,
25238             "field": "type",
25239             "description": ""
25240           },
25241           {
25242             "group": "Body",
25243             "type": "String",
25244             "optional": true,
25245             "field": "content",
25246             "description": ""
25247           },
25248           {
25249             "group": "Body",
25250             "type": "String",
25251             "optional": true,
25252             "field": "key",
25253             "description": ""
25254           },
25255           {
25256             "group": "Body",
25257             "type": "String",
25258             "allowedValues": [
25259               "\"string\"",
25260               "\"variable\"",
25261               "\"customVariable\""
25262             ],
25263             "optional": true,
25264             "field": "keyType",
25265             "description": ""
25266           },
25267           {
25268             "group": "Body",
25269             "type": "String",
25270             "optional": true,
25271             "field": "keyContent",
25272             "description": ""
25273           },
25274           {
25275             "group": "Body",
25276             "type": "String",
25277             "optional": true,
25278             "field": "idField",
25279             "description": ""
25280           },
25281           {
25282             "group": "Body",
25283             "type": "String",
25284             "optional": true,
25285             "field": "nameField",
25286             "description": ""
25287           },
25288           {
25289             "group": "Body",
25290             "type": "Boolean",
25291             "optional": true,
25292             "field": "customField",
25293             "description": ""
25294           },
25295           {
25296             "group": "Body",
25297             "type": "String",
25298             "optional": true,
25299             "field": "variableName",
25300             "description": ""
25301           }
25302         ]
25303       }
25304     },
25305     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25306     "version": "0.0.0",
25307     "filename": "server/api/intSugarcrmField/index.js",
25308     "groupTitle": "Sugarcrm_Fields"
25309   },
25310   {
25311     "type": "delete",
25312     "url": "/api/integrations/sugarcrm/fields/{id}",
25313     "title": "Deletes a Sugarcrm Field",
25314     "examples": [
25315       {
25316         "title": "Example usage:",
25317         "content": "curl https://{domain}/api/integrations/sugarcrm/fields/{id} -v -u {name}:{password} -X DELETE",
25318         "type": "json"
25319       }
25320     ],
25321     "name": "DeleteSugarcrm_Fields",
25322     "group": "Sugarcrm_Fields",
25323     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25324     "version": "0.0.0",
25325     "filename": "server/api/intSugarcrmField/index.js",
25326     "groupTitle": "Sugarcrm_Fields"
25327   },
25328   {
25329     "type": "get",
25330     "url": "/api/integrations/sugarcrm/fields",
25331     "title": "Gets a list of Sugarcrm Fields",
25332     "examples": [
25333       {
25334         "title": "Example usage:",
25335         "content": "curl https://{domain}/api/integrations/sugarcrm/fields -v -u {name}:{password}",
25336         "type": "json"
25337       }
25338     ],
25339     "name": "GetSugarcrm_Fields",
25340     "group": "Sugarcrm_Fields",
25341     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
25342     "version": "0.0.0",
25343     "filename": "server/api/intSugarcrmField/index.js",
25344     "groupTitle": "Sugarcrm_Fields"
25345   },
25346   {
25347     "type": "get",
25348     "url": "/api/integrations/sugarcrm/fields/{id}",
25349     "title": "Gets a single Sugarcrm Field",
25350     "examples": [
25351       {
25352         "title": "Example usage:",
25353         "content": "curl https://{domain}/api/integrations/sugarcrm/fields/{id} -v -u {name}:{password}",
25354         "type": "json"
25355       }
25356     ],
25357     "name": "ShowSugarcrm_Fields",
25358     "group": "Sugarcrm_Fields",
25359     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25360     "version": "0.0.0",
25361     "filename": "server/api/intSugarcrmField/index.js",
25362     "groupTitle": "Sugarcrm_Fields"
25363   },
25364   {
25365     "type": "put",
25366     "url": "/api/integrations/sugarcrm/fields/{id}",
25367     "title": "Update an existing Sugarcrm Field",
25368     "examples": [
25369       {
25370         "title": "Example usage:",
25371         "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",
25372         "type": "json"
25373       }
25374     ],
25375     "name": "updateSugarcrm_Fields",
25376     "group": "Sugarcrm_Fields",
25377     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25378     "version": "0.0.0",
25379     "filename": "server/api/intSugarcrmField/index.js",
25380     "groupTitle": "Sugarcrm_Fields"
25381   },
25382   {
25383     "type": "get",
25384     "url": "/api/system",
25385     "title": "Gets system information",
25386     "examples": [
25387       {
25388         "title": "Example usage:",
25389         "content": "curl https://{domain}/api/system -v -u {name}:{password}",
25390         "type": "json"
25391       }
25392     ],
25393     "name": "GetSystemInformation",
25394     "group": "System_Information",
25395     "description": "<p>Motion returns the system information.</p>",
25396     "version": "0.0.0",
25397     "filename": "server/api/system/index.js",
25398     "groupTitle": "System_Information"
25399   },
25400   {
25401     "type": "get",
25402     "url": "/api/system/process",
25403     "title": "Gets system information",
25404     "examples": [
25405       {
25406         "title": "Example usage:",
25407         "content": "curl https://{domain}/api/system -v -u {name}:{password}",
25408         "type": "json"
25409       }
25410     ],
25411     "name": "GetSystemInformation",
25412     "group": "System_Information",
25413     "description": "<p>Motion returns the system information.</p>",
25414     "version": "0.0.0",
25415     "filename": "server/api/system/index.js",
25416     "groupTitle": "System_Information"
25417   },
25418   {
25419     "type": "post",
25420     "url": "/api/tags",
25421     "title": "Creates a new Tag",
25422     "examples": [
25423       {
25424         "title": "Example usage:",
25425         "content": "curl https://{domain}/api/tags -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
25426         "type": "json"
25427       }
25428     ],
25429     "name": "CreateTags",
25430     "group": "Tags",
25431     "parameter": {
25432       "fields": {
25433         "Body": [
25434           {
25435             "group": "Body",
25436             "type": "String",
25437             "optional": false,
25438             "field": "name",
25439             "description": ""
25440           },
25441           {
25442             "group": "Body",
25443             "type": "String",
25444             "optional": true,
25445             "field": "color",
25446             "description": ""
25447           },
25448           {
25449             "group": "Body",
25450             "type": "String",
25451             "optional": true,
25452             "field": "description",
25453             "description": ""
25454           }
25455         ]
25456       }
25457     },
25458     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25459     "version": "0.0.0",
25460     "filename": "server/api/tag/index.js",
25461     "groupTitle": "Tags"
25462   },
25463   {
25464     "type": "delete",
25465     "url": "/api/tags/{id}",
25466     "title": "Deletes a Tag",
25467     "examples": [
25468       {
25469         "title": "Example usage:",
25470         "content": "curl https://{domain}/api/tags/{id} -v -u {name}:{password} -X DELETE",
25471         "type": "json"
25472       }
25473     ],
25474     "name": "DeleteTags",
25475     "group": "Tags",
25476     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25477     "version": "0.0.0",
25478     "filename": "server/api/tag/index.js",
25479     "groupTitle": "Tags"
25480   },
25481   {
25482     "type": "get",
25483     "url": "/api/tags",
25484     "title": "Gets a list of Tags",
25485     "examples": [
25486       {
25487         "title": "Example usage:",
25488         "content": "curl https://{domain}/api/tags -v -u {name}:{password}",
25489         "type": "json"
25490       }
25491     ],
25492     "name": "GetTags",
25493     "group": "Tags",
25494     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
25495     "version": "0.0.0",
25496     "filename": "server/api/tag/index.js",
25497     "groupTitle": "Tags"
25498   },
25499   {
25500     "type": "get",
25501     "url": "/api/tags/{id}",
25502     "title": "Gets a single Tag",
25503     "examples": [
25504       {
25505         "title": "Example usage:",
25506         "content": "curl https://{domain}/api/tags/{id} -v -u {name}:{password}",
25507         "type": "json"
25508       }
25509     ],
25510     "name": "ShowTags",
25511     "group": "Tags",
25512     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25513     "version": "0.0.0",
25514     "filename": "server/api/tag/index.js",
25515     "groupTitle": "Tags"
25516   },
25517   {
25518     "type": "put",
25519     "url": "/api/tags/{id}",
25520     "title": "Update an existing Tag",
25521     "examples": [
25522       {
25523         "title": "Example usage:",
25524         "content": "curl https://{domain}/api/tags/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
25525         "type": "json"
25526       }
25527     ],
25528     "name": "updateTags",
25529     "group": "Tags",
25530     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25531     "version": "0.0.0",
25532     "filename": "server/api/tag/index.js",
25533     "groupTitle": "Tags"
25534   },
25535   {
25536     "type": "post",
25537     "url": "/api/teams/{id}/queues",
25538     "title": "Add queues to a team",
25539     "examples": [
25540       {
25541         "title": "Example usage:",
25542         "content": "curl https://{domain}/api/teams/{id}/queues -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
25543         "type": "json"
25544       }
25545     ],
25546     "name": "AddQueues",
25547     "group": "Teams",
25548     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25549     "version": "0.0.0",
25550     "filename": "server/api/team/index.js",
25551     "groupTitle": "Teams"
25552   },
25553   {
25554     "type": "post",
25555     "url": "/api/teams",
25556     "title": "Creates a new Team",
25557     "examples": [
25558       {
25559         "title": "Example usage:",
25560         "content": "curl https://{domain}/api/teams -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
25561         "type": "json"
25562       }
25563     ],
25564     "name": "CreateTeams",
25565     "group": "Teams",
25566     "parameter": {
25567       "fields": {
25568         "Body": [
25569           {
25570             "group": "Body",
25571             "type": "String",
25572             "optional": false,
25573             "field": "name",
25574             "description": ""
25575           },
25576           {
25577             "group": "Body",
25578             "type": "String",
25579             "optional": true,
25580             "field": "description",
25581             "description": ""
25582           }
25583         ]
25584       }
25585     },
25586     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25587     "version": "0.0.0",
25588     "filename": "server/api/team/index.js",
25589     "groupTitle": "Teams"
25590   },
25591   {
25592     "type": "delete",
25593     "url": "/api/teams/{id}",
25594     "title": "Deletes a Team",
25595     "examples": [
25596       {
25597         "title": "Example usage:",
25598         "content": "curl https://{domain}/api/teams/{id} -v -u {name}:{password} -X DELETE",
25599         "type": "json"
25600       }
25601     ],
25602     "name": "DeleteTeams",
25603     "group": "Teams",
25604     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25605     "version": "0.0.0",
25606     "filename": "server/api/team/index.js",
25607     "groupTitle": "Teams"
25608   },
25609   {
25610     "type": "get",
25611     "url": "/api/teams/{id}/users",
25612     "title": "Gets agents from team",
25613     "examples": [
25614       {
25615         "title": "Example usage:",
25616         "content": "curl https://{domain}/api/teams/{id}/users -v -u {name}:{password} -X GET",
25617         "type": "json"
25618       }
25619     ],
25620     "name": "GetAgents",
25621     "group": "Teams",
25622     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25623     "version": "0.0.0",
25624     "filename": "server/api/team/index.js",
25625     "groupTitle": "Teams"
25626   },
25627   {
25628     "type": "get",
25629     "url": "/api/teams/{id}/queues?channel={channel}",
25630     "title": "Gets Queues list",
25631     "examples": [
25632       {
25633         "title": "Example usage:",
25634         "content": "curl https://{domain}/api/teams/{id}/queues?channel={channel} -v -u {name}:{password}",
25635         "type": "json"
25636       }
25637     ],
25638     "name": "GetQueues",
25639     "group": "Teams",
25640     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25641     "version": "0.0.0",
25642     "filename": "server/api/team/index.js",
25643     "groupTitle": "Teams"
25644   },
25645   {
25646     "type": "get",
25647     "url": "/api/teams",
25648     "title": "Gets a list of Teams",
25649     "examples": [
25650       {
25651         "title": "Example usage:",
25652         "content": "curl https://{domain}/api/teams -v -u {name}:{password}",
25653         "type": "json"
25654       }
25655     ],
25656     "name": "GetTeams",
25657     "group": "Teams",
25658     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
25659     "version": "0.0.0",
25660     "filename": "server/api/team/index.js",
25661     "groupTitle": "Teams"
25662   },
25663   {
25664     "type": "delete",
25665     "url": "/api/teams/{id}/users",
25666     "title": "Removes agents from a team",
25667     "examples": [
25668       {
25669         "title": "Example usage:",
25670         "content": "curl https://{domain}/api/teams/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
25671         "type": "json"
25672       }
25673     ],
25674     "name": "RemoveAgents",
25675     "group": "Teams",
25676     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25677     "version": "0.0.0",
25678     "filename": "server/api/team/index.js",
25679     "groupTitle": "Teams"
25680   },
25681   {
25682     "type": "delete",
25683     "url": "/api/teams/{id}/queues",
25684     "title": "Remove queues to a team",
25685     "examples": [
25686       {
25687         "title": "Example usage:",
25688         "content": "curl https://{domain}/api/teams/{id}/queues?channel=voice&ids=1&ids=2 -v -u {name}:{password} -X DELETE",
25689         "type": "json"
25690       }
25691     ],
25692     "name": "RemoveQueues",
25693     "group": "Teams",
25694     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25695     "version": "0.0.0",
25696     "filename": "server/api/team/index.js",
25697     "groupTitle": "Teams"
25698   },
25699   {
25700     "type": "delete",
25701     "url": "/api/mail/queues/{id}/teams",
25702     "title": "Remove teams from a queue",
25703     "examples": [
25704       {
25705         "title": "Example usage:",
25706         "content": "curl https://{domain}/api/mail/queues/{id}/teams -v -u {name}:{password} -X DELETE",
25707         "type": "json"
25708       }
25709     ],
25710     "name": "RemoveTeams",
25711     "group": "Teams",
25712     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25713     "version": "0.0.0",
25714     "filename": "server/api/mailQueue/index.js",
25715     "groupTitle": "Teams"
25716   },
25717   {
25718     "type": "delete",
25719     "url": "/api/openchannel/queues/{id}/teams",
25720     "title": "Remove teams from a queue",
25721     "examples": [
25722       {
25723         "title": "Example usage:",
25724         "content": "curl https://{domain}/api/openchannel/queues/{id}/teams -v -u {name}:{password} -X DELETE",
25725         "type": "json"
25726       }
25727     ],
25728     "name": "RemoveTeams",
25729     "group": "Teams",
25730     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25731     "version": "0.0.0",
25732     "filename": "server/api/openchannelQueue/index.js",
25733     "groupTitle": "Teams"
25734   },
25735   {
25736     "type": "delete",
25737     "url": "/api/whatsapp/queues/{id}/teams",
25738     "title": "Remove teams from a queue",
25739     "examples": [
25740       {
25741         "title": "Example usage:",
25742         "content": "curl https://{domain}/api/whatsapp/queues/{id}/teams -v -u {name}:{password} -X DELETE",
25743         "type": "json"
25744       }
25745     ],
25746     "name": "RemoveTeams",
25747     "group": "Teams",
25748     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25749     "version": "0.0.0",
25750     "filename": "server/api/whatsappQueue/index.js",
25751     "groupTitle": "Teams"
25752   },
25753   {
25754     "type": "delete",
25755     "url": "/api/sms/queues/{id}/teams",
25756     "title": "Remove teams from a queue",
25757     "examples": [
25758       {
25759         "title": "Example usage:",
25760         "content": "curl https://{domain}/api/sms/queues/{id}/teams -v -u {name}:{password} -X DELETE",
25761         "type": "json"
25762       }
25763     ],
25764     "name": "RemoveTeams",
25765     "group": "Teams",
25766     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25767     "version": "0.0.0",
25768     "filename": "server/api/smsQueue/index.js",
25769     "groupTitle": "Teams"
25770   },
25771   {
25772     "type": "delete",
25773     "url": "/api/voice/queues/{id}/teams",
25774     "title": "Remove teams from a queue",
25775     "examples": [
25776       {
25777         "title": "Example usage:",
25778         "content": "curl https://{domain}/api/voice/queues/{id}/teams -v -u {name}:{password} -X DELETE",
25779         "type": "json"
25780       }
25781     ],
25782     "name": "RemoveTeams",
25783     "group": "Teams",
25784     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25785     "version": "0.0.0",
25786     "filename": "server/api/voiceQueue/index.js",
25787     "groupTitle": "Teams"
25788   },
25789   {
25790     "type": "delete",
25791     "url": "/api/chat/queues/{id}/teams",
25792     "title": "Remove teams from a queue",
25793     "examples": [
25794       {
25795         "title": "Example usage:",
25796         "content": "curl https://{domain}/api/chat/queues/{id}/teams -v -u {name}:{password} -X DELETE",
25797         "type": "json"
25798       }
25799     ],
25800     "name": "RemoveTeams",
25801     "group": "Teams",
25802     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25803     "version": "0.0.0",
25804     "filename": "server/api/chatQueue/index.js",
25805     "groupTitle": "Teams"
25806   },
25807   {
25808     "type": "delete",
25809     "url": "/api/fax/queues/{id}/teams",
25810     "title": "Remove teams from a queue",
25811     "examples": [
25812       {
25813         "title": "Example usage:",
25814         "content": "curl https://{domain}/api/fax/queues/{id}/teams -v -u {name}:{password} -X DELETE",
25815         "type": "json"
25816       }
25817     ],
25818     "name": "RemoveTeams",
25819     "group": "Teams",
25820     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25821     "version": "0.0.0",
25822     "filename": "server/api/faxQueue/index.js",
25823     "groupTitle": "Teams"
25824   },
25825   {
25826     "type": "get",
25827     "url": "/api/teams/{id}",
25828     "title": "Gets a single Team",
25829     "examples": [
25830       {
25831         "title": "Example usage:",
25832         "content": "curl https://{domain}/api/teams/{id} -v -u {name}:{password}",
25833         "type": "json"
25834       }
25835     ],
25836     "name": "ShowTeams",
25837     "group": "Teams",
25838     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25839     "version": "0.0.0",
25840     "filename": "server/api/team/index.js",
25841     "groupTitle": "Teams"
25842   },
25843   {
25844     "type": "post",
25845     "url": "/api/teams/{id}/users",
25846     "title": "Adds agents to a team",
25847     "examples": [
25848       {
25849         "title": "Example usage:",
25850         "content": "curl https://{domain}/api/teams/{id}/users -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
25851         "type": "json"
25852       }
25853     ],
25854     "name": "addAgents",
25855     "group": "Teams",
25856     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25857     "version": "0.0.0",
25858     "filename": "server/api/team/index.js",
25859     "groupTitle": "Teams"
25860   },
25861   {
25862     "type": "put",
25863     "url": "/api/teams/{id}",
25864     "title": "Update an existing Team",
25865     "examples": [
25866       {
25867         "title": "Example usage:",
25868         "content": "curl https://{domain}/api/teams/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
25869         "type": "json"
25870       }
25871     ],
25872     "name": "updateTeams",
25873     "group": "Teams",
25874     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25875     "version": "0.0.0",
25876     "filename": "server/api/team/index.js",
25877     "groupTitle": "Teams"
25878   },
25879   {
25880     "type": "post",
25881     "url": "/api/templates",
25882     "title": "Creates a new Template",
25883     "examples": [
25884       {
25885         "title": "Example usage:",
25886         "content": "curl https://{domain}/api/templates -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
25887         "type": "json"
25888       }
25889     ],
25890     "name": "CreateTemplates",
25891     "group": "Templates",
25892     "parameter": {
25893       "fields": {
25894         "Body": [
25895           {
25896             "group": "Body",
25897             "type": "String",
25898             "optional": true,
25899             "field": "name",
25900             "description": ""
25901           },
25902           {
25903             "group": "Body",
25904             "type": "String",
25905             "optional": true,
25906             "field": "description",
25907             "description": ""
25908           },
25909           {
25910             "group": "Body",
25911             "type": "Text",
25912             "optional": true,
25913             "field": "html",
25914             "description": ""
25915           }
25916         ]
25917       }
25918     },
25919     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25920     "version": "0.0.0",
25921     "filename": "server/api/template/index.js",
25922     "groupTitle": "Templates"
25923   },
25924   {
25925     "type": "delete",
25926     "url": "/api/templates/{id}",
25927     "title": "Deletes a Template",
25928     "examples": [
25929       {
25930         "title": "Example usage:",
25931         "content": "curl https://{domain}/api/templates/{id} -v -u {name}:{password} -X DELETE",
25932         "type": "json"
25933       }
25934     ],
25935     "name": "DeleteTemplates",
25936     "group": "Templates",
25937     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25938     "version": "0.0.0",
25939     "filename": "server/api/template/index.js",
25940     "groupTitle": "Templates"
25941   },
25942   {
25943     "type": "get",
25944     "url": "/api/templates",
25945     "title": "Gets a list of Templates",
25946     "examples": [
25947       {
25948         "title": "Example usage:",
25949         "content": "curl https://{domain}/api/templates -v -u {name}:{password}",
25950         "type": "json"
25951       }
25952     ],
25953     "name": "GetTemplates",
25954     "group": "Templates",
25955     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
25956     "version": "0.0.0",
25957     "filename": "server/api/template/index.js",
25958     "groupTitle": "Templates"
25959   },
25960   {
25961     "type": "get",
25962     "url": "/api/templates/{id}",
25963     "title": "Gets a single Template",
25964     "examples": [
25965       {
25966         "title": "Example usage:",
25967         "content": "curl https://{domain}/api/templates/{id} -v -u {name}:{password}",
25968         "type": "json"
25969       }
25970     ],
25971     "name": "ShowTemplates",
25972     "group": "Templates",
25973     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25974     "version": "0.0.0",
25975     "filename": "server/api/template/index.js",
25976     "groupTitle": "Templates"
25977   },
25978   {
25979     "type": "put",
25980     "url": "/api/templates/{id}",
25981     "title": "Update an existing Template",
25982     "examples": [
25983       {
25984         "title": "Example usage:",
25985         "content": "curl https://{domain}/api/templates/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
25986         "type": "json"
25987       }
25988     ],
25989     "name": "updateTemplates",
25990     "group": "Templates",
25991     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25992     "version": "0.0.0",
25993     "filename": "server/api/template/index.js",
25994     "groupTitle": "Templates"
25995   },
25996   {
25997     "type": "post",
25998     "url": "/api/triggers",
25999     "title": "Creates a new Trigger",
26000     "examples": [
26001       {
26002         "title": "Example usage:",
26003         "content": "curl https://{domain}/api/triggers -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
26004         "type": "json"
26005       }
26006     ],
26007     "name": "CreateTriggers",
26008     "group": "Triggers",
26009     "parameter": {
26010       "fields": {
26011         "Body": [
26012           {
26013             "group": "Body",
26014             "type": "String",
26015             "optional": true,
26016             "field": "name",
26017             "description": ""
26018           },
26019           {
26020             "group": "Body",
26021             "type": "String",
26022             "optional": true,
26023             "field": "channel",
26024             "description": ""
26025           },
26026           {
26027             "group": "Body",
26028             "type": "String",
26029             "optional": true,
26030             "field": "description",
26031             "description": ""
26032           },
26033           {
26034             "group": "Body",
26035             "type": "Boolean",
26036             "optional": true,
26037             "field": "status",
26038             "description": ""
26039           }
26040         ]
26041       }
26042     },
26043     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26044     "version": "0.0.0",
26045     "filename": "server/api/trigger/index.js",
26046     "groupTitle": "Triggers"
26047   },
26048   {
26049     "type": "delete",
26050     "url": "/api/triggers/{id}",
26051     "title": "Deletes a Trigger",
26052     "examples": [
26053       {
26054         "title": "Example usage:",
26055         "content": "curl https://{domain}/api/triggers/{id} -v -u {name}:{password} -X DELETE",
26056         "type": "json"
26057       }
26058     ],
26059     "name": "DeleteTriggers",
26060     "group": "Triggers",
26061     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26062     "version": "0.0.0",
26063     "filename": "server/api/trigger/index.js",
26064     "groupTitle": "Triggers"
26065   },
26066   {
26067     "type": "get",
26068     "url": "/api/triggers",
26069     "title": "Gets a list of Triggers",
26070     "examples": [
26071       {
26072         "title": "Example usage:",
26073         "content": "curl https://{domain}/api/triggers -v -u {name}:{password}",
26074         "type": "json"
26075       }
26076     ],
26077     "name": "GetTriggers",
26078     "group": "Triggers",
26079     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
26080     "version": "0.0.0",
26081     "filename": "server/api/trigger/index.js",
26082     "groupTitle": "Triggers"
26083   },
26084   {
26085     "type": "get",
26086     "url": "/api/triggers/{id}",
26087     "title": "Gets a single Trigger",
26088     "examples": [
26089       {
26090         "title": "Example usage:",
26091         "content": "curl https://{domain}/api/triggers/{id} -v -u {name}:{password}",
26092         "type": "json"
26093       }
26094     ],
26095     "name": "ShowTriggers",
26096     "group": "Triggers",
26097     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26098     "version": "0.0.0",
26099     "filename": "server/api/trigger/index.js",
26100     "groupTitle": "Triggers"
26101   },
26102   {
26103     "type": "post",
26104     "url": "/api/triggers/{id}/actions",
26105     "title": "Creates new actions",
26106     "examples": [
26107       {
26108         "title": "Example usage:",
26109         "content": "curl https://{domain}/api/triggers/{id}/actions -d '{\"action\": \"contactManager\",\"data1\": \"1\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
26110         "type": "json"
26111       }
26112     ],
26113     "name": "addAction",
26114     "group": "Triggers",
26115     "parameter": {
26116       "fields": {
26117         "Body": [
26118           {
26119             "group": "Body",
26120             "type": "Virtual",
26121             "optional": true,
26122             "field": "name",
26123             "description": ""
26124           },
26125           {
26126             "group": "Body",
26127             "type": "String",
26128             "optional": false,
26129             "field": "action",
26130             "description": "<p>Allowed values: contactManager, integration, motionbar, jscripty, urlForward, browser, bot, script</p>"
26131           },
26132           {
26133             "group": "Body",
26134             "type": "String",
26135             "optional": true,
26136             "field": "data1",
26137             "description": "<p>contactManager[ListId], integration[intName(zendesk)], motionbar[Popup(0),URL(1),WinApp(2)], urlForward[GET,POST], browser[TemplateId(0),URL(1)]</p>"
26138           },
26139           {
26140             "group": "Body",
26141             "type": "String",
26142             "optional": true,
26143             "field": "data2",
26144             "description": "<p>integration[AccountId], motionbar[TemplateId,URL,WinAppPath], urlForward[URL]</p>"
26145           },
26146           {
26147             "group": "Body",
26148             "type": "String",
26149             "optional": true,
26150             "field": "data3",
26151             "description": "<p>motionbar[NULL,NULL,WinAppArguments]</p>"
26152           },
26153           {
26154             "group": "Body",
26155             "type": "String",
26156             "optional": true,
26157             "field": "data4",
26158             "description": ""
26159           },
26160           {
26161             "group": "Body",
26162             "type": "String",
26163             "optional": true,
26164             "field": "data5",
26165             "description": ""
26166           },
26167           {
26168             "group": "Body",
26169             "type": "String",
26170             "optional": true,
26171             "field": "data6",
26172             "description": ""
26173           },
26174           {
26175             "group": "Body",
26176             "type": "Text",
26177             "optional": true,
26178             "field": "data7",
26179             "description": ""
26180           }
26181         ]
26182       }
26183     },
26184     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26185     "version": "0.0.0",
26186     "filename": "server/api/trigger/index.js",
26187     "groupTitle": "Triggers"
26188   },
26189   {
26190     "type": "post",
26191     "url": "/api/triggers/{id}/all_conditions",
26192     "title": "Creates a new \"AND\"condition",
26193     "examples": [
26194       {
26195         "title": "Example usage:",
26196         "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",
26197         "type": "json"
26198       }
26199     ],
26200     "name": "addAllCondition",
26201     "group": "Triggers",
26202     "parameter": {
26203       "fields": {
26204         "Body": [
26205           {
26206             "group": "Body",
26207             "type": "Virtual",
26208             "optional": true,
26209             "field": "name",
26210             "description": ""
26211           },
26212           {
26213             "group": "Body",
26214             "type": "String",
26215             "optional": false,
26216             "field": "field",
26217             "description": ""
26218           },
26219           {
26220             "group": "Body",
26221             "type": "String",
26222             "optional": false,
26223             "field": "operator",
26224             "description": ""
26225           },
26226           {
26227             "group": "Body",
26228             "type": "String",
26229             "optional": false,
26230             "field": "value",
26231             "description": ""
26232           }
26233         ]
26234       }
26235     },
26236     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26237     "version": "0.0.0",
26238     "filename": "server/api/trigger/index.js",
26239     "groupTitle": "Triggers"
26240   },
26241   {
26242     "type": "post",
26243     "url": "/api/triggers/{id}/any_conditions",
26244     "title": "Creates a new \"OR\"condition",
26245     "examples": [
26246       {
26247         "title": "Example usage:",
26248         "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",
26249         "type": "json"
26250       }
26251     ],
26252     "name": "addAnyCondition",
26253     "group": "Triggers",
26254     "parameter": {
26255       "fields": {
26256         "Body": [
26257           {
26258             "group": "Body",
26259             "type": "Virtual",
26260             "optional": true,
26261             "field": "name",
26262             "description": ""
26263           },
26264           {
26265             "group": "Body",
26266             "type": "String",
26267             "optional": false,
26268             "field": "field",
26269             "description": ""
26270           },
26271           {
26272             "group": "Body",
26273             "type": "String",
26274             "optional": false,
26275             "field": "operator",
26276             "description": ""
26277           },
26278           {
26279             "group": "Body",
26280             "type": "String",
26281             "optional": false,
26282             "field": "value",
26283             "description": ""
26284           }
26285         ]
26286       }
26287     },
26288     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26289     "version": "0.0.0",
26290     "filename": "server/api/trigger/index.js",
26291     "groupTitle": "Triggers"
26292   },
26293   {
26294     "type": "get",
26295     "url": "/api/triggers/{id}/actions",
26296     "title": "Gets Trigger Actions",
26297     "examples": [
26298       {
26299         "title": "Example usage:",
26300         "content": "curl https://{domain}/api/triggers/{id}/actions -v -u {name}:{password} -X GET",
26301         "type": "json"
26302       }
26303     ],
26304     "name": "getActions",
26305     "group": "Triggers",
26306     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26307     "version": "0.0.0",
26308     "filename": "server/api/trigger/index.js",
26309     "groupTitle": "Triggers"
26310   },
26311   {
26312     "type": "get",
26313     "url": "/api/triggers/{id}/all_conditions",
26314     "title": "Gets \"AND\" Trigger Conditions",
26315     "examples": [
26316       {
26317         "title": "Example usage:",
26318         "content": "curl https://{domain}/api/triggers/{id}/all_conditions -v -u {name}:{password} -X GET",
26319         "type": "json"
26320       }
26321     ],
26322     "name": "getAllConditions",
26323     "group": "Triggers",
26324     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26325     "version": "0.0.0",
26326     "filename": "server/api/trigger/index.js",
26327     "groupTitle": "Triggers"
26328   },
26329   {
26330     "type": "get",
26331     "url": "/api/triggers/{id}/any_conditions",
26332     "title": "Gets \"OR\" Trigger Conditions",
26333     "examples": [
26334       {
26335         "title": "Example usage:",
26336         "content": "curl https://{domain}/api/triggers/{id}/any_conditions -v -u {name}:{password} -X GET",
26337         "type": "json"
26338       }
26339     ],
26340     "name": "getAnyConditions",
26341     "group": "Triggers",
26342     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26343     "version": "0.0.0",
26344     "filename": "server/api/trigger/index.js",
26345     "groupTitle": "Triggers"
26346   },
26347   {
26348     "type": "put",
26349     "url": "/api/triggers/{id}",
26350     "title": "Update an existing Trigger",
26351     "examples": [
26352       {
26353         "title": "Example usage:",
26354         "content": "curl https://{domain}/api/triggers/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
26355         "type": "json"
26356       }
26357     ],
26358     "name": "updateTriggers",
26359     "group": "Triggers",
26360     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26361     "version": "0.0.0",
26362     "filename": "server/api/trigger/index.js",
26363     "groupTitle": "Triggers"
26364   },
26365   {
26366     "type": "post",
26367     "url": "/api/trunks/clone",
26368     "title": "Clone an existing Trunk",
26369     "examples": [
26370       {
26371         "title": "Example usage:",
26372         "content": "curl https://{domain}/api/trunks/clone -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
26373         "type": "json"
26374       }
26375     ],
26376     "name": "CloneTrunks",
26377     "group": "Trunks",
26378     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26379     "version": "0.0.0",
26380     "filename": "server/api/trunk/index.js",
26381     "groupTitle": "Trunks"
26382   },
26383   {
26384     "type": "post",
26385     "url": "/api/trunks",
26386     "title": "Create a new trunk",
26387     "examples": [
26388       {
26389         "title": "Example usage:",
26390         "content": "curl https://{domain}/api/trunks -v -u {name}:{password} -X POST",
26391         "type": "json"
26392       }
26393     ],
26394     "name": "Create",
26395     "group": "Trunks",
26396     "parameter": {
26397       "fields": {
26398         "Body": [
26399           {
26400             "group": "Body",
26401             "type": "String",
26402             "optional": false,
26403             "field": "name",
26404             "description": ""
26405           },
26406           {
26407             "group": "Body",
26408             "type": "String",
26409             "allowedValues": [
26410               "\"friend\"",
26411               "\"user\"",
26412               "\"peer\""
26413             ],
26414             "optional": false,
26415             "field": "type",
26416             "description": ""
26417           },
26418           {
26419             "group": "Body",
26420             "type": "String",
26421             "optional": false,
26422             "field": "context",
26423             "description": ""
26424           },
26425           {
26426             "group": "Body",
26427             "type": "String",
26428             "allowedValues": [
26429               "\"ALLOWED_NOT_SCREENED\"",
26430               "\"ALLOWED_PASSED_SCREEN\"",
26431               "\"ALLOWED_FAILED_SCREEN\"",
26432               "\"ALLOWED\"",
26433               "\"PROHIB_NOT_SCREENED\"",
26434               "\"PROHIB_PASSED_SCREEN\"",
26435               "\"PROHIB_FAILED_SCREEN\"",
26436               "\"PROHIB\""
26437             ],
26438             "optional": true,
26439             "field": "callingpres",
26440             "description": ""
26441           },
26442           {
26443             "group": "Body",
26444             "type": "String",
26445             "optional": true,
26446             "field": "deny",
26447             "description": ""
26448           },
26449           {
26450             "group": "Body",
26451             "type": "String",
26452             "optional": true,
26453             "field": "permit",
26454             "description": ""
26455           },
26456           {
26457             "group": "Body",
26458             "type": "String",
26459             "optional": true,
26460             "field": "secret",
26461             "description": ""
26462           },
26463           {
26464             "group": "Body",
26465             "type": "String",
26466             "optional": true,
26467             "field": "md5secret",
26468             "description": ""
26469           },
26470           {
26471             "group": "Body",
26472             "type": "String",
26473             "optional": true,
26474             "field": "remotesecret",
26475             "description": ""
26476           },
26477           {
26478             "group": "Body",
26479             "type": "String",
26480             "optional": true,
26481             "field": "transport",
26482             "description": "<p>String is deprecated. Please use an Array as [&quot;udp&quot;, &quot;tcp&quot;]</p>"
26483           },
26484           {
26485             "group": "Body",
26486             "type": "String",
26487             "allowedValues": [
26488               "\"rfc2833\"",
26489               "\"info\"",
26490               "\"shortinfo\"",
26491               "\"inband\"",
26492               "\"auto\""
26493             ],
26494             "optional": true,
26495             "field": "dtmfmode",
26496             "description": ""
26497           },
26498           {
26499             "group": "Body",
26500             "type": "String",
26501             "allowedValues": [
26502               "\"yes\"",
26503               "\"no\"",
26504               "\"nonat\"",
26505               "\"update\"",
26506               "\"outgoing\""
26507             ],
26508             "optional": true,
26509             "field": "directmedia",
26510             "description": ""
26511           },
26512           {
26513             "group": "Body",
26514             "type": "String",
26515             "allowedValues": [
26516               "\"yes\"",
26517               "\"no\""
26518             ],
26519             "optional": true,
26520             "field": "directrtpsetup",
26521             "description": ""
26522           },
26523           {
26524             "group": "Body",
26525             "type": "String",
26526             "optional": true,
26527             "field": "directmediapermit",
26528             "description": ""
26529           },
26530           {
26531             "group": "Body",
26532             "type": "String",
26533             "optional": true,
26534             "field": "directmediadeny",
26535             "description": ""
26536           },
26537           {
26538             "group": "Body",
26539             "type": "String",
26540             "optional": true,
26541             "field": "nat",
26542             "description": "<p>String is deprecated. Please use an Array as [&quot;force_rport&quot;, &quot;comedia&quot;]</p>"
26543           },
26544           {
26545             "group": "Body",
26546             "type": "String",
26547             "optional": true,
26548             "field": "callgroup",
26549             "description": ""
26550           },
26551           {
26552             "group": "Body",
26553             "type": "String",
26554             "optional": true,
26555             "field": "namedcallgroup",
26556             "description": ""
26557           },
26558           {
26559             "group": "Body",
26560             "type": "String",
26561             "optional": true,
26562             "field": "pickupgroup",
26563             "description": ""
26564           },
26565           {
26566             "group": "Body",
26567             "type": "String",
26568             "optional": true,
26569             "field": "namedpickupgroup",
26570             "description": ""
26571           },
26572           {
26573             "group": "Body",
26574             "type": "String",
26575             "optional": true,
26576             "field": "language",
26577             "description": ""
26578           },
26579           {
26580             "group": "Body",
26581             "type": "String",
26582             "optional": true,
26583             "field": "tonezone",
26584             "description": ""
26585           },
26586           {
26587             "group": "Body",
26588             "type": "String",
26589             "optional": true,
26590             "field": "disallow",
26591             "description": ""
26592           },
26593           {
26594             "group": "Body",
26595             "type": "String",
26596             "optional": false,
26597             "field": "allow",
26598             "description": "<p>String is deprecated. Please use an Array as [&quot;ulaw&quot;, &quot;alaw&quot;, &quot;alaw&quot;]</p>"
26599           },
26600           {
26601             "group": "Body",
26602             "type": "String",
26603             "allowedValues": [
26604               "\"yes\"",
26605               "\"no\""
26606             ],
26607             "optional": true,
26608             "field": "autoframing",
26609             "description": ""
26610           },
26611           {
26612             "group": "Body",
26613             "type": "String",
26614             "optional": true,
26615             "field": "insecure",
26616             "description": "<p>String is deprecated. Please use an Array as [&quot;port&quot;, &quot;invite&quot;]</p>"
26617           },
26618           {
26619             "group": "Body",
26620             "type": "String",
26621             "allowedValues": [
26622               "\"yes\"",
26623               "\"no\""
26624             ],
26625             "optional": true,
26626             "field": "trustrpid",
26627             "description": ""
26628           },
26629           {
26630             "group": "Body",
26631             "type": "String",
26632             "allowedValues": [
26633               "\"yes\"",
26634               "\"no\""
26635             ],
26636             "optional": true,
26637             "field": "trust_id_outbound",
26638             "description": ""
26639           },
26640           {
26641             "group": "Body",
26642             "type": "String",
26643             "allowedValues": [
26644               "\"yes\"",
26645               "\"no\"",
26646               "\"never\""
26647             ],
26648             "optional": true,
26649             "field": "progressinband",
26650             "description": ""
26651           },
26652           {
26653             "group": "Body",
26654             "type": "String",
26655             "allowedValues": [
26656               "\"yes\"",
26657               "\"no\""
26658             ],
26659             "optional": true,
26660             "field": "promiscredir",
26661             "description": ""
26662           },
26663           {
26664             "group": "Body",
26665             "type": "String",
26666             "allowedValues": [
26667               "\"yes\"",
26668               "\"no\""
26669             ],
26670             "optional": true,
26671             "field": "useclientcode",
26672             "description": ""
26673           },
26674           {
26675             "group": "Body",
26676             "type": "Integer",
26677             "optional": true,
26678             "field": "accountcode",
26679             "description": ""
26680           },
26681           {
26682             "group": "Body",
26683             "type": "String",
26684             "optional": true,
26685             "field": "setvar",
26686             "description": ""
26687           },
26688           {
26689             "group": "Body",
26690             "type": "String",
26691             "optional": true,
26692             "field": "callerid",
26693             "description": ""
26694           },
26695           {
26696             "group": "Body",
26697             "type": "String",
26698             "optional": true,
26699             "field": "amaflags",
26700             "description": ""
26701           },
26702           {
26703             "group": "Body",
26704             "type": "String",
26705             "allowedValues": [
26706               "\"yes\"",
26707               "\"no\""
26708             ],
26709             "optional": true,
26710             "field": "callcounter",
26711             "description": ""
26712           },
26713           {
26714             "group": "Body",
26715             "type": "Integer",
26716             "optional": true,
26717             "field": "busylevel",
26718             "description": ""
26719           },
26720           {
26721             "group": "Body",
26722             "type": "String",
26723             "allowedValues": [
26724               "\"yes\"",
26725               "\"no\""
26726             ],
26727             "optional": true,
26728             "field": "allowoverlap",
26729             "description": ""
26730           },
26731           {
26732             "group": "Body",
26733             "type": "String",
26734             "allowedValues": [
26735               "\"yes\"",
26736               "\"no\""
26737             ],
26738             "optional": true,
26739             "field": "allowsubscribe",
26740             "description": ""
26741           },
26742           {
26743             "group": "Body",
26744             "type": "String",
26745             "allowedValues": [
26746               "\"yes\"",
26747               "\"no\""
26748             ],
26749             "optional": true,
26750             "field": "allowtransfer",
26751             "description": ""
26752           },
26753           {
26754             "group": "Body",
26755             "type": "String",
26756             "allowedValues": [
26757               "\"yes\"",
26758               "\"no\""
26759             ],
26760             "optional": true,
26761             "field": "ignoresdpversion",
26762             "description": ""
26763           },
26764           {
26765             "group": "Body",
26766             "type": "String",
26767             "optional": true,
26768             "field": "subscribecontext",
26769             "description": ""
26770           },
26771           {
26772             "group": "Body",
26773             "type": "String",
26774             "optional": true,
26775             "field": "template",
26776             "description": ""
26777           },
26778           {
26779             "group": "Body",
26780             "type": "String",
26781             "allowedValues": [
26782               "\"yes\"",
26783               "\"no\"",
26784               "\"always\""
26785             ],
26786             "optional": true,
26787             "field": "videosupport",
26788             "description": ""
26789           },
26790           {
26791             "group": "Body",
26792             "type": "Integer",
26793             "optional": true,
26794             "field": "maxcallbitrate",
26795             "description": ""
26796           },
26797           {
26798             "group": "Body",
26799             "type": "String",
26800             "allowedValues": [
26801               "\"yes\"",
26802               "\"no\""
26803             ],
26804             "optional": true,
26805             "field": "rfc2833compensate",
26806             "description": ""
26807           },
26808           {
26809             "group": "Body",
26810             "type": "String",
26811             "optional": true,
26812             "field": "mailbox",
26813             "description": ""
26814           },
26815           {
26816             "group": "Body",
26817             "type": "String",
26818             "allowedValues": [
26819               "\"accept\"",
26820               "\"refuse\"",
26821               "\"originate\""
26822             ],
26823             "optional": true,
26824             "field": "session_timers",
26825             "description": ""
26826           },
26827           {
26828             "group": "Body",
26829             "type": "Integer",
26830             "optional": true,
26831             "field": "session_expires",
26832             "description": ""
26833           },
26834           {
26835             "group": "Body",
26836             "type": "Integer",
26837             "optional": true,
26838             "field": "session_minse",
26839             "description": ""
26840           },
26841           {
26842             "group": "Body",
26843             "type": "String",
26844             "allowedValues": [
26845               "\"uac\"",
26846               "\"uas\""
26847             ],
26848             "optional": true,
26849             "field": "session_refresher",
26850             "description": ""
26851           },
26852           {
26853             "group": "Body",
26854             "type": "String",
26855             "optional": true,
26856             "field": "t38pt_usertpsource",
26857             "description": ""
26858           },
26859           {
26860             "group": "Body",
26861             "type": "String",
26862             "optional": true,
26863             "field": "regexten",
26864             "description": ""
26865           },
26866           {
26867             "group": "Body",
26868             "type": "String",
26869             "optional": true,
26870             "field": "fromdomain",
26871             "description": ""
26872           },
26873           {
26874             "group": "Body",
26875             "type": "String",
26876             "optional": true,
26877             "field": "fromuser",
26878             "description": ""
26879           },
26880           {
26881             "group": "Body",
26882             "type": "Integer",
26883             "optional": true,
26884             "field": "port",
26885             "description": ""
26886           },
26887           {
26888             "group": "Body",
26889             "type": "String",
26890             "allowedValues": [
26891               "\"yes\"",
26892               "\"no\""
26893             ],
26894             "optional": true,
26895             "field": "qualify",
26896             "description": ""
26897           },
26898           {
26899             "group": "Body",
26900             "type": "Integer",
26901             "optional": true,
26902             "field": "keepalive",
26903             "description": ""
26904           },
26905           {
26906             "group": "Body",
26907             "type": "String",
26908             "optional": true,
26909             "field": "defaultip",
26910             "description": ""
26911           },
26912           {
26913             "group": "Body",
26914             "type": "String",
26915             "optional": true,
26916             "field": "defaultuser",
26917             "description": ""
26918           },
26919           {
26920             "group": "Body",
26921             "type": "Integer",
26922             "optional": true,
26923             "field": "rtptimeout",
26924             "description": ""
26925           },
26926           {
26927             "group": "Body",
26928             "type": "Integer",
26929             "optional": true,
26930             "field": "rtpholdtimeout",
26931             "description": ""
26932           },
26933           {
26934             "group": "Body",
26935             "type": "Integer",
26936             "optional": true,
26937             "field": "rtpkeepalive",
26938             "description": ""
26939           },
26940           {
26941             "group": "Body",
26942             "type": "String",
26943             "allowedValues": [
26944               "\"yes\"",
26945               "\"no\"",
26946               "\"pai\""
26947             ],
26948             "optional": true,
26949             "field": "sendrpid",
26950             "description": ""
26951           },
26952           {
26953             "group": "Body",
26954             "type": "String",
26955             "optional": true,
26956             "field": "outboundproxy",
26957             "description": ""
26958           },
26959           {
26960             "group": "Body",
26961             "type": "String",
26962             "optional": true,
26963             "field": "callbackextension",
26964             "description": ""
26965           },
26966           {
26967             "group": "Body",
26968             "type": "Integer",
26969             "optional": true,
26970             "field": "timert1",
26971             "description": ""
26972           },
26973           {
26974             "group": "Body",
26975             "type": "Integer",
26976             "optional": true,
26977             "field": "timerb",
26978             "description": ""
26979           },
26980           {
26981             "group": "Body",
26982             "type": "Integer",
26983             "optional": true,
26984             "field": "qualifyfreq",
26985             "description": ""
26986           },
26987           {
26988             "group": "Body",
26989             "type": "String",
26990             "optional": true,
26991             "field": "contactpermit",
26992             "description": ""
26993           },
26994           {
26995             "group": "Body",
26996             "type": "String",
26997             "optional": true,
26998             "field": "contactdeny",
26999             "description": ""
27000           },
27001           {
27002             "group": "Body",
27003             "type": "String",
27004             "optional": true,
27005             "field": "contactacl",
27006             "description": ""
27007           },
27008           {
27009             "group": "Body",
27010             "type": "String",
27011             "optional": true,
27012             "field": "unsolicited_mailbox",
27013             "description": ""
27014           },
27015           {
27016             "group": "Body",
27017             "type": "String",
27018             "optional": true,
27019             "field": "use_q850_reason",
27020             "description": ""
27021           },
27022           {
27023             "group": "Body",
27024             "type": "Integer",
27025             "optional": true,
27026             "field": "maxforwards",
27027             "description": ""
27028           },
27029           {
27030             "group": "Body",
27031             "type": "String",
27032             "allowedValues": [
27033               "\"yes\"",
27034               "\"no\""
27035             ],
27036             "optional": true,
27037             "field": "encryption",
27038             "description": ""
27039           },
27040           {
27041             "group": "Body",
27042             "type": "String",
27043             "allowedValues": [
27044               "\"yes\"",
27045               "\"no\""
27046             ],
27047             "optional": true,
27048             "field": "avpf",
27049             "description": ""
27050           },
27051           {
27052             "group": "Body",
27053             "type": "String",
27054             "allowedValues": [
27055               "\"yes\"",
27056               "\"no\""
27057             ],
27058             "optional": true,
27059             "field": "force_avp",
27060             "description": ""
27061           },
27062           {
27063             "group": "Body",
27064             "type": "String",
27065             "allowedValues": [
27066               "\"yes\"",
27067               "\"no\""
27068             ],
27069             "optional": true,
27070             "field": "icesupport",
27071             "description": ""
27072           },
27073           {
27074             "group": "Body",
27075             "type": "String",
27076             "allowedValues": [
27077               "\"yes\"",
27078               "\"no\""
27079             ],
27080             "optional": true,
27081             "field": "dtlsenable",
27082             "description": ""
27083           },
27084           {
27085             "group": "Body",
27086             "type": "String",
27087             "allowedValues": [
27088               "\"yes\"",
27089               "\"no\"",
27090               "\"fingerprint\"",
27091               "\"certificate\""
27092             ],
27093             "optional": true,
27094             "field": "dtlsverify",
27095             "description": ""
27096           },
27097           {
27098             "group": "Body",
27099             "type": "Integer",
27100             "optional": true,
27101             "field": "dtlsrekey",
27102             "description": ""
27103           },
27104           {
27105             "group": "Body",
27106             "type": "String",
27107             "optional": true,
27108             "field": "dtlscertfile",
27109             "description": ""
27110           },
27111           {
27112             "group": "Body",
27113             "type": "String",
27114             "optional": true,
27115             "field": "dtlsprivatekey",
27116             "description": ""
27117           },
27118           {
27119             "group": "Body",
27120             "type": "String",
27121             "optional": true,
27122             "field": "dtlscipher",
27123             "description": ""
27124           },
27125           {
27126             "group": "Body",
27127             "type": "String",
27128             "optional": true,
27129             "field": "dtlscafile",
27130             "description": ""
27131           },
27132           {
27133             "group": "Body",
27134             "type": "String",
27135             "optional": true,
27136             "field": "dtlscapath",
27137             "description": ""
27138           },
27139           {
27140             "group": "Body",
27141             "type": "String",
27142             "allowedValues": [
27143               "\"active\"",
27144               "\"passive\"",
27145               "\"actpass\""
27146             ],
27147             "optional": true,
27148             "field": "dtlssetup",
27149             "description": ""
27150           },
27151           {
27152             "group": "Body",
27153             "type": "String",
27154             "optional": true,
27155             "field": "dtlsfingerprint",
27156             "description": ""
27157           },
27158           {
27159             "group": "Body",
27160             "type": "String",
27161             "allowedValues": [
27162               "\"yes\"",
27163               "\"no\""
27164             ],
27165             "optional": true,
27166             "field": "usereqphone",
27167             "description": ""
27168           },
27169           {
27170             "group": "Body",
27171             "type": "String",
27172             "optional": true,
27173             "field": "recordonfeature",
27174             "description": ""
27175           },
27176           {
27177             "group": "Body",
27178             "type": "String",
27179             "optional": true,
27180             "field": "recordofffeature",
27181             "description": ""
27182           },
27183           {
27184             "group": "Body",
27185             "type": "Integer",
27186             "optional": true,
27187             "field": "call_limit",
27188             "description": ""
27189           },
27190           {
27191             "group": "Body",
27192             "type": "String",
27193             "allowedValues": [
27194               "\"yes\"",
27195               "\"no\""
27196             ],
27197             "optional": true,
27198             "field": "registertrying",
27199             "description": ""
27200           },
27201           {
27202             "group": "Body",
27203             "type": "String",
27204             "allowedValues": [
27205               "\"yes\"",
27206               "\"no\""
27207             ],
27208             "optional": true,
27209             "field": "subscribemwi",
27210             "description": ""
27211           },
27212           {
27213             "group": "Body",
27214             "type": "String",
27215             "optional": true,
27216             "field": "vmexten",
27217             "description": ""
27218           },
27219           {
27220             "group": "Body",
27221             "type": "String",
27222             "optional": true,
27223             "field": "mohinterpret",
27224             "description": ""
27225           },
27226           {
27227             "group": "Body",
27228             "type": "String",
27229             "optional": true,
27230             "field": "mohsuggest",
27231             "description": ""
27232           },
27233           {
27234             "group": "Body",
27235             "type": "String",
27236             "optional": true,
27237             "field": "parkinglot",
27238             "description": ""
27239           },
27240           {
27241             "group": "Body",
27242             "type": "String",
27243             "optional": true,
27244             "field": "description",
27245             "description": ""
27246           },
27247           {
27248             "group": "Body",
27249             "type": "String",
27250             "optional": true,
27251             "field": "host",
27252             "description": ""
27253           },
27254           {
27255             "group": "Body",
27256             "type": "String",
27257             "allowedValues": [
27258               "\"yes\"",
27259               "\"no\"",
27260               "\"nonat\"",
27261               "\"update\"",
27262               "\"update,nonat\""
27263             ],
27264             "optional": true,
27265             "field": "canreinvite",
27266             "description": ""
27267           },
27268           {
27269             "group": "Body",
27270             "type": "String",
27271             "optional": true,
27272             "field": "registry",
27273             "description": ""
27274           },
27275           {
27276             "group": "Body",
27277             "type": "String",
27278             "optional": true,
27279             "field": "otherFields",
27280             "description": ""
27281           },
27282           {
27283             "group": "Body",
27284             "type": "Boolean",
27285             "optional": false,
27286             "field": "active",
27287             "description": ""
27288           },
27289           {
27290             "group": "Body",
27291             "type": "String",
27292             "optional": true,
27293             "field": "t38pt_udptl",
27294             "description": ""
27295           }
27296         ]
27297       }
27298     },
27299     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27300     "version": "0.0.0",
27301     "filename": "server/api/trunk/index.js",
27302     "groupTitle": "Trunks"
27303   },
27304   {
27305     "type": "delete",
27306     "url": "/api/trunks/{id}",
27307     "title": "Deletes a trunk",
27308     "examples": [
27309       {
27310         "title": "Example usage:",
27311         "content": "curl https://{domain}/api/trunks/{id} -v -u {name}:{password} -X DELETE",
27312         "type": "json"
27313       }
27314     ],
27315     "name": "Delete",
27316     "group": "Trunks",
27317     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27318     "version": "0.0.0",
27319     "filename": "server/api/trunk/index.js",
27320     "groupTitle": "Trunks"
27321   },
27322   {
27323     "type": "get",
27324     "url": "/api/trunks",
27325     "title": "Gets a list of Trunks",
27326     "examples": [
27327       {
27328         "title": "Example usage:",
27329         "content": "curl https://{domain}/api/trunks -v -u {name}:{password}",
27330         "type": "json"
27331       }
27332     ],
27333     "name": "GetTrunks",
27334     "group": "Trunks",
27335     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
27336     "version": "0.0.0",
27337     "filename": "server/api/trunk/index.js",
27338     "groupTitle": "Trunks"
27339   },
27340   {
27341     "type": "get",
27342     "url": "/api/trunks/{id}",
27343     "title": "Gets a single Trunk",
27344     "examples": [
27345       {
27346         "title": "Example usage:",
27347         "content": "curl https://{domain}/api/trunks/{id} -v -u {name}:{password}",
27348         "type": "json"
27349       }
27350     ],
27351     "name": "ShowTrunks",
27352     "group": "Trunks",
27353     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27354     "version": "0.0.0",
27355     "filename": "server/api/trunk/index.js",
27356     "groupTitle": "Trunks"
27357   },
27358   {
27359     "type": "put",
27360     "url": "/api/trunks/{id}",
27361     "title": "Update an existing trunk",
27362     "examples": [
27363       {
27364         "title": "Example usage:",
27365         "content": "curl https://{domain}/api/trunks/{id} -v -u {name}:{password} -X PUT",
27366         "type": "json"
27367       }
27368     ],
27369     "name": "Update",
27370     "group": "Trunks",
27371     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27372     "version": "0.0.0",
27373     "filename": "server/api/trunk/index.js",
27374     "groupTitle": "Trunks"
27375   },
27376   {
27377     "type": "post",
27378     "url": "/api/userProfile/resources",
27379     "title": "Creates a new User Profile Resource",
27380     "examples": [
27381       {
27382         "title": "Example usage:",
27383         "content": "curl https://{domain}/api/userProfile/resources -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
27384         "type": "json"
27385       }
27386     ],
27387     "name": "CreateUser_Profile_Resources",
27388     "group": "User_Profile_Resources",
27389     "parameter": {
27390       "fields": {
27391         "Body": [
27392           {
27393             "group": "Body",
27394             "type": "String",
27395             "optional": false,
27396             "field": "name",
27397             "description": ""
27398           },
27399           {
27400             "group": "Body",
27401             "type": "Integer",
27402             "optional": false,
27403             "field": "resourceId",
27404             "description": ""
27405           },
27406           {
27407             "group": "Body",
27408             "type": "String",
27409             "optional": false,
27410             "field": "type",
27411             "description": ""
27412           }
27413         ]
27414       }
27415     },
27416     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27417     "version": "0.0.0",
27418     "filename": "server/api/userProfileResource/index.js",
27419     "groupTitle": "User_Profile_Resources"
27420   },
27421   {
27422     "type": "delete",
27423     "url": "/api/userProfile/resources/{id}",
27424     "title": "Deletes a User Profile Resource",
27425     "examples": [
27426       {
27427         "title": "Example usage:",
27428         "content": "curl https://{domain}/api/userProfile/resources/{id} -v -u {name}:{password} -X DELETE",
27429         "type": "json"
27430       }
27431     ],
27432     "name": "DeleteUser_Profile_Resources",
27433     "group": "User_Profile_Resources",
27434     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27435     "version": "0.0.0",
27436     "filename": "server/api/userProfileResource/index.js",
27437     "groupTitle": "User_Profile_Resources"
27438   },
27439   {
27440     "type": "get",
27441     "url": "/api/userProfile/resources/describe",
27442     "title": "Gets table info about User Profile Resources",
27443     "examples": [
27444       {
27445         "title": "Example usage:",
27446         "content": "curl https://{domain}/api/userProfile/resources/describe -v -u {name}:{password}",
27447         "type": "json"
27448       }
27449     ],
27450     "name": "DescribeUser_Profile_Resources",
27451     "group": "User_Profile_Resources",
27452     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27453     "version": "0.0.0",
27454     "filename": "server/api/userProfileResource/index.js",
27455     "groupTitle": "User_Profile_Resources"
27456   },
27457   {
27458     "type": "get",
27459     "url": "/api/userProfile/resources",
27460     "title": "Gets a list of User Profile Resources",
27461     "examples": [
27462       {
27463         "title": "Example usage:",
27464         "content": "curl https://{domain}/api/userProfile/resources -v -u {name}:{password}",
27465         "type": "json"
27466       }
27467     ],
27468     "name": "GetUser_Profile_Resources",
27469     "group": "User_Profile_Resources",
27470     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
27471     "version": "0.0.0",
27472     "filename": "server/api/userProfileResource/index.js",
27473     "groupTitle": "User_Profile_Resources"
27474   },
27475   {
27476     "type": "get",
27477     "url": "/api/userProfile/resources/{id}",
27478     "title": "Gets a single User Profile Resource",
27479     "examples": [
27480       {
27481         "title": "Example usage:",
27482         "content": "curl https://{domain}/api/userProfile/resources/{id} -v -u {name}:{password}",
27483         "type": "json"
27484       }
27485     ],
27486     "name": "ShowUser_Profile_Resources",
27487     "group": "User_Profile_Resources",
27488     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27489     "version": "0.0.0",
27490     "filename": "server/api/userProfileResource/index.js",
27491     "groupTitle": "User_Profile_Resources"
27492   },
27493   {
27494     "type": "put",
27495     "url": "/api/userProfile/resources/{id}",
27496     "title": "Update an existing User Profile Resource",
27497     "examples": [
27498       {
27499         "title": "Example usage:",
27500         "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",
27501         "type": "json"
27502       }
27503     ],
27504     "name": "updateUser_Profile_Resources",
27505     "group": "User_Profile_Resources",
27506     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27507     "version": "0.0.0",
27508     "filename": "server/api/userProfileResource/index.js",
27509     "groupTitle": "User_Profile_Resources"
27510   },
27511   {
27512     "type": "post",
27513     "url": "/api/userProfile/sections",
27514     "title": "Creates a new User Profile Section",
27515     "examples": [
27516       {
27517         "title": "Example usage:",
27518         "content": "curl https://{domain}/api/userProfile/sections -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
27519         "type": "json"
27520       }
27521     ],
27522     "name": "CreateUser_Profile_Sections",
27523     "group": "User_Profile_Sections",
27524     "parameter": {
27525       "fields": {
27526         "Body": [
27527           {
27528             "group": "Body",
27529             "type": "String",
27530             "optional": false,
27531             "field": "name",
27532             "description": ""
27533           },
27534           {
27535             "group": "Body",
27536             "type": "String",
27537             "optional": false,
27538             "field": "category",
27539             "description": ""
27540           },
27541           {
27542             "group": "Body",
27543             "type": "Integer",
27544             "optional": false,
27545             "field": "sectionId",
27546             "description": ""
27547           },
27548           {
27549             "group": "Body",
27550             "type": "Boolean",
27551             "optional": true,
27552             "field": "enabled",
27553             "description": ""
27554           },
27555           {
27556             "group": "Body",
27557             "type": "Boolean",
27558             "optional": true,
27559             "field": "autoAssociation",
27560             "description": ""
27561           },
27562           {
27563             "group": "Body",
27564             "type": "String",
27565             "optional": true,
27566             "field": "crudPermissions",
27567             "description": ""
27568           }
27569         ]
27570       }
27571     },
27572     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27573     "version": "0.0.0",
27574     "filename": "server/api/userProfileSection/index.js",
27575     "groupTitle": "User_Profile_Sections"
27576   },
27577   {
27578     "type": "delete",
27579     "url": "/api/userProfile/sections/{id}",
27580     "title": "Deletes a User Profile Section",
27581     "examples": [
27582       {
27583         "title": "Example usage:",
27584         "content": "curl https://{domain}/api/userProfile/sections/{id} -v -u {name}:{password} -X DELETE",
27585         "type": "json"
27586       }
27587     ],
27588     "name": "DeleteUser_Profile_Sections",
27589     "group": "User_Profile_Sections",
27590     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27591     "version": "0.0.0",
27592     "filename": "server/api/userProfileSection/index.js",
27593     "groupTitle": "User_Profile_Sections"
27594   },
27595   {
27596     "type": "get",
27597     "url": "/api/userProfile/sections/describe",
27598     "title": "Gets table info about User Profile Sections",
27599     "examples": [
27600       {
27601         "title": "Example usage:",
27602         "content": "curl https://{domain}/api/userProfile/sections/describe -v -u {name}:{password}",
27603         "type": "json"
27604       }
27605     ],
27606     "name": "DescribeUser_Profile_Sections",
27607     "group": "User_Profile_Sections",
27608     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27609     "version": "0.0.0",
27610     "filename": "server/api/userProfileSection/index.js",
27611     "groupTitle": "User_Profile_Sections"
27612   },
27613   {
27614     "type": "get",
27615     "url": "/api/userProfile/sections",
27616     "title": "Gets a list of User Profile Sections",
27617     "examples": [
27618       {
27619         "title": "Example usage:",
27620         "content": "curl https://{domain}/api/userProfile/sections -v -u {name}:{password}",
27621         "type": "json"
27622       }
27623     ],
27624     "name": "GetUser_Profile_Sections",
27625     "group": "User_Profile_Sections",
27626     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
27627     "version": "0.0.0",
27628     "filename": "server/api/userProfileSection/index.js",
27629     "groupTitle": "User_Profile_Sections"
27630   },
27631   {
27632     "type": "get",
27633     "url": "/api/userProfile/sections/{id}",
27634     "title": "Gets a single User Profile Section",
27635     "examples": [
27636       {
27637         "title": "Example usage:",
27638         "content": "curl https://{domain}/api/userProfile/sections/{id} -v -u {name}:{password}",
27639         "type": "json"
27640       }
27641     ],
27642     "name": "ShowUser_Profile_Sections",
27643     "group": "User_Profile_Sections",
27644     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27645     "version": "0.0.0",
27646     "filename": "server/api/userProfileSection/index.js",
27647     "groupTitle": "User_Profile_Sections"
27648   },
27649   {
27650     "type": "put",
27651     "url": "/api/userProfile/sections/{id}",
27652     "title": "Update an existing User Profile Section",
27653     "examples": [
27654       {
27655         "title": "Example usage:",
27656         "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",
27657         "type": "json"
27658       }
27659     ],
27660     "name": "updateUser_Profile_Sections",
27661     "group": "User_Profile_Sections",
27662     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27663     "version": "0.0.0",
27664     "filename": "server/api/userProfileSection/index.js",
27665     "groupTitle": "User_Profile_Sections"
27666   },
27667   {
27668     "type": "post",
27669     "url": "/api/userProfiles/{id}/resources",
27670     "title": "Add resources' permissions to User Profile",
27671     "examples": [
27672       {
27673         "title": "Example usage:",
27674         "content": "curl https://{domain}/api/userProfiles/{id}/resources -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
27675         "type": "json"
27676       }
27677     ],
27678     "name": "AddResources",
27679     "group": "User_Profiles",
27680     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27681     "version": "0.0.0",
27682     "filename": "server/api/userProfile/index.js",
27683     "groupTitle": "User_Profiles"
27684   },
27685   {
27686     "type": "post",
27687     "url": "/api/userProfiles/{id}/sections",
27688     "title": "Add sections' permissions to User Profile",
27689     "examples": [
27690       {
27691         "title": "Example usage:",
27692         "content": "curl https://{domain}/api/userProfiles/{id}/sections -d '[{\"sectionId\": \"name\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
27693         "type": "json"
27694       }
27695     ],
27696     "name": "AddSections",
27697     "group": "User_Profiles",
27698     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27699     "version": "0.0.0",
27700     "filename": "server/api/userProfile/index.js",
27701     "groupTitle": "User_Profiles"
27702   },
27703   {
27704     "type": "post",
27705     "url": "/api/userProfiles/clone",
27706     "title": "Clone an existing User Profile",
27707     "examples": [
27708       {
27709         "title": "Example usage:",
27710         "content": "curl https://{domain}/api/userProfiles/clone -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
27711         "type": "json"
27712       }
27713     ],
27714     "name": "CloneUser_Profiles",
27715     "group": "User_Profiles",
27716     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27717     "version": "0.0.0",
27718     "filename": "server/api/userProfile/index.js",
27719     "groupTitle": "User_Profiles"
27720   },
27721   {
27722     "type": "post",
27723     "url": "/api/userProfiles",
27724     "title": "Creates a new User Profile",
27725     "examples": [
27726       {
27727         "title": "Example usage:",
27728         "content": "curl https://{domain}/api/userProfiles -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
27729         "type": "json"
27730       }
27731     ],
27732     "name": "CreateUser_Profiles",
27733     "group": "User_Profiles",
27734     "parameter": {
27735       "fields": {
27736         "Body": [
27737           {
27738             "group": "Body",
27739             "type": "String",
27740             "optional": false,
27741             "field": "name",
27742             "description": ""
27743           },
27744           {
27745             "group": "Body",
27746             "type": "String",
27747             "optional": false,
27748             "field": "crudPermissions",
27749             "description": ""
27750           },
27751           {
27752             "group": "Body",
27753             "type": "String",
27754             "optional": true,
27755             "field": "description",
27756             "description": ""
27757           }
27758         ]
27759       }
27760     },
27761     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27762     "version": "0.0.0",
27763     "filename": "server/api/userProfile/index.js",
27764     "groupTitle": "User_Profiles"
27765   },
27766   {
27767     "type": "delete",
27768     "url": "/api/userProfiles/{id}",
27769     "title": "Deletes a User Profile",
27770     "examples": [
27771       {
27772         "title": "Example usage:",
27773         "content": "curl https://{domain}/api/userProfiles/{id} -v -u {name}:{password} -X DELETE",
27774         "type": "json"
27775       }
27776     ],
27777     "name": "DeleteUser_Profiles",
27778     "group": "User_Profiles",
27779     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27780     "version": "0.0.0",
27781     "filename": "server/api/userProfile/index.js",
27782     "groupTitle": "User_Profiles"
27783   },
27784   {
27785     "type": "get",
27786     "url": "/api/userProfiles/describe",
27787     "title": "Gets table info about User Profiles",
27788     "examples": [
27789       {
27790         "title": "Example usage:",
27791         "content": "curl https://{domain}/api/userProfiles/describe -v -u {name}:{password}",
27792         "type": "json"
27793       }
27794     ],
27795     "name": "DescribeUser_Profiles",
27796     "group": "User_Profiles",
27797     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27798     "version": "0.0.0",
27799     "filename": "server/api/userProfile/index.js",
27800     "groupTitle": "User_Profiles"
27801   },
27802   {
27803     "type": "get",
27804     "url": "/api/userProfiles/{id}/resources?section={section}",
27805     "title": "Get Resources assigned to a Section",
27806     "examples": [
27807       {
27808         "title": "Example usage:",
27809         "content": "curl https://{domain}/api/userProfiles/{id}/resources?section={section} -v -u {name}:{password} -X GET",
27810         "type": "json"
27811       }
27812     ],
27813     "name": "GetResources",
27814     "group": "User_Profiles",
27815     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27816     "version": "0.0.0",
27817     "filename": "server/api/userProfile/index.js",
27818     "groupTitle": "User_Profiles"
27819   },
27820   {
27821     "type": "get",
27822     "url": "/api/userProfiles/{id}/sections",
27823     "title": "Get sections associated to a User Profile",
27824     "examples": [
27825       {
27826         "title": "Example usage:",
27827         "content": "curl https://{domain}/api/userProfiles/{id}/sections -v -u {name}:{password} -X GET",
27828         "type": "json"
27829       }
27830     ],
27831     "name": "GetSections",
27832     "group": "User_Profiles",
27833     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27834     "version": "0.0.0",
27835     "filename": "server/api/userProfile/index.js",
27836     "groupTitle": "User_Profiles"
27837   },
27838   {
27839     "type": "get",
27840     "url": "/api/userProfiles",
27841     "title": "Gets a list of User Profiles",
27842     "examples": [
27843       {
27844         "title": "Example usage:",
27845         "content": "curl https://{domain}/api/userProfiles -v -u {name}:{password}",
27846         "type": "json"
27847       }
27848     ],
27849     "name": "GetUser_Profiles",
27850     "group": "User_Profiles",
27851     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
27852     "version": "0.0.0",
27853     "filename": "server/api/userProfile/index.js",
27854     "groupTitle": "User_Profiles"
27855   },
27856   {
27857     "type": "delete",
27858     "url": "/api/userProfiles/{id}/resources",
27859     "title": "Removes resources' permissions from User Profile",
27860     "examples": [
27861       {
27862         "title": "Example usage:",
27863         "content": "curl https://{domain}/api/userProfiles/{id}/resources?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
27864         "type": "json"
27865       }
27866     ],
27867     "name": "RemoveResources",
27868     "group": "User_Profiles",
27869     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27870     "version": "0.0.0",
27871     "filename": "server/api/userProfile/index.js",
27872     "groupTitle": "User_Profiles"
27873   },
27874   {
27875     "type": "delete",
27876     "url": "/api/userProfiles/{id}/sections",
27877     "title": "Removes sections' permissions from User Profile",
27878     "examples": [
27879       {
27880         "title": "Example usage:",
27881         "content": "curl https://{domain}/api/userProfiles/{id}/sections?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
27882         "type": "json"
27883       }
27884     ],
27885     "name": "RemoveSections",
27886     "group": "User_Profiles",
27887     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27888     "version": "0.0.0",
27889     "filename": "server/api/userProfile/index.js",
27890     "groupTitle": "User_Profiles"
27891   },
27892   {
27893     "type": "get",
27894     "url": "/api/userProfiles/{id}",
27895     "title": "Gets a single User Profile",
27896     "examples": [
27897       {
27898         "title": "Example usage:",
27899         "content": "curl https://{domain}/api/userProfiles/{id} -v -u {name}:{password}",
27900         "type": "json"
27901       }
27902     ],
27903     "name": "ShowUser_Profiles",
27904     "group": "User_Profiles",
27905     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27906     "version": "0.0.0",
27907     "filename": "server/api/userProfile/index.js",
27908     "groupTitle": "User_Profiles"
27909   },
27910   {
27911     "type": "put",
27912     "url": "/api/userProfiles/{id}",
27913     "title": "Update an existing User Profile",
27914     "examples": [
27915       {
27916         "title": "Example usage:",
27917         "content": "curl https://{domain}/api/userProfiles/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
27918         "type": "json"
27919       }
27920     ],
27921     "name": "updateUser_Profiles",
27922     "group": "User_Profiles",
27923     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27924     "version": "0.0.0",
27925     "filename": "server/api/userProfile/index.js",
27926     "groupTitle": "User_Profiles"
27927   },
27928   {
27929     "type": "post",
27930     "url": "/api/users/{id}/chat_interactions",
27931     "title": "Add chat interaction tabs to an agent",
27932     "examples": [
27933       {
27934         "title": "Example usage:",
27935         "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",
27936         "type": "json"
27937       }
27938     ],
27939     "name": "AddChatInteractions",
27940     "group": "Users",
27941     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27942     "version": "0.0.0",
27943     "filename": "server/api/user/index.js",
27944     "groupTitle": "Users"
27945   },
27946   {
27947     "type": "post",
27948     "url": "/api/users/{id}/chat_websites",
27949     "title": "Add a Chat Website to a user",
27950     "examples": [
27951       {
27952         "title": "Example usage:",
27953         "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",
27954         "type": "json"
27955       }
27956     ],
27957     "name": "AddChatWebsites",
27958     "group": "Users",
27959     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27960     "version": "0.0.0",
27961     "filename": "server/api/user/index.js",
27962     "groupTitle": "Users"
27963   },
27964   {
27965     "type": "post",
27966     "url": "/api/users/{id}/contacts",
27967     "title": "Add contacts to a user",
27968     "examples": [
27969       {
27970         "title": "Example usage:",
27971         "content": "curl https://{domain}/api/users/{id}/contacts -d '{\"ids\": [1,2]}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
27972         "type": "json"
27973       }
27974     ],
27975     "name": "AddContacts",
27976     "group": "Users",
27977     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27978     "version": "0.0.0",
27979     "filename": "server/api/user/index.js",
27980     "groupTitle": "Users"
27981   },
27982   {
27983     "type": "post",
27984     "url": "/api/users/{id}/fax_accounts",
27985     "title": "Add a Fax Account to a user",
27986     "examples": [
27987       {
27988         "title": "Example usage:",
27989         "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",
27990         "type": "json"
27991       }
27992     ],
27993     "name": "AddFaxAccounts",
27994     "group": "Users",
27995     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27996     "version": "0.0.0",
27997     "filename": "server/api/user/index.js",
27998     "groupTitle": "Users"
27999   },
28000   {
28001     "type": "post",
28002     "url": "/api/users/{id}/fax_interactions",
28003     "title": "Add fax interaction tabs to an agent",
28004     "examples": [
28005       {
28006         "title": "Example usage:",
28007         "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",
28008         "type": "json"
28009       }
28010     ],
28011     "name": "AddFaxInteractions",
28012     "group": "Users",
28013     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28014     "version": "0.0.0",
28015     "filename": "server/api/user/index.js",
28016     "groupTitle": "Users"
28017   },
28018   {
28019     "type": "post",
28020     "url": "/api/users/{id}/mail_accounts",
28021     "title": "Add a Mail Account to a user",
28022     "examples": [
28023       {
28024         "title": "Example usage:",
28025         "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",
28026         "type": "json"
28027       }
28028     ],
28029     "name": "AddMailAccounts",
28030     "group": "Users",
28031     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28032     "version": "0.0.0",
28033     "filename": "server/api/user/index.js",
28034     "groupTitle": "Users"
28035   },
28036   {
28037     "type": "post",
28038     "url": "/api/users/{id}/mail_interactions",
28039     "title": "Add mail interaction tabs to an agent",
28040     "examples": [
28041       {
28042         "title": "Example usage:",
28043         "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",
28044         "type": "json"
28045       }
28046     ],
28047     "name": "AddMailInteractions",
28048     "group": "Users",
28049     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28050     "version": "0.0.0",
28051     "filename": "server/api/user/index.js",
28052     "groupTitle": "Users"
28053   },
28054   {
28055     "type": "post",
28056     "url": "/api/users/{id}/openchannel_accounts",
28057     "title": "Add a Open Channel Account to a user",
28058     "examples": [
28059       {
28060         "title": "Example usage:",
28061         "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",
28062         "type": "json"
28063       }
28064     ],
28065     "name": "AddOpenchannelAccounts",
28066     "group": "Users",
28067     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28068     "version": "0.0.0",
28069     "filename": "server/api/user/index.js",
28070     "groupTitle": "Users"
28071   },
28072   {
28073     "type": "post",
28074     "url": "/api/users/{id}/openchannel_interactions",
28075     "title": "Add openchannel interaction tabs to an agent",
28076     "examples": [
28077       {
28078         "title": "Example usage:",
28079         "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",
28080         "type": "json"
28081       }
28082     ],
28083     "name": "AddOpenchannelInteractions",
28084     "group": "Users",
28085     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28086     "version": "0.0.0",
28087     "filename": "server/api/user/index.js",
28088     "groupTitle": "Users"
28089   },
28090   {
28091     "type": "post",
28092     "url": "/api/users/{id}/queues",
28093     "title": "Add queues to an agent",
28094     "examples": [
28095       {
28096         "title": "Example usage:",
28097         "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",
28098         "type": "json"
28099       }
28100     ],
28101     "name": "AddQueues",
28102     "group": "Users",
28103     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28104     "version": "0.0.0",
28105     "filename": "server/api/user/index.js",
28106     "groupTitle": "Users"
28107   },
28108   {
28109     "type": "post",
28110     "url": "/api/users/{id}/sms_accounts",
28111     "title": "Add a Sms Account to a user",
28112     "examples": [
28113       {
28114         "title": "Example usage:",
28115         "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",
28116         "type": "json"
28117       }
28118     ],
28119     "name": "AddSmsAccounts",
28120     "group": "Users",
28121     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28122     "version": "0.0.0",
28123     "filename": "server/api/user/index.js",
28124     "groupTitle": "Users"
28125   },
28126   {
28127     "type": "post",
28128     "url": "/api/users/{id}/sms_interactions",
28129     "title": "Add sms interaction tabs to an agent",
28130     "examples": [
28131       {
28132         "title": "Example usage:",
28133         "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",
28134         "type": "json"
28135       }
28136     ],
28137     "name": "AddSmsInteractions",
28138     "group": "Users",
28139     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28140     "version": "0.0.0",
28141     "filename": "server/api/user/index.js",
28142     "groupTitle": "Users"
28143   },
28144   {
28145     "type": "post",
28146     "url": "/api/users/{id}/square_projects",
28147     "title": "Add a Square Project to a user",
28148     "examples": [
28149       {
28150         "title": "Example usage:",
28151         "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",
28152         "type": "json"
28153       }
28154     ],
28155     "name": "AddSquareProjects",
28156     "group": "Users",
28157     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28158     "version": "0.0.0",
28159     "filename": "server/api/user/index.js",
28160     "groupTitle": "Users"
28161   },
28162   {
28163     "type": "post",
28164     "url": "/api/users/{id}/teams",
28165     "title": "Add teams to an agent",
28166     "examples": [
28167       {
28168         "title": "Example usage:",
28169         "content": "curl https://{domain}/api/users/{id}/teams -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
28170         "type": "json"
28171       }
28172     ],
28173     "name": "AddTeams",
28174     "group": "Users",
28175     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28176     "version": "0.0.0",
28177     "filename": "server/api/user/index.js",
28178     "groupTitle": "Users"
28179   },
28180   {
28181     "type": "post",
28182     "url": "/api/users/{id}/whatsapp_accounts",
28183     "title": "Add a Whatsapp Account to a user",
28184     "examples": [
28185       {
28186         "title": "Example usage:",
28187         "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",
28188         "type": "json"
28189       }
28190     ],
28191     "name": "AddWhatsappAccounts",
28192     "group": "Users",
28193     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28194     "version": "0.0.0",
28195     "filename": "server/api/user/index.js",
28196     "groupTitle": "Users"
28197   },
28198   {
28199     "type": "post",
28200     "url": "/api/users/{id}/whatsapp_interactions",
28201     "title": "Add Whatsapp interaction tabs to an agent",
28202     "examples": [
28203       {
28204         "title": "Example usage:",
28205         "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",
28206         "type": "json"
28207       }
28208     ],
28209     "name": "AddWhatsappInteractions",
28210     "group": "Users",
28211     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28212     "version": "0.0.0",
28213     "filename": "server/api/user/index.js",
28214     "groupTitle": "Users"
28215   },
28216   {
28217     "type": "post",
28218     "url": "/api/users/create_many",
28219     "title": "Creates many Users",
28220     "examples": [
28221       {
28222         "title": "Example usage:",
28223         "content": "curl https://{domain}/api/users/create_many -d '[{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}]' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
28224         "type": "json"
28225       }
28226     ],
28227     "name": "BulkCreateUsers",
28228     "group": "Users",
28229     "parameter": {
28230       "fields": {
28231         "Body": [
28232           {
28233             "group": "Body",
28234             "type": "String",
28235             "optional": false,
28236             "field": "name",
28237             "description": "<p>The name of the user</p>"
28238           },
28239           {
28240             "group": "Body",
28241             "type": "String",
28242             "optional": false,
28243             "field": "fullname",
28244             "description": ""
28245           },
28246           {
28247             "group": "Body",
28248             "type": "String",
28249             "optional": true,
28250             "field": "alias",
28251             "description": ""
28252           },
28253           {
28254             "group": "Body",
28255             "type": "String",
28256             "optional": false,
28257             "field": "email",
28258             "description": ""
28259           },
28260           {
28261             "group": "Body",
28262             "type": "String",
28263             "allowedValues": [
28264               "\"admin\"",
28265               "\"user\"",
28266               "\"agent\"",
28267               "\"telephone\""
28268             ],
28269             "optional": false,
28270             "field": "role",
28271             "description": ""
28272           },
28273           {
28274             "group": "Body",
28275             "type": "String",
28276             "optional": false,
28277             "field": "password",
28278             "description": ""
28279           },
28280           {
28281             "group": "Body",
28282             "type": "String",
28283             "optional": true,
28284             "field": "provider",
28285             "description": ""
28286           },
28287           {
28288             "group": "Body",
28289             "type": "Integer",
28290             "optional": false,
28291             "field": "internal",
28292             "description": ""
28293           },
28294           {
28295             "group": "Body",
28296             "type": "String",
28297             "optional": true,
28298             "field": "salt",
28299             "description": ""
28300           },
28301           {
28302             "group": "Body",
28303             "type": "String",
28304             "optional": true,
28305             "field": "phone",
28306             "description": ""
28307           },
28308           {
28309             "group": "Body",
28310             "type": "String",
28311             "optional": true,
28312             "field": "mobile",
28313             "description": ""
28314           },
28315           {
28316             "group": "Body",
28317             "type": "String",
28318             "optional": true,
28319             "field": "address",
28320             "description": ""
28321           },
28322           {
28323             "group": "Body",
28324             "type": "String",
28325             "optional": true,
28326             "field": "zipcode",
28327             "description": ""
28328           },
28329           {
28330             "group": "Body",
28331             "type": "String",
28332             "optional": true,
28333             "field": "userpic",
28334             "description": ""
28335           },
28336           {
28337             "group": "Body",
28338             "type": "String",
28339             "optional": true,
28340             "field": "city",
28341             "description": ""
28342           },
28343           {
28344             "group": "Body",
28345             "type": "String",
28346             "optional": true,
28347             "field": "country",
28348             "description": ""
28349           },
28350           {
28351             "group": "Body",
28352             "type": "Boolean",
28353             "optional": true,
28354             "field": "online",
28355             "description": ""
28356           },
28357           {
28358             "group": "Body",
28359             "type": "String",
28360             "optional": true,
28361             "field": "lastLoginAt",
28362             "description": ""
28363           },
28364           {
28365             "group": "Body",
28366             "type": "Boolean",
28367             "optional": true,
28368             "field": "voicePause",
28369             "description": ""
28370           },
28371           {
28372             "group": "Body",
28373             "type": "Boolean",
28374             "optional": true,
28375             "field": "chatPause",
28376             "description": ""
28377           },
28378           {
28379             "group": "Body",
28380             "type": "Boolean",
28381             "optional": true,
28382             "field": "mailPause",
28383             "description": ""
28384           },
28385           {
28386             "group": "Body",
28387             "type": "Boolean",
28388             "optional": true,
28389             "field": "faxPause",
28390             "description": ""
28391           },
28392           {
28393             "group": "Body",
28394             "type": "Boolean",
28395             "optional": true,
28396             "field": "smsPause",
28397             "description": ""
28398           },
28399           {
28400             "group": "Body",
28401             "type": "Boolean",
28402             "optional": true,
28403             "field": "whatsappPause",
28404             "description": ""
28405           },
28406           {
28407             "group": "Body",
28408             "type": "Boolean",
28409             "optional": true,
28410             "field": "openchannelPause",
28411             "description": ""
28412           },
28413           {
28414             "group": "Body",
28415             "type": "String",
28416             "optional": true,
28417             "field": "pauseType",
28418             "description": ""
28419           },
28420           {
28421             "group": "Body",
28422             "type": "String",
28423             "optional": true,
28424             "field": "lastPauseAt",
28425             "description": ""
28426           },
28427           {
28428             "group": "Body",
28429             "type": "Integer",
28430             "optional": true,
28431             "field": "chatCapacity",
28432             "description": ""
28433           },
28434           {
28435             "group": "Body",
28436             "type": "Integer",
28437             "optional": true,
28438             "field": "mailCapacity",
28439             "description": ""
28440           },
28441           {
28442             "group": "Body",
28443             "type": "Integer",
28444             "optional": true,
28445             "field": "faxCapacity",
28446             "description": ""
28447           },
28448           {
28449             "group": "Body",
28450             "type": "Integer",
28451             "optional": true,
28452             "field": "smsCapacity",
28453             "description": ""
28454           },
28455           {
28456             "group": "Body",
28457             "type": "Integer",
28458             "optional": true,
28459             "field": "whatsappCapacity",
28460             "description": ""
28461           },
28462           {
28463             "group": "Body",
28464             "type": "Integer",
28465             "optional": true,
28466             "field": "openchannelCapacity",
28467             "description": ""
28468           },
28469           {
28470             "group": "Body",
28471             "type": "Boolean",
28472             "optional": true,
28473             "field": "phoneBarAutoAnswer",
28474             "description": ""
28475           },
28476           {
28477             "group": "Body",
28478             "type": "Boolean",
28479             "optional": true,
28480             "field": "phoneBarEnableSettings",
28481             "description": ""
28482           },
28483           {
28484             "group": "Body",
28485             "type": "Integer",
28486             "optional": true,
28487             "field": "phoneBarListenPort",
28488             "description": ""
28489           },
28490           {
28491             "group": "Body",
28492             "type": "Integer",
28493             "optional": true,
28494             "field": "phoneBarExpires",
28495             "description": ""
28496           },
28497           {
28498             "group": "Body",
28499             "type": "Boolean",
28500             "optional": true,
28501             "field": "phoneBarRemoteControl",
28502             "description": ""
28503           },
28504           {
28505             "group": "Body",
28506             "type": "Integer",
28507             "optional": true,
28508             "field": "phoneBarRemoteControlPort",
28509             "description": ""
28510           },
28511           {
28512             "group": "Body",
28513             "type": "Boolean",
28514             "optional": true,
28515             "field": "phoneBarEnableRecording",
28516             "description": ""
28517           },
28518           {
28519             "group": "Body",
28520             "type": "Boolean",
28521             "optional": true,
28522             "field": "phoneBarRingInUse",
28523             "description": ""
28524           },
28525           {
28526             "group": "Body",
28527             "type": "Boolean",
28528             "optional": true,
28529             "field": "chanspy",
28530             "description": ""
28531           },
28532           {
28533             "group": "Body",
28534             "type": "String",
28535             "optional": true,
28536             "field": "description",
28537             "description": ""
28538           },
28539           {
28540             "group": "Body",
28541             "type": "String",
28542             "optional": true,
28543             "field": "host",
28544             "description": ""
28545           },
28546           {
28547             "group": "Body",
28548             "type": "String",
28549             "optional": true,
28550             "field": "ipaddr",
28551             "description": ""
28552           },
28553           {
28554             "group": "Body",
28555             "type": "Integer",
28556             "optional": true,
28557             "field": "port",
28558             "description": ""
28559           },
28560           {
28561             "group": "Body",
28562             "type": "Integer",
28563             "optional": true,
28564             "field": "regseconds",
28565             "description": ""
28566           },
28567           {
28568             "group": "Body",
28569             "type": "String",
28570             "optional": true,
28571             "field": "fullcontact",
28572             "description": ""
28573           },
28574           {
28575             "group": "Body",
28576             "type": "String",
28577             "optional": true,
28578             "field": "regserver",
28579             "description": ""
28580           },
28581           {
28582             "group": "Body",
28583             "type": "String",
28584             "optional": true,
28585             "field": "useragent",
28586             "description": ""
28587           },
28588           {
28589             "group": "Body",
28590             "type": "Integer",
28591             "optional": true,
28592             "field": "lastms",
28593             "description": ""
28594           },
28595           {
28596             "group": "Body",
28597             "type": "String",
28598             "allowedValues": [
28599               "\"friend\"",
28600               "\"user\"",
28601               "\"peer\""
28602             ],
28603             "optional": true,
28604             "field": "type",
28605             "description": ""
28606           },
28607           {
28608             "group": "Body",
28609             "type": "String",
28610             "optional": true,
28611             "field": "context",
28612             "description": ""
28613           },
28614           {
28615             "group": "Body",
28616             "type": "String",
28617             "allowedValues": [
28618               "\"ALLOWED_NOT_SCREENED\"",
28619               "\"ALLOWED_PASSED_SCREEN\"",
28620               "\"ALLOWED_FAILED_SCREEN\"",
28621               "\"ALLOWED\"",
28622               "\"PROHIB_NOT_SCREENED\"",
28623               "\"PROHIB_PASSED_SCREEN\"",
28624               "\"PROHIB_FAILED_SCREEN\"",
28625               "\"PROHIB\""
28626             ],
28627             "optional": true,
28628             "field": "callingpres",
28629             "description": ""
28630           },
28631           {
28632             "group": "Body",
28633             "type": "String",
28634             "optional": true,
28635             "field": "deny",
28636             "description": ""
28637           },
28638           {
28639             "group": "Body",
28640             "type": "String",
28641             "optional": true,
28642             "field": "permit",
28643             "description": ""
28644           },
28645           {
28646             "group": "Body",
28647             "type": "String",
28648             "optional": true,
28649             "field": "secret",
28650             "description": ""
28651           },
28652           {
28653             "group": "Body",
28654             "type": "String",
28655             "optional": true,
28656             "field": "md5secret",
28657             "description": ""
28658           },
28659           {
28660             "group": "Body",
28661             "type": "String",
28662             "optional": true,
28663             "field": "remotesecret",
28664             "description": ""
28665           },
28666           {
28667             "group": "Body",
28668             "type": "String",
28669             "optional": true,
28670             "field": "transport",
28671             "description": "<p>String is deprecated. Please use an Array as [&quot;udp&quot;, &quot;tcp&quot;]</p>"
28672           },
28673           {
28674             "group": "Body",
28675             "type": "String",
28676             "allowedValues": [
28677               "\"rfc2833\"",
28678               "\"info\"",
28679               "\"shortinfo\"",
28680               "\"inband\"",
28681               "\"auto\""
28682             ],
28683             "optional": true,
28684             "field": "dtmfmode",
28685             "description": ""
28686           },
28687           {
28688             "group": "Body",
28689             "type": "String",
28690             "allowedValues": [
28691               "\"yes\"",
28692               "\"no\"",
28693               "\"nonat\"",
28694               "\"update\"",
28695               "\"outgoing\""
28696             ],
28697             "optional": true,
28698             "field": "directmedia",
28699             "description": ""
28700           },
28701           {
28702             "group": "Body",
28703             "type": "String",
28704             "allowedValues": [
28705               "\"yes\"",
28706               "\"no\""
28707             ],
28708             "optional": true,
28709             "field": "directrtpsetup",
28710             "description": ""
28711           },
28712           {
28713             "group": "Body",
28714             "type": "String",
28715             "optional": true,
28716             "field": "directmediapermit",
28717             "description": ""
28718           },
28719           {
28720             "group": "Body",
28721             "type": "String",
28722             "optional": true,
28723             "field": "directmediadeny",
28724             "description": ""
28725           },
28726           {
28727             "group": "Body",
28728             "type": "String",
28729             "optional": true,
28730             "field": "nat",
28731             "description": "<p>String is deprecated. Please use an Array as [&quot;force_rport&quot;, &quot;comedia&quot;]</p>"
28732           },
28733           {
28734             "group": "Body",
28735             "type": "String",
28736             "optional": true,
28737             "field": "callgroup",
28738             "description": ""
28739           },
28740           {
28741             "group": "Body",
28742             "type": "String",
28743             "optional": true,
28744             "field": "namedcallgroup",
28745             "description": ""
28746           },
28747           {
28748             "group": "Body",
28749             "type": "String",
28750             "optional": true,
28751             "field": "pickupgroup",
28752             "description": ""
28753           },
28754           {
28755             "group": "Body",
28756             "type": "String",
28757             "optional": true,
28758             "field": "namedpickupgroup",
28759             "description": ""
28760           },
28761           {
28762             "group": "Body",
28763             "type": "String",
28764             "optional": true,
28765             "field": "language",
28766             "description": ""
28767           },
28768           {
28769             "group": "Body",
28770             "type": "String",
28771             "optional": true,
28772             "field": "tonezone",
28773             "description": ""
28774           },
28775           {
28776             "group": "Body",
28777             "type": "String",
28778             "optional": false,
28779             "field": "disallow",
28780             "description": ""
28781           },
28782           {
28783             "group": "Body",
28784             "type": "String",
28785             "optional": false,
28786             "field": "allow",
28787             "description": "<p>String is deprecated. Please use an Array as [&quot;ulaw&quot;, &quot;alaw&quot;, &quot;gsm&quot;]</p>"
28788           },
28789           {
28790             "group": "Body",
28791             "type": "String",
28792             "allowedValues": [
28793               "\"yes\"",
28794               "\"no\""
28795             ],
28796             "optional": true,
28797             "field": "autoframing",
28798             "description": ""
28799           },
28800           {
28801             "group": "Body",
28802             "type": "String",
28803             "optional": true,
28804             "field": "insecure",
28805             "description": "<p>String is deprecated. Please use an Array as [&quot;port&quot;, &quot;invite&quot;]</p>"
28806           },
28807           {
28808             "group": "Body",
28809             "type": "String",
28810             "allowedValues": [
28811               "\"yes\"",
28812               "\"no\""
28813             ],
28814             "optional": true,
28815             "field": "trustrpid",
28816             "description": ""
28817           },
28818           {
28819             "group": "Body",
28820             "type": "String",
28821             "allowedValues": [
28822               "\"yes\"",
28823               "\"no\""
28824             ],
28825             "optional": true,
28826             "field": "trust_id_outbound",
28827             "description": ""
28828           },
28829           {
28830             "group": "Body",
28831             "type": "String",
28832             "allowedValues": [
28833               "\"yes\"",
28834               "\"no\"",
28835               "\"never\""
28836             ],
28837             "optional": true,
28838             "field": "progressinband",
28839             "description": ""
28840           },
28841           {
28842             "group": "Body",
28843             "type": "String",
28844             "allowedValues": [
28845               "\"yes\"",
28846               "\"no\""
28847             ],
28848             "optional": true,
28849             "field": "promiscredir",
28850             "description": ""
28851           },
28852           {
28853             "group": "Body",
28854             "type": "String",
28855             "allowedValues": [
28856               "\"yes\"",
28857               "\"no\""
28858             ],
28859             "optional": true,
28860             "field": "useclientcode",
28861             "description": ""
28862           },
28863           {
28864             "group": "Body",
28865             "type": "Integer",
28866             "optional": true,
28867             "field": "accountcode",
28868             "description": ""
28869           },
28870           {
28871             "group": "Body",
28872             "type": "String",
28873             "optional": true,
28874             "field": "setvar",
28875             "description": ""
28876           },
28877           {
28878             "group": "Body",
28879             "type": "String",
28880             "optional": true,
28881             "field": "callerid",
28882             "description": ""
28883           },
28884           {
28885             "group": "Body",
28886             "type": "String",
28887             "optional": true,
28888             "field": "amaflags",
28889             "description": ""
28890           },
28891           {
28892             "group": "Body",
28893             "type": "String",
28894             "allowedValues": [
28895               "\"yes\"",
28896               "\"no\""
28897             ],
28898             "optional": true,
28899             "field": "callcounter",
28900             "description": ""
28901           },
28902           {
28903             "group": "Body",
28904             "type": "Integer",
28905             "optional": true,
28906             "field": "busylevel",
28907             "description": ""
28908           },
28909           {
28910             "group": "Body",
28911             "type": "String",
28912             "allowedValues": [
28913               "\"yes\"",
28914               "\"no\""
28915             ],
28916             "optional": true,
28917             "field": "allowoverlap",
28918             "description": ""
28919           },
28920           {
28921             "group": "Body",
28922             "type": "String",
28923             "allowedValues": [
28924               "\"yes\"",
28925               "\"no\""
28926             ],
28927             "optional": true,
28928             "field": "allowsubscribe",
28929             "description": ""
28930           },
28931           {
28932             "group": "Body",
28933             "type": "String",
28934             "allowedValues": [
28935               "\"yes\"",
28936               "\"no\""
28937             ],
28938             "optional": true,
28939             "field": "allowtransfer",
28940             "description": ""
28941           },
28942           {
28943             "group": "Body",
28944             "type": "String",
28945             "allowedValues": [
28946               "\"yes\"",
28947               "\"no\""
28948             ],
28949             "optional": true,
28950             "field": "ignoresdpversion",
28951             "description": ""
28952           },
28953           {
28954             "group": "Body",
28955             "type": "String",
28956             "optional": true,
28957             "field": "subscribecontext",
28958             "description": ""
28959           },
28960           {
28961             "group": "Body",
28962             "type": "String",
28963             "optional": true,
28964             "field": "template",
28965             "description": ""
28966           },
28967           {
28968             "group": "Body",
28969             "type": "String",
28970             "allowedValues": [
28971               "\"yes\"",
28972               "\"no\"",
28973               "\"always\""
28974             ],
28975             "optional": true,
28976             "field": "videosupport",
28977             "description": ""
28978           },
28979           {
28980             "group": "Body",
28981             "type": "Integer",
28982             "optional": true,
28983             "field": "maxcallbitrate",
28984             "description": ""
28985           },
28986           {
28987             "group": "Body",
28988             "type": "String",
28989             "allowedValues": [
28990               "\"yes\"",
28991               "\"no\""
28992             ],
28993             "optional": true,
28994             "field": "rfc2833compensate",
28995             "description": ""
28996           },
28997           {
28998             "group": "Body",
28999             "type": "String",
29000             "optional": true,
29001             "field": "mailbox",
29002             "description": ""
29003           },
29004           {
29005             "group": "Body",
29006             "type": "String",
29007             "allowedValues": [
29008               "\"accept\"",
29009               "\"refuse\"",
29010               "\"originate\""
29011             ],
29012             "optional": true,
29013             "field": "session_timers",
29014             "description": ""
29015           },
29016           {
29017             "group": "Body",
29018             "type": "Integer",
29019             "optional": true,
29020             "field": "session_expires",
29021             "description": ""
29022           },
29023           {
29024             "group": "Body",
29025             "type": "Integer",
29026             "optional": true,
29027             "field": "session_minse",
29028             "description": ""
29029           },
29030           {
29031             "group": "Body",
29032             "type": "String",
29033             "allowedValues": [
29034               "\"uac\"",
29035               "\"uas\""
29036             ],
29037             "optional": true,
29038             "field": "session_refresher",
29039             "description": ""
29040           },
29041           {
29042             "group": "Body",
29043             "type": "String",
29044             "optional": true,
29045             "field": "t38pt_usertpsource",
29046             "description": ""
29047           },
29048           {
29049             "group": "Body",
29050             "type": "String",
29051             "optional": true,
29052             "field": "regexten",
29053             "description": ""
29054           },
29055           {
29056             "group": "Body",
29057             "type": "String",
29058             "optional": true,
29059             "field": "fromdomain",
29060             "description": ""
29061           },
29062           {
29063             "group": "Body",
29064             "type": "String",
29065             "optional": true,
29066             "field": "fromuser",
29067             "description": ""
29068           },
29069           {
29070             "group": "Body",
29071             "type": "String",
29072             "allowedValues": [
29073               "\"yes\"",
29074               "\"no\""
29075             ],
29076             "optional": true,
29077             "field": "qualify",
29078             "description": ""
29079           },
29080           {
29081             "group": "Body",
29082             "type": "Integer",
29083             "optional": true,
29084             "field": "keepalive",
29085             "description": ""
29086           },
29087           {
29088             "group": "Body",
29089             "type": "String",
29090             "optional": true,
29091             "field": "defaultip",
29092             "description": ""
29093           },
29094           {
29095             "group": "Body",
29096             "type": "String",
29097             "optional": true,
29098             "field": "defaultuser",
29099             "description": ""
29100           },
29101           {
29102             "group": "Body",
29103             "type": "Integer",
29104             "optional": true,
29105             "field": "rtptimeout",
29106             "description": ""
29107           },
29108           {
29109             "group": "Body",
29110             "type": "Integer",
29111             "optional": true,
29112             "field": "rtpholdtimeout",
29113             "description": ""
29114           },
29115           {
29116             "group": "Body",
29117             "type": "Integer",
29118             "optional": true,
29119             "field": "rtpkeepalive",
29120             "description": ""
29121           },
29122           {
29123             "group": "Body",
29124             "type": "String",
29125             "allowedValues": [
29126               "\"yes\"",
29127               "\"no\""
29128             ],
29129             "optional": true,
29130             "field": "sendrpid",
29131             "description": ""
29132           },
29133           {
29134             "group": "Body",
29135             "type": "String",
29136             "optional": true,
29137             "field": "outboundproxy",
29138             "description": ""
29139           },
29140           {
29141             "group": "Body",
29142             "type": "String",
29143             "optional": true,
29144             "field": "callbackextension",
29145             "description": ""
29146           },
29147           {
29148             "group": "Body",
29149             "type": "Integer",
29150             "optional": true,
29151             "field": "timert1",
29152             "description": ""
29153           },
29154           {
29155             "group": "Body",
29156             "type": "Integer",
29157             "optional": true,
29158             "field": "timerb",
29159             "description": ""
29160           },
29161           {
29162             "group": "Body",
29163             "type": "Integer",
29164             "optional": true,
29165             "field": "qualifyfreq",
29166             "description": ""
29167           },
29168           {
29169             "group": "Body",
29170             "type": "String",
29171             "optional": true,
29172             "field": "contactpermit",
29173             "description": ""
29174           },
29175           {
29176             "group": "Body",
29177             "type": "String",
29178             "optional": true,
29179             "field": "contactdeny",
29180             "description": ""
29181           },
29182           {
29183             "group": "Body",
29184             "type": "String",
29185             "optional": true,
29186             "field": "contactacl",
29187             "description": ""
29188           },
29189           {
29190             "group": "Body",
29191             "type": "String",
29192             "optional": true,
29193             "field": "unsolicited_mailbox",
29194             "description": ""
29195           },
29196           {
29197             "group": "Body",
29198             "type": "String",
29199             "optional": true,
29200             "field": "use_q850_reason",
29201             "description": ""
29202           },
29203           {
29204             "group": "Body",
29205             "type": "Integer",
29206             "optional": true,
29207             "field": "maxforwards",
29208             "description": ""
29209           },
29210           {
29211             "group": "Body",
29212             "type": "String",
29213             "allowedValues": [
29214               "\"yes\"",
29215               "\"no\""
29216             ],
29217             "optional": true,
29218             "field": "encryption",
29219             "description": ""
29220           },
29221           {
29222             "group": "Body",
29223             "type": "String",
29224             "allowedValues": [
29225               "\"yes\"",
29226               "\"no\""
29227             ],
29228             "optional": true,
29229             "field": "avpf",
29230             "description": ""
29231           },
29232           {
29233             "group": "Body",
29234             "type": "String",
29235             "allowedValues": [
29236               "\"yes\"",
29237               "\"no\""
29238             ],
29239             "optional": true,
29240             "field": "force_avp",
29241             "description": ""
29242           },
29243           {
29244             "group": "Body",
29245             "type": "String",
29246             "allowedValues": [
29247               "\"yes\"",
29248               "\"no\""
29249             ],
29250             "optional": true,
29251             "field": "icesupport",
29252             "description": ""
29253           },
29254           {
29255             "group": "Body",
29256             "type": "String",
29257             "allowedValues": [
29258               "\"yes\"",
29259               "\"no\""
29260             ],
29261             "optional": true,
29262             "field": "dtlsenable",
29263             "description": ""
29264           },
29265           {
29266             "group": "Body",
29267             "type": "String",
29268             "allowedValues": [
29269               "\"yes\"",
29270               "\"no\"",
29271               "\"fingerprint\"",
29272               "\"certificate\""
29273             ],
29274             "optional": true,
29275             "field": "dtlsverify",
29276             "description": ""
29277           },
29278           {
29279             "group": "Body",
29280             "type": "Integer",
29281             "optional": true,
29282             "field": "dtlsrekey",
29283             "description": ""
29284           },
29285           {
29286             "group": "Body",
29287             "type": "String",
29288             "optional": true,
29289             "field": "dtlscertfile",
29290             "description": ""
29291           },
29292           {
29293             "group": "Body",
29294             "type": "String",
29295             "optional": true,
29296             "field": "dtlsprivatekey",
29297             "description": ""
29298           },
29299           {
29300             "group": "Body",
29301             "type": "String",
29302             "optional": true,
29303             "field": "dtlscipher",
29304             "description": ""
29305           },
29306           {
29307             "group": "Body",
29308             "type": "String",
29309             "optional": true,
29310             "field": "dtlscafile",
29311             "description": ""
29312           },
29313           {
29314             "group": "Body",
29315             "type": "String",
29316             "optional": true,
29317             "field": "dtlscapath",
29318             "description": ""
29319           },
29320           {
29321             "group": "Body",
29322             "type": "String",
29323             "allowedValues": [
29324               "\"active\"",
29325               "\"passive\"",
29326               "\"actpass\""
29327             ],
29328             "optional": true,
29329             "field": "dtlssetup",
29330             "description": ""
29331           },
29332           {
29333             "group": "Body",
29334             "type": "String",
29335             "optional": true,
29336             "field": "dtlsfingerprint",
29337             "description": ""
29338           },
29339           {
29340             "group": "Body",
29341             "type": "String",
29342             "allowedValues": [
29343               "\"yes\"",
29344               "\"no\""
29345             ],
29346             "optional": true,
29347             "field": "usereqphone",
29348             "description": ""
29349           },
29350           {
29351             "group": "Body",
29352             "type": "String",
29353             "optional": true,
29354             "field": "recordonfeature",
29355             "description": ""
29356           },
29357           {
29358             "group": "Body",
29359             "type": "String",
29360             "optional": true,
29361             "field": "recordofffeature",
29362             "description": ""
29363           },
29364           {
29365             "group": "Body",
29366             "type": "Integer",
29367             "optional": true,
29368             "field": "call_limit",
29369             "description": ""
29370           },
29371           {
29372             "group": "Body",
29373             "type": "String",
29374             "allowedValues": [
29375               "\"yes\"",
29376               "\"no\""
29377             ],
29378             "optional": true,
29379             "field": "registertrying",
29380             "description": ""
29381           },
29382           {
29383             "group": "Body",
29384             "type": "String",
29385             "allowedValues": [
29386               "\"yes\"",
29387               "\"no\""
29388             ],
29389             "optional": true,
29390             "field": "subscribemwi",
29391             "description": ""
29392           },
29393           {
29394             "group": "Body",
29395             "type": "String",
29396             "optional": true,
29397             "field": "vmexten",
29398             "description": ""
29399           },
29400           {
29401             "group": "Body",
29402             "type": "String",
29403             "optional": true,
29404             "field": "mohinterpret",
29405             "description": ""
29406           },
29407           {
29408             "group": "Body",
29409             "type": "String",
29410             "optional": true,
29411             "field": "mohsuggest",
29412             "description": ""
29413           },
29414           {
29415             "group": "Body",
29416             "type": "String",
29417             "optional": true,
29418             "field": "parkinglot",
29419             "description": ""
29420           },
29421           {
29422             "group": "Body",
29423             "type": "String",
29424             "allowedValues": [
29425               "\"yes\"",
29426               "\"no\"",
29427               "\"nonat\"",
29428               "\"update\"",
29429               "\"update,nonat\""
29430             ],
29431             "optional": true,
29432             "field": "canreinvite",
29433             "description": ""
29434           },
29435           {
29436             "group": "Body",
29437             "type": "Boolean",
29438             "optional": true,
29439             "field": "loginInPause",
29440             "description": ""
29441           },
29442           {
29443             "group": "Body",
29444             "type": "String",
29445             "optional": true,
29446             "field": "resetPasswordToken",
29447             "description": ""
29448           },
29449           {
29450             "group": "Body",
29451             "type": "String",
29452             "optional": true,
29453             "field": "resetPasswordExpires",
29454             "description": ""
29455           },
29456           {
29457             "group": "Body",
29458             "type": "Integer",
29459             "optional": true,
29460             "field": "showWebBar",
29461             "description": ""
29462           },
29463           {
29464             "group": "Body",
29465             "type": "Text",
29466             "optional": true,
29467             "field": "permissions",
29468             "description": ""
29469           },
29470           {
29471             "group": "Body",
29472             "type": "String",
29473             "optional": true,
29474             "field": "phoneBarUnconditionalNumber",
29475             "description": ""
29476           },
29477           {
29478             "group": "Body",
29479             "type": "String",
29480             "optional": true,
29481             "field": "phoneBarNoReplyNumber",
29482             "description": ""
29483           },
29484           {
29485             "group": "Body",
29486             "type": "String",
29487             "optional": true,
29488             "field": "phoneBarBusyNumber",
29489             "description": ""
29490           },
29491           {
29492             "group": "Body",
29493             "type": "Boolean",
29494             "optional": true,
29495             "field": "phoneBarUnconditional",
29496             "description": ""
29497           },
29498           {
29499             "group": "Body",
29500             "type": "Boolean",
29501             "optional": true,
29502             "field": "phoneBarNoReply",
29503             "description": ""
29504           },
29505           {
29506             "group": "Body",
29507             "type": "Boolean",
29508             "optional": true,
29509             "field": "phoneBarBusy",
29510             "description": ""
29511           },
29512           {
29513             "group": "Body",
29514             "type": "Boolean",
29515             "optional": true,
29516             "field": "phoneBarDnd",
29517             "description": ""
29518           },
29519           {
29520             "group": "Body",
29521             "type": "Boolean",
29522             "optional": true,
29523             "field": "phoneBarUnansweredCallBadge",
29524             "description": ""
29525           },
29526           {
29527             "group": "Body",
29528             "type": "Boolean",
29529             "optional": true,
29530             "field": "phoneBarEnableDtmfTone",
29531             "description": ""
29532           },
29533           {
29534             "group": "Body",
29535             "type": "Integer",
29536             "optional": true,
29537             "field": "phoneBarAutoAnswerDelay",
29538             "description": ""
29539           },
29540           {
29541             "group": "Body",
29542             "type": "String",
29543             "optional": true,
29544             "field": "extensionMonitor",
29545             "description": ""
29546           },
29547           {
29548             "group": "Body",
29549             "type": "Integer",
29550             "optional": true,
29551             "field": "crudPermissions",
29552             "description": ""
29553           },
29554           {
29555             "group": "Body",
29556             "type": "String",
29557             "allowedValues": [
29558               "\"yes\"",
29559               "\"no\""
29560             ],
29561             "optional": true,
29562             "field": "rtcp_mux",
29563             "description": ""
29564           },
29565           {
29566             "group": "Body",
29567             "type": "Boolean",
29568             "optional": true,
29569             "field": "allowmessenger",
29570             "description": ""
29571           },
29572           {
29573             "group": "Body",
29574             "type": "String",
29575             "optional": true,
29576             "field": "phoneBarOutboundProxy",
29577             "description": ""
29578           },
29579           {
29580             "group": "Body",
29581             "type": "String",
29582             "optional": true,
29583             "field": "passwordResetAt",
29584             "description": ""
29585           },
29586           {
29587             "group": "Body",
29588             "type": "Boolean",
29589             "optional": true,
29590             "field": "phoneBarEnableJaws",
29591             "description": ""
29592           },
29593           {
29594             "group": "Body",
29595             "type": "Boolean",
29596             "optional": true,
29597             "field": "phoneBarEnableScreenRecordingByAgent",
29598             "description": ""
29599           },
29600           {
29601             "group": "Body",
29602             "type": "Virtual",
29603             "optional": true,
29604             "field": "phoneBarEnableVideoRecording",
29605             "description": ""
29606           },
29607           {
29608             "group": "Body",
29609             "type": "Boolean",
29610             "optional": true,
29611             "field": "phoneBarEnableAutomaticScreenRecording",
29612             "description": ""
29613           },
29614           {
29615             "group": "Body",
29616             "type": "Boolean",
29617             "optional": true,
29618             "field": "phoneBarPrefixRequired",
29619             "description": ""
29620           },
29621           {
29622             "group": "Body",
29623             "type": "Boolean",
29624             "optional": true,
29625             "field": "hotdesk",
29626             "description": ""
29627           },
29628           {
29629             "group": "Body",
29630             "type": "String",
29631             "optional": true,
29632             "field": "interface",
29633             "description": ""
29634           },
29635           {
29636             "group": "Body",
29637             "type": "Boolean",
29638             "optional": true,
29639             "field": "privacyEnabled",
29640             "description": ""
29641           },
29642           {
29643             "group": "Body",
29644             "type": "String",
29645             "optional": true,
29646             "field": "apiKeyNonce",
29647             "description": ""
29648           },
29649           {
29650             "group": "Body",
29651             "type": "String",
29652             "optional": true,
29653             "field": "apiKeyIat",
29654             "description": ""
29655           },
29656           {
29657             "group": "Body",
29658             "type": "Boolean",
29659             "optional": true,
29660             "field": "screenrecording",
29661             "description": ""
29662           },
29663           {
29664             "group": "Body",
29665             "type": "Boolean",
29666             "optional": true,
29667             "field": "blocked",
29668             "description": ""
29669           },
29670           {
29671             "group": "Body",
29672             "type": "String",
29673             "optional": true,
29674             "field": "blockedAt",
29675             "description": ""
29676           },
29677           {
29678             "group": "Body",
29679             "type": "Integer",
29680             "optional": true,
29681             "field": "loginAttempts",
29682             "description": ""
29683           },
29684           {
29685             "group": "Body",
29686             "type": "Boolean",
29687             "optional": true,
29688             "field": "disabled",
29689             "description": ""
29690           }
29691         ]
29692       }
29693     },
29694     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29695     "version": "0.0.0",
29696     "filename": "server/api/user/index.js",
29697     "groupTitle": "Users"
29698   },
29699   {
29700     "type": "put",
29701     "url": "/api/users/{id}/password",
29702     "title": "Change user password",
29703     "examples": [
29704       {
29705         "title": "Example usage:",
29706         "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",
29707         "type": "json"
29708       }
29709     ],
29710     "name": "ChangePwd",
29711     "group": "Users",
29712     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29713     "version": "0.0.0",
29714     "filename": "server/api/user/index.js",
29715     "groupTitle": "Users"
29716   },
29717   {
29718     "type": "post",
29719     "url": "/api/users",
29720     "title": "Create a new user",
29721     "examples": [
29722       {
29723         "title": "Example usage:",
29724         "content": "curl https://{domain}/api/users -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
29725         "type": "json"
29726       }
29727     ],
29728     "name": "Create",
29729     "group": "Users",
29730     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29731     "version": "0.0.0",
29732     "filename": "server/api/user/index.js",
29733     "groupTitle": "Users"
29734   },
29735   {
29736     "type": "post",
29737     "url": "/api/users/{id}/api_key",
29738     "title": "Create a new API access key for the user",
29739     "examples": [
29740       {
29741         "title": "Example usage:",
29742         "content": "curl https://{domain}/api/users/:id/api_key -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
29743         "type": "json"
29744       }
29745     ],
29746     "name": "CreateApiKey",
29747     "group": "Users",
29748     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29749     "version": "0.0.0",
29750     "filename": "server/api/user/index.js",
29751     "groupTitle": "Users"
29752   },
29753   {
29754     "type": "delete",
29755     "url": "/api/users/{id}",
29756     "title": "Deletes a user",
29757     "examples": [
29758       {
29759         "title": "Example usage:",
29760         "content": "curl https://{domain}/api/users/{id} -v -u {name}:{password} -X DELETE",
29761         "type": "json"
29762       }
29763     ],
29764     "name": "Delete",
29765     "group": "Users",
29766     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29767     "version": "0.0.0",
29768     "filename": "server/api/user/index.js",
29769     "groupTitle": "Users"
29770   },
29771   {
29772     "type": "get",
29773     "url": "/api/users/describe",
29774     "title": "Gets table info about Users",
29775     "examples": [
29776       {
29777         "title": "Example usage:",
29778         "content": "curl https://{domain}/api/users/describe -v -u {name}:{password}",
29779         "type": "json"
29780       }
29781     ],
29782     "name": "DescribeUsers",
29783     "group": "Users",
29784     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29785     "version": "0.0.0",
29786     "filename": "server/api/user/index.js",
29787     "groupTitle": "Users"
29788   },
29789   {
29790     "type": "get",
29791     "url": "/api/users/{id}/agents",
29792     "title": "GetAgents",
29793     "examples": [
29794       {
29795         "title": "Example usage:",
29796         "content": "curl https://{domain}/api/users/{id}/agents -v -u {name}:{password} -X GET",
29797         "type": "json"
29798       }
29799     ],
29800     "name": "GetAgents",
29801     "group": "Users",
29802     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29803     "version": "0.0.0",
29804     "filename": "server/api/user/index.js",
29805     "groupTitle": "Users"
29806   },
29807   {
29808     "type": "get",
29809     "url": "/api/users/{id}/api_key",
29810     "title": "Get the API access key for the user",
29811     "examples": [
29812       {
29813         "title": "Example usage:",
29814         "content": "curl https://{domain}/api/users/:id/api_key -v -u {name}:{password} -X GET",
29815         "type": "json"
29816       }
29817     ],
29818     "name": "GetApiKey",
29819     "group": "Users",
29820     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29821     "version": "0.0.0",
29822     "filename": "server/api/user/index.js",
29823     "groupTitle": "Users"
29824   },
29825   {
29826     "type": "get",
29827     "url": "/api/users/{id}/groups",
29828     "title": "GetChatGroups",
29829     "examples": [
29830       {
29831         "title": "Example usage:",
29832         "content": "curl https://{domain}/api/users/{id}/groups -v -u {name}:{password} -X GET",
29833         "type": "json"
29834       }
29835     ],
29836     "name": "GetChatGroups",
29837     "group": "Users",
29838     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29839     "version": "0.0.0",
29840     "filename": "server/api/user/index.js",
29841     "groupTitle": "Users"
29842   },
29843   {
29844     "type": "get",
29845     "url": "/api/users/{id}/chat/interactions",
29846     "title": "GetChatInteractions",
29847     "examples": [
29848       {
29849         "title": "Example usage:",
29850         "content": "curl https://{domain}/api/users/{id}/chat/interactions -v -u {name}:{password} -X GET",
29851         "type": "json"
29852       }
29853     ],
29854     "name": "GetChatInteractions",
29855     "group": "Users",
29856     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29857     "version": "0.0.0",
29858     "filename": "server/api/user/index.js",
29859     "groupTitle": "Users"
29860   },
29861   {
29862     "type": "get",
29863     "url": "/api/users/{id}/chat_websites",
29864     "title": "GetChatWebsites",
29865     "examples": [
29866       {
29867         "title": "Example usage:",
29868         "content": "curl https://{domain}/api/users/{id}/chat_websites -v -u {name}:{password} -X GET",
29869         "type": "json"
29870       }
29871     ],
29872     "name": "GetChatWebsites",
29873     "group": "Users",
29874     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29875     "version": "0.0.0",
29876     "filename": "server/api/user/index.js",
29877     "groupTitle": "Users"
29878   },
29879   {
29880     "type": "get",
29881     "url": "/api/users/{id}/contacts",
29882     "title": "GetContacts",
29883     "examples": [
29884       {
29885         "title": "Example usage:",
29886         "content": "curl https://{domain}/api/users/{id}/contacts -v -u {name}:{password} -X GET",
29887         "type": "json"
29888       }
29889     ],
29890     "name": "GetContacts",
29891     "group": "Users",
29892     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29893     "version": "0.0.0",
29894     "filename": "server/api/user/index.js",
29895     "groupTitle": "Users"
29896   },
29897   {
29898     "type": "get",
29899     "url": "/api/users/{id}/fax_accounts",
29900     "title": "GetFaxAccounts",
29901     "examples": [
29902       {
29903         "title": "Example usage:",
29904         "content": "curl https://{domain}/api/users/{id}/fax_accounts -v -u {name}:{password} -X GET",
29905         "type": "json"
29906       }
29907     ],
29908     "name": "GetFaxAccounts",
29909     "group": "Users",
29910     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29911     "version": "0.0.0",
29912     "filename": "server/api/user/index.js",
29913     "groupTitle": "Users"
29914   },
29915   {
29916     "type": "get",
29917     "url": "/api/users/{id}/fax/interactions",
29918     "title": "GetFaxInteractions",
29919     "examples": [
29920       {
29921         "title": "Example usage:",
29922         "content": "curl https://{domain}/api/users/{id}/fax/interactions -v -u {name}:{password} -X GET",
29923         "type": "json"
29924       }
29925     ],
29926     "name": "GetFaxInteractions",
29927     "group": "Users",
29928     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29929     "version": "0.0.0",
29930     "filename": "server/api/user/index.js",
29931     "groupTitle": "Users"
29932   },
29933   {
29934     "type": "get",
29935     "url": "/api/users/{id}/lists",
29936     "title": "GetLists",
29937     "examples": [
29938       {
29939         "title": "Example usage:",
29940         "content": "curl https://{domain}/api/users/{id}/lists -v -u {name}:{password} -X GET",
29941         "type": "json"
29942       }
29943     ],
29944     "name": "GetLists",
29945     "group": "Users",
29946     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29947     "version": "0.0.0",
29948     "filename": "server/api/user/index.js",
29949     "groupTitle": "Users"
29950   },
29951   {
29952     "type": "get",
29953     "url": "/api/users/{id}/mail_accounts",
29954     "title": "GetMailAccounts",
29955     "examples": [
29956       {
29957         "title": "Example usage:",
29958         "content": "curl https://{domain}/api/users/{id}/mail_accounts -v -u {name}:{password} -X GET",
29959         "type": "json"
29960       }
29961     ],
29962     "name": "GetMailAccounts",
29963     "group": "Users",
29964     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29965     "version": "0.0.0",
29966     "filename": "server/api/user/index.js",
29967     "groupTitle": "Users"
29968   },
29969   {
29970     "type": "get",
29971     "url": "/api/users/{id}/mail/interactions",
29972     "title": "GetMailInteractions",
29973     "examples": [
29974       {
29975         "title": "Example usage:",
29976         "content": "curl https://{domain}/api/users/{id}/mail/interactions -v -u {name}:{password} -X GET",
29977         "type": "json"
29978       }
29979     ],
29980     "name": "GetMailInteractions",
29981     "group": "Users",
29982     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29983     "version": "0.0.0",
29984     "filename": "server/api/user/index.js",
29985     "groupTitle": "Users"
29986   },
29987   {
29988     "type": "get",
29989     "url": "/api/users/{id}/openchannel_accounts",
29990     "title": "GetOpenchannelAccounts",
29991     "examples": [
29992       {
29993         "title": "Example usage:",
29994         "content": "curl https://{domain}/api/users/{id}/openchannel_accounts -v -u {name}:{password} -X GET",
29995         "type": "json"
29996       }
29997     ],
29998     "name": "GetOpenchannelAccounts",
29999     "group": "Users",
30000     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30001     "version": "0.0.0",
30002     "filename": "server/api/user/index.js",
30003     "groupTitle": "Users"
30004   },
30005   {
30006     "type": "get",
30007     "url": "/api/users/{id}/openchannel/interactions",
30008     "title": "GetOpenchannelInteractions",
30009     "examples": [
30010       {
30011         "title": "Example usage:",
30012         "content": "curl https://{domain}/api/users/{id}/openchannel/interactions -v -u {name}:{password}",
30013         "type": "json"
30014       }
30015     ],
30016     "name": "GetOpenchannelInteractions",
30017     "group": "Users",
30018     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30019     "version": "0.0.0",
30020     "filename": "server/api/user/index.js",
30021     "groupTitle": "Users"
30022   },
30023   {
30024     "type": "get",
30025     "url": "/api/users/{id}/prefixes",
30026     "title": "GetPrefixes",
30027     "examples": [
30028       {
30029         "title": "Example usage:",
30030         "content": "curl https://{domain}/api/users/{id}/prefixes -v -u {name}:{password} -X GET",
30031         "type": "json"
30032       }
30033     ],
30034     "name": "GetPrefixes",
30035     "group": "Users",
30036     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30037     "version": "0.0.0",
30038     "filename": "server/api/user/index.js",
30039     "groupTitle": "Users"
30040   },
30041   {
30042     "type": "get",
30043     "url": "/api/users/{id}/queues?channel={channel}",
30044     "title": "Gets Queues list",
30045     "examples": [
30046       {
30047         "title": "Example usage:",
30048         "content": "curl https://{domain}/api/users/{id}/queues/?channel={channel} -v -u {name}:{password} -X GET",
30049         "type": "json"
30050       }
30051     ],
30052     "name": "GetQueues",
30053     "group": "Users",
30054     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30055     "version": "0.0.0",
30056     "filename": "server/api/user/index.js",
30057     "groupTitle": "Users"
30058   },
30059   {
30060     "type": "get",
30061     "url": "/api/users/{id}/recordings",
30062     "title": "GetRecordings",
30063     "examples": [
30064       {
30065         "title": "Example usage:",
30066         "content": "curl https://{domain}/api/users/{id}/recordings -v -u {name}:{password} -X GET",
30067         "type": "json"
30068       }
30069     ],
30070     "name": "GetRecordings",
30071     "group": "Users",
30072     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30073     "version": "0.0.0",
30074     "filename": "server/api/user/index.js",
30075     "groupTitle": "Users"
30076   },
30077   {
30078     "type": "get",
30079     "url": "/api/users/{id}/scheduled_calls",
30080     "title": "GetScheduledCalls",
30081     "examples": [
30082       {
30083         "title": "Example usage:",
30084         "content": "curl https://{domain}/api/users/{id}/scheduled_calls -v -u {name}:{password} -X GET",
30085         "type": "json"
30086       }
30087     ],
30088     "name": "GetScheduledCalls",
30089     "group": "Users",
30090     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30091     "version": "0.0.0",
30092     "filename": "server/api/user/index.js",
30093     "groupTitle": "Users"
30094   },
30095   {
30096     "type": "get",
30097     "url": "/api/users/{id}/screen_recordings",
30098     "title": "GetScreenRecordings",
30099     "examples": [
30100       {
30101         "title": "Example usage:",
30102         "content": "curl https://{domain}/api/users/{id}/screen_recordings -v -u {name}:{password} -X GET",
30103         "type": "json"
30104       }
30105     ],
30106     "name": "GetScreenRecordings",
30107     "group": "Users",
30108     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30109     "version": "0.0.0",
30110     "filename": "server/api/user/index.js",
30111     "groupTitle": "Users"
30112   },
30113   {
30114     "type": "get",
30115     "url": "/api/users/{id}/sms_accounts",
30116     "title": "GetSmsAccounts",
30117     "examples": [
30118       {
30119         "title": "Example usage:",
30120         "content": "curl https://{domain}/api/users/{id}/sms_accounts -v -u {name}:{password} -X GET",
30121         "type": "json"
30122       }
30123     ],
30124     "name": "GetSmsAccounts",
30125     "group": "Users",
30126     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30127     "version": "0.0.0",
30128     "filename": "server/api/user/index.js",
30129     "groupTitle": "Users"
30130   },
30131   {
30132     "type": "get",
30133     "url": "/api/users/{id}/sms/interactions",
30134     "title": "GetSmsInteractions",
30135     "examples": [
30136       {
30137         "title": "Example usage:",
30138         "content": "curl https://{domain}/api/users/{id}/sms/interactions -v -u {name}:{password} -X GET",
30139         "type": "json"
30140       }
30141     ],
30142     "name": "GetSmsInteractions",
30143     "group": "Users",
30144     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30145     "version": "0.0.0",
30146     "filename": "server/api/user/index.js",
30147     "groupTitle": "Users"
30148   },
30149   {
30150     "type": "get",
30151     "url": "/api/users/{id}/square_projects",
30152     "title": "GetSquareProjects",
30153     "examples": [
30154       {
30155         "title": "Example usage:",
30156         "content": "curl https://{domain}/api/users/{id}/square_projects -v -u {name}:{password} -X GET",
30157         "type": "json"
30158       }
30159     ],
30160     "name": "GetSquareProjects",
30161     "group": "Users",
30162     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30163     "version": "0.0.0",
30164     "filename": "server/api/user/index.js",
30165     "groupTitle": "Users"
30166   },
30167   {
30168     "type": "get",
30169     "url": "/api/users/{id}/teams",
30170     "title": "GetTeams",
30171     "examples": [
30172       {
30173         "title": "Example usage:",
30174         "content": "curl https://{domain}/api/users/{id}/teams -v -u {name}:{password} -X GET",
30175         "type": "json"
30176       }
30177     ],
30178     "name": "GetTeams",
30179     "group": "Users",
30180     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30181     "version": "0.0.0",
30182     "filename": "server/api/user/index.js",
30183     "groupTitle": "Users"
30184   },
30185   {
30186     "type": "get",
30187     "url": "/api/users",
30188     "title": "Gets a list of Users",
30189     "examples": [
30190       {
30191         "title": "Example usage:",
30192         "content": "curl https://{domain}/api/users -v -u {name}:{password}",
30193         "type": "json"
30194       }
30195     ],
30196     "name": "GetUsers",
30197     "group": "Users",
30198     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
30199     "version": "0.0.0",
30200     "filename": "server/api/user/index.js",
30201     "groupTitle": "Users"
30202   },
30203   {
30204     "type": "get",
30205     "url": "/api/users/{id}/queues_rt",
30206     "title": "GetVoiceQueuesRt",
30207     "examples": [
30208       {
30209         "title": "Example usage:",
30210         "content": "curl https://{domain}/api/users/{id}/queues_rt -v -u {name}:{password} -X GET",
30211         "type": "json"
30212       }
30213     ],
30214     "name": "GetVoiceQueuesRt",
30215     "group": "Users",
30216     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30217     "version": "0.0.0",
30218     "filename": "server/api/user/index.js",
30219     "groupTitle": "Users"
30220   },
30221   {
30222     "type": "get",
30223     "url": "/api/users/{id}/whatsapp_accounts",
30224     "title": "GetWhatsappAccounts",
30225     "examples": [
30226       {
30227         "title": "Example usage:",
30228         "content": "curl https://{domain}/api/users/{id}/whatsapp_accounts -v -u {name}:{password} -X GET",
30229         "type": "json"
30230       }
30231     ],
30232     "name": "GetWhatsappAccounts",
30233     "group": "Users",
30234     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30235     "version": "0.0.0",
30236     "filename": "server/api/user/index.js",
30237     "groupTitle": "Users"
30238   },
30239   {
30240     "type": "get",
30241     "url": "/api/users/{id}/whatsapp/interactions",
30242     "title": "GetWhatsappInteractions",
30243     "examples": [
30244       {
30245         "title": "Example usage:",
30246         "content": "curl https://{domain}/api/users/{id}/whatsapp/interactions -v -u {name}:{password} -X GET",
30247         "type": "json"
30248       }
30249     ],
30250     "name": "GetWhatsappInteractions",
30251     "group": "Users",
30252     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30253     "version": "0.0.0",
30254     "filename": "server/api/user/index.js",
30255     "groupTitle": "Users"
30256   },
30257   {
30258     "type": "post",
30259     "url": "/api/users/{id}/login",
30260     "title": "Login",
30261     "examples": [
30262       {
30263         "title": "Example usage:",
30264         "content": "curl https://{domain}/api/users/{id}/login  -v -u {name}:{password} -X POST",
30265         "type": "json"
30266       }
30267     ],
30268     "name": "Login",
30269     "group": "Users",
30270     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30271     "version": "0.0.0",
30272     "filename": "server/api/user/index.js",
30273     "groupTitle": "Users"
30274   },
30275   {
30276     "type": "post",
30277     "url": "/api/users/{id}/logout",
30278     "title": "Logout",
30279     "examples": [
30280       {
30281         "title": "Example usage:",
30282         "content": "curl https://{domain}/api/users/{id}/logout -v -u {name}:{password} -X POST",
30283         "type": "json"
30284       }
30285     ],
30286     "name": "Logout",
30287     "group": "Users",
30288     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30289     "version": "0.0.0",
30290     "filename": "server/api/user/index.js",
30291     "groupTitle": "Users"
30292   },
30293   {
30294     "type": "post",
30295     "url": "/api/users/{id}/pause",
30296     "title": "Pause",
30297     "examples": [
30298       {
30299         "title": "Example usage:",
30300         "content": "curl https://{domain}/api/users/{id}/pause -v -u {name}:{password} -X POST",
30301         "type": "json"
30302       }
30303     ],
30304     "name": "Pause",
30305     "group": "Users",
30306     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30307     "version": "0.0.0",
30308     "filename": "server/api/user/index.js",
30309     "groupTitle": "Users"
30310   },
30311   {
30312     "type": "delete",
30313     "url": "/api/users/{id}/api_key",
30314     "title": "Remove API access key for the user",
30315     "examples": [
30316       {
30317         "title": "Example usage:",
30318         "content": "curl https://{domain}/api/users/:id/api_key -v -u {name}:{password} -X DELETE",
30319         "type": "json"
30320       }
30321     ],
30322     "name": "RemoveApiKey",
30323     "group": "Users",
30324     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30325     "version": "0.0.0",
30326     "filename": "server/api/user/index.js",
30327     "groupTitle": "Users"
30328   },
30329   {
30330     "type": "delete",
30331     "url": "/api/users/{id}/chat_interactions",
30332     "title": "Removes interactions from an agent",
30333     "examples": [
30334       {
30335         "title": "Example usage:",
30336         "content": "curl https://{domain}/api/users/{id}/chat_interactions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
30337         "type": "json"
30338       }
30339     ],
30340     "name": "RemoveChatInteractions",
30341     "group": "Users",
30342     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30343     "version": "0.0.0",
30344     "filename": "server/api/user/index.js",
30345     "groupTitle": "Users"
30346   },
30347   {
30348     "type": "delete",
30349     "url": "/api/users/{id}/chat_websites",
30350     "title": "Removes a Chat Website from a user",
30351     "examples": [
30352       {
30353         "title": "Example usage:",
30354         "content": "curl https://{domain}/api/users/{id}/chat_websites?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
30355         "type": "json"
30356       }
30357     ],
30358     "name": "RemoveChatWebsites",
30359     "group": "Users",
30360     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30361     "version": "0.0.0",
30362     "filename": "server/api/user/index.js",
30363     "groupTitle": "Users"
30364   },
30365   {
30366     "type": "delete",
30367     "url": "/api/users/{id}/fax_accounts",
30368     "title": "Removes a Fax Account from a user",
30369     "examples": [
30370       {
30371         "title": "Example usage:",
30372         "content": "curl https://{domain}/api/users/{id}/fax_accounts?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
30373         "type": "json"
30374       }
30375     ],
30376     "name": "RemoveFaxAccounts",
30377     "group": "Users",
30378     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30379     "version": "0.0.0",
30380     "filename": "server/api/user/index.js",
30381     "groupTitle": "Users"
30382   },
30383   {
30384     "type": "delete",
30385     "url": "/api/users/{id}/fax_interactions",
30386     "title": "Removes interactions from an agent",
30387     "examples": [
30388       {
30389         "title": "Example usage:",
30390         "content": "curl https://{domain}/api/users/{id}/fax_interactions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
30391         "type": "json"
30392       }
30393     ],
30394     "name": "RemoveFaxInteractions",
30395     "group": "Users",
30396     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30397     "version": "0.0.0",
30398     "filename": "server/api/user/index.js",
30399     "groupTitle": "Users"
30400   },
30401   {
30402     "type": "delete",
30403     "url": "/api/users/{id}/mail_accounts",
30404     "title": "Removes a Mail Account from a user",
30405     "examples": [
30406       {
30407         "title": "Example usage:",
30408         "content": "curl https://{domain}/api/users/{id}/mail_accounts?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
30409         "type": "json"
30410       }
30411     ],
30412     "name": "RemoveMailAccounts",
30413     "group": "Users",
30414     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30415     "version": "0.0.0",
30416     "filename": "server/api/user/index.js",
30417     "groupTitle": "Users"
30418   },
30419   {
30420     "type": "delete",
30421     "url": "/api/users/{id}/mail_interactions",
30422     "title": "Removes interactions from an agent",
30423     "examples": [
30424       {
30425         "title": "Example usage:",
30426         "content": "curl https://{domain}/api/users/{id}/mail_interactions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
30427         "type": "json"
30428       }
30429     ],
30430     "name": "RemoveMailInteractions",
30431     "group": "Users",
30432     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30433     "version": "0.0.0",
30434     "filename": "server/api/user/index.js",
30435     "groupTitle": "Users"
30436   },
30437   {
30438     "type": "delete",
30439     "url": "/api/users/{id}/openchannel_accounts",
30440     "title": "Removes a Open Channel Account from a user",
30441     "examples": [
30442       {
30443         "title": "Example usage:",
30444         "content": "curl https://{domain}/api/users/{id}/openchannel_accounts?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
30445         "type": "json"
30446       }
30447     ],
30448     "name": "RemoveOpenchannelAccounts",
30449     "group": "Users",
30450     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30451     "version": "0.0.0",
30452     "filename": "server/api/user/index.js",
30453     "groupTitle": "Users"
30454   },
30455   {
30456     "type": "delete",
30457     "url": "/api/users/{id}/openchannel_interactions",
30458     "title": "Removes openchannel interactions from an agent",
30459     "examples": [
30460       {
30461         "title": "Example usage:",
30462         "content": "curl https://{domain}/api/users/{id}/openchannel_interactions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
30463         "type": "json"
30464       }
30465     ],
30466     "name": "RemoveOpenchannelInteractions",
30467     "group": "Users",
30468     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30469     "version": "0.0.0",
30470     "filename": "server/api/user/index.js",
30471     "groupTitle": "Users"
30472   },
30473   {
30474     "type": "delete",
30475     "url": "/api/users/{id}/queues",
30476     "title": "Remove queues to an agent",
30477     "examples": [
30478       {
30479         "title": "Example usage:",
30480         "content": "curl https://{domain}/api/users/{id}/queues?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
30481         "type": "json"
30482       }
30483     ],
30484     "name": "RemoveQueues",
30485     "group": "Users",
30486     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30487     "version": "0.0.0",
30488     "filename": "server/api/user/index.js",
30489     "groupTitle": "Users"
30490   },
30491   {
30492     "type": "delete",
30493     "url": "/api/users/{id}/sms_accounts",
30494     "title": "Removes a Sms Account from a user",
30495     "examples": [
30496       {
30497         "title": "Example usage:",
30498         "content": "curl https://{domain}/api/users/{id}/sms_accounts?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
30499         "type": "json"
30500       }
30501     ],
30502     "name": "RemoveSmsAccounts",
30503     "group": "Users",
30504     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30505     "version": "0.0.0",
30506     "filename": "server/api/user/index.js",
30507     "groupTitle": "Users"
30508   },
30509   {
30510     "type": "delete",
30511     "url": "/api/users/{id}/sms_interactions",
30512     "title": "Removes interactions from an agent",
30513     "examples": [
30514       {
30515         "title": "Example usage:",
30516         "content": "curl https://{domain}/api/users/{id}/sms_interactions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
30517         "type": "json"
30518       }
30519     ],
30520     "name": "RemoveSmsInteractions",
30521     "group": "Users",
30522     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30523     "version": "0.0.0",
30524     "filename": "server/api/user/index.js",
30525     "groupTitle": "Users"
30526   },
30527   {
30528     "type": "delete",
30529     "url": "/api/users/{id}/square_projects",
30530     "title": "Removes a Square Project from a user",
30531     "examples": [
30532       {
30533         "title": "Example usage:",
30534         "content": "curl https://{domain}/api/users/{id}/square_projects?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
30535         "type": "json"
30536       }
30537     ],
30538     "name": "RemoveSquareProjects",
30539     "group": "Users",
30540     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30541     "version": "0.0.0",
30542     "filename": "server/api/user/index.js",
30543     "groupTitle": "Users"
30544   },
30545   {
30546     "type": "delete",
30547     "url": "/api/users/{id}/teams",
30548     "title": "Removes teams from an agent",
30549     "examples": [
30550       {
30551         "title": "Example usage:",
30552         "content": "curl https://{domain}/api/users/{id}/teams?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
30553         "type": "json"
30554       }
30555     ],
30556     "name": "RemoveTeams",
30557     "group": "Users",
30558     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30559     "version": "0.0.0",
30560     "filename": "server/api/user/index.js",
30561     "groupTitle": "Users"
30562   },
30563   {
30564     "type": "delete",
30565     "url": "/api/users/{id}/whatsapp_accounts",
30566     "title": "Removes a Whatsapp Account from a user",
30567     "examples": [
30568       {
30569         "title": "Example usage:",
30570         "content": "curl https://{domain}/api/users/{id}/whatsapp_accounts?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
30571         "type": "json"
30572       }
30573     ],
30574     "name": "RemoveWhatsappAccounts",
30575     "group": "Users",
30576     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30577     "version": "0.0.0",
30578     "filename": "server/api/user/index.js",
30579     "groupTitle": "Users"
30580   },
30581   {
30582     "type": "delete",
30583     "url": "/api/users/{id}/whatsapp_interactions",
30584     "title": "Removes Whatsapp interactions from an agent",
30585     "examples": [
30586       {
30587         "title": "Example usage:",
30588         "content": "curl https://{domain}/api/users/{id}/whatsapp_interactions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
30589         "type": "json"
30590       }
30591     ],
30592     "name": "RemoveWhatsappInteractions",
30593     "group": "Users",
30594     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30595     "version": "0.0.0",
30596     "filename": "server/api/user/index.js",
30597     "groupTitle": "Users"
30598   },
30599   {
30600     "type": "get",
30601     "url": "/api/users/{id}",
30602     "title": "Gets a single User",
30603     "examples": [
30604       {
30605         "title": "Example usage:",
30606         "content": "curl https://{domain}/api/users/{id} -v -u {name}:{password}",
30607         "type": "json"
30608       }
30609     ],
30610     "name": "ShowUsers",
30611     "group": "Users",
30612     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30613     "version": "0.0.0",
30614     "filename": "server/api/user/index.js",
30615     "groupTitle": "Users"
30616   },
30617   {
30618     "type": "post",
30619     "url": "/api/users/{id}/unpause",
30620     "title": "Unpause",
30621     "examples": [
30622       {
30623         "title": "Example usage:",
30624         "content": "curl https://{domain}/api/users/{id}/unpause -v -u {name}:{password} -X POST",
30625         "type": "json"
30626       }
30627     ],
30628     "name": "Unpause",
30629     "group": "Users",
30630     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30631     "version": "0.0.0",
30632     "filename": "server/api/user/index.js",
30633     "groupTitle": "Users"
30634   },
30635   {
30636     "type": "get",
30637     "url": "/api/users/whoami",
30638     "title": "WhoAmI",
30639     "examples": [
30640       {
30641         "title": "Example usage:",
30642         "content": "curl https://{domain}/api/users/whoami -v -u {name}:{password} -X GET",
30643         "type": "json"
30644       }
30645     ],
30646     "name": "WhoAmI",
30647     "group": "Users",
30648     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30649     "version": "0.0.0",
30650     "filename": "server/api/user/index.js",
30651     "groupTitle": "Users"
30652   },
30653   {
30654     "type": "post",
30655     "url": "/api/users/{id}/avatar",
30656     "title": "Add avatar",
30657     "examples": [
30658       {
30659         "title": "Example usage:",
30660         "content": "curl https://{domain}/api/users/{id}/avatar -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
30661         "type": "json"
30662       }
30663     ],
30664     "name": "addAvatar",
30665     "group": "Users",
30666     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30667     "version": "0.0.0",
30668     "filename": "server/api/user/index.js",
30669     "groupTitle": "Users"
30670   },
30671   {
30672     "type": "get",
30673     "url": "/api/users/{id}/avatar",
30674     "title": "Get avatar",
30675     "examples": [
30676       {
30677         "title": "Example usage:",
30678         "content": "curl https://{domain}/api/users/{id}/avatar -v -u {name}:{password} -X GET",
30679         "type": "json"
30680       }
30681     ],
30682     "name": "getAvatar",
30683     "group": "Users",
30684     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30685     "version": "0.0.0",
30686     "filename": "server/api/user/index.js",
30687     "groupTitle": "Users"
30688   },
30689   {
30690     "type": "put",
30691     "url": "/api/users/{id}",
30692     "title": "Update an existing User",
30693     "examples": [
30694       {
30695         "title": "Example usage:",
30696         "content": "curl https://{domain}/api/users/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
30697         "type": "json"
30698       }
30699     ],
30700     "name": "updateUsers",
30701     "group": "Users",
30702     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30703     "version": "0.0.0",
30704     "filename": "server/api/user/index.js",
30705     "groupTitle": "Users"
30706   },
30707   {
30708     "type": "post",
30709     "url": "/api/variables",
30710     "title": "Creates a new Variable",
30711     "examples": [
30712       {
30713         "title": "Example usage:",
30714         "content": "curl https://{domain}/api/variables -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
30715         "type": "json"
30716       }
30717     ],
30718     "name": "CreateVariables",
30719     "group": "Variables",
30720     "parameter": {
30721       "fields": {
30722         "Body": [
30723           {
30724             "group": "Body",
30725             "type": "String",
30726             "optional": false,
30727             "field": "name",
30728             "description": ""
30729           },
30730           {
30731             "group": "Body",
30732             "type": "String",
30733             "optional": true,
30734             "field": "description",
30735             "description": ""
30736           }
30737         ]
30738       }
30739     },
30740     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30741     "version": "0.0.0",
30742     "filename": "server/api/variable/index.js",
30743     "groupTitle": "Variables"
30744   },
30745   {
30746     "type": "delete",
30747     "url": "/api/variables/{id}",
30748     "title": "Deletes a Variable",
30749     "examples": [
30750       {
30751         "title": "Example usage:",
30752         "content": "curl https://{domain}/api/variables/{id} -v -u {name}:{password} -X DELETE",
30753         "type": "json"
30754       }
30755     ],
30756     "name": "DeleteVariables",
30757     "group": "Variables",
30758     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30759     "version": "0.0.0",
30760     "filename": "server/api/variable/index.js",
30761     "groupTitle": "Variables"
30762   },
30763   {
30764     "type": "get",
30765     "url": "/api/variables",
30766     "title": "Gets a list of Variables",
30767     "examples": [
30768       {
30769         "title": "Example usage:",
30770         "content": "curl https://{domain}/api/variables -v -u {name}:{password}",
30771         "type": "json"
30772       }
30773     ],
30774     "name": "GetVariables",
30775     "group": "Variables",
30776     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
30777     "version": "0.0.0",
30778     "filename": "server/api/variable/index.js",
30779     "groupTitle": "Variables"
30780   },
30781   {
30782     "type": "get",
30783     "url": "/api/variables/{id}",
30784     "title": "Gets a single Variable",
30785     "examples": [
30786       {
30787         "title": "Example usage:",
30788         "content": "curl https://{domain}/api/variables/{id} -v -u {name}:{password}",
30789         "type": "json"
30790       }
30791     ],
30792     "name": "ShowVariables",
30793     "group": "Variables",
30794     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30795     "version": "0.0.0",
30796     "filename": "server/api/variable/index.js",
30797     "groupTitle": "Variables"
30798   },
30799   {
30800     "type": "put",
30801     "url": "/api/variables/{id}",
30802     "title": "Update an existing Variable",
30803     "examples": [
30804       {
30805         "title": "Example usage:",
30806         "content": "curl https://{domain}/api/variables/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
30807         "type": "json"
30808       }
30809     ],
30810     "name": "updateVariables",
30811     "group": "Variables",
30812     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30813     "version": "0.0.0",
30814     "filename": "server/api/variable/index.js",
30815     "groupTitle": "Variables"
30816   },
30817   {
30818     "type": "get",
30819     "url": "/api/version/fetch",
30820     "title": "Fetch git version",
30821     "examples": [
30822       {
30823         "title": "Example usage:",
30824         "content": "curl https://{domain}/api/version/fetch -v -u {name}:{password}",
30825         "type": "json"
30826       }
30827     ],
30828     "name": "FetchVersion",
30829     "group": "Version",
30830     "description": "<p>Motion run the following command: git fetch origin master</p>",
30831     "version": "0.0.0",
30832     "filename": "server/api/version/index.js",
30833     "groupTitle": "Version"
30834   },
30835   {
30836     "type": "get",
30837     "url": "/api/version",
30838     "title": "Gets version",
30839     "examples": [
30840       {
30841         "title": "Example usage:",
30842         "content": "curl https://{domain}/api/version -v -u {name}:{password}",
30843         "type": "json"
30844       }
30845     ],
30846     "name": "GetVersion",
30847     "group": "Version",
30848     "description": "<p>Motion returns the current and latest motion version.</p>",
30849     "version": "0.0.0",
30850     "filename": "server/api/version/index.js",
30851     "groupTitle": "Version"
30852   },
30853   {
30854     "type": "get",
30855     "url": "/api/version/migrations",
30856     "title": "Launch database migrations",
30857     "examples": [
30858       {
30859         "title": "Example usage:",
30860         "content": "curl https://{domain}/api/version/migrations -v -u {name}:{password}",
30861         "type": "json"
30862       }
30863     ],
30864     "name": "MigrateVersion",
30865     "group": "Version",
30866     "description": "<p>Motion launch the database migrations, according to the application version</p>",
30867     "version": "0.0.0",
30868     "filename": "server/api/version/index.js",
30869     "groupTitle": "Version"
30870   },
30871   {
30872     "type": "get",
30873     "url": "/api/version/pull",
30874     "title": "Pull git version",
30875     "examples": [
30876       {
30877         "title": "Example usage:",
30878         "content": "curl https://{domain}/api/version/pull -v -u {name}:{password}",
30879         "type": "json"
30880       }
30881     ],
30882     "name": "PullVersion",
30883     "group": "Version",
30884     "description": "<p>Motion run the following command: git pull</p>",
30885     "version": "0.0.0",
30886     "filename": "server/api/version/index.js",
30887     "groupTitle": "Version"
30888   },
30889   {
30890     "type": "get",
30891     "url": "/api/version/reset",
30892     "title": "Reset git version",
30893     "examples": [
30894       {
30895         "title": "Example usage:",
30896         "content": "curl https://{domain}/api/version/reset -v -u {name}:{password}",
30897         "type": "json"
30898       }
30899     ],
30900     "name": "ResetVersion",
30901     "group": "Version",
30902     "description": "<p>Motion run the following command: git reset --hard FETCH_HEAD</p>",
30903     "version": "0.0.0",
30904     "filename": "server/api/version/index.js",
30905     "groupTitle": "Version"
30906   },
30907   {
30908     "type": "get",
30909     "url": "/api/version/restart",
30910     "title": "Restart motion2 after update",
30911     "examples": [
30912       {
30913         "title": "Example usage:",
30914         "content": "curl https://{domain}/api/version/restart -v -u {name}:{password}",
30915         "type": "json"
30916       }
30917     ],
30918     "name": "RestartVersion",
30919     "group": "Version",
30920     "description": "<p>Motion run the following command: pm2 restart motion</p>",
30921     "version": "0.0.0",
30922     "filename": "server/api/version/index.js",
30923     "groupTitle": "Version"
30924   },
30925   {
30926     "type": "get",
30927     "url": "/api/voice/agents/reports/describe",
30928     "title": "Gets table info about Agent Reports",
30929     "examples": [
30930       {
30931         "title": "Example usage:",
30932         "content": "curl https://{domain}/api/voice/agents/reports/describe -v -u {name}:{password}",
30933         "type": "json"
30934       }
30935     ],
30936     "name": "DescribeAgent_Reports",
30937     "group": "Voice_Agent_Reports",
30938     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30939     "version": "0.0.0",
30940     "filename": "server/api/voiceAgentReport/index.js",
30941     "groupTitle": "Voice_Agent_Reports"
30942   },
30943   {
30944     "type": "get",
30945     "url": "/api/voice/agents/reports",
30946     "title": "Gets a list of Agent Reports",
30947     "examples": [
30948       {
30949         "title": "Example usage:",
30950         "content": "curl https://{domain}/api/voice/agents/reports -v -u {name}:{password}",
30951         "type": "json"
30952       }
30953     ],
30954     "name": "GetAgent_Reports",
30955     "group": "Voice_Agent_Reports",
30956     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
30957     "version": "0.0.0",
30958     "filename": "server/api/voiceAgentReport/index.js",
30959     "groupTitle": "Voice_Agent_Reports"
30960   },
30961   {
30962     "type": "get",
30963     "url": "/api/voice/agents/reports/{id}",
30964     "title": "Gets a single Agent Report",
30965     "examples": [
30966       {
30967         "title": "Example usage:",
30968         "content": "curl https://{domain}/api/voice/agents/reports/{id} -v -u {name}:{password}",
30969         "type": "json"
30970       }
30971     ],
30972     "name": "ShowAgent_Reports",
30973     "group": "Voice_Agent_Reports",
30974     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30975     "version": "0.0.0",
30976     "filename": "server/api/voiceAgentReport/index.js",
30977     "groupTitle": "Voice_Agent_Reports"
30978   },
30979   {
30980     "type": "get",
30981     "url": "/api/voice/calls/reports/describe",
30982     "title": "Gets table info about Call Reports",
30983     "examples": [
30984       {
30985         "title": "Example usage:",
30986         "content": "curl https://{domain}/api/voice/calls/reports/describe -v -u {name}:{password}",
30987         "type": "json"
30988       }
30989     ],
30990     "name": "DescribeCall_Reports",
30991     "group": "Voice_Call_Reports",
30992     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30993     "version": "0.0.0",
30994     "filename": "server/api/voiceCallReport/index.js",
30995     "groupTitle": "Voice_Call_Reports"
30996   },
30997   {
30998     "type": "get",
30999     "url": "/api/voice/calls/reports",
31000     "title": "Gets a list of Call Reports",
31001     "examples": [
31002       {
31003         "title": "Example usage:",
31004         "content": "curl https://{domain}/api/voice/calls/reports -v -u {name}:{password}",
31005         "type": "json"
31006       }
31007     ],
31008     "name": "GetCall_Reports",
31009     "group": "Voice_Call_Reports",
31010     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
31011     "version": "0.0.0",
31012     "filename": "server/api/voiceCallReport/index.js",
31013     "groupTitle": "Voice_Call_Reports"
31014   },
31015   {
31016     "type": "get",
31017     "url": "/api/voice/calls/reports/{id}",
31018     "title": "Gets a single Call Report",
31019     "examples": [
31020       {
31021         "title": "Example usage:",
31022         "content": "curl https://{domain}/api/voice/calls/reports/{id} -v -u {name}:{password}",
31023         "type": "json"
31024       }
31025     ],
31026     "name": "ShowCall_Reports",
31027     "group": "Voice_Call_Reports",
31028     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31029     "version": "0.0.0",
31030     "filename": "server/api/voiceCallReport/index.js",
31031     "groupTitle": "Voice_Call_Reports"
31032   },
31033   {
31034     "type": "put",
31035     "url": "/api/voice/calls/reports/{id}",
31036     "title": "Update a single cdr",
31037     "examples": [
31038       {
31039         "title": "Example usage:",
31040         "content": "curl https://{domain}/api/voice/calls/reports/{id} -d '{\"userDispositio\": \"OK\"}' -v -u {name}:{password} -X PUT",
31041         "type": "json"
31042       }
31043     ],
31044     "name": "update",
31045     "group": "Voice_Call_Reports",
31046     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31047     "version": "0.0.0",
31048     "filename": "server/api/voiceCallReport/index.js",
31049     "groupTitle": "Voice_Call_Reports"
31050   },
31051   {
31052     "type": "post",
31053     "url": "/api/voice/chanspy",
31054     "title": "Creates a new ChanSpy",
31055     "examples": [
31056       {
31057         "title": "Example usage:",
31058         "content": "curl https://{domain}/api/voice/chanspy -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
31059         "type": "json"
31060       }
31061     ],
31062     "name": "CreateChanSpy",
31063     "group": "Voice_ChanSpy",
31064     "parameter": {
31065       "fields": {
31066         "Body": [
31067           {
31068             "group": "Body",
31069             "type": "String",
31070             "optional": true,
31071             "field": "name",
31072             "description": ""
31073           },
31074           {
31075             "group": "Body",
31076             "type": "String",
31077             "optional": false,
31078             "field": "prefix",
31079             "description": ""
31080           },
31081           {
31082             "group": "Body",
31083             "type": "String",
31084             "optional": true,
31085             "field": "options",
31086             "description": ""
31087           },
31088           {
31089             "group": "Body",
31090             "type": "Boolean",
31091             "optional": true,
31092             "field": "auth",
31093             "description": ""
31094           },
31095           {
31096             "group": "Body",
31097             "type": "String",
31098             "optional": true,
31099             "field": "password",
31100             "description": ""
31101           },
31102           {
31103             "group": "Body",
31104             "type": "Boolean",
31105             "optional": true,
31106             "field": "record",
31107             "description": ""
31108           },
31109           {
31110             "group": "Body",
31111             "type": "String",
31112             "optional": true,
31113             "field": "recordingFormat",
31114             "description": ""
31115           },
31116           {
31117             "group": "Body",
31118             "type": "String",
31119             "optional": true,
31120             "field": "description",
31121             "description": ""
31122           }
31123         ]
31124       }
31125     },
31126     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31127     "version": "0.0.0",
31128     "filename": "server/api/voiceChanSpy/index.js",
31129     "groupTitle": "Voice_ChanSpy"
31130   },
31131   {
31132     "type": "delete",
31133     "url": "/api/voice/chanspy/{id}",
31134     "title": "Deletes a ChanSpy",
31135     "examples": [
31136       {
31137         "title": "Example usage:",
31138         "content": "curl https://{domain}/api/voice/chanspy/{id} -v -u {name}:{password} -X DELETE",
31139         "type": "json"
31140       }
31141     ],
31142     "name": "DeleteChanSpy",
31143     "group": "Voice_ChanSpy",
31144     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31145     "version": "0.0.0",
31146     "filename": "server/api/voiceChanSpy/index.js",
31147     "groupTitle": "Voice_ChanSpy"
31148   },
31149   {
31150     "type": "get",
31151     "url": "/api/voice/chanspy",
31152     "title": "Gets a list of ChanSpy",
31153     "examples": [
31154       {
31155         "title": "Example usage:",
31156         "content": "curl https://{domain}/api/voice/chanspy -v -u {name}:{password}",
31157         "type": "json"
31158       }
31159     ],
31160     "name": "GetChanSpy",
31161     "group": "Voice_ChanSpy",
31162     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
31163     "version": "0.0.0",
31164     "filename": "server/api/voiceChanSpy/index.js",
31165     "groupTitle": "Voice_ChanSpy"
31166   },
31167   {
31168     "type": "get",
31169     "url": "/api/voice/chanspy/{id}",
31170     "title": "Gets a single ChanSpy",
31171     "examples": [
31172       {
31173         "title": "Example usage:",
31174         "content": "curl https://{domain}/api/voice/chanspy/{id} -v -u {name}:{password}",
31175         "type": "json"
31176       }
31177     ],
31178     "name": "ShowChanSpy",
31179     "group": "Voice_ChanSpy",
31180     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31181     "version": "0.0.0",
31182     "filename": "server/api/voiceChanSpy/index.js",
31183     "groupTitle": "Voice_ChanSpy"
31184   },
31185   {
31186     "type": "put",
31187     "url": "/api/voice/chanspy/{id}",
31188     "title": "Update an existing ChanSpy",
31189     "examples": [
31190       {
31191         "title": "Example usage:",
31192         "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",
31193         "type": "json"
31194       }
31195     ],
31196     "name": "updateChanSpy",
31197     "group": "Voice_ChanSpy",
31198     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31199     "version": "0.0.0",
31200     "filename": "server/api/voiceChanSpy/index.js",
31201     "groupTitle": "Voice_ChanSpy"
31202   },
31203   {
31204     "type": "post",
31205     "url": "/api/voice/contexts",
31206     "title": "Create a new context",
31207     "examples": [
31208       {
31209         "title": "Example usage:",
31210         "content": "curl https://{domain}/api/voice/contexts -v -u {name}:{password} -X POST",
31211         "type": "json"
31212       }
31213     ],
31214     "name": "Create",
31215     "group": "Voice_Contexts",
31216     "parameter": {
31217       "fields": {
31218         "Body": [
31219           {
31220             "group": "Body",
31221             "type": "String",
31222             "optional": true,
31223             "field": "name",
31224             "description": ""
31225           },
31226           {
31227             "group": "Body",
31228             "type": "String",
31229             "optional": true,
31230             "field": "description",
31231             "description": ""
31232           },
31233           {
31234             "group": "Body",
31235             "type": "Boolean",
31236             "optional": true,
31237             "field": "defaultEntry",
31238             "description": ""
31239           }
31240         ]
31241       }
31242     },
31243     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31244     "version": "0.0.0",
31245     "filename": "server/api/voiceContext/index.js",
31246     "groupTitle": "Voice_Contexts"
31247   },
31248   {
31249     "type": "delete",
31250     "url": "/api/voice/contexts/{id}",
31251     "title": "Deletes a context",
31252     "examples": [
31253       {
31254         "title": "Example usage:",
31255         "content": "curl https://{domain}/api/voice/contexts/{id} -v -u {name}:{password} -X DELETE",
31256         "type": "json"
31257       }
31258     ],
31259     "name": "Delete",
31260     "group": "Voice_Contexts",
31261     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31262     "version": "0.0.0",
31263     "filename": "server/api/voiceContext/index.js",
31264     "groupTitle": "Voice_Contexts"
31265   },
31266   {
31267     "type": "get",
31268     "url": "/api/voice/contexts",
31269     "title": "Gets a list of Contexts",
31270     "examples": [
31271       {
31272         "title": "Example usage:",
31273         "content": "curl https://{domain}/api/voice/contexts -v -u {name}:{password}",
31274         "type": "json"
31275       }
31276     ],
31277     "name": "GetContexts",
31278     "group": "Voice_Contexts",
31279     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
31280     "version": "0.0.0",
31281     "filename": "server/api/voiceContext/index.js",
31282     "groupTitle": "Voice_Contexts"
31283   },
31284   {
31285     "type": "get",
31286     "url": "/api/voice/contexts/{id}",
31287     "title": "Gets a single Context",
31288     "examples": [
31289       {
31290         "title": "Example usage:",
31291         "content": "curl https://{domain}/api/voice/contexts/{id} -v -u {name}:{password}",
31292         "type": "json"
31293       }
31294     ],
31295     "name": "ShowContexts",
31296     "group": "Voice_Contexts",
31297     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31298     "version": "0.0.0",
31299     "filename": "server/api/voiceContext/index.js",
31300     "groupTitle": "Voice_Contexts"
31301   },
31302   {
31303     "type": "put",
31304     "url": "/api/voice/contexts/{id}",
31305     "title": "Update an existing context",
31306     "examples": [
31307       {
31308         "title": "Example usage:",
31309         "content": "curl https://{domain}/api/voice/contexts/{id} -v -u {name}:{password} -X PUT",
31310         "type": "json"
31311       }
31312     ],
31313     "name": "Update",
31314     "group": "Voice_Contexts",
31315     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31316     "version": "0.0.0",
31317     "filename": "server/api/voiceContext/index.js",
31318     "groupTitle": "Voice_Contexts"
31319   },
31320   {
31321     "type": "get",
31322     "url": "/api/voice/dials/reports/describe",
31323     "title": "Gets table info about Dial Reports",
31324     "examples": [
31325       {
31326         "title": "Example usage:",
31327         "content": "curl https://{domain}/api/voice/dials/reports/describe -v -u {name}:{password}",
31328         "type": "json"
31329       }
31330     ],
31331     "name": "DescribeDial_Reports",
31332     "group": "Voice_Dial_Reports",
31333     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31334     "version": "0.0.0",
31335     "filename": "server/api/voiceDialReport/index.js",
31336     "groupTitle": "Voice_Dial_Reports"
31337   },
31338   {
31339     "type": "get",
31340     "url": "/api/voice/dials/reports",
31341     "title": "Gets a list of Dial Reports",
31342     "examples": [
31343       {
31344         "title": "Example usage:",
31345         "content": "curl https://{domain}/api/voice/dials/reports -v -u {name}:{password}",
31346         "type": "json"
31347       }
31348     ],
31349     "name": "GetDial_Reports",
31350     "group": "Voice_Dial_Reports",
31351     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
31352     "version": "0.0.0",
31353     "filename": "server/api/voiceDialReport/index.js",
31354     "groupTitle": "Voice_Dial_Reports"
31355   },
31356   {
31357     "type": "get",
31358     "url": "/api/voice/dials/reports/{id}",
31359     "title": "Gets a single Dial Report",
31360     "examples": [
31361       {
31362         "title": "Example usage:",
31363         "content": "curl https://{domain}/api/voice/dials/reports/{id} -v -u {name}:{password}",
31364         "type": "json"
31365       }
31366     ],
31367     "name": "ShowDial_Reports",
31368     "group": "Voice_Dial_Reports",
31369     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31370     "version": "0.0.0",
31371     "filename": "server/api/voiceDialReport/index.js",
31372     "groupTitle": "Voice_Dial_Reports"
31373   },
31374   {
31375     "type": "delete",
31376     "url": "/api/voice/extensions/{id}",
31377     "title": "Deletes a Extension",
31378     "examples": [
31379       {
31380         "title": "Example usage:",
31381         "content": "curl https://{domain}/api/voice/extensions/{id} -v -u {name}:{password} -X DELETE",
31382         "type": "json"
31383       }
31384     ],
31385     "name": "DeleteExtensions",
31386     "group": "Voice_Extensions",
31387     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31388     "version": "0.0.0",
31389     "filename": "server/api/voiceExtension/index.js",
31390     "groupTitle": "Voice_Extensions"
31391   },
31392   {
31393     "type": "get",
31394     "url": "/api/voice/extensions",
31395     "title": "Gets a list of Extensions",
31396     "examples": [
31397       {
31398         "title": "Example usage:",
31399         "content": "curl https://{domain}/api/voice/extensions -v -u {name}:{password}",
31400         "type": "json"
31401       }
31402     ],
31403     "name": "GetExtensions",
31404     "group": "Voice_Extensions",
31405     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
31406     "version": "0.0.0",
31407     "filename": "server/api/voiceExtension/index.js",
31408     "groupTitle": "Voice_Extensions"
31409   },
31410   {
31411     "type": "get",
31412     "url": "/api/voice/extensions/{id}",
31413     "title": "Gets a single Extension",
31414     "examples": [
31415       {
31416         "title": "Example usage:",
31417         "content": "curl https://{domain}/api/voice/extensions/{id} -v -u {name}:{password}",
31418         "type": "json"
31419       }
31420     ],
31421     "name": "ShowExtensions",
31422     "group": "Voice_Extensions",
31423     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31424     "version": "0.0.0",
31425     "filename": "server/api/voiceExtension/index.js",
31426     "groupTitle": "Voice_Extensions"
31427   },
31428   {
31429     "type": "post",
31430     "url": "/api/voice/extensions",
31431     "title": "Create new applications",
31432     "examples": [
31433       {
31434         "title": "Example usage:",
31435         "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",
31436         "type": "json"
31437       }
31438     ],
31439     "name": "addApplications",
31440     "group": "Voice_Extensions",
31441     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31442     "version": "0.0.0",
31443     "filename": "server/api/voiceExtension/index.js",
31444     "groupTitle": "Voice_Extensions"
31445   },
31446   {
31447     "type": "post",
31448     "url": "/api/voice/extensions",
31449     "title": "Create an extension",
31450     "examples": [
31451       {
31452         "title": "Example usage:",
31453         "content": "curl https://{domain}/api/voice/extensions -d '{\"exten\": \"12345\", \"context\": \"from-custom\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
31454         "type": "json"
31455       }
31456     ],
31457     "name": "create",
31458     "group": "Voice_Extensions",
31459     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31460     "version": "0.0.0",
31461     "filename": "server/api/voiceExtension/index.js",
31462     "groupTitle": "Voice_Extensions"
31463   },
31464   {
31465     "type": "put",
31466     "url": "/api/voice/extensions/{id}",
31467     "title": "Update an extension",
31468     "examples": [
31469       {
31470         "title": "Example usage:",
31471         "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",
31472         "type": "json"
31473       }
31474     ],
31475     "name": "update",
31476     "group": "Voice_Extensions",
31477     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31478     "version": "0.0.0",
31479     "filename": "server/api/voiceExtension/index.js",
31480     "groupTitle": "Voice_Extensions"
31481   },
31482   {
31483     "type": "post",
31484     "url": "/api/voice/mohs",
31485     "title": "Create a new a new MOH",
31486     "examples": [
31487       {
31488         "title": "Example usage:",
31489         "content": "curl https://{domain}/api/voice/mohs -d '{\"name\": \"xmas_musics\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
31490         "type": "json"
31491       }
31492     ],
31493     "name": "AddMoh",
31494     "group": "Voice_MOHs",
31495     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31496     "version": "0.0.0",
31497     "filename": "server/api/voiceMusicOnHold/index.js",
31498     "groupTitle": "Voice_MOHs"
31499   },
31500   {
31501     "type": "post",
31502     "url": "/api/voice/mohs/{id}/sounds",
31503     "title": "Add sound to MOH",
31504     "examples": [
31505       {
31506         "title": "Example usage:",
31507         "content": "curl https://{domain}/api/voice/mohs/{id}/sounds -d '{\"id\": 1}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
31508         "type": "json"
31509       }
31510     ],
31511     "name": "AddSound",
31512     "group": "Voice_MOHs",
31513     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31514     "version": "0.0.0",
31515     "filename": "server/api/voiceMusicOnHold/index.js",
31516     "groupTitle": "Voice_MOHs"
31517   },
31518   {
31519     "type": "delete",
31520     "url": "/api/voice/mohs/{id}",
31521     "title": "Deletes an MOH",
31522     "examples": [
31523       {
31524         "title": "Example usage:",
31525         "content": "curl https://{domain}/api/voice/mohs/{id} -v -u {name}:{password} -X DELETE",
31526         "type": "json"
31527       }
31528     ],
31529     "name": "DestroyMoh",
31530     "group": "Voice_MOHs",
31531     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31532     "version": "0.0.0",
31533     "filename": "server/api/voiceMusicOnHold/index.js",
31534     "groupTitle": "Voice_MOHs"
31535   },
31536   {
31537     "type": "get",
31538     "url": "/api/voice/mohs",
31539     "title": "Gets a list of Music On Holds",
31540     "examples": [
31541       {
31542         "title": "Example usage:",
31543         "content": "curl https://{domain}/api/voice/mohs -v -u {name}:{password}",
31544         "type": "json"
31545       }
31546     ],
31547     "name": "GetMusic_On_Holds",
31548     "group": "Voice_MOHs",
31549     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
31550     "version": "0.0.0",
31551     "filename": "server/api/voiceMusicOnHold/index.js",
31552     "groupTitle": "Voice_MOHs"
31553   },
31554   {
31555     "type": "get",
31556     "url": "/api/voice/mohs/{id}/sounds",
31557     "title": "Gets sounds from MOH",
31558     "examples": [
31559       {
31560         "title": "Example usage:",
31561         "content": "curl https://{domain}/api/voice/mohs/{id}/sounds -v -u {name}:{password} -X DELETE",
31562         "type": "json"
31563       }
31564     ],
31565     "name": "GetSounds",
31566     "group": "Voice_MOHs",
31567     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31568     "version": "0.0.0",
31569     "filename": "server/api/voiceMusicOnHold/index.js",
31570     "groupTitle": "Voice_MOHs"
31571   },
31572   {
31573     "type": "delete",
31574     "url": "/api/voice/mohs/{id}/sounds/{id2}",
31575     "title": "Remove sound from MOH",
31576     "examples": [
31577       {
31578         "title": "Example usage:",
31579         "content": "curl https://{domain}/api/voice/mohs/{id}/sounds/{id2} -v -u {name}:{password} -X DELETE",
31580         "type": "json"
31581       }
31582     ],
31583     "name": "RemoveSound",
31584     "group": "Voice_MOHs",
31585     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31586     "version": "0.0.0",
31587     "filename": "server/api/voiceMusicOnHold/index.js",
31588     "groupTitle": "Voice_MOHs"
31589   },
31590   {
31591     "type": "get",
31592     "url": "/api/voice/mohs/{id}",
31593     "title": "Gets a single Music On Hold",
31594     "examples": [
31595       {
31596         "title": "Example usage:",
31597         "content": "curl https://{domain}/api/voice/mohs/{id} -v -u {name}:{password}",
31598         "type": "json"
31599       }
31600     ],
31601     "name": "ShowMusic_On_Holds",
31602     "group": "Voice_MOHs",
31603     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31604     "version": "0.0.0",
31605     "filename": "server/api/voiceMusicOnHold/index.js",
31606     "groupTitle": "Voice_MOHs"
31607   },
31608   {
31609     "type": "put",
31610     "url": "/api/voice/mohs/{id}",
31611     "title": "Update an existing Music On Hold",
31612     "examples": [
31613       {
31614         "title": "Example usage:",
31615         "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",
31616         "type": "json"
31617       }
31618     ],
31619     "name": "updateMusic_On_Holds",
31620     "group": "Voice_MOHs",
31621     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31622     "version": "0.0.0",
31623     "filename": "server/api/voiceMusicOnHold/index.js",
31624     "groupTitle": "Voice_MOHs"
31625   },
31626   {
31627     "type": "post",
31628     "url": "/api/voice/mails",
31629     "title": "Creates a new Mail",
31630     "examples": [
31631       {
31632         "title": "Example usage:",
31633         "content": "curl https://{domain}/api/voice/mails -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
31634         "type": "json"
31635       }
31636     ],
31637     "name": "CreateMails",
31638     "group": "Voice_Mails",
31639     "parameter": {
31640       "fields": {
31641         "Body": [
31642           {
31643             "group": "Body",
31644             "type": "String",
31645             "optional": true,
31646             "field": "customer_id",
31647             "description": ""
31648           },
31649           {
31650             "group": "Body",
31651             "type": "String",
31652             "optional": true,
31653             "field": "context",
31654             "description": ""
31655           },
31656           {
31657             "group": "Body",
31658             "type": "String",
31659             "optional": false,
31660             "field": "mailbox",
31661             "description": ""
31662           },
31663           {
31664             "group": "Body",
31665             "type": "String",
31666             "optional": true,
31667             "field": "password",
31668             "description": ""
31669           },
31670           {
31671             "group": "Body",
31672             "type": "String",
31673             "optional": true,
31674             "field": "fullname",
31675             "description": ""
31676           },
31677           {
31678             "group": "Body",
31679             "type": "String",
31680             "optional": true,
31681             "field": "email",
31682             "description": ""
31683           },
31684           {
31685             "group": "Body",
31686             "type": "String",
31687             "optional": true,
31688             "field": "pager",
31689             "description": ""
31690           },
31691           {
31692             "group": "Body",
31693             "type": "String",
31694             "optional": true,
31695             "field": "tz",
31696             "description": ""
31697           },
31698           {
31699             "group": "Body",
31700             "type": "String",
31701             "allowedValues": [
31702               "\"yes\"",
31703               "\"no\""
31704             ],
31705             "optional": false,
31706             "field": "attach",
31707             "description": ""
31708           },
31709           {
31710             "group": "Body",
31711             "type": "String",
31712             "allowedValues": [
31713               "\"yes\"",
31714               "\"no\""
31715             ],
31716             "optional": false,
31717             "field": "saycid",
31718             "description": ""
31719           },
31720           {
31721             "group": "Body",
31722             "type": "String",
31723             "optional": true,
31724             "field": "dialout",
31725             "description": ""
31726           },
31727           {
31728             "group": "Body",
31729             "type": "String",
31730             "optional": true,
31731             "field": "callback",
31732             "description": ""
31733           },
31734           {
31735             "group": "Body",
31736             "type": "String",
31737             "allowedValues": [
31738               "\"yes\"",
31739               "\"no\""
31740             ],
31741             "optional": false,
31742             "field": "review",
31743             "description": ""
31744           },
31745           {
31746             "group": "Body",
31747             "type": "String",
31748             "allowedValues": [
31749               "\"yes\"",
31750               "\"no\""
31751             ],
31752             "optional": false,
31753             "field": "operator",
31754             "description": ""
31755           },
31756           {
31757             "group": "Body",
31758             "type": "String",
31759             "allowedValues": [
31760               "\"yes\"",
31761               "\"no\""
31762             ],
31763             "optional": false,
31764             "field": "envelope",
31765             "description": ""
31766           },
31767           {
31768             "group": "Body",
31769             "type": "String",
31770             "allowedValues": [
31771               "\"yes\"",
31772               "\"no\""
31773             ],
31774             "optional": false,
31775             "field": "sayduration",
31776             "description": ""
31777           },
31778           {
31779             "group": "Body",
31780             "type": "String",
31781             "optional": false,
31782             "field": "saydurationm",
31783             "description": ""
31784           },
31785           {
31786             "group": "Body",
31787             "type": "String",
31788             "allowedValues": [
31789               "\"yes\"",
31790               "\"no\""
31791             ],
31792             "optional": false,
31793             "field": "sendvoicemail",
31794             "description": ""
31795           },
31796           {
31797             "group": "Body",
31798             "type": "String",
31799             "allowedValues": [
31800               "\"yes\"",
31801               "\"no\""
31802             ],
31803             "optional": false,
31804             "field": "delete",
31805             "description": ""
31806           },
31807           {
31808             "group": "Body",
31809             "type": "String",
31810             "allowedValues": [
31811               "\"yes\"",
31812               "\"no\""
31813             ],
31814             "optional": false,
31815             "field": "nextaftercmd",
31816             "description": ""
31817           },
31818           {
31819             "group": "Body",
31820             "type": "String",
31821             "allowedValues": [
31822               "\"yes\"",
31823               "\"no\""
31824             ],
31825             "optional": false,
31826             "field": "forcename",
31827             "description": ""
31828           },
31829           {
31830             "group": "Body",
31831             "type": "String",
31832             "allowedValues": [
31833               "\"yes\"",
31834               "\"no\""
31835             ],
31836             "optional": false,
31837             "field": "forcegreetings",
31838             "description": ""
31839           },
31840           {
31841             "group": "Body",
31842             "type": "String",
31843             "allowedValues": [
31844               "\"yes\"",
31845               "\"no\""
31846             ],
31847             "optional": false,
31848             "field": "hidefromdir",
31849             "description": ""
31850           },
31851           {
31852             "group": "Body",
31853             "type": "String",
31854             "optional": true,
31855             "field": "stamp",
31856             "description": ""
31857           },
31858           {
31859             "group": "Body",
31860             "type": "String",
31861             "optional": true,
31862             "field": "emailsubject",
31863             "description": ""
31864           },
31865           {
31866             "group": "Body",
31867             "type": "String",
31868             "optional": true,
31869             "field": "emailbody",
31870             "description": ""
31871           },
31872           {
31873             "group": "Body",
31874             "type": "Integer",
31875             "optional": false,
31876             "field": "maxsecs",
31877             "description": ""
31878           },
31879           {
31880             "group": "Body",
31881             "type": "Integer",
31882             "optional": false,
31883             "field": "maxmsg",
31884             "description": ""
31885           },
31886           {
31887             "group": "Body",
31888             "type": "Virtual",
31889             "optional": true,
31890             "field": "name",
31891             "description": ""
31892           }
31893         ]
31894       }
31895     },
31896     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31897     "version": "0.0.0",
31898     "filename": "server/api/voiceMail/index.js",
31899     "groupTitle": "Voice_Mails"
31900   },
31901   {
31902     "type": "delete",
31903     "url": "/api/voice/mails/{id}",
31904     "title": "Deletes a Mail",
31905     "examples": [
31906       {
31907         "title": "Example usage:",
31908         "content": "curl https://{domain}/api/voice/mails/{id} -v -u {name}:{password} -X DELETE",
31909         "type": "json"
31910       }
31911     ],
31912     "name": "DeleteMails",
31913     "group": "Voice_Mails",
31914     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31915     "version": "0.0.0",
31916     "filename": "server/api/voiceMail/index.js",
31917     "groupTitle": "Voice_Mails"
31918   },
31919   {
31920     "type": "get",
31921     "url": "/api/voice/mails",
31922     "title": "Gets a list of Mails",
31923     "examples": [
31924       {
31925         "title": "Example usage:",
31926         "content": "curl https://{domain}/api/voice/mails -v -u {name}:{password}",
31927         "type": "json"
31928       }
31929     ],
31930     "name": "GetMails",
31931     "group": "Voice_Mails",
31932     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
31933     "version": "0.0.0",
31934     "filename": "server/api/voiceMail/index.js",
31935     "groupTitle": "Voice_Mails"
31936   },
31937   {
31938     "type": "get",
31939     "url": "/api/voice/mails/{id}",
31940     "title": "Gets a single Mail",
31941     "examples": [
31942       {
31943         "title": "Example usage:",
31944         "content": "curl https://{domain}/api/voice/mails/{id} -v -u {name}:{password}",
31945         "type": "json"
31946       }
31947     ],
31948     "name": "ShowMails",
31949     "group": "Voice_Mails",
31950     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31951     "version": "0.0.0",
31952     "filename": "server/api/voiceMail/index.js",
31953     "groupTitle": "Voice_Mails"
31954   },
31955   {
31956     "type": "get",
31957     "url": "/api/voice/mails/{id}/messages",
31958     "title": "Gets voice mail messages",
31959     "examples": [
31960       {
31961         "title": "Example usage:",
31962         "content": "curl https://{domain}/api/voice/mails/{id}/messages -v -u {name}:{password} -X GET",
31963         "type": "json"
31964       }
31965     ],
31966     "name": "getMessages",
31967     "group": "Voice_Mails",
31968     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31969     "version": "0.0.0",
31970     "filename": "server/api/voiceMail/index.js",
31971     "groupTitle": "Voice_Mails"
31972   },
31973   {
31974     "type": "put",
31975     "url": "/api/voice/mails/{id}",
31976     "title": "Update an existing Mail",
31977     "examples": [
31978       {
31979         "title": "Example usage:",
31980         "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",
31981         "type": "json"
31982       }
31983     ],
31984     "name": "updateMails",
31985     "group": "Voice_Mails",
31986     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31987     "version": "0.0.0",
31988     "filename": "server/api/voiceMail/index.js",
31989     "groupTitle": "Voice_Mails"
31990   },
31991   {
31992     "type": "post",
31993     "url": "/api/voice/mails/messages",
31994     "title": "Creates a new Message",
31995     "examples": [
31996       {
31997         "title": "Example usage:",
31998         "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",
31999         "type": "json"
32000       }
32001     ],
32002     "name": "CreateMessages",
32003     "group": "Voice_Messages",
32004     "parameter": {
32005       "fields": {
32006         "Body": [
32007           {
32008             "group": "Body",
32009             "type": "Virtual",
32010             "optional": true,
32011             "field": "name",
32012             "description": ""
32013           },
32014           {
32015             "group": "Body",
32016             "type": "Integer",
32017             "optional": false,
32018             "field": "msgnum",
32019             "description": ""
32020           },
32021           {
32022             "group": "Body",
32023             "type": "String",
32024             "optional": true,
32025             "field": "dir",
32026             "description": ""
32027           },
32028           {
32029             "group": "Body",
32030             "type": "String",
32031             "optional": true,
32032             "field": "context",
32033             "description": ""
32034           },
32035           {
32036             "group": "Body",
32037             "type": "String",
32038             "optional": true,
32039             "field": "macrocontext",
32040             "description": ""
32041           },
32042           {
32043             "group": "Body",
32044             "type": "String",
32045             "optional": true,
32046             "field": "callerid",
32047             "description": ""
32048           },
32049           {
32050             "group": "Body",
32051             "type": "String",
32052             "optional": true,
32053             "field": "origtime",
32054             "description": ""
32055           },
32056           {
32057             "group": "Body",
32058             "type": "String",
32059             "optional": true,
32060             "field": "duration",
32061             "description": ""
32062           },
32063           {
32064             "group": "Body",
32065             "type": "String",
32066             "optional": true,
32067             "field": "mailboxuser",
32068             "description": ""
32069           },
32070           {
32071             "group": "Body",
32072             "type": "String",
32073             "optional": true,
32074             "field": "mailboxcontext",
32075             "description": ""
32076           },
32077           {
32078             "group": "Body",
32079             "type": "Blob",
32080             "optional": true,
32081             "field": "recording",
32082             "description": ""
32083           },
32084           {
32085             "group": "Body",
32086             "type": "String",
32087             "optional": true,
32088             "field": "flag",
32089             "description": ""
32090           },
32091           {
32092             "group": "Body",
32093             "type": "String",
32094             "optional": true,
32095             "field": "msg_id",
32096             "description": ""
32097           },
32098           {
32099             "group": "Body",
32100             "type": "String",
32101             "optional": false,
32102             "field": "stamp",
32103             "description": ""
32104           }
32105         ]
32106       }
32107     },
32108     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32109     "version": "0.0.0",
32110     "filename": "server/api/voiceMailMessage/index.js",
32111     "groupTitle": "Voice_Messages"
32112   },
32113   {
32114     "type": "delete",
32115     "url": "/api/voice/mails/messages/{id}",
32116     "title": "Deletes a Message",
32117     "examples": [
32118       {
32119         "title": "Example usage:",
32120         "content": "curl https://{domain}/api/voice/mails/messages/{id} -v -u {name}:{password} -X DELETE",
32121         "type": "json"
32122       }
32123     ],
32124     "name": "DeleteMessages",
32125     "group": "Voice_Messages",
32126     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32127     "version": "0.0.0",
32128     "filename": "server/api/voiceMailMessage/index.js",
32129     "groupTitle": "Voice_Messages"
32130   },
32131   {
32132     "type": "get",
32133     "url": "/api/voice/mails/messages",
32134     "title": "Gets a list of Messages",
32135     "examples": [
32136       {
32137         "title": "Example usage:",
32138         "content": "curl https://{domain}/api/voice/mails/messages -v -u {name}:{password}",
32139         "type": "json"
32140       }
32141     ],
32142     "name": "GetMessages",
32143     "group": "Voice_Messages",
32144     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
32145     "version": "0.0.0",
32146     "filename": "server/api/voiceMailMessage/index.js",
32147     "groupTitle": "Voice_Messages"
32148   },
32149   {
32150     "type": "get",
32151     "url": "/api/voice/mails/messages/{id}",
32152     "title": "Gets a single Message",
32153     "examples": [
32154       {
32155         "title": "Example usage:",
32156         "content": "curl https://{domain}/api/voice/mails/messages/{id} -v -u {name}:{password}",
32157         "type": "json"
32158       }
32159     ],
32160     "name": "ShowMessages",
32161     "group": "Voice_Messages",
32162     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32163     "version": "0.0.0",
32164     "filename": "server/api/voiceMailMessage/index.js",
32165     "groupTitle": "Voice_Messages"
32166   },
32167   {
32168     "type": "get",
32169     "url": "voice/mails/messages/{id}/download",
32170     "title": "Download Voice Message",
32171     "examples": [
32172       {
32173         "title": "Example usage:",
32174         "content": "curl https://{domain}voice/mails/messages/{id}/download -v -u {name}:{password} -X GET",
32175         "type": "json"
32176       }
32177     ],
32178     "name": "download",
32179     "group": "Voice_Messages",
32180     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32181     "version": "0.0.0",
32182     "filename": "server/api/voiceMailMessage/index.js",
32183     "groupTitle": "Voice_Messages"
32184   },
32185   {
32186     "type": "put",
32187     "url": "/api/voice/mails/messages/{id}",
32188     "title": "Update an existing Message",
32189     "examples": [
32190       {
32191         "title": "Example usage:",
32192         "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",
32193         "type": "json"
32194       }
32195     ],
32196     "name": "updateMessages",
32197     "group": "Voice_Messages",
32198     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32199     "version": "0.0.0",
32200     "filename": "server/api/voiceMailMessage/index.js",
32201     "groupTitle": "Voice_Messages"
32202   },
32203   {
32204     "type": "post",
32205     "url": "/api/voice/prefixes/{id}/users",
32206     "title": "Add agents to a prefix",
32207     "examples": [
32208       {
32209         "title": "Example usage:",
32210         "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",
32211         "type": "json"
32212       }
32213     ],
32214     "name": "AddAgents",
32215     "group": "Voice_Prefixes",
32216     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32217     "version": "0.0.0",
32218     "filename": "server/api/voicePrefix/index.js",
32219     "groupTitle": "Voice_Prefixes"
32220   },
32221   {
32222     "type": "delete",
32223     "url": "/api/voice/prefixes/{id}",
32224     "title": "Deletes a Prefix",
32225     "examples": [
32226       {
32227         "title": "Example usage:",
32228         "content": "curl https://{domain}/api/voice/prefixes/{id} -v -u {name}:{password} -X DELETE",
32229         "type": "json"
32230       }
32231     ],
32232     "name": "DeletePrefixes",
32233     "group": "Voice_Prefixes",
32234     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32235     "version": "0.0.0",
32236     "filename": "server/api/voicePrefix/index.js",
32237     "groupTitle": "Voice_Prefixes"
32238   },
32239   {
32240     "type": "get",
32241     "url": "/api/voice/prefixes/describe",
32242     "title": "Gets table info about Prefixes",
32243     "examples": [
32244       {
32245         "title": "Example usage:",
32246         "content": "curl https://{domain}/api/voice/prefixes/describe -v -u {name}:{password}",
32247         "type": "json"
32248       }
32249     ],
32250     "name": "DescribePrefixes",
32251     "group": "Voice_Prefixes",
32252     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32253     "version": "0.0.0",
32254     "filename": "server/api/voicePrefix/index.js",
32255     "groupTitle": "Voice_Prefixes"
32256   },
32257   {
32258     "type": "get",
32259     "url": "/api/voice/prefixes/{id}/users",
32260     "title": "Gets agents from prefix",
32261     "examples": [
32262       {
32263         "title": "Example usage:",
32264         "content": "curl https://{domain}/api/voice/prefixes/{id}/users -v -u {name}:{password} -X GET",
32265         "type": "json"
32266       }
32267     ],
32268     "name": "GetAgents",
32269     "group": "Voice_Prefixes",
32270     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32271     "version": "0.0.0",
32272     "filename": "server/api/voicePrefix/index.js",
32273     "groupTitle": "Voice_Prefixes"
32274   },
32275   {
32276     "type": "get",
32277     "url": "/api/voice/prefixes",
32278     "title": "Gets a list of Prefixes",
32279     "examples": [
32280       {
32281         "title": "Example usage:",
32282         "content": "curl https://{domain}/api/voice/prefixes -v -u {name}:{password}",
32283         "type": "json"
32284       }
32285     ],
32286     "name": "GetPrefixes",
32287     "group": "Voice_Prefixes",
32288     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
32289     "version": "0.0.0",
32290     "filename": "server/api/voicePrefix/index.js",
32291     "groupTitle": "Voice_Prefixes"
32292   },
32293   {
32294     "type": "delete",
32295     "url": "/api/voice/prefixes/{id}/users",
32296     "title": "Removes agents from a prefix",
32297     "examples": [
32298       {
32299         "title": "Example usage:",
32300         "content": "curl https://{domain}/api/voice/prefixes/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
32301         "type": "json"
32302       }
32303     ],
32304     "name": "RemoveAgents",
32305     "group": "Voice_Prefixes",
32306     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32307     "version": "0.0.0",
32308     "filename": "server/api/voicePrefix/index.js",
32309     "groupTitle": "Voice_Prefixes"
32310   },
32311   {
32312     "type": "get",
32313     "url": "/api/voice/prefixes/{id}",
32314     "title": "Gets a single Prefix",
32315     "examples": [
32316       {
32317         "title": "Example usage:",
32318         "content": "curl https://{domain}/api/voice/prefixes/{id} -v -u {name}:{password}",
32319         "type": "json"
32320       }
32321     ],
32322     "name": "ShowPrefixes",
32323     "group": "Voice_Prefixes",
32324     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32325     "version": "0.0.0",
32326     "filename": "server/api/voicePrefix/index.js",
32327     "groupTitle": "Voice_Prefixes"
32328   },
32329   {
32330     "type": "put",
32331     "url": "/api/voice/prefixes/{id}",
32332     "title": "Update an existing prefix",
32333     "examples": [
32334       {
32335         "title": "Example usage:",
32336         "content": "curl https://{domain}/api/voice/prefixes/{id} -v -u {name}:{password} -X PUT",
32337         "type": "json"
32338       }
32339     ],
32340     "name": "Update",
32341     "group": "Voice_Prefixes",
32342     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32343     "version": "0.0.0",
32344     "filename": "server/api/voicePrefix/index.js",
32345     "groupTitle": "Voice_Prefixes"
32346   },
32347   {
32348     "type": "post",
32349     "url": "/api/voice/prefixes",
32350     "title": "Create a prefix",
32351     "examples": [
32352       {
32353         "title": "Example usage:",
32354         "content": "curl https://{domain}/api/voice/prefixes -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
32355         "type": "json"
32356       }
32357     ],
32358     "name": "create",
32359     "group": "Voice_Prefixes",
32360     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32361     "version": "0.0.0",
32362     "filename": "server/api/voicePrefix/index.js",
32363     "groupTitle": "Voice_Prefixes"
32364   },
32365   {
32366     "type": "get",
32367     "url": "/api/voice/queues/reports/describe",
32368     "title": "Gets table info about Queue Reports",
32369     "examples": [
32370       {
32371         "title": "Example usage:",
32372         "content": "curl https://{domain}/api/voice/queues/reports/describe -v -u {name}:{password}",
32373         "type": "json"
32374       }
32375     ],
32376     "name": "DescribeQueue_Reports",
32377     "group": "Voice_Queue_Reports",
32378     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32379     "version": "0.0.0",
32380     "filename": "server/api/voiceQueueReport/index.js",
32381     "groupTitle": "Voice_Queue_Reports"
32382   },
32383   {
32384     "type": "get",
32385     "url": "/api/voice/queues/reports",
32386     "title": "Gets a list of Queue Reports",
32387     "examples": [
32388       {
32389         "title": "Example usage:",
32390         "content": "curl https://{domain}/api/voice/queues/reports -v -u {name}:{password}",
32391         "type": "json"
32392       }
32393     ],
32394     "name": "GetQueue_Reports",
32395     "group": "Voice_Queue_Reports",
32396     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
32397     "version": "0.0.0",
32398     "filename": "server/api/voiceQueueReport/index.js",
32399     "groupTitle": "Voice_Queue_Reports"
32400   },
32401   {
32402     "type": "get",
32403     "url": "/api/voice/queues/reports/{id}",
32404     "title": "Gets a single Queue Report",
32405     "examples": [
32406       {
32407         "title": "Example usage:",
32408         "content": "curl https://{domain}/api/voice/queues/reports/{id} -v -u {name}:{password}",
32409         "type": "json"
32410       }
32411     ],
32412     "name": "ShowQueue_Reports",
32413     "group": "Voice_Queue_Reports",
32414     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32415     "version": "0.0.0",
32416     "filename": "server/api/voiceQueueReport/index.js",
32417     "groupTitle": "Voice_Queue_Reports"
32418   },
32419   {
32420     "type": "get",
32421     "url": "/api/voice/queues/reports/index",
32422     "title": "Get Voice Queues Report",
32423     "examples": [
32424       {
32425         "title": "Example usage:",
32426         "content": "curl https://{domain}/api/voice/queues/reports/index -v -u {name}:{password} -X GET",
32427         "type": "json"
32428       }
32429     ],
32430     "name": "getVoiceQueuesReport",
32431     "group": "Voice_Queue_Reports",
32432     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32433     "version": "0.0.0",
32434     "filename": "server/api/voiceQueueReport/index.js",
32435     "groupTitle": "Voice_Queue_Reports"
32436   },
32437   {
32438     "type": "post",
32439     "url": "/api/voice/queues/{id}/users",
32440     "title": "Add agents to queue",
32441     "examples": [
32442       {
32443         "title": "Example usage:",
32444         "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",
32445         "type": "json"
32446       }
32447     ],
32448     "name": "AddAgents",
32449     "group": "Voice_Queues",
32450     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32451     "version": "0.0.0",
32452     "filename": "server/api/voiceQueue/index.js",
32453     "groupTitle": "Voice_Queues"
32454   },
32455   {
32456     "type": "post",
32457     "url": "/api/voice/queues/{id}/blacklists",
32458     "title": "Add blacklists to a queue",
32459     "examples": [
32460       {
32461         "title": "Example usage:",
32462         "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",
32463         "type": "json"
32464       }
32465     ],
32466     "name": "AddBlackLists",
32467     "group": "Voice_Queues",
32468     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32469     "version": "0.0.0",
32470     "filename": "server/api/voiceQueue/index.js",
32471     "groupTitle": "Voice_Queues"
32472   },
32473   {
32474     "type": "post",
32475     "url": "/api/voice/queues/{id}/lists",
32476     "title": "Add lists to a queue",
32477     "examples": [
32478       {
32479         "title": "Example usage:",
32480         "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",
32481         "type": "json"
32482       }
32483     ],
32484     "name": "AddLists",
32485     "group": "Voice_Queues",
32486     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32487     "version": "0.0.0",
32488     "filename": "server/api/voiceQueue/index.js",
32489     "groupTitle": "Voice_Queues"
32490   },
32491   {
32492     "type": "post",
32493     "url": "/api/voice/queues/{id}/teams",
32494     "title": "Add teams to queue",
32495     "examples": [
32496       {
32497         "title": "Example usage:",
32498         "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",
32499         "type": "json"
32500       }
32501     ],
32502     "name": "AddTeams",
32503     "group": "Voice_Queues",
32504     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32505     "version": "0.0.0",
32506     "filename": "server/api/voiceQueue/index.js",
32507     "groupTitle": "Voice_Queues"
32508   },
32509   {
32510     "type": "post",
32511     "url": "/api/voice/queues/clone",
32512     "title": "Clone an existing Queue",
32513     "examples": [
32514       {
32515         "title": "Example usage:",
32516         "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",
32517         "type": "json"
32518       }
32519     ],
32520     "name": "CloneQueues",
32521     "group": "Voice_Queues",
32522     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32523     "version": "0.0.0",
32524     "filename": "server/api/voiceQueue/index.js",
32525     "groupTitle": "Voice_Queues"
32526   },
32527   {
32528     "type": "post",
32529     "url": "/api/voice/queues",
32530     "title": "Creates a new Queue",
32531     "examples": [
32532       {
32533         "title": "Example usage:",
32534         "content": "curl https://{domain}/api/voice/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
32535         "type": "json"
32536       }
32537     ],
32538     "name": "CreateQueues",
32539     "group": "Voice_Queues",
32540     "parameter": {
32541       "fields": {
32542         "Body": [
32543           {
32544             "group": "Body",
32545             "type": "String",
32546             "optional": false,
32547             "field": "name",
32548             "description": ""
32549           },
32550           {
32551             "group": "Body",
32552             "type": "String",
32553             "allowedValues": [
32554               "\"inbound\"",
32555               "\"outbound\""
32556             ],
32557             "optional": false,
32558             "field": "type",
32559             "description": ""
32560           },
32561           {
32562             "group": "Body",
32563             "type": "String",
32564             "optional": true,
32565             "field": "musiconhold",
32566             "description": ""
32567           },
32568           {
32569             "group": "Body",
32570             "type": "String",
32571             "optional": true,
32572             "field": "announce",
32573             "description": ""
32574           },
32575           {
32576             "group": "Body",
32577             "type": "String",
32578             "allowedValues": [
32579               "\"rr\"",
32580               "\"ringall\"",
32581               "\"leastrecent\"",
32582               "\"fewestcalls\"",
32583               "\"random\"",
32584               "\"rrmemory\"",
32585               "\"linear\"",
32586               "\"wrandom\"",
32587               "\"rrordered\""
32588             ],
32589             "optional": false,
32590             "field": "strategy",
32591             "description": ""
32592           },
32593           {
32594             "group": "Body",
32595             "type": "Integer",
32596             "optional": true,
32597             "field": "servicelevel",
32598             "description": ""
32599           },
32600           {
32601             "group": "Body",
32602             "type": "String",
32603             "optional": true,
32604             "field": "context",
32605             "description": ""
32606           },
32607           {
32608             "group": "Body",
32609             "type": "Integer",
32610             "optional": true,
32611             "field": "penaltymemberslimit",
32612             "description": ""
32613           },
32614           {
32615             "group": "Body",
32616             "type": "Integer",
32617             "optional": true,
32618             "field": "timeout",
32619             "description": ""
32620           },
32621           {
32622             "group": "Body",
32623             "type": "Integer",
32624             "optional": true,
32625             "field": "retry",
32626             "description": ""
32627           },
32628           {
32629             "group": "Body",
32630             "type": "String",
32631             "optional": true,
32632             "field": "timeoutpriority",
32633             "description": ""
32634           },
32635           {
32636             "group": "Body",
32637             "type": "Integer",
32638             "optional": true,
32639             "field": "weight",
32640             "description": ""
32641           },
32642           {
32643             "group": "Body",
32644             "type": "Integer",
32645             "optional": true,
32646             "field": "wrapuptime",
32647             "description": ""
32648           },
32649           {
32650             "group": "Body",
32651             "type": "String",
32652             "allowedValues": [
32653               "\"yes\"",
32654               "\"no\""
32655             ],
32656             "optional": true,
32657             "field": "autofill",
32658             "description": ""
32659           },
32660           {
32661             "group": "Body",
32662             "type": "String",
32663             "allowedValues": [
32664               "\"yes\"",
32665               "\"no\"",
32666               "\"all\""
32667             ],
32668             "optional": true,
32669             "field": "autopause",
32670             "description": ""
32671           },
32672           {
32673             "group": "Body",
32674             "type": "Integer",
32675             "optional": true,
32676             "field": "autopausedelay",
32677             "description": ""
32678           },
32679           {
32680             "group": "Body",
32681             "type": "String",
32682             "allowedValues": [
32683               "\"yes\"",
32684               "\"no\""
32685             ],
32686             "optional": true,
32687             "field": "autopausebusy",
32688             "description": ""
32689           },
32690           {
32691             "group": "Body",
32692             "type": "String",
32693             "allowedValues": [
32694               "\"yes\"",
32695               "\"no\""
32696             ],
32697             "optional": true,
32698             "field": "autopauseunavail",
32699             "description": ""
32700           },
32701           {
32702             "group": "Body",
32703             "type": "Integer",
32704             "optional": true,
32705             "field": "maxlen",
32706             "description": ""
32707           },
32708           {
32709             "group": "Body",
32710             "type": "String",
32711             "allowedValues": [
32712               "\"yes\"",
32713               "\"no\""
32714             ],
32715             "optional": true,
32716             "field": "setinterfacevar",
32717             "description": ""
32718           },
32719           {
32720             "group": "Body",
32721             "type": "String",
32722             "allowedValues": [
32723               "\"yes\"",
32724               "\"no\""
32725             ],
32726             "optional": true,
32727             "field": "setqueueentryvar",
32728             "description": ""
32729           },
32730           {
32731             "group": "Body",
32732             "type": "String",
32733             "allowedValues": [
32734               "\"yes\"",
32735               "\"no\""
32736             ],
32737             "optional": true,
32738             "field": "setqueuevar",
32739             "description": ""
32740           },
32741           {
32742             "group": "Body",
32743             "type": "String",
32744             "allowedValues": [
32745               "\"yes\"",
32746               "\"no\""
32747             ],
32748             "optional": true,
32749             "field": "eventmemberstatus",
32750             "description": ""
32751           },
32752           {
32753             "group": "Body",
32754             "type": "String",
32755             "optional": true,
32756             "field": "membermacro",
32757             "description": ""
32758           },
32759           {
32760             "group": "Body",
32761             "type": "String",
32762             "optional": true,
32763             "field": "membergosub",
32764             "description": ""
32765           },
32766           {
32767             "group": "Body",
32768             "type": "Integer",
32769             "optional": true,
32770             "field": "announce_frequency",
32771             "description": ""
32772           },
32773           {
32774             "group": "Body",
32775             "type": "Integer",
32776             "optional": true,
32777             "field": "min_announce_frequency",
32778             "description": ""
32779           },
32780           {
32781             "group": "Body",
32782             "type": "Integer",
32783             "optional": true,
32784             "field": "periodic_announce_frequency",
32785             "description": ""
32786           },
32787           {
32788             "group": "Body",
32789             "type": "String",
32790             "allowedValues": [
32791               "\"yes\"",
32792               "\"no\""
32793             ],
32794             "optional": true,
32795             "field": "random_periodic_announce",
32796             "description": ""
32797           },
32798           {
32799             "group": "Body",
32800             "type": "String",
32801             "allowedValues": [
32802               "\"yes\"",
32803               "\"no\""
32804             ],
32805             "optional": true,
32806             "field": "relative_periodic_announce",
32807             "description": ""
32808           },
32809           {
32810             "group": "Body",
32811             "type": "String",
32812             "allowedValues": [
32813               "\"yes\"",
32814               "\"no\"",
32815               "\"once\""
32816             ],
32817             "optional": true,
32818             "field": "announce_holdtime",
32819             "description": ""
32820           },
32821           {
32822             "group": "Body",
32823             "type": "String",
32824             "optional": true,
32825             "field": "announce_position",
32826             "description": ""
32827           },
32828           {
32829             "group": "Body",
32830             "type": "String",
32831             "allowedValues": [
32832               "\"yes\"",
32833               "\"no\""
32834             ],
32835             "optional": true,
32836             "field": "announce_to_first_user",
32837             "description": ""
32838           },
32839           {
32840             "group": "Body",
32841             "type": "Integer",
32842             "optional": true,
32843             "field": "announce_position_limit",
32844             "description": ""
32845           },
32846           {
32847             "group": "Body",
32848             "type": "String",
32849             "allowedValues": [
32850               "\"0\"",
32851               "\"5\"",
32852               "\"10\"",
32853               "\"15\"",
32854               "\"20\"",
32855               "\"30\""
32856             ],
32857             "optional": true,
32858             "field": "announce_round_seconds",
32859             "description": ""
32860           },
32861           {
32862             "group": "Body",
32863             "type": "String",
32864             "optional": true,
32865             "field": "monitor_format",
32866             "description": ""
32867           },
32868           {
32869             "group": "Body",
32870             "type": "String",
32871             "optional": true,
32872             "field": "monitor_type",
32873             "description": ""
32874           },
32875           {
32876             "group": "Body",
32877             "type": "String",
32878             "optional": true,
32879             "field": "queue_youarenext",
32880             "description": ""
32881           },
32882           {
32883             "group": "Body",
32884             "type": "String",
32885             "optional": true,
32886             "field": "queue_thereare",
32887             "description": ""
32888           },
32889           {
32890             "group": "Body",
32891             "type": "String",
32892             "optional": true,
32893             "field": "queue_callswaiting",
32894             "description": ""
32895           },
32896           {
32897             "group": "Body",
32898             "type": "String",
32899             "optional": true,
32900             "field": "queue_holdtime",
32901             "description": ""
32902           },
32903           {
32904             "group": "Body",
32905             "type": "String",
32906             "optional": true,
32907             "field": "queue_minute",
32908             "description": ""
32909           },
32910           {
32911             "group": "Body",
32912             "type": "String",
32913             "optional": true,
32914             "field": "queue_minutes",
32915             "description": ""
32916           },
32917           {
32918             "group": "Body",
32919             "type": "String",
32920             "optional": true,
32921             "field": "queue_seconds",
32922             "description": ""
32923           },
32924           {
32925             "group": "Body",
32926             "type": "String",
32927             "optional": true,
32928             "field": "queue_thankyou",
32929             "description": ""
32930           },
32931           {
32932             "group": "Body",
32933             "type": "String",
32934             "optional": true,
32935             "field": "queue_reporthold",
32936             "description": ""
32937           },
32938           {
32939             "group": "Body",
32940             "type": "String",
32941             "optional": true,
32942             "field": "queue_quantity1",
32943             "description": ""
32944           },
32945           {
32946             "group": "Body",
32947             "type": "String",
32948             "optional": true,
32949             "field": "queue_quantity2",
32950             "description": ""
32951           },
32952           {
32953             "group": "Body",
32954             "type": "String",
32955             "optional": true,
32956             "field": "queue_periodic_announce",
32957             "description": ""
32958           },
32959           {
32960             "group": "Body",
32961             "type": "String",
32962             "optional": true,
32963             "field": "queue_less_than",
32964             "description": ""
32965           },
32966           {
32967             "group": "Body",
32968             "type": "Text",
32969             "optional": true,
32970             "field": "periodic_announce",
32971             "description": ""
32972           },
32973           {
32974             "group": "Body",
32975             "type": "String",
32976             "optional": true,
32977             "field": "joinempty",
32978             "description": ""
32979           },
32980           {
32981             "group": "Body",
32982             "type": "String",
32983             "optional": true,
32984             "field": "leavewhenempty",
32985             "description": ""
32986           },
32987           {
32988             "group": "Body",
32989             "type": "String",
32990             "allowedValues": [
32991               "\"yes\"",
32992               "\"no\""
32993             ],
32994             "optional": true,
32995             "field": "reportholdtime",
32996             "description": ""
32997           },
32998           {
32999             "group": "Body",
33000             "type": "String",
33001             "allowedValues": [
33002               "\"yes\"",
33003               "\"no\""
33004             ],
33005             "optional": true,
33006             "field": "ringinuse",
33007             "description": ""
33008           },
33009           {
33010             "group": "Body",
33011             "type": "Integer",
33012             "optional": true,
33013             "field": "memberdelay",
33014             "description": ""
33015           },
33016           {
33017             "group": "Body",
33018             "type": "String",
33019             "allowedValues": [
33020               "\"yes\"",
33021               "\"no\""
33022             ],
33023             "optional": true,
33024             "field": "timeoutrestart",
33025             "description": ""
33026           },
33027           {
33028             "group": "Body",
33029             "type": "String",
33030             "optional": true,
33031             "field": "defaultrule",
33032             "description": ""
33033           },
33034           {
33035             "group": "Body",
33036             "type": "String",
33037             "optional": true,
33038             "field": "description",
33039             "description": ""
33040           },
33041           {
33042             "group": "Body",
33043             "type": "Boolean",
33044             "optional": true,
33045             "field": "acw",
33046             "description": ""
33047           },
33048           {
33049             "group": "Body",
33050             "type": "Integer",
33051             "optional": true,
33052             "field": "acwTimeout",
33053             "description": ""
33054           },
33055           {
33056             "group": "Body",
33057             "type": "Boolean",
33058             "optional": true,
33059             "field": "dialActive",
33060             "description": "<p>Active/Disactive Campaign</p>"
33061           },
33062           {
33063             "group": "Body",
33064             "type": "String",
33065             "allowedValues": [
33066               "\"preview\"",
33067               "\"progressive\"",
33068               "\"power\"",
33069               "\"predictive\"",
33070               "\"booked\""
33071             ],
33072             "optional": true,
33073             "field": "dialMethod",
33074             "description": "<p>Dial Method.</p>"
33075           },
33076           {
33077             "group": "Body",
33078             "type": "Integer",
33079             "optional": true,
33080             "field": "dialLimitChannel",
33081             "description": "<p>Max 9999 channels, 0 means unlimited.</p>"
33082           },
33083           {
33084             "group": "Body",
33085             "type": "Integer",
33086             "optional": true,
33087             "field": "dialLimitQueue",
33088             "description": "<p>Max 9999 member in queue(min:1, max:9999), 0 means unlimited.</p>"
33089           },
33090           {
33091             "group": "Body",
33092             "type": "Float",
33093             "optional": true,
33094             "field": "dialPowerLevel",
33095             "description": "<p>Power Level: Calls for agents (min:1, max:10).</p>"
33096           },
33097           {
33098             "group": "Body",
33099             "type": "String",
33100             "allowedValues": [
33101               "\"agentBusyFactor\"",
33102               "\"dropRate\""
33103             ],
33104             "optional": true,
33105             "field": "dialPredictiveOptimization",
33106             "description": "<p>Only for predictive method.</p>"
33107           },
33108           {
33109             "group": "Body",
33110             "type": "Float",
33111             "optional": true,
33112             "field": "dialPredictiveOptimizationPercentage",
33113             "description": "<p>Predictive Optimization Percentage (min: 1, max: 95)</p>"
33114           },
33115           {
33116             "group": "Body",
33117             "type": "Integer",
33118             "optional": true,
33119             "field": "dialPredictiveInterval",
33120             "description": "<p>Interval Predictive Minutes (min:5 max:30)</p>"
33121           },
33122           {
33123             "group": "Body",
33124             "type": "String",
33125             "optional": true,
33126             "field": "dialOriginateCallerIdName",
33127             "description": ""
33128           },
33129           {
33130             "group": "Body",
33131             "type": "String",
33132             "optional": true,
33133             "field": "dialOriginateCallerIdNumber",
33134             "description": ""
33135           },
33136           {
33137             "group": "Body",
33138             "type": "Integer",
33139             "optional": true,
33140             "field": "dialOriginateTimeout",
33141             "description": "<p>Originate Timeout Seconds (min:1, max:999)</p>"
33142           },
33143           {
33144             "group": "Body",
33145             "type": "String",
33146             "optional": true,
33147             "field": "dialQueueOptions",
33148             "description": "<p>https://wiki.asterisk.org/wiki/display/AST/Asterisk+13+Application_Queue</p>"
33149           },
33150           {
33151             "group": "Body",
33152             "type": "Integer",
33153             "optional": true,
33154             "field": "dialQueueTimeout",
33155             "description": "<p>Queue Timeout Seconds (min:1, max:999)</p>"
33156           },
33157           {
33158             "group": "Body",
33159             "type": "String",
33160             "optional": true,
33161             "field": "dialQueueProject",
33162             "description": "<p>AGI queue option (use: agi://127.0.0.1/square,&lt;project_name&gt;)</p>"
33163           },
33164           {
33165             "group": "Body",
33166             "type": "Integer",
33167             "optional": true,
33168             "field": "dialCongestionMaxRetry",
33169             "description": "<p>#Congestion Retry (min:1, max:999)</p>"
33170           },
33171           {
33172             "group": "Body",
33173             "type": "Integer",
33174             "optional": true,
33175             "field": "dialCongestionRetryFrequency",
33176             "description": "<p>Congestion Retry Frequency Minutes (min:1, max:99999)</p>"
33177           },
33178           {
33179             "group": "Body",
33180             "type": "Integer",
33181             "optional": true,
33182             "field": "dialBusyMaxRetry",
33183             "description": "<p>#Busy Retry (min:1, max:999)</p>"
33184           },
33185           {
33186             "group": "Body",
33187             "type": "Integer",
33188             "optional": true,
33189             "field": "dialBusyRetryFrequency",
33190             "description": "<p>Busy Retry Frequency Minutes (min:1, max:99999)</p>"
33191           },
33192           {
33193             "group": "Body",
33194             "type": "Integer",
33195             "optional": true,
33196             "field": "dialNoAnswerMaxRetry",
33197             "description": "<p>#NoAnswer Retry (min:1, max:999)</p>"
33198           },
33199           {
33200             "group": "Body",
33201             "type": "Integer",
33202             "optional": true,
33203             "field": "dialNoAnswerRetryFrequency",
33204             "description": "<p>NoAnswer Retry Frequency Minutes (min:1, max:99999)</p>"
33205           },
33206           {
33207             "group": "Body",
33208             "type": "Integer",
33209             "optional": true,
33210             "field": "dialGlobalMaxRetry",
33211             "description": "<p>#Global Max Retry (min:1, max:999)</p>"
33212           },
33213           {
33214             "group": "Body",
33215             "type": "String",
33216             "optional": true,
33217             "field": "dialTimezone",
33218             "description": ""
33219           },
33220           {
33221             "group": "Body",
33222             "type": "String",
33223             "optional": true,
33224             "field": "dialGlobalInterval",
33225             "description": ""
33226           },
33227           {
33228             "group": "Body",
33229             "type": "String",
33230             "optional": true,
33231             "field": "dialPrefix",
33232             "description": ""
33233           },
33234           {
33235             "group": "Body",
33236             "type": "String",
33237             "allowedValues": [
33238               "\"always\"",
33239               "\"never\"",
33240               "\"onlyIfOpen\""
33241             ],
33242             "optional": true,
33243             "field": "dialCheckDuplicateType",
33244             "description": ""
33245           },
33246           {
33247             "group": "Body",
33248             "type": "Boolean",
33249             "optional": true,
33250             "field": "dialAMDActive",
33251             "description": "<p>Active/Disactive AMD</p>"
33252           },
33253           {
33254             "group": "Body",
33255             "type": "Integer",
33256             "optional": true,
33257             "field": "dialAMDInitialSilence",
33258             "description": "<p>#AMD Initial Silence</p>"
33259           },
33260           {
33261             "group": "Body",
33262             "type": "Integer",
33263             "optional": true,
33264             "field": "dialAMDGreeting",
33265             "description": "<p>#AMD Greeting</p>"
33266           },
33267           {
33268             "group": "Body",
33269             "type": "Integer",
33270             "optional": true,
33271             "field": "dialAMDAfterGreetingSilence",
33272             "description": "<p>#AMD After Greeting Silence</p>"
33273           },
33274           {
33275             "group": "Body",
33276             "type": "Integer",
33277             "optional": true,
33278             "field": "dialAMDTotalAnalysisTime",
33279             "description": "<p>#AMD Total Analysis Time</p>"
33280           },
33281           {
33282             "group": "Body",
33283             "type": "Integer",
33284             "optional": true,
33285             "field": "dialAMDMinWordLength",
33286             "description": "<p>#AMD Min Word Length</p>"
33287           },
33288           {
33289             "group": "Body",
33290             "type": "Integer",
33291             "optional": true,
33292             "field": "dialAMDBetweenWordsSilence",
33293             "description": "<p>#AMD Between Words Silence</p>"
33294           },
33295           {
33296             "group": "Body",
33297             "type": "Integer",
33298             "optional": true,
33299             "field": "dialAMDMaximumNumberOfWords",
33300             "description": "<p>#AMD Maximum Number Of Words</p>"
33301           },
33302           {
33303             "group": "Body",
33304             "type": "Integer",
33305             "optional": true,
33306             "field": "dialAMDSilenceThreshold",
33307             "description": "<p>#AMD Silence Threshold (min:0, max:32767)</p>"
33308           },
33309           {
33310             "group": "Body",
33311             "type": "Integer",
33312             "optional": true,
33313             "field": "dialAMDMaximumWordLength",
33314             "description": "<p>#AMD Maximum Word Length</p>"
33315           },
33316           {
33317             "group": "Body",
33318             "type": "Integer",
33319             "optional": true,
33320             "field": "dialRecallMeTimeout",
33321             "description": "<p>#RecallMe Timeout (min:1)</p>"
33322           },
33323           {
33324             "group": "Body",
33325             "type": "Boolean",
33326             "optional": true,
33327             "field": "dialRecallInQueue",
33328             "description": "<p>Active/Disactive Recall In Queue</p>"
33329           },
33330           {
33331             "group": "Body",
33332             "type": "String",
33333             "allowedValues": [
33334               "\"DESC\"",
33335               "\"ASC\""
33336             ],
33337             "optional": true,
33338             "field": "dialOrderByScheduledAt",
33339             "description": ""
33340           },
33341           {
33342             "group": "Body",
33343             "type": "String",
33344             "optional": true,
33345             "field": "dialQueueProject2",
33346             "description": "<p>AGI queue option (use: agi://127.0.0.1/square,&lt;project_name&gt;)</p>"
33347           },
33348           {
33349             "group": "Body",
33350             "type": "Boolean",
33351             "optional": true,
33352             "field": "dialAgiAfterHangupClient",
33353             "description": ""
33354           },
33355           {
33356             "group": "Body",
33357             "type": "Boolean",
33358             "optional": true,
33359             "field": "dialAgiAfterHangupAgent",
33360             "description": ""
33361           },
33362           {
33363             "group": "Body",
33364             "type": "Integer",
33365             "optional": true,
33366             "field": "dialRandomLastDigitCallerIdNumber",
33367             "description": "<p>Random Last Digit (min:1, max:15)</p>"
33368           },
33369           {
33370             "group": "Body",
33371             "type": "Integer",
33372             "optional": true,
33373             "field": "dialCutDigit",
33374             "description": "<p>Cut Digit (min:1, max:15)</p>"
33375           },
33376           {
33377             "group": "Body",
33378             "type": "Integer",
33379             "optional": true,
33380             "field": "dialNoSuchNumberMaxRetry",
33381             "description": "<p>#NoSuchNumber Retry (min:1, max:999)</p>"
33382           },
33383           {
33384             "group": "Body",
33385             "type": "Integer",
33386             "optional": true,
33387             "field": "dialNoSuchNumberRetryFrequency",
33388             "description": "<p>NoSuchNumber Retry Frequency Minutes (min:1, max:99999)</p>"
33389           },
33390           {
33391             "group": "Body",
33392             "type": "Integer",
33393             "optional": true,
33394             "field": "dialDropMaxRetry",
33395             "description": "<p>#Drop Retry (min:1, max:999)</p>"
33396           },
33397           {
33398             "group": "Body",
33399             "type": "Integer",
33400             "optional": true,
33401             "field": "dialDropRetryFrequency",
33402             "description": "<p>Drop Retry Frequency Minutes (min:1, max:99999)</p>"
33403           },
33404           {
33405             "group": "Body",
33406             "type": "Integer",
33407             "optional": true,
33408             "field": "dialAbandonedMaxRetry",
33409             "description": "<p>#Abandoned Retry (min:1, max:999)</p>"
33410           },
33411           {
33412             "group": "Body",
33413             "type": "Integer",
33414             "optional": true,
33415             "field": "dialAbandonedRetryFrequency",
33416             "description": "<p>Abandoned Retry Frequency Minutes (min:1, max:99999)</p>"
33417           },
33418           {
33419             "group": "Body",
33420             "type": "Integer",
33421             "optional": true,
33422             "field": "dialMachineMaxRetry",
33423             "description": "<p>#Machine Retry (min:1, max:999)</p>"
33424           },
33425           {
33426             "group": "Body",
33427             "type": "Integer",
33428             "optional": true,
33429             "field": "dialMachineRetryFrequency",
33430             "description": "<p>Machine Retry Frequency Minutes (min:1, max:99999)</p>"
33431           },
33432           {
33433             "group": "Body",
33434             "type": "Integer",
33435             "optional": true,
33436             "field": "dialAgentRejectMaxRetry",
33437             "description": "<p>#AgentReject Retry (min:1, max:999)</p>"
33438           },
33439           {
33440             "group": "Body",
33441             "type": "Integer",
33442             "optional": true,
33443             "field": "dialAgentRejectRetryFrequency",
33444             "description": "<p>AgentReject Retry Frequency Minutes (min:1, max:99999)</p>"
33445           },
33446           {
33447             "group": "Body",
33448             "type": "Integer",
33449             "optional": true,
33450             "field": "mandatoryDispositionPauseId",
33451             "description": "<p>Status to put when mandatory disposition is enabled</p>"
33452           },
33453           {
33454             "group": "Body",
33455             "type": "Boolean",
33456             "optional": true,
33457             "field": "mandatoryDisposition",
33458             "description": "<p>Enabled/disables mandatory dispo on a queue</p>"
33459           },
33460           {
33461             "group": "Body",
33462             "type": "Integer",
33463             "optional": true,
33464             "field": "dialPredictiveIntervalMaxThreshold",
33465             "description": ""
33466           },
33467           {
33468             "group": "Body",
33469             "type": "Integer",
33470             "optional": true,
33471             "field": "dialPredictiveIntervalMinThreshold",
33472             "description": ""
33473           }
33474         ]
33475       }
33476     },
33477     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33478     "version": "0.0.0",
33479     "filename": "server/api/voiceQueue/index.js",
33480     "groupTitle": "Voice_Queues"
33481   },
33482   {
33483     "type": "delete",
33484     "url": "/api/voice/queues/{id}",
33485     "title": "Deletes a Queue",
33486     "examples": [
33487       {
33488         "title": "Example usage:",
33489         "content": "curl https://{domain}/api/voice/queues/{id} -v -u {name}:{password} -X DELETE",
33490         "type": "json"
33491       }
33492     ],
33493     "name": "DeleteQueues",
33494     "group": "Voice_Queues",
33495     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33496     "version": "0.0.0",
33497     "filename": "server/api/voiceQueue/index.js",
33498     "groupTitle": "Voice_Queues"
33499   },
33500   {
33501     "type": "get",
33502     "url": "/api/voice/queues/{id}/users",
33503     "title": "Gets queue agents",
33504     "examples": [
33505       {
33506         "title": "Example usage:",
33507         "content": "curl https://{domain}/api/voice/queues/{id}/users -v -u {name}:{password} -X GET",
33508         "type": "json"
33509       }
33510     ],
33511     "name": "GetAgents",
33512     "group": "Voice_Queues",
33513     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33514     "version": "0.0.0",
33515     "filename": "server/api/voiceQueue/index.js",
33516     "groupTitle": "Voice_Queues"
33517   },
33518   {
33519     "type": "get",
33520     "url": "/api/voice/queues/{id}/blacklists",
33521     "title": "Get queue blacklists",
33522     "examples": [
33523       {
33524         "title": "Example usage:",
33525         "content": "curl https://{domain}/api/voice/queues/{id}/blacklists -v -u {name}:{password} -X GET",
33526         "type": "json"
33527       }
33528     ],
33529     "name": "GetBlackLists",
33530     "group": "Voice_Queues",
33531     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33532     "version": "0.0.0",
33533     "filename": "server/api/voiceQueue/index.js",
33534     "groupTitle": "Voice_Queues"
33535   },
33536   {
33537     "type": "get",
33538     "url": "/api/voice/queues/{id}/finals",
33539     "title": "Gets queue hopper finals",
33540     "examples": [
33541       {
33542         "title": "Example usage:",
33543         "content": "curl https://{domain}/api/voice/queues/{id}/hopper_finals -v -u {name}:{password}  -X GET",
33544         "type": "json"
33545       }
33546     ],
33547     "name": "GetHopperFinals",
33548     "group": "Voice_Queues",
33549     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33550     "version": "0.0.0",
33551     "filename": "server/api/voiceQueue/index.js",
33552     "groupTitle": "Voice_Queues"
33553   },
33554   {
33555     "type": "get",
33556     "url": "/api/voice/queues/{id}/hopper_histories",
33557     "title": "Gets queue hopper histories",
33558     "examples": [
33559       {
33560         "title": "Example usage:",
33561         "content": "curl https://{domain}/api/voice/queues/{id}/hopper_histories -v -u {name}:{password} -X GET",
33562         "type": "json"
33563       }
33564     ],
33565     "name": "GetHopperHistories",
33566     "group": "Voice_Queues",
33567     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33568     "version": "0.0.0",
33569     "filename": "server/api/voiceQueue/index.js",
33570     "groupTitle": "Voice_Queues"
33571   },
33572   {
33573     "type": "get",
33574     "url": "/api/voice/queues/{id}/hoppers",
33575     "title": "Gets queue hoppers",
33576     "examples": [
33577       {
33578         "title": "Example usage:",
33579         "content": "curl https://{domain}/api/voice/queues/{id}/hoppers -v -u {name}:{password} -X GET",
33580         "type": "json"
33581       }
33582     ],
33583     "name": "GetHoppers",
33584     "group": "Voice_Queues",
33585     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33586     "version": "0.0.0",
33587     "filename": "server/api/voiceQueue/index.js",
33588     "groupTitle": "Voice_Queues"
33589   },
33590   {
33591     "type": "get",
33592     "url": "/api/voice/queues/{id}/lists",
33593     "title": "Get queue lists",
33594     "examples": [
33595       {
33596         "title": "Example usage:",
33597         "content": "curl https://{domain}/api/voice/queues/{id}/lists -v -u {name}:{password} -X GET",
33598         "type": "json"
33599       }
33600     ],
33601     "name": "GetLists",
33602     "group": "Voice_Queues",
33603     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33604     "version": "0.0.0",
33605     "filename": "server/api/voiceQueue/index.js",
33606     "groupTitle": "Voice_Queues"
33607   },
33608   {
33609     "type": "get",
33610     "url": "/api/voice/queues/{id}/members",
33611     "title": "Gets queue members",
33612     "examples": [
33613       {
33614         "title": "Example usage:",
33615         "content": "curl https://{domain}/api/voice/queues/{id}/members -v -u {name}:{password} -X GET",
33616         "type": "json"
33617       }
33618     ],
33619     "name": "GetMembers",
33620     "group": "Voice_Queues",
33621     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33622     "version": "0.0.0",
33623     "filename": "server/api/voiceQueue/index.js",
33624     "groupTitle": "Voice_Queues"
33625   },
33626   {
33627     "type": "get",
33628     "url": "/api/voice/queues",
33629     "title": "Gets a list of Queues",
33630     "examples": [
33631       {
33632         "title": "Example usage:",
33633         "content": "curl https://{domain}/api/voice/queues -v -u {name}:{password}",
33634         "type": "json"
33635       }
33636     ],
33637     "name": "GetQueues",
33638     "group": "Voice_Queues",
33639     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
33640     "version": "0.0.0",
33641     "filename": "server/api/voiceQueue/index.js",
33642     "groupTitle": "Voice_Queues"
33643   },
33644   {
33645     "type": "get",
33646     "url": "/api/voice/queues/{id}/teams",
33647     "title": "Gets queue team",
33648     "examples": [
33649       {
33650         "title": "Example usage:",
33651         "content": "curl https://{domain}/api/voice/queues/{id}/teams -v -u {name}:{password}  -X GET",
33652         "type": "json"
33653       }
33654     ],
33655     "name": "GetTeams",
33656     "group": "Voice_Queues",
33657     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33658     "version": "0.0.0",
33659     "filename": "server/api/voiceQueue/index.js",
33660     "groupTitle": "Voice_Queues"
33661   },
33662   {
33663     "type": "delete",
33664     "url": "/api/voice/queues/{id}/users",
33665     "title": "Removes agents from a queue",
33666     "examples": [
33667       {
33668         "title": "Example usage:",
33669         "content": "curl https://{domain}/api/voice/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
33670         "type": "json"
33671       }
33672     ],
33673     "name": "RemoveAgents",
33674     "group": "Voice_Queues",
33675     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33676     "version": "0.0.0",
33677     "filename": "server/api/voiceQueue/index.js",
33678     "groupTitle": "Voice_Queues"
33679   },
33680   {
33681     "type": "delete",
33682     "url": "/api/voice/queues/{id}/blacklists",
33683     "title": "Remove blacklists from a queue",
33684     "examples": [
33685       {
33686         "title": "Example usage:",
33687         "content": "curl https://{domain}/api/voice/queues/{id}/blacklists?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
33688         "type": "json"
33689       }
33690     ],
33691     "name": "RemoveBlackLists",
33692     "group": "Voice_Queues",
33693     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33694     "version": "0.0.0",
33695     "filename": "server/api/voiceQueue/index.js",
33696     "groupTitle": "Voice_Queues"
33697   },
33698   {
33699     "type": "delete",
33700     "url": "/api/voice/queues/{id}/lists",
33701     "title": "Remove lists from a queue",
33702     "examples": [
33703       {
33704         "title": "Example usage:",
33705         "content": "curl https://{domain}/api/voice/queues/{id}/lists?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
33706         "type": "json"
33707       }
33708     ],
33709     "name": "RemoveLists",
33710     "group": "Voice_Queues",
33711     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33712     "version": "0.0.0",
33713     "filename": "server/api/voiceQueue/index.js",
33714     "groupTitle": "Voice_Queues"
33715   },
33716   {
33717     "type": "get",
33718     "url": "/api/voice/queues/{id}",
33719     "title": "Gets a single Queue",
33720     "examples": [
33721       {
33722         "title": "Example usage:",
33723         "content": "curl https://{domain}/api/voice/queues/{id} -v -u {name}:{password}",
33724         "type": "json"
33725       }
33726     ],
33727     "name": "ShowQueues",
33728     "group": "Voice_Queues",
33729     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33730     "version": "0.0.0",
33731     "filename": "server/api/voiceQueue/index.js",
33732     "groupTitle": "Voice_Queues"
33733   },
33734   {
33735     "type": "get",
33736     "url": "/api/voice/queues/{id}/blacks",
33737     "title": "Gets queue hopper blacks",
33738     "examples": [
33739       {
33740         "title": "Example usage:",
33741         "content": "curl https://{domain}/api/voice/queues/{id}/hopper_black -v -u {name}:{password}  -X GET",
33742         "type": "json"
33743       }
33744     ],
33745     "name": "getHopperBlacks",
33746     "group": "Voice_Queues",
33747     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33748     "version": "0.0.0",
33749     "filename": "server/api/voiceQueue/index.js",
33750     "groupTitle": "Voice_Queues"
33751   },
33752   {
33753     "type": "put",
33754     "url": "/api/voice/queues/{id}",
33755     "title": "Update an existing Queue",
33756     "examples": [
33757       {
33758         "title": "Example usage:",
33759         "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",
33760         "type": "json"
33761       }
33762     ],
33763     "name": "updateQueues",
33764     "group": "Voice_Queues",
33765     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33766     "version": "0.0.0",
33767     "filename": "server/api/voiceQueue/index.js",
33768     "groupTitle": "Voice_Queues"
33769   },
33770   {
33771     "type": "post",
33772     "url": "/api/voice/recordings",
33773     "title": "Creates a new Recording",
33774     "examples": [
33775       {
33776         "title": "Example usage:",
33777         "content": "curl https://{domain}/api/voice/recordings -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
33778         "type": "json"
33779       }
33780     ],
33781     "name": "CreateRecordings",
33782     "group": "Voice_Recordings",
33783     "parameter": {
33784       "fields": {
33785         "Body": [
33786           {
33787             "group": "Body",
33788             "type": "Virtual",
33789             "optional": true,
33790             "field": "format",
33791             "description": ""
33792           },
33793           {
33794             "group": "Body",
33795             "type": "String",
33796             "optional": true,
33797             "field": "uniqueid",
33798             "description": ""
33799           },
33800           {
33801             "group": "Body",
33802             "type": "String",
33803             "optional": true,
33804             "field": "channel",
33805             "description": ""
33806           },
33807           {
33808             "group": "Body",
33809             "type": "String",
33810             "optional": true,
33811             "field": "membername",
33812             "description": ""
33813           },
33814           {
33815             "group": "Body",
33816             "type": "String",
33817             "optional": true,
33818             "field": "calleridnum",
33819             "description": ""
33820           },
33821           {
33822             "group": "Body",
33823             "type": "String",
33824             "optional": true,
33825             "field": "calleridname",
33826             "description": ""
33827           },
33828           {
33829             "group": "Body",
33830             "type": "String",
33831             "optional": true,
33832             "field": "connectedlinenum",
33833             "description": ""
33834           },
33835           {
33836             "group": "Body",
33837             "type": "String",
33838             "optional": true,
33839             "field": "connectedlinename",
33840             "description": ""
33841           },
33842           {
33843             "group": "Body",
33844             "type": "String",
33845             "optional": true,
33846             "field": "accountcode",
33847             "description": ""
33848           },
33849           {
33850             "group": "Body",
33851             "type": "String",
33852             "optional": true,
33853             "field": "context",
33854             "description": ""
33855           },
33856           {
33857             "group": "Body",
33858             "type": "String",
33859             "optional": true,
33860             "field": "exten",
33861             "description": ""
33862           },
33863           {
33864             "group": "Body",
33865             "type": "String",
33866             "optional": true,
33867             "field": "value",
33868             "description": ""
33869           },
33870           {
33871             "group": "Body",
33872             "type": "String",
33873             "optional": true,
33874             "field": "type",
33875             "description": ""
33876           },
33877           {
33878             "group": "Body",
33879             "type": "Integer",
33880             "optional": true,
33881             "field": "rating",
33882             "description": ""
33883           },
33884           {
33885             "group": "Body",
33886             "type": "String",
33887             "optional": true,
33888             "field": "queue",
33889             "description": ""
33890           },
33891           {
33892             "group": "Body",
33893             "type": "String",
33894             "optional": true,
33895             "field": "userDisposition",
33896             "description": ""
33897           },
33898           {
33899             "group": "Body",
33900             "type": "Text",
33901             "optional": true,
33902             "field": "location",
33903             "description": ""
33904           },
33905           {
33906             "group": "Body",
33907             "type": "String",
33908             "optional": true,
33909             "field": "transcribeName",
33910             "description": ""
33911           },
33912           {
33913             "group": "Body",
33914             "type": "String",
33915             "optional": true,
33916             "field": "transcribeStatus",
33917             "description": ""
33918           },
33919           {
33920             "group": "Body",
33921             "type": "Text",
33922             "optional": true,
33923             "field": "fileUri",
33924             "description": ""
33925           },
33926           {
33927             "group": "Body",
33928             "type": "Text",
33929             "optional": true,
33930             "field": "fileText",
33931             "description": ""
33932           },
33933           {
33934             "group": "Body",
33935             "type": "Text",
33936             "optional": true,
33937             "field": "failureReason",
33938             "description": ""
33939           },
33940           {
33941             "group": "Body",
33942             "type": "String",
33943             "optional": true,
33944             "field": "sentiment",
33945             "description": ""
33946           },
33947           {
33948             "group": "Body",
33949             "type": "Float",
33950             "optional": true,
33951             "field": "sPositive",
33952             "description": ""
33953           },
33954           {
33955             "group": "Body",
33956             "type": "Float",
33957             "optional": true,
33958             "field": "sNegative",
33959             "description": ""
33960           },
33961           {
33962             "group": "Body",
33963             "type": "Float",
33964             "optional": true,
33965             "field": "sNeutral",
33966             "description": ""
33967           },
33968           {
33969             "group": "Body",
33970             "type": "Float",
33971             "optional": true,
33972             "field": "sMixed",
33973             "description": ""
33974           },
33975           {
33976             "group": "Body",
33977             "type": "Boolean",
33978             "optional": true,
33979             "field": "tempSentiment",
33980             "description": ""
33981           },
33982           {
33983             "group": "Body",
33984             "type": "String",
33985             "optional": true,
33986             "field": "createdAt",
33987             "description": ""
33988           },
33989           {
33990             "group": "Body",
33991             "type": "String",
33992             "optional": true,
33993             "field": "updatedAt",
33994             "description": ""
33995           }
33996         ]
33997       }
33998     },
33999     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34000     "version": "0.0.0",
34001     "filename": "server/api/voiceRecording/index.js",
34002     "groupTitle": "Voice_Recordings"
34003   },
34004   {
34005     "type": "get",
34006     "url": "/api/voice/recordings/describe",
34007     "title": "Gets table info about Recordings",
34008     "examples": [
34009       {
34010         "title": "Example usage:",
34011         "content": "curl https://{domain}/api/voice/recordings/describe -v -u {name}:{password}",
34012         "type": "json"
34013       }
34014     ],
34015     "name": "DescribeRecordings",
34016     "group": "Voice_Recordings",
34017     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34018     "version": "0.0.0",
34019     "filename": "server/api/voiceRecording/index.js",
34020     "groupTitle": "Voice_Recordings"
34021   },
34022   {
34023     "type": "get",
34024     "url": "/api/voice/recordings",
34025     "title": "Gets a list of Recordings",
34026     "examples": [
34027       {
34028         "title": "Example usage:",
34029         "content": "curl https://{domain}/api/voice/recordings -v -u {name}:{password}",
34030         "type": "json"
34031       }
34032     ],
34033     "name": "GetRecordings",
34034     "group": "Voice_Recordings",
34035     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
34036     "version": "0.0.0",
34037     "filename": "server/api/voiceRecording/index.js",
34038     "groupTitle": "Voice_Recordings"
34039   },
34040   {
34041     "type": "get",
34042     "url": "/api/voice/recordings/{id}",
34043     "title": "Gets a single Recording",
34044     "examples": [
34045       {
34046         "title": "Example usage:",
34047         "content": "curl https://{domain}/api/voice/recordings/{id} -v -u {name}:{password}",
34048         "type": "json"
34049       }
34050     ],
34051     "name": "ShowRecordings",
34052     "group": "Voice_Recordings",
34053     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34054     "version": "0.0.0",
34055     "filename": "server/api/voiceRecording/index.js",
34056     "groupTitle": "Voice_Recordings"
34057   },
34058   {
34059     "type": "delete",
34060     "url": "/api/voice/recordings/{id}",
34061     "title": "Delete voice recording",
34062     "examples": [
34063       {
34064         "title": "Example usage:",
34065         "content": "curl https://{domain}/api/voice/recordings/{id} -v -u {name}:{password} -X DELETE",
34066         "type": "json"
34067       }
34068     ],
34069     "name": "destroy",
34070     "group": "Voice_Recordings",
34071     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34072     "version": "0.0.0",
34073     "filename": "server/api/voiceRecording/index.js",
34074     "groupTitle": "Voice_Recordings"
34075   },
34076   {
34077     "type": "get",
34078     "url": "/api/voice/recordings/{id}/download",
34079     "title": "Download Recording",
34080     "examples": [
34081       {
34082         "title": "Example usage:",
34083         "content": "curl https://{domain}/api/voice/recordings/{id}/download -v -u {name}:{password} -X GET",
34084         "type": "json"
34085       }
34086     ],
34087     "name": "download",
34088     "group": "Voice_Recordings",
34089     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34090     "version": "0.0.0",
34091     "filename": "server/api/voiceRecording/index.js",
34092     "groupTitle": "Voice_Recordings"
34093   },
34094   {
34095     "type": "get",
34096     "url": "/api/voice/recordings/{id}/downloads",
34097     "title": "Download Recording",
34098     "examples": [
34099       {
34100         "title": "Example usage:",
34101         "content": "curl https://{domain}/api/voice/recordings/{id}/downloads -v -u {name}:{password} -X GET",
34102         "type": "json"
34103       }
34104     ],
34105     "name": "downloads",
34106     "group": "Voice_Recordings",
34107     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34108     "version": "0.0.0",
34109     "filename": "server/api/voiceRecording/index.js",
34110     "groupTitle": "Voice_Recordings"
34111   },
34112   {
34113     "type": "get",
34114     "url": "/api/voice/recordings/{id}/transcribe",
34115     "title": "Run Transcribe Recording",
34116     "examples": [
34117       {
34118         "title": "Example usage:",
34119         "content": "curl https://{domain}/api/voice/recordings/{id}/transcribe -v -u {name}:{password} -X GET",
34120         "type": "json"
34121       }
34122     ],
34123     "name": "transcribe",
34124     "group": "Voice_Recordings",
34125     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34126     "version": "0.0.0",
34127     "filename": "server/api/voiceRecording/index.js",
34128     "groupTitle": "Voice_Recordings"
34129   },
34130   {
34131     "type": "post",
34132     "url": "/api/voice/recordings/{id}/transcribe",
34133     "title": "Run Transcribe Recording",
34134     "examples": [
34135       {
34136         "title": "Example usage:",
34137         "content": "curl https://{domain}/api/voice/recordings/{id}/transcribe -d '{\"runSentiment\": \"true\"}' -v -u {name}:{password} -X POST",
34138         "type": "json"
34139       }
34140     ],
34141     "name": "transcribe",
34142     "group": "Voice_Recordings",
34143     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34144     "version": "0.0.0",
34145     "filename": "server/api/voiceRecording/index.js",
34146     "groupTitle": "Voice_Recordings"
34147   },
34148   {
34149     "type": "put",
34150     "url": "/api/voice/recordings/{id}",
34151     "title": "Update an existing Recording",
34152     "examples": [
34153       {
34154         "title": "Example usage:",
34155         "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",
34156         "type": "json"
34157       }
34158     ],
34159     "name": "updateRecordings",
34160     "group": "Voice_Recordings",
34161     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34162     "version": "0.0.0",
34163     "filename": "server/api/voiceRecording/index.js",
34164     "groupTitle": "Voice_Recordings"
34165   },
34166   {
34167     "type": "post",
34168     "url": "/api/voice/transfers/reports",
34169     "title": "Creates a new Transfer Report",
34170     "examples": [
34171       {
34172         "title": "Example usage:",
34173         "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",
34174         "type": "json"
34175       }
34176     ],
34177     "name": "CreateTransfer_Reports",
34178     "group": "Voice_Transfer_Reports",
34179     "parameter": {
34180       "fields": {
34181         "Body": [
34182           {
34183             "group": "Body",
34184             "type": "String",
34185             "allowedValues": [
34186               "\"blind\"",
34187               "\"attended\""
34188             ],
34189             "optional": true,
34190             "field": "type",
34191             "description": ""
34192           },
34193           {
34194             "group": "Body",
34195             "type": "String",
34196             "optional": true,
34197             "field": "result",
34198             "description": ""
34199           },
34200           {
34201             "group": "Body",
34202             "type": "String",
34203             "optional": true,
34204             "field": "transfererchannel",
34205             "description": ""
34206           },
34207           {
34208             "group": "Body",
34209             "type": "String",
34210             "optional": true,
34211             "field": "transferercalleridnum",
34212             "description": ""
34213           },
34214           {
34215             "group": "Body",
34216             "type": "String",
34217             "optional": true,
34218             "field": "transferercalleridname",
34219             "description": ""
34220           },
34221           {
34222             "group": "Body",
34223             "type": "String",
34224             "optional": true,
34225             "field": "transfererconnectedlinenum",
34226             "description": ""
34227           },
34228           {
34229             "group": "Body",
34230             "type": "String",
34231             "optional": true,
34232             "field": "transfererconnectedlinename",
34233             "description": ""
34234           },
34235           {
34236             "group": "Body",
34237             "type": "String",
34238             "optional": true,
34239             "field": "transfereraccountcode",
34240             "description": ""
34241           },
34242           {
34243             "group": "Body",
34244             "type": "String",
34245             "optional": true,
34246             "field": "transferercontext",
34247             "description": ""
34248           },
34249           {
34250             "group": "Body",
34251             "type": "String",
34252             "optional": true,
34253             "field": "transfererexten",
34254             "description": ""
34255           },
34256           {
34257             "group": "Body",
34258             "type": "String",
34259             "optional": true,
34260             "field": "transfererlinkedid",
34261             "description": ""
34262           },
34263           {
34264             "group": "Body",
34265             "type": "String",
34266             "optional": true,
34267             "field": "transfereechannel",
34268             "description": ""
34269           },
34270           {
34271             "group": "Body",
34272             "type": "String",
34273             "optional": true,
34274             "field": "transfereecalleridnum",
34275             "description": ""
34276           },
34277           {
34278             "group": "Body",
34279             "type": "String",
34280             "optional": true,
34281             "field": "transfereecalleridname",
34282             "description": ""
34283           },
34284           {
34285             "group": "Body",
34286             "type": "String",
34287             "optional": true,
34288             "field": "transfereeconnectedlinenum",
34289             "description": ""
34290           },
34291           {
34292             "group": "Body",
34293             "type": "String",
34294             "optional": true,
34295             "field": "transfereeconnectedlinename",
34296             "description": ""
34297           },
34298           {
34299             "group": "Body",
34300             "type": "String",
34301             "optional": true,
34302             "field": "transfereeaccountcode",
34303             "description": ""
34304           },
34305           {
34306             "group": "Body",
34307             "type": "String",
34308             "optional": true,
34309             "field": "transfereecontext",
34310             "description": ""
34311           },
34312           {
34313             "group": "Body",
34314             "type": "String",
34315             "optional": true,
34316             "field": "transfereeexten",
34317             "description": ""
34318           },
34319           {
34320             "group": "Body",
34321             "type": "String",
34322             "optional": true,
34323             "field": "transfereelinkedid",
34324             "description": ""
34325           },
34326           {
34327             "group": "Body",
34328             "type": "String",
34329             "allowedValues": [
34330               "\"Yes\"",
34331               "\"No\""
34332             ],
34333             "optional": true,
34334             "field": "isexternal",
34335             "description": ""
34336           },
34337           {
34338             "group": "Body",
34339             "type": "String",
34340             "optional": true,
34341             "field": "context",
34342             "description": ""
34343           },
34344           {
34345             "group": "Body",
34346             "type": "String",
34347             "optional": true,
34348             "field": "extension",
34349             "description": ""
34350           }
34351         ]
34352       }
34353     },
34354     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34355     "version": "0.0.0",
34356     "filename": "server/api/voiceTransferReport/index.js",
34357     "groupTitle": "Voice_Transfer_Reports"
34358   },
34359   {
34360     "type": "delete",
34361     "url": "/api/voice/transfers/reports/{id}",
34362     "title": "Deletes a Transfer Report",
34363     "examples": [
34364       {
34365         "title": "Example usage:",
34366         "content": "curl https://{domain}/api/voice/transfers/reports/{id} -v -u {name}:{password} -X DELETE",
34367         "type": "json"
34368       }
34369     ],
34370     "name": "DeleteTransfer_Reports",
34371     "group": "Voice_Transfer_Reports",
34372     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34373     "version": "0.0.0",
34374     "filename": "server/api/voiceTransferReport/index.js",
34375     "groupTitle": "Voice_Transfer_Reports"
34376   },
34377   {
34378     "type": "get",
34379     "url": "/api/voice/transfers/reports",
34380     "title": "Gets a list of Transfer Reports",
34381     "examples": [
34382       {
34383         "title": "Example usage:",
34384         "content": "curl https://{domain}/api/voice/transfers/reports -v -u {name}:{password}",
34385         "type": "json"
34386       }
34387     ],
34388     "name": "GetTransfer_Reports",
34389     "group": "Voice_Transfer_Reports",
34390     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
34391     "version": "0.0.0",
34392     "filename": "server/api/voiceTransferReport/index.js",
34393     "groupTitle": "Voice_Transfer_Reports"
34394   },
34395   {
34396     "type": "get",
34397     "url": "/api/voice/transfers/reports/{id}",
34398     "title": "Gets a single Transfer Report",
34399     "examples": [
34400       {
34401         "title": "Example usage:",
34402         "content": "curl https://{domain}/api/voice/transfers/reports/{id} -v -u {name}:{password}",
34403         "type": "json"
34404       }
34405     ],
34406     "name": "ShowTransfer_Reports",
34407     "group": "Voice_Transfer_Reports",
34408     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34409     "version": "0.0.0",
34410     "filename": "server/api/voiceTransferReport/index.js",
34411     "groupTitle": "Voice_Transfer_Reports"
34412   },
34413   {
34414     "type": "put",
34415     "url": "/api/voice/transfers/reports/{id}",
34416     "title": "Update an existing Transfer Report",
34417     "examples": [
34418       {
34419         "title": "Example usage:",
34420         "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",
34421         "type": "json"
34422       }
34423     ],
34424     "name": "updateTransfer_Reports",
34425     "group": "Voice_Transfer_Reports",
34426     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34427     "version": "0.0.0",
34428     "filename": "server/api/voiceTransferReport/index.js",
34429     "groupTitle": "Voice_Transfer_Reports"
34430   },
34431   {
34432     "type": "post",
34433     "url": "/api/integrations/vtiger/accounts",
34434     "title": "Creates a new Vtiger Account",
34435     "examples": [
34436       {
34437         "title": "Example usage:",
34438         "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",
34439         "type": "json"
34440       }
34441     ],
34442     "name": "CreateVtiger_Accounts",
34443     "group": "Vtiger_Accounts",
34444     "parameter": {
34445       "fields": {
34446         "Body": [
34447           {
34448             "group": "Body",
34449             "type": "String",
34450             "optional": false,
34451             "field": "name",
34452             "description": ""
34453           },
34454           {
34455             "group": "Body",
34456             "type": "String",
34457             "optional": true,
34458             "field": "description",
34459             "description": ""
34460           },
34461           {
34462             "group": "Body",
34463             "type": "String",
34464             "optional": false,
34465             "field": "username",
34466             "description": ""
34467           },
34468           {
34469             "group": "Body",
34470             "type": "String",
34471             "optional": false,
34472             "field": "moduleName",
34473             "description": ""
34474           },
34475           {
34476             "group": "Body",
34477             "type": "String",
34478             "optional": false,
34479             "field": "remoteUri",
34480             "description": ""
34481           },
34482           {
34483             "group": "Body",
34484             "type": "String",
34485             "optional": true,
34486             "field": "serverUrl",
34487             "description": ""
34488           },
34489           {
34490             "group": "Body",
34491             "type": "String",
34492             "optional": false,
34493             "field": "accessKey",
34494             "description": ""
34495           }
34496         ]
34497       }
34498     },
34499     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34500     "version": "0.0.0",
34501     "filename": "server/api/intVtigerAccount/index.js",
34502     "groupTitle": "Vtiger_Accounts"
34503   },
34504   {
34505     "type": "delete",
34506     "url": "/api/integrations/vtiger/accounts/{id}",
34507     "title": "Deletes a Vtiger Account",
34508     "examples": [
34509       {
34510         "title": "Example usage:",
34511         "content": "curl https://{domain}/api/integrations/vtiger/accounts/{id} -v -u {name}:{password} -X DELETE",
34512         "type": "json"
34513       }
34514     ],
34515     "name": "DeleteVtiger_Accounts",
34516     "group": "Vtiger_Accounts",
34517     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34518     "version": "0.0.0",
34519     "filename": "server/api/intVtigerAccount/index.js",
34520     "groupTitle": "Vtiger_Accounts"
34521   },
34522   {
34523     "type": "get",
34524     "url": "/api/integrations/vtiger/accounts",
34525     "title": "Gets a list of Vtiger Accounts",
34526     "examples": [
34527       {
34528         "title": "Example usage:",
34529         "content": "curl https://{domain}/api/integrations/vtiger/accounts -v -u {name}:{password}",
34530         "type": "json"
34531       }
34532     ],
34533     "name": "GetVtiger_Accounts",
34534     "group": "Vtiger_Accounts",
34535     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
34536     "version": "0.0.0",
34537     "filename": "server/api/intVtigerAccount/index.js",
34538     "groupTitle": "Vtiger_Accounts"
34539   },
34540   {
34541     "type": "get",
34542     "url": "/api/integrations/vtiger/accounts/{id}",
34543     "title": "Gets a single Vtiger Account",
34544     "examples": [
34545       {
34546         "title": "Example usage:",
34547         "content": "curl https://{domain}/api/integrations/vtiger/accounts/{id} -v -u {name}:{password}",
34548         "type": "json"
34549       }
34550     ],
34551     "name": "ShowVtiger_Accounts",
34552     "group": "Vtiger_Accounts",
34553     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34554     "version": "0.0.0",
34555     "filename": "server/api/intVtigerAccount/index.js",
34556     "groupTitle": "Vtiger_Accounts"
34557   },
34558   {
34559     "type": "post",
34560     "url": "/api/integrations/vtiger/accounts/{id}/configurations",
34561     "title": "Creates new configuration",
34562     "examples": [
34563       {
34564         "title": "Example usage:",
34565         "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",
34566         "type": "json"
34567       }
34568     ],
34569     "name": "addConfiguration",
34570     "group": "Vtiger_Accounts",
34571     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34572     "version": "0.0.0",
34573     "filename": "server/api/intVtigerAccount/index.js",
34574     "groupTitle": "Vtiger_Accounts"
34575   },
34576   {
34577     "type": "get",
34578     "url": "/api/integrations/vtiger/accounts/{id}/configurations",
34579     "title": "Gets account configurations",
34580     "examples": [
34581       {
34582         "title": "Example usage:",
34583         "content": "curl https://{domain}/api/integrations/vtiger/accounts/{id}/configurations -v -u {name}:{password} -X GET",
34584         "type": "json"
34585       }
34586     ],
34587     "name": "getConfigurations",
34588     "group": "Vtiger_Accounts",
34589     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34590     "version": "0.0.0",
34591     "filename": "server/api/intVtigerAccount/index.js",
34592     "groupTitle": "Vtiger_Accounts"
34593   },
34594   {
34595     "type": "get",
34596     "url": "/api/integrations/vtiger/accounts/{id}/fields",
34597     "title": "Gets account fields",
34598     "examples": [
34599       {
34600         "title": "Example usage:",
34601         "content": "curl https://{domain}/api/integrations/vtiger/accounts/{id}/fields -v -u {name}:{password} -X GET",
34602         "type": "json"
34603       }
34604     ],
34605     "name": "getFields",
34606     "group": "Vtiger_Accounts",
34607     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34608     "version": "0.0.0",
34609     "filename": "server/api/intVtigerAccount/index.js",
34610     "groupTitle": "Vtiger_Accounts"
34611   },
34612   {
34613     "type": "put",
34614     "url": "/api/integrations/vtiger/accounts/{id}",
34615     "title": "Update an existing Vtiger Account",
34616     "examples": [
34617       {
34618         "title": "Example usage:",
34619         "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",
34620         "type": "json"
34621       }
34622     ],
34623     "name": "updateVtiger_Accounts",
34624     "group": "Vtiger_Accounts",
34625     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34626     "version": "0.0.0",
34627     "filename": "server/api/intVtigerAccount/index.js",
34628     "groupTitle": "Vtiger_Accounts"
34629   },
34630   {
34631     "type": "post",
34632     "url": "/api/integrations/vtiger/configurations",
34633     "title": "Creates a new Vtiger Configuration",
34634     "examples": [
34635       {
34636         "title": "Example usage:",
34637         "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",
34638         "type": "json"
34639       }
34640     ],
34641     "name": "CreateVtiger_Configurations",
34642     "group": "Vtiger_Configurations",
34643     "parameter": {
34644       "fields": {
34645         "Body": [
34646           {
34647             "group": "Body",
34648             "type": "String",
34649             "optional": true,
34650             "field": "name",
34651             "description": ""
34652           },
34653           {
34654             "group": "Body",
34655             "type": "String",
34656             "optional": true,
34657             "field": "description",
34658             "description": ""
34659           }
34660         ]
34661       }
34662     },
34663     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34664     "version": "0.0.0",
34665     "filename": "server/api/intVtigerConfiguration/index.js",
34666     "groupTitle": "Vtiger_Configurations"
34667   },
34668   {
34669     "type": "delete",
34670     "url": "/api/integrations/vtiger/configurations/{id}",
34671     "title": "Deletes a Vtiger Configuration",
34672     "examples": [
34673       {
34674         "title": "Example usage:",
34675         "content": "curl https://{domain}/api/integrations/vtiger/configurations/{id} -v -u {name}:{password} -X DELETE",
34676         "type": "json"
34677       }
34678     ],
34679     "name": "DeleteVtiger_Configurations",
34680     "group": "Vtiger_Configurations",
34681     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34682     "version": "0.0.0",
34683     "filename": "server/api/intVtigerConfiguration/index.js",
34684     "groupTitle": "Vtiger_Configurations"
34685   },
34686   {
34687     "type": "get",
34688     "url": "/api/integrations/vtiger/configurations",
34689     "title": "Gets a list of Vtiger Configurations",
34690     "examples": [
34691       {
34692         "title": "Example usage:",
34693         "content": "curl https://{domain}/api/integrations/vtiger/configurations -v -u {name}:{password}",
34694         "type": "json"
34695       }
34696     ],
34697     "name": "GetVtiger_Configurations",
34698     "group": "Vtiger_Configurations",
34699     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
34700     "version": "0.0.0",
34701     "filename": "server/api/intVtigerConfiguration/index.js",
34702     "groupTitle": "Vtiger_Configurations"
34703   },
34704   {
34705     "type": "get",
34706     "url": "/api/integrations/vtiger/configurations/{id}",
34707     "title": "Gets a single Vtiger Configuration",
34708     "examples": [
34709       {
34710         "title": "Example usage:",
34711         "content": "curl https://{domain}/api/integrations/vtiger/configurations/{id} -v -u {name}:{password}",
34712         "type": "json"
34713       }
34714     ],
34715     "name": "ShowVtiger_Configurations",
34716     "group": "Vtiger_Configurations",
34717     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34718     "version": "0.0.0",
34719     "filename": "server/api/intVtigerConfiguration/index.js",
34720     "groupTitle": "Vtiger_Configurations"
34721   },
34722   {
34723     "type": "get",
34724     "url": "/api/integrations/vtiger/configurations/{id}/descriptions",
34725     "title": "Gets configurations descriptions",
34726     "examples": [
34727       {
34728         "title": "Example usage:",
34729         "content": "curl https://{domain}/api/integrations/vtiger/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
34730         "type": "json"
34731       }
34732     ],
34733     "name": "getDescriptions",
34734     "group": "Vtiger_Configurations",
34735     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34736     "version": "0.0.0",
34737     "filename": "server/api/intVtigerConfiguration/index.js",
34738     "groupTitle": "Vtiger_Configurations"
34739   },
34740   {
34741     "type": "get",
34742     "url": "/api/integrations/vtiger/configurations/{id}/fields",
34743     "title": "Gets configurations fields",
34744     "examples": [
34745       {
34746         "title": "Example usage:",
34747         "content": "curl https://{domain}/api/integrations/vtiger/configurations/{id}/fields -v -u {name}:{password} -X GET",
34748         "type": "json"
34749       }
34750     ],
34751     "name": "getFields",
34752     "group": "Vtiger_Configurations",
34753     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34754     "version": "0.0.0",
34755     "filename": "server/api/intVtigerConfiguration/index.js",
34756     "groupTitle": "Vtiger_Configurations"
34757   },
34758   {
34759     "type": "get",
34760     "url": "/api/integrations/vtiger/configurations/{id}/subjects",
34761     "title": "Gets configurations subjects",
34762     "examples": [
34763       {
34764         "title": "Example usage:",
34765         "content": "curl https://{domain}/api/integrations/vtiger/configurations/{id}/subjects -v -u {name}:{password} -X GET",
34766         "type": "json"
34767       }
34768     ],
34769     "name": "getSubjects",
34770     "group": "Vtiger_Configurations",
34771     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34772     "version": "0.0.0",
34773     "filename": "server/api/intVtigerConfiguration/index.js",
34774     "groupTitle": "Vtiger_Configurations"
34775   },
34776   {
34777     "type": "put",
34778     "url": "/api/integrations/vtiger/configurations/{id}",
34779     "title": "Update an existing Vtiger Configuration",
34780     "examples": [
34781       {
34782         "title": "Example usage:",
34783         "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",
34784         "type": "json"
34785       }
34786     ],
34787     "name": "updateVtiger_Configurations",
34788     "group": "Vtiger_Configurations",
34789     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34790     "version": "0.0.0",
34791     "filename": "server/api/intVtigerConfiguration/index.js",
34792     "groupTitle": "Vtiger_Configurations"
34793   },
34794   {
34795     "type": "post",
34796     "url": "/api/integrations/vtiger/fields",
34797     "title": "Creates a new Vtiger Field",
34798     "examples": [
34799       {
34800         "title": "Example usage:",
34801         "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",
34802         "type": "json"
34803       }
34804     ],
34805     "name": "CreateVtiger_Fields",
34806     "group": "Vtiger_Fields",
34807     "parameter": {
34808       "fields": {
34809         "Body": [
34810           {
34811             "group": "Body",
34812             "type": "String",
34813             "allowedValues": [
34814               "\"string\"",
34815               "\"variable\"",
34816               "\"customVariable\"",
34817               "\"keyValue\""
34818             ],
34819             "optional": true,
34820             "field": "type",
34821             "description": ""
34822           },
34823           {
34824             "group": "Body",
34825             "type": "String",
34826             "optional": true,
34827             "field": "content",
34828             "description": ""
34829           },
34830           {
34831             "group": "Body",
34832             "type": "String",
34833             "optional": true,
34834             "field": "key",
34835             "description": ""
34836           },
34837           {
34838             "group": "Body",
34839             "type": "String",
34840             "allowedValues": [
34841               "\"string\"",
34842               "\"variable\"",
34843               "\"customVariable\""
34844             ],
34845             "optional": true,
34846             "field": "keyType",
34847             "description": ""
34848           },
34849           {
34850             "group": "Body",
34851             "type": "String",
34852             "optional": true,
34853             "field": "keyContent",
34854             "description": ""
34855           },
34856           {
34857             "group": "Body",
34858             "type": "String",
34859             "optional": true,
34860             "field": "idField",
34861             "description": ""
34862           },
34863           {
34864             "group": "Body",
34865             "type": "String",
34866             "optional": true,
34867             "field": "nameField",
34868             "description": ""
34869           },
34870           {
34871             "group": "Body",
34872             "type": "Boolean",
34873             "optional": true,
34874             "field": "customField",
34875             "description": ""
34876           },
34877           {
34878             "group": "Body",
34879             "type": "String",
34880             "optional": true,
34881             "field": "variableName",
34882             "description": ""
34883           }
34884         ]
34885       }
34886     },
34887     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34888     "version": "0.0.0",
34889     "filename": "server/api/intVtigerField/index.js",
34890     "groupTitle": "Vtiger_Fields"
34891   },
34892   {
34893     "type": "delete",
34894     "url": "/api/integrations/vtiger/fields/{id}",
34895     "title": "Deletes a Vtiger Field",
34896     "examples": [
34897       {
34898         "title": "Example usage:",
34899         "content": "curl https://{domain}/api/integrations/vtiger/fields/{id} -v -u {name}:{password} -X DELETE",
34900         "type": "json"
34901       }
34902     ],
34903     "name": "DeleteVtiger_Fields",
34904     "group": "Vtiger_Fields",
34905     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34906     "version": "0.0.0",
34907     "filename": "server/api/intVtigerField/index.js",
34908     "groupTitle": "Vtiger_Fields"
34909   },
34910   {
34911     "type": "get",
34912     "url": "/api/integrations/vtiger/fields",
34913     "title": "Gets a list of Vtiger Fields",
34914     "examples": [
34915       {
34916         "title": "Example usage:",
34917         "content": "curl https://{domain}/api/integrations/vtiger/fields -v -u {name}:{password}",
34918         "type": "json"
34919       }
34920     ],
34921     "name": "GetVtiger_Fields",
34922     "group": "Vtiger_Fields",
34923     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
34924     "version": "0.0.0",
34925     "filename": "server/api/intVtigerField/index.js",
34926     "groupTitle": "Vtiger_Fields"
34927   },
34928   {
34929     "type": "get",
34930     "url": "/api/integrations/vtiger/fields/{id}",
34931     "title": "Gets a single Vtiger Field",
34932     "examples": [
34933       {
34934         "title": "Example usage:",
34935         "content": "curl https://{domain}/api/integrations/vtiger/fields/{id} -v -u {name}:{password}",
34936         "type": "json"
34937       }
34938     ],
34939     "name": "ShowVtiger_Fields",
34940     "group": "Vtiger_Fields",
34941     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34942     "version": "0.0.0",
34943     "filename": "server/api/intVtigerField/index.js",
34944     "groupTitle": "Vtiger_Fields"
34945   },
34946   {
34947     "type": "put",
34948     "url": "/api/integrations/vtiger/fields/{id}",
34949     "title": "Update an existing Vtiger Field",
34950     "examples": [
34951       {
34952         "title": "Example usage:",
34953         "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",
34954         "type": "json"
34955       }
34956     ],
34957     "name": "updateVtiger_Fields",
34958     "group": "Vtiger_Fields",
34959     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34960     "version": "0.0.0",
34961     "filename": "server/api/intVtigerField/index.js",
34962     "groupTitle": "Vtiger_Fields"
34963   },
34964   {
34965     "type": "post",
34966     "url": "/api/webbar/answer",
34967     "title": "answer webrtc call",
34968     "examples": [
34969       {
34970         "title": "Example usage:",
34971         "content": "curl https://{domain}/api/webbar/answer -d '{\"sessionId\": \"<sessionId>\", \"userId\": 54}' \\\n -H \"Content-Type: application/json\" -X POST",
34972         "type": "json"
34973       }
34974     ],
34975     "name": "Web_Bar_answer",
34976     "group": "WebBar",
34977     "parameter": {
34978       "fields": {
34979         "Body": [
34980           {
34981             "group": "Body",
34982             "type": "String",
34983             "optional": false,
34984             "field": "sessionId",
34985             "description": ""
34986           },
34987           {
34988             "group": "Body",
34989             "type": "number",
34990             "optional": false,
34991             "field": "userId",
34992             "description": ""
34993           }
34994         ]
34995       }
34996     },
34997     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34998     "version": "0.0.0",
34999     "filename": "server/api/webbar/index.js",
35000     "groupTitle": "WebBar"
35001   },
35002   {
35003     "type": "post",
35004     "url": "/api/webbar/calls",
35005     "title": "webrtc call list",
35006     "examples": [
35007       {
35008         "title": "Example usage:",
35009         "content": "curl https://{domain}/api/webbar/calls -d '{\"userId\": 54}' \\\n -H \"Content-Type: application/json\" -X POST",
35010         "type": "json"
35011       }
35012     ],
35013     "name": "Web_Bar_calls",
35014     "group": "WebBar",
35015     "parameter": {
35016       "fields": {
35017         "Body": [
35018           {
35019             "group": "Body",
35020             "type": "number",
35021             "optional": false,
35022             "field": "userId",
35023             "description": ""
35024           }
35025         ]
35026       }
35027     },
35028     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35029     "version": "0.0.0",
35030     "filename": "server/api/webbar/index.js",
35031     "groupTitle": "WebBar"
35032   },
35033   {
35034     "type": "post",
35035     "url": "/api/webbar/hangup",
35036     "title": "hangup webrtc call",
35037     "examples": [
35038       {
35039         "title": "Example usage:",
35040         "content": "curl https://{domain}/api/webbar/hangup -d '{\"sessionId\": \"<sessionId>\", \"userId\": 54}' \\\n -H \"Content-Type: application/json\" -X POST",
35041         "type": "json"
35042       }
35043     ],
35044     "name": "Web_Bar_hangup",
35045     "group": "WebBar",
35046     "parameter": {
35047       "fields": {
35048         "Body": [
35049           {
35050             "group": "Body",
35051             "type": "String",
35052             "optional": false,
35053             "field": "sessionId",
35054             "description": ""
35055           },
35056           {
35057             "group": "Body",
35058             "type": "number",
35059             "optional": false,
35060             "field": "userId",
35061             "description": ""
35062           }
35063         ]
35064       }
35065     },
35066     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35067     "version": "0.0.0",
35068     "filename": "server/api/webbar/index.js",
35069     "groupTitle": "WebBar"
35070   },
35071   {
35072     "type": "post",
35073     "url": "/api/webbar/hold",
35074     "title": "hold webrtc call",
35075     "examples": [
35076       {
35077         "title": "Example usage:",
35078         "content": "curl https://{domain}/api/webbar/hold -d '{\"sessionId\": \"<sessionId>\", \"userId\": 54}' \\\n -H \"Content-Type: application/json\" -X POST",
35079         "type": "json"
35080       }
35081     ],
35082     "name": "Web_Bar_hold",
35083     "group": "WebBar",
35084     "parameter": {
35085       "fields": {
35086         "Body": [
35087           {
35088             "group": "Body",
35089             "type": "String",
35090             "optional": true,
35091             "field": "sessionId",
35092             "description": ""
35093           },
35094           {
35095             "group": "Body",
35096             "type": "number",
35097             "optional": false,
35098             "field": "userId",
35099             "description": ""
35100           }
35101         ]
35102       }
35103     },
35104     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35105     "version": "0.0.0",
35106     "filename": "server/api/webbar/index.js",
35107     "groupTitle": "WebBar"
35108   },
35109   {
35110     "type": "post",
35111     "url": "/api/webbar/unhold",
35112     "title": "unhold webrtc call",
35113     "examples": [
35114       {
35115         "title": "Example usage:",
35116         "content": "curl https://{domain}/api/webbar/unhold -d '{\"sessionId\": \"<sessionId>\", \"userId\": 54}' \\\n -H \"Content-Type: application/json\" -X POST",
35117         "type": "json"
35118       }
35119     ],
35120     "name": "Web_Bar_hold",
35121     "group": "WebBar",
35122     "parameter": {
35123       "fields": {
35124         "Body": [
35125           {
35126             "group": "Body",
35127             "type": "String",
35128             "optional": false,
35129             "field": "sessionId",
35130             "description": ""
35131           },
35132           {
35133             "group": "Body",
35134             "type": "number",
35135             "optional": false,
35136             "field": "userId",
35137             "description": ""
35138           }
35139         ]
35140       }
35141     },
35142     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35143     "version": "0.0.0",
35144     "filename": "server/api/webbar/index.js",
35145     "groupTitle": "WebBar"
35146   },
35147   {
35148     "type": "post",
35149     "url": "/api/webbar/originate",
35150     "title": "Originate new webrtc call",
35151     "examples": [
35152       {
35153         "title": "Example usage:",
35154         "content": "curl https://{domain}/api/webbar/originate -d '{\"callNumber\": \"0119692844\", \"userId\": 54}' \\\n -H \"Content-Type: application/json\" -X POST",
35155         "type": "json"
35156       }
35157     ],
35158     "name": "Web_Bar_originate",
35159     "group": "WebBar",
35160     "parameter": {
35161       "fields": {
35162         "Body": [
35163           {
35164             "group": "Body",
35165             "type": "String",
35166             "optional": false,
35167             "field": "callNumber",
35168             "description": ""
35169           },
35170           {
35171             "group": "Body",
35172             "type": "number",
35173             "optional": false,
35174             "field": "userId",
35175             "description": ""
35176           },
35177           {
35178             "group": "Body",
35179             "type": "String",
35180             "optional": false,
35181             "field": "callerId",
35182             "description": ""
35183           },
35184           {
35185             "group": "Body",
35186             "type": "String",
35187             "optional": false,
35188             "field": "callbackUrl",
35189             "description": ""
35190           }
35191         ]
35192       }
35193     },
35194     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35195     "version": "0.0.0",
35196     "filename": "server/api/webbar/index.js",
35197     "groupTitle": "WebBar"
35198   },
35199   {
35200     "type": "post",
35201     "url": "/api/webbar/transfer",
35202     "title": "blind transfer webrtc call",
35203     "examples": [
35204       {
35205         "title": "Example usage:",
35206         "content": "curl https://{domain}/api/webbar/transfer -d '{\"userId\": 54, \"sessionId\":\"<sessionId>\", \"transferNumber\":\"<transferNumber>\"}' \\\n -H \"Content-Type: application/json\" -X POST",
35207         "type": "json"
35208       }
35209     ],
35210     "name": "Web_Bar_transfer",
35211     "group": "WebBar",
35212     "parameter": {
35213       "fields": {
35214         "Body": [
35215           {
35216             "group": "Body",
35217             "type": "number",
35218             "optional": false,
35219             "field": "userId",
35220             "description": ""
35221           },
35222           {
35223             "group": "Body",
35224             "type": "string",
35225             "optional": false,
35226             "field": "sessionId",
35227             "description": ""
35228           },
35229           {
35230             "group": "Body",
35231             "type": "string",
35232             "optional": false,
35233             "field": "transferNumber",
35234             "description": ""
35235           }
35236         ]
35237       }
35238     },
35239     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35240     "version": "0.0.0",
35241     "filename": "server/api/webbar/index.js",
35242     "groupTitle": "WebBar"
35243   },
35244   {
35245     "type": "post",
35246     "url": "/api/whatsapp/accounts/{id}/users",
35247     "title": "Add agents to a whatsapp account",
35248     "examples": [
35249       {
35250         "title": "Example usage:",
35251         "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",
35252         "type": "json"
35253       }
35254     ],
35255     "name": "AddAgents",
35256     "group": "Whatsapp_Accounts",
35257     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35258     "version": "0.0.0",
35259     "filename": "server/api/whatsappAccount/index.js",
35260     "groupTitle": "Whatsapp_Accounts"
35261   },
35262   {
35263     "type": "post",
35264     "url": "/api/whatsapp/accounts",
35265     "title": "Creates a new Account",
35266     "examples": [
35267       {
35268         "title": "Example usage:",
35269         "content": "curl https://{domain}/api/whatsapp/accounts -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
35270         "type": "json"
35271       }
35272     ],
35273     "name": "CreateAccounts",
35274     "group": "Whatsapp_Accounts",
35275     "parameter": {
35276       "fields": {
35277         "Body": [
35278           {
35279             "group": "Body",
35280             "type": "String",
35281             "optional": false,
35282             "field": "name",
35283             "description": ""
35284           },
35285           {
35286             "group": "Body",
35287             "type": "String",
35288             "optional": false,
35289             "field": "key",
35290             "description": ""
35291           },
35292           {
35293             "group": "Body",
35294             "type": "String",
35295             "optional": false,
35296             "field": "remote",
35297             "description": ""
35298           },
35299           {
35300             "group": "Body",
35301             "type": "String",
35302             "optional": true,
35303             "field": "token",
35304             "description": ""
35305           },
35306           {
35307             "group": "Body",
35308             "type": "String",
35309             "optional": true,
35310             "field": "phone",
35311             "description": ""
35312           },
35313           {
35314             "group": "Body",
35315             "type": "String",
35316             "allowedValues": [
35317               "\"twilio\""
35318             ],
35319             "optional": true,
35320             "field": "type",
35321             "description": ""
35322           },
35323           {
35324             "group": "Body",
35325             "type": "String",
35326             "optional": true,
35327             "field": "accountSid",
35328             "description": ""
35329           },
35330           {
35331             "group": "Body",
35332             "type": "String",
35333             "optional": true,
35334             "field": "authToken",
35335             "description": ""
35336           },
35337           {
35338             "group": "Body",
35339             "type": "Text",
35340             "optional": true,
35341             "field": "notificationTemplate",
35342             "description": ""
35343           },
35344           {
35345             "group": "Body",
35346             "type": "Boolean",
35347             "optional": true,
35348             "field": "notificationSound",
35349             "description": ""
35350           },
35351           {
35352             "group": "Body",
35353             "type": "Boolean",
35354             "optional": true,
35355             "field": "notificationShake",
35356             "description": ""
35357           },
35358           {
35359             "group": "Body",
35360             "type": "Integer",
35361             "optional": true,
35362             "field": "waitForTheAssignedAgent",
35363             "description": ""
35364           },
35365           {
35366             "group": "Body",
35367             "type": "Boolean",
35368             "optional": true,
35369             "field": "queueTransfer",
35370             "description": ""
35371           },
35372           {
35373             "group": "Body",
35374             "type": "Integer",
35375             "optional": true,
35376             "field": "queueTransferTimeout",
35377             "description": ""
35378           },
35379           {
35380             "group": "Body",
35381             "type": "Boolean",
35382             "optional": true,
35383             "field": "agentTransfer",
35384             "description": ""
35385           },
35386           {
35387             "group": "Body",
35388             "type": "Integer",
35389             "optional": true,
35390             "field": "agentTransferTimeout",
35391             "description": ""
35392           },
35393           {
35394             "group": "Body",
35395             "type": "Integer",
35396             "optional": true,
35397             "field": "mandatoryDispositionPauseId",
35398             "description": "<p>Status to put when mandatory disposition is enabled</p>"
35399           },
35400           {
35401             "group": "Body",
35402             "type": "Boolean",
35403             "optional": true,
35404             "field": "mandatoryDisposition",
35405             "description": "<p>Enabled/disables mandatory dispo on a queue</p>"
35406           },
35407           {
35408             "group": "Body",
35409             "type": "String",
35410             "optional": true,
35411             "field": "description",
35412             "description": ""
35413           }
35414         ]
35415       }
35416     },
35417     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35418     "version": "0.0.0",
35419     "filename": "server/api/whatsappAccount/index.js",
35420     "groupTitle": "Whatsapp_Accounts"
35421   },
35422   {
35423     "type": "delete",
35424     "url": "/api/whatsapp/accounts/{id}",
35425     "title": "Deletes a Account",
35426     "examples": [
35427       {
35428         "title": "Example usage:",
35429         "content": "curl https://{domain}/api/whatsapp/accounts/{id} -v -u {name}:{password} -X DELETE",
35430         "type": "json"
35431       }
35432     ],
35433     "name": "DeleteAccounts",
35434     "group": "Whatsapp_Accounts",
35435     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35436     "version": "0.0.0",
35437     "filename": "server/api/whatsappAccount/index.js",
35438     "groupTitle": "Whatsapp_Accounts"
35439   },
35440   {
35441     "type": "get",
35442     "url": "/api/whatsapp/accounts/describe",
35443     "title": "Gets table info about Accounts",
35444     "examples": [
35445       {
35446         "title": "Example usage:",
35447         "content": "curl https://{domain}/api/whatsapp/accounts/describe -v -u {name}:{password}",
35448         "type": "json"
35449       }
35450     ],
35451     "name": "DescribeAccounts",
35452     "group": "Whatsapp_Accounts",
35453     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35454     "version": "0.0.0",
35455     "filename": "server/api/whatsappAccount/index.js",
35456     "groupTitle": "Whatsapp_Accounts"
35457   },
35458   {
35459     "type": "get",
35460     "url": "/api/whatsapp/accounts",
35461     "title": "Gets a list of Accounts",
35462     "examples": [
35463       {
35464         "title": "Example usage:",
35465         "content": "curl https://{domain}/api/whatsapp/accounts -v -u {name}:{password}",
35466         "type": "json"
35467       }
35468     ],
35469     "name": "GetAccounts",
35470     "group": "Whatsapp_Accounts",
35471     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
35472     "version": "0.0.0",
35473     "filename": "server/api/whatsappAccount/index.js",
35474     "groupTitle": "Whatsapp_Accounts"
35475   },
35476   {
35477     "type": "get",
35478     "url": "/api/whatsapp/accounts/{id}/users",
35479     "title": "Gets agents from whatsapp account",
35480     "examples": [
35481       {
35482         "title": "Example usage:",
35483         "content": "curl https://{domain}/api/whatsapp/accounts/{id}/users -v -u {name}:{password} -X GET",
35484         "type": "json"
35485       }
35486     ],
35487     "name": "GetAgents",
35488     "group": "Whatsapp_Accounts",
35489     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35490     "version": "0.0.0",
35491     "filename": "server/api/whatsappAccount/index.js",
35492     "groupTitle": "Whatsapp_Accounts"
35493   },
35494   {
35495     "type": "delete",
35496     "url": "/api/whatsapp/accounts/{id}/users",
35497     "title": "Removes agents from a whatsapp account",
35498     "examples": [
35499       {
35500         "title": "Example usage:",
35501         "content": "curl https://{domain}/api/whatsapp/accounts/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
35502         "type": "json"
35503       }
35504     ],
35505     "name": "RemoveAgents",
35506     "group": "Whatsapp_Accounts",
35507     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35508     "version": "0.0.0",
35509     "filename": "server/api/whatsappAccount/index.js",
35510     "groupTitle": "Whatsapp_Accounts"
35511   },
35512   {
35513     "type": "delete",
35514     "url": "/api/whatsapp/accounts/{id}/canned_answers",
35515     "title": "Removes canned answers from account",
35516     "examples": [
35517       {
35518         "title": "Example usage:",
35519         "content": "curl https://{domain}/api/whatsapp/accounts/{id}/canned_answers?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
35520         "type": "json"
35521       }
35522     ],
35523     "name": "RemoveAnswers",
35524     "group": "Whatsapp_Accounts",
35525     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35526     "version": "0.0.0",
35527     "filename": "server/api/whatsappAccount/index.js",
35528     "groupTitle": "Whatsapp_Accounts"
35529   },
35530   {
35531     "type": "delete",
35532     "url": "/api/whatsapp/accounts/{id}/dispositions",
35533     "title": "Removes dispositions from account",
35534     "examples": [
35535       {
35536         "title": "Example usage:",
35537         "content": "curl https://{domain}/api/whatsapp/accounts/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
35538         "type": "json"
35539       }
35540     ],
35541     "name": "RemoveDispositions",
35542     "group": "Whatsapp_Accounts",
35543     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35544     "version": "0.0.0",
35545     "filename": "server/api/whatsappAccount/index.js",
35546     "groupTitle": "Whatsapp_Accounts"
35547   },
35548   {
35549     "type": "get",
35550     "url": "/api/whatsapp/accounts/{id}",
35551     "title": "Gets a single Account",
35552     "examples": [
35553       {
35554         "title": "Example usage:",
35555         "content": "curl https://{domain}/api/whatsapp/accounts/{id} -v -u {name}:{password}",
35556         "type": "json"
35557       }
35558     ],
35559     "name": "ShowAccounts",
35560     "group": "Whatsapp_Accounts",
35561     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35562     "version": "0.0.0",
35563     "filename": "server/api/whatsappAccount/index.js",
35564     "groupTitle": "Whatsapp_Accounts"
35565   },
35566   {
35567     "type": "put",
35568     "url": "/api/whatsapp/messages/{id}/accept",
35569     "title": "Accepts message",
35570     "examples": [
35571       {
35572         "title": "Example usage:",
35573         "content": "curl https://{domain}/api/whatsapp/messages/{id}/accept \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
35574         "type": "json"
35575       }
35576     ],
35577     "name": "acceptMessage",
35578     "group": "Whatsapp_Accounts",
35579     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35580     "version": "0.0.0",
35581     "filename": "server/api/whatsappMessage/index.js",
35582     "groupTitle": "Whatsapp_Accounts"
35583   },
35584   {
35585     "type": "post",
35586     "url": "/api/whatsapp/accounts/{id}/canned_answers",
35587     "title": "Creates new canned answer",
35588     "examples": [
35589       {
35590         "title": "Example usage:",
35591         "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",
35592         "type": "json"
35593       }
35594     ],
35595     "name": "addAnswer",
35596     "group": "Whatsapp_Accounts",
35597     "parameter": {
35598       "fields": {
35599         "Body": [
35600           {
35601             "group": "Body",
35602             "type": "String",
35603             "optional": false,
35604             "field": "key",
35605             "description": ""
35606           },
35607           {
35608             "group": "Body",
35609             "type": "Text",
35610             "optional": false,
35611             "field": "value",
35612             "description": ""
35613           },
35614           {
35615             "group": "Body",
35616             "type": "String",
35617             "optional": true,
35618             "field": "description",
35619             "description": ""
35620           },
35621           {
35622             "group": "Body",
35623             "type": "Virtual",
35624             "optional": true,
35625             "field": "name",
35626             "description": ""
35627           }
35628         ]
35629       }
35630     },
35631     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35632     "version": "0.0.0",
35633     "filename": "server/api/whatsappAccount/index.js",
35634     "groupTitle": "Whatsapp_Accounts"
35635   },
35636   {
35637     "type": "post",
35638     "url": "/api/whatsapp/accounts/{id}/applications",
35639     "title": "Creates new applications",
35640     "examples": [
35641       {
35642         "title": "Example usage:",
35643         "content": "curl https://{domain}/api/whatsapp/accounts/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
35644         "type": "json"
35645       }
35646     ],
35647     "name": "addApplications",
35648     "group": "Whatsapp_Accounts",
35649     "parameter": {
35650       "fields": {
35651         "Body": [
35652           {
35653             "group": "Body",
35654             "type": "Integer",
35655             "optional": false,
35656             "field": "priority",
35657             "description": ""
35658           },
35659           {
35660             "group": "Body",
35661             "type": "String",
35662             "optional": false,
35663             "field": "app",
35664             "description": ""
35665           },
35666           {
35667             "group": "Body",
35668             "type": "Text",
35669             "optional": true,
35670             "field": "appdata",
35671             "description": ""
35672           },
35673           {
35674             "group": "Body",
35675             "type": "String",
35676             "optional": true,
35677             "field": "description",
35678             "description": ""
35679           },
35680           {
35681             "group": "Body",
35682             "type": "String",
35683             "optional": true,
35684             "field": "interval",
35685             "description": ""
35686           }
35687         ]
35688       }
35689     },
35690     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35691     "version": "0.0.0",
35692     "filename": "server/api/whatsappAccount/index.js",
35693     "groupTitle": "Whatsapp_Accounts"
35694   },
35695   {
35696     "type": "post",
35697     "url": "/api/whatsapp/accounts/{id}/dispositions",
35698     "title": "Creates new disposition",
35699     "examples": [
35700       {
35701         "title": "Example usage:",
35702         "content": "curl https://{domain}/api/whatsapp/accounts/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
35703         "type": "json"
35704       }
35705     ],
35706     "name": "addDisposition",
35707     "group": "Whatsapp_Accounts",
35708     "parameter": {
35709       "fields": {
35710         "Body": [
35711           {
35712             "group": "Body",
35713             "type": "String",
35714             "optional": false,
35715             "field": "name",
35716             "description": ""
35717           }
35718         ]
35719       }
35720     },
35721     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35722     "version": "0.0.0",
35723     "filename": "server/api/whatsappAccount/index.js",
35724     "groupTitle": "Whatsapp_Accounts"
35725   },
35726   {
35727     "type": "get",
35728     "url": "/api/whatsapp/accounts/{id}/canned_answers",
35729     "title": "Gets account canned answers",
35730     "examples": [
35731       {
35732         "title": "Example usage:",
35733         "content": "curl https://{domain}/api/whatsapp/accounts/{id}/canned_answers -v -u {name}:{password} -X GET",
35734         "type": "json"
35735       }
35736     ],
35737     "name": "getAnswers",
35738     "group": "Whatsapp_Accounts",
35739     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35740     "version": "0.0.0",
35741     "filename": "server/api/whatsappAccount/index.js",
35742     "groupTitle": "Whatsapp_Accounts"
35743   },
35744   {
35745     "type": "get",
35746     "url": "/api/whatsapp/accounts/{id}/applications",
35747     "title": "Gets account applications",
35748     "examples": [
35749       {
35750         "title": "Example usage:",
35751         "content": "curl https://{domain}/api/whatsapp/accounts/{id}/applications -v -u {name}:{password} -X GET",
35752         "type": "json"
35753       }
35754     ],
35755     "name": "getApplications",
35756     "group": "Whatsapp_Accounts",
35757     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35758     "version": "0.0.0",
35759     "filename": "server/api/whatsappAccount/index.js",
35760     "groupTitle": "Whatsapp_Accounts"
35761   },
35762   {
35763     "type": "get",
35764     "url": "/api/whatsapp/accounts/{id}/dispositions",
35765     "title": "Gets account dispositions",
35766     "examples": [
35767       {
35768         "title": "Example usage:",
35769         "content": "curl https://{domain}/api/whatsapp/accounts/{id}/dispositions -v -u {name}:{password} -X GET",
35770         "type": "json"
35771       }
35772     ],
35773     "name": "getDispositions",
35774     "group": "Whatsapp_Accounts",
35775     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35776     "version": "0.0.0",
35777     "filename": "server/api/whatsappAccount/index.js",
35778     "groupTitle": "Whatsapp_Accounts"
35779   },
35780   {
35781     "type": "post",
35782     "url": "/api/whatsapp/accounts/{id}/notify",
35783     "title": "Notify new message",
35784     "examples": [
35785       {
35786         "title": "Example usage:",
35787         "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",
35788         "type": "json"
35789       }
35790     ],
35791     "name": "notify",
35792     "group": "Whatsapp_Accounts",
35793     "description": "<p>Motion 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>",
35794     "version": "0.0.0",
35795     "filename": "server/api/whatsappAccount/index.js",
35796     "groupTitle": "Whatsapp_Accounts"
35797   },
35798   {
35799     "type": "put",
35800     "url": "/api/whatsapp/messages/{id}/reject",
35801     "title": "Rejects message",
35802     "examples": [
35803       {
35804         "title": "Example usage:",
35805         "content": "curl https://{domain}/api/whatsapp/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
35806         "type": "json"
35807       }
35808     ],
35809     "name": "rejectMessage",
35810     "group": "Whatsapp_Accounts",
35811     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35812     "version": "0.0.0",
35813     "filename": "server/api/whatsappMessage/index.js",
35814     "groupTitle": "Whatsapp_Accounts"
35815   },
35816   {
35817     "type": "post",
35818     "url": "/api/whatsapp/accounts/{id}/send",
35819     "title": "Send new whatsapp message",
35820     "examples": [
35821       {
35822         "title": "Example usage:",
35823         "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",
35824         "type": "json"
35825       }
35826     ],
35827     "name": "sendWhatsapp",
35828     "group": "Whatsapp_Accounts",
35829     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35830     "version": "0.0.0",
35831     "filename": "server/api/whatsappAccount/index.js",
35832     "groupTitle": "Whatsapp_Accounts"
35833   },
35834   {
35835     "type": "post",
35836     "url": "/api/whatsapp/messages/{id}/status",
35837     "title": "Receive message status",
35838     "examples": [
35839       {
35840         "title": "Example usage:",
35841         "content": "curl https://{domain}/api/whatsapp/messages/{id}/status \\ \n -H 'Content-Type: application/json' -v -X POST",
35842         "type": "json"
35843       }
35844     ],
35845     "name": "statusMessage",
35846     "group": "Whatsapp_Accounts",
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/whatsappMessage/index.js",
35850     "groupTitle": "Whatsapp_Accounts"
35851   },
35852   {
35853     "type": "put",
35854     "url": "/api/whatsapp/accounts/{id}",
35855     "title": "Update an existing Account",
35856     "examples": [
35857       {
35858         "title": "Example usage:",
35859         "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",
35860         "type": "json"
35861       }
35862     ],
35863     "name": "updateAccounts",
35864     "group": "Whatsapp_Accounts",
35865     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <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/whatsappAccount/index.js",
35868     "groupTitle": "Whatsapp_Accounts"
35869   },
35870   {
35871     "type": "post",
35872     "url": "/api/whatsapp/applications",
35873     "title": "Creates a new Application",
35874     "examples": [
35875       {
35876         "title": "Example usage:",
35877         "content": "curl https://{domain}/api/whatsapp/applications -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
35878         "type": "json"
35879       }
35880     ],
35881     "name": "CreateApplications",
35882     "group": "Whatsapp_Applications",
35883     "parameter": {
35884       "fields": {
35885         "Body": [
35886           {
35887             "group": "Body",
35888             "type": "Integer",
35889             "optional": false,
35890             "field": "priority",
35891             "description": ""
35892           },
35893           {
35894             "group": "Body",
35895             "type": "String",
35896             "optional": false,
35897             "field": "app",
35898             "description": ""
35899           },
35900           {
35901             "group": "Body",
35902             "type": "Text",
35903             "optional": true,
35904             "field": "appdata",
35905             "description": ""
35906           },
35907           {
35908             "group": "Body",
35909             "type": "String",
35910             "optional": true,
35911             "field": "description",
35912             "description": ""
35913           },
35914           {
35915             "group": "Body",
35916             "type": "String",
35917             "optional": true,
35918             "field": "interval",
35919             "description": ""
35920           }
35921         ]
35922       }
35923     },
35924     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35925     "version": "0.0.0",
35926     "filename": "server/api/whatsappApplication/index.js",
35927     "groupTitle": "Whatsapp_Applications"
35928   },
35929   {
35930     "type": "delete",
35931     "url": "/api/whatsapp/applications/{id}",
35932     "title": "Deletes a Application",
35933     "examples": [
35934       {
35935         "title": "Example usage:",
35936         "content": "curl https://{domain}/api/whatsapp/applications/{id} -v -u {name}:{password} -X DELETE",
35937         "type": "json"
35938       }
35939     ],
35940     "name": "DeleteApplications",
35941     "group": "Whatsapp_Applications",
35942     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35943     "version": "0.0.0",
35944     "filename": "server/api/whatsappApplication/index.js",
35945     "groupTitle": "Whatsapp_Applications"
35946   },
35947   {
35948     "type": "get",
35949     "url": "/api/whatsapp/applications",
35950     "title": "Gets a list of Applications",
35951     "examples": [
35952       {
35953         "title": "Example usage:",
35954         "content": "curl https://{domain}/api/whatsapp/applications -v -u {name}:{password}",
35955         "type": "json"
35956       }
35957     ],
35958     "name": "GetApplications",
35959     "group": "Whatsapp_Applications",
35960     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
35961     "version": "0.0.0",
35962     "filename": "server/api/whatsappApplication/index.js",
35963     "groupTitle": "Whatsapp_Applications"
35964   },
35965   {
35966     "type": "get",
35967     "url": "/api/whatsapp/applications/{id}",
35968     "title": "Gets a single Application",
35969     "examples": [
35970       {
35971         "title": "Example usage:",
35972         "content": "curl https://{domain}/api/whatsapp/applications/{id} -v -u {name}:{password}",
35973         "type": "json"
35974       }
35975     ],
35976     "name": "ShowApplications",
35977     "group": "Whatsapp_Applications",
35978     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35979     "version": "0.0.0",
35980     "filename": "server/api/whatsappApplication/index.js",
35981     "groupTitle": "Whatsapp_Applications"
35982   },
35983   {
35984     "type": "put",
35985     "url": "/api/whatsapp/applications/{id}",
35986     "title": "Update an existing Application",
35987     "examples": [
35988       {
35989         "title": "Example usage:",
35990         "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",
35991         "type": "json"
35992       }
35993     ],
35994     "name": "updateApplications",
35995     "group": "Whatsapp_Applications",
35996     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35997     "version": "0.0.0",
35998     "filename": "server/api/whatsappApplication/index.js",
35999     "groupTitle": "Whatsapp_Applications"
36000   },
36001   {
36002     "type": "post",
36003     "url": "/api/whatsapp/interactions/{id}/tags",
36004     "title": "Add tags to the interaction",
36005     "examples": [
36006       {
36007         "title": "Example usage:",
36008         "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",
36009         "type": "json"
36010       }
36011     ],
36012     "name": "AddTags",
36013     "group": "Whatsapp_Interactions",
36014     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36015     "version": "0.0.0",
36016     "filename": "server/api/whatsappInteraction/index.js",
36017     "groupTitle": "Whatsapp_Interactions"
36018   },
36019   {
36020     "type": "post",
36021     "url": "/api/whatsapp/interactions",
36022     "title": "Creates a new Interaction",
36023     "examples": [
36024       {
36025         "title": "Example usage:",
36026         "content": "curl https://{domain}/api/whatsapp/interactions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
36027         "type": "json"
36028       }
36029     ],
36030     "name": "CreateInteractions",
36031     "group": "Whatsapp_Interactions",
36032     "parameter": {
36033       "fields": {
36034         "Body": [
36035           {
36036             "group": "Body",
36037             "type": "Boolean",
36038             "optional": true,
36039             "field": "closed",
36040             "description": ""
36041           },
36042           {
36043             "group": "Body",
36044             "type": "String",
36045             "optional": true,
36046             "field": "closedAt",
36047             "description": ""
36048           },
36049           {
36050             "group": "Body",
36051             "type": "String",
36052             "optional": true,
36053             "field": "disposition",
36054             "description": ""
36055           },
36056           {
36057             "group": "Body",
36058             "type": "String",
36059             "optional": true,
36060             "field": "note",
36061             "description": ""
36062           },
36063           {
36064             "group": "Body",
36065             "type": "String",
36066             "optional": true,
36067             "field": "phone",
36068             "description": ""
36069           },
36070           {
36071             "group": "Body",
36072             "type": "String",
36073             "optional": true,
36074             "field": "read1stAt",
36075             "description": ""
36076           },
36077           {
36078             "group": "Body",
36079             "type": "String",
36080             "allowedValues": [
36081               "\"in\"",
36082               "\"out\""
36083             ],
36084             "optional": false,
36085             "field": "firstMsgDirection",
36086             "description": ""
36087           },
36088           {
36089             "group": "Body",
36090             "type": "String",
36091             "optional": true,
36092             "field": "lastMsgAt",
36093             "description": ""
36094           },
36095           {
36096             "group": "Body",
36097             "type": "String",
36098             "allowedValues": [
36099               "\"in\"",
36100               "\"out\""
36101             ],
36102             "optional": false,
36103             "field": "lastMsgDirection",
36104             "description": ""
36105           }
36106         ]
36107       }
36108     },
36109     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36110     "version": "0.0.0",
36111     "filename": "server/api/whatsappInteraction/index.js",
36112     "groupTitle": "Whatsapp_Interactions"
36113   },
36114   {
36115     "type": "delete",
36116     "url": "/api/whatsapp/interactions/{id}",
36117     "title": "Deletes a Interaction",
36118     "examples": [
36119       {
36120         "title": "Example usage:",
36121         "content": "curl https://{domain}/api/whatsapp/interactions/{id} -v -u {name}:{password} -X DELETE",
36122         "type": "json"
36123       }
36124     ],
36125     "name": "DeleteInteractions",
36126     "group": "Whatsapp_Interactions",
36127     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36128     "version": "0.0.0",
36129     "filename": "server/api/whatsappInteraction/index.js",
36130     "groupTitle": "Whatsapp_Interactions"
36131   },
36132   {
36133     "type": "get",
36134     "url": "/api/whatsapp/interactions/describe",
36135     "title": "Gets table info about Interactions",
36136     "examples": [
36137       {
36138         "title": "Example usage:",
36139         "content": "curl https://{domain}/api/whatsapp/interactions/describe -v -u {name}:{password}",
36140         "type": "json"
36141       }
36142     ],
36143     "name": "DescribeInteractions",
36144     "group": "Whatsapp_Interactions",
36145     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36146     "version": "0.0.0",
36147     "filename": "server/api/whatsappInteraction/index.js",
36148     "groupTitle": "Whatsapp_Interactions"
36149   },
36150   {
36151     "type": "get",
36152     "url": "/api/whatsapp/interactions",
36153     "title": "Gets a list of Interactions",
36154     "examples": [
36155       {
36156         "title": "Example usage:",
36157         "content": "curl https://{domain}/api/whatsapp/interactions -v -u {name}:{password}",
36158         "type": "json"
36159       }
36160     ],
36161     "name": "GetInteractions",
36162     "group": "Whatsapp_Interactions",
36163     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/whatsapp/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>",
36164     "version": "0.0.0",
36165     "filename": "server/api/whatsappInteraction/index.js",
36166     "groupTitle": "Whatsapp_Interactions"
36167   },
36168   {
36169     "type": "delete",
36170     "url": "/api/whatsapp/interactions/{id}/tags",
36171     "title": "Removes tags from interaction",
36172     "examples": [
36173       {
36174         "title": "Example usage:",
36175         "content": "curl https://{domain}/api/whatsapp/interactions/{id}/tags?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
36176         "type": "json"
36177       }
36178     ],
36179     "name": "RemoveTags",
36180     "group": "Whatsapp_Interactions",
36181     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36182     "version": "0.0.0",
36183     "filename": "server/api/whatsappInteraction/index.js",
36184     "groupTitle": "Whatsapp_Interactions"
36185   },
36186   {
36187     "type": "get",
36188     "url": "/api/whatsapp/interactions/{id}",
36189     "title": "Gets a single Interaction",
36190     "examples": [
36191       {
36192         "title": "Example usage:",
36193         "content": "curl https://{domain}/api/whatsapp/interactions/{id} -v -u {name}:{password}",
36194         "type": "json"
36195       }
36196     ],
36197     "name": "ShowInteractions",
36198     "group": "Whatsapp_Interactions",
36199     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36200     "version": "0.0.0",
36201     "filename": "server/api/whatsappInteraction/index.js",
36202     "groupTitle": "Whatsapp_Interactions"
36203   },
36204   {
36205     "type": "post",
36206     "url": "/api/whatsapp/interactions/{id}/messages",
36207     "title": "Creates new messages",
36208     "examples": [
36209       {
36210         "title": "Example usage:",
36211         "content": "curl https://{domain}/api/whatsapp/interactions/{id}/messages -d '[{\"to\": \"+3901119886500\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
36212         "type": "json"
36213       }
36214     ],
36215     "name": "addMessage",
36216     "group": "Whatsapp_Interactions",
36217     "parameter": {
36218       "fields": {
36219         "Body": [
36220           {
36221             "group": "Body",
36222             "type": "Text",
36223             "optional": false,
36224             "field": "body",
36225             "description": ""
36226           },
36227           {
36228             "group": "Body",
36229             "type": "Boolean",
36230             "optional": true,
36231             "field": "read",
36232             "description": ""
36233           },
36234           {
36235             "group": "Body",
36236             "type": "String",
36237             "allowedValues": [
36238               "\"in\"",
36239               "\"out\""
36240             ],
36241             "optional": false,
36242             "field": "direction",
36243             "description": ""
36244           },
36245           {
36246             "group": "Body",
36247             "type": "String",
36248             "optional": true,
36249             "field": "messageId",
36250             "description": ""
36251           },
36252           {
36253             "group": "Body",
36254             "type": "String",
36255             "optional": true,
36256             "field": "phone",
36257             "description": ""
36258           },
36259           {
36260             "group": "Body",
36261             "type": "String",
36262             "optional": true,
36263             "field": "readAt",
36264             "description": ""
36265           },
36266           {
36267             "group": "Body",
36268             "type": "Boolean",
36269             "optional": true,
36270             "field": "secret",
36271             "description": ""
36272           }
36273         ]
36274       }
36275     },
36276     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36277     "version": "0.0.0",
36278     "filename": "server/api/whatsappInteraction/index.js",
36279     "groupTitle": "Whatsapp_Interactions"
36280   },
36281   {
36282     "type": "get",
36283     "url": "/api/whatsapp/interactions/{id}/download",
36284     "title": "Gets interaction",
36285     "examples": [
36286       {
36287         "title": "Example usage:",
36288         "content": "curl https://{domain}/api/whatsapp/interactions/{id}/download -v -u {name}:{password} -X GET",
36289         "type": "json"
36290       }
36291     ],
36292     "name": "download",
36293     "group": "Whatsapp_Interactions",
36294     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36295     "version": "0.0.0",
36296     "filename": "server/api/whatsappInteraction/index.js",
36297     "groupTitle": "Whatsapp_Interactions"
36298   },
36299   {
36300     "type": "get",
36301     "url": "/api/whatsapp/interactions/{id}/messages",
36302     "title": "Gets interaction messages",
36303     "examples": [
36304       {
36305         "title": "Example usage:",
36306         "content": "curl https://{domain}/api/whatsapp/interactions/{id}/messages -v -u {name}:{password} -X GET",
36307         "type": "json"
36308       }
36309     ],
36310     "name": "getMessages",
36311     "group": "Whatsapp_Interactions",
36312     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36313     "version": "0.0.0",
36314     "filename": "server/api/whatsappInteraction/index.js",
36315     "groupTitle": "Whatsapp_Interactions"
36316   },
36317   {
36318     "type": "put",
36319     "url": "/api/whatsapp/interactions/{id}",
36320     "title": "Update an existing Interaction",
36321     "examples": [
36322       {
36323         "title": "Example usage:",
36324         "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",
36325         "type": "json"
36326       }
36327     ],
36328     "name": "updateInteractions",
36329     "group": "Whatsapp_Interactions",
36330     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36331     "version": "0.0.0",
36332     "filename": "server/api/whatsappInteraction/index.js",
36333     "groupTitle": "Whatsapp_Interactions"
36334   },
36335   {
36336     "type": "post",
36337     "url": "/api/whatsapp/messages",
36338     "title": "Creates a new Message",
36339     "examples": [
36340       {
36341         "title": "Example usage:",
36342         "content": "curl https://{domain}/api/whatsapp/messages -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
36343         "type": "json"
36344       }
36345     ],
36346     "name": "CreateMessages",
36347     "group": "Whatsapp_Messages",
36348     "parameter": {
36349       "fields": {
36350         "Body": [
36351           {
36352             "group": "Body",
36353             "type": "Text",
36354             "optional": false,
36355             "field": "body",
36356             "description": ""
36357           },
36358           {
36359             "group": "Body",
36360             "type": "Boolean",
36361             "optional": true,
36362             "field": "read",
36363             "description": ""
36364           },
36365           {
36366             "group": "Body",
36367             "type": "String",
36368             "allowedValues": [
36369               "\"in\"",
36370               "\"out\""
36371             ],
36372             "optional": false,
36373             "field": "direction",
36374             "description": ""
36375           },
36376           {
36377             "group": "Body",
36378             "type": "String",
36379             "optional": true,
36380             "field": "messageId",
36381             "description": ""
36382           },
36383           {
36384             "group": "Body",
36385             "type": "String",
36386             "optional": true,
36387             "field": "phone",
36388             "description": ""
36389           },
36390           {
36391             "group": "Body",
36392             "type": "String",
36393             "optional": true,
36394             "field": "readAt",
36395             "description": ""
36396           },
36397           {
36398             "group": "Body",
36399             "type": "Boolean",
36400             "optional": true,
36401             "field": "secret",
36402             "description": ""
36403           }
36404         ]
36405       }
36406     },
36407     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36408     "version": "0.0.0",
36409     "filename": "server/api/whatsappMessage/index.js",
36410     "groupTitle": "Whatsapp_Messages"
36411   },
36412   {
36413     "type": "delete",
36414     "url": "/api/whatsapp/messages/{id}",
36415     "title": "Deletes a Message",
36416     "examples": [
36417       {
36418         "title": "Example usage:",
36419         "content": "curl https://{domain}/api/whatsapp/messages/{id} -v -u {name}:{password} -X DELETE",
36420         "type": "json"
36421       }
36422     ],
36423     "name": "DeleteMessages",
36424     "group": "Whatsapp_Messages",
36425     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36426     "version": "0.0.0",
36427     "filename": "server/api/whatsappMessage/index.js",
36428     "groupTitle": "Whatsapp_Messages"
36429   },
36430   {
36431     "type": "get",
36432     "url": "/api/whatsapp/messages/describe",
36433     "title": "Gets table info about Messages",
36434     "examples": [
36435       {
36436         "title": "Example usage:",
36437         "content": "curl https://{domain}/api/whatsapp/messages/describe -v -u {name}:{password}",
36438         "type": "json"
36439       }
36440     ],
36441     "name": "DescribeMessages",
36442     "group": "Whatsapp_Messages",
36443     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36444     "version": "0.0.0",
36445     "filename": "server/api/whatsappMessage/index.js",
36446     "groupTitle": "Whatsapp_Messages"
36447   },
36448   {
36449     "type": "get",
36450     "url": "/api/whatsapp/messages",
36451     "title": "Gets a list of Messages",
36452     "examples": [
36453       {
36454         "title": "Example usage:",
36455         "content": "curl https://{domain}/api/whatsapp/messages -v -u {name}:{password}",
36456         "type": "json"
36457       }
36458     ],
36459     "name": "GetMessages",
36460     "group": "Whatsapp_Messages",
36461     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
36462     "version": "0.0.0",
36463     "filename": "server/api/whatsappMessage/index.js",
36464     "groupTitle": "Whatsapp_Messages"
36465   },
36466   {
36467     "type": "get",
36468     "url": "/api/whatsapp/messages/{id}",
36469     "title": "Gets a single Message",
36470     "examples": [
36471       {
36472         "title": "Example usage:",
36473         "content": "curl https://{domain}/api/whatsapp/messages/{id} -v -u {name}:{password}",
36474         "type": "json"
36475       }
36476     ],
36477     "name": "ShowMessages",
36478     "group": "Whatsapp_Messages",
36479     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36480     "version": "0.0.0",
36481     "filename": "server/api/whatsappMessage/index.js",
36482     "groupTitle": "Whatsapp_Messages"
36483   },
36484   {
36485     "type": "put",
36486     "url": "/api/whatsapp/messages/{id}",
36487     "title": "Update an existing Message",
36488     "examples": [
36489       {
36490         "title": "Example usage:",
36491         "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",
36492         "type": "json"
36493       }
36494     ],
36495     "name": "updateMessages",
36496     "group": "Whatsapp_Messages",
36497     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36498     "version": "0.0.0",
36499     "filename": "server/api/whatsappMessage/index.js",
36500     "groupTitle": "Whatsapp_Messages"
36501   },
36502   {
36503     "type": "post",
36504     "url": "/api/whatsapp/reports/queue",
36505     "title": "Creates a new Whatsapp Queue Report",
36506     "examples": [
36507       {
36508         "title": "Example usage:",
36509         "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",
36510         "type": "json"
36511       }
36512     ],
36513     "name": "CreateWhatsapp_Queue_Reports",
36514     "group": "Whatsapp_Queue_Reports",
36515     "parameter": {
36516       "fields": {
36517         "Body": [
36518           {
36519             "group": "Body",
36520             "type": "String",
36521             "optional": false,
36522             "field": "uniqueid",
36523             "description": ""
36524           },
36525           {
36526             "group": "Body",
36527             "type": "String",
36528             "optional": true,
36529             "field": "from",
36530             "description": ""
36531           },
36532           {
36533             "group": "Body",
36534             "type": "String",
36535             "optional": true,
36536             "field": "joinAt",
36537             "description": ""
36538           },
36539           {
36540             "group": "Body",
36541             "type": "String",
36542             "optional": true,
36543             "field": "leaveAt",
36544             "description": ""
36545           },
36546           {
36547             "group": "Body",
36548             "type": "String",
36549             "optional": true,
36550             "field": "acceptAt",
36551             "description": ""
36552           },
36553           {
36554             "group": "Body",
36555             "type": "String",
36556             "optional": true,
36557             "field": "exitAt",
36558             "description": ""
36559           },
36560           {
36561             "group": "Body",
36562             "type": "String",
36563             "optional": true,
36564             "field": "reason",
36565             "description": ""
36566           }
36567         ]
36568       }
36569     },
36570     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36571     "version": "0.0.0",
36572     "filename": "server/api/whatsappQueueReport/index.js",
36573     "groupTitle": "Whatsapp_Queue_Reports"
36574   },
36575   {
36576     "type": "delete",
36577     "url": "/api/whatsapp/reports/queue/{id}",
36578     "title": "Deletes a Whatsapp Queue Report",
36579     "examples": [
36580       {
36581         "title": "Example usage:",
36582         "content": "curl https://{domain}/api/whatsapp/reports/queue/{id} -v -u {name}:{password} -X DELETE",
36583         "type": "json"
36584       }
36585     ],
36586     "name": "DeleteWhatsapp_Queue_Reports",
36587     "group": "Whatsapp_Queue_Reports",
36588     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36589     "version": "0.0.0",
36590     "filename": "server/api/whatsappQueueReport/index.js",
36591     "groupTitle": "Whatsapp_Queue_Reports"
36592   },
36593   {
36594     "type": "get",
36595     "url": "/api/whatsapp/reports/queue/describe",
36596     "title": "Gets table info about Whatsapp Queue Reports",
36597     "examples": [
36598       {
36599         "title": "Example usage:",
36600         "content": "curl https://{domain}/api/whatsapp/reports/queue/describe -v -u {name}:{password}",
36601         "type": "json"
36602       }
36603     ],
36604     "name": "DescribeWhatsapp_Queue_Reports",
36605     "group": "Whatsapp_Queue_Reports",
36606     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36607     "version": "0.0.0",
36608     "filename": "server/api/whatsappQueueReport/index.js",
36609     "groupTitle": "Whatsapp_Queue_Reports"
36610   },
36611   {
36612     "type": "get",
36613     "url": "/api/whatsapp/reports/queue",
36614     "title": "Gets a list of Whatsapp Queue Reports",
36615     "examples": [
36616       {
36617         "title": "Example usage:",
36618         "content": "curl https://{domain}/api/whatsapp/reports/queue -v -u {name}:{password}",
36619         "type": "json"
36620       }
36621     ],
36622     "name": "GetWhatsapp_Queue_Reports",
36623     "group": "Whatsapp_Queue_Reports",
36624     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
36625     "version": "0.0.0",
36626     "filename": "server/api/whatsappQueueReport/index.js",
36627     "groupTitle": "Whatsapp_Queue_Reports"
36628   },
36629   {
36630     "type": "get",
36631     "url": "/api/whatsapp/reports/queue/{id}",
36632     "title": "Gets a single Whatsapp Queue Report",
36633     "examples": [
36634       {
36635         "title": "Example usage:",
36636         "content": "curl https://{domain}/api/whatsapp/reports/queue/{id} -v -u {name}:{password}",
36637         "type": "json"
36638       }
36639     ],
36640     "name": "ShowWhatsapp_Queue_Reports",
36641     "group": "Whatsapp_Queue_Reports",
36642     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36643     "version": "0.0.0",
36644     "filename": "server/api/whatsappQueueReport/index.js",
36645     "groupTitle": "Whatsapp_Queue_Reports"
36646   },
36647   {
36648     "type": "put",
36649     "url": "/api/whatsapp/reports/queue/{id}",
36650     "title": "Update an existing Whatsapp Queue Report",
36651     "examples": [
36652       {
36653         "title": "Example usage:",
36654         "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",
36655         "type": "json"
36656       }
36657     ],
36658     "name": "updateWhatsapp_Queue_Reports",
36659     "group": "Whatsapp_Queue_Reports",
36660     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36661     "version": "0.0.0",
36662     "filename": "server/api/whatsappQueueReport/index.js",
36663     "groupTitle": "Whatsapp_Queue_Reports"
36664   },
36665   {
36666     "type": "post",
36667     "url": "/api/whatsapp/queues/{id}/users",
36668     "title": "Add agents to a queue",
36669     "examples": [
36670       {
36671         "title": "Example usage:",
36672         "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",
36673         "type": "json"
36674       }
36675     ],
36676     "name": "AddAgents",
36677     "group": "Whatsapp_Queues",
36678     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36679     "version": "0.0.0",
36680     "filename": "server/api/whatsappQueue/index.js",
36681     "groupTitle": "Whatsapp_Queues"
36682   },
36683   {
36684     "type": "post",
36685     "url": "/api/whatsapp/queues/{id}/teams",
36686     "title": "Add teams to a queue",
36687     "examples": [
36688       {
36689         "title": "Example usage:",
36690         "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",
36691         "type": "json"
36692       }
36693     ],
36694     "name": "AddTeams",
36695     "group": "Whatsapp_Queues",
36696     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36697     "version": "0.0.0",
36698     "filename": "server/api/whatsappQueue/index.js",
36699     "groupTitle": "Whatsapp_Queues"
36700   },
36701   {
36702     "type": "post",
36703     "url": "/api/whatsapp/queues",
36704     "title": "Creates a new Queue",
36705     "examples": [
36706       {
36707         "title": "Example usage:",
36708         "content": "curl https://{domain}/api/whatsapp/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
36709         "type": "json"
36710       }
36711     ],
36712     "name": "CreateQueues",
36713     "group": "Whatsapp_Queues",
36714     "parameter": {
36715       "fields": {
36716         "Body": [
36717           {
36718             "group": "Body",
36719             "type": "String",
36720             "optional": true,
36721             "field": "name",
36722             "description": ""
36723           },
36724           {
36725             "group": "Body",
36726             "type": "Integer",
36727             "optional": true,
36728             "field": "timeout",
36729             "description": ""
36730           },
36731           {
36732             "group": "Body",
36733             "type": "String",
36734             "allowedValues": [
36735               "\"rrmemory\"",
36736               "\"beepall\"",
36737               "\"roundrobin\""
36738             ],
36739             "optional": true,
36740             "field": "strategy",
36741             "description": ""
36742           },
36743           {
36744             "group": "Body",
36745             "type": "String",
36746             "optional": true,
36747             "field": "description",
36748             "description": ""
36749           }
36750         ]
36751       }
36752     },
36753     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36754     "version": "0.0.0",
36755     "filename": "server/api/whatsappQueue/index.js",
36756     "groupTitle": "Whatsapp_Queues"
36757   },
36758   {
36759     "type": "delete",
36760     "url": "/api/whatsapp/queues/{id}",
36761     "title": "Deletes a Queue",
36762     "examples": [
36763       {
36764         "title": "Example usage:",
36765         "content": "curl https://{domain}/api/whatsapp/queues/{id} -v -u {name}:{password} -X DELETE",
36766         "type": "json"
36767       }
36768     ],
36769     "name": "DeleteQueues",
36770     "group": "Whatsapp_Queues",
36771     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36772     "version": "0.0.0",
36773     "filename": "server/api/whatsappQueue/index.js",
36774     "groupTitle": "Whatsapp_Queues"
36775   },
36776   {
36777     "type": "get",
36778     "url": "/api/whatsapp/queues/describe",
36779     "title": "Gets table info about Queues",
36780     "examples": [
36781       {
36782         "title": "Example usage:",
36783         "content": "curl https://{domain}/api/whatsapp/queues/describe -v -u {name}:{password}",
36784         "type": "json"
36785       }
36786     ],
36787     "name": "DescribeQueues",
36788     "group": "Whatsapp_Queues",
36789     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36790     "version": "0.0.0",
36791     "filename": "server/api/whatsappQueue/index.js",
36792     "groupTitle": "Whatsapp_Queues"
36793   },
36794   {
36795     "type": "get",
36796     "url": "/api/whatsapp/queues/{id}/users",
36797     "title": "Gets queue agents",
36798     "examples": [
36799       {
36800         "title": "Example usage:",
36801         "content": "curl https://{domain}/api/whatsapp/queues/{id}/users -v -u {name}:{password} -X POST",
36802         "type": "json"
36803       }
36804     ],
36805     "name": "GetAgents",
36806     "group": "Whatsapp_Queues",
36807     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36808     "version": "0.0.0",
36809     "filename": "server/api/whatsappQueue/index.js",
36810     "groupTitle": "Whatsapp_Queues"
36811   },
36812   {
36813     "type": "get",
36814     "url": "/api/whatsapp/queues/{id}/members",
36815     "title": "GetMembers",
36816     "examples": [
36817       {
36818         "title": "Example usage:",
36819         "content": "curl https://{domain}/api/whatsapp/queues/{id}/members  -v -u {name}:{password}",
36820         "type": "json"
36821       }
36822     ],
36823     "name": "GetMembers",
36824     "group": "Whatsapp_Queues",
36825     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36826     "version": "0.0.0",
36827     "filename": "server/api/whatsappQueue/index.js",
36828     "groupTitle": "Whatsapp_Queues"
36829   },
36830   {
36831     "type": "get",
36832     "url": "/api/whatsapp/queues",
36833     "title": "Gets a list of Queues",
36834     "examples": [
36835       {
36836         "title": "Example usage:",
36837         "content": "curl https://{domain}/api/whatsapp/queues -v -u {name}:{password}",
36838         "type": "json"
36839       }
36840     ],
36841     "name": "GetQueues",
36842     "group": "Whatsapp_Queues",
36843     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
36844     "version": "0.0.0",
36845     "filename": "server/api/whatsappQueue/index.js",
36846     "groupTitle": "Whatsapp_Queues"
36847   },
36848   {
36849     "type": "get",
36850     "url": "/api/whatsapp/queues/{id}/teams",
36851     "title": "Gets queues list",
36852     "examples": [
36853       {
36854         "title": "Example usage:",
36855         "content": "curl https://{domain}/api/whatsapp/queues/{id}/teams -v -u {name}:{password}",
36856         "type": "json"
36857       }
36858     ],
36859     "name": "GetTeams",
36860     "group": "Whatsapp_Queues",
36861     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36862     "version": "0.0.0",
36863     "filename": "server/api/whatsappQueue/index.js",
36864     "groupTitle": "Whatsapp_Queues"
36865   },
36866   {
36867     "type": "delete",
36868     "url": "/api/whatsapp/queues/{id}/users",
36869     "title": "Removes agents from a queue",
36870     "examples": [
36871       {
36872         "title": "Example usage:",
36873         "content": "curl https://{domain}/api/whatsapp/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
36874         "type": "json"
36875       }
36876     ],
36877     "name": "RemoveAgents",
36878     "group": "Whatsapp_Queues",
36879     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36880     "version": "0.0.0",
36881     "filename": "server/api/whatsappQueue/index.js",
36882     "groupTitle": "Whatsapp_Queues"
36883   },
36884   {
36885     "type": "get",
36886     "url": "/api/whatsapp/queues/{id}",
36887     "title": "Gets a single Queue",
36888     "examples": [
36889       {
36890         "title": "Example usage:",
36891         "content": "curl https://{domain}/api/whatsapp/queues/{id} -v -u {name}:{password}",
36892         "type": "json"
36893       }
36894     ],
36895     "name": "ShowQueues",
36896     "group": "Whatsapp_Queues",
36897     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36898     "version": "0.0.0",
36899     "filename": "server/api/whatsappQueue/index.js",
36900     "groupTitle": "Whatsapp_Queues"
36901   },
36902   {
36903     "type": "put",
36904     "url": "/api/whatsapp/queues/{id}",
36905     "title": "Update an existing Queue",
36906     "examples": [
36907       {
36908         "title": "Example usage:",
36909         "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",
36910         "type": "json"
36911       }
36912     ],
36913     "name": "updateQueues",
36914     "group": "Whatsapp_Queues",
36915     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36916     "version": "0.0.0",
36917     "filename": "server/api/whatsappQueue/index.js",
36918     "groupTitle": "Whatsapp_Queues"
36919   },
36920   {
36921     "type": "post",
36922     "url": "/api/whatsapp/reports/transfer",
36923     "title": "Creates a new Whatsapp Transfer Report",
36924     "examples": [
36925       {
36926         "title": "Example usage:",
36927         "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",
36928         "type": "json"
36929       }
36930     ],
36931     "name": "CreateWhatsapp_Transfer_Reports",
36932     "group": "Whatsapp_Transfer_Reports",
36933     "parameter": {
36934       "fields": {
36935         "Body": [
36936           {
36937             "group": "Body",
36938             "type": "String",
36939             "optional": false,
36940             "field": "uniqueid",
36941             "description": ""
36942           },
36943           {
36944             "group": "Body",
36945             "type": "String",
36946             "allowedValues": [
36947               "\"account\"",
36948               "\"agent\"",
36949               "\"queue\""
36950             ],
36951             "optional": false,
36952             "field": "type",
36953             "description": ""
36954           },
36955           {
36956             "group": "Body",
36957             "type": "String",
36958             "optional": true,
36959             "field": "transferredAt",
36960             "description": ""
36961           }
36962         ]
36963       }
36964     },
36965     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36966     "version": "0.0.0",
36967     "filename": "server/api/whatsappTransferReport/index.js",
36968     "groupTitle": "Whatsapp_Transfer_Reports"
36969   },
36970   {
36971     "type": "delete",
36972     "url": "/api/whatsapp/reports/transfer/{id}",
36973     "title": "Deletes a Whatsapp Transfer Report",
36974     "examples": [
36975       {
36976         "title": "Example usage:",
36977         "content": "curl https://{domain}/api/whatsapp/reports/transfer/{id} -v -u {name}:{password} -X DELETE",
36978         "type": "json"
36979       }
36980     ],
36981     "name": "DeleteWhatsapp_Transfer_Reports",
36982     "group": "Whatsapp_Transfer_Reports",
36983     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36984     "version": "0.0.0",
36985     "filename": "server/api/whatsappTransferReport/index.js",
36986     "groupTitle": "Whatsapp_Transfer_Reports"
36987   },
36988   {
36989     "type": "get",
36990     "url": "/api/whatsapp/reports/transfer/describe",
36991     "title": "Gets table info about Whatsapp Transfer Reports",
36992     "examples": [
36993       {
36994         "title": "Example usage:",
36995         "content": "curl https://{domain}/api/whatsapp/reports/transfer/describe -v -u {name}:{password}",
36996         "type": "json"
36997       }
36998     ],
36999     "name": "DescribeWhatsapp_Transfer_Reports",
37000     "group": "Whatsapp_Transfer_Reports",
37001     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37002     "version": "0.0.0",
37003     "filename": "server/api/whatsappTransferReport/index.js",
37004     "groupTitle": "Whatsapp_Transfer_Reports"
37005   },
37006   {
37007     "type": "get",
37008     "url": "/api/whatsapp/reports/transfer",
37009     "title": "Gets a list of Whatsapp Transfer Reports",
37010     "examples": [
37011       {
37012         "title": "Example usage:",
37013         "content": "curl https://{domain}/api/whatsapp/reports/transfer -v -u {name}:{password}",
37014         "type": "json"
37015       }
37016     ],
37017     "name": "GetWhatsapp_Transfer_Reports",
37018     "group": "Whatsapp_Transfer_Reports",
37019     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
37020     "version": "0.0.0",
37021     "filename": "server/api/whatsappTransferReport/index.js",
37022     "groupTitle": "Whatsapp_Transfer_Reports"
37023   },
37024   {
37025     "type": "get",
37026     "url": "/api/whatsapp/reports/transfer/{id}",
37027     "title": "Gets a single Whatsapp Transfer Report",
37028     "examples": [
37029       {
37030         "title": "Example usage:",
37031         "content": "curl https://{domain}/api/whatsapp/reports/transfer/{id} -v -u {name}:{password}",
37032         "type": "json"
37033       }
37034     ],
37035     "name": "ShowWhatsapp_Transfer_Reports",
37036     "group": "Whatsapp_Transfer_Reports",
37037     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37038     "version": "0.0.0",
37039     "filename": "server/api/whatsappTransferReport/index.js",
37040     "groupTitle": "Whatsapp_Transfer_Reports"
37041   },
37042   {
37043     "type": "put",
37044     "url": "/api/whatsapp/reports/transfer/{id}",
37045     "title": "Update an existing Whatsapp Transfer Report",
37046     "examples": [
37047       {
37048         "title": "Example usage:",
37049         "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",
37050         "type": "json"
37051       }
37052     ],
37053     "name": "updateWhatsapp_Transfer_Reports",
37054     "group": "Whatsapp_Transfer_Reports",
37055     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37056     "version": "0.0.0",
37057     "filename": "server/api/whatsappTransferReport/index.js",
37058     "groupTitle": "Whatsapp_Transfer_Reports"
37059   },
37060   {
37061     "type": "post",
37062     "url": "/api/integrations/zendesk/accounts",
37063     "title": "Creates a new Zendesk Account",
37064     "examples": [
37065       {
37066         "title": "Example usage:",
37067         "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",
37068         "type": "json"
37069       }
37070     ],
37071     "name": "CreateZendesk_Accounts",
37072     "group": "Zendesk_Accounts",
37073     "parameter": {
37074       "fields": {
37075         "Body": [
37076           {
37077             "group": "Body",
37078             "type": "String",
37079             "optional": true,
37080             "field": "name",
37081             "description": ""
37082           },
37083           {
37084             "group": "Body",
37085             "type": "String",
37086             "optional": true,
37087             "field": "description",
37088             "description": ""
37089           },
37090           {
37091             "group": "Body",
37092             "type": "String",
37093             "optional": true,
37094             "field": "username",
37095             "description": ""
37096           },
37097           {
37098             "group": "Body",
37099             "type": "String",
37100             "optional": true,
37101             "field": "password",
37102             "description": ""
37103           },
37104           {
37105             "group": "Body",
37106             "type": "String",
37107             "optional": true,
37108             "field": "token",
37109             "description": ""
37110           },
37111           {
37112             "group": "Body",
37113             "type": "String",
37114             "optional": true,
37115             "field": "remoteUri",
37116             "description": ""
37117           },
37118           {
37119             "group": "Body",
37120             "type": "String",
37121             "allowedValues": [
37122               "\"password\"",
37123               "\"token\""
37124             ],
37125             "optional": true,
37126             "field": "authType",
37127             "description": ""
37128           },
37129           {
37130             "group": "Body",
37131             "type": "String",
37132             "optional": true,
37133             "field": "serverUrl",
37134             "description": ""
37135           },
37136           {
37137             "group": "Body",
37138             "type": "String",
37139             "allowedValues": [
37140               "\"integrationTab\"",
37141               "\"newTab\""
37142             ],
37143             "optional": true,
37144             "field": "type",
37145             "description": ""
37146           }
37147         ]
37148       }
37149     },
37150     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37151     "version": "0.0.0",
37152     "filename": "server/api/intZendeskAccount/index.js",
37153     "groupTitle": "Zendesk_Accounts"
37154   },
37155   {
37156     "type": "delete",
37157     "url": "/api/integrations/zendesk/accounts/{id}",
37158     "title": "Deletes a Zendesk Account",
37159     "examples": [
37160       {
37161         "title": "Example usage:",
37162         "content": "curl https://{domain}/api/integrations/zendesk/accounts/{id} -v -u {name}:{password} -X DELETE",
37163         "type": "json"
37164       }
37165     ],
37166     "name": "DeleteZendesk_Accounts",
37167     "group": "Zendesk_Accounts",
37168     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37169     "version": "0.0.0",
37170     "filename": "server/api/intZendeskAccount/index.js",
37171     "groupTitle": "Zendesk_Accounts"
37172   },
37173   {
37174     "type": "get",
37175     "url": "/api/integrations/zendesk/accounts",
37176     "title": "Gets a list of Zendesk Accounts",
37177     "examples": [
37178       {
37179         "title": "Example usage:",
37180         "content": "curl https://{domain}/api/integrations/zendesk/accounts -v -u {name}:{password}",
37181         "type": "json"
37182       }
37183     ],
37184     "name": "GetZendesk_Accounts",
37185     "group": "Zendesk_Accounts",
37186     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
37187     "version": "0.0.0",
37188     "filename": "server/api/intZendeskAccount/index.js",
37189     "groupTitle": "Zendesk_Accounts"
37190   },
37191   {
37192     "type": "get",
37193     "url": "/api/integrations/zendesk/accounts/{id}",
37194     "title": "Gets a single Zendesk Account",
37195     "examples": [
37196       {
37197         "title": "Example usage:",
37198         "content": "curl https://{domain}/api/integrations/zendesk/accounts/{id} -v -u {name}:{password}",
37199         "type": "json"
37200       }
37201     ],
37202     "name": "ShowZendesk_Accounts",
37203     "group": "Zendesk_Accounts",
37204     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37205     "version": "0.0.0",
37206     "filename": "server/api/intZendeskAccount/index.js",
37207     "groupTitle": "Zendesk_Accounts"
37208   },
37209   {
37210     "type": "post",
37211     "url": "/api/integrations/zendesk/accounts/{id}/configurations",
37212     "title": "Creates new configuration",
37213     "examples": [
37214       {
37215         "title": "Example usage:",
37216         "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",
37217         "type": "json"
37218       }
37219     ],
37220     "name": "addConfiguration",
37221     "group": "Zendesk_Accounts",
37222     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37223     "version": "0.0.0",
37224     "filename": "server/api/intZendeskAccount/index.js",
37225     "groupTitle": "Zendesk_Accounts"
37226   },
37227   {
37228     "type": "get",
37229     "url": "/api/integrations/zendesk/accounts/{id}/configurations",
37230     "title": "Gets account configurations",
37231     "examples": [
37232       {
37233         "title": "Example usage:",
37234         "content": "curl https://{domain}/api/integrations/zendesk/accounts/{id}/configurations -v -u {name}:{password} -X GET",
37235         "type": "json"
37236       }
37237     ],
37238     "name": "getConfigurations",
37239     "group": "Zendesk_Accounts",
37240     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37241     "version": "0.0.0",
37242     "filename": "server/api/intZendeskAccount/index.js",
37243     "groupTitle": "Zendesk_Accounts"
37244   },
37245   {
37246     "type": "get",
37247     "url": "/api/integrations/zendesk/accounts/{id}/fields",
37248     "title": "Gets account fields",
37249     "examples": [
37250       {
37251         "title": "Example usage:",
37252         "content": "curl https://{domain}/api/integrations/zendesk/accounts/{id}/fields -v -u {name}:{password} -X GET",
37253         "type": "json"
37254       }
37255     ],
37256     "name": "getFields",
37257     "group": "Zendesk_Accounts",
37258     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37259     "version": "0.0.0",
37260     "filename": "server/api/intZendeskAccount/index.js",
37261     "groupTitle": "Zendesk_Accounts"
37262   },
37263   {
37264     "type": "put",
37265     "url": "/api/integrations/zendesk/accounts/{id}",
37266     "title": "Update an existing Zendesk Account",
37267     "examples": [
37268       {
37269         "title": "Example usage:",
37270         "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",
37271         "type": "json"
37272       }
37273     ],
37274     "name": "updateZendesk_Accounts",
37275     "group": "Zendesk_Accounts",
37276     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37277     "version": "0.0.0",
37278     "filename": "server/api/intZendeskAccount/index.js",
37279     "groupTitle": "Zendesk_Accounts"
37280   },
37281   {
37282     "type": "post",
37283     "url": "/api/integrations/zendesk/configurations",
37284     "title": "Creates a new Zendesk Configuration",
37285     "examples": [
37286       {
37287         "title": "Example usage:",
37288         "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",
37289         "type": "json"
37290       }
37291     ],
37292     "name": "CreateZendesk_Configurations",
37293     "group": "Zendesk_Configurations",
37294     "parameter": {
37295       "fields": {
37296         "Body": [
37297           {
37298             "group": "Body",
37299             "type": "String",
37300             "optional": true,
37301             "field": "name",
37302             "description": ""
37303           },
37304           {
37305             "group": "Body",
37306             "type": "String",
37307             "optional": true,
37308             "field": "description",
37309             "description": ""
37310           }
37311         ]
37312       }
37313     },
37314     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37315     "version": "0.0.0",
37316     "filename": "server/api/intZendeskConfiguration/index.js",
37317     "groupTitle": "Zendesk_Configurations"
37318   },
37319   {
37320     "type": "delete",
37321     "url": "/api/integrations/zendesk/configurations/{id}",
37322     "title": "Deletes a Zendesk Configuration",
37323     "examples": [
37324       {
37325         "title": "Example usage:",
37326         "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id} -v -u {name}:{password} -X DELETE",
37327         "type": "json"
37328       }
37329     ],
37330     "name": "DeleteZendesk_Configurations",
37331     "group": "Zendesk_Configurations",
37332     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37333     "version": "0.0.0",
37334     "filename": "server/api/intZendeskConfiguration/index.js",
37335     "groupTitle": "Zendesk_Configurations"
37336   },
37337   {
37338     "type": "get",
37339     "url": "/api/integrations/zendesk/configurations",
37340     "title": "Gets a list of Zendesk Configurations",
37341     "examples": [
37342       {
37343         "title": "Example usage:",
37344         "content": "curl https://{domain}/api/integrations/zendesk/configurations -v -u {name}:{password}",
37345         "type": "json"
37346       }
37347     ],
37348     "name": "GetZendesk_Configurations",
37349     "group": "Zendesk_Configurations",
37350     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
37351     "version": "0.0.0",
37352     "filename": "server/api/intZendeskConfiguration/index.js",
37353     "groupTitle": "Zendesk_Configurations"
37354   },
37355   {
37356     "type": "get",
37357     "url": "/api/integrations/zendesk/configurations/{id}",
37358     "title": "Gets a single Zendesk Configuration",
37359     "examples": [
37360       {
37361         "title": "Example usage:",
37362         "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id} -v -u {name}:{password}",
37363         "type": "json"
37364       }
37365     ],
37366     "name": "ShowZendesk_Configurations",
37367     "group": "Zendesk_Configurations",
37368     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37369     "version": "0.0.0",
37370     "filename": "server/api/intZendeskConfiguration/index.js",
37371     "groupTitle": "Zendesk_Configurations"
37372   },
37373   {
37374     "type": "get",
37375     "url": "/api/integrations/zendesk/configurations/{id}/descriptions",
37376     "title": "Gets configurations descriptions",
37377     "examples": [
37378       {
37379         "title": "Example usage:",
37380         "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
37381         "type": "json"
37382       }
37383     ],
37384     "name": "getDescriptions",
37385     "group": "Zendesk_Configurations",
37386     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37387     "version": "0.0.0",
37388     "filename": "server/api/intZendeskConfiguration/index.js",
37389     "groupTitle": "Zendesk_Configurations"
37390   },
37391   {
37392     "type": "get",
37393     "url": "/api/integrations/zendesk/configurations/{id}/fields",
37394     "title": "Gets configurations fields",
37395     "examples": [
37396       {
37397         "title": "Example usage:",
37398         "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id}/fields -v -u {name}:{password} -X GET",
37399         "type": "json"
37400       }
37401     ],
37402     "name": "getFields",
37403     "group": "Zendesk_Configurations",
37404     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37405     "version": "0.0.0",
37406     "filename": "server/api/intZendeskConfiguration/index.js",
37407     "groupTitle": "Zendesk_Configurations"
37408   },
37409   {
37410     "type": "get",
37411     "url": "/api/integrations/zendesk/configurations/{id}/subjects",
37412     "title": "Gets configurations subjects",
37413     "examples": [
37414       {
37415         "title": "Example usage:",
37416         "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id}/subjects -v -u {name}:{password} -X GET",
37417         "type": "json"
37418       }
37419     ],
37420     "name": "getSubjects",
37421     "group": "Zendesk_Configurations",
37422     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37423     "version": "0.0.0",
37424     "filename": "server/api/intZendeskConfiguration/index.js",
37425     "groupTitle": "Zendesk_Configurations"
37426   },
37427   {
37428     "type": "get",
37429     "url": "/api/integrations/zendesk/configurations/{id}/tags",
37430     "title": "Gets configurations tags",
37431     "examples": [
37432       {
37433         "title": "Example usage:",
37434         "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id}/tags -v -u {name}:{password} -X GET",
37435         "type": "json"
37436       }
37437     ],
37438     "name": "getTags",
37439     "group": "Zendesk_Configurations",
37440     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37441     "version": "0.0.0",
37442     "filename": "server/api/intZendeskConfiguration/index.js",
37443     "groupTitle": "Zendesk_Configurations"
37444   },
37445   {
37446     "type": "post",
37447     "url": "/api/integrations/zendesk/configurations/{id}/tags",
37448     "title": "Sets new tags",
37449     "examples": [
37450       {
37451         "title": "Example usage:",
37452         "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",
37453         "type": "json"
37454       }
37455     ],
37456     "name": "setTags",
37457     "group": "Zendesk_Configurations",
37458     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37459     "version": "0.0.0",
37460     "filename": "server/api/intZendeskConfiguration/index.js",
37461     "groupTitle": "Zendesk_Configurations"
37462   },
37463   {
37464     "type": "put",
37465     "url": "/api/integrations/zendesk/configurations/{id}",
37466     "title": "Update an existing Zendesk Configuration",
37467     "examples": [
37468       {
37469         "title": "Example usage:",
37470         "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",
37471         "type": "json"
37472       }
37473     ],
37474     "name": "updateZendesk_Configurations",
37475     "group": "Zendesk_Configurations",
37476     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37477     "version": "0.0.0",
37478     "filename": "server/api/intZendeskConfiguration/index.js",
37479     "groupTitle": "Zendesk_Configurations"
37480   },
37481   {
37482     "type": "post",
37483     "url": "/api/integrations/zendesk/fields",
37484     "title": "Creates a new Zendesk Field",
37485     "examples": [
37486       {
37487         "title": "Example usage:",
37488         "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",
37489         "type": "json"
37490       }
37491     ],
37492     "name": "CreateZendesk_Fields",
37493     "group": "Zendesk_Fields",
37494     "parameter": {
37495       "fields": {
37496         "Body": [
37497           {
37498             "group": "Body",
37499             "type": "String",
37500             "allowedValues": [
37501               "\"string\"",
37502               "\"variable\"",
37503               "\"customVariable\"",
37504               "\"keyValue\""
37505             ],
37506             "optional": true,
37507             "field": "type",
37508             "description": ""
37509           },
37510           {
37511             "group": "Body",
37512             "type": "String",
37513             "optional": true,
37514             "field": "content",
37515             "description": ""
37516           },
37517           {
37518             "group": "Body",
37519             "type": "String",
37520             "optional": true,
37521             "field": "key",
37522             "description": ""
37523           },
37524           {
37525             "group": "Body",
37526             "type": "String",
37527             "allowedValues": [
37528               "\"string\"",
37529               "\"variable\"",
37530               "\"customVariable\""
37531             ],
37532             "optional": true,
37533             "field": "keyType",
37534             "description": ""
37535           },
37536           {
37537             "group": "Body",
37538             "type": "String",
37539             "optional": true,
37540             "field": "keyContent",
37541             "description": ""
37542           },
37543           {
37544             "group": "Body",
37545             "type": "String",
37546             "optional": true,
37547             "field": "idField",
37548             "description": ""
37549           },
37550           {
37551             "group": "Body",
37552             "type": "String",
37553             "optional": true,
37554             "field": "nameField",
37555             "description": ""
37556           },
37557           {
37558             "group": "Body",
37559             "type": "Boolean",
37560             "optional": true,
37561             "field": "customField",
37562             "description": ""
37563           },
37564           {
37565             "group": "Body",
37566             "type": "String",
37567             "optional": true,
37568             "field": "variableName",
37569             "description": ""
37570           }
37571         ]
37572       }
37573     },
37574     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37575     "version": "0.0.0",
37576     "filename": "server/api/intZendeskField/index.js",
37577     "groupTitle": "Zendesk_Fields"
37578   },
37579   {
37580     "type": "delete",
37581     "url": "/api/integrations/zendesk/fields/{id}",
37582     "title": "Deletes a Zendesk Field",
37583     "examples": [
37584       {
37585         "title": "Example usage:",
37586         "content": "curl https://{domain}/api/integrations/zendesk/fields/{id} -v -u {name}:{password} -X DELETE",
37587         "type": "json"
37588       }
37589     ],
37590     "name": "DeleteZendesk_Fields",
37591     "group": "Zendesk_Fields",
37592     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37593     "version": "0.0.0",
37594     "filename": "server/api/intZendeskField/index.js",
37595     "groupTitle": "Zendesk_Fields"
37596   },
37597   {
37598     "type": "get",
37599     "url": "/api/integrations/zendesk/fields",
37600     "title": "Gets a list of Zendesk Fields",
37601     "examples": [
37602       {
37603         "title": "Example usage:",
37604         "content": "curl https://{domain}/api/integrations/zendesk/fields -v -u {name}:{password}",
37605         "type": "json"
37606       }
37607     ],
37608     "name": "GetZendesk_Fields",
37609     "group": "Zendesk_Fields",
37610     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
37611     "version": "0.0.0",
37612     "filename": "server/api/intZendeskField/index.js",
37613     "groupTitle": "Zendesk_Fields"
37614   },
37615   {
37616     "type": "get",
37617     "url": "/api/integrations/zendesk/fields/{id}",
37618     "title": "Gets a single Zendesk Field",
37619     "examples": [
37620       {
37621         "title": "Example usage:",
37622         "content": "curl https://{domain}/api/integrations/zendesk/fields/{id} -v -u {name}:{password}",
37623         "type": "json"
37624       }
37625     ],
37626     "name": "ShowZendesk_Fields",
37627     "group": "Zendesk_Fields",
37628     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37629     "version": "0.0.0",
37630     "filename": "server/api/intZendeskField/index.js",
37631     "groupTitle": "Zendesk_Fields"
37632   },
37633   {
37634     "type": "put",
37635     "url": "/api/integrations/zendesk/fields/{id}",
37636     "title": "Update an existing Zendesk Field",
37637     "examples": [
37638       {
37639         "title": "Example usage:",
37640         "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",
37641         "type": "json"
37642       }
37643     ],
37644     "name": "updateZendesk_Fields",
37645     "group": "Zendesk_Fields",
37646     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37647     "version": "0.0.0",
37648     "filename": "server/api/intZendeskField/index.js",
37649     "groupTitle": "Zendesk_Fields"
37650   },
37651   {
37652     "type": "post",
37653     "url": "/api/integrations/zoho/accounts",
37654     "title": "Creates a new Zoho Account",
37655     "examples": [
37656       {
37657         "title": "Example usage:",
37658         "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",
37659         "type": "json"
37660       }
37661     ],
37662     "name": "CreateZoho_Accounts",
37663     "group": "Zoho_Accounts",
37664     "parameter": {
37665       "fields": {
37666         "Body": [
37667           {
37668             "group": "Body",
37669             "type": "String",
37670             "optional": true,
37671             "field": "name",
37672             "description": ""
37673           },
37674           {
37675             "group": "Body",
37676             "type": "String",
37677             "optional": true,
37678             "field": "description",
37679             "description": ""
37680           },
37681           {
37682             "group": "Body",
37683             "type": "String",
37684             "optional": true,
37685             "field": "host",
37686             "description": ""
37687           },
37688           {
37689             "group": "Body",
37690             "type": "String",
37691             "optional": true,
37692             "field": "zone",
37693             "description": ""
37694           },
37695           {
37696             "group": "Body",
37697             "type": "String",
37698             "optional": true,
37699             "field": "clientId",
37700             "description": ""
37701           },
37702           {
37703             "group": "Body",
37704             "type": "String",
37705             "optional": true,
37706             "field": "clientSecret",
37707             "description": ""
37708           },
37709           {
37710             "group": "Body",
37711             "type": "String",
37712             "optional": true,
37713             "field": "serverUrl",
37714             "description": ""
37715           },
37716           {
37717             "group": "Body",
37718             "type": "String",
37719             "optional": true,
37720             "field": "code",
37721             "description": ""
37722           },
37723           {
37724             "group": "Body",
37725             "type": "String",
37726             "optional": true,
37727             "field": "refreshToken",
37728             "description": ""
37729           }
37730         ]
37731       }
37732     },
37733     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37734     "version": "0.0.0",
37735     "filename": "server/api/intZohoAccount/index.js",
37736     "groupTitle": "Zoho_Accounts"
37737   },
37738   {
37739     "type": "delete",
37740     "url": "/api/integrations/zoho/accounts/{id}",
37741     "title": "Deletes a Zoho Account",
37742     "examples": [
37743       {
37744         "title": "Example usage:",
37745         "content": "curl https://{domain}/api/integrations/zoho/accounts/{id} -v -u {name}:{password} -X DELETE",
37746         "type": "json"
37747       }
37748     ],
37749     "name": "DeleteZoho_Accounts",
37750     "group": "Zoho_Accounts",
37751     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37752     "version": "0.0.0",
37753     "filename": "server/api/intZohoAccount/index.js",
37754     "groupTitle": "Zoho_Accounts"
37755   },
37756   {
37757     "type": "get",
37758     "url": "/api/integrations/zoho/accounts",
37759     "title": "Gets a list of Zoho Accounts",
37760     "examples": [
37761       {
37762         "title": "Example usage:",
37763         "content": "curl https://{domain}/api/integrations/zoho/accounts -v -u {name}:{password}",
37764         "type": "json"
37765       }
37766     ],
37767     "name": "GetZoho_Accounts",
37768     "group": "Zoho_Accounts",
37769     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
37770     "version": "0.0.0",
37771     "filename": "server/api/intZohoAccount/index.js",
37772     "groupTitle": "Zoho_Accounts"
37773   },
37774   {
37775     "type": "get",
37776     "url": "/api/integrations/zoho/accounts/{id}",
37777     "title": "Gets a single Zoho Account",
37778     "examples": [
37779       {
37780         "title": "Example usage:",
37781         "content": "curl https://{domain}/api/integrations/zoho/accounts/{id} -v -u {name}:{password}",
37782         "type": "json"
37783       }
37784     ],
37785     "name": "ShowZoho_Accounts",
37786     "group": "Zoho_Accounts",
37787     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37788     "version": "0.0.0",
37789     "filename": "server/api/intZohoAccount/index.js",
37790     "groupTitle": "Zoho_Accounts"
37791   },
37792   {
37793     "type": "post",
37794     "url": "/api/integrations/zoho/accounts/{id}/configurations",
37795     "title": "Creates new configuration",
37796     "examples": [
37797       {
37798         "title": "Example usage:",
37799         "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",
37800         "type": "json"
37801       }
37802     ],
37803     "name": "addConfiguration",
37804     "group": "Zoho_Accounts",
37805     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37806     "version": "0.0.0",
37807     "filename": "server/api/intZohoAccount/index.js",
37808     "groupTitle": "Zoho_Accounts"
37809   },
37810   {
37811     "type": "get",
37812     "url": "/api/integrations/zoho/accounts/{id}/configurations",
37813     "title": "Gets account configurations",
37814     "examples": [
37815       {
37816         "title": "Example usage:",
37817         "content": "curl https://{domain}/api/integrations/zoho/accounts/{id}/configurations -v -u {name}:{password} -X GET",
37818         "type": "json"
37819       }
37820     ],
37821     "name": "getConfigurations",
37822     "group": "Zoho_Accounts",
37823     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37824     "version": "0.0.0",
37825     "filename": "server/api/intZohoAccount/index.js",
37826     "groupTitle": "Zoho_Accounts"
37827   },
37828   {
37829     "type": "get",
37830     "url": "/api/integrations/zoho/accounts/{id}/fields",
37831     "title": "Gets account fields",
37832     "examples": [
37833       {
37834         "title": "Example usage:",
37835         "content": "curl https://{domain}/api/integrations/zoho/accounts/{id}/fields -v -u {name}:{password} -X GET",
37836         "type": "json"
37837       }
37838     ],
37839     "name": "getFields",
37840     "group": "Zoho_Accounts",
37841     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37842     "version": "0.0.0",
37843     "filename": "server/api/intZohoAccount/index.js",
37844     "groupTitle": "Zoho_Accounts"
37845   },
37846   {
37847     "type": "put",
37848     "url": "/api/integrations/zoho/accounts/{id}",
37849     "title": "Update an existing Zoho Account",
37850     "examples": [
37851       {
37852         "title": "Example usage:",
37853         "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",
37854         "type": "json"
37855       }
37856     ],
37857     "name": "updateZoho_Accounts",
37858     "group": "Zoho_Accounts",
37859     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37860     "version": "0.0.0",
37861     "filename": "server/api/intZohoAccount/index.js",
37862     "groupTitle": "Zoho_Accounts"
37863   },
37864   {
37865     "type": "post",
37866     "url": "/api/integrations/zoho/configurations",
37867     "title": "Creates a new Zoho Configuration",
37868     "examples": [
37869       {
37870         "title": "Example usage:",
37871         "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",
37872         "type": "json"
37873       }
37874     ],
37875     "name": "CreateZoho_Configurations",
37876     "group": "Zoho_Configurations",
37877     "parameter": {
37878       "fields": {
37879         "Body": [
37880           {
37881             "group": "Body",
37882             "type": "String",
37883             "optional": true,
37884             "field": "name",
37885             "description": ""
37886           },
37887           {
37888             "group": "Body",
37889             "type": "String",
37890             "allowedValues": [
37891               "\"lead\"",
37892               "\"contact\"",
37893               "\"nothing\""
37894             ],
37895             "optional": true,
37896             "field": "moduleCreate",
37897             "description": ""
37898           },
37899           {
37900             "group": "Body",
37901             "type": "String",
37902             "allowedValues": [
37903               "\"contact_lead\"",
37904               "\"contact\"",
37905               "\"lead\""
37906             ],
37907             "optional": true,
37908             "field": "moduleSearch",
37909             "description": ""
37910           },
37911           {
37912             "group": "Body",
37913             "type": "String",
37914             "optional": true,
37915             "field": "description",
37916             "description": ""
37917           }
37918         ]
37919       }
37920     },
37921     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37922     "version": "0.0.0",
37923     "filename": "server/api/intZohoConfiguration/index.js",
37924     "groupTitle": "Zoho_Configurations"
37925   },
37926   {
37927     "type": "delete",
37928     "url": "/api/integrations/zoho/configurations/{id}",
37929     "title": "Deletes a Zoho Configuration",
37930     "examples": [
37931       {
37932         "title": "Example usage:",
37933         "content": "curl https://{domain}/api/integrations/zoho/configurations/{id} -v -u {name}:{password} -X DELETE",
37934         "type": "json"
37935       }
37936     ],
37937     "name": "DeleteZoho_Configurations",
37938     "group": "Zoho_Configurations",
37939     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37940     "version": "0.0.0",
37941     "filename": "server/api/intZohoConfiguration/index.js",
37942     "groupTitle": "Zoho_Configurations"
37943   },
37944   {
37945     "type": "get",
37946     "url": "/api/integrations/zoho/configurations",
37947     "title": "Gets a list of Zoho Configurations",
37948     "examples": [
37949       {
37950         "title": "Example usage:",
37951         "content": "curl https://{domain}/api/integrations/zoho/configurations -v -u {name}:{password}",
37952         "type": "json"
37953       }
37954     ],
37955     "name": "GetZoho_Configurations",
37956     "group": "Zoho_Configurations",
37957     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
37958     "version": "0.0.0",
37959     "filename": "server/api/intZohoConfiguration/index.js",
37960     "groupTitle": "Zoho_Configurations"
37961   },
37962   {
37963     "type": "get",
37964     "url": "/api/integrations/zoho/configurations/{id}",
37965     "title": "Gets a single Zoho Configuration",
37966     "examples": [
37967       {
37968         "title": "Example usage:",
37969         "content": "curl https://{domain}/api/integrations/zoho/configurations/{id} -v -u {name}:{password}",
37970         "type": "json"
37971       }
37972     ],
37973     "name": "ShowZoho_Configurations",
37974     "group": "Zoho_Configurations",
37975     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37976     "version": "0.0.0",
37977     "filename": "server/api/intZohoConfiguration/index.js",
37978     "groupTitle": "Zoho_Configurations"
37979   },
37980   {
37981     "type": "get",
37982     "url": "/api/integrations/zoho/configurations/{id}/descriptions",
37983     "title": "Gets configurations descriptions",
37984     "examples": [
37985       {
37986         "title": "Example usage:",
37987         "content": "curl https://{domain}/api/integrations/zoho/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
37988         "type": "json"
37989       }
37990     ],
37991     "name": "getDescriptions",
37992     "group": "Zoho_Configurations",
37993     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37994     "version": "0.0.0",
37995     "filename": "server/api/intZohoConfiguration/index.js",
37996     "groupTitle": "Zoho_Configurations"
37997   },
37998   {
37999     "type": "get",
38000     "url": "/api/integrations/zoho/configurations/{id}/fields",
38001     "title": "Gets configurations fields",
38002     "examples": [
38003       {
38004         "title": "Example usage:",
38005         "content": "curl https://{domain}/api/integrations/zoho/configurations/{id}/fields -v -u {name}:{password} -X GET",
38006         "type": "json"
38007       }
38008     ],
38009     "name": "getFields",
38010     "group": "Zoho_Configurations",
38011     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
38012     "version": "0.0.0",
38013     "filename": "server/api/intZohoConfiguration/index.js",
38014     "groupTitle": "Zoho_Configurations"
38015   },
38016   {
38017     "type": "get",
38018     "url": "/api/integrations/zoho/configurations/{id}/subjects",
38019     "title": "Gets configurations subjects",
38020     "examples": [
38021       {
38022         "title": "Example usage:",
38023         "content": "curl https://{domain}/api/integrations/zoho/configurations/{id}/subjects -v -u {name}:{password} -X GET",
38024         "type": "json"
38025       }
38026     ],
38027     "name": "getSubjects",
38028     "group": "Zoho_Configurations",
38029     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
38030     "version": "0.0.0",
38031     "filename": "server/api/intZohoConfiguration/index.js",
38032     "groupTitle": "Zoho_Configurations"
38033   },
38034   {
38035     "type": "put",
38036     "url": "/api/integrations/zoho/configurations/{id}",
38037     "title": "Update an existing Zoho Configuration",
38038     "examples": [
38039       {
38040         "title": "Example usage:",
38041         "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",
38042         "type": "json"
38043       }
38044     ],
38045     "name": "updateZoho_Configurations",
38046     "group": "Zoho_Configurations",
38047     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
38048     "version": "0.0.0",
38049     "filename": "server/api/intZohoConfiguration/index.js",
38050     "groupTitle": "Zoho_Configurations"
38051   },
38052   {
38053     "type": "post",
38054     "url": "/api/integrations/zoho/fields",
38055     "title": "Creates a new Zoho Field",
38056     "examples": [
38057       {
38058         "title": "Example usage:",
38059         "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",
38060         "type": "json"
38061       }
38062     ],
38063     "name": "CreateZoho_Fields",
38064     "group": "Zoho_Fields",
38065     "parameter": {
38066       "fields": {
38067         "Body": [
38068           {
38069             "group": "Body",
38070             "type": "String",
38071             "allowedValues": [
38072               "\"string\"",
38073               "\"variable\"",
38074               "\"customVariable\"",
38075               "\"keyValue\""
38076             ],
38077             "optional": true,
38078             "field": "type",
38079             "description": ""
38080           },
38081           {
38082             "group": "Body",
38083             "type": "String",
38084             "optional": true,
38085             "field": "content",
38086             "description": ""
38087           },
38088           {
38089             "group": "Body",
38090             "type": "String",
38091             "optional": true,
38092             "field": "key",
38093             "description": ""
38094           },
38095           {
38096             "group": "Body",
38097             "type": "String",
38098             "allowedValues": [
38099               "\"string\"",
38100               "\"variable\"",
38101               "\"customVariable\""
38102             ],
38103             "optional": true,
38104             "field": "keyType",
38105             "description": ""
38106           },
38107           {
38108             "group": "Body",
38109             "type": "String",
38110             "optional": true,
38111             "field": "keyContent",
38112             "description": ""
38113           },
38114           {
38115             "group": "Body",
38116             "type": "String",
38117             "optional": true,
38118             "field": "idField",
38119             "description": ""
38120           },
38121           {
38122             "group": "Body",
38123             "type": "String",
38124             "optional": true,
38125             "field": "nameField",
38126             "description": ""
38127           },
38128           {
38129             "group": "Body",
38130             "type": "Boolean",
38131             "optional": true,
38132             "field": "customField",
38133             "description": ""
38134           },
38135           {
38136             "group": "Body",
38137             "type": "String",
38138             "optional": true,
38139             "field": "variableName",
38140             "description": ""
38141           }
38142         ]
38143       }
38144     },
38145     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
38146     "version": "0.0.0",
38147     "filename": "server/api/intZohoField/index.js",
38148     "groupTitle": "Zoho_Fields"
38149   },
38150   {
38151     "type": "delete",
38152     "url": "/api/integrations/zoho/fields/{id}",
38153     "title": "Deletes a Zoho Field",
38154     "examples": [
38155       {
38156         "title": "Example usage:",
38157         "content": "curl https://{domain}/api/integrations/zoho/fields/{id} -v -u {name}:{password} -X DELETE",
38158         "type": "json"
38159       }
38160     ],
38161     "name": "DeleteZoho_Fields",
38162     "group": "Zoho_Fields",
38163     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
38164     "version": "0.0.0",
38165     "filename": "server/api/intZohoField/index.js",
38166     "groupTitle": "Zoho_Fields"
38167   },
38168   {
38169     "type": "get",
38170     "url": "/api/integrations/zoho/fields",
38171     "title": "Gets a list of Zoho Fields",
38172     "examples": [
38173       {
38174         "title": "Example usage:",
38175         "content": "curl https://{domain}/api/integrations/zoho/fields -v -u {name}:{password}",
38176         "type": "json"
38177       }
38178     ],
38179     "name": "GetZoho_Fields",
38180     "group": "Zoho_Fields",
38181     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
38182     "version": "0.0.0",
38183     "filename": "server/api/intZohoField/index.js",
38184     "groupTitle": "Zoho_Fields"
38185   },
38186   {
38187     "type": "get",
38188     "url": "/api/integrations/zoho/fields/{id}",
38189     "title": "Gets a single Zoho Field",
38190     "examples": [
38191       {
38192         "title": "Example usage:",
38193         "content": "curl https://{domain}/api/integrations/zoho/fields/{id} -v -u {name}:{password}",
38194         "type": "json"
38195       }
38196     ],
38197     "name": "ShowZoho_Fields",
38198     "group": "Zoho_Fields",
38199     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
38200     "version": "0.0.0",
38201     "filename": "server/api/intZohoField/index.js",
38202     "groupTitle": "Zoho_Fields"
38203   },
38204   {
38205     "type": "put",
38206     "url": "/api/integrations/zoho/fields/{id}",
38207     "title": "Update an existing Zoho Field",
38208     "examples": [
38209       {
38210         "title": "Example usage:",
38211         "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",
38212         "type": "json"
38213       }
38214     ],
38215     "name": "updateZoho_Fields",
38216     "group": "Zoho_Fields",
38217     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
38218     "version": "0.0.0",
38219     "filename": "server/api/intZohoField/index.js",
38220     "groupTitle": "Zoho_Fields"
38221   },
38222   {
38223     "type": "post",
38224     "url": "/api/cdr",
38225     "title": "Creates a new Cdr",
38226     "examples": [
38227       {
38228         "title": "Example usage:",
38229         "content": "curl https://{domain}/api/cdr -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
38230         "type": "json"
38231       }
38232     ],
38233     "name": "CreateCdrs",
38234     "group": "cdr",
38235     "parameter": {
38236       "fields": {
38237         "Body": [
38238           {
38239             "group": "Body",
38240             "type": "String",
38241             "optional": false,
38242             "field": "calldate",
38243             "description": ""
38244           },
38245           {
38246             "group": "Body",
38247             "type": "String",
38248             "optional": true,
38249             "field": "clid",
38250             "description": ""
38251           },
38252           {
38253             "group": "Body",
38254             "type": "String",
38255             "optional": true,
38256             "field": "src",
38257             "description": ""
38258           },
38259           {
38260             "group": "Body",
38261             "type": "String",
38262             "optional": true,
38263             "field": "dst",
38264             "description": ""
38265           },
38266           {
38267             "group": "Body",
38268             "type": "String",
38269             "optional": true,
38270             "field": "dcontext",
38271             "description": ""
38272           },
38273           {
38274             "group": "Body",
38275             "type": "String",
38276             "optional": true,
38277             "field": "channel",
38278             "description": ""
38279           },
38280           {
38281             "group": "Body",
38282             "type": "String",
38283             "optional": true,
38284             "field": "dstchannel",
38285             "description": ""
38286           },
38287           {
38288             "group": "Body",
38289             "type": "String",
38290             "optional": true,
38291             "field": "lastapp",
38292             "description": ""
38293           },
38294           {
38295             "group": "Body",
38296             "type": "String",
38297             "optional": true,
38298             "field": "lastdata",
38299             "description": ""
38300           },
38301           {
38302             "group": "Body",
38303             "type": "Integer",
38304             "optional": false,
38305             "field": "duration",
38306             "description": ""
38307           },
38308           {
38309             "group": "Body",
38310             "type": "Integer",
38311             "optional": false,
38312             "field": "billsec",
38313             "description": ""
38314           },
38315           {
38316             "group": "Body",
38317             "type": "String",
38318             "optional": true,
38319             "field": "disposition",
38320             "description": ""
38321           },
38322           {
38323             "group": "Body",
38324             "type": "Integer",
38325             "optional": false,
38326             "field": "amaflags",
38327             "description": ""
38328           },
38329           {
38330             "group": "Body",
38331             "type": "String",
38332             "optional": true,
38333             "field": "accountcode",
38334             "description": ""
38335           },
38336           {
38337             "group": "Body",
38338             "type": "String",
38339             "optional": true,
38340             "field": "userfield",
38341             "description": ""
38342           },
38343           {
38344             "group": "Body",
38345             "type": "String",
38346             "optional": true,
38347             "field": "uniqueid",
38348             "description": ""
38349           },
38350           {
38351             "group": "Body",
38352             "type": "String",
38353             "optional": true,
38354             "field": "linkedid",
38355             "description": ""
38356           },
38357           {
38358             "group": "Body",
38359             "type": "String",
38360             "optional": true,
38361             "field": "sequence",
38362             "description": ""
38363           },
38364           {
38365             "group": "Body",
38366             "type": "String",
38367             "optional": true,
38368             "field": "peeraccount",
38369             "description": ""
38370           },
38371           {
38372             "group": "Body",
38373             "type": "String",
38374             "optional": true,
38375             "field": "type",
38376             "description": ""
38377           },
38378           {
38379             "group": "Body",
38380             "type": "String",
38381             "optional": true,
38382             "field": "tag",
38383             "description": ""
38384           }
38385         ]
38386       }
38387     },
38388     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
38389     "version": "0.0.0",
38390     "filename": "server/api/cdr/index.js",
38391     "groupTitle": "cdr"
38392   },
38393   {
38394     "type": "delete",
38395     "url": "/api/cdr/{id}",
38396     "title": "Deletes a Cdr",
38397     "examples": [
38398       {
38399         "title": "Example usage:",
38400         "content": "curl https://{domain}/api/cdr/{id} -v -u {name}:{password} -X DELETE",
38401         "type": "json"
38402       }
38403     ],
38404     "name": "DeleteCdrs",
38405     "group": "cdr",
38406     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
38407     "version": "0.0.0",
38408     "filename": "server/api/cdr/index.js",
38409     "groupTitle": "cdr"
38410   },
38411   {
38412     "type": "get",
38413     "url": "/api/cdr/describe",
38414     "title": "Gets table info about Cdrs",
38415     "examples": [
38416       {
38417         "title": "Example usage:",
38418         "content": "curl https://{domain}/api/cdr/describe -v -u {name}:{password}",
38419         "type": "json"
38420       }
38421     ],
38422     "name": "DescribeCdrs",
38423     "group": "cdr",
38424     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
38425     "version": "0.0.0",
38426     "filename": "server/api/cdr/index.js",
38427     "groupTitle": "cdr"
38428   },
38429   {
38430     "type": "get",
38431     "url": "/api/cdr",
38432     "title": "Gets a list of Cdrs",
38433     "examples": [
38434       {
38435         "title": "Example usage:",
38436         "content": "curl https://{domain}/api/cdr -v -u {name}:{password}",
38437         "type": "json"
38438       }
38439     ],
38440     "name": "GetCdrs",
38441     "group": "cdr",
38442     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
38443     "version": "0.0.0",
38444     "filename": "server/api/cdr/index.js",
38445     "groupTitle": "cdr"
38446   },
38447   {
38448     "type": "get",
38449     "url": "/api/cdr/{id}",
38450     "title": "Gets a single Cdr",
38451     "examples": [
38452       {
38453         "title": "Example usage:",
38454         "content": "curl https://{domain}/api/cdr/{id} -v -u {name}:{password}",
38455         "type": "json"
38456       }
38457     ],
38458     "name": "ShowCdrs",
38459     "group": "cdr",
38460     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
38461     "version": "0.0.0",
38462     "filename": "server/api/cdr/index.js",
38463     "groupTitle": "cdr"
38464   },
38465   {
38466     "type": "put",
38467     "url": "/api/cdr/{id}",
38468     "title": "Update an existing Cdr",
38469     "examples": [
38470       {
38471         "title": "Example usage:",
38472         "content": "curl https://{domain}/api/cdr/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
38473         "type": "json"
38474       }
38475     ],
38476     "name": "updateCdrs",
38477     "group": "cdr",
38478     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
38479     "version": "0.0.0",
38480     "filename": "server/api/cdr/index.js",
38481     "groupTitle": "cdr"
38482   },
38483   {
38484     "type": "post",
38485     "url": "/api/voiceQueuesLog",
38486     "title": "Creates a new VoiceQueuesLog",
38487     "examples": [
38488       {
38489         "title": "Example usage:",
38490         "content": "curl https://{domain}/api/voiceQueuesLog -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
38491         "type": "json"
38492       }
38493     ],
38494     "name": "CreateVoiceQueuesLogs",
38495     "group": "voiceQueuesLog",
38496     "parameter": {
38497       "fields": {
38498         "Body": [
38499           {
38500             "group": "Body",
38501             "type": "String",
38502             "optional": true,
38503             "field": "time",
38504             "description": ""
38505           },
38506           {
38507             "group": "Body",
38508             "type": "String",
38509             "optional": false,
38510             "field": "callid",
38511             "description": ""
38512           },
38513           {
38514             "group": "Body",
38515             "type": "String",
38516             "optional": false,
38517             "field": "queuename",
38518             "description": ""
38519           },
38520           {
38521             "group": "Body",
38522             "type": "String",
38523             "optional": false,
38524             "field": "agent",
38525             "description": ""
38526           },
38527           {
38528             "group": "Body",
38529             "type": "String",
38530             "optional": false,
38531             "field": "event",
38532             "description": ""
38533           },
38534           {
38535             "group": "Body",
38536             "type": "String",
38537             "optional": false,
38538             "field": "data",
38539             "description": ""
38540           },
38541           {
38542             "group": "Body",
38543             "type": "String",
38544             "optional": false,
38545             "field": "data1",
38546             "description": ""
38547           },
38548           {
38549             "group": "Body",
38550             "type": "String",
38551             "optional": false,
38552             "field": "data2",
38553             "description": ""
38554           },
38555           {
38556             "group": "Body",
38557             "type": "String",
38558             "optional": false,
38559             "field": "data3",
38560             "description": ""
38561           },
38562           {
38563             "group": "Body",
38564             "type": "String",
38565             "optional": false,
38566             "field": "data4",
38567             "description": ""
38568           },
38569           {
38570             "group": "Body",
38571             "type": "String",
38572             "optional": false,
38573             "field": "data5",
38574             "description": ""
38575           },
38576           {
38577             "group": "Body",
38578             "type": "String",
38579             "optional": false,
38580             "field": "dtm",
38581             "description": ""
38582           }
38583         ]
38584       }
38585     },
38586     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
38587     "version": "0.0.0",
38588     "filename": "server/api/voiceQueuesLog/index.js",
38589     "groupTitle": "voiceQueuesLog"
38590   },
38591   {
38592     "type": "delete",
38593     "url": "/api/voiceQueuesLog/{id}",
38594     "title": "Deletes a VoiceQueuesLog",
38595     "examples": [
38596       {
38597         "title": "Example usage:",
38598         "content": "curl https://{domain}/api/voiceQueuesLog/{id} -v -u {name}:{password} -X DELETE",
38599         "type": "json"
38600       }
38601     ],
38602     "name": "DeleteVoiceQueuesLogs",
38603     "group": "voiceQueuesLog",
38604     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
38605     "version": "0.0.0",
38606     "filename": "server/api/voiceQueuesLog/index.js",
38607     "groupTitle": "voiceQueuesLog"
38608   },
38609   {
38610     "type": "get",
38611     "url": "/api/voiceQueuesLog",
38612     "title": "Gets a list of VoiceQueuesLogs",
38613     "examples": [
38614       {
38615         "title": "Example usage:",
38616         "content": "curl https://{domain}/api/voiceQueuesLog -v -u {name}:{password}",
38617         "type": "json"
38618       }
38619     ],
38620     "name": "GetVoiceQueuesLogs",
38621     "group": "voiceQueuesLog",
38622     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
38623     "version": "0.0.0",
38624     "filename": "server/api/voiceQueuesLog/index.js",
38625     "groupTitle": "voiceQueuesLog"
38626   },
38627   {
38628     "type": "get",
38629     "url": "/api/voiceQueuesLog/{id}",
38630     "title": "Gets a single VoiceQueuesLog",
38631     "examples": [
38632       {
38633         "title": "Example usage:",
38634         "content": "curl https://{domain}/api/voiceQueuesLog/{id} -v -u {name}:{password}",
38635         "type": "json"
38636       }
38637     ],
38638     "name": "ShowVoiceQueuesLogs",
38639     "group": "voiceQueuesLog",
38640     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
38641     "version": "0.0.0",
38642     "filename": "server/api/voiceQueuesLog/index.js",
38643     "groupTitle": "voiceQueuesLog"
38644   },
38645   {
38646     "type": "put",
38647     "url": "/api/voiceQueuesLog/{id}",
38648     "title": "Update an existing VoiceQueuesLog",
38649     "examples": [
38650       {
38651         "title": "Example usage:",
38652         "content": "curl https://{domain}/api/voiceQueuesLog/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
38653         "type": "json"
38654       }
38655     ],
38656     "name": "updateVoiceQueuesLogs",
38657     "group": "voiceQueuesLog",
38658     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
38659     "version": "0.0.0",
38660     "filename": "server/api/voiceQueuesLog/index.js",
38661     "groupTitle": "voiceQueuesLog"
38662   }
38663 ] });